Merge branch 'add-get-workflow-metadata' of github.com:antlai-temporal/sdk-typescript into add-get-workflow-metadata

Author: antlai-temporal

packages/common/src/interfaces.ts

@@ -6,7 +6,13 @@ export type Payload = temporal.api.common.v1.IPayload;
 export type WorkflowReturnType = Promise<any>;
 export type WorkflowUpdateType = (...args: any[]) => Promise<any> | any;
 export type WorkflowUpdateValidatorType = (...args: any[]) => void;
+export type WorkflowUpdateAnnotatedType = {
+  handler: WorkflowUpdateType;
+  validator?: WorkflowUpdateValidatorType;
+  description?: string;
+};
 export type WorkflowSignalType = (...args: any[]) => Promise<void> | void;
+export type WorkflowSignalAnnotatedType = { handler: WorkflowSignalType; description?: string };
 export type WorkflowQueryType = (...args: any[]) => any;
 
 /**

packages/workflow/src/interfaces.ts

@@ -464,3 +464,18 @@ export type DefaultSignalHandler = (signalName: string, ...args: unknown[]) => v
  * A validation function capable of accepting the arguments for a given UpdateDefinition.
  */
 export type UpdateValidator<Args extends any[]> = (...args: Args) => void;
+
+/**
+ * A description of a signal or query handler.
+ */
+export type SignalOrQueryHandlerOptions = { description?: string };
+
+/**
+ * A validator and description of an update handler.
+ */
+export type UpdateHandlerOptions<Args extends any[]> = { validator?: UpdateValidator<Args>; description?: string };
+
+/**
+ * Options for a generic handler.
+ */
+export type AnyHandlerOptions<Args extends any[]> = UpdateHandlerOptions<Args>;

packages/workflow/src/internals.ts

@@ -11,10 +11,9 @@ import {
   Workflow,
   WorkflowExecutionAlreadyStartedError,
   WorkflowQueryType,
-  WorkflowSignalType,
-  WorkflowUpdateType,
+  WorkflowSignalAnnotatedType,
+  WorkflowUpdateAnnotatedType,
   ProtoFailure,
-  WorkflowUpdateValidatorType,
   ApplicationFailure,
 } from '@temporalio/common';
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
@@ -125,15 +124,12 @@ export class Activator implements ActivationHandler {
   /**
    * Mapping of update name to handler and validator
    */
-  readonly updateHandlers = new Map<
-    string,
-    { handler: WorkflowUpdateType; validator?: WorkflowUpdateValidatorType; description?: string }
-  >();
+  readonly updateHandlers = new Map<string, WorkflowUpdateAnnotatedType>();
 
   /**
    * Mapping of signal name to handler
    */
-  readonly signalHandlers = new Map<string, { handler: WorkflowSignalType; description?: string }>();
+  readonly signalHandlers = new Map<string, WorkflowSignalAnnotatedType>();
 
   /**
    * A signal handler that catches calls for non-registered signal names.
@@ -205,7 +201,6 @@ export class Activator implements ActivationHandler {
       {
         handler: (): temporal.api.sdk.v1.IWorkflowMetadata => {
           const workflowType = this.info.workflowType;
-          const description = this.info?.memo?.__temporal_workflow_description;
           const queryDefinitions = Array.from(this.queryHandlers.entries()).map(([name, value]) => ({
             name,
             description: value.description,
@@ -221,15 +216,14 @@ export class Activator implements ActivationHandler {
           return {
             definition: {
               type: workflowType,
-              description: typeof description === 'string' ? description : null,
+              description: null, // For now, do not set the workflow description in the TS SDK.
               queryDefinitions,
               signalDefinitions,
               updateDefinitions,
             },
           };
         },
-        description:
-          'Returns metadata associated with this workflow. Use `memo.__temporal_workflow_description` to add a workflow description.',
+        description: 'Returns metadata associated with this workflow.',
       },
     ],
   ]);

packages/workflow/src/workflow.ts

@@ -32,6 +32,7 @@ import {
   TimerInput,
 } from './interceptors';
 import {
+  AnyHandlerOptions,
   ChildWorkflowCancellationType,
   ChildWorkflowOptions,
   ChildWorkflowOptionsWithDefaults,
@@ -40,7 +41,8 @@ import {
   DefaultSignalHandler,
   EnhancedStackTrace,
   Handler,
-  UpdateValidator,
+  SignalOrQueryHandlerOptions,
+  UpdateHandlerOptions,
   WorkflowInfo,
 } from './interfaces';
 import { LocalActivityDoBackoff } from './errors';
@@ -1149,12 +1151,12 @@ export function defineQuery<Ret, Args extends any[] = [], Name extends string =
 export function setHandler<Ret, Args extends any[], T extends SignalDefinition<Args> | QueryDefinition<Ret, Args>>(
   def: T,
   handler: Handler<Ret, Args, T> | undefined,
-  options?: { description?: string }
+  options?: SignalOrQueryHandlerOptions
 ): void;
 export function setHandler<Ret, Args extends any[], T extends UpdateDefinition<Ret, Args>>(
   def: T,
   handler: Handler<Ret, Args, T> | undefined,
-  options?: { validator?: UpdateValidator<Args>; description?: string }
+  options?: UpdateHandlerOptions<Args>
 ): void;
 
 // For Updates and Signals we want to make a public guarantee something like the
@@ -1243,11 +1245,7 @@ export function setHandler<
   Ret,
   Args extends any[],
   T extends UpdateDefinition<Ret, Args> | SignalDefinition<Args> | QueryDefinition<Ret, Args>,
->(
-  def: T,
-  handler: Handler<Ret, Args, T> | undefined,
-  options?: { validator?: UpdateValidator<Args>; description?: string }
-): void {
+>(def: T, handler: Handler<Ret, Args, T> | undefined, options?: AnyHandlerOptions<Args>): void {
   const activator = assertInWorkflowContext('Workflow.setHandler(...) may only be used from a Workflow Execution.');
   const description = options?.description;
   if (def.type === 'update') {