@temporalio/common 1.8.6 → 1.9.0

package/src/type-helpers.ts

@@ -140,3 +140,26 @@ export function SymbolBasedInstanceOfError<E extends Error>(markerName: string):
     });
   };
 }
+
+// Thanks MDN: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze
+export function deepFreeze<T>(object: T): T {
+  // Retrieve the property names defined on object
+  const propNames = Object.getOwnPropertyNames(object);
+
+  // Freeze properties before freezing self
+  for (const name of propNames) {
+    const value = (object as any)[name];
+
+    if (value && typeof value === 'object') {
+      try {
+        deepFreeze(value);
+      } catch (err) {
+        // This is okay, there are some typed arrays that cannot be frozen (encodingKeys)
+      }
+    } else if (typeof value === 'function') {
+      Object.freeze(value);
+    }
+  }
+
+  return Object.freeze(object);
+}

package/src/versioning-intent.ts

@@ -1,17 +1,15 @@
 /**
- * Indicates whether the user intends certain commands to be run on a compatible worker Build Id
- * version or not.
+ * Indicates whether the user intends certain commands to be run on a compatible worker Build Id version or not.
  *
- * `COMPATIBLE` indicates that the command should run on a worker with compatible version if
- * possible. It may not be possible if the target task queue does not also have knowledge of the
- * current worker's Build Id.
+ * `COMPATIBLE` indicates that the command should run on a worker with compatible version if possible. It may not be
+ * possible if the target task queue does not also have knowledge of the current worker's Build Id.
  *
- * `DEFAULT` indicates that the command should run on the target task queue's current
- * overall-default Build Id.
+ * `DEFAULT` indicates that the command should run on the target task queue's current overall-default Build Id.
  *
- * Where this type is accepted optionally, an unset value indicates that the SDK should choose the
- * most sensible default behavior for the type of command, accounting for whether the command will
- * be run on the same task queue as the current worker.
+ * Where this type is accepted optionally, an unset value indicates that the SDK should choose the most sensible default
+ * behavior for the type of command, accounting for whether the command will be run on the same task queue as the
+ * current worker. The default behavior for starting Workflows is `DEFAULT`. The default behavior for Workflows starting
+ * Activities, starting Child Workflows, or Continuing As New is `COMPATIBLE`.
  *
  * @experimental
  */

package/src/workflow-options.ts

@@ -1,8 +1,8 @@
-import type { temporal, google } from '@temporalio/proto';
+import type { temporal } from '@temporalio/proto';
 import { SearchAttributes, Workflow } from './interfaces';
 import { RetryPolicy } from './retry-policy';
-import { Duration, msOptionalToTs } from './time';
-import { checkExtends, Replace } from './type-helpers';
+import { Duration } from './time';
+import { checkExtends } from './type-helpers';
 
 // Avoid importing the proto implementation to reduce workflow bundle size
 // Copied from temporal.api.enums.v1.WorkflowIdReusePolicy
@@ -135,26 +135,6 @@ export interface WorkflowDurationOptions {
 
 export type CommonWorkflowOptions = BaseWorkflowOptions & WorkflowDurationOptions;
 
-export type WithCompiledWorkflowOptions<T extends CommonWorkflowOptions> = Replace<
-  T,
-  {
-    workflowExecutionTimeout?: google.protobuf.IDuration;
-    workflowRunTimeout?: google.protobuf.IDuration;
-    workflowTaskTimeout?: google.protobuf.IDuration;
-  }
->;
-
-export function compileWorkflowOptions<T extends CommonWorkflowOptions>(options: T): WithCompiledWorkflowOptions<T> {
-  const { workflowExecutionTimeout, workflowRunTimeout, workflowTaskTimeout, ...rest } = options;
-
-  return {
-    ...rest,
-    workflowExecutionTimeout: msOptionalToTs(workflowExecutionTimeout),
-    workflowRunTimeout: msOptionalToTs(workflowRunTimeout),
-    workflowTaskTimeout: msOptionalToTs(workflowTaskTimeout),
-  };
-}
-
 export function extractWorkflowType<T extends Workflow>(workflowTypeOrFunc: string | T): string {
   if (typeof workflowTypeOrFunc === 'string') return workflowTypeOrFunc as string;
   if (typeof workflowTypeOrFunc === 'function') {

package/lib/otel.d.ts

@@ -1,26 +0,0 @@
-import * as otel from '@opentelemetry/api';
-import { Headers } from './interceptors';
-/** Default trace header for opentelemetry interceptors */
-export declare const TRACE_HEADER = "_tracer-data";
-/** As in workflow run id */
-export declare const RUN_ID_ATTR_KEY = "run_id";
-/** For a workflow or activity task */
-export declare const TASK_TOKEN_ATTR_KEY = "task_token";
-/** Number of jobs in a workflow activation */
-export declare const NUM_JOBS_ATTR_KEY = "num_jobs";
-/**
- * If found, return an otel Context deserialized from the provided headers
- */
-export declare function extractContextFromHeaders(headers: Headers): Promise<otel.Context | undefined>;
-/**
- * If found, return an otel SpanContext deserialized from the provided headers
- */
-export declare function extractSpanContextFromHeaders(headers: Headers): Promise<otel.SpanContext | undefined>;
-/**
- * Given headers, return new headers with the current otel context inserted
- */
-export declare function headersWithContext(headers: Headers): Promise<Headers>;
-/**
- * Link a span to an maybe-existing span context
- */
-export declare function linkSpans(fromSpan: otel.Span, toContext?: otel.SpanContext): void;

package/lib/otel.js

@@ -1,87 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.linkSpans = exports.headersWithContext = exports.extractSpanContextFromHeaders = exports.extractContextFromHeaders = exports.NUM_JOBS_ATTR_KEY = exports.TASK_TOKEN_ATTR_KEY = exports.RUN_ID_ATTR_KEY = exports.TRACE_HEADER = void 0;
-const otel = __importStar(require("@opentelemetry/api"));
-const payload_converter_1 = require("./converter/payload-converter");
-/** Default trace header for opentelemetry interceptors */
-exports.TRACE_HEADER = '_tracer-data';
-/** As in workflow run id */
-exports.RUN_ID_ATTR_KEY = 'run_id';
-/** For a workflow or activity task */
-exports.TASK_TOKEN_ATTR_KEY = 'task_token';
-/** Number of jobs in a workflow activation */
-exports.NUM_JOBS_ATTR_KEY = 'num_jobs';
-const payloadConverter = payload_converter_1.defaultPayloadConverter;
-/**
- * If found, return an otel Context deserialized from the provided headers
- */
-async function extractContextFromHeaders(headers) {
-    const encodedSpanContext = headers[exports.TRACE_HEADER];
-    if (encodedSpanContext === undefined) {
-        return undefined;
-    }
-    const textMap = payloadConverter.fromPayload(encodedSpanContext);
-    return otel.propagation.extract(otel.context.active(), textMap, otel.defaultTextMapGetter);
-}
-exports.extractContextFromHeaders = extractContextFromHeaders;
-/**
- * If found, return an otel SpanContext deserialized from the provided headers
- */
-async function extractSpanContextFromHeaders(headers) {
-    const context = await extractContextFromHeaders(headers);
-    if (context === undefined) {
-        return undefined;
-    }
-    return otel.trace.getSpanContext(context);
-}
-exports.extractSpanContextFromHeaders = extractSpanContextFromHeaders;
-/**
- * Given headers, return new headers with the current otel context inserted
- */
-async function headersWithContext(headers) {
-    const carrier = {};
-    otel.propagation.inject(otel.context.active(), carrier, otel.defaultTextMapSetter);
-    return { ...headers, [exports.TRACE_HEADER]: payloadConverter.toPayload(carrier) };
-}
-exports.headersWithContext = headersWithContext;
-/**
- * Link a span to an maybe-existing span context
- */
-function linkSpans(fromSpan, toContext) {
-    if (toContext !== undefined) {
-        // TODO: I have to go around typescript because otel api 😢
-        //  See https://github.com/open-telemetry/opentelemetry-js-api/issues/124
-        const links = fromSpan.links;
-        if (links === undefined) {
-            fromSpan.links = [{ context: toContext }];
-        }
-        else {
-            links.push({ context: toContext });
-        }
-    }
-}
-exports.linkSpans = linkSpans;
-//# sourceMappingURL=otel.js.map

package/lib/otel.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"otel.js","sourceRoot":"","sources":["../src/otel.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAA2C;AAE3C,qEAAwE;AAExE,0DAA0D;AAC7C,QAAA,YAAY,GAAG,cAAc,CAAC;AAC3C,4BAA4B;AACf,QAAA,eAAe,GAAG,QAAQ,CAAC;AACxC,sCAAsC;AACzB,QAAA,mBAAmB,GAAG,YAAY,CAAC;AAChD,8CAA8C;AACjC,QAAA,iBAAiB,GAAG,UAAU,CAAC;AAE5C,MAAM,gBAAgB,GAAG,2CAAuB,CAAC;AAEjD;;GAEG;AACI,KAAK,UAAU,yBAAyB,CAAC,OAAgB;IAC9D,MAAM,kBAAkB,GAAG,OAAO,CAAC,oBAAY,CAAC,CAAC;IACjD,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACpC,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,OAAO,GAA2B,gBAAgB,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACzF,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;AAC7F,CAAC;AAPD,8DAOC;AAED;;GAEG;AACI,KAAK,UAAU,6BAA6B,CAAC,OAAgB;IAClE,MAAM,OAAO,GAAG,MAAM,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACzD,IAAI,OAAO,KAAK,SAAS,EAAE;QACzB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AAC5C,CAAC;AAPD,sEAOC;AAED;;GAEG;AACI,KAAK,UAAU,kBAAkB,CAAC,OAAgB;IACvD,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACnF,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,oBAAY,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;AAC7E,CAAC;AAJD,gDAIC;AAED;;GAEG;AACH,SAAgB,SAAS,CAAC,QAAmB,EAAE,SAA4B;IACzE,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,2DAA2D;QAC3D,yEAAyE;QACzE,MAAM,KAAK,GAAI,QAAgB,CAAC,KAAK,CAAC;QACtC,IAAI,KAAK,KAAK,SAAS,EAAE;YACtB,QAAgB,CAAC,KAAK,GAAG,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;SACpD;aAAM;YACL,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;SACpC;KACF;AACH,CAAC;AAXD,8BAWC"}

package/src/otel.ts

@@ -1,63 +0,0 @@
-import * as otel from '@opentelemetry/api';
-import { Headers } from './interceptors';
-import { defaultPayloadConverter } from './converter/payload-converter';
-
-/** Default trace header for opentelemetry interceptors */
-export const TRACE_HEADER = '_tracer-data';
-/** As in workflow run id */
-export const RUN_ID_ATTR_KEY = 'run_id';
-/** For a workflow or activity task */
-export const TASK_TOKEN_ATTR_KEY = 'task_token';
-/** Number of jobs in a workflow activation */
-export const NUM_JOBS_ATTR_KEY = 'num_jobs';
-
-const payloadConverter = defaultPayloadConverter;
-
-/**
- * If found, return an otel Context deserialized from the provided headers
- */
-export async function extractContextFromHeaders(headers: Headers): Promise<otel.Context | undefined> {
-  const encodedSpanContext = headers[TRACE_HEADER];
-  if (encodedSpanContext === undefined) {
-    return undefined;
-  }
-  const textMap: Record<string, string> = payloadConverter.fromPayload(encodedSpanContext);
-  return otel.propagation.extract(otel.context.active(), textMap, otel.defaultTextMapGetter);
-}
-
-/**
- * If found, return an otel SpanContext deserialized from the provided headers
- */
-export async function extractSpanContextFromHeaders(headers: Headers): Promise<otel.SpanContext | undefined> {
-  const context = await extractContextFromHeaders(headers);
-  if (context === undefined) {
-    return undefined;
-  }
-
-  return otel.trace.getSpanContext(context);
-}
-
-/**
- * Given headers, return new headers with the current otel context inserted
- */
-export async function headersWithContext(headers: Headers): Promise<Headers> {
-  const carrier = {};
-  otel.propagation.inject(otel.context.active(), carrier, otel.defaultTextMapSetter);
-  return { ...headers, [TRACE_HEADER]: payloadConverter.toPayload(carrier) };
-}
-
-/**
- * Link a span to an maybe-existing span context
- */
-export function linkSpans(fromSpan: otel.Span, toContext?: otel.SpanContext): void {
-  if (toContext !== undefined) {
-    // TODO: I have to go around typescript because otel api 😢
-    //  See https://github.com/open-telemetry/opentelemetry-js-api/issues/124
-    const links = (fromSpan as any).links;
-    if (links === undefined) {
-      (fromSpan as any).links = [{ context: toContext }];
-    } else {
-      links.push({ context: toContext });
-    }
-  }
-}