fix(workflow): do encode memos on continueAsNew (#955)

Author: mjameswh

packages/common/src/workflow-options.ts

@@ -79,7 +79,7 @@ export interface BaseWorkflowOptions {
    * Specifies additional non-indexed information to attach to the Workflow Execution. The values can be anything that
    * is serializable by {@link DataConverter}.
    */
-  memo?: Record<string, any>;
+  memo?: Record<string, unknown>;
 
   /**
    * Specifies additional indexed information to attach to the Workflow Execution. More info:

packages/test/src/integration-tests.ts

@@ -872,6 +872,88 @@ export function runIntegrationTests(codec?: PayloadCodec): void {
     t.is(timeSlept, 1);
   });
 
+  test('continue-as-new-to-same-workflow keeps memo and search attributes', async (t) => {
+    const { client } = t.context;
+    const workflow = await client.start(workflows.continueAsNewSameWorkflow, {
+      taskQueue: 'test',
+      workflowId: uuid4(),
+      memo: {
+        note: 'foo',
+      },
+      searchAttributes: {
+        CustomKeywordField: ['test-value'],
+        CustomIntField: [1, 2],
+      },
+      followRuns: true,
+    });
+    await workflow.signal(workflows.continueAsNewSignal);
+    await workflow.result();
+
+    const execution = await workflow.describe();
+    t.not(execution.runId, workflow.firstExecutionRunId);
+    t.deepEqual(execution.memo, { note: 'foo' });
+    t.deepEqual(execution.searchAttributes!.CustomKeywordField, ['test-value']);
+    t.deepEqual(execution.searchAttributes!.CustomIntField, [1, 2]);
+  });
+
+  test('continue-as-new-to-different-workflow keeps memo and search attributes by default', async (t) => {
+    const { client } = t.context;
+    const workflow = await client.start(workflows.continueAsNewToDifferentWorkflow, {
+      taskQueue: 'test',
+      workflowId: uuid4(),
+      followRuns: true,
+      memo: {
+        note: 'foo',
+      },
+      searchAttributes: {
+        CustomKeywordField: ['test-value'],
+        CustomIntField: [1, 2],
+      },
+    });
+    await workflow.result();
+    const info = await workflow.describe();
+    t.is(info.type, 'sleeper');
+    t.not(info.runId, workflow.firstExecutionRunId);
+    t.deepEqual(info.memo, { note: 'foo' });
+    t.deepEqual(info.searchAttributes!.CustomKeywordField, ['test-value']);
+    t.deepEqual(info.searchAttributes!.CustomIntField, [1, 2]);
+  });
+
+  test('continue-as-new-to-different-workflow can set memo and search attributes', async (t) => {
+    const { client } = t.context;
+    const workflow = await client.start(workflows.continueAsNewToDifferentWorkflow, {
+      args: [
+        1,
+        {
+          memo: {
+            note: 'bar',
+          },
+          searchAttributes: {
+            CustomKeywordField: ['test-value-2'],
+            CustomIntField: [3, 4],
+          },
+        },
+      ],
+      taskQueue: 'test',
+      workflowId: uuid4(),
+      followRuns: true,
+      memo: {
+        note: 'foo',
+      },
+      searchAttributes: {
+        CustomKeywordField: ['test-value'],
+        CustomIntField: [1, 2],
+      },
+    });
+    await workflow.result();
+    const info = await workflow.describe();
+    t.is(info.type, 'sleeper');
+    t.not(info.runId, workflow.firstExecutionRunId);
+    t.deepEqual(info.memo, { note: 'bar' });
+    t.deepEqual(info.searchAttributes!.CustomKeywordField, ['test-value-2']);
+    t.deepEqual(info.searchAttributes!.CustomIntField, [3, 4]);
+  });
+
   test('signalWithStart works as intended and returns correct runId', async (t) => {
     const { client } = t.context;
     const ogWF = await client.signalWithStart(workflows.interruptableWorkflow, {

packages/test/src/workflows/continue-as-new-to-different-workflow.ts

@@ -2,10 +2,13 @@
  * Tests continueAsNew to another Workflow
  * @module
  */
-import { makeContinueAsNewFunc } from '@temporalio/workflow';
+import { ContinueAsNewOptions, makeContinueAsNewFunc } from '@temporalio/workflow';
 import { sleeper } from './sleep';
 
-export async function continueAsNewToDifferentWorkflow(ms = 1): Promise<void> {
-  const continueAsNew = makeContinueAsNewFunc<typeof sleeper>({ workflowType: 'sleeper' });
+export async function continueAsNewToDifferentWorkflow(
+  ms = 1,
+  extraArgs?: Partial<ContinueAsNewOptions>
+): Promise<void> {
+  const continueAsNew = makeContinueAsNewFunc<typeof sleeper>({ workflowType: 'sleeper', ...(extraArgs ?? {}) });
   await continueAsNew(ms);
 }

packages/workflow/src/interfaces.ts

@@ -189,7 +189,7 @@ export interface ContinueAsNewOptions {
   /**
    * Non-searchable attributes to attach to next Workflow run
    */
-  memo?: Record<string, any>;
+  memo?: Record<string, unknown>;
   /**
    * Searchable attributes to attach to next Workflow run
    */

packages/workflow/src/workflow.ts

@@ -939,7 +939,7 @@ export function makeContinueAsNewFunc<F extends Workflow>(
         arguments: toPayloads(activator.payloadConverter, ...args),
         headers,
         taskQueue: options.taskQueue,
-        memo: options.memo,
+        memo: options.memo && mapToPayloads(activator.payloadConverter, options.memo),
         searchAttributes: options.searchAttributes
           ? mapToPayloads(searchAttributePayloadConverter, options.searchAttributes)
           : undefined,