Disable eager start by default (temporalio#1879)

HuruPlatform · Oct 5, 2023 · b083a70 · b083a70
1 parent 3670bce
commit b083a70
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 10 deletions.
diff --git a/temporal-sdk/src/main/java/io/temporal/client/WorkflowOptions.java b/temporal-sdk/src/main/java/io/temporal/client/WorkflowOptions.java
@@ -105,7 +105,7 @@ public static final class Builder {
 
     private List<ContextPropagator> contextPropagators;
 
-    private boolean disableEagerExecution;
+    private boolean disableEagerExecution = true;
 
     private Builder() {}
 
@@ -331,6 +331,11 @@ public Builder setContextPropagators(@Nullable List<ContextPropagator> contextPr
      * could be dispatched on this local worker with the response to the start call if Server
      * supports it. This option can be used to disable this mechanism.
      *
+     * <p>Default is true
+     *
+     * <p>WARNING: Eager start does not respect worker versioning. An eagerly started workflow may
+     * run on any available local worker even if that worker is not in the default build ID set.
+     *
      * @param disableEagerExecution if true, an eager local execution of the workflow task will
      *     never be requested even if it is possible.
      */

diff --git a/temporal-sdk/src/test/java/io/temporal/workflow/EagerWorkflowTaskDispatchTest.java b/temporal-sdk/src/test/java/io/temporal/workflow/EagerWorkflowTaskDispatchTest.java
@@ -98,15 +98,21 @@ public void workflowIsEagerlyDispatchedOnTheWorkerRegisteredWithTheCorrespondent
             .getWorkflowClient()
             .newWorkflowStub(
                 TestWorkflows.NoArgsWorkflow.class,
-                WorkflowOptions.newBuilder().setTaskQueue(testWorkflowRule.getTaskQueue()).build());
+                WorkflowOptions.newBuilder()
+                    .setTaskQueue(testWorkflowRule.getTaskQueue())
+                    .setDisableEagerExecution(false)
+                    .build());
     workflowStub1.execute();
     assertTrue(START_CALL_INTERCEPTOR.wasLastStartEager);
     TestWorkflows.NoArgsWorkflow workflowStub2 =
         workerFactory2
             .getWorkflowClient()
             .newWorkflowStub(
                 TestWorkflows.NoArgsWorkflow.class,
-                WorkflowOptions.newBuilder().setTaskQueue(testWorkflowRule.getTaskQueue()).build());
+                WorkflowOptions.newBuilder()
+                    .setTaskQueue(testWorkflowRule.getTaskQueue())
+                    .setDisableEagerExecution(false)
+                    .build());
     workflowStub2.execute();
     assertTrue(START_CALL_INTERCEPTOR.wasLastStartEager);
 
@@ -151,7 +157,10 @@ public void testNoEagerWorkflowTaskIfWorkerHasNoWorkflowsRegistered() {
             .getWorkflowClient()
             .newWorkflowStub(
                 TestWorkflows.NoArgsWorkflow.class,
-                WorkflowOptions.newBuilder().setTaskQueue(testWorkflowRule.getTaskQueue()).build());
+                WorkflowOptions.newBuilder()
+                    .setTaskQueue(testWorkflowRule.getTaskQueue())
+                    .setDisableEagerExecution(false)
+                    .build());
     workflowStub.execute();
     assertFalse(
         "Eager dispatch shouldn't be requested for activity-only worker",
@@ -181,7 +190,10 @@ public void testNoEagerWorkflowTaskIfWorkerIsNotStarted() {
             .getWorkflowClient()
             .newWorkflowStub(
                 TestWorkflows.NoArgsWorkflow.class,
-                WorkflowOptions.newBuilder().setTaskQueue(testWorkflowRule.getTaskQueue()).build());
+                WorkflowOptions.newBuilder()
+                    .setTaskQueue(testWorkflowRule.getTaskQueue())
+                    .setDisableEagerExecution(false)
+                    .build());
     workflowStub.execute();
     assertFalse(
         "Eager dispatch shouldn't be requested for a not started worker",
@@ -212,7 +224,10 @@ public void testNoEagerWorkflowTaskIfWorkerIsSuspended() {
             .getWorkflowClient()
             .newWorkflowStub(
                 TestWorkflows.NoArgsWorkflow.class,
-                WorkflowOptions.newBuilder().setTaskQueue(testWorkflowRule.getTaskQueue()).build());
+                WorkflowOptions.newBuilder()
+                    .setTaskQueue(testWorkflowRule.getTaskQueue())
+                    .setDisableEagerExecution(false)
+                    .build());
     workflowStub.execute();
     assertFalse(
         "Eager dispatch shouldn't be requested for a suspended worker",
@@ -233,10 +248,7 @@ public void testNoEagerWFTIfDisabledOnWorkflowOptions() {
             .getWorkflowClient()
             .newWorkflowStub(
                 TestWorkflows.NoArgsWorkflow.class,
-                WorkflowOptions.newBuilder()
-                    .setTaskQueue(testWorkflowRule.getTaskQueue())
-                    .setDisableEagerExecution(true)
-                    .build());
+                WorkflowOptions.newBuilder().setTaskQueue(testWorkflowRule.getTaskQueue()).build());
     workflowStub.execute();
     assertFalse(START_CALL_INTERCEPTOR.wasLastStartEager);