WorkflowTestSuite.UpdateWorkflow generate an update ID if none (#1738)

internal/internal_workflow_testsuite.go

@@ -2933,6 +2933,9 @@ func (env *testWorkflowEnvironmentImpl) updateWorkflow(name string, id string, u
 	if err != nil {
 		panic(err)
 	}
+	if id == "" {
+		id = uuid.NewString()
+	}
 
 	if env.updateMap == nil {
 		env.updateMap = make(map[string]*updateResult)

internal/workflow_testsuite.go

@@ -1091,7 +1091,9 @@ func (e *TestWorkflowEnvironment) QueryWorkflow(queryType string, args ...interf
 	return e.impl.queryWorkflow(queryType, args...)
 }
 
-// UpdateWorkflow sends an update to the currently running workflow.
+// UpdateWorkflow sends an update to the currently running workflow. The updateName is the name of the update handler
+// to be invoked. The updateID is a unique identifier for the update. If updateID is an empty string a UUID will be generated.
+// The update callbacks are used to handle the update. The args are the arguments to be passed to the update handler.
 func (e *TestWorkflowEnvironment) UpdateWorkflow(updateName, updateID string, uc UpdateCallbacks, args ...interface{}) {
 	e.impl.updateWorkflow(updateName, updateID, uc, args...)
 }

internal/workflow_testsuite_test.go

@@ -395,6 +395,67 @@ func TestWorkflowUpdateOrder(t *testing.T) {
 	require.Equal(t, 1, result)
 }
 
+func TestWorkflowUpdateIdGeneration(t *testing.T) {
+	var suite WorkflowTestSuite
+	env := suite.NewTestWorkflowEnvironment()
+	env.RegisterDelayedCallback(func() {
+		env.UpdateWorkflow("update", "", &TestUpdateCallback{
+			OnReject: func(err error) {
+				require.Fail(t, "update should not be rejected")
+			},
+			OnAccept:   func() {},
+			OnComplete: func(interface{}, error) {},
+		})
+	}, 0)
+	env.RegisterDelayedCallback(func() {
+		env.UpdateWorkflow("update", "", &TestUpdateCallback{
+			OnReject: func(err error) {
+			},
+			OnAccept: func() {
+				require.Fail(t, "update should be rejected")
+			},
+			OnComplete: func(interface{}, error) {
+			},
+		})
+	}, time.Second)
+
+	env.ExecuteWorkflow(func(ctx Context) (int, error) {
+		var inflightUpdates int
+		var ranUpdates int
+		err := SetUpdateHandler(ctx, "update", func(ctx Context) error {
+			inflightUpdates++
+			ranUpdates++
+			defer func() {
+				inflightUpdates--
+			}()
+			return Sleep(ctx, time.Hour)
+		}, UpdateHandlerOptions{
+			Validator: func() error {
+				if inflightUpdates > 0 {
+					return errors.New("inflight updates should be 0")
+				}
+				return nil
+			},
+		})
+		if err != nil {
+			return 0, err
+		}
+		err = Await(ctx, func() bool { return inflightUpdates == 0 })
+		if err != nil {
+			return 0, err
+		}
+		err = Sleep(ctx, time.Minute)
+		if err != nil {
+			return 0, err
+		}
+		return ranUpdates, err
+	})
+	require.NoError(t, env.GetWorkflowError())
+	var result int
+	require.NoError(t, env.GetWorkflowResult(&result))
+	require.Equal(t, 1, result)
+}
+
 func TestWorkflowNotRegisteredRejected(t *testing.T) {
 	var suite WorkflowTestSuite
 	// Test UpdateWorkflowByID works with custom ID