@ontrails/warden 1.0.0-beta.11 → 1.0.0-beta.13

package/src/__tests__/service-declarations.test.ts

@@ -1,318 +0,0 @@
-import { describe, expect, test } from 'bun:test';
-
-import { serviceDeclarations } from '../rules/service-declarations.js';
-
-const TEST_FILE = 'test.ts';
-
-describe('service-declarations', () => {
-  describe('clean cases', () => {
-    test('declared services match service.from(ctx) usage', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => {
-    return Result.ok({ source: db.from(ctx).source });
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(0);
-    });
-
-    test('local helper named service() is not treated as ctx lookup', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => {
-    const service = (id: string) => id;
-    return Result.ok({
-      resolved: service('db.main'),
-      source: db.from(ctx).source,
-    });
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(0);
-    });
-
-    test('declared services match ctx.service() usage', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => {
-    const resolved = ctx.service('db.main');
-    return Result.ok(resolved);
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(0);
-    });
-
-    test('recognizes destructured service() calls', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => {
-    const { service } = ctx;
-    return Result.ok(service('db.main'));
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(0);
-    });
-
-    test('recognizes ctx.service(db) lookups by declared service object', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => {
-    return Result.ok(ctx.service(db));
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(0);
-    });
-  });
-
-  describe('error cases', () => {
-    test('service.from(ctx) without a declaration produces an error', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  run: async (_input, ctx) => {
-    return Result.ok({ source: db.from(ctx).source });
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(1);
-      expect(diagnostics[0]?.severity).toBe('error');
-      expect(diagnostics[0]?.rule).toBe('service-declarations');
-      expect(diagnostics[0]?.message).toContain('db.from(ctx)');
-      expect(diagnostics[0]?.message).toContain('not declared in services');
-    });
-
-    test('ctx.service() without a declaration produces an error', () => {
-      const code = `
-trail('entity.show', {
-  run: async (_input, ctx) => {
-    return Result.ok(ctx.service('db.main'));
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(1);
-      expect(diagnostics[0]?.severity).toBe('error');
-      expect(diagnostics[0]?.message).toContain("ctx.service('db.main')");
-    });
-
-    test('unresolved imported service declarations do not suppress lookup diagnostics', () => {
-      const code = `
-import { Result, trail } from '@ontrails/core';
-import { db } from './services';
-
-// const db = service('db.main', {
-//   create: () => Result.ok({ source: 'factory' }),
-// });
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => {
-    return Result.ok(ctx.service('db.main'));
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(1);
-      expect(diagnostics[0]?.severity).toBe('error');
-      expect(diagnostics[0]?.message).toContain("ctx.service('db.main')");
-    });
-
-    test('ctx.service(db) without a declaration produces an error', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  run: async (_input, ctx) => {
-    return Result.ok(ctx.service(db));
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(1);
-      expect(diagnostics[0]?.severity).toBe('error');
-      expect(diagnostics[0]?.message).toContain('ctx.service(db)');
-    });
-  });
-
-  describe('warn cases', () => {
-    test('declared but unused service produces a warning', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async () => {
-    return Result.ok({ ok: true });
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(1);
-      expect(diagnostics[0]?.severity).toBe('warn');
-      expect(diagnostics[0]?.rule).toBe('service-declarations');
-      expect(diagnostics[0]?.message).toContain("'db' declared in services");
-      expect(diagnostics[0]?.message).toContain('never used');
-    });
-  });
-
-  describe('single-object overload', () => {
-    test('recognizes trail({ id, services, run }) form', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail({
-  id: 'entity.show',
-  services: [db],
-  run: async (_input, ctx) => {
-    return Result.ok({ source: db.from(ctx).source });
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(0);
-    });
-  });
-
-  describe('context parameter naming', () => {
-    test('recognizes database.from(context) when second param is named context', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const database = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [database],
-  run: async (_input, context) => {
-    return Result.ok(database.from(context));
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(0);
-    });
-  });
-
-  describe('nested run false positives', () => {
-    test('metadata.run does not trigger false positives', () => {
-      const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  metadata: { run: async () => ctx.service('phantom') },
-  run: async (_input, ctx) => {
-    return Result.ok(db.from(ctx));
-  },
-});
-`;
-
-      const diagnostics = serviceDeclarations.check(code, TEST_FILE);
-
-      expect(diagnostics.length).toBe(0);
-    });
-  });
-
-  test('skips test files', () => {
-    const code = `
-trail('entity.show', {
-  run: async (_input, ctx) => {
-    return Result.ok(ctx.service('db.main'));
-  },
-});
-`;
-
-    expect(serviceDeclarations.check(code, 'entity.test.ts')).toEqual([]);
-  });
-});

package/src/__tests__/service-exists.test.ts

@@ -1,122 +0,0 @@
-import { describe, expect, test } from 'bun:test';
-
-import { serviceExists } from '../rules/service-exists.js';
-
-const TEST_FILE = 'entity.ts';
-
-describe('service-exists', () => {
-  test('passes when a locally declared service exists', () => {
-    const code = `
-import { Result, service, trail } from '@ontrails/core';
-import type { Service } from '@ontrails/core';
-
-const db: Service<{ source: string }> = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => Result.ok(db.from(ctx)),
-});
-`;
-
-    expect(serviceExists.check(code, TEST_FILE)).toEqual([]);
-  });
-
-  test('ignores commented-out service declarations when resolving local ids', () => {
-    const code = `
-import { Result, trail } from '@ontrails/core';
-
-trail('entity.show', {
-  services: ['db.main'],
-  run: async (_input, ctx) => Result.ok(ctx.service('db.main')),
-});
-
-// const db = service('db.main', {
-//   create: () => Result.ok({ source: 'factory' }),
-// });
-`;
-
-    const diagnostics = serviceExists.check(code, TEST_FILE);
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0]?.rule).toBe('service-exists');
-    expect(diagnostics[0]?.message).toContain('db.main');
-  });
-
-  test('flags a declared service missing from project context', () => {
-    const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => Result.ok(db.from(ctx)),
-});
-`;
-
-    const diagnostics = serviceExists.checkWithContext(code, TEST_FILE, {
-      knownServiceIds: new Set(['db.other']),
-      knownTrailIds: new Set(['entity.show']),
-    });
-
-    expect(diagnostics).toHaveLength(1);
-    expect(diagnostics[0]?.rule).toBe('service-exists');
-    expect(diagnostics[0]?.message).toContain('db.main');
-  });
-
-  test('passes when project context includes the declared service', () => {
-    const code = `
-import { Result, service, trail } from '@ontrails/core';
-
-const db = service('db.main', {
-  create: () => Result.ok({ source: 'factory' }),
-});
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => Result.ok(db.from(ctx)),
-});
-`;
-
-    const diagnostics = serviceExists.checkWithContext(code, TEST_FILE, {
-      knownServiceIds: new Set(['db.main']),
-      knownTrailIds: new Set(['entity.show']),
-    });
-
-    expect(diagnostics).toEqual([]);
-  });
-
-  test('skips unresolved imported services instead of guessing', () => {
-    const code = `
-import { trail } from '@ontrails/core';
-import { db } from './services';
-
-trail('entity.show', {
-  services: [db],
-  run: async (_input, ctx) => Result.ok(db.from(ctx)),
-});
-`;
-
-    expect(
-      serviceExists.checkWithContext(code, TEST_FILE, {
-        knownServiceIds: new Set(['db.main']),
-        knownTrailIds: new Set(['entity.show']),
-      })
-    ).toEqual([]);
-  });
-
-  test('skips test files', () => {
-    const code = `
-trail('entity.show', {
-  services: ['db.main'],
-  run: async (_input, ctx) => Result.ok(ctx.service('db.main')),
-});
-`;
-
-    expect(serviceExists.check(code, 'entity.test.ts')).toEqual([]);
-  });
-});

package/src/trails/follow-declarations.trail.ts

@@ -1,22 +0,0 @@
-import { followDeclarations } from '../rules/follow-declarations.js';
-import { wrapRule } from './wrap-rule.js';
-
-export const followDeclarationsTrail = wrapRule({
-  examples: [
-    {
-      expected: { diagnostics: [] },
-      input: {
-        filePath: 'clean.ts',
-        sourceCode: `trail("entity.onboard", {
-  follow: ["entity.create"],
-  run: async (input, ctx) => {
-    const result = await ctx.follow("entity.create", input);
-    return Result.ok(result);
-  }
-})`,
-      },
-      name: 'Matched follow declarations and calls',
-    },
-  ],
-  rule: followDeclarations,
-});

package/src/trails/service-declarations.trail.ts

@@ -1,25 +0,0 @@
-import { serviceDeclarations } from '../rules/service-declarations.js';
-import { wrapRule } from './wrap-rule.js';
-
-export const serviceDeclarationsTrail = wrapRule({
-  examples: [
-    {
-      expected: { diagnostics: [] },
-      input: {
-        filePath: 'clean.ts',
-        sourceCode: `const db = service("db.main", {
-  create: () => Result.ok({ source: "factory" }),
-});
-
-trail("entity.show", {
-  services: [db],
-  run: async (_input, ctx) => {
-    return Result.ok(db.from(ctx));
-  }
-})`,
-      },
-      name: 'Matched service declarations and usage',
-    },
-  ],
-  rule: serviceDeclarations,
-});

package/src/trails/service-exists.trail.ts

@@ -1,27 +0,0 @@
-import { serviceExists } from '../rules/service-exists.js';
-import { wrapRule } from './wrap-rule.js';
-
-export const serviceExistsTrail = wrapRule({
-  examples: [
-    {
-      expected: { diagnostics: [] },
-      input: {
-        filePath: 'clean.ts',
-        knownServiceIds: ['db.main'],
-        knownTrailIds: ['entity.show'],
-        sourceCode: `const db = service("db.main", {
-  create: () => Result.ok({ source: "factory" }),
-});
-
-trail("entity.show", {
-  services: [db],
-  run: async (_input, ctx) => {
-    return Result.ok(db.from(ctx));
-  }
-})`,
-      },
-      name: 'Declared services resolve to known project services',
-    },
-  ],
-  rule: serviceExists,
-});