Update stack trace interfaces to match new protos (#1454)

Author: twin-drill

packages/test/src/integration-tests-old.ts

@@ -1343,8 +1343,8 @@ export function runIntegrationTests(codec?: PayloadCodec): void {
       const stacks = enhancedStack.stacks.map((s) => ({
         locations: s.locations.map((l) => ({
           ...l,
-          ...(l.filePath
-            ? { filePath: l.filePath.replace(path.resolve(__dirname, '../../../'), '').replace(/\\/g, '/') }
+          ...(l.file_path
+            ? { file_path: l.file_path.replace(path.resolve(__dirname, '../../../'), '').replace(/\\/g, '/') }
             : undefined),
         })),
       }));
@@ -1354,43 +1354,48 @@ export function runIntegrationTests(codec?: PayloadCodec): void {
         {
           locations: [
             {
-              functionName: 'Function.all',
+              function_name: 'Function.all',
+              internal_code: false,
             },
             {
-              filePath: '/packages/test/src/workflows/stack-tracer.ts',
-              functionName: 'enhancedStackTracer',
+              file_path: '/packages/test/src/workflows/stack-tracer.ts',
+              function_name: 'enhancedStackTracer',
               line: 32,
               column: 35,
+              internal_code: false,
             },
           ],
         },
         {
           locations: [
             {
-              filePath: '/packages/test/src/workflows/stack-tracer.ts',
-              functionName: 'enhancedStackTracer',
+              file_path: '/packages/test/src/workflows/stack-tracer.ts',
+              function_name: 'enhancedStackTracer',
               line: 32,
               column: 35,
+              internal_code: false,
             },
           ],
         },
         {
           locations: [
             {
-              functionName: 'Promise.then',
+              function_name: 'Promise.then',
+              internal_code: false,
             },
             {
-              filePath: '/packages/workflow/src/trigger.ts',
-              functionName: 'Trigger.then',
+              file_path: '/packages/workflow/src/trigger.ts',
+              function_name: 'Trigger.then',
               line: 47,
               column: 24,
+              internal_code: false,
             },
           ],
         },
       ]);
       const expectedSources = ['../src/workflows/stack-tracer.ts', '../../workflow/src/trigger.ts'].map((p) => [
         path.resolve(__dirname, p),
-        [{ content: readFileSync(path.resolve(__dirname, p), 'utf8'), lineOffset: 0 }],
+        [{ content: readFileSync(path.resolve(__dirname, p), 'utf8'), line_offset: 0 }],
       ]);
       t.deepEqual(Object.entries(enhancedStack.sources), expectedSources);
     });

packages/worker/src/workflow/vm-shared.ts

@@ -3,7 +3,7 @@ import vm from 'node:vm';
 import { SourceMapConsumer } from 'source-map';
 import { cutoffStackTrace, IllegalStateError } from '@temporalio/common';
 import { coresdk } from '@temporalio/proto';
-import type { WorkflowInfo, FileLocation } from '@temporalio/workflow';
+import type { WorkflowInfo, StackTraceFileLocation } from '@temporalio/workflow';
 import { type SinkCall } from '@temporalio/workflow/lib/sinks';
 import * as internals from '@temporalio/workflow/lib/worker-interface';
 import { Activator } from '@temporalio/workflow/lib/internals';
@@ -36,18 +36,18 @@ export function setUnhandledRejectionHandler(getWorkflowByRunId: (runId: string)
 /**
  * Variant of {@link cutoffStackTrace} that works with FileLocation, keep this in sync with the original implementation
  */
-function cutoffStructuredStackTrace(stackTrace: FileLocation[]): void {
+function cutoffStructuredStackTrace(stackTrace: StackTraceFileLocation[]): void {
   stackTrace.shift();
-  if (stackTrace[0].functionName === 'initAll' && stackTrace[0].filePath === 'node:internal/promise_hooks') {
+  if (stackTrace[0].function_name === 'initAll' && stackTrace[0].file_path === 'node:internal/promise_hooks') {
     stackTrace.shift();
   }
-  const idx = stackTrace.findIndex(({ functionName, filePath }) => {
+  const idx = stackTrace.findIndex(({ function_name, file_path }) => {
     return (
-      functionName &&
-      filePath &&
-      ((/^Activator\.\S+NextHandler$/.test(functionName) &&
-        /.*[\\/]workflow[\\/](?:src|lib)[\\/]internals\.[jt]s$/.test(filePath)) ||
-        (/Script\.runInContext/.test(functionName) && /^node:vm|vm\.js$/.test(filePath)))
+      function_name &&
+      file_path &&
+      ((/^Activator\.\S+NextHandler$/.test(function_name) &&
+        /.*[\\/]workflow[\\/](?:src|lib)[\\/]internals\.[jt]s$/.test(file_path)) ||
+        (/Script\.runInContext/.test(function_name) && /^node:vm|vm\.js$/.test(file_path)))
     );
   });
   if (idx > -1) {
@@ -98,7 +98,7 @@ export function injectConsole(context: vm.Context): void {
  * Global handlers for overriding stack trace preparation and promise hooks
  */
 export class GlobalHandlers {
-  currentStackTrace: FileLocation[] | undefined = undefined;
+  currentStackTrace: StackTraceFileLocation[] | undefined = undefined;
   bundleFilenameToSourceMapConsumer = new Map<string, SourceMapConsumer>();
   origPrepareStackTrace = Error.prepareStackTrace;
   private stopPromiseHook = () => {
@@ -163,10 +163,11 @@ export class GlobalHandlers {
 
           const name = pos.name || formatCallsiteName(callsite);
           this.currentStackTrace?.push({
-            filePath: pos.source ?? undefined,
-            functionName: name ?? undefined,
+            file_path: pos.source ?? undefined,
+            function_name: name ?? undefined,
             line: pos.line ?? undefined,
             column: pos.column ?? undefined,
+            internal_code: false,
           });
 
           return name
@@ -176,10 +177,11 @@ export class GlobalHandlers {
           const name = formatCallsiteName(callsite);
 
           this.currentStackTrace?.push({
-            filePath: filename ?? undefined,
-            functionName: name ?? undefined,
+            file_path: filename ?? undefined,
+            function_name: name ?? undefined,
             line: line ?? undefined,
             column: column ?? undefined,
+            internal_code: false,
           });
           return `    at ${callsite}`;
         }
@@ -219,7 +221,7 @@ export class GlobalHandlers {
           if (this.currentStackTrace === undefined) {
             return;
           }
-          const structured = this.currentStackTrace as FileLocation[];
+          const structured = this.currentStackTrace as StackTraceFileLocation[];
           cutoffStructuredStackTrace(structured);
           let stackTrace = { formatted, structured };
 

packages/workflow/src/index.ts

@@ -92,11 +92,11 @@ export {
   ContinueAsNew,
   ContinueAsNewOptions,
   EnhancedStackTrace,
-  FileLocation,
-  FileSlice,
+  StackTraceFileLocation,
+  StackTraceFileSlice,
   ParentClosePolicy,
   ParentWorkflowInfo,
-  SDKInfo,
+  StackTraceSDKInfo,
   StackTrace,
   UnsafeWorkflowInfo,
   WorkflowInfo,

packages/workflow/src/interfaces.ts

@@ -382,34 +382,34 @@ export type RequiredChildWorkflowOptions = Required<Pick<ChildWorkflowOptions, '
 
 export type ChildWorkflowOptionsWithDefaults = ChildWorkflowOptions & RequiredChildWorkflowOptions;
 
-export interface SDKInfo {
+export interface StackTraceSDKInfo {
   name: string;
   version: string;
 }
 
 /**
  * Represents a slice of a file starting at lineOffset
  */
-export interface FileSlice {
+export interface StackTraceFileSlice {
   /**
-   * slice of a file with `\n` (newline) line terminator.
+   * Only used possible to trim the file without breaking syntax highlighting.
    */
-  content: string;
+  line_offset: number;
   /**
-   * Only used possible to trim the file without breaking syntax highlighting.
+   * slice of a file with `\n` (newline) line terminator.
    */
-  lineOffset: number;
+  content: string;
 }
 
 /**
  * A pointer to a location in a file
  */
-export interface FileLocation {
+export interface StackTraceFileLocation {
   /**
    * Path to source file (absolute or relative).
    * When using a relative path, make sure all paths are relative to the same root.
    */
-  filePath?: string;
+  file_path?: string;
   /**
    * If possible, SDK should send this, required for displaying the code location.
    */
@@ -422,24 +422,28 @@ export interface FileLocation {
    * Function name this line belongs to (if applicable).
    * Used for falling back to stack trace view.
    */
-  functionName?: string;
+  function_name?: string;
+  /**
+   * Flag to mark this as internal SDK code and hide by default in the UI.
+   */
+  internal_code: boolean;
 }
 
 export interface StackTrace {
-  locations: FileLocation[];
+  locations: StackTraceFileLocation[];
 }
 
 /**
  * Used as the result for the enhanced stack trace query
  */
 export interface EnhancedStackTrace {
-  sdk: SDKInfo;
+  sdk: StackTraceSDKInfo;
   /**
    * Mapping of file path to file contents.
    * SDK may choose to send no, some or all sources.
    * Sources might be trimmed, and some time only the file(s) of the top element of the trace will be sent.
    */
-  sources: Record<string, FileSlice[]>;
+  sources: Record<string, StackTraceFileSlice[]>;
   stacks: StackTrace[];
 }
 

packages/workflow/src/internals.ts

@@ -27,10 +27,10 @@ import { QueryInput, SignalInput, UpdateInput, WorkflowExecuteInput, WorkflowInt
 import {
   ContinueAsNew,
   DefaultSignalHandler,
-  SDKInfo,
-  FileSlice,
+  StackTraceSDKInfo,
+  StackTraceFileSlice,
   EnhancedStackTrace,
-  FileLocation,
+  StackTraceFileLocation,
   WorkflowInfo,
   WorkflowCreateOptionsInternal,
 } from './interfaces';
@@ -49,7 +49,7 @@ checkExtends<StartChildWorkflowExecutionFailedCause, coresdk.child_workflow.Star
 
 export interface Stack {
   formatted: string;
-  structured: FileLocation[];
+  structured: StackTraceFileLocation[];
 }
 
 /**
@@ -176,19 +176,19 @@ export class Activator implements ActivationHandler {
       {
         handler: (): EnhancedStackTrace => {
           const { sourceMap } = this;
-          const sdk: SDKInfo = { name: 'typescript', version: pkg.version };
+          const sdk: StackTraceSDKInfo = { name: 'typescript', version: pkg.version };
           const stacks = this.getStackTraces().map(({ structured: locations }) => ({ locations }));
-          const sources: Record<string, FileSlice[]> = {};
+          const sources: Record<string, StackTraceFileSlice[]> = {};
           if (this.showStackTraceSources) {
             for (const { locations } of stacks) {
-              for (const { filePath } of locations) {
-                if (!filePath) continue;
-                const content = sourceMap?.sourcesContent?.[sourceMap?.sources.indexOf(filePath)];
+              for (const { file_path } of locations) {
+                if (!file_path) continue;
+                const content = sourceMap?.sourcesContent?.[sourceMap?.sources.indexOf(file_path)];
                 if (!content) continue;
-                sources[filePath] = [
+                sources[file_path] = [
                   {
+                    line_offset: 0,
                     content,
-                    lineOffset: 0,
                   },
                 ];
               }