temporalio / temporalio/temporal

Add a Cancellation Request status to DescribeWorkflowExecution API

Open
#3,597 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement P1
Dominant language
Go
Stars
23.2k
Forks
1.9k
Avg merge
2d 8h
Merged PRs (30d)
228

Description

Is your feature request related to a problem? Please describe.
Cancelling a workflow is a non-deterministic operation that could take quite a while to complete - or possibly never complete at all. Currently when I create a Cancel request for a given workflow, that status is not reflected in the workflow itself.

Describe the solution you'd like
A new value in the existing workflowExecutionInfo.status field that reflects whether a cancel request has been created

Describe alternatives you've considered
Polling the workflow from the UI is not feasible as we don't know when the operation will complete, if at all.

Additional context

Contributor guide

Open the contributing guide

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 by reviewing the DescribeWorkflowExecution API and the existing workflowExecutionInfo.status definition. Determine how a created cancellation request should be represented and when that status should change, then add coverage showing the expected API response.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, distributed-systems
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.