[Workflow] Add examples for reuse ID policy #4237

hhunter-ms · 2024-06-26T16:00:54Z

Description

Add examples provided by @kaibocai for workflow reuse Id policy

Issue reference

PR will close: #3909

Signed-off-by: Hannah Hunter <[email protected]>

kaibocai · 2024-06-26T20:25:28Z

The examples look good to me, wondering if we should also add an example for the default behavior which will error out when reuse the workflow ID.

msfussell

@kaibocai Left some comments and questions.

...cs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

msfussell · 2024-06-26T21:30:01Z

...cs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

-Only one workflow instance with a given ID can exist at any given time. However, if a workflow instance completes or fails, its ID can be reused by a new workflow instance. Note, however, that the new workflow instance effectively replaces the old one in the configured state store.
+#### Reusing workflow identities
+
+If a workflow instance completes or fails, its ID can be reused by a new workflow instance. The new workflow instance effectively replaces the old one in the configured state store.


To be clear here, you can set a policy called "api.REUSE_ID_ACTION_TERMINATE" that does force an existing workflow to terminate so you can start a new workflow with the same id.

Is this correct? Little unclear here in the wording. If so, then it would also be good to have a list of the reuse ID policies somewhere in the docs.

yes that's correct

@kaibocai - Can you then provide a list of the api.REUSE_ID_ACTION_XX values and what each one does in a table?

Signed-off-by: Hannah Hunter <[email protected]>

msfussell · 2024-06-27T18:20:58Z

...cs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

+	}
+	// Wait for orchestration to start...
+	client.WaitForOrchestrationStart(ctx, id)
+	// Schedule the workflow again using the same id. However it will ignore creating the new orchestration, since the id is already in use.


What do you mean "ignore". You mean nothing happens (which is strange), or it will eventually get rescheduled. A silent failure event would be really hard to determine. We need to be clearer here on what happens IMO. Can you explain this more and why I would choose this option?

@kaibocai - See my questions. It would help to clarify clearly when these actions are used.
Action: api.REUSE_ID_ACTION_IGNORE

What do you mean "ignore". You mean nothing happens (which is strange), or it will eventually get rescheduled. A silent failure event would be really hard to determine. We need to be clearer here on what happens IMO. Can you explain this more and why I would choose this option?

@kaibocai an explanation of this would help me as well!

so when you want to start an orchestration but only when it's not in running, then you can use this option. More discussion details can be found microsoft/durabletask-go#42

@kaibocai - Ok, but this is a discussion and there is no final conclusion here of what was actually implemented. We need a table for the reuse ID options and what each one does. Can you add this?

github-actions · 2024-07-04T00:09:27Z

Stale PR, paging all reviewers

hhunter-ms · 2024-07-08T20:45:28Z

@cgillum do you mind taking a look as well? I'm hoping to represent this well in the docs and I feel like I'm not being as clear as I could be.

Signed-off-by: Hannah Hunter <[email protected]>

…issue_3909

cgillum · 2024-07-09T01:42:50Z

...cs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

+```go
+func main() {
+	r := task.NewTaskRegistry()
+	r.AddOrchestratorN("SingleActivity", func(ctx *task.OrchestrationContext) (any, error) {


This code sample is for the Durable Task SDK. We should instead provide a code sample for Dapr Workflow.

Yes, please rework this code to use Workflow and keep this as simple as needed. I suggest having this in at least 2 languages also so that this is open to more developers to understand (at least one of .NET or Java

cgillum · 2024-07-09T13:55:32Z

...cs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

+	ctx := context.Background()
+	client, engine := startEngine(ctx, r)
+
+	instanceID := api.InstanceID("IGNORE_IF_RUNNING_OR_COMPLETED")


The string value here is intended to be the workflow ID, which is typically some business identity or is random (in which case we don't use it at all). It looks like we're trying to specify a policy as a workflow ID, which is a bit confusing. I think it would be better to not specify an explicit workflow ID at all to avoid confusion.

Given this code all need to change to workflow example, this can be changed at the same time.

msfussell

@kaibocai - This is important information. Can you update this PR, with workflow examples and a description of the "why" for each of the policies? Thanks

msfussell · 2024-07-09T22:13:53Z

...cs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

+```go
+func main() {
+	r := task.NewTaskRegistry()
+	r.AddOrchestratorN("SingleActivity", func(ctx *task.OrchestrationContext) (any, error) {


Yes, please rework this code to use Workflow and keep this as simple as needed. I suggest having this in at least 2 languages also so that this is open to more developers to understand (at least one of .NET or Java

msfussell · 2024-07-09T22:16:44Z

...cs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

+	ctx := context.Background()
+	client, engine := startEngine(ctx, r)
+
+	instanceID := api.InstanceID("IGNORE_IF_RUNNING_OR_COMPLETED")


Given this code all need to change to workflow example, this can be changed at the same time.

msfussell · 2024-07-09T22:16:57Z

...cs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md

+
+You can use the following policies to reuse workflow IDs:
+
+| Policies | Description | 


So there are only two Workflow reuse ID policies? What is the default if not set?

Why would use REUSE_ID_ACTION_IGNORE? This just means that a new workflow can never be started if there is an existing one already?

github-actions · 2024-07-15T00:10:22Z

Stale PR, paging all reviewers

hhunter-ms · 2024-07-16T18:03:31Z

Closing for now as this is not supported in any SDK at the moment.

add examples

fb3c1e0

Signed-off-by: Hannah Hunter <[email protected]>

hhunter-ms self-assigned this Jun 26, 2024

hhunter-ms requested review from a team as code owners June 26, 2024 16:00

msfussell reviewed Jun 26, 2024

View reviewed changes

hhunter-ms and others added 3 commits June 27, 2024 11:17

attempting to clarify

2ca982b

Signed-off-by: Hannah Hunter <[email protected]>

tweak first example

f1ebce8

Signed-off-by: Hannah Hunter <[email protected]>

Merge branch 'v1.13' into issue_3909

1761f30

msfussell reviewed Jun 27, 2024

View reviewed changes

github-actions bot added the stale label Jul 4, 2024

hhunter-ms removed the stale label Jul 8, 2024

Merge branch 'v1.13' into issue_3909

8272c18

hhunter-ms added 2 commits July 8, 2024 16:48

small update

02087f2

Signed-off-by: Hannah Hunter <[email protected]>

Merge branch 'issue_3909' of https://github.com/hhunter-ms/docs into …

ba2c043

…issue_3909

cgillum reviewed Jul 9, 2024

View reviewed changes

msfussell reviewed Jul 9, 2024

View reviewed changes

msfussell added the P0 label Jul 9, 2024

msfussell added this to the 1.14 milestone Jul 9, 2024

github-actions bot added the stale label Jul 15, 2024

hhunter-ms removed the stale label Jul 15, 2024

hhunter-ms closed this Jul 16, 2024

hhunter-ms modified the milestones: 1.14, 1.15 Jul 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Workflow] Add examples for reuse ID policy #4237

[Workflow] Add examples for reuse ID policy #4237

hhunter-ms commented Jun 26, 2024

kaibocai commented Jun 26, 2024

msfussell left a comment

msfussell Jun 26, 2024

kaibocai Jun 28, 2024

msfussell Jul 9, 2024

msfussell Jun 27, 2024

msfussell Jun 27, 2024

hhunter-ms Jun 27, 2024

kaibocai Jun 28, 2024 •

edited

Loading

msfussell Jul 9, 2024 •

edited

Loading

github-actions bot commented Jul 4, 2024

hhunter-ms commented Jul 8, 2024

cgillum Jul 9, 2024

msfussell Jul 9, 2024

cgillum Jul 9, 2024

msfussell Jul 9, 2024

msfussell left a comment

msfussell Jul 9, 2024

msfussell Jul 9, 2024

msfussell Jul 9, 2024

github-actions bot commented Jul 15, 2024

hhunter-ms commented Jul 16, 2024


		You can use the following policies to reuse workflow IDs:

		\| Policies \| Description \|

[Workflow] Add examples for reuse ID policy #4237

[Workflow] Add examples for reuse ID policy #4237

Conversation

hhunter-ms commented Jun 26, 2024

Description

Issue reference

kaibocai commented Jun 26, 2024

msfussell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaibocai Jun 28, 2024 • edited Loading

Choose a reason for hiding this comment

msfussell Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jul 4, 2024

hhunter-ms commented Jul 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msfussell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jul 15, 2024

hhunter-ms commented Jul 16, 2024

kaibocai Jun 28, 2024 •

edited

Loading

msfussell Jul 9, 2024 •

edited

Loading