use supplied data converter

Author: THardy98

packages/client/src/schedule-helpers.ts

@@ -15,7 +15,9 @@ import { Headers } from '@temporalio/common/lib/interceptors';
 import {
   decodeArrayFromPayloads,
   decodeMapFromPayloads,
+  decodeOptionalSinglePayload,
   encodeMapToPayloads,
+  encodeOptionalToPayload,
   encodeToPayloads,
 } from '@temporalio/common/lib/internal-non-workflow';
 import { temporal } from '@temporalio/proto';
@@ -245,7 +247,6 @@ export async function encodeScheduleAction(
   action: CompiledScheduleAction,
   headers: Headers
 ): Promise<temporal.api.schedule.v1.IScheduleAction> {
-  const jsonConverter = new JsonPayloadConverter();
   return {
     startWorkflow: {
       workflowId: action.workflowId,
@@ -270,8 +271,8 @@ export async function encodeScheduleAction(
           : undefined,
       header: { fields: headers },
       userMetadata: {
-        summary: jsonConverter.toPayload(action.staticSummary),
-        details: jsonConverter.toPayload(action.staticDetails),
+        summary: await encodeOptionalToPayload(dataConverter, action?.staticSummary),
+        details: await encodeOptionalToPayload(dataConverter, action?.staticDetails),
       },
     },
   };
@@ -322,7 +323,6 @@ export async function decodeScheduleAction(
   pb: temporal.api.schedule.v1.IScheduleAction
 ): Promise<ScheduleDescriptionAction> {
   if (pb.startWorkflow) {
-    const jsonConverter = new JsonPayloadConverter();
     const userMetadata = pb.startWorkflow?.userMetadata;
     return {
       type: 'startWorkflow',
@@ -340,8 +340,8 @@ export async function decodeScheduleAction(
       workflowExecutionTimeout: optionalTsToMs(pb.startWorkflow.workflowExecutionTimeout),
       workflowRunTimeout: optionalTsToMs(pb.startWorkflow.workflowRunTimeout),
       workflowTaskTimeout: optionalTsToMs(pb.startWorkflow.workflowTaskTimeout),
-      staticSummary: userMetadata?.summary ? jsonConverter.fromPayload(userMetadata.summary) : undefined,
-      staticDetails: userMetadata?.details ? jsonConverter.fromPayload(userMetadata.details) : undefined,
+      staticSummary: await decodeOptionalSinglePayload(dataConverter, userMetadata?.summary) ?? undefined,
+      staticDetails: await decodeOptionalSinglePayload(dataConverter, userMetadata?.details) ?? undefined,
     };
   }
   throw new TypeError('Unsupported schedule action');

packages/client/src/workflow-client.ts

@@ -22,7 +22,6 @@ import {
   decodeRetryState,
   encodeWorkflowIdConflictPolicy,
   WorkflowIdConflictPolicy,
-  JsonPayloadConverter,
 } from '@temporalio/common';
 import { encodeUnifiedSearchAttributes } from '@temporalio/common/lib/converter/payload-search-attributes';
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
@@ -32,7 +31,9 @@ import {
   decodeArrayFromPayloads,
   decodeFromPayloadsAtIndex,
   decodeOptionalFailureToOptionalError,
+  decodeOptionalSinglePayload,
   encodeMapToPayloads,
+  encodeOptionalToPayload,
   encodeToPayloads,
   filterNullAndUndefined,
 } from '@temporalio/common/lib/internal-non-workflow';
@@ -1197,7 +1198,6 @@ export class WorkflowClient extends BaseClient {
   protected async _signalWithStartWorkflowHandler(input: WorkflowSignalWithStartInput): Promise<string> {
     const { identity } = this.options;
     const { options, workflowType, signalName, signalArgs, headers } = input;
-    const jsonConverter = new JsonPayloadConverter();
     const req: temporal.api.workflowservice.v1.ISignalWithStartWorkflowExecutionRequest = {
       namespace: this.options.namespace,
       identity,
@@ -1228,8 +1228,8 @@ export class WorkflowClient extends BaseClient {
       cronSchedule: options.cronSchedule,
       header: { fields: headers },
       userMetadata: {
-        summary: jsonConverter.toPayload(options?.staticSummary),
-        details: jsonConverter.toPayload(options?.staticDetails),
+        summary: await encodeOptionalToPayload(this.dataConverter, options?.staticSummary),
+        details: await encodeOptionalToPayload(this.dataConverter, options?.staticDetails),
       },
     };
     try {
@@ -1271,7 +1271,6 @@ export class WorkflowClient extends BaseClient {
   protected async createStartWorkflowRequest(input: WorkflowStartInput): Promise<StartWorkflowExecutionRequest> {
     const { options: opts, workflowType, headers } = input;
     const { identity, namespace } = this.options;
-    const jsonConverter = new JsonPayloadConverter();
     return {
       namespace,
       identity,
@@ -1300,8 +1299,8 @@ export class WorkflowClient extends BaseClient {
       cronSchedule: opts.cronSchedule,
       header: { fields: headers },
       userMetadata: {
-        summary: jsonConverter.toPayload(opts?.staticSummary),
-        details: jsonConverter.toPayload(opts?.staticDetails),
+        summary: await encodeOptionalToPayload(this.dataConverter, opts?.staticSummary),
+        details: await encodeOptionalToPayload(this.dataConverter, opts?.staticDetails),
       },
     };
   }
@@ -1436,12 +1435,11 @@ export class WorkflowClient extends BaseClient {
           workflowExecution: { workflowId, runId },
         });
         const info = await executionInfoFromRaw(raw.workflowExecutionInfo ?? {}, this.client.dataConverter, raw);
-        const jsonConverter = new JsonPayloadConverter();
         const userMetadata = raw.executionConfig?.userMetadata;
         return {
           ...info,
-          staticDetails: userMetadata?.details ? jsonConverter.fromPayload(userMetadata.details) : undefined,
-          staticSummary: userMetadata?.summary ? jsonConverter.fromPayload(userMetadata.summary) : undefined,
+          staticDetails: await decodeOptionalSinglePayload(this.client.dataConverter, userMetadata?.details) ?? undefined,
+          staticSummary: await decodeOptionalSinglePayload(this.client.dataConverter, userMetadata?.summary) ?? undefined,
           raw,
         };
       },

packages/common/src/internal-non-workflow/codec-helpers.ts

@@ -72,6 +72,17 @@ export async function decodeOptionalSingle(
   return await decodeSingle(codecs, payload);
 }
 
+/** Run {@link PayloadCodec.decode} and convert from a single Payload */
+export async function decodeOptionalSinglePayload<T>(
+  dataConverter: LoadedDataConverter,
+  payload?: Payload | null | undefined
+): Promise<T | null | undefined> {
+  const { payloadCodecs, payloadConverter } = dataConverter;
+  const decoded = await decodeOptionalSingle(payloadCodecs, payload);
+  if (decoded == null) return decoded;
+  return payloadConverter.fromPayload(decoded);
+}
+
 /**
  * Run {@link PayloadConverter.toPayload} on value, and then encode it.
  */
@@ -80,6 +91,20 @@ export async function encodeToPayload(converter: LoadedDataConverter, value: unk
   return await encodeSingle(payloadCodecs, payloadConverter.toPayload(value));
 }
 
+/**
+ * Run {@link PayloadConverter.toPayload} on an optional value, and then encode it.
+ */
+export async function encodeOptionalToPayload(
+  converter: LoadedDataConverter, 
+  value: unknown
+): Promise<Payload | null | undefined> {
+  if (value == null) return value;
+  
+  const { payloadConverter, payloadCodecs } = converter;
+  const payload = payloadConverter.toPayload(value);  
+  return await encodeSingle(payloadCodecs, payload);
+}
+
 /**
  * Decode `payloads` and then return {@link arrayFromPayloads}`.
  */