feat(workflow): List registered queries in error response when a quer… (#791)

Author: bergundy

packages/client/src/workflow-client.ts

@@ -611,6 +611,9 @@ export class WorkflowClient {
         },
       });
     } catch (err) {
+      if (isServerErrorResponse(err) && err.code === grpcStatus.INVALID_ARGUMENT) {
+        throw new QueryNotRegisteredError(err.message.replace(/^3 INVALID_ARGUMENT: /, ''), err.code);
+      }
       this.rethrowGrpcError(err, input.workflowExecution, 'Failed to query Workflow');
     }
     if (response.queryRejected) {
@@ -938,6 +941,13 @@ export class QueryRejectedError extends Error {
   }
 }
 
+export class QueryNotRegisteredError extends Error {
+  public readonly name: string = 'QueryNotRegisteredError';
+  constructor(message: string, public readonly code: grpcStatus) {
+    super(message);
+  }
+}
+
 function workflowStatusCodeToName(code: temporal.api.enums.v1.WorkflowExecutionStatus): WorkflowExecutionStatusName {
   return workflowStatusCodeToNameInternal(code) ?? 'UNKNOWN';
 }

packages/test/src/integration-tests.ts

@@ -3,6 +3,7 @@ import {
   ActivityFailure,
   ApplicationFailure,
   Connection,
+  QueryNotRegisteredError,
   WorkflowClient,
   WorkflowContinuedAsNewError,
   WorkflowFailedError,
@@ -391,6 +392,20 @@ export function runIntegrationTests(codec?: PayloadCodec): void {
     t.pass();
   });
 
+  test('query not found', async (t) => {
+    const { client } = t.context;
+    const workflow = await client.start(workflows.unblockOrCancel, {
+      taskQueue: 'test',
+      workflowId: uuid4(),
+    });
+    await workflow.signal(workflows.unblockSignal);
+    await workflow.result();
+    await t.throwsAsync(workflow.query('not found'), {
+      instanceOf: QueryNotRegisteredError,
+      message: 'Workflow did not register a handler for not found. Registered queries: [__stack_trace isBlocked]',
+    });
+  });
+
   test('query and unblock', async (t) => {
     const { client } = t.context;
     const workflow = await client.start(workflows.unblockOrCancel, {

packages/workflow/src/internals.ts

@@ -212,8 +212,11 @@ export class Activator implements ActivationHandler {
   protected queryWorkflowNextHandler({ queryName, args }: QueryInput): Promise<unknown> {
     const fn = state.queryHandlers.get(queryName);
     if (fn === undefined) {
+      const knownQueryTypes = [...state.queryHandlers.keys()].join(' ');
       // Fail the query
-      throw new ReferenceError(`Workflow did not register a handler for ${queryName}`);
+      throw new ReferenceError(
+        `Workflow did not register a handler for ${queryName}. Registered queries: [${knownQueryTypes}]`
+      );
     }
     try {
       const ret = fn(...args);