temporalio / temporalio/ui

Provide a "Time Remaining" Value When Using a Timer

Open
#2,141 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
431
Forks
179
Avg merge
2d 9h
Merged PRs (30d)
71

Description

Is your feature request related to a problem? Please describe.

Hi!

We've been experimenting with using timers (using sleep, for example) in our Workflows. And while the total duration of a Timer is easy to see (thank you!) in the UI, for longer timers it be hard to understand how much time is left until the timer completes.

Describe the solution you'd like

When clicking on a Timer in the Workflow Run, it would be helpful if a "Time Remaining" value were visible to the user. I'd imagine this would be calculated only on the page and not in any API request/response.

Using an existing UI sample from a real workflow (under the Additional Context section_, it might make sense for this value to be one of the values in the table on the "right" when viewing the Timer details with a label of "Time Remaining." I could also see this being "Estimated Remaining Time" as some timers can be updated via Signals.

Describe alternatives you've considered

None at this time.

Additional context

Screenshot 2024-06-06 at 10 19 51 AM

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the Workflow Run UI by locating the Timer details view and the existing display of total timer duration. Add a client-side Time Remaining or Estimated Remaining Time value there, accounting for timers that may be updated via Signals; done means the value is visible when a user selects a Timer.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.