@temporalio/workflow 1.14.2-canary-release-testing.0 → 1.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/workflow",
-  "version": "1.14.2-canary-release-testing.0",
+  "version": "1.15.0",
   "description": "Temporal.io SDK Workflow sub-package",
   "keywords": [
     "temporal",
@@ -22,8 +22,8 @@
   "types": "lib/index.d.ts",
   "dependencies": {
     "nexus-rpc": "^0.0.1",
-    "@temporalio/common": "1.14.2-canary-release-testing.0",
-    "@temporalio/proto": "1.14.2-canary-release-testing.0"
+    "@temporalio/common": "1.15.0",
+    "@temporalio/proto": "1.15.0"
   },
   "devDependencies": {
     "source-map": "^0.7.4"
@@ -32,7 +32,7 @@
     "access": "public"
   },
   "engines": {
-    "node": ">= 18.0.0"
+    "node": ">= 20.0.0"
   },
   "files": [
     "src",

package/src/cancellation-scope.ts

@@ -35,7 +35,7 @@ export interface CancellationScopeOptions {
 
 /**
  * Cancellation Scopes provide the mechanic by which a Workflow may gracefully handle incoming requests for cancellation
- * (e.g. in response to {@link WorkflowHandle.cancel} or through the UI or CLI), as well as request cancelation of
+ * (e.g. in response to {@link WorkflowHandle.cancel} or through the UI or CLI), as well as request cancellation of
  * cancellable operations it owns (e.g. Activities, Timers, Child Workflows, etc).
  *
  * Cancellation Scopes form a tree, with the Workflow's main function running in the root scope of that tree.
@@ -57,7 +57,7 @@ export interface CancellationScopeOptions {
  * ```ts
  * async function myWorkflow(...): Promise<void> {
  *   try {
- *     // This activity runs in the root cancellation scope. Therefore, a cancelation request on
+ *     // This activity runs in the root cancellation scope. Therefore, a cancellation request on
  *     // the Workflow execution (e.g. through the UI or CLI) automatically propagates to this
  *     // activity. Assuming that the activity properly handle the cancellation request, then the
  *     // call below will throw an `ActivityFailure` exception, with `cause` sets to an

package/src/flags.ts

@@ -114,7 +114,7 @@ type AltConditionFn = (ctx: { info: WorkflowInfo; sdkVersion?: string }) => bool
 
 function buildIdSdkVersionMatches(version: RegExp): AltConditionFn {
   const regex = new RegExp(`^@temporalio/worker@(${version.source})[+]`);
-  return ({ info }) => info.currentBuildId != null && regex.test(info.currentBuildId); // eslint-disable-line deprecation/deprecation
+  return ({ info }) => info.currentBuildId != null && regex.test(info.currentBuildId); // eslint-disable-line @typescript-eslint/no-deprecated
 }
 
 type SemVer = {

package/src/global-attributes.ts

@@ -11,7 +11,7 @@ declare global {
   // bundles with different versions of the SDK, but in this specific case, there's really no
   // user-side value in renaming this, so making a breaking change for that would not be justified.
   //
-  // eslint-disable-next-line no-var
+
   var __TEMPORAL__: {
     api: typeof import('./worker-interface.ts');
     importWorkflows: () => Record<string, Workflow>;
@@ -19,11 +19,11 @@ declare global {
   };
 
   // Destructors to be called when the shared sandbox is destroyed.
-  // eslint-disable-next-line no-var
+
   var __temporal_globalSandboxDestructors: (() => void)[] | undefined;
 
   // FIXME: Rename to lowercase syntax before 1.15.0.
-  // eslint-disable-next-line no-var
+
   var __TEMPORAL_ACTIVATOR__: Activator | undefined;
 }
 

package/src/global-overrides.ts

@@ -42,7 +42,7 @@ export function overrideGlobals(): void {
 
   global.Date.prototype = OriginalDate.prototype;
 
-  const timeoutCancelationScopes = new Map<number, CancellationScope>();
+  const timeoutCancellationScopes = new Map<number, CancellationScope>();
 
   /**
    * @param ms sleep duration -  number of milliseconds. If given a negative number, value will be set to 1.
@@ -57,15 +57,15 @@ export function overrideGlobals(): void {
       const sleepPromise = timerScope.run(() => sleep(ms));
       sleepPromise.then(
         () => {
-          timeoutCancelationScopes.delete(seq);
+          timeoutCancellationScopes.delete(seq);
           cb(...args);
         },
         () => {
-          timeoutCancelationScopes.delete(seq);
+          timeoutCancellationScopes.delete(seq);
         }
       );
       untrackPromise(sleepPromise);
-      timeoutCancelationScopes.set(seq, timerScope);
+      timeoutCancellationScopes.set(seq, timerScope);
       return seq;
     } else {
       const seq = activator.nextSeqs.timer++;
@@ -88,9 +88,9 @@ export function overrideGlobals(): void {
 
   global.clearTimeout = function (handle: number): void {
     const activator = getActivator();
-    const timerScope = timeoutCancelationScopes.get(handle);
+    const timerScope = timeoutCancellationScopes.get(handle);
     if (timerScope) {
-      timeoutCancelationScopes.delete(handle);
+      timeoutCancellationScopes.delete(handle);
       timerScope.cancel();
     } else {
       activator.nextSeqs.timer++; // Shouldn't increase seq number, but that's the legacy behavior

package/src/index.ts

@@ -60,8 +60,8 @@ export {
   PayloadConverter,
   RetryPolicy,
   rootCause,
-  SearchAttributes, // eslint-disable-line deprecation/deprecation
-  SearchAttributeValue, // eslint-disable-line deprecation/deprecation
+  SearchAttributes, // eslint-disable-line @typescript-eslint/no-deprecated
+  SearchAttributeValue, // eslint-disable-line @typescript-eslint/no-deprecated
   ServerFailure,
   TemporalFailure,
   TerminatedFailure,
@@ -70,7 +70,7 @@ export {
 export * from '@temporalio/common/lib/errors';
 export {
   ActivityFunction,
-  ActivityInterface, // eslint-disable-line deprecation/deprecation
+  ActivityInterface, // eslint-disable-line @typescript-eslint/no-deprecated
   Payload,
   QueryDefinition,
   SignalDefinition,
@@ -108,8 +108,13 @@ export { Trigger } from './trigger';
 export * from './workflow';
 export { ChildWorkflowHandle, ExternalWorkflowHandle } from './workflow-handle';
 export { metricMeter } from './metrics';
-
-export { createNexusClient, NexusClientOptions, NexusClient, NexusOperationHandle } from './nexus';
+export {
+  createNexusClient,
+  NexusClientOptions,
+  NexusClient,
+  NexusOperationHandle,
+  NexusOperationCancellationType,
+} from './nexus';
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 // Deprecated APIs
@@ -121,6 +126,6 @@ export {
    *             exported by the `@temporalio/workflow` package. To capture log messages emitted
    *             by Workflow code, set the {@link Runtime.logger} property.
    */
-  // eslint-disable-next-line deprecation/deprecation
+
   LoggerSinksDeprecated as LoggerSinks,
 } from './logs';

package/src/interceptors.ts

@@ -15,7 +15,8 @@ import {
   WorkflowExecution,
 } from '@temporalio/common';
 import type { coresdk } from '@temporalio/proto';
-import { ChildWorkflowOptionsWithDefaults, ContinueAsNewOptions } from './interfaces';
+import type { ChildWorkflowOptionsWithDefaults, ContinueAsNewOptions } from './interfaces';
+import type { NexusOperationCancellationType } from './nexus';
 
 export { Next, Headers };
 
@@ -288,6 +289,22 @@ export interface StartNexusOperationOptions {
    */
   readonly scheduleToCloseTimeout?: Duration;
 
+  /**
+   * Determines:
+   * - whether cancellation requests should be propagated from the Workflow to the Nexus Operation
+   * - whether and when should the Operation's cancellation be reported back to the Workflow
+   *   (i.e. at which moment should the operation's result promise fail with a `NexusOperationFailure`,
+   *   with `cause` set to a `CancelledFailure`).
+   *
+   * Note that this setting only applies to cancellation originating from an external request for the
+   * Workflow itself, or from internal cancellation of the `CancellationScope` in which the
+   * Operation call was made.
+   *
+   * @default WAIT_CANCELLATION_COMPLETED
+   */
+  // MAINTENANCE: Keep this typedoc in sync with the `NexusOperationCancellationType` enum
+  readonly cancellationType?: NexusOperationCancellationType;
+
   /**
    * A fixed, single-line summary for this Nexus Operation that may appear in the UI/CLI.
    * This can be in single-line Temporal markdown format.

package/src/interfaces.ts

@@ -45,7 +45,7 @@ export interface WorkflowInfo {
    * This value may change during the lifetime of an Execution.
    * @deprecated Use {@link typedSearchAttributes} instead.
    */
-  readonly searchAttributes: SearchAttributes; // eslint-disable-line deprecation/deprecation
+  readonly searchAttributes: SearchAttributes; // eslint-disable-line @typescript-eslint/no-deprecated
 
   /**
    * Indexed information attached to the Workflow Execution, exposed through an interface.
@@ -208,8 +208,6 @@ export interface WorkflowInfo {
    * executing this task for the first time and has a Deployment Version set, then its ID will be
    * used. This value may change over the lifetime of the workflow run, but is deterministic and
    * safe to use for branching.
-   *
-   * @experimental Deployment based versioning is experimental and may change in the future.
    */
   readonly currentDeploymentVersion?: WorkerDeploymentVersion;
 
@@ -235,7 +233,22 @@ export interface UnsafeWorkflowInfo {
    */
   readonly now: () => number;
 
+  /**
+   * Whether the workflow is currently replaying.
+   */
   readonly isReplaying: boolean;
+
+  /**
+   * Whether the workflow is currently replaying history events.
+   *
+   * This is similar to {@link isReplaying}, but returns `false` during query handlers and update
+   * validators, which are live read-only operations that should not be considered as replaying
+   * history events.
+   *
+   * When this property is true, workflow log messages are suppressed and sinks defined with
+   * callDuringReplay=false won't get processed.
+   */
+  readonly isReplayingHistoryEvents: boolean;
 }
 
 /**
@@ -304,7 +317,7 @@ export interface ContinueAsNewOptions {
    * Searchable attributes to attach to next Workflow run
    * @deprecated Use {@link typedSearchAttributes} instead.
    */
-  searchAttributes?: SearchAttributes; // eslint-disable-line deprecation/deprecation
+  searchAttributes?: SearchAttributes; // eslint-disable-line @typescript-eslint/no-deprecated
   /**
    * Specifies additional indexed information to attach to the Workflow Execution. More info:
    * https://docs.temporal.io/docs/typescript/search-attributes
@@ -322,48 +335,74 @@ export interface ContinueAsNewOptions {
    *
    * @default 'COMPATIBLE'
    *
-   * @deprecated In favor of the new Worker Deployment API.
-   * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+   * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
    */
-  versioningIntent?: VersioningIntent; // eslint-disable-line deprecation/deprecation
+  versioningIntent?: VersioningIntent; // eslint-disable-line @typescript-eslint/no-deprecated
 }
 
 /**
- * Specifies:
- * - whether cancellation requests are sent to the Child
- * - whether and when a {@link CanceledFailure} is thrown from {@link executeChild} or
- *   {@link ChildWorkflowHandle.result}
+ * Determines:
+ * - whether cancellation requests should be propagated from the Parent Workflow to the Child, and
+ * - whether and when should the Child's cancellation be reported back to the Parent Workflow
+ *   (i.e. at which moment should the {@link executeChild}'s or {@link ChildWorkflowHandle.result}'s
+ *   promise fail with a `ChildWorkflowFailure`, with `cause` set to a `CancelledFailure`).
+ *
+ * Note that this setting only applies to cancellation originating from an external request for the
+ * Parent Workflow itself, or from internal cancellation of the `CancellationScope` in which the
+ * Child Workflow call was made. Eventual Cancellation of a Child Workflow on completion of the
+ * Parent Workflow is controlled by the {@link ParentClosePolicy} setting.
  *
- * @default {@link ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED}
+ * @default ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED
  */
-export type ChildWorkflowCancellationType =
-  (typeof ChildWorkflowCancellationType)[keyof typeof ChildWorkflowCancellationType];
+// MAINTENANCE: Keep this typedoc in sync with the `ChildWorkflowOptions.cancellationType` field
 export const ChildWorkflowCancellationType = {
   /**
-   * Don't send a cancellation request to the Child.
+   * Do not propagate cancellation requests to the Child, and immediately report cancellation
+   * to the caller.
    */
   ABANDON: 'ABANDON',
 
   /**
-   * Send a cancellation request to the Child. Immediately throw the error.
+   * Propagate cancellation request from the Parent Workflow to the Child, yet _immediately_ report
+   * cancellation to the caller, i.e. without waiting for the server to confirm the cancellation
+   * request.
+   *
+   * Note that this cancellation type provides no guarantee, from the Parent-side, that the
+   * cancellation request will actually be atomically added to the Child workflow's history.
+   * In particular, the Child may complete (either successfully or uncessfully) before the
+   * cancellation is delivered, resulting in a situation where the Parent workflow thinks its child
+   * was cancelled, but the child actually completed successfully.
+   *
+   * To guarantee that the Child will eventually be notified of the cancellation request,
+   * use {@link WAIT_CANCELLATION_REQUESTED}.
    */
   TRY_CANCEL: 'TRY_CANCEL',
 
   /**
-   * Send a cancellation request to the Child. The Child may respect cancellation, in which case an error will be thrown
-   * when cancellation has completed, and {@link isCancellation}(error) will be true. On the other hand, the Child may
-   * ignore the cancellation request, in which case an error might be thrown with a different cause, or the Child may
-   * complete successfully.
+   * Propagate cancellation request from the Parent Workflow to the Child, then wait for the server
+   * to confirm that the Child Workflow cancellation request was recorded in its history.
    *
-   * @default
+   * This cancellation type guarantees that the Child will eventually be notified of the
+   * cancellation request (that is, unless the Child terminates inbetween due to unexpected causes).
    */
-  WAIT_CANCELLATION_COMPLETED: 'WAIT_CANCELLATION_COMPLETED',
+  WAIT_CANCELLATION_REQUESTED: 'WAIT_CANCELLATION_REQUESTED',
 
   /**
-   * Send a cancellation request to the Child. Throw the error once the Server receives the Child cancellation request.
+   * Propagate cancellation request from the Parent Workflow to the Child, then wait for completion
+   * of the Child Workflow.
+   *
+   * The Child may respect cancellation, in which case the Parent's `executeChild` or
+   * `ChildWorkflowHandle.result` promise will fail with a `ChildWorkflowFailure`, with `cause`
+   * set to a `CancelledFailure`. On the other hand, the Child may ignore the cancellation request,
+   * in which case the corresponding promise will either resolve with a result (if Child completed
+   * successfully) or reject with a different cause (if Child completed uncessfully).
+   *
+   * @default
    */
-  WAIT_CANCELLATION_REQUESTED: 'WAIT_CANCELLATION_REQUESTED',
+  WAIT_CANCELLATION_COMPLETED: 'WAIT_CANCELLATION_COMPLETED',
 } as const;
+export type ChildWorkflowCancellationType =
+  (typeof ChildWorkflowCancellationType)[keyof typeof ChildWorkflowCancellationType];
 
 // ts-prune-ignore-next
 export const [encodeChildWorkflowCancellationType, decodeChildWorkflowCancellationType] = makeProtoEnumConverters<
@@ -387,7 +426,6 @@ export const [encodeChildWorkflowCancellationType, decodeChildWorkflowCancellati
  *
  * @see {@link https://docs.temporal.io/concepts/what-is-a-parent-close-policy/ | Parent Close Policy}
  */
-export type ParentClosePolicy = (typeof ParentClosePolicy)[keyof typeof ParentClosePolicy];
 export const ParentClosePolicy = {
   /**
    * When the Parent is Closed, the Child is Terminated.
@@ -413,29 +451,30 @@ export const ParentClosePolicy = {
    *
    * @deprecated Either leave property `undefined`, or set an explicit policy instead.
    */
-  PARENT_CLOSE_POLICY_UNSPECIFIED: undefined, // eslint-disable-line deprecation/deprecation
+  PARENT_CLOSE_POLICY_UNSPECIFIED: undefined,
 
   /**
    * When the Parent is Closed, the Child is Terminated.
    *
    * @deprecated Use {@link ParentClosePolicy.TERMINATE} instead.
    */
-  PARENT_CLOSE_POLICY_TERMINATE: 'TERMINATE', // eslint-disable-line deprecation/deprecation
+  PARENT_CLOSE_POLICY_TERMINATE: 'TERMINATE',
 
   /**
    * When the Parent is Closed, nothing is done to the Child.
    *
    * @deprecated Use {@link ParentClosePolicy.ABANDON} instead.
    */
-  PARENT_CLOSE_POLICY_ABANDON: 'ABANDON', // eslint-disable-line deprecation/deprecation
+  PARENT_CLOSE_POLICY_ABANDON: 'ABANDON',
 
   /**
    * When the Parent is Closed, the Child is Cancelled.
    *
    * @deprecated Use {@link ParentClosePolicy.REQUEST_CANCEL} instead.
    */
-  PARENT_CLOSE_POLICY_REQUEST_CANCEL: 'REQUEST_CANCEL', // eslint-disable-line deprecation/deprecation
+  PARENT_CLOSE_POLICY_REQUEST_CANCEL: 'REQUEST_CANCEL',
 } as const;
+export type ParentClosePolicy = (typeof ParentClosePolicy)[keyof typeof ParentClosePolicy];
 
 // ts-prune-ignore-next
 export const [encodeParentClosePolicy, decodeParentClosePolicy] = makeProtoEnumConverters<
@@ -471,19 +510,26 @@ export interface ChildWorkflowOptions extends Omit<CommonWorkflowOptions, 'workf
   taskQueue?: string;
 
   /**
-   * Specifies:
-   * - whether cancellation requests are sent to the Child
-   * - whether and when an error is thrown from {@link executeChild} or
-   *   {@link ChildWorkflowHandle.result}
+   * Determines:
+   * - whether cancellation requests should be propagated from the Parent Workflow to the Child, and
+   * - whether and when should the Child's cancellation be reported back to the Parent Workflow
+   *   (i.e. at which moment should the {@link executeChild}'s or {@link ChildWorkflowHandle.result}'s
+   *   promise fail with a `ChildWorkflowFailure`, with `cause` set to a `CancelledFailure`).
+   *
+   * Note that this setting only applies to cancellation originating from an external request for the
+   * Parent Workflow itself, or from internal cancellation of the `CancellationScope` in which the
+   * Child Workflow call was made. Eventual Cancellation of a Child Workflow on completion of the
+   * Parent Workflow is controlled by the {@link ParentClosePolicy} setting.
    *
-   * @default {@link ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED}
+   * @default ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED
    */
+  // MAINTENANCE: Keep this typedoc in sync with the `ChildWorkflowCancellationType` enum
   cancellationType?: ChildWorkflowCancellationType;
 
   /**
    * Specifies how the Child reacts to the Parent Workflow reaching a Closed state.
    *
-   * @default {@link ParentClosePolicy.PARENT_CLOSE_POLICY_TERMINATE}
+   * @default ParentClosePolicy.PARENT_CLOSE_POLICY_TERMINATE
    */
   parentClosePolicy?: ParentClosePolicy;
 
@@ -493,10 +539,9 @@ export interface ChildWorkflowOptions extends Omit<CommonWorkflowOptions, 'workf
    *
    * @default 'COMPATIBLE'
    *
-   * @deprecated In favor of the new Worker Deployment API.
-   * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+   * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
    */
-  versioningIntent?: VersioningIntent; // eslint-disable-line deprecation/deprecation
+  versioningIntent?: VersioningIntent; // eslint-disable-line @typescript-eslint/no-deprecated
 }
 
 export type RequiredChildWorkflowOptions = Required<Pick<ChildWorkflowOptions, 'workflowId' | 'cancellationType'>> & {
@@ -581,6 +626,7 @@ export interface WorkflowCreateOptionsInternal extends WorkflowCreateOptions {
   sourceMap: RawSourceMap;
   registeredActivityNames: Set<string>;
   getTimeOfDay(): bigint;
+  stackTracesEnabled: boolean;
 }
 
 /**

package/src/internals.ts

@@ -457,6 +457,8 @@ export class Activator implements ActivationHandler {
 
   public readonly workflowSandboxDestructors: (() => void)[] = [];
 
+  protected readonly stackTracesEnabled: boolean;
+
   constructor({
     info,
     now,
@@ -465,6 +467,7 @@ export class Activator implements ActivationHandler {
     getTimeOfDay,
     randomnessSeed,
     registeredActivityNames,
+    stackTracesEnabled,
   }: WorkflowCreateOptionsInternal) {
     this.getTimeOfDay = getTimeOfDay;
     this.info = info;
@@ -473,6 +476,7 @@ export class Activator implements ActivationHandler {
     this.sourceMap = sourceMap;
     this.random = alea(randomnessSeed);
     this.registeredActivityNames = registeredActivityNames;
+    this.stackTracesEnabled = stackTracesEnabled;
   }
 
   /**
@@ -483,6 +487,9 @@ export class Activator implements ActivationHandler {
   }
 
   protected getStackTraces(): Stack[] {
+    if (!this.stackTracesEnabled) {
+      throw new IllegalStateError('Workflow stack traces are not enabled on this worker');
+    }
     const { childToParent, promiseToStack } = this.promiseStackStore;
     const internalNodes = [...childToParent.values()].reduce((acc, curr) => {
       for (const p of curr) {
@@ -858,12 +865,26 @@ export class Activator implements ActivationHandler {
       let input: UpdateInput;
       try {
         if (runValidator && entry.validator) {
-          const validate = composeInterceptors(
-            interceptors,
-            'validateUpdate',
-            this.validateUpdateNextHandler.bind(this, entry.validator)
-          );
-          validate(makeInput());
+          // Temporarily mark as not replaying history events during validator execution
+          // so that logging is permitted. Validators are live read-only operations.
+          const wasReplayingHistoryEvents = this.info.unsafe.isReplayingHistoryEvents;
+          this.mutateWorkflowInfo((info) => ({
+            ...info,
+            unsafe: { ...info.unsafe, isReplayingHistoryEvents: false },
+          }));
+          try {
+            const validate = composeInterceptors(
+              interceptors,
+              'validateUpdate',
+              this.validateUpdateNextHandler.bind(this, entry.validator)
+            );
+            validate(makeInput());
+          } finally {
+            this.mutateWorkflowInfo((info) => ({
+              ...info,
+              unsafe: { ...info.unsafe, isReplayingHistoryEvents: wasReplayingHistoryEvents },
+            }));
+          }
         }
         input = makeInput();
       } catch (error) {
@@ -930,7 +951,6 @@ export class Activator implements ActivationHandler {
       const update = this.bufferedUpdates.shift();
       if (update) {
         this.rejectUpdate(
-          /* eslint-disable @typescript-eslint/no-non-null-assertion */
           update.protocolInstanceId!,
           ApplicationFailure.nonRetryable(`No registered handler for update: ${update.name}`)
         );
@@ -997,7 +1017,7 @@ export class Activator implements ActivationHandler {
     while (bufferedSignals.length) {
       if (this.defaultSignalHandler) {
         // We have a default signal handler, so all signals are dispatchable
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
         this.signalWorkflow(bufferedSignals.shift()!);
       } else {
         const foundIndex = bufferedSignals.findIndex((signal) => this.signalHandlers.has(signal.signalName as string));

package/src/metrics.ts

@@ -48,6 +48,9 @@ class WorkflowMetricMeterImpl implements MetricMeter {
 }
 
 class WorkflowMetricCounter implements MetricCounter {
+  public readonly kind = 'counter';
+  public readonly valueType = 'int';
+
   constructor(
     public readonly name: string,
     public readonly unit: string | undefined,
@@ -70,6 +73,8 @@ class WorkflowMetricCounter implements MetricCounter {
 }
 
 class WorkflowMetricHistogram implements MetricHistogram {
+  public readonly kind = 'histogram';
+
   constructor(
     public readonly name: string,
     public readonly valueType: NumericMetricValueType,
@@ -93,6 +98,8 @@ class WorkflowMetricHistogram implements MetricHistogram {
 }
 
 class WorkflowMetricGauge implements MetricGauge {
+  public readonly kind = 'gauge';
+
   constructor(
     public readonly name: string,
     public readonly valueType: NumericMetricValueType,