move sink check, change constant var name

Author: THardy98

packages/common/src/reserved.ts

@@ -1,6 +1,6 @@
 export const TEMPORAL_RESERVED_PREFIX = '__temporal_';
-export const STACK_TRACE_RESERVED_NAME = '__stack_trace';
-export const ENHANCED_STACK_TRACE_RESERVED_NAME = '__enhanced_stack_trace';
+export const STACK_TRACE_QUERY_NAME = '__stack_trace';
+export const ENHANCED_STACK_TRACE_QUERY_NAME = '__enhanced_stack_trace';
 
 /**
  * Valid entity types that can be checked for reserved name violations
@@ -20,7 +20,7 @@ export function throwIfReservedName(type: ReservedNameEntityType, name: string):
     throw new TypeError(`Cannot use ${type} name: '${name}', with reserved prefix: '${TEMPORAL_RESERVED_PREFIX}'`);
   }
 
-  if (name === STACK_TRACE_RESERVED_NAME || name === ENHANCED_STACK_TRACE_RESERVED_NAME) {
+  if (name === STACK_TRACE_QUERY_NAME || name === ENHANCED_STACK_TRACE_QUERY_NAME) {
     throw new TypeError(`Cannot use ${type} name: '${name}', which is a reserved name`);
   }
 }

packages/test/src/test-integration-workflows.ts

@@ -32,8 +32,8 @@ import {
 } from '@temporalio/common';
 import {
   TEMPORAL_RESERVED_PREFIX,
-  STACK_TRACE_RESERVED_NAME,
-  ENHANCED_STACK_TRACE_RESERVED_NAME,
+  STACK_TRACE_QUERY_NAME,
+  ENHANCED_STACK_TRACE_QUERY_NAME,
 } from '@temporalio/common/lib/reserved';
 import { signalSchedulingWorkflow } from './activities/helpers';
 import { activityStartedSignal } from './workflows/definitions';
@@ -1456,7 +1456,7 @@ test('Workflow can return root workflow', async (t) => {
   });
 });
 
-const reservedNames = [TEMPORAL_RESERVED_PREFIX, STACK_TRACE_RESERVED_NAME, ENHANCED_STACK_TRACE_RESERVED_NAME];
+const reservedNames = [TEMPORAL_RESERVED_PREFIX, STACK_TRACE_QUERY_NAME, ENHANCED_STACK_TRACE_QUERY_NAME];
 
 test('Cannot register activities using reserved prefixes', async (t) => {
   const { createWorker } = helpers(t);

packages/worker/src/worker-options.ts

@@ -932,6 +932,16 @@ export function compileWorkerOptions(
   logger: Logger,
   metricMeter: MetricMeter
 ): CompiledWorkerOptions {
+  // Validate sink names to ensure they don't use reserved prefixes/names
+  if (rawOpts.sinks) {
+    for (const sinkName of Object.keys(rawOpts.sinks)) {
+      // Allow internal sinks used by the SDK
+      if (sinkName !== '__temporal_logger' && sinkName !== '__temporal_metrics') {
+        throwIfReservedName('sink', sinkName);
+      }
+    }
+  }
+
   const opts = addDefaultWorkerOptions(rawOpts, logger, metricMeter);
   if (opts.maxCachedWorkflows !== 0 && opts.maxCachedWorkflows < 2) {
     logger.warn('maxCachedWorkflows must be either 0 (ie. cache is disabled) or greater than 1. Defaulting to 2.');
@@ -958,16 +968,6 @@ export function compileWorkerOptions(
     throwIfReservedName('activity', activityName);
   }
 
-  // Validate sink names to ensure they don't use reserved prefixes/names
-  if (opts.sinks) {
-    for (const sinkName of Object.keys(opts.sinks)) {
-      // Allow internal sinks used by the SDK
-      if (sinkName !== '__temporal_logger' && sinkName !== '__temporal_metrics') {
-        throwIfReservedName('sink', sinkName);
-      }
-    }
-  }
-
   const tuner = asNativeTuner(opts.tuner, logger);
 
   return {

packages/workflow/src/internals.ts

@@ -34,8 +34,8 @@ import { makeProtoEnumConverters } from '@temporalio/common/lib/internal-workflo
 import type { coresdk, temporal } from '@temporalio/proto';
 import {
   TEMPORAL_RESERVED_PREFIX,
-  STACK_TRACE_RESERVED_NAME,
-  ENHANCED_STACK_TRACE_RESERVED_NAME,
+  STACK_TRACE_QUERY_NAME,
+  ENHANCED_STACK_TRACE_QUERY_NAME,
 } from '@temporalio/common/lib/reserved';
 import { alea, RNG } from './alea';
 import { RootCancellationScope } from './cancellation-scope';
@@ -266,7 +266,7 @@ export class Activator implements ActivationHandler {
    */
   public readonly queryHandlers = new Map<string, WorkflowQueryAnnotatedType>([
     [
-      STACK_TRACE_RESERVED_NAME,
+      STACK_TRACE_QUERY_NAME,
       {
         handler: () => {
           return new RawValue<string>(
@@ -279,7 +279,7 @@ export class Activator implements ActivationHandler {
       },
     ],
     [
-      ENHANCED_STACK_TRACE_RESERVED_NAME,
+      ENHANCED_STACK_TRACE_QUERY_NAME,
       {
         handler: (): RawValue => {
           const { sourceMap } = this;
@@ -695,8 +695,8 @@ export class Activator implements ActivationHandler {
     // Skip interceptors if it's an internal query.
     const isInternalQuery =
       queryType.startsWith(TEMPORAL_RESERVED_PREFIX) ||
-      queryType === STACK_TRACE_RESERVED_NAME ||
-      queryType === ENHANCED_STACK_TRACE_RESERVED_NAME;
+      queryType === STACK_TRACE_QUERY_NAME ||
+      queryType === ENHANCED_STACK_TRACE_QUERY_NAME;
     const interceptors = isInternalQuery ? [] : this.interceptors.inbound;
     const execute = composeInterceptors(interceptors, 'handleQuery', this.queryWorkflowNextHandler.bind(this));
     execute({
@@ -730,8 +730,8 @@ export class Activator implements ActivationHandler {
     // Skip interceptors if it's an internal update.
     const isInternalUpdate =
       name.startsWith(TEMPORAL_RESERVED_PREFIX) ||
-      name === STACK_TRACE_RESERVED_NAME ||
-      name === ENHANCED_STACK_TRACE_RESERVED_NAME;
+      name === STACK_TRACE_QUERY_NAME ||
+      name === ENHANCED_STACK_TRACE_QUERY_NAME;
     const interceptors = isInternalUpdate ? [] : this.interceptors.inbound;
 
     const entry =
@@ -896,8 +896,8 @@ export class Activator implements ActivationHandler {
     // Skip interceptors if it's an internal signal.
     const isInternalSignal =
       signalName.startsWith(TEMPORAL_RESERVED_PREFIX) ||
-      signalName === STACK_TRACE_RESERVED_NAME ||
-      signalName === ENHANCED_STACK_TRACE_RESERVED_NAME;
+      signalName === STACK_TRACE_QUERY_NAME ||
+      signalName === ENHANCED_STACK_TRACE_QUERY_NAME;
     const interceptors = isInternalSignal ? [] : this.interceptors.inbound;
 
     if (!this.signalHandlers.has(signalName) && !this.defaultSignalHandler) {