💥 Standalone Activities for Java (#2858)

* vc

* Integration tests.

* Options .toBuilder() should duplicate 'this'.

* equals and hashCode for StartActivityOptions

* Only throw ActivityAlreadyStartedException if error detail is present

* Same for getActivityResult

* equals/hashcode/tostring for ActivityExecution
Remove isEmpty() check from isWorkflowActivity.

* use-api-design

* match fully

* More tests

* Rename ActivityExecution to ActivityExecutionMetadata.

* Store ActivityExecutionInfo instead of DescribeActivityExecutionResponse.

* Rename getRetryPolicy to getRetryOptions.

* Missing methods in ActivityExecutionDescription.

* Correct naming for interceptor interfaces.

* Update ActivityInfo interface.

* More tests.

* Tests for standalone completion client methods.

* Interceptor tests.

* Nullable fields.

* swap args

* Rename IsInWorkflow to IsWorkflowActivity.

* Test: contextPropagatorValueAppearsInStartActivityHeader.

* Revert "Test: contextPropagatorValueAppearsInStartActivityHeader."

This reverts commit 381e66c.

* ActivityClientInterceptor and ActivityClientInterceptorBase.

* Correct order for activity interceptors.

* Rename to initializeClientInvoker.

* Javadoc warnings, unused classes, a deprecated method.

* Remove runtime rethrow.

* Pass null instead of "" for summary/details.

* Remove section dividers.

* useless test comments

* Enable SAA in test server.

* Remove trivial tests.

* wip

* Rename to ActivityClientCallsInterceptorBaseTest.

* Non-mocked completion client tests.

* Tweak javadoc

* Box for capturing

* Box for capturing

* MethodExtractor

* All overloads of same

* Refactor ME

* .start() pulls headers from context propagators.

* Distinguish standalone method names in completion client.

* Use long poll token in describeActivity.

* Expose lastFailure and raw proto on ActivityExecutionDescription.

* Completion handled at gPRC layer.

* Cache for ActivityHandleImpl.getResultAsync.

* Rename ActivityHandleWrapper to ActivityHandleImpl.

* Javadoc for ActivityClientCallsInterceptor

* ActivityException base class

* Remove throws clauses for unchecked exceptions

* Don't expose ActivityClient.listExecutionsPaginated

* Examples for all overloads in ActivityClient

* Update temporal-sdk/src/main/java/io/temporal/client/ActivityClient.java

Co-authored-by: Quinn Klassen <klassenq@gmail.com>

* Finish removing implementation detail in comment.

* Remove trivial tests

* Update testFromUntypedWithExplicitTypePassesTypeToInterceptor to make sure type is forwarded

* testGetActivityResultAsyncDelegatesToNext

* Javadoc: missing import

* Revert "Use long poll token in describeActivity."

This reverts commit 749a8c7.

* Address small review changes

* Default implementations for some untyped execute/executeAsync

* Remove ActivityCountOptions

* Apply DataConverter to results of .getLastFailure

* Polling can outlast server timeout

* Remove ActivityListOptions and ActivityListPaginatedOptions; keep both listActivities and listActivitiesPaginated in the interceptor

* getResult/Async continue polling across the server's long-poll boundary

* getResult/Async continue polling across the server's long-poll boundary and the client's rpc boundary (this and previous)

* Split slow tests for speed

* Increase timeout tolerance for GetActivityResultOverLongPollWaitTest.

* Remaining two default overloads of execute/executeAsync, and remove redundant Impl implementations.

* Remove unused listActivitiesPaginated interceptor

* Add overload to ActivityHandle.getResult with timeout.
Implemented this by adding a Deadline to RootActivityClientInvoker.getActivityResult.
Also:
In tests, use .start(...).get() instead of .executeAsync, for clarity.
Added stopwatch check to testGetActivityResultAsyncTimeoutAbortsPolling to avoid possibility of false negative.

* TODO

* getWorkflowNamespace returns null if no workflow execution

* Update comment on ActivityInfo for getActivityNamespace() returning null for SAA.

* Remove result caching, will revisit later.

* Rename isWorkflowActivity to isInWorkflow

* Remove default ActivityClientCallsInterceptor.getActivityResultAsync

* Move Func7 to the correct spot

* Remove internal ActivityExecutionDescription.info()

* Tests that check that both only scheduleToCloseTimeout and only startToCloseTimeout are allowed.

* ActivityClientCallsInterceptorChainTest: confirm ordering for 2 interceptors with real ActivityClient.

* Added tests testGetHandleWithNullRunId and testVoidExecuteOverloadDiscardsNonVoidResult.
Renames: ActivityInfoStandaloneTest -> ActivityInfoImplTest, testDescribeNoToken -> testDescribe in ActivityHandleImplTest.

---------

Co-authored-by: Quinn Klassen <klassenq@gmail.com>

Author: GregoryTravis

.github/workflows/ci.yml

@@ -110,7 +110,11 @@ jobs:
               --dynamic-config-value history.enableRequestIdRefLinks=true \
               --dynamic-config-value frontend.WorkerHeartbeatsEnabled=true \
               --dynamic-config-value frontend.ListWorkersEnabled=true \
-              --dynamic-config-value 'component.callbacks.allowedAddresses=[{"Pattern":"localhost:7243","AllowInsecure":true}]' &
+              --dynamic-config-value 'component.callbacks.allowedAddresses=[{"Pattern":"localhost:7243","AllowInsecure":true}]' \
+              --dynamic-config-value frontend.activityAPIsEnabled=true \
+              --dynamic-config-value activity.enableStandalone=true \
+              --dynamic-config-value history.enableChasm=true \
+              --dynamic-config-value history.enableTransitionHistory=true &
           sleep 10s
 
       # Can't actually run tests against Java 8 because Mockito 5 requires Java 11+.

contrib/temporal-opentracing/src/main/java/io/temporal/opentracing/internal/OpenTracingActivityInboundCallsInterceptor.java

@@ -51,7 +51,7 @@ public ActivityOutput execute(ActivityInput input) {
                 tracer,
                 activityInfo.getActivityType(),
                 activityInfo.getWorkflowId(),
-                activityInfo.getRunId(),
+                activityInfo.getWorkflowRunId(),
                 rootSpanContext)
             .start();
     try (Scope scope = tracer.scopeManager().activate(activityRunSpan)) {

temporal-sdk/src/main/java/io/temporal/activity/ActivityInfo.java

@@ -7,6 +7,7 @@
 import java.time.Duration;
 import java.util.Optional;
 import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
 
 /**
  * Information about the Activity Task that the current Activity Execution is handling. Use {@link
@@ -21,15 +22,35 @@ public interface ActivityInfo {
   byte[] getTaskToken();
 
   /**
-   * @return WorkflowId of the Workflow Execution that scheduled the Activity Execution.
+   * @return WorkflowId of the Workflow Execution that scheduled the Activity Execution, or {@code
+   *     null} for standalone activities not scheduled by a workflow.
    */
+  @Nullable
   String getWorkflowId();
 
   /**
-   * @return RunId of the Workflow Execution that scheduled the Activity Execution.
+   * @return RunId of the Workflow Execution that scheduled the Activity Execution, or {@code null}
+   *     for standalone activities not scheduled by a workflow.
+   * @deprecated use {@link #getWorkflowRunId()}
    */
+  @Deprecated
+  @Nullable
   String getRunId();
 
+  /**
+   * @return RunId of the Workflow Execution that scheduled the Activity Execution, or {@code null}
+   *     for standalone activities not scheduled by a workflow.
+   */
+  @Nullable
+  String getWorkflowRunId();
+
+  /**
+   * @return the run ID of this standalone Activity Execution, or {@code null} for activities
+   *     scheduled by a workflow.
+   */
+  @Nullable
+  String getActivityRunId();
+
   /**
    * ID of the Activity Execution. This ID can be used to complete the Activity Execution
    * asynchronously through {@link io.temporal.client.ActivityCompletionClient#complete(String,
@@ -82,8 +103,10 @@ public interface ActivityInfo {
   Optional<Payloads> getHeartbeatDetails();
 
   /**
-   * @return the Workflow Type of the Workflow Execution that executed the Activity.
+   * @return the Workflow Type of the Workflow Execution that executed the Activity, or {@code null}
+   *     for standalone activities not scheduled by a workflow.
    */
+  @Nullable
   String getWorkflowType();
 
   /**
@@ -92,10 +115,12 @@ public interface ActivityInfo {
    * same namespace, hence no need for different {@code getWorkflowNamespace()} and {@link
    * #getActivityNamespace()} methods.
    *
-   * @return the Namespace of Workflow Execution that scheduled the Activity.
+   * @return the Namespace of Workflow Execution that scheduled the Activity, or null for standalone
+   *     activities.
    * @deprecated use {@link #getNamespace()}
    */
   @Deprecated
+  @Nullable
   String getWorkflowNamespace();
 
   /**
@@ -110,8 +135,19 @@ public interface ActivityInfo {
   @Deprecated
   String getActivityNamespace();
 
+  /**
+   * @return the Namespace of this Activity Execution.
+   */
   String getNamespace();
 
+  /**
+   * @return {@code true} if this activity was scheduled by a workflow execution; {@code false} for
+   *     standalone activities.
+   */
+  default boolean isInWorkflow() {
+    return getWorkflowId() != null;
+  }
+
   String getActivityTaskQueue();
 
   /**

temporal-sdk/src/main/java/io/temporal/client/ActivityAlreadyStartedException.java

@@ -0,0 +1,35 @@
+package io.temporal.client;
+
+import io.temporal.common.Experimental;
+import javax.annotation.Nullable;
+
+/**
+ * Thrown by {@link ActivityClient#start} when the server returns an ALREADY_EXISTS error because an
+ * activity with the same ID is already running (or has a completed run that conflicts with the
+ * requested {@link StartActivityOptions#getIdReusePolicy()} / {@link
+ * StartActivityOptions#getIdConflictPolicy()}).
+ */
+@Experimental
+public final class ActivityAlreadyStartedException extends ActivityException {
+
+  private final String activityType;
+
+  public ActivityAlreadyStartedException(
+      String activityId, String activityType, @Nullable String runId, Throwable cause) {
+    super(
+        "Activity already started: activityId='"
+            + activityId
+            + "', activityType='"
+            + activityType
+            + (runId != null ? "', runId='" + runId + "'" : "'"),
+        activityId,
+        runId,
+        cause);
+    this.activityType = activityType;
+  }
+
+  /** The activity type that was requested. */
+  public String getActivityType() {
+    return activityType;
+  }
+}