@temporalio/interceptors-opentelemetry 1.14.2 → 1.15.1

package/src/workflow/index.ts

@@ -1,4 +1,3 @@
-/* eslint-disable import/order */
 // eslint-disable-next-line import/no-unassigned-import
 import './runtime'; // Patch the Workflow isolate runtime for opentelemetry
 import * as otel from '@opentelemetry/api';
@@ -36,7 +35,7 @@ import {
 import { ContextManager } from './context-manager';
 import { SpanName, SPAN_DELIMITER } from './definitions';
 import { SpanExporter } from './span-exporter';
-import { ensureWorkflowModuleLoaded, getWorkflowModule, hasSdkFlag } from './workflow-module-loader';
+import { workflowInfo, ContinueAsNew, getActivator, SdkFlags } from './workflow-imports';
 
 export * from './definitions';
 
@@ -67,18 +66,12 @@ function getTracer(): otel.Tracer {
 export class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInterceptor {
   protected readonly tracer = getTracer();
 
-  public constructor() {
-    ensureWorkflowModuleLoaded();
-  }
-
   public async execute(
     input: WorkflowExecuteInput,
     next: Next<WorkflowInboundCallsInterceptor, 'execute'>
   ): Promise<unknown> {
-    const { workflowInfo, ContinueAsNew } = getWorkflowModule();
-
     const context = extractContextFromHeaders(input.headers);
-    if (!hasSdkFlag('OpenTelemetryInterceporsAvoidsExtraYields')) await Promise.resolve();
+    if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceporsAvoidsExtraYields)) await Promise.resolve();
 
     return await instrument({
       tracer: this.tracer,
@@ -94,10 +87,10 @@ export class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInte
     next: Next<WorkflowInboundCallsInterceptor, 'handleSignal'>
   ): Promise<void> {
     // Tracing of inbound signals was added in v1.11.5.
-    if (!hasSdkFlag('OpenTelemetryInterceptorsTracesInboundSignals')) return next(input);
+    if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorsTracesInboundSignals)) return next(input);
 
     const context = extractContextFromHeaders(input.headers);
-    if (!hasSdkFlag('OpenTelemetryInterceporsAvoidsExtraYields')) await Promise.resolve();
+    if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceporsAvoidsExtraYields)) await Promise.resolve();
 
     return await instrument({
       tracer: this.tracer,
@@ -111,7 +104,7 @@ export class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInte
     input: UpdateInput,
     next: Next<WorkflowInboundCallsInterceptor, 'handleUpdate'>
   ): Promise<unknown> {
-    if (!hasSdkFlag('OpenTelemetryInterceptorsInstrumentsAllMethods')) return next(input);
+    if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorsInstrumentsAllMethods)) return next(input);
 
     const context = extractContextFromHeaders(input.headers);
 
@@ -127,7 +120,7 @@ export class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInte
   }
 
   public validateUpdate(input: UpdateInput, next: Next<WorkflowInboundCallsInterceptor, 'validateUpdate'>): void {
-    if (!hasSdkFlag('OpenTelemetryInterceptorsInstrumentsAllMethods')) return next(input);
+    if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorsInstrumentsAllMethods)) return next(input);
 
     const context = extractContextFromHeaders(input.headers);
     instrumentSync({
@@ -145,7 +138,7 @@ export class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInte
     input: QueryInput,
     next: Next<WorkflowInboundCallsInterceptor, 'handleQuery'>
   ): Promise<unknown> {
-    if (!hasSdkFlag('OpenTelemetryInterceptorsInstrumentsAllMethods')) return next(input);
+    if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorsInstrumentsAllMethods)) return next(input);
 
     const context = extractContextFromHeaders(input.headers);
 
@@ -168,10 +161,6 @@ export class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInte
 export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsInterceptor {
   protected readonly tracer = getTracer();
 
-  public constructor() {
-    ensureWorkflowModuleLoaded();
-  }
-
   public async scheduleActivity(
     input: ActivityInput,
     next: Next<WorkflowOutboundCallsInterceptor, 'scheduleActivity'>
@@ -181,7 +170,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
       spanName: `${SpanName.ACTIVITY_START}${SPAN_DELIMITER}${input.activityType}`,
       fn: async () => {
         const headers = headersWithContext(input.headers);
-        if (!hasSdkFlag('OpenTelemetryInterceporsAvoidsExtraYields')) await Promise.resolve();
+        if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceporsAvoidsExtraYields)) await Promise.resolve();
 
         return next({
           ...input,
@@ -196,14 +185,14 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
     next: Next<WorkflowOutboundCallsInterceptor, 'scheduleLocalActivity'>
   ): Promise<unknown> {
     // Tracing of local activities was added in v1.11.6.
-    if (!hasSdkFlag('OpenTelemetryInterceptorsTracesLocalActivities')) return next(input);
+    if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorsTracesLocalActivities)) return next(input);
 
     return await instrument({
       tracer: this.tracer,
       spanName: `${SpanName.ACTIVITY_START}${SPAN_DELIMITER}${input.activityType}`,
       fn: async () => {
         const headers = headersWithContext(input.headers);
-        if (!hasSdkFlag('OpenTelemetryInterceporsAvoidsExtraYields')) await Promise.resolve();
+        if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceporsAvoidsExtraYields)) await Promise.resolve();
 
         return next({
           ...input,
@@ -217,7 +206,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
     input: StartNexusOperationInput,
     next: Next<WorkflowOutboundCallsInterceptor, 'startNexusOperation'>
   ): Promise<StartNexusOperationOutput> {
-    if (!hasSdkFlag('OpenTelemetryInterceptorsInstrumentsAllMethods')) return next(input);
+    if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorsInstrumentsAllMethods)) return next(input);
 
     return await instrument({
       tracer: this.tracer,
@@ -240,7 +229,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
       spanName: `${SpanName.CHILD_WORKFLOW_START}${SPAN_DELIMITER}${input.workflowType}`,
       fn: async () => {
         const headers = headersWithContext(input.headers);
-        if (!hasSdkFlag('OpenTelemetryInterceporsAvoidsExtraYields')) await Promise.resolve();
+        if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceporsAvoidsExtraYields)) await Promise.resolve();
 
         return next({
           ...input,
@@ -254,13 +243,12 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
     input: ContinueAsNewInput,
     next: Next<WorkflowOutboundCallsInterceptor, 'continueAsNew'>
   ): Promise<never> {
-    const { ContinueAsNew } = getWorkflowModule();
     return await instrument({
       tracer: this.tracer,
       spanName: `${SpanName.CONTINUE_AS_NEW}${SPAN_DELIMITER}${input.options.workflowType}`,
       fn: async () => {
         const headers = headersWithContext(input.headers);
-        if (!hasSdkFlag('OpenTelemetryInterceporsAvoidsExtraYields')) await Promise.resolve();
+        if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceporsAvoidsExtraYields)) await Promise.resolve();
 
         return next({
           ...input,
@@ -280,7 +268,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
       spanName: `${SpanName.WORKFLOW_SIGNAL}${SPAN_DELIMITER}${input.signalName}`,
       fn: async () => {
         const headers = headersWithContext(input.headers);
-        if (!hasSdkFlag('OpenTelemetryInterceporsAvoidsExtraYields')) await Promise.resolve();
+        if (!getActivator().hasFlag(SdkFlags.OpenTelemetryInterceporsAvoidsExtraYields)) await Promise.resolve();
 
         return next({
           ...input,

package/src/workflow/runtime.ts

@@ -2,11 +2,9 @@
  * Sets global variables required for importing opentelemetry in isolate
  * @module
  */
-import { getWorkflowModuleIfAvailable } from './workflow-module-loader';
+import { inWorkflowContext } from './workflow-imports';
 
-const inWorkflowContext = getWorkflowModuleIfAvailable()?.inWorkflowContext;
-
-if (inWorkflowContext?.()) {
+if (inWorkflowContext()) {
   // Required by opentelemetry (pretend to be a browser)
   Object.assign(globalThis, {
     performance: {

package/src/workflow/span-exporter.ts

@@ -1,17 +1,16 @@
 import * as tracing from '@opentelemetry/sdk-trace-base';
 import { ExportResult, ExportResultCode } from '@opentelemetry/core';
-import { OpenTelemetrySinks, SerializableSpan } from './definitions';
-import { ensureWorkflowModuleLoaded, getWorkflowModuleIfAvailable } from './workflow-module-loader';
-
-const exporter = getWorkflowModuleIfAvailable()?.proxySinks<OpenTelemetrySinks>()?.exporter;
+import { OpenTelemetrySinks, SerializableSpan, SerializableSpanContext } from './definitions';
+import { proxySinks } from './workflow-imports';
 
 export class SpanExporter implements tracing.SpanExporter {
-  public constructor() {
-    ensureWorkflowModuleLoaded();
-  }
+  private exporter?: OpenTelemetrySinks['exporter'];
 
   public export(spans: tracing.ReadableSpan[], resultCallback: (result: ExportResult) => void): void {
-    exporter!.export(spans.map((span) => this.makeSerializable(span)));
+    if (!this.exporter) {
+      this.exporter = proxySinks<OpenTelemetrySinks>().exporter;
+    }
+    this.exporter.export(spans.map((span) => this.makeSerializable(span)));
     resultCallback({ code: ExportResultCode.SUCCESS });
   }
 
@@ -20,10 +19,18 @@ export class SpanExporter implements tracing.SpanExporter {
   }
 
   public makeSerializable(span: tracing.ReadableSpan): SerializableSpan {
+    const { traceState, ...restSpanContext } = span.spanContext();
+    // Serialize traceState to a string because TraceState objects lose their
+    // prototype methods when crossing the V8 isolate boundary.
+    // See: https://github.com/temporalio/sdk-typescript/issues/1738
+    const serializableSpanContext: SerializableSpanContext = {
+      traceState: traceState?.serialize(),
+      ...restSpanContext,
+    };
     return {
       name: span.name,
       kind: span.kind,
-      spanContext: span.spanContext(),
+      spanContext: serializableSpanContext,
       parentSpanId: span.parentSpanId,
       startTime: span.startTime,
       endTime: span.endTime,

package/src/workflow/workflow-imports-impl.ts

@@ -0,0 +1,9 @@
+/**
+ * Real workflow imports for otel interceptors.
+ * This replaces the stub via webpack alias when bundled.
+ *
+ * @module
+ */
+export { inWorkflowContext, proxySinks, workflowInfo, AsyncLocalStorage, ContinueAsNew } from '@temporalio/workflow';
+export { SdkFlags } from '@temporalio/workflow/lib/flags';
+export { getActivator } from '@temporalio/workflow/lib/global-attributes';

package/src/workflow/workflow-imports.ts

@@ -0,0 +1,42 @@
+/**
+ * Workflow imports stub module.
+ *
+ * This module provides stubs for workflow functionality needed by interceptors.
+ * When bundled by the workflow bundler, this is replaced with the real
+ * implementation via NormalModuleReplacementPlugin.
+ *
+ * @module
+ */
+import type {
+  inWorkflowContext as inWorkflowContextT,
+  workflowInfo as workflowInfoT,
+  proxySinks as proxySinksT,
+  AsyncLocalStorage as AsyncLocalStorageT,
+  ContinueAsNew as ContinueAsNewT,
+} from '@temporalio/workflow';
+import type { getActivator as getActivatorT } from '@temporalio/workflow/lib/global-attributes';
+import type { SdkFlags as SdkFlagsT } from '@temporalio/workflow/lib/flags';
+
+import { IllegalStateError } from '@temporalio/common';
+
+// always returns false since if using this implementation, we are outside of workflow context
+export const inWorkflowContext: typeof inWorkflowContextT = () => false;
+
+// All of the following stubs will throw if used
+export const workflowInfo: typeof workflowInfoT = () => {
+  throw new IllegalStateError('Workflow.workflowInfo(...) may only be used from a Workflow Execution.');
+};
+
+export const ContinueAsNew = class ContinueAsNew {} as unknown as typeof ContinueAsNewT;
+
+export const AsyncLocalStorage = class AsyncLocalStorage {} as unknown as typeof AsyncLocalStorageT;
+
+export const getActivator: typeof getActivatorT = () => {
+  throw new IllegalStateError('Workflow uninitialized');
+};
+
+export const proxySinks: typeof proxySinksT = () => {
+  throw new IllegalStateError('Proxied sinks functions may only be used from a Workflow Execution.');
+};
+
+export const SdkFlags: typeof SdkFlagsT = {} as typeof SdkFlagsT;

package/src/workflow-interceptors.ts

@@ -0,0 +1,14 @@
+/** Not a workflow, just interceptors */
+
+import type { WorkflowInterceptors } from '@temporalio/workflow';
+import {
+  OpenTelemetryInboundInterceptor,
+  OpenTelemetryOutboundInterceptor,
+  OpenTelemetryInternalsInterceptor,
+} from './workflow';
+
+export const interceptors = (): WorkflowInterceptors => ({
+  inbound: [new OpenTelemetryInboundInterceptor()],
+  outbound: [new OpenTelemetryOutboundInterceptor()],
+  internals: [new OpenTelemetryInternalsInterceptor()],
+});

package/lib/workflow/workflow-module-loader.d.ts

@@ -1,28 +0,0 @@
-/**
- * Utilities for working with a possibly missing `@temporalio/workflow` peer dependency
- * @module
- */
-import type * as WorkflowModule from '@temporalio/workflow';
-import type { SdkFlags as SdkFlagsT } from '@temporalio/workflow/lib/flags';
-type SdkFlags = typeof SdkFlagsT;
-/**
- * Returns `@temporalio/workflow` module if present.
- * Throws if the module failed to load
- */
-export declare function getWorkflowModule(): typeof WorkflowModule;
-/**
- * Returns if an SDK flag was set
- *
- * Expects to be called only after `ensureWorkflowModuleLoaded`.
- * Will throw if `@temporalio/workflow` is not available
- */
-export declare function hasSdkFlag(flag: keyof SdkFlags): boolean;
-/**
- * Checks if the workflow module loaded successfully and throws if not.
- */
-export declare function ensureWorkflowModuleLoaded(): void;
-/**
- * Returns the workflow module if available, or undefined if it failed to load.
- */
-export declare function getWorkflowModuleIfAvailable(): typeof WorkflowModule | undefined;
-export {};

package/lib/workflow/workflow-module-loader.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWorkflowModule = getWorkflowModule;
-exports.hasSdkFlag = hasSdkFlag;
-exports.ensureWorkflowModuleLoaded = ensureWorkflowModuleLoaded;
-exports.getWorkflowModuleIfAvailable = getWorkflowModuleIfAvailable;
-// @temporalio/workflow is an optional peer dependency.
-// It can be missing as long as the user isn't attempting to construct a workflow interceptor.
-// If we start shipping ES modules alongside CJS, we will have to reconsider
-// this dynamic import as `import` is async for ES modules.
-let workflowModule;
-let workflowModuleLoadError;
-try {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    workflowModule = require('@temporalio/workflow');
-}
-catch (err) {
-    // Capture the module not found error to rethrow if the module is required
-    workflowModuleLoadError = err;
-}
-/**
- * Returns `@temporalio/workflow` module if present.
- * Throws if the module failed to load
- */
-function getWorkflowModule() {
-    if (workflowModuleLoadError) {
-        throw workflowModuleLoadError;
-    }
-    return workflowModule;
-}
-/**
- * Returns if an SDK flag was set
- *
- * Expects to be called only after `ensureWorkflowModuleLoaded`.
- * Will throw if `@temporalio/workflow` is not available
- */
-function hasSdkFlag(flag) {
-    const { SdkFlags } = require('@temporalio/workflow/lib/flags'); // eslint-disable-line @typescript-eslint/no-require-imports
-    const { getActivator } = require('@temporalio/workflow/lib/global-attributes'); // eslint-disable-line @typescript-eslint/no-require-imports
-    return getActivator().hasFlag(SdkFlags[flag]);
-}
-/**
- * Checks if the workflow module loaded successfully and throws if not.
- */
-function ensureWorkflowModuleLoaded() {
-    if (workflowModuleLoadError) {
-        throw workflowModuleLoadError;
-    }
-}
-/**
- * Returns the workflow module if available, or undefined if it failed to load.
- */
-function getWorkflowModuleIfAvailable() {
-    return workflowModule;
-}
-//# sourceMappingURL=workflow-module-loader.js.map

package/lib/workflow/workflow-module-loader.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workflow-module-loader.js","sourceRoot":"","sources":["../../src/workflow/workflow-module-loader.ts"],"names":[],"mappings":";;AA4BA,8CAKC;AAQD,gCAMC;AAKD,gEAIC;AAKD,oEAEC;AAtDD,uDAAuD;AACvD,8FAA8F;AAC9F,4EAA4E;AAC5E,2DAA2D;AAC3D,IAAI,cAAiD,CAAC;AACtD,IAAI,uBAAwC,CAAC;AAE7C,IAAI,CAAC;IACH,iEAAiE;IACjE,cAAc,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;AACnD,CAAC;AAAC,OAAO,GAAG,EAAE,CAAC;IACb,0EAA0E;IAC1E,uBAAuB,GAAG,GAAG,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB;IAC/B,IAAI,uBAAuB,EAAE,CAAC;QAC5B,MAAM,uBAAuB,CAAC;IAChC,CAAC;IACD,OAAO,cAAe,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,IAAoB;IAC7C,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,gCAAgC,CAAoD,CAAC,CAAC,4DAA4D;IAC/K,MAAM,EAAE,YAAY,EAAE,GACpB,OAAO,CAAC,4CAA4C,CAAgE,CAAC,CAAC,4DAA4D;IAEpL,OAAO,YAAY,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AAChD,CAAC;AAED;;GAEG;AACH,SAAgB,0BAA0B;IACxC,IAAI,uBAAuB,EAAE,CAAC;QAC5B,MAAM,uBAAuB,CAAC;IAChC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,4BAA4B;IAC1C,OAAO,cAAc,CAAC;AACxB,CAAC"}

package/src/workflow/workflow-module-loader.ts

@@ -1,64 +0,0 @@
-/**
- * Utilities for working with a possibly missing `@temporalio/workflow` peer dependency
- * @module
- */
-import type * as WorkflowModule from '@temporalio/workflow';
-import type { SdkFlags as SdkFlagsT } from '@temporalio/workflow/lib/flags';
-
-type SdkFlags = typeof SdkFlagsT;
-
-// @temporalio/workflow is an optional peer dependency.
-// It can be missing as long as the user isn't attempting to construct a workflow interceptor.
-// If we start shipping ES modules alongside CJS, we will have to reconsider
-// this dynamic import as `import` is async for ES modules.
-let workflowModule: typeof WorkflowModule | undefined;
-let workflowModuleLoadError: any | undefined;
-
-try {
-  // eslint-disable-next-line @typescript-eslint/no-require-imports
-  workflowModule = require('@temporalio/workflow');
-} catch (err) {
-  // Capture the module not found error to rethrow if the module is required
-  workflowModuleLoadError = err;
-}
-
-/**
- * Returns `@temporalio/workflow` module if present.
- * Throws if the module failed to load
- */
-export function getWorkflowModule(): typeof WorkflowModule {
-  if (workflowModuleLoadError) {
-    throw workflowModuleLoadError;
-  }
-  return workflowModule!;
-}
-
-/**
- * Returns if an SDK flag was set
- *
- * Expects to be called only after `ensureWorkflowModuleLoaded`.
- * Will throw if `@temporalio/workflow` is not available
- */
-export function hasSdkFlag(flag: keyof SdkFlags): boolean {
-  const { SdkFlags } = require('@temporalio/workflow/lib/flags') as typeof import('@temporalio/workflow/lib/flags'); // eslint-disable-line @typescript-eslint/no-require-imports
-  const { getActivator } =
-    require('@temporalio/workflow/lib/global-attributes') as typeof import('@temporalio/workflow/lib/global-attributes'); // eslint-disable-line @typescript-eslint/no-require-imports
-
-  return getActivator().hasFlag(SdkFlags[flag]);
-}
-
-/**
- * Checks if the workflow module loaded successfully and throws if not.
- */
-export function ensureWorkflowModuleLoaded(): void {
-  if (workflowModuleLoadError) {
-    throw workflowModuleLoadError;
-  }
-}
-
-/**
- * Returns the workflow module if available, or undefined if it failed to load.
- */
-export function getWorkflowModuleIfAvailable(): typeof WorkflowModule | undefined {
-  return workflowModule;
-}