schedule metadata test, fix schedule action decode

THardy98 · THardy98 · commit 6af2e2c62e80 · 2025-03-21T12:50:34.000-07:00
diff --git a/packages/client/src/schedule-helpers.ts b/packages/client/src/schedule-helpers.ts
@@ -1,5 +1,11 @@
 import Long from 'long'; // eslint-disable-line import/no-named-as-default
-import { compileRetryPolicy, decompileRetryPolicy, extractWorkflowType, JsonPayloadConverter, LoadedDataConverter } from '@temporalio/common';
+import {
+  compileRetryPolicy,
+  decompileRetryPolicy,
+  extractWorkflowType,
+  JsonPayloadConverter,
+  LoadedDataConverter,
+} from '@temporalio/common';
 import {
   encodeUnifiedSearchAttributes,
   decodeSearchAttributes,
@@ -239,7 +245,7 @@ export async function encodeScheduleAction(
   action: CompiledScheduleAction,
   headers: Headers
 ): Promise<temporal.api.schedule.v1.IScheduleAction> {
-  const jsonConverter = new JsonPayloadConverter()
+  const jsonConverter = new JsonPayloadConverter();
   return {
     startWorkflow: {
       workflowId: action.workflowId,
@@ -263,10 +269,10 @@ export async function encodeScheduleAction(
             }
           : undefined,
       header: { fields: headers },
-      userMetadata: { 
-        summary: jsonConverter.toPayload(action.staticSummary), 
-        details: jsonConverter.toPayload(action.staticDetails) 
-      }
+      userMetadata: {
+        summary: jsonConverter.toPayload(action.staticSummary),
+        details: jsonConverter.toPayload(action.staticDetails),
+      },
     },
   };
 }
@@ -316,6 +322,8 @@ 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',
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -332,6 +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,
     };
   }
   throw new TypeError('Unsupported schedule action');
diff --git a/packages/client/src/workflow-client.ts b/packages/client/src/workflow-client.ts
@@ -1229,8 +1229,8 @@ export class WorkflowClient extends BaseClient {
       header: { fields: headers },
       userMetadata: {
         summary: jsonConverter.toPayload(options?.staticSummary),
-        details: jsonConverter.toPayload(options?.staticDetails)
-      }
+        details: jsonConverter.toPayload(options?.staticDetails),
+      },
     };
     try {
       return (await this.workflowService.signalWithStartWorkflowExecution(req)).runId;
@@ -1271,7 +1271,7 @@ 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()
+    const jsonConverter = new JsonPayloadConverter();
     return {
       namespace,
       identity,
@@ -1301,8 +1301,8 @@ export class WorkflowClient extends BaseClient {
       header: { fields: headers },
       userMetadata: {
         summary: jsonConverter.toPayload(opts?.staticSummary),
-        details: jsonConverter.toPayload(opts?.staticDetails)
-      }
+        details: jsonConverter.toPayload(opts?.staticDetails),
+      },
     };
   }
 
@@ -1436,8 +1436,8 @@ 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
+        const jsonConverter = new JsonPayloadConverter();
+        const userMetadata = raw.executionConfig?.userMetadata;
         return {
           ...info,
           staticDetails: userMetadata?.details ? jsonConverter.fromPayload(userMetadata.details) : undefined,
diff --git a/packages/common/src/workflow-options.ts b/packages/common/src/workflow-options.ts
@@ -192,16 +192,16 @@ export interface BaseWorkflowOptions {
   typedSearchAttributes?: SearchAttributePair[] | TypedSearchAttributes;
 
   /**
-   * General fixed details for this workflow execution that may appear in UI/CLI. 
+   * General fixed details for this workflow execution that may appear in UI/CLI.
    * This can be in Temporal markdown format and can span multiple lines.
-   * 
-   * @experimental 
+   *
+   * @experimental
    */
   staticDetails?: string;
   /**
    * A single-line fixed summary for this workflow execution that may appear in the UI/CLI.
    * This can be in single-line Temporal markdown format.
-   * 
+   *
    * @experimental
    */
   staticSummary?: string;
diff --git a/packages/test/src/test-integration-workflows.ts b/packages/test/src/test-integration-workflows.ts
@@ -10,14 +10,19 @@ import { CancelReason } from '@temporalio/worker/lib/activity';
 import * as workflow from '@temporalio/workflow';
 import { defineQuery, defineSignal, setHandler } from '@temporalio/workflow';
 import { SdkFlags } from '@temporalio/workflow/lib/flags';
-import { ActivityCancellationType, ApplicationFailure, JsonPayloadConverter, WorkflowExecutionAlreadyStartedError } from '@temporalio/common';
+import {
+  ActivityCancellationType,
+  ApplicationFailure,
+  JsonPayloadConverter,
+  WorkflowExecutionAlreadyStartedError,
+} from '@temporalio/common';
+import { temporal } from '@temporalio/proto';
 import { signalSchedulingWorkflow } from './activities/helpers';
 import { activityStartedSignal } from './workflows/definitions';
 import * as workflows from './workflows';
 import { Context, helpers, makeTestFunction } from './helpers-integration';
 import { overrideSdkInternalFlag } from './mock-internal-flags';
 import { asSdkLoggerSink, loadHistory, RUN_TIME_SKIPPING_TESTS } from './helpers';
-import { temporal } from '@temporalio/proto';
 
 const test = makeTestFunction({
   workflowsPath: __filename,
@@ -1307,38 +1312,38 @@ test('Count workflow executions', async (t) => {
 
 export async function userMetadataWorkflow(): Promise<string> {
   let done = false;
-  const signalDef = defineSignal('done')
-  setHandler(signalDef, () => { done = true })
-  
+  const signalDef = defineSignal('done');
+  setHandler(signalDef, () => {
+    done = true;
+  });
+
   // That workflow should call an activity (with summary)
-  const { activityWithSummary } = workflow
-    .proxyActivities({ scheduleToCloseTimeout: '10s' })
-    .withSummaries({
-      activityWithSummary: 'activity summary'
-    })
-  await activityWithSummary()
+  const { activityWithSummary } = workflow.proxyActivities({ scheduleToCloseTimeout: '10s' }).withSummaries({
+    activityWithSummary: 'activity summary',
+  });
+  await activityWithSummary();
   // Should have a timer (with summary)
-  await workflow.sleep(5, "timer summary")
+  await workflow.sleep(5, 'timer summary');
   // Set current details
   workflow.setCurrentDetails('current wf details');
   // Unblock on var -> query current details (or return)
   await workflow.condition(() => done);
   return workflow.getCurrentDetails();
 }
 
-test('User metadata', async (t) => {
+test('User metadata on workflow, timer, activity', async (t) => {
   const { createWorker, startWorkflow } = helpers(t);
   const worker = await createWorker({
     activities: {
-      async activityWithSummary() {} 
-    }
+      async activityWithSummary() {},
+    },
   });
 
   await worker.runUntil(async () => {
     // Start a workflow with static details
     const handle = await startWorkflow(userMetadataWorkflow, {
-      staticSummary: "wf static summary",
-      staticDetails: "wf static details"
+      staticSummary: 'wf static summary',
+      staticDetails: 'wf static details',
     });
     // Describe workflow -> static summary, static details
     const desc = await handle.describe();
@@ -1350,15 +1355,13 @@ test('User metadata', async (t) => {
     t.true(res === 'current wf details');
 
     // Get history events for timer and activity summaries.
-    const resp = await t.context.env.client.workflowService.getWorkflowExecutionHistory(
-      {
-        namespace: t.context.env.client.options.namespace,
-        execution: { 
-          workflowId: handle.workflowId, 
-          runId: handle.firstExecutionRunId
-        },
-      }
-    );
+    const resp = await t.context.env.client.workflowService.getWorkflowExecutionHistory({
+      namespace: t.context.env.client.options.namespace,
+      execution: {
+        workflowId: handle.workflowId,
+        runId: handle.firstExecutionRunId,
+      },
+    });
     const jsonConverter = new JsonPayloadConverter();
     for (const event of resp.history?.events ?? []) {
       if (event.eventType === temporal.api.enums.v1.EventType.EVENT_TYPE_WORKFLOW_EXECUTION_STARTED) {
@@ -1372,10 +1375,10 @@ test('User metadata', async (t) => {
     }
 
     // Run metadata query -> get current details
-    const wfMetadata = await handle.query('__temporal_workflow_metadata') as temporal.api.sdk.v1.IWorkflowMetadata;
+    const wfMetadata = (await handle.query('__temporal_workflow_metadata')) as temporal.api.sdk.v1.IWorkflowMetadata;
     t.deepEqual(wfMetadata.definition?.signalDefinitions?.length, 1);
     t.deepEqual(wfMetadata.definition?.signalDefinitions?.[0].name, 'done');
     t.deepEqual(wfMetadata.definition?.queryDefinitions?.length, 3); // default queries
     t.deepEqual(wfMetadata.currentDetails, 'current wf details');
   });
-});
+});
diff --git a/packages/test/src/test-schedules.ts b/packages/test/src/test-schedules.ts
@@ -758,4 +758,31 @@ if (RUN_INTEGRATION_TESTS) {
       await handle.delete();
     }
   });
+
+  test.serial('User metadata on schedule', async (t) => {
+    const { client } = t.context;
+    const scheduleId = `schedule-with-user-metadata-${randomUUID()}`;
+    const handle = await client.schedule.create({
+      scheduleId,
+      spec: {},
+      action: {
+        type: 'startWorkflow',
+        workflowType: dummyWorkflow,
+        taskQueue,
+        staticSummary: 'schedule static summary',
+        staticDetails: 'schedule static details',
+      },
+    });
+
+    try {
+      const describedSchedule = await handle.describe();
+      t.deepEqual(describedSchedule.spec.calendars, []);
+      t.deepEqual(describedSchedule.spec.intervals, []);
+      t.deepEqual(describedSchedule.spec.skip, []);
+      t.deepEqual(describedSchedule.action.staticSummary, 'schedule static summary');
+      t.deepEqual(describedSchedule.action.staticDetails, 'schedule static details');
+    } finally {
+      await handle.delete();
+    }
+  });
 }
diff --git a/packages/workflow/src/interceptors.ts b/packages/workflow/src/interceptors.ts
@@ -7,7 +7,7 @@
  */
 
 import { ActivityOptions, Headers, LocalActivityOptions, Next, Timestamp, WorkflowExecution } from '@temporalio/common';
-import type { coresdk, temporal } from '@temporalio/proto';
+import type { coresdk } from '@temporalio/proto';
 import { ChildWorkflowOptionsWithDefaults, ContinueAsNewOptions } from './interfaces';
 
 export { Next, Headers };
@@ -105,7 +105,7 @@ export interface StartChildWorkflowExecutionInput {
 
 /**
  * User metadata that can be attached to workflow commands.
- * 
+ *
  * Current used for:
  * - startTimer, scheduleActivity/scheduleLocalActivity commands
  * - internal metadata query
@@ -122,7 +122,7 @@ export interface UserMetadata {
  */
 export interface WorkflowCommandOptions {
   /** User metadata for the command that may be persisted to history */
-  readonly userMetadata?: UserMetadata
+  readonly userMetadata?: UserMetadata;
 }
 
 /** Input for WorkflowOutboundCallsInterceptor.startTimer */
diff --git a/packages/workflow/src/internals.ts b/packages/workflow/src/internals.ts
@@ -417,7 +417,7 @@ export class Activator implements ActivationHandler {
 
   public readonly registeredActivityNames: Set<string>;
 
-  public currentDetails: string = "";
+  public currentDetails: string = '';
 
   constructor({
     info,
diff --git a/packages/workflow/src/workflow.ts b/packages/workflow/src/workflow.ts
