Add support for metadata to test server (#2441)

Add support for metadata to test server

Author: Quinn-With-Two-Ns

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

@@ -21,19 +21,70 @@
 package io.temporal.client;
 
 import io.temporal.api.workflowservice.v1.DescribeWorkflowExecutionResponse;
+import io.temporal.common.Experimental;
 import io.temporal.common.converter.DataConverter;
+import io.temporal.payload.context.WorkflowSerializationContext;
 import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
 
 /** Contains information about a workflow execution. */
 public class WorkflowExecutionDescription extends WorkflowExecutionMetadata {
+  private final @Nonnull DataConverter dataConverter;
   private final @Nonnull DescribeWorkflowExecutionResponse response;
 
   public WorkflowExecutionDescription(
       @Nonnull DescribeWorkflowExecutionResponse response, @Nonnull DataConverter dataConverter) {
     super(response.getWorkflowExecutionInfo(), dataConverter);
+    this.dataConverter = dataConverter;
     this.response = response;
   }
 
+  /**
+   * Get the fixed summary for this workflow execution.
+   *
+   * @apiNote Will be decoded on each invocation, so it is recommended to cache the result if it is
+   *     used multiple times.
+   */
+  @Experimental
+  @Nullable
+  public String getStaticSummary() {
+    if (!response.getExecutionConfig().getUserMetadata().hasSummary()) {
+      return null;
+    }
+    return dataConverter
+        .withContext(
+            new WorkflowSerializationContext(
+                response.getWorkflowExecutionInfo().getParentNamespaceId(),
+                response.getWorkflowExecutionInfo().getExecution().getWorkflowId()))
+        .fromPayload(
+            response.getExecutionConfig().getUserMetadata().getSummary(),
+            String.class,
+            String.class);
+  }
+
+  /**
+   * Get the details summary for this workflow execution.
+   *
+   * @apiNote Will be decoded on each invocation, so it is recommended to cache the result if it is
+   *     used multiple times.
+   */
+  @Experimental
+  @Nullable
+  public String getStaticDetails() {
+    if (!response.getExecutionConfig().getUserMetadata().hasDetails()) {
+      return null;
+    }
+    return dataConverter
+        .withContext(
+            new WorkflowSerializationContext(
+                response.getWorkflowExecutionInfo().getParentNamespaceId(),
+                response.getWorkflowExecutionInfo().getExecution().getWorkflowId()))
+        .fromPayload(
+            response.getExecutionConfig().getUserMetadata().getDetails(),
+            String.class,
+            String.class);
+  }
+
   /** Returns the raw response from the Temporal service. */
   public DescribeWorkflowExecutionResponse getRawDescription() {
     return response;

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

@@ -31,6 +31,7 @@
 import io.temporal.internal.common.SearchAttributesUtil;
 import io.temporal.payload.context.WorkflowSerializationContext;
 import java.lang.reflect.Type;
+import java.time.Duration;
 import java.time.Instant;
 import java.util.Collections;
 import java.util.List;
@@ -98,6 +99,23 @@ public WorkflowExecution getParentExecution() {
     return info.hasParentExecution() ? info.getParentExecution() : null;
   }
 
+  @Nullable
+  public WorkflowExecution getRootExecution() {
+    return info.hasRootExecution() ? info.getRootExecution() : null;
+  }
+
+  @Nullable
+  public String getFirstRunId() {
+    return info.getFirstRunId();
+  }
+
+  @Nullable
+  public Duration getExecutionDuration() {
+    return info.hasExecutionDuration()
+        ? ProtobufTimeUtils.toJavaDuration(info.getExecutionDuration())
+        : null;
+  }
+
   /**
    * @deprecated use {@link #getTypedSearchAttributes} instead.
    */

temporal-sdk/src/main/java/io/temporal/internal/replay/BasicWorkflowContext.java

@@ -96,6 +96,12 @@ WorkflowExecution getParentWorkflowExecution() {
         : null;
   }
 
+  WorkflowExecution getRootWorkflowExecution() {
+    return startedAttributes.hasRootWorkflowExecution()
+        ? startedAttributes.getRootWorkflowExecution()
+        : null;
+  }
+
   Duration getWorkflowRunTimeout() {
     return ProtobufTimeUtils.toJavaDuration(startedAttributes.getWorkflowRunTimeout());
   }

temporal-sdk/src/main/java/io/temporal/internal/replay/ReplayWorkflowContext.java

@@ -78,6 +78,8 @@ public Functions.Proc1<Exception> getCancellationHandle() {
 
   WorkflowExecution getParentWorkflowExecution();
 
+  WorkflowExecution getRootWorkflowExecution();
+
   WorkflowType getWorkflowType();
 
   /**

temporal-sdk/src/main/java/io/temporal/internal/replay/ReplayWorkflowContextImpl.java

@@ -108,6 +108,11 @@ public WorkflowExecution getParentWorkflowExecution() {
     return basicWorkflowContext.getParentWorkflowExecution();
   }
 
+  @Override
+  public WorkflowExecution getRootWorkflowExecution() {
+    return basicWorkflowContext.getRootWorkflowExecution();
+  }
+
   @Override
   public String getFirstExecutionRunId() {
     return basicWorkflowContext.getFirstExecutionRunId();

temporal-sdk/src/main/java/io/temporal/internal/sync/WorkflowInfoImpl.java

@@ -125,6 +125,17 @@ public Optional<String> getParentRunId() {
         : Optional.of(parentWorkflowExecution.getRunId());
   }
 
+  public String getRootWorkflowId() {
+    WorkflowExecution rootWorkflowExecution = context.getRootWorkflowExecution();
+    return rootWorkflowExecution == null ? null : rootWorkflowExecution.getWorkflowId();
+  }
+
+  @Override
+  public String getRootRunId() {
+    WorkflowExecution rootWorkflowExecution = context.getRootWorkflowExecution();
+    return rootWorkflowExecution == null ? null : rootWorkflowExecution.getRunId();
+  }
+
   @Override
   public int getAttempt() {
     return context.getAttempt();
@@ -183,6 +194,10 @@ public String toString() {
         + getParentWorkflowId()
         + ", parentRunId="
         + getParentRunId()
+        + ", rootWorkflowId="
+        + getRootWorkflowId()
+        + ", rootRunId="
+        + getRootRunId()
         + ", attempt="
         + getAttempt()
         + ", cronSchedule="

temporal-sdk/src/main/java/io/temporal/workflow/ChildWorkflowOptions.java

@@ -507,10 +507,12 @@ public VersioningIntent getVersioningIntent() {
     return versioningIntent;
   }
 
+  @Experimental
   public String getStaticSummary() {
     return staticSummary;
   }
 
+  @Experimental
   public String getStaticDetails() {
     return staticDetails;
   }

temporal-sdk/src/main/java/io/temporal/workflow/WorkflowInfo.java

@@ -136,6 +136,22 @@ public interface WorkflowInfo {
    */
   Optional<String> getParentRunId();
 
+  /**
+   * @return Workflow ID of the root Workflow
+   * @apiNote On server versions prior to v1.27.0, this method will return null. Otherwise, it will
+   *     always return a non-null value.
+   */
+  @Nullable
+  String getRootWorkflowId();
+
+  /**
+   * @return Run ID of the root Workflow
+   * @apiNote On server versions prior to v1.27.0, this method will return null. Otherwise, it will
+   *     always return a non-null value.
+   */
+  @Nullable
+  String getRootRunId();
+
   /**
    * @return Workflow retry attempt handled by this Workflow code execution. Starts on "1".
    */

temporal-sdk/src/test/java/io/temporal/workflow/activityTests/ActivityMetadataTest.java

@@ -21,7 +21,6 @@
 package io.temporal.workflow.activityTests;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assume.assumeTrue;
 
 import io.temporal.activity.ActivityOptions;
 import io.temporal.api.common.v1.WorkflowExecution;
@@ -36,7 +35,6 @@
 import java.time.Duration;
 import java.util.List;
 import java.util.stream.Collectors;
-import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 
@@ -51,11 +49,6 @@ public class ActivityMetadataTest {
 
   static final String activitySummary = "activity-summary";
 
-  @Before
-  public void checkRealServer() {
-    assumeTrue("skipping for test server", SDKTestWorkflowRule.useExternalService);
-  }
-
   @Test
   public void testActivityWithMetaData() {
     TestWorkflow1 stub = testWorkflowRule.newWorkflowStubTimeoutOptions(TestWorkflow1.class);

temporal-sdk/src/test/java/io/temporal/workflow/activityTests/LocalActivityMetadataTest.java

@@ -21,7 +21,6 @@
 package io.temporal.workflow.activityTests;
 
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assume.assumeTrue;
 
 import io.temporal.activity.LocalActivityOptions;
 import io.temporal.api.common.v1.WorkflowExecution;
@@ -36,7 +35,6 @@
 import java.time.Duration;
 import java.util.List;
 import java.util.stream.Collectors;
-import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 
@@ -51,11 +49,6 @@ public class LocalActivityMetadataTest {
 
   static final String localActivitySummary = "local-activity-summary";
 
-  @Before
-  public void checkRealServer() {
-    assumeTrue("skipping for test server", SDKTestWorkflowRule.useExternalService);
-  }
-
   @Test
   public void testLocalActivityWithMetaData() {
     TestWorkflow1 stub = testWorkflowRule.newWorkflowStubTimeoutOptions(TestWorkflow1.class);