add sample for workflow update #40

antmendoza · 2023-11-01T18:50:41Z

What was changed

Why?

Checklist

Closes
How was this tested:

Any docs updates needed?

antmendoza · 2023-11-01T19:03:22Z

@cretz I am trying to implement an example for workflow update, in test environment the [WorkflowUpdate] method never gets executed.

this is the stacktrace

[xUnit.net 00:00:00.35]     TemporalioSamples.Tests.Encryption.CodecServer.CodecServerTests.CodecServer_WithEncryptionCodec_WorksProperly [SKIP]
  Skipped TemporalioSamples.Tests.Encryption.CodecServer.CodecServerTests.CodecServer_WithEncryptionCodec_WorksProperly [1 ms]
[xUnit.net 00:00:30.61]     TemporalioSamples.Tests.WorkflowUpdate.MyWorkflowTests.RunAsync_SimpleRun_Succeeds [FAIL]
  Failed TemporalioSamples.Tests.WorkflowUpdate.MyWorkflowTests.RunAsync_SimpleRun_Succeeds [30 s]
  Error Message:
   Temporalio.Exceptions.RpcException : Timeout expired
  Stack Trace:
     at Temporalio.Bridge.Client.CallAsync[T](RpcService service, String rpc, IMessage req, MessageParser`1 resp, Boolean retry, IEnumerable`1 metadata, Nullable`1 timeout, Nullable`1 cancellationToken)
   at Temporalio.Client.TemporalConnection.InvokeRpcAsync[T](RpcService service, String rpc, IMessage req, MessageParser`1 resp, RpcOptions options)
   at Temporalio.Client.WorkflowService.UpdateWorkflowExecutionAsync(UpdateWorkflowExecutionRequest req, RpcOptions options)
   at Temporalio.Client.TemporalClient.Impl.StartWorkflowUpdateAsync[TResult](StartWorkflowUpdateInput input)
   at Temporalio.Client.WorkflowHandle`1.ExecuteUpdateAsync[TUpdateResult](Expression`1 updateCall, WorkflowUpdateOptions options)
   at TemporalioSamples.Tests.WorkflowUpdate.MyWorkflowTests.<>c__DisplayClass1_0.<<RunAsync_SimpleRun_Succeeds>b__0>d.MoveNext() in /Users/antmendoza/dev/temporal/_dotnet/samples-dotnet/tests/WorkflowUpdate/MyWorkflowTests.cs:line 36
--- End of stack trace from previous location ---
   at Temporalio.Worker.TemporalWorker.ExecuteInternalAsync(Func`1 untilComplete, CancellationToken stoppingToken)
   at Temporalio.Worker.TemporalWorker.ExecuteInternalAsync(Func`1 untilComplete, CancellationToken stoppingToken)
   at TemporalioSamples.Tests.WorkflowUpdate.MyWorkflowTests.RunAsync_SimpleRun_Succeeds() in /Users/antmendoza/dev/temporal/_dotnet/samples-dotnet/tests/WorkflowUpdate/MyWorkflowTests.cs:line 25
   at TemporalioSamples.Tests.WorkflowUpdate.MyWorkflowTests.RunAsync_SimpleRun_Succeeds() in /Users/antmendoza/dev/temporal/_dotnet/samples-dotnet/tests/WorkflowUpdate/MyWorkflowTests.cs:line 25
--- End of stack trace from previous location ---

I might be doing something wrong, any idea?

thank you

cretz · 2023-11-01T19:48:25Z

I wonder if this is an issue with the time skipping test server. I will set aside some time to debug that, but see if it works with WorkflowEnvironment.StartLocalAsync in the meantime.

antmendoza · 2023-11-02T08:22:09Z

now that you mention skipping test server , my laptop is not x86/x64 , but the rest of the test are working for me

antmendoza · 2023-11-02T11:04:18Z

await using var env = await WorkflowEnvironment.StartLocalAsync();
works

cretz · 2023-11-02T12:25:57Z

Can you check whether all uses of StartTimeSkippingAsync fail for you or just update? I haven't gotten around to investigating this issue yet.

antmendoza · 2023-11-07T20:59:49Z

@cretz sorry I didn't come back before,

Can you check whether all uses of StartTimeSkippingAsync fail for you or just update?

I am not really sure what you mean with "all uses". Tested

query
signal
DelayAsync
WaitConditionAsync

and it works.

Is there anything else I can test?

cretz · 2023-11-07T21:09:24Z

Is there anything else I can test?

No, that confirms that the time-skipping test server does not currently work with update but does with other things. Use StartLocalAsync for now so your PR will go through. If you'd like you can open an issue on the .NET repo (though it is likely a problem w/ the Java test server).

antmendoza · 2024-02-25T18:14:56Z

@cretz sorry forgot about this.. I am working on it again.

For this example, I am implementing a UI wizard. The user submits a screen, the workflow processes the screen (maybe execute some activities) and returns the id of the next screen.

I have a small issue, implementation issue, nothing to do with dotnet,

If I remove this line https://github.com/temporalio/samples-dotnet/pull/40/files#diff-6717af88ce41823890a56df6172522c7503b0829944f308df6cf29549e1404c1R25 the workflow completes before the update handler returns

Event WorkflowExecutionUpdateCompleted is missing

Am I doing something wrong?

cretz · 2024-02-26T14:47:00Z

@antmendoza - hrmm, I would expect instant update completion (as failure since workflow completed) upon workflow completion. Can you bring this up internally and tag me (e.g. start discussion with server team)?

…orkflow

antmendoza

the PR is ready @cretz ,

thank you

antmendoza · 2024-03-05T12:11:21Z

tests/TimeSkippingServerFact.cs

 /// </remarks>
 public sealed class TimeSkippingServerFactAttribute : FactAttribute
 {
    public TimeSkippingServerFactAttribute()
    {
-        if (RuntimeInformation.ProcessArchitecture != Architecture.X86 &&
-            RuntimeInformation.ProcessArchitecture != Architecture.X64)
+        var processArchitecture = RuntimeInformation.ProcessArchitecture;


I had to change this file to have some tests working on my laptop, let me know if it makes sense @cretz or you want me to revert it back

Yeah, this will fail CI. The problem is your macOS ARM does run fine, but Linux ARM does not. You should revert it back and not use [TimeSkippingServerFact] on your tests since you're not using the time-skipping test server.

cretz

Sorry, added several more comments, but the only two that really matter are the time skipping fact attribute update and the sln file conflict.

cretz · 2024-03-05T13:47:34Z

tests/TimeSkippingServerFact.cs

 /// </remarks>
 public sealed class TimeSkippingServerFactAttribute : FactAttribute
 {
    public TimeSkippingServerFactAttribute()
    {
-        if (RuntimeInformation.ProcessArchitecture != Architecture.X86 &&
-            RuntimeInformation.ProcessArchitecture != Architecture.X64)
+        var processArchitecture = RuntimeInformation.ProcessArchitecture;


Yeah, this will fail CI. The problem is your macOS ARM does run fine, but Linux ARM does not. You should revert it back and not use [TimeSkippingServerFact] on your tests since you're not using the time-skipping test server.

cretz · 2024-03-05T13:48:11Z

TemporalioSamples.sln

This file is conflicting with main. Since it's kinda an opaque file, you may have to merge, accept main's version, and then dotnet add this project again

cretz · 2024-03-05T13:49:13Z

src/WorkflowUpdate/UiRequest.cs

@@ -0,0 +1,3 @@
+namespace TemporalioSamples.WorkflowUpdate;
+
+public record UiRequest(string RequestId, ScreenId ScreenId);


Could have also just made this and ScreenId as inner classes of the workflow itself, but this is fine too

cretz · 2024-03-05T13:51:01Z

src/WorkflowUpdate/WorkflowUpdate.workflow.cs

+    [WorkflowQuery]
+    public ScreenId GetCurrentScreen()
+    {
+        return screen;
+    }


May be clearer to make this a property and remove the screen field (queries as property getters is a neat .NET feature).

Suggested change

[WorkflowQuery]

public ScreenId GetCurrentScreen()

{

return screen;

}

[WorkflowQuery]

public ScreenId CurrentScreen { get; private set; } = ScreenId.Screen1;

cretz · 2024-03-05T13:54:34Z

src/WorkflowUpdate/WorkflowUpdate.workflow.cs

+        await Workflow.WaitConditionAsync(() => !requests.Any());
+        updateInProgress = true;


If you're counting on one in-flight update at a time, might as well not use a queue, but instead just have a private UiRequest? pendingRequest field that you set.

cretz · 2024-03-05T13:55:10Z

src/WorkflowUpdate/WorkflowUpdate.workflow.cs

+        }
+
+        // Ensure update method has completed
+        await Workflow.WaitConditionAsync(() => !updateInProgress);


Might as well do the per-update wait in the loop for each update

Suggested change

}

// Ensure update method has completed

await Workflow.WaitConditionAsync(() => !updateInProgress);

// Ensure update method has completed

await Workflow.WaitConditionAsync(() => !updateInProgress);

}

cretz · 2024-03-05T13:55:48Z

src/WorkflowUpdate/WorkflowUpdate.workflow.cs

+        return screen;
+    }
+
+    private bool IsLastScreen()


Can probably inline this single-use one-liner into the while loop

cretz · 2024-03-05T14:15:04Z

src/WorkflowUpdate/WorkflowUpdate.workflow.cs

+    private bool updateInProgress;
+
+    [WorkflowRun]
+    public async Task RunAsync()


Technically it may be clearer to have the update handler have its own logic and if it needs to have a homemade lock to prevent other updates from running using a bool field like you have, so be it, and the run function just be public Task RunAsync() => Workflow.WaitConditionAsync(() => CurrentScreen == ScreenId.End), but what you have here is fine too.

antmendoza · 2024-03-06T09:10:11Z

@cretz thanks, I've implemented the suggested changes. The code looks much clearer now

I've implemented the suggested change

I think, feel free to add more comments if something can be improved

cretz

LGTM, just minor suggestions, not required

cretz · 2024-03-06T14:05:55Z

src/WorkflowUpdate/WorkflowUpdate.workflow.cs

+    public async Task RunAsync()
+    {
+        await Workflow.WaitConditionAsync(() => currentScreen == ScreenId.End);
+    }


Suggested change

public async Task RunAsync()

{

await Workflow.WaitConditionAsync(() => currentScreen == ScreenId.End);

}

public Task RunAsync() => Workflow.WaitConditionAsync(() => currentScreen == ScreenId.End);

Can shorten to this if you want, but don't have to

cretz · 2024-03-06T14:06:12Z

src/WorkflowUpdate/WorkflowUpdate.workflow.cs

+        return currentScreen;
+    }
+
+    private void SetNextScreen(UiRequest currentRequest)


Why make this a separate method? It's just a one-liner

It makes the code easier (for me) to read than having...

updateInProgress = true; // Activities can be scheduled here currentScreen = request.ScreenId switch { ScreenId.Screen1 => ScreenId.Screen2, ScreenId.Screen2 => ScreenId.End, _ => currentScreen, }; updateInProgress = false;

wdyt?

cretz · 2024-03-06T14:07:09Z

tests/WorkflowUpdate/WorkflowUpdateTests.cs

+    {
+    }
+
+    [TimeSkippingServerFact]


I think you can remove this attribute since you're not using time-skipping

I tried but it does not work? what should I put instead ?

ok [Fact] seems to work

Yes, sorry, [Fact] required for all tests (the [TimeSkippingServerFact] is just a special kind)

cretz · 2024-03-06T14:08:13Z

tests/WorkflowUpdate/WorkflowUpdateTests.cs

+        });
+    }
+
+    [TimeSkippingServerFact]


I think you can remove this attribute since you're not using time-skipping

cretz · 2024-03-06T20:31:55Z

src/WorkflowUpdate/WorkflowUpdate.workflow.cs

+    private ScreenId currentScreen = ScreenId.Screen1;
+
+    [WorkflowRun]
+    public async Task RunAsync() => await Workflow.WaitConditionAsync(() => currentScreen == ScreenId.End);


Suggested change

public async Task RunAsync() => await Workflow.WaitConditionAsync(() => currentScreen == ScreenId.End);

public Task RunAsync() => Workflow.WaitConditionAsync(() => currentScreen == ScreenId.End);

Probably could be this, but what you have is good too

cretz · 2024-03-06T20:41:53Z

Looks great, merge whenever.

wip

46c580f

antmendoza requested a review from cretz November 1, 2023 18:50

antmendoza marked this pull request as draft November 1, 2023 18:52

wip

47a3ada

antmendoza removed the request for review from cretz November 1, 2023 19:03

antmendoza mentioned this pull request Nov 1, 2023

Sample request: Workflow update #37

Open

antmendoza added 3 commits February 24, 2024 19:19

Merge remote-tracking branch 'core/main' into workflowupdate

a07ed2c

wip

3c1b1c7

wip

8d9cec8

wip

e0fbdcb

antmendoza force-pushed the workflowupdate branch from 9f88621 to e0fbdcb Compare February 25, 2024 18:24

add flag to wait for the update-method to finish before closing the w…

df8b300

…orkflow

antmendoza changed the title ~~[WIP] add sample for workflow update~~ add sample for workflow update Mar 5, 2024

antmendoza commented Mar 5, 2024

View reviewed changes

antmendoza marked this pull request as ready for review March 5, 2024 12:12

cretz reviewed Mar 5, 2024

View reviewed changes

antmendoza added 2 commits March 6, 2024 06:42

refactor, implementing the changes suggested in the code review.

8ca39bc

Merge remote-tracking branch 'core/main' into workflowupdate

fcacdf8

antmendoza marked this pull request as draft March 6, 2024 05:59

added-readme

b364ce4

antmendoza self-assigned this Mar 6, 2024

antmendoza requested a review from cretz March 6, 2024 09:10

antmendoza marked this pull request as ready for review March 6, 2024 09:10

antmendoza added 2 commits March 6, 2024 10:13

fix-TemporalioSamples

04c4266

revert-TimeSkippingServerFact.cs

4246519

antmendoza removed their assignment Mar 6, 2024

format

6c4cbc1

cretz approved these changes Mar 6, 2024

View reviewed changes

implementing the changes suggested in the PR

a9c2c76

cretz approved these changes Mar 6, 2024

View reviewed changes

antmendoza merged commit 49c0c06 into temporalio:main Mar 6, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add sample for workflow update #40

add sample for workflow update #40

antmendoza commented Nov 1, 2023

antmendoza commented Nov 1, 2023

cretz commented Nov 1, 2023

antmendoza commented Nov 2, 2023

antmendoza commented Nov 2, 2023

cretz commented Nov 2, 2023

antmendoza commented Nov 7, 2023

cretz commented Nov 7, 2023

antmendoza commented Feb 25, 2024 •

edited

Loading

cretz commented Feb 26, 2024 •

edited

Loading

antmendoza left a comment

antmendoza Mar 5, 2024

cretz Mar 5, 2024

cretz left a comment

cretz Mar 5, 2024

cretz Mar 5, 2024

cretz Mar 5, 2024

cretz Mar 5, 2024

cretz Mar 5, 2024

cretz Mar 5, 2024

cretz Mar 5, 2024

cretz Mar 5, 2024

antmendoza commented Mar 6, 2024 •

edited

Loading

cretz left a comment

cretz Mar 6, 2024

cretz Mar 6, 2024

antmendoza Mar 6, 2024

cretz Mar 6, 2024

antmendoza Mar 6, 2024

antmendoza Mar 6, 2024

cretz Mar 6, 2024 •

edited

Loading

cretz Mar 6, 2024

cretz Mar 6, 2024

cretz commented Mar 6, 2024

		@@ -0,0 +1,3 @@
		namespace TemporalioSamples.WorkflowUpdate;

		public record UiRequest(string RequestId, ScreenId ScreenId);

		await Workflow.WaitConditionAsync(() => !requests.Any());
		updateInProgress = true;

	public async Task RunAsync() => await Workflow.WaitConditionAsync(() => currentScreen == ScreenId.End);
	public Task RunAsync() => Workflow.WaitConditionAsync(() => currentScreen == ScreenId.End);

add sample for workflow update #40

add sample for workflow update #40

Conversation

antmendoza commented Nov 1, 2023

What was changed

Why?

Checklist

antmendoza commented Nov 1, 2023

cretz commented Nov 1, 2023

antmendoza commented Nov 2, 2023

antmendoza commented Nov 2, 2023

cretz commented Nov 2, 2023

antmendoza commented Nov 7, 2023

cretz commented Nov 7, 2023

antmendoza commented Feb 25, 2024 • edited Loading

cretz commented Feb 26, 2024 • edited Loading

antmendoza left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cretz 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antmendoza commented Mar 6, 2024 • edited Loading

cretz 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

cretz Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cretz commented Mar 6, 2024

antmendoza commented Feb 25, 2024 •

edited

Loading

cretz commented Feb 26, 2024 •

edited

Loading

antmendoza commented Mar 6, 2024 •

edited

Loading

cretz Mar 6, 2024 •

edited

Loading