__temporal_workflow_metadata query responses should use "RawValue" (#2551)

Author: Quinn-With-Two-Ns

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

@@ -1,9 +1,6 @@
 package io.temporal.internal.sync;
 
-import io.temporal.api.common.v1.Header;
-import io.temporal.api.common.v1.Payloads;
-import io.temporal.api.common.v1.WorkflowExecution;
-import io.temporal.api.common.v1.WorkflowType;
+import io.temporal.api.common.v1.*;
 import io.temporal.api.enums.v1.EventType;
 import io.temporal.api.history.v1.HistoryEvent;
 import io.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes;
@@ -12,6 +9,7 @@
 import io.temporal.common.context.ContextPropagator;
 import io.temporal.common.converter.DataConverter;
 import io.temporal.common.converter.DefaultDataConverter;
+import io.temporal.common.converter.RawValue;
 import io.temporal.internal.logging.LoggerTag;
 import io.temporal.internal.replay.ReplayWorkflow;
 import io.temporal.internal.replay.ReplayWorkflowContext;
@@ -225,7 +223,12 @@ public Optional<Payloads> query(WorkflowQuery query) {
       return DefaultDataConverter.STANDARD_INSTANCE.toPayloads(runner.stackTrace());
     }
     if (WorkflowClient.QUERY_TYPE_WORKFLOW_METADATA.equals(query.getQueryType())) {
-      return dataConverterWithWorkflowContext.toPayloads(workflowContext.getWorkflowMetadata());
+      // metadata should be readable independent of user DataConverter settings
+      Payload payload =
+          DefaultDataConverter.STANDARD_INSTANCE
+              .toPayload(workflowContext.getWorkflowMetadata())
+              .orElseThrow(() -> new IllegalStateException("Failed to serialize metadata"));
+      return dataConverterWithWorkflowContext.toPayloads(new RawValue(payload));
     }
     Optional<Payloads> args =
         query.hasQueryArgs() ? Optional.of(query.getQueryArgs()) : Optional.empty();

temporal-sdk/src/test/java/io/temporal/common/converter/CodecDataConverterTest.java

@@ -123,7 +123,7 @@ static boolean isEncoded(Payload payload) {
     return payload.getData().startsWith(PrefixPayloadCodec.PREFIX);
   }
 
-  private static final class PrefixPayloadCodec implements PayloadCodec {
+  public static final class PrefixPayloadCodec implements PayloadCodec {
     public static final ByteString PREFIX = ByteString.copyFromUtf8("ENCODED: ");
 
     @Override

temporal-sdk/src/test/java/io/temporal/workflow/WorkflowMetadataTest.java

@@ -4,17 +4,36 @@
 import io.temporal.api.sdk.v1.WorkflowInteractionDefinition;
 import io.temporal.api.sdk.v1.WorkflowMetadata;
 import io.temporal.client.WorkflowClient;
+import io.temporal.client.WorkflowClientOptions;
 import io.temporal.client.WorkflowStub;
+import io.temporal.common.converter.CodecDataConverter;
+import io.temporal.common.converter.CodecDataConverterTest;
+import io.temporal.common.converter.DataConverter;
+import io.temporal.common.converter.DefaultDataConverter;
 import io.temporal.testing.internal.SDKTestWorkflowRule;
+import java.util.Collections;
 import org.junit.Assert;
 import org.junit.Rule;
 import org.junit.Test;
 
 public class WorkflowMetadataTest {
 
+  CodecDataConverterTest.PrefixPayloadCodec prefixPayloadCodec =
+      new CodecDataConverterTest.PrefixPayloadCodec();
+
+  DataConverter dataConverter =
+      new CodecDataConverter(
+          DefaultDataConverter.newDefaultInstance(),
+          Collections.singletonList(prefixPayloadCodec),
+          true);
+
   @Rule
   public SDKTestWorkflowRule testWorkflowRule =
-      SDKTestWorkflowRule.newBuilder().setWorkflowTypes(TestWorkflowWithMetadataImpl.class).build();
+      SDKTestWorkflowRule.newBuilder()
+          .setWorkflowClientOptions(
+              WorkflowClientOptions.newBuilder().setDataConverter(dataConverter).build())
+          .setWorkflowTypes(TestWorkflowWithMetadataImpl.class)
+          .build();
 
   @Test
   public void testGetMetadata() {