@temporalio/common 1.9.0 → 1.9.1

package/lib/interfaces.d.ts

@@ -4,8 +4,21 @@ 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;
+export type WorkflowQueryAnnotatedType = {
+    handler: WorkflowQueryType;
+    description?: string;
+};
 /**
  * Broad Workflow function definition, specific Workflows will typically use a narrower type definition, e.g:
  * ```ts

package/lib/otel.d.ts

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,87 @@
+"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

@@ -0,0 +1 @@
+{"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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/common",
-  "version": "1.9.0",
+  "version": "1.9.1",
   "description": "Common library for code that's used across the Client, Worker, and/or Workflow",
   "main": "lib/index.js",
   "types": "./lib/index.d.ts",
@@ -12,7 +12,7 @@
   "author": "Temporal Technologies Inc. <sdk@temporal.io>",
   "license": "MIT",
   "dependencies": {
-    "@temporalio/proto": "1.9.0",
+    "@temporalio/proto": "1.9.1",
     "long": "^5.2.3",
     "ms": "^3.0.0-canary.1",
     "proto3-json-serializer": "^2.0.0"
@@ -36,5 +36,5 @@
     "src",
     "lib"
   ],
-  "gitHead": "5096976287616207edcd3e4281a2a5e1f7393e33"
+  "gitHead": "05f22004a0d877d8a128768016d5719adbc67de8"
 }

package/src/interfaces.ts

@@ -6,8 +6,15 @@ 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;
+export type WorkflowQueryAnnotatedType = { handler: WorkflowQueryType; description?: string };
 
 /**
  * Broad Workflow function definition, specific Workflows will typically use a narrower type definition, e.g: