@pikku/inspector 0.12.35 → 0.12.37

package/src/add/function-body-span.test.ts

@@ -0,0 +1,96 @@
+import { strict as assert } from 'assert'
+import { describe, test } from 'node:test'
+import { mkdtemp, rm, writeFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+import { inspect } from '../inspector.js'
+import type { InspectorLogger } from '../types.js'
+
+const logger: InspectorLogger = {
+  debug: () => {},
+  info: () => {},
+  warn: () => {},
+  error: () => {},
+  diagnostic: () => {},
+  critical: () => {},
+  hasCriticalErrors: () => false,
+}
+
+describe('function body spans in meta', () => {
+  test('meta records 1-indexed bodyStart/bodyEnd lines of the handler body', async () => {
+    const rootDir = await mkdtemp(join(tmpdir(), 'pikku-span-'))
+    const file = join(rootDir, 'my.function.ts')
+    await writeFile(
+      file,
+      [
+        "import { pikkuSessionlessFunc } from '@pikku/core'", // line 1
+        '', // 2
+        'export const spanProbe = pikkuSessionlessFunc({', // 3
+        '  func: async ({ logger }, data: { n: number }) => {', // 4
+        '    const doubled = data.n * 2', // 5
+        '    return { doubled }', // 6
+        '  },', // 7
+        '})', // 8
+      ].join('\n')
+    )
+    try {
+      const state = await inspect(logger, [file], { rootDir })
+      const meta = (state.functions.meta as any).spanProbe
+      assert.ok(meta, 'spanProbe should be inspected')
+      assert.equal(
+        meta.bodyStart,
+        5,
+        `bodyStart should be 5, got ${meta.bodyStart}`
+      )
+      assert.equal(meta.bodyEnd, 6, `bodyEnd should be 6, got ${meta.bodyEnd}`)
+    } finally {
+      await rm(rootDir, { recursive: true, force: true })
+    }
+  })
+
+  test('meta records bodySourceFile when the handler is imported from another file', async () => {
+    const rootDir = await mkdtemp(join(tmpdir(), 'pikku-span-'))
+    const handlerFile = join(rootDir, 'handlers.ts')
+    const wiringFile = join(rootDir, 'my.function.ts')
+    await writeFile(
+      handlerFile,
+      [
+        'export const importedHandler = async (', // line 1
+        '  { logger }: any,', // 2
+        '  data: { n: number }', // 3
+        ') => {', // 4
+        '  const doubled = data.n * 2', // 5
+        '  return { doubled }', // 6
+        '}', // 7
+      ].join('\n')
+    )
+    await writeFile(
+      wiringFile,
+      [
+        "import { pikkuSessionlessFunc } from '@pikku/core'",
+        "import { importedHandler } from './handlers.js'",
+        '',
+        'export const importedProbe = pikkuSessionlessFunc({',
+        '  func: importedHandler,',
+        '})',
+      ].join('\n')
+    )
+    try {
+      const state = await inspect(logger, [wiringFile, handlerFile], {
+        rootDir,
+      })
+      const meta = (state.functions.meta as any).importedProbe
+      assert.ok(meta, 'importedProbe should be inspected')
+      assert.equal(meta.sourceFile, wiringFile)
+      assert.equal(
+        meta.bodySourceFile,
+        handlerFile,
+        `bodySourceFile should be the handler file, got ${meta.bodySourceFile}`
+      )
+      assert.equal(meta.bodyStart, 5)
+      assert.equal(meta.bodyEnd, 6)
+    } finally {
+      await rm(rootDir, { recursive: true, force: true })
+    }
+  })
+})

package/src/error-codes.ts

@@ -21,7 +21,8 @@ export enum ErrorCode {
   MISSING_QUEUE_NAME = 'PKU384',
   MISSING_CHANNEL_NAME = 'PKU400',
   CLI_CLIENTSIDE_RENDERER_HAS_SERVICES = 'PKU672',
-  USER_FLOW_HAS_SERVICES = 'PKU673',
+  SCENARIO_HAS_SERVICES = 'PKU673',
+  EXPECT_EVENTUALLY_SCENARIO_ONLY = 'PKU675',
   DYNAMIC_STEP_NAME = 'PKU529',
   WORKFLOW_ORCHESTRATOR_NOT_CONFIGURED = 'PKU600',
   INVALID_DSL_WORKFLOW = 'PKU641',

package/src/utils/workflow/dsl/patterns.ts

@@ -6,7 +6,7 @@ import * as ts from 'typescript'
 
 /**
  * Check if a call expression is workflow.do() or workflow.expectEventually()
- * (both are RPC steps; expectEventually is the polling variant used by user flows)
+ * (both are RPC steps; expectEventually is the polling variant used by scenarios)
  */
 export function isWorkflowDoCall(
   node: ts.CallExpression,

package/src/utils/workflow/graph/convert-dsl-to-graph.ts

@@ -396,11 +396,11 @@ export function convertDslToGraph(
   const entryNodeIds = nodes.length > 0 ? [nodes[0].nodeId] : []
 
   // Determine source type:
-  // - userFlow: complex workflow whose steps run as actors (user flow)
+  // - scenario: complex workflow whose steps run as actors (scenario)
   // - dsl === true: pure DSL workflow, can be serialized
   // - dsl === false: complex workflow with inline steps, not serializable
-  const source = meta.userFlow
-    ? 'user-flow'
+  const source = meta.scenario
+    ? 'scenario'
     : meta.dsl === false
       ? 'complex'
       : 'dsl'

package/src/utils/workflow/graph/workflow-graph.types.ts

@@ -142,9 +142,9 @@ export interface FunctionNode extends BaseNode {
   outputVar?: string
   /** Hash of nodeId + RPC input/output schemas for version detection */
   stepHash?: string
-  /** User-flow actor name this step runs as (workflow.do {actor: actors.x}) */
+  /** Scenario actor name this step runs as (workflow.do {actor: actors.x}) */
   actor?: string
-  /** True for workflow.expectEventually polling steps (user flows) */
+  /** True for workflow.expectEventually polling steps (scenarios) */
   expectEventually?: boolean
 }
 
@@ -181,9 +181,9 @@ export const isFlowNode = (node: SerializedGraphNode): node is FlowNode =>
  * - 'dsl': Pure DSL workflow (pikkuWorkflowFunc) - can be round-tripped to code
  * - 'complex': Complex workflow (pikkuWorkflowComplexFunc) - contains inline steps, not serializable
  * - 'graph': Graph-based workflow (pikkuWorkflowGraph)
- * - 'user-flow': User flow (pikkuUserFlow) - complex workflow whose steps run as actors
+ * - 'scenario': Scenario (pikkuScenario) - complex workflow whose steps run as actors
  */
-export type WorkflowSourceType = 'dsl' | 'complex' | 'graph' | 'user-flow'
+export type WorkflowSourceType = 'dsl' | 'complex' | 'graph' | 'scenario'
 
 /**
  * Serialized workflow graph - the canonical JSON format
@@ -201,7 +201,7 @@ export interface SerializedWorkflowGraph {
   description?: string
   /** Tags for organization */
   tags?: string[]
-  /** Actor names a user flow's steps run as */
+  /** Actor names a scenario's steps run as */
   actors?: string[]
   /** If true, workflow always executes inline without queues */
   inline?: boolean