@ontrails/core 1.0.0-beta.1 → 1.0.0-beta.11

package/src/__tests__/topo.test.ts

@@ -4,6 +4,7 @@ import { z } from 'zod';
 
 import { ValidationError } from '../errors.js';
 import { Result } from '../result.js';
+import { service } from '../service.js';
 import { topo } from '../topo.js';
 
 // ---------------------------------------------------------------------------
@@ -13,22 +14,13 @@ import { topo } from '../topo.js';
 // oxlint-disable-next-line require-await -- satisfies async interface without needing await
 const noop = async () => Result.ok();
 
-const mockTrail = (id: string) => ({
+const mockTrail = (id: string, follow?: readonly string[]) => ({
+  follow: Object.freeze([...(follow ?? [])]),
   id,
-  implementation: noop,
   input: z.object({ x: z.number() }),
   kind: 'trail' as const,
   output: z.object({ y: z.number() }),
-});
-
-const mockHike = (id: string) => ({
-  follows: [] as readonly string[],
-  id,
-  implementation: noop,
-  input: z.object({ q: z.string() }),
-  kind: 'hike' as const,
-  output: z.object({ r: z.string() }),
-  path: `/${id}`,
+  run: noop,
 });
 
 const mockEvent = (id: string) => ({
@@ -37,85 +29,159 @@ const mockEvent = (id: string) => ({
   payload: z.object({ payload: z.string() }),
 });
 
+const mockService = (id: string) =>
+  service(id, {
+    create: () => Result.ok({ id }),
+    description: `${id} service`,
+  });
+
 // ---------------------------------------------------------------------------
 // topo()
 // ---------------------------------------------------------------------------
 
 describe('topo', () => {
-  test('returns Topo with name', () => {
-    const t = topo('my-app');
-    expect(t.name).toBe('my-app');
-  });
+  describe('collection', () => {
+    test('returns Topo with name', () => {
+      const t = topo('my-app');
+      expect(t.name).toBe('my-app');
+    });
 
-  test('collects trails from modules', () => {
-    const mod = { myTrail: mockTrail('create-user') };
-    const t = topo('app', mod);
+    test('collects trails from modules', () => {
+      const mod = { myTrail: mockTrail('create-user') };
+      const t = topo('app', mod);
 
-    expect(t.trails.size).toBe(1);
-    expect(t.trails.get('create-user')).toBe(mod.myTrail);
-  });
+      expect(t.trails.size).toBe(1);
+      expect(t.trails.get('create-user')).toBe(mod.myTrail);
+    });
 
-  test('auto-scans exports by kind discriminant', () => {
-    const mod = {
-      event1: mockEvent('e1'),
-      hike1: mockHike('r1'),
-      trail1: mockTrail('t1'),
-    };
-    const t = topo('app', mod);
-
-    expect(t.trails.size).toBe(1);
-    expect(t.hikes.size).toBe(1);
-    expect(t.events.size).toBe(1);
-  });
+    test('auto-scans exports by kind discriminant', () => {
+      const mod = {
+        event1: mockEvent('e1'),
+        service1: mockService('s1'),
+        trail1: mockTrail('t1'),
+        trail2: mockTrail('t2', ['t1']),
+      };
+      const t = topo('app', mod);
+
+      expect(t.trails.size).toBe(2);
+      expect(t.events.size).toBe(1);
+      expect(t.services.size).toBe(1);
+    });
 
-  test('collects from multiple modules', () => {
-    const mod1 = { a: mockTrail('t1') };
-    const mod2 = { b: mockTrail('t2'), c: mockHike('r1') };
-    const t = topo('app', mod1, mod2);
+    test('collects from multiple modules', () => {
+      const mod1 = { a: mockTrail('t1') };
+      const mod2 = { b: mockTrail('t2'), c: mockTrail('t3', ['t1']) };
+      const t = topo('app', mod1, mod2);
 
-    expect(t.trails.size).toBe(2);
-    expect(t.hikes.size).toBe(1);
+      expect(t.trails.size).toBe(3);
+    });
+
+    test('non-trail exports are silently ignored', () => {
+      const mod = {
+        config: { port: 3000 },
+        helper: () => 'not a trail',
+        name: 'some-string',
+        nothing: null,
+        num: 42,
+        trail1: mockTrail('t1'),
+        undef: undefined,
+      };
+      const t = topo('app', mod);
+
+      expect(t.trails.size).toBe(1);
+      expect(t.events.size).toBe(0);
+      expect(t.services.size).toBe(0);
+    });
+
+    test('trail with follow registers correctly', () => {
+      const mod = { t: mockTrail('trail-1', ['trail-2']) };
+      const t = topo('app', mod);
+
+      expect(t.trails.size).toBe(1);
+      const registered = t.trails.get('trail-1');
+      expect(registered?.follow).toEqual(['trail-2']);
+    });
+
+    test('collects services from modules', () => {
+      const mod = { db: mockService('db.main') };
+      const t = topo('app', mod);
+
+      expect(t.services.size).toBe(1);
+      expect(t.services.get('db.main')).toBe(mod.db);
+    });
   });
 
-  test('non-trail exports are silently ignored', () => {
-    const mod = {
-      config: { port: 3000 },
-      helper: () => 'not a trail',
-      name: 'some-string',
-      nothing: null,
-      num: 42,
-      trail1: mockTrail('t1'),
-      undef: undefined,
-    };
-    const t = topo('app', mod);
-
-    expect(t.trails.size).toBe(1);
-    expect(t.hikes.size).toBe(0);
-    expect(t.events.size).toBe(0);
+  describe('duplicate rejection', () => {
+    test('rejects duplicate trail IDs', () => {
+      const mod1 = { a: mockTrail('dup') };
+      const mod2 = { b: mockTrail('dup') };
+
+      expect(() => topo('app', mod1, mod2)).toThrow(ValidationError);
+      expect(() => topo('app', mod1, mod2)).toThrow(
+        'Duplicate trail ID: "dup"'
+      );
+    });
+
+    test('rejects duplicate event IDs', () => {
+      const mod1 = { a: mockEvent('dup') };
+      const mod2 = { b: mockEvent('dup') };
+
+      expect(() => topo('app', mod1, mod2)).toThrow(ValidationError);
+      expect(() => topo('app', mod1, mod2)).toThrow(
+        'Duplicate event ID: "dup"'
+      );
+    });
+
+    test('rejects duplicate service IDs', () => {
+      const mod1 = { a: mockService('dup') };
+      const mod2 = { b: mockService('dup') };
+
+      expect(() => topo('app', mod1, mod2)).toThrow(ValidationError);
+      expect(() => topo('app', mod1, mod2)).toThrow(
+        'Duplicate service ID: "dup"'
+      );
+    });
   });
+});
 
-  test('rejects duplicate trail IDs', () => {
-    const mod1 = { a: mockTrail('dup') };
-    const mod2 = { b: mockTrail('dup') };
+// ---------------------------------------------------------------------------
+// topo accessors
+// ---------------------------------------------------------------------------
 
-    expect(() => topo('app', mod1, mod2)).toThrow(ValidationError);
-    expect(() => topo('app', mod1, mod2)).toThrow('Duplicate trail ID: "dup"');
+describe('topo accessors', () => {
+  test('ids() returns all trail IDs', () => {
+    const a = mockTrail('alpha');
+    const b = mockTrail('beta');
+    const app = topo('test', { a, b });
+    expect(app.ids().toSorted()).toEqual(['alpha', 'beta']);
   });
 
-  test('rejects duplicate hike IDs', () => {
-    const mod1 = { a: mockHike('dup') };
-    const mod2 = { b: mockHike('dup') };
+  test('count returns number of trails', () => {
+    const a = mockTrail('alpha');
+    const app = topo('test', { a });
+    expect(app.count).toBe(1);
+  });
 
-    expect(() => topo('app', mod1, mod2)).toThrow(ValidationError);
-    expect(() => topo('app', mod1, mod2)).toThrow('Duplicate hike ID: "dup"');
+  test('serviceCount returns number of services', () => {
+    const db = mockService('db.main');
+    const cache = mockService('cache.main');
+    const app = topo('test', { cache, db });
+    expect(app.serviceCount).toBe(2);
   });
 
-  test('rejects duplicate event IDs', () => {
-    const mod1 = { a: mockEvent('dup') };
-    const mod2 = { b: mockEvent('dup') };
+  test('empty topo has zero count and empty ids', () => {
+    const app = topo('empty');
+    expect(app.count).toBe(0);
+    expect(app.ids()).toEqual([]);
+    expect(app.serviceCount).toBe(0);
+    expect(app.serviceIds()).toEqual([]);
+  });
 
-    expect(() => topo('app', mod1, mod2)).toThrow(ValidationError);
-    expect(() => topo('app', mod1, mod2)).toThrow('Duplicate event ID: "dup"');
+  test('serviceIds() returns all service IDs', () => {
+    const db = mockService('db.main');
+    const cache = mockService('cache.main');
+    const app = topo('test', { cache, db });
+    expect(app.serviceIds().toSorted()).toEqual(['cache.main', 'db.main']);
   });
 });
 
@@ -126,9 +192,10 @@ describe('topo', () => {
 describe('Topo', () => {
   const mod = {
     e1: mockEvent('event-1'),
-    h1: mockHike('hike-1'),
+    s1: mockService('service-1'),
     t1: mockTrail('trail-1'),
     t2: mockTrail('trail-2'),
+    t3: mockTrail('trail-3', ['trail-1']),
   };
 
   // Build once for the describe block
@@ -139,8 +206,8 @@ describe('Topo', () => {
       expect(app.get('trail-1')).toBe(mod.t1);
     });
 
-    test('retrieves hike by ID', () => {
-      expect(app.get('hike-1')).toBe(mod.h1);
+    test('retrieves trail with follow by ID', () => {
+      expect(app.get('trail-3')).toBe(mod.t3);
     });
 
     test('returns undefined for unknown ID', () => {
@@ -153,26 +220,46 @@ describe('Topo', () => {
       expect(app.has('trail-1')).toBe(true);
     });
 
-    test('returns true for known hike', () => {
-      expect(app.has('hike-1')).toBe(true);
+    test('returns true for trail with follow', () => {
+      expect(app.has('trail-3')).toBe(true);
     });
 
     test('returns false for unknown ID', () => {
       expect(app.has('nope')).toBe(false);
     });
 
-    test('returns false for event ID (events are not trails/hikes)', () => {
+    test('returns false for event ID (events are not trails)', () => {
       expect(app.has('event-1')).toBe(false);
     });
   });
 
+  describe('getService()', () => {
+    test('retrieves service by ID', () => {
+      expect(app.getService('service-1')).toBe(mod.s1);
+    });
+
+    test('returns undefined for unknown service ID', () => {
+      expect(app.getService('missing-service')).toBeUndefined();
+    });
+  });
+
+  describe('hasService()', () => {
+    test('returns true for known service', () => {
+      expect(app.hasService('service-1')).toBe(true);
+    });
+
+    test('returns false for unknown service', () => {
+      expect(app.hasService('missing-service')).toBe(false);
+    });
+  });
+
   describe('listing', () => {
-    test('list() returns all trails and hikes', () => {
+    test('list() returns all trails (with and without follow)', () => {
       const items = app.list();
       expect(items).toHaveLength(3);
       expect(items).toContain(mod.t1);
       expect(items).toContain(mod.t2);
-      expect(items).toContain(mod.h1);
+      expect(items).toContain(mod.t3);
     });
 
     test('listEvents() returns all events', () => {
@@ -180,5 +267,11 @@ describe('Topo', () => {
       expect(items).toHaveLength(1);
       expect(items).toContain(mod.e1);
     });
+
+    test('listServices() returns all services', () => {
+      const items = app.listServices();
+      expect(items).toHaveLength(1);
+      expect(items).toContain(mod.s1);
+    });
   });
 });

package/src/__tests__/trail.test.ts

@@ -2,14 +2,26 @@ import { describe, test, expect } from 'bun:test';
 
 import { z } from 'zod';
 
+import { createTrailContext } from '../context';
 import { Result } from '../result';
+import { service } from '../service';
 import { trail } from '../trail';
 import type { TrailContext } from '../types';
 
-const stubCtx: TrailContext = {
+const stubCtx: TrailContext = createTrailContext({
   requestId: 'test-123',
   signal: AbortSignal.timeout(5000),
-};
+});
+
+const dbService = service('db.main', {
+  create: () =>
+    Result.ok({
+      query(sql: string) {
+        return sql.length;
+      },
+    }),
+  description: 'Primary database service',
+});
 
 describe('trail()', () => {
   const inputSchema = z.object({ name: z.string() });
@@ -17,9 +29,9 @@ describe('trail()', () => {
 
   const greet = trail('greet', {
     description: 'Greet someone',
-    implementation: (input) => Result.ok({ greeting: `Hello, ${input.name}!` }),
     input: inputSchema,
     output: outputSchema,
+    run: (input) => Result.ok({ greeting: `Hello, ${input.name}!` }),
   });
 
   describe('basics', () => {
@@ -41,14 +53,14 @@ describe('trail()', () => {
 
     test('output schema is optional', () => {
       const minimal = trail('noop', {
-        implementation: () => Result.ok(),
         input: z.object({}),
+        run: () => Result.ok(),
       });
       expect(minimal.output).toBeUndefined();
     });
 
     test('implementation is callable', async () => {
-      const result = await greet.implementation({ name: 'World' }, stubCtx);
+      const result = await greet.run({ name: 'World' }, stubCtx);
       expect(result.isOk()).toBe(true);
       expect(result.unwrap()).toEqual({ greeting: 'Hello, World!' });
     });
@@ -61,8 +73,8 @@ describe('trail()', () => {
           { error: 'ValidationError', input: { text: '' }, name: 'error-case' },
           { expected: { text: 'hi' }, input: { text: 'hi' }, name: 'basic' },
         ],
-        implementation: (input) => Result.ok({ text: input.text }),
         input: z.object({ text: z.string() }),
+        run: (input) => Result.ok({ text: input.text }),
       });
       expect(withExamples.examples).toHaveLength(2);
       const first = withExamples.examples?.[0];
@@ -71,13 +83,13 @@ describe('trail()', () => {
       expect(second?.name).toBe('basic');
     });
 
-    test('markers are stored', () => {
-      const withMarkers = trail('tagged', {
-        implementation: () => Result.ok(),
+    test('metadata is stored', () => {
+      const withMetadata = trail('tagged', {
         input: z.object({}),
-        markers: { domain: 'billing', tier: 1 },
+        metadata: { domain: 'billing', tier: 1 },
+        run: () => Result.ok(),
       });
-      expect(withMarkers.markers).toEqual({ domain: 'billing', tier: 1 });
+      expect(withMetadata.metadata).toEqual({ domain: 'billing', tier: 1 });
     });
 
     test('detours are stored', () => {
@@ -86,8 +98,8 @@ describe('trail()', () => {
           onFailure: ['alert'],
           onSuccess: ['notify', 'audit'],
         },
-        implementation: () => Result.ok(),
         input: z.object({}),
+        run: () => Result.ok(),
       });
       expect(withDetours.detours).toEqual({
         onFailure: ['alert'],
@@ -96,28 +108,98 @@ describe('trail()', () => {
     });
   });
 
-  describe('boolean flags', () => {
-    test('boolean flags default to undefined', () => {
+  describe('follow', () => {
+    test('defaults to empty frozen array when omitted', () => {
+      const minimal = trail('bare', {
+        input: z.object({}),
+        run: () => Result.ok(),
+      });
+      expect(minimal.follow).toEqual([]);
+      expect(Object.isFrozen(minimal.follow)).toBe(true);
+    });
+
+    test('preserves follow array', () => {
+      const withFollow = trail('composed', {
+        follow: ['authenticate', 'validate-session'],
+        input: z.object({}),
+        run: () => Result.ok(),
+      });
+      expect(withFollow.follow).toEqual(['authenticate', 'validate-session']);
+    });
+
+    test('follow array is frozen', () => {
+      const withFollow = trail('composed', {
+        follow: ['authenticate'],
+        input: z.object({}),
+        run: () => Result.ok(),
+      });
+      expect(Object.isFrozen(withFollow.follow)).toBe(true);
+    });
+  });
+
+  describe('services', () => {
+    test('defaults to empty frozen array when omitted', () => {
+      const minimal = trail('bare', {
+        input: z.object({}),
+        run: () => Result.ok(),
+      });
+      expect(minimal.services).toEqual([]);
+      expect(Object.isFrozen(minimal.services)).toBe(true);
+    });
+
+    test('preserves declared service objects', () => {
+      const withServices = trail('search', {
+        input: z.object({}),
+        run: () => Result.ok(),
+        services: [dbService],
+      });
+      expect(withServices.services).toEqual([dbService]);
+      expect(withServices.services[0]).toBe(dbService);
+    });
+
+    test('services array is frozen', () => {
+      const withServices = trail('search', {
+        input: z.object({}),
+        run: () => Result.ok(),
+        services: [dbService],
+      });
+      expect(Object.isFrozen(withServices.services)).toBe(true);
+    });
+  });
+
+  describe('intent and idempotent', () => {
+    test('intent defaults to write', () => {
       const minimal = trail('bare', {
-        implementation: () => Result.ok(),
         input: z.object({}),
+        run: () => Result.ok(),
       });
-      expect(minimal.readOnly).toBeUndefined();
-      expect(minimal.destructive).toBeUndefined();
+      expect(minimal.intent).toBe('write');
       expect(minimal.idempotent).toBeUndefined();
     });
 
-    test('boolean flags are preserved when set', () => {
-      const withFlags = trail('flagged', {
-        destructive: false,
+    test('intent is preserved when set', () => {
+      const readTrail = trail('reader', {
+        input: z.object({}),
+        intent: 'read',
+        run: () => Result.ok(),
+      });
+      expect(readTrail.intent).toBe('read');
+
+      const destroyTrail = trail('destroyer', {
+        input: z.object({}),
+        intent: 'destroy',
+        run: () => Result.ok(),
+      });
+      expect(destroyTrail.intent).toBe('destroy');
+    });
+
+    test('idempotent is preserved when set', () => {
+      const t = trail('idempotent', {
         idempotent: true,
-        implementation: () => Result.ok(),
         input: z.object({}),
-        readOnly: true,
+        run: () => Result.ok(),
       });
-      expect(withFlags.readOnly).toBe(true);
-      expect(withFlags.destructive).toBe(false);
-      expect(withFlags.idempotent).toBe(true);
+      expect(t.idempotent).toBe(true);
     });
   });
 
@@ -125,9 +207,9 @@ describe('trail()', () => {
     test('accepts spec with id property', () => {
       const t = trail({
         id: 'entity.show',
-        implementation: (input: { name: string }, _ctx: TrailContext) =>
-          Result.ok({ greeting: `Hi, ${input.name}` }),
         input: inputSchema,
+        run: (input: { name: string }, _ctx: TrailContext) =>
+          Result.ok({ greeting: `Hi, ${input.name}` }),
       });
       expect(t.id).toBe('entity.show');
       expect(t.kind).toBe('trail');
@@ -136,39 +218,39 @@ describe('trail()', () => {
     test('preserves all spec fields', () => {
       const t = trail({
         description: 'A full trail',
-        destructive: false,
         examples: [{ input: { name: 'World' }, name: 'test' }],
         id: 'full',
-        implementation: (input: { name: string }, _ctx: TrailContext) =>
-          Result.ok({ greeting: `Hi, ${input.name}` }),
         input: inputSchema,
+        intent: 'read',
         output: outputSchema,
-        readOnly: true,
+        run: (input: { name: string }, _ctx: TrailContext) =>
+          Result.ok({ greeting: `Hi, ${input.name}` }),
+        services: [dbService],
       });
       expect(t.description).toBe('A full trail');
-      expect(t.readOnly).toBe(true);
+      expect(t.intent).toBe('read');
       expect(t.examples).toHaveLength(1);
+      expect(t.services).toEqual([dbService]);
     });
 
     test('implementation is callable', async () => {
       const t = trail({
         id: 'callable',
-        implementation: (input: { x: number }) => Result.ok(input.x * 2),
         input: z.object({ x: z.number() }),
+        run: (input: { x: number }) => Result.ok(input.x * 2),
       });
-      const result = await t.implementation({ x: 5 }, stubCtx);
+      const result = await t.run({ x: 5 }, stubCtx);
       expect(result.isOk()).toBe(true);
       expect(result.unwrap()).toBe(10);
     });
 
     test('sync implementations are normalized to an awaitable runtime function', async () => {
       const t = trail('normalized', {
-        implementation: (input: { value: number }) =>
-          Result.ok(input.value + 1),
         input: z.object({ value: z.number() }),
+        run: (input: { value: number }) => Result.ok(input.value + 1),
       });
 
-      const promise = t.implementation({ value: 2 }, stubCtx);
+      const promise = t.run({ value: 2 }, stubCtx);
       expect(promise).toBeInstanceOf(Promise);
 
       const result = await promise;