temporalio / temporalio/features

Expose `StartWorkflowExecutionResponse` fields to `ExecuteWorkflow` API

Open
#619 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
32
Forks
28
Avg merge
1d 9h
Merged PRs (30d)
7

Description

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

ExecuteWorkflow wraps StartWorkflowExecution call, and don't provide visibility to the StartWorkflowExecutionResponse. In particular, if the workflow ID conflict policy is UseExisting, the StartWorkflowExecutionResponse contains the boolean Started which indicates if the call actually started a new workflow or not. It might also contain a link that can also be useful.

For Nexus WorkflowRunOperation, it would need the link that being added in https://github.com/temporalio/api/pull/563.

Describe the solution you'd like

We want to provide some of the information in StartWorkflowExecutionResponse. This can achieved if we add a optional object pointer in StartWorkflowOptions that can be populated by the SDK internals. Example solution:

type StartWorkflowResultInfo struct {
	Link *commonpb.Link
}

type StartWorkflowOptions struct {
	...
	ResultInfo *StartWorkflowResultInfo
}

func ExecuteWorkflow(...) (...) {
	...

	if options.ResultInfo != nil {
		options.ResultInfo.Link = resp.Link
	}
}
Per-SDK Tickets
  • Go -
  • Java -
  • Core -
  • TypeScript -
  • Python -
  • .NET -
  • Ruby -
  • PHP -
  • Temporal CLI -

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 with the ExecuteWorkflow API and StartWorkflowOptions, then compare the available StartWorkflowExecutionResponse fields, especially Started and Link. Review how the proposed ResultInfo object would be populated by SDK internals and track the Go, Java, Core, TypeScript, Python, .NET, Ruby, PHP, and CLI tickets. Done means the required response information is exposed through the relevant SDK APIs.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.