refactor sdk access with runtime workflow access

Author: chris-olszewski

packages/interceptors-opentelemetry/src/workflow/index.ts

@@ -22,7 +22,7 @@ import { instrument, extractContextFromHeaders, headersWithContext } from '../in
 import { ContextManager } from './context-manager';
 import { SpanName, SPAN_DELIMITER } from './definitions';
 import { SpanExporter } from './span-exporter';
-import { ensureWorkflowModuleLoaded, getSdkFlagsChecking, getWorkflowModule } from './workflow-module-loader';
+import { ensureWorkflowModuleLoaded, getWorkflowModule, hasSdkFlag } from './workflow-module-loader';
 
 export * from './definitions';
 
@@ -63,8 +63,7 @@ export class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInte
     next: Next<WorkflowInboundCallsInterceptor, 'execute'>
   ): Promise<unknown> {
     const { workflowInfo, ContinueAsNew } = getWorkflowModule();
-    const { getActivator, SdkFlags } = getSdkFlagsChecking();
-    const shouldInjectYield = getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorInsertYield);
+    const shouldInjectYield = hasSdkFlag('OpenTelemetryInterceptorInsertYield');
     const context = extractContextFromHeaders(input.headers);
     if (shouldInjectYield) await Promise.resolve();
     return await instrument({
@@ -80,8 +79,7 @@ export class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInte
     input: SignalInput,
     next: Next<WorkflowInboundCallsInterceptor, 'handleSignal'>
   ): Promise<void> {
-    const { getActivator, SdkFlags } = getSdkFlagsChecking();
-    const shouldInjectYield = getActivator().hasFlag(SdkFlags.OpenTelemetryHandleSignalInterceptorInsertYield);
+    const shouldInjectYield = hasSdkFlag('OpenTelemetryHandleSignalInterceptorInsertYield');
     const context = extractContextFromHeaders(input.headers);
     if (shouldInjectYield) await Promise.resolve();
     return await instrument({
@@ -111,8 +109,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
     input: ActivityInput,
     next: Next<WorkflowOutboundCallsInterceptor, 'scheduleActivity'>
   ): Promise<unknown> {
-    const { getActivator, SdkFlags } = getSdkFlagsChecking();
-    const shouldInjectYield = getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorInsertYield);
+    const shouldInjectYield = hasSdkFlag('OpenTelemetryInterceptorInsertYield');
     return await instrument({
       tracer: this.tracer,
       spanName: `${SpanName.ACTIVITY_START}${SPAN_DELIMITER}${input.activityType}`,
@@ -131,8 +128,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
     input: LocalActivityInput,
     next: Next<WorkflowOutboundCallsInterceptor, 'scheduleLocalActivity'>
   ): Promise<unknown> {
-    const { getActivator, SdkFlags } = getSdkFlagsChecking();
-    const shouldInjectYield = getActivator().hasFlag(SdkFlags.OpenTelemetryScheduleLocalActivityInterceptorInsertYield);
+    const shouldInjectYield = hasSdkFlag('OpenTelemetryScheduleLocalActivityInterceptorInsertYield');
     return await instrument({
       tracer: this.tracer,
       spanName: `${SpanName.ACTIVITY_START}${SPAN_DELIMITER}${input.activityType}`,
@@ -151,8 +147,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
     input: StartChildWorkflowExecutionInput,
     next: Next<WorkflowOutboundCallsInterceptor, 'startChildWorkflowExecution'>
   ): Promise<[Promise<string>, Promise<unknown>]> {
-    const { getActivator, SdkFlags } = getSdkFlagsChecking();
-    const shouldInjectYield = getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorInsertYield);
+    const shouldInjectYield = hasSdkFlag('OpenTelemetryInterceptorInsertYield');
     return await instrument({
       tracer: this.tracer,
       spanName: `${SpanName.CHILD_WORKFLOW_START}${SPAN_DELIMITER}${input.workflowType}`,
@@ -172,8 +167,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
     next: Next<WorkflowOutboundCallsInterceptor, 'continueAsNew'>
   ): Promise<never> {
     const { ContinueAsNew } = getWorkflowModule();
-    const { getActivator, SdkFlags } = getSdkFlagsChecking();
-    const shouldInjectYield = getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorInsertYield);
+    const shouldInjectYield = hasSdkFlag('OpenTelemetryInterceptorInsertYield');
     return await instrument({
       tracer: this.tracer,
       spanName: `${SpanName.CONTINUE_AS_NEW}${SPAN_DELIMITER}${input.options.workflowType}`,
@@ -193,8 +187,7 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
     input: SignalWorkflowInput,
     next: Next<WorkflowOutboundCallsInterceptor, 'signalWorkflow'>
   ): Promise<void> {
-    const { getActivator, SdkFlags } = getSdkFlagsChecking();
-    const shouldInjectYield = getActivator().hasFlag(SdkFlags.OpenTelemetryInterceptorInsertYield);
+    const shouldInjectYield = hasSdkFlag('OpenTelemetryInterceptorInsertYield');
     return await instrument({
       tracer: this.tracer,
       spanName: `${SpanName.WORKFLOW_SIGNAL}${SPAN_DELIMITER}${input.signalName}`,

packages/interceptors-opentelemetry/src/workflow/workflow-module-loader.ts

@@ -4,7 +4,8 @@
  */
 import type * as WorkflowModule from '@temporalio/workflow';
 import type { SdkFlags as SdkFlagsT } from '@temporalio/workflow/lib/flags';
-import type { getActivator as getActivatorT } from '@temporalio/workflow/lib/global-attributes';
+
+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.
@@ -32,10 +33,17 @@ export function getWorkflowModule(): typeof WorkflowModule {
   return workflowModule!;
 }
 
-export function getSdkFlagsChecking(): { getActivator: typeof getActivatorT; SdkFlags: typeof SdkFlagsT } {
+/**
+ * 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');
   const { getActivator } = require('@temporalio/workflow/lib/global-attributes');
-  return { getActivator, SdkFlags };
+
+  return getActivator().hasFlag(SdkFlags[flag]);
 }
 
 /**