@ontrails/testing 1.0.0-beta.13 → 1.0.0-beta.15

package/src/crosses.ts

@@ -10,10 +10,11 @@ import { describe, expect, test } from 'bun:test';
 import type {
   AnyTrail,
   CrossFn,
-  ProvisionOverrideMap,
+  ResourceOverrideMap,
   TrailContext,
 } from '@ontrails/core';
 import {
+  buildCrossValidationSchema,
   executeTrail,
   InternalError,
   Result,
@@ -26,7 +27,7 @@ import {
   assertFullMatch,
   assertSchemaMatch,
 } from './assertions.js';
-import { mergeProvisionOverrides, mergeTestContext } from './context.js';
+import { mergeResourceOverrides, mergeTestContext } from './context.js';
 import type { CrossScenario } from './types.js';
 
 // ---------------------------------------------------------------------------
@@ -38,21 +39,21 @@ interface CrossRecord {
   readonly input: unknown;
 }
 
-const collectDeclaredProvisions = (
+const collectDeclaredResources = (
   trailDef: AnyTrail,
   trailsMap: ReadonlyMap<string, AnyTrail> | undefined
-): AnyTrail['provisions'] => {
-  const seenProvisionIds = new Set<string>();
+): AnyTrail['resources'] => {
+  const seenResourceIds = new Set<string>();
   const seenTrailIds = new Set<string>();
-  const provisions: AnyTrail['provisions'][number][] = [];
+  const resources: AnyTrail['resources'][number][] = [];
 
   const collect = (candidate: AnyTrail): void => {
-    for (const declaredProvision of candidate.provisions) {
-      if (seenProvisionIds.has(declaredProvision.id)) {
+    for (const declaredResource of candidate.resources) {
+      if (seenResourceIds.has(declaredResource.id)) {
         continue;
       }
-      seenProvisionIds.add(declaredProvision.id);
-      provisions.push(declaredProvision);
+      seenResourceIds.add(declaredResource.id);
+      resources.push(declaredResource);
     }
   };
 
@@ -71,26 +72,26 @@ const collectDeclaredProvisions = (
   };
 
   visit(trailDef);
-  return provisions;
+  return resources;
 };
 
-const resolveCrossMockProvisions = async (
+const resolveCrossMockResources = async (
   trailDef: AnyTrail,
   trailsMap: ReadonlyMap<string, AnyTrail> | undefined
-): Promise<ProvisionOverrideMap> => {
-  const provisions: Record<string, unknown> = {};
+): Promise<ResourceOverrideMap> => {
+  const resources: Record<string, unknown> = {};
 
-  for (const declaredProvision of collectDeclaredProvisions(
+  for (const declaredResource of collectDeclaredResources(
     trailDef,
     trailsMap
   )) {
-    if (!declaredProvision.mock) {
+    if (!declaredResource.mock) {
       continue;
     }
-    provisions[declaredProvision.id] = await declaredProvision.mock();
+    resources[declaredResource.id] = await declaredResource.mock();
   }
 
-  return provisions;
+  return resources;
 };
 
 // ---------------------------------------------------------------------------
@@ -143,15 +144,12 @@ const tryInjectError = (
   return Result.err(new Error(errorName));
 };
 
-/**
- * Execute a trail from the map, validating input first.
- */
 const executeFromMap = (
   id: string,
   input: unknown,
   trailsMap: ReadonlyMap<string, AnyTrail> | undefined,
   ctx: TrailContext,
-  provisions: ProvisionOverrideMap | undefined,
+  resources: ResourceOverrideMap | undefined,
   cross?: CrossFn
 ): Result<unknown, Error> | Promise<Result<unknown, Error>> | undefined => {
   const trailDef = trailsMap?.get(id);
@@ -162,14 +160,36 @@ const executeFromMap = (
   const nestedCtx = cross ? { ...ctx, cross } : ctx;
   return executeTrail(trailDef, input, {
     ctx: nestedCtx,
-    provisions,
+    resources,
+    validationSchema: buildCrossValidationSchema(trailDef),
   });
 };
 
+/** Extract trail ID from either a trail object or a string. */
+const resolveCrossId = (idOrTrail: string | { readonly id: string }): string =>
+  typeof idOrTrail === 'string' ? idOrTrail : idOrTrail.id;
+
 // ---------------------------------------------------------------------------
 // Cross factory
 // ---------------------------------------------------------------------------
 
+/** Delegate to baseCross, executeFromMap, or fall back to Result.ok(). */
+const delegateCross = (
+  id: string,
+  input: unknown,
+  baseCross: CrossFn | undefined,
+  trailsMap: ReadonlyMap<string, AnyTrail> | undefined,
+  ctx: TrailContext,
+  resources: ResourceOverrideMap | undefined,
+  self: CrossFn
+): Promise<Result<unknown, Error>> => {
+  if (baseCross !== undefined) {
+    return baseCross(id, input);
+  }
+  const executed = executeFromMap(id, input, trailsMap, ctx, resources, self);
+  return Promise.resolve(executed ?? Result.ok());
+};
+
 /**
  * Build a recording cross function that optionally injects errors.
  */
@@ -179,37 +199,59 @@ const createRecordingCross = (
   trailsMap: ReadonlyMap<string, AnyTrail> | undefined,
   baseCross: CrossFn | undefined,
   ctx: TrailContext,
-  provisions: ProvisionOverrideMap | undefined
+  resources: ResourceOverrideMap | undefined
 ): CrossFn => {
   // The generic O on CrossFn is erased at runtime; the cast is safe
   // because callers narrow via isOk/isErr before accessing the value.
-  const cross = (id: string, input: unknown) => {
+  const invokeCross = async (
+    idOrTrail: string | { readonly id: string },
+    input: unknown,
+    self: CrossFn
+  ) => {
+    const id = resolveCrossId(idOrTrail);
     trace.push({ id, input });
 
     const injected = tryInjectError(id, scenario, trailsMap);
     if (injected !== undefined) {
-      return Promise.resolve(injected);
+      return injected;
     }
 
-    if (baseCross !== undefined) {
-      return baseCross(id, input);
-    }
-
-    const executed = executeFromMap(
+    return await delegateCross(
       id,
       input,
+      baseCross,
       trailsMap,
       ctx,
-      provisions,
-      cross as CrossFn
+      resources,
+      self
     );
-    if (executed !== undefined) {
-      return Promise.resolve(executed);
+  };
+
+  // Accepts either a trail object (typed cross), a string id (untyped),
+  // or a batch of `[target, input]` tuples.
+  const cross = async function cross(
+    idOrTrail:
+      | string
+      | { readonly id: string }
+      | readonly (readonly [string | { readonly id: string }, unknown])[],
+    input?: unknown
+  ) {
+    if (Array.isArray(idOrTrail)) {
+      return await Promise.all(
+        idOrTrail.map(([target, batchInput]) =>
+          invokeCross(target, batchInput, cross as CrossFn)
+        )
+      );
     }
 
-    return Promise.resolve(Result.ok());
-  };
-  return cross as CrossFn;
+    return await invokeCross(
+      idOrTrail as string | { readonly id: string },
+      input,
+      cross as CrossFn
+    );
+  } as CrossFn;
+
+  return cross;
 };
 
 // ---------------------------------------------------------------------------
@@ -280,7 +322,7 @@ const buildTestContext = (
   scenario: CrossScenario,
   ctx: Partial<TrailContext> | undefined,
   trailsMap: ReadonlyMap<string, AnyTrail> | undefined,
-  provisions: ProvisionOverrideMap | undefined
+  resources: ResourceOverrideMap | undefined
 ): { trace: CrossRecord[]; testCtx: TrailContext } => {
   const trace: CrossRecord[] = [];
   const baseCtx = mergeTestContext(ctx);
@@ -290,7 +332,7 @@ const buildTestContext = (
     trailsMap,
     baseCtx.cross,
     baseCtx,
-    provisions
+    resources
   );
   return { testCtx: { ...baseCtx, cross }, trace };
 };
@@ -300,7 +342,7 @@ const runScenario = async (
   scenario: CrossScenario,
   ctx: Partial<TrailContext> | undefined,
   trailsMap: ReadonlyMap<string, AnyTrail> | undefined,
-  provisions: ProvisionOverrideMap | undefined
+  resources: ResourceOverrideMap | undefined
 ): Promise<void> => {
   const validated = validateInput(trailDef.input, scenario.input);
   if (handleValidationError(validated, scenario)) {
@@ -311,11 +353,11 @@ const runScenario = async (
     scenario,
     ctx,
     trailsMap,
-    provisions
+    resources
   );
   const result = await executeTrail(trailDef, scenario.input, {
     ctx: testCtx,
-    provisions,
+    resources,
   });
   assertCrossTrace(trace, scenario);
   assertScenarioResult(result, scenario, trailDef);
@@ -330,11 +372,11 @@ export interface TestCrossOptions {
   /** Partial context overrides. */
   readonly ctx?: Partial<TrailContext> | undefined;
   /**
-   * Explicit provision overrides merged on top of auto-resolved mocks for every
+   * Explicit resource overrides merged on top of auto-resolved mocks for every
    * scenario. Values are passed by reference — provide immutable objects, or
-   * use `mock()` on the provision definition to get a fresh instance per run.
+   * use `mock()` on the resource definition to get a fresh instance per run.
    */
-  readonly provisions?: ProvisionOverrideMap | undefined;
+  readonly resources?: ResourceOverrideMap | undefined;
   /** Map of trail ID to trail definition, used for injectFromExample. */
   readonly trails?: ReadonlyMap<string, AnyTrail> | undefined;
 }
@@ -359,23 +401,23 @@ export const testCrosses = (
   scenarios: readonly CrossScenario[],
   options?: TestCrossOptions
 ): void => {
-  const explicitProvisions = options?.provisions;
+  const explicitResources = options?.resources;
 
   describe(trailDef.id, () => {
     test.each([...scenarios])(
       '$description',
       async (scenario: CrossScenario) => {
-        const provisions = mergeProvisionOverrides(
-          await resolveCrossMockProvisions(trailDef, options?.trails),
+        const resources = mergeResourceOverrides(
+          await resolveCrossMockResources(trailDef, options?.trails),
           options?.ctx,
-          explicitProvisions
+          explicitResources
         );
         await runScenario(
           trailDef,
           scenario,
           options?.ctx,
           options?.trails,
-          provisions
+          resources
         );
       }
     );

package/src/detours.ts

@@ -1,42 +1,179 @@
 /**
- * testDetours — verify that all detour targets exist in the topo.
+ * testDetours — validate the live detour contract for every trail.
  *
- * Pure structural validation. No implementation execution needed.
+ * Pure structural validation. No blaze or detour recovery execution needed.
  */
 
-import { describe, expect, test } from 'bun:test';
+import { describe, test } from 'bun:test';
 
+import { TrailsError } from '@ontrails/core';
 import type { Topo, Trail } from '@ontrails/core';
 
-// ---------------------------------------------------------------------------
-// testDetours
-// ---------------------------------------------------------------------------
+interface RuntimeDetour {
+  readonly on?: unknown;
+  readonly recover?: unknown;
+}
+
+const isErrorConstructor = (
+  value: unknown
+): value is abstract new (...args: never[]) => Error => {
+  if (typeof value !== 'function') {
+    return false;
+  }
+
+  const { prototype } = value as { prototype?: unknown };
+  return prototype instanceof Error;
+};
+
+const detourLabel = (trailId: string, index: number, detour: RuntimeDetour) => {
+  if (typeof detour.on === 'function') {
+    const { name } = detour.on as { name?: unknown };
+    if (typeof name === 'string' && name.length > 0) {
+      return `${trailId} detour[${index}] on ${name}`;
+    }
+  }
+
+  return `${trailId} detour[${index}]`;
+};
+
+const assertValidOn = (
+  trailId: string,
+  index: number,
+  detour: RuntimeDetour
+): void => {
+  if (isErrorConstructor(detour.on)) {
+    return;
+  }
+
+  throw new Error(
+    `${detourLabel(trailId, index, detour)} must declare a real error constructor in on:`
+  );
+};
+
+const assertCallableRecover = (
+  trailId: string,
+  index: number,
+  detour: RuntimeDetour
+): void => {
+  if (typeof detour.recover === 'function') {
+    return;
+  }
+
+  throw new Error(
+    `${detourLabel(trailId, index, detour)} must declare a callable recover function`
+  );
+};
+
+const sameOrSubtype = (
+  candidate: abstract new (...args: never[]) => Error,
+  ancestor: abstract new (...args: never[]) => Error
+): boolean => {
+  if (candidate === ancestor) {
+    return true;
+  }
+
+  let current = Object.getPrototypeOf(candidate.prototype);
+  while (current && typeof current === 'object') {
+    const ctor = (current as { constructor?: unknown }).constructor;
+    if (ctor === ancestor) {
+      return true;
+    }
+    current = Object.getPrototypeOf(current);
+  }
+
+  return false;
+};
+
+const getShadowingDetour = (
+  detours: readonly RuntimeDetour[],
+  index: number
+):
+  | {
+      readonly index: number;
+      readonly on: abstract new (...args: never[]) => Error;
+    }
+  | undefined => {
+  const detour = detours[index];
+  if (!detour || !isErrorConstructor(detour.on)) {
+    return undefined;
+  }
+
+  for (let previousIndex = 0; previousIndex < index; previousIndex += 1) {
+    const previous = detours[previousIndex];
+    if (!previous || !isErrorConstructor(previous.on)) {
+      continue;
+    }
+
+    if (sameOrSubtype(detour.on, previous.on)) {
+      return { index: previousIndex, on: previous.on };
+    }
+  }
+
+  return undefined;
+};
+
+const assertNotShadowed = (
+  trailId: string,
+  detours: readonly RuntimeDetour[],
+  index: number
+): void => {
+  const detour = detours[index];
+  if (!detour || !isErrorConstructor(detour.on)) {
+    return;
+  }
+
+  const shadowing = getShadowingDetour(detours, index);
+  if (!shadowing) {
+    return;
+  }
+
+  const previousName = shadowing.on.name || TrailsError.name;
+  const currentName = detour.on.name || TrailsError.name;
+  throw new Error(
+    `${trailId} detour[${index}] on ${currentName} is shadowed by earlier detour[${shadowing.index}] on ${previousName}`
+  );
+};
 
 /**
- * Verify that every trail's detour targets reference trails that
- * actually exist in the app's topo.
+ * Verify that every trail's detours match the live runtime contract:
+ * `on` must be an error constructor, `recover` must be callable, and
+ * later detours must not be shadowed by earlier broader `on` types.
  */
 export const testDetours = (app: Topo): void => {
   const trailEntries = [...app.trails];
 
   describe('detours', () => {
     describe.each(trailEntries)('%s', (_id, trailDef) => {
-      const t = trailDef as Trail<unknown, unknown>;
+      const trail = trailDef as Trail<unknown, unknown, unknown>;
 
-      if (t.detours === undefined) {
+      if (trail.detours.length === 0) {
         return;
       }
 
-      const { detours } = t;
-      const testCases = Object.entries(detours).flatMap(
-        ([detourName, targets]) =>
-          targets.map((targetId) => ({ detourName, targetId }))
+      const detourCases = trail.detours.map((detour, index) => ({
+        detour,
+        index,
+        trailId: trail.id,
+      }));
+
+      test.each(detourCases)(
+        '$trailId detour[$index] uses an error constructor',
+        ({ detour, index, trailId }) => {
+          assertValidOn(trailId, index, detour);
+        }
+      );
+
+      test.each(detourCases)(
+        '$trailId detour[$index] provides a callable recover',
+        ({ detour, index, trailId }) => {
+          assertCallableRecover(trailId, index, detour);
+        }
       );
 
-      test.each(testCases)(
-        'detour "$detourName" -> "$targetId" exists',
-        ({ targetId }) => {
-          expect(app.has(targetId)).toBe(true);
+      test.each(detourCases)(
+        '$trailId detour[$index] is not shadowed by an earlier detour',
+        ({ index, trailId }) => {
+          assertNotShadowed(trailId, trail.detours, index);
         }
       );
     });