Add executeWorkflow method for WorkflowInterceptor to match go client library (#779)

* executeWorkflowPath 
-- added executeWorkflow method
-- added ExecutionInput class for getting input
-- fixed tracer and tests

Author: abhishekj720

src/main/java/com/uber/cadence/internal/sync/SyncDecisionContext.java

@@ -127,6 +127,12 @@ public WorkflowInterceptor getWorkflowInterceptor() {
     return headInterceptor;
   }
 
+  @Override
+  public byte[] executeWorkflow(
+      SyncWorkflowDefinition workflowDefinition, WorkflowExecuteInput input) {
+    return workflowDefinition.execute(input.getInput());
+  }
+
   @Override
   public <T> Promise<T> executeActivity(
       String activityName,

src/main/java/com/uber/cadence/internal/sync/SyncWorkflowDefinition.java

@@ -17,7 +17,7 @@
 
 package com.uber.cadence.internal.sync;
 
-interface SyncWorkflowDefinition {
+public interface SyncWorkflowDefinition {
 
   byte[] execute(byte[] input);
 

src/main/java/com/uber/cadence/internal/sync/TestActivityEnvironmentInternal.java

@@ -29,14 +29,9 @@
 import com.uber.cadence.serviceclient.IWorkflowService;
 import com.uber.cadence.testing.TestActivityEnvironment;
 import com.uber.cadence.testing.TestEnvironmentOptions;
-import com.uber.cadence.workflow.ActivityFailureException;
-import com.uber.cadence.workflow.ChildWorkflowOptions;
-import com.uber.cadence.workflow.ContinueAsNewOptions;
+import com.uber.cadence.workflow.*;
 import com.uber.cadence.workflow.Functions.Func;
 import com.uber.cadence.workflow.Functions.Func1;
-import com.uber.cadence.workflow.Promise;
-import com.uber.cadence.workflow.Workflow;
-import com.uber.cadence.workflow.WorkflowInterceptor;
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.Proxy;
 import java.lang.reflect.Type;
@@ -107,7 +102,8 @@ public <T> T newActivityStub(Class<T> activityInterface) {
     ActivityOptions options =
         new ActivityOptions.Builder().setScheduleToCloseTimeout(Duration.ofDays(1)).build();
     InvocationHandler invocationHandler =
-        ActivityInvocationHandler.newInstance(options, new TestActivityExecutor(workflowService));
+        ActivityInvocationHandler.newInstance(
+            options, new TestActivityExecutor(workflowService, null));
     invocationHandler = new DeterministicRunnerWrapper(invocationHandler);
     return ActivityInvocationHandlerBase.newProxy(activityInterface, invocationHandler);
   }
@@ -131,12 +127,13 @@ public void setWorkflowService(IWorkflowService workflowService) {
     this.activityTaskHandler.setWorkflowService(service);
   }
 
-  private class TestActivityExecutor implements WorkflowInterceptor {
+  private class TestActivityExecutor extends WorkflowInterceptorBase {
 
     @SuppressWarnings("UnusedVariable")
     private final IWorkflowService workflowService;
 
-    TestActivityExecutor(IWorkflowService workflowService) {
+    TestActivityExecutor(IWorkflowService workflowService, WorkflowInterceptorBase next) {
+      super(next);
       this.workflowService = workflowService;
     }
 

src/main/java/com/uber/cadence/internal/sync/WorkflowRunnable.java

@@ -18,6 +18,7 @@
 package com.uber.cadence.internal.sync;
 
 import com.uber.cadence.WorkflowExecutionStartedEventAttributes;
+import com.uber.cadence.workflow.WorkflowInterceptor;
 import java.util.Objects;
 
 class WorkflowRunnable implements Runnable {
@@ -43,8 +44,10 @@ public WorkflowRunnable(
   @Override
   public void run() {
     try {
-
-      output = workflow.execute(attributes.getInput());
+      WorkflowInterceptor interceptor = context.getWorkflowInterceptor();
+      output =
+          interceptor.executeWorkflow(
+              workflow, new WorkflowInterceptor.WorkflowExecuteInput(attributes));
     } finally {
       done = true;
     }

src/main/java/com/uber/cadence/workflow/WorkflowInterceptor.java

@@ -18,20 +18,42 @@
 package com.uber.cadence.workflow;
 
 import com.uber.cadence.WorkflowExecution;
+import com.uber.cadence.WorkflowExecutionStartedEventAttributes;
+import com.uber.cadence.WorkflowType;
 import com.uber.cadence.activity.ActivityOptions;
 import com.uber.cadence.activity.LocalActivityOptions;
+import com.uber.cadence.internal.sync.SyncWorkflowDefinition;
+import com.uber.cadence.internal.worker.WorkflowExecutionException;
 import com.uber.cadence.workflow.Functions.Func;
 import java.lang.reflect.Type;
 import java.time.Duration;
-import java.util.Map;
-import java.util.Optional;
-import java.util.Random;
-import java.util.UUID;
+import java.util.*;
+import java.util.concurrent.CancellationException;
 import java.util.function.BiPredicate;
 import java.util.function.Supplier;
 
 public interface WorkflowInterceptor {
 
+  public final class WorkflowExecuteInput {
+    private final WorkflowExecutionStartedEventAttributes workflowEventStart;
+    private final WorkflowType workflowType;
+    private final byte[] input;
+
+    public WorkflowExecuteInput(WorkflowExecutionStartedEventAttributes workflowEventStart) {
+      this.workflowEventStart = workflowEventStart;
+      this.workflowType = workflowEventStart.workflowType;
+      this.input = workflowEventStart.getInput();
+    }
+
+    public WorkflowType getWorkflowType() {
+      return workflowType;
+    }
+
+    public byte[] getInput() {
+      return input;
+    }
+  }
+
   final class WorkflowResult<R> {
 
     private final Promise<R> result;
@@ -51,6 +73,10 @@ public Promise<WorkflowExecution> getWorkflowExecution() {
     }
   }
 
+  // to match behavior in go client: interceptor executeWorkflow method
+  byte[] executeWorkflow(SyncWorkflowDefinition workflowDefinition, WorkflowExecuteInput input)
+      throws CancellationException, WorkflowExecutionException;
+
   <R> Promise<R> executeActivity(
       String activityName,
       Class<R> resultClass,

src/main/java/com/uber/cadence/workflow/WorkflowInterceptorBase.java

@@ -20,14 +20,12 @@
 import com.uber.cadence.WorkflowExecution;
 import com.uber.cadence.activity.ActivityOptions;
 import com.uber.cadence.activity.LocalActivityOptions;
+import com.uber.cadence.internal.sync.SyncWorkflowDefinition;
 import com.uber.cadence.workflow.Functions.Func;
 import com.uber.cadence.workflow.Functions.Func1;
 import java.lang.reflect.Type;
 import java.time.Duration;
-import java.util.Map;
-import java.util.Optional;
-import java.util.Random;
-import java.util.UUID;
+import java.util.*;
 import java.util.function.BiPredicate;
 import java.util.function.Supplier;
 
@@ -40,6 +38,14 @@ public WorkflowInterceptorBase(WorkflowInterceptor next) {
     this.next = next;
   }
 
+  // base interceptor executeWorkflow method: no-op interceptors delegate calls to next interceptors
+  // used for users to create new interceptors easily
+  @Override
+  public byte[] executeWorkflow(
+      SyncWorkflowDefinition workflowDefinition, WorkflowExecuteInput input) {
+    return next.executeWorkflow(workflowDefinition, input);
+  }
+
   @Override
   public <R> Promise<R> executeActivity(
       String activityName,

src/test/java/com/uber/cadence/workflow/WorkflowTest.java

@@ -62,8 +62,10 @@
 import com.uber.cadence.converter.JsonDataConverter;
 import com.uber.cadence.internal.common.WorkflowExecutionUtils;
 import com.uber.cadence.internal.sync.DeterministicRunnerTest;
+import com.uber.cadence.internal.sync.SyncWorkflowDefinition;
 import com.uber.cadence.internal.sync.TestWorkflowEnvironmentInternal;
 import com.uber.cadence.internal.worker.PollerOptions;
+import com.uber.cadence.internal.worker.WorkflowExecutionException;
 import com.uber.cadence.serviceclient.ClientOptions;
 import com.uber.cadence.serviceclient.IWorkflowService;
 import com.uber.cadence.serviceclient.WorkflowServiceTChannel;
@@ -503,6 +505,7 @@ public void testSync() {
     String result = workflowStub.execute(taskList);
     assertEquals("activity10", result);
     tracer.setExpected(
+        "executeWorkflow: TestWorkflow1::execute",
         "sleep PT2S",
         "executeActivity TestActivities::activityWithDelay",
         "executeActivity TestActivities::activity2");
@@ -1276,7 +1279,16 @@ public void testContinueAsNew() {
             TestContinueAsNew.class, newWorkflowOptionsBuilder(this.taskList).build());
     int result = client.execute(4, continuedTaskList);
     assertEquals(111, result);
-    tracer.setExpected("continueAsNew", "continueAsNew", "continueAsNew", "continueAsNew");
+    tracer.setExpected(
+        "executeWorkflow: TestContinueAsNew::execute",
+        "continueAsNew",
+        "executeWorkflow: TestContinueAsNew::execute",
+        "continueAsNew",
+        "executeWorkflow: TestContinueAsNew::execute",
+        "continueAsNew",
+        "executeWorkflow: TestContinueAsNew::execute",
+        "continueAsNew",
+        "executeWorkflow: TestContinueAsNew::execute");
   }
 
   public static class TestAsyncActivityWorkflowImpl implements TestWorkflow1 {
@@ -2156,10 +2168,18 @@ public void testTimer() {
     assertEquals("testTimer", result);
     if (useExternalService) {
       tracer.setExpected(
-          "registerQuery getTrace", "newTimer PT0.7S", "newTimer PT1.3S", "newTimer PT10S");
+          "executeWorkflow: testActivity",
+          "registerQuery getTrace",
+          "newTimer PT0.7S",
+          "newTimer PT1.3S",
+          "newTimer PT10S");
     } else {
       tracer.setExpected(
-          "registerQuery getTrace", "newTimer PT11M40S", "newTimer PT21M40S", "newTimer PT10H");
+          "executeWorkflow: testActivity",
+          "registerQuery getTrace",
+          "newTimer PT11M40S",
+          "newTimer PT21M40S",
+          "newTimer PT10H");
     }
   }
 
@@ -3325,7 +3345,9 @@ public void testSignalExternalWorkflow() {
         workflowClient.newWorkflowStub(TestWorkflowSignaled.class, options.build());
     assertEquals("Hello World!", client.execute());
     tracer.setExpected(
+        "executeWorkflow: TestWorkflowSignaled::execute",
         "executeChildWorkflow SignalingChild::execute",
+        "executeWorkflow: SignalingChild::execute",
         "signalExternalWorkflow " + UUID_REGEXP + " testSignal");
   }
 
@@ -4499,7 +4521,11 @@ public void testSideEffect() {
             TestWorkflow1.class, newWorkflowOptionsBuilder(taskList).build());
     String result = workflowStub.execute(taskList);
     assertEquals("activity1", result);
-    tracer.setExpected("sideEffect", "sleep PT1S", "executeActivity customActivity1");
+    tracer.setExpected(
+        "executeWorkflow: TestWorkflow1::execute",
+        "sideEffect",
+        "sleep PT1S",
+        "executeActivity customActivity1");
   }
 
   private static final Map<String, Queue<Long>> mutableSideEffectValue =
@@ -4595,6 +4621,7 @@ public void testGetVersion() {
     String result = workflowStub.execute(taskList);
     assertEquals("activity22activity1activity1activity1", result);
     tracer.setExpected(
+        "executeWorkflow: TestWorkflow1::execute",
         "getVersion",
         "executeActivity TestActivities::activity2",
         "getVersion",
@@ -4765,6 +4792,7 @@ public void testGetVersionRemovedInReplay() {
     String result = workflowStub.execute(taskList);
     assertEquals("activity22activity", result);
     tracer.setExpected(
+        "executeWorkflow: TestWorkflowQuery::execute",
         "registerQuery TestWorkflowQuery::query",
         "getVersion",
         "executeActivity TestActivities::activity2",
@@ -4809,6 +4837,7 @@ public void testGetVersionRemovedInReplay2() {
     String result = workflowStub.execute(taskList);
     assertEquals("activity", result);
     tracer.setExpected(
+        "executeWorkflow: TestWorkflowQuery::execute",
         "registerQuery TestWorkflowQuery::query",
         "getVersion",
         "getVersion",
@@ -4844,7 +4873,8 @@ public void testGetVersionRemovedInReplay3() {
             TestWorkflow1.class, newWorkflowOptionsBuilder(taskList).build());
     String result = workflowStub.execute(taskList);
     assertEquals("done", result);
-    tracer.setExpected("getVersion", "upsertSearchAttributes");
+    tracer.setExpected(
+        "executeWorkflow: TestWorkflow1::execute", "getVersion", "upsertSearchAttributes");
   }
 
   public static class TestVersionNotSupportedWorkflowImpl implements TestWorkflow1 {
@@ -5113,7 +5143,11 @@ public void testUUIDAndRandom() {
             TestWorkflow1.class, newWorkflowOptionsBuilder(taskList).build());
     String result = workflowStub.execute(taskList);
     assertEquals("foo10", result);
-    tracer.setExpected("sideEffect", "sideEffect", "executeActivity TestActivities::activity2");
+    tracer.setExpected(
+        "executeWorkflow: TestWorkflow1::execute",
+        "sideEffect",
+        "sideEffect",
+        "executeActivity TestActivities::activity2");
   }
 
   public interface GenericParametersActivity {
@@ -5941,10 +5975,13 @@ public void testSaga() {
             TestSagaWorkflow.class, newWorkflowOptionsBuilder(taskList).build());
     sagaWorkflow.execute(taskList, false);
     tracer.setExpected(
+        "executeWorkflow: TestSagaWorkflow::execute",
         "executeActivity customActivity1",
         "executeChildWorkflow TestMultiargsWorkflowsFunc::func",
+        "executeWorkflow: TestMultiargsWorkflowsFunc::func",
         "executeActivity TestActivities::throwIO",
         "executeChildWorkflow TestCompensationWorkflow::compensate",
+        "executeWorkflow: TestCompensationWorkflow::compensate",
         "executeActivity TestActivities::activity2");
   }
 
@@ -6062,7 +6099,10 @@ public void testUpsertSearchAttributes() {
             TestUpsertSearchAttributes.class, newWorkflowOptionsBuilder(taskList).build());
     String result = testWorkflow.execute(taskList, "testKey");
     assertEquals("done", result);
-    tracer.setExpected("upsertSearchAttributes", "executeActivity TestActivities::activity");
+    tracer.setExpected(
+        "executeWorkflow: TestUpsertSearchAttributes::execute",
+        "upsertSearchAttributes",
+        "executeActivity TestActivities::activity");
   }
 
   public static class TestMultiargsWorkflowsFuncChild implements TestMultiargsWorkflowsFunc2 {
@@ -6118,6 +6158,14 @@ private TracingWorkflowInterceptor(FilteredTrace trace, WorkflowInterceptor next
       this.next = Objects.requireNonNull(next);
     }
 
+    @Override
+    public byte[] executeWorkflow(
+        SyncWorkflowDefinition workflowDefinition, WorkflowExecuteInput input)
+        throws CancellationException, WorkflowExecutionException {
+      trace.add("executeWorkflow: " + input.getWorkflowType().getName());
+      return next.executeWorkflow(workflowDefinition, input);
+    }
+
     @Override
     public <R> Promise<R> executeActivity(
         String activityName,

src/test/java/com/uber/cadence/workflow/interceptors/SignalWorkflowInterceptor.java

@@ -20,6 +20,8 @@
 import com.uber.cadence.WorkflowExecution;
 import com.uber.cadence.activity.ActivityOptions;
 import com.uber.cadence.activity.LocalActivityOptions;
+import com.uber.cadence.internal.sync.SyncWorkflowDefinition;
+import com.uber.cadence.internal.worker.WorkflowExecutionException;
 import com.uber.cadence.workflow.*;
 import java.lang.reflect.Type;
 import java.time.Duration;
@@ -28,6 +30,7 @@
 import java.util.Optional;
 import java.util.Random;
 import java.util.UUID;
+import java.util.concurrent.CancellationException;
 import java.util.function.BiPredicate;
 import java.util.function.Function;
 import java.util.function.Supplier;
@@ -47,6 +50,13 @@ public SignalWorkflowInterceptor(
     this.next = Objects.requireNonNull(next);
   }
 
+  @Override
+  public byte[] executeWorkflow(
+      SyncWorkflowDefinition workflowDefinition, WorkflowExecuteInput input)
+      throws CancellationException, WorkflowExecutionException {
+    return next.executeWorkflow(workflowDefinition, input);
+  }
+
   @Override
   public <R> Promise<R> executeActivity(
       String activityName,