Move the addon-gated domains onto the decorators

collab, journal, atlas, vacay and collections: 32 more methods, so the registry
owns 93 of 113. rpc-host.ts is at 565 lines, down from 1332, and the deps factory
at 384, down from 944.

These five are the risky group, because their addon gates lived inside the deps
factory's closure rather than in the router. A handler that calls its service
directly still works, just without the check, and neither the compiler nor the
router tests would notice. So addon-gates.rpc.test.ts walks all 37 gated methods as
one table and asserts two things for each: with the addon off it is refused with
that addon's message, and the service is never reached. The table length is pinned,
so a later method added without a row is a failure rather than a silent gap.

One ordering detail worth knowing: on the atlas writes the router evaluated its
params before the addon gate inside the closure, so a malformed country code still
reports BAD_PARAMS rather than the addon. The handlers keep that order.

The collections service reports refusals as status-tagged errors rather than typed
ones, so mapCollectionError came across with the handlers: 403 and 404 become
RESOURCE_FORBIDDEN, 400 and 409 become BAD_PARAMS, and anything untagged stays a
HOST_ERROR instead of being dressed up as a permission problem.
This commit is contained in:
Maurice
2026-08-09 15:49:51 +02:00
committed by Maurice
parent 7bca741f28
commit 294cfcd8d7
19 changed files with 1016 additions and 504 deletions
@@ -0,0 +1,243 @@
/**
* The refusal paths of the five addon-gated domains: no bound user, invalid input,
* and the service saying no.
*
* The happy paths and the addon gates live in addon-gates.rpc.test.ts and the domain
* suites; this file is about what happens when something is wrong, because those are
* the branches a move like this leaves untested by default.
*/
import { describe, it, expect, vi } from 'vitest';
import { PluginRpcHost } from '../../../src/nest/plugins/host/rpc-host';
import { createTestPluginRegistry } from '../../../src/nest/plugins/host/rpc-kit/testing';
import { PluginGuards } from '../../../src/nest/plugins/host/plugin-guards.service';
import { CollabRpc } from '../../../src/nest/collab/collab.rpc';
import { AtlasRpc } from '../../../src/nest/atlas/atlas.rpc';
import { VacayRpc } from '../../../src/nest/vacay/vacay.rpc';
import { JournalRpc } from '../../../src/nest/journey/journal.rpc';
import { CollectionsRpc } from '../../../src/nest/collections/collections.rpc';
import type { DatabaseService } from '../../../src/nest/database/database.service';
import type { PermissionsService } from '../../../src/nest/permissions/permissions.service';
import type { AddonsService } from '../../../src/nest/addons/addons.service';
import type { RpcRequest, RpcError } from '../../../src/nest/plugins/protocol/envelope';
import { makeDeps } from '../../helpers/rpc-host-deps';
const req = (method: string, params: Record<string, unknown> = {}): RpcRequest => ({ k: 'req', id: 'x', method, params });
const err = (r: unknown) => (r as RpcError).error;
/** A status-tagged error, the shape CollectionsService throws. */
function statusError(status: number, message: string) {
return Object.assign(new Error(message), { status });
}
function build(overrides: {
collab?: Record<string, unknown>;
atlas?: Record<string, unknown>;
vacay?: Record<string, unknown>;
journey?: Record<string, unknown>;
collections?: Record<string, unknown>;
} = {}) {
const db = {
canAccessTrip: vi.fn(() => ({ id: 1, user_id: 42 })),
prepare: vi.fn(() => ({ get: () => ({ role: 'user' }), all: () => [] })),
} as unknown as DatabaseService;
const guards = new PluginGuards(
db,
{ checkPermission: vi.fn(() => true) } as unknown as PermissionsService,
{ isAddonEnabled: vi.fn(() => true) } as unknown as AddonsService,
);
const realtime = { broadcast: vi.fn() } as never;
const registry = createTestPluginRegistry([
new CollabRpc({ createNote: vi.fn(() => ({})), createPoll: vi.fn(() => ({})), votePoll: vi.fn(() => ({ error: null, poll: {} })), createMessage: vi.fn(() => ({ error: null, message: {} })), listNotes: vi.fn(() => []), listPolls: vi.fn(() => []), listMessages: vi.fn(() => []), ...overrides.collab } as never, realtime, guards),
new AtlasRpc({ listVisitedCountries: vi.fn(() => []), listManuallyVisitedRegions: vi.fn(() => []), bucketList: vi.fn(() => []), markCountry: vi.fn(), unmarkCountry: vi.fn(), markRegion: vi.fn(), unmarkRegion: vi.fn(), createBucketItem: vi.fn(() => ({})), deleteBucketItem: vi.fn(() => true), ...overrides.atlas } as never, guards),
new VacayRpc({ getPlanData: vi.fn(() => ({})), getActivePlanId: vi.fn(() => 1), toggleEntry: vi.fn(() => ({})), toggleCompanyHoliday: vi.fn(() => ({})), ...overrides.vacay } as never, guards),
new JournalRpc({ listJourneys: vi.fn(() => []), listEntries: vi.fn(() => []), createEntry: vi.fn(() => ({})), updateEntry: vi.fn(() => ({})), deleteEntry: vi.fn(() => true), createJourney: vi.fn(() => ({})), deleteJourney: vi.fn(() => true), ...overrides.journey } as never, guards),
new CollectionsRpc({ listCollections: vi.fn(() => []), getCollection: vi.fn(() => ({})), createCollection: vi.fn(() => ({})), updateCollection: vi.fn(() => ({})), savePlace: vi.fn(() => ({})), copyToTrip: vi.fn(() => ({})), deletePlace: vi.fn(() => undefined), ...overrides.collections } as never, guards),
]);
const granted = new Set([
'db:read:collab', 'db:write:collab', 'db:read:journal', 'db:write:journal',
'db:read:atlas', 'db:write:atlas', 'db:read:vacay', 'db:write:vacay',
'db:read:collections', 'db:write:collections',
]);
return new PluginRpcHost('p', granted, makeDeps(), registry);
}
/** Every user-scoped method, with the refusal it owes a job or onLoad. */
const USERLESS: Array<[string, Record<string, unknown>, string]> = [
['journal.listMine', {}, 'journal reads require an authenticated user context'],
['journal.getEntries', { journeyId: 7 }, 'journal reads require an authenticated user context'],
['journal.createEntry', { journeyId: 7, input: { entry_date: '2027-01-01' } }, 'journal writes require an authenticated user context'],
['journal.updateEntry', { entryId: 1, input: {} }, 'journal writes require an authenticated user context'],
['journal.deleteEntry', { entryId: 1 }, 'journal writes require an authenticated user context'],
['journal.createJourney', { input: { title: 'J' } }, 'journal writes require an authenticated user context'],
['journal.deleteJourney', { journeyId: 7 }, 'journal writes require an authenticated user context'],
['atlas.visited', {}, 'atlas reads require an authenticated user context'],
['atlas.bucketList', {}, 'atlas reads require an authenticated user context'],
['atlas.markCountry', { code: 'JP' }, 'atlas writes require an authenticated user context'],
['atlas.unmarkCountry', { code: 'JP' }, 'atlas writes require an authenticated user context'],
['atlas.markRegion', { regionCode: 'JP-13', countryCode: 'JP' }, 'atlas writes require an authenticated user context'],
['atlas.unmarkRegion', { regionCode: 'JP-13' }, 'atlas writes require an authenticated user context'],
['atlas.createBucketItem', { input: { name: 'K' } }, 'atlas writes require an authenticated user context'],
['atlas.deleteBucketItem', { itemId: 1 }, 'atlas writes require an authenticated user context'],
['vacay.mine', {}, 'vacay reads require an authenticated user context'],
['vacay.toggleEntry', { date: '2027-01-01' }, 'vacay writes require an authenticated user context'],
['vacay.toggleCompanyHoliday', { date: '2027-01-01' }, 'vacay writes require an authenticated user context'],
['collections.listMine', {}, 'collection reads require an authenticated user context'],
['collections.get', { id: 1 }, 'collection reads require an authenticated user context'],
['collections.create', { input: { name: 'C' } }, 'collection writes require an authenticated user context'],
['collections.update', { id: 1, input: { name: 'C' } }, 'collection writes require an authenticated user context'],
['collections.savePlace', { input: { collection_id: 1, name: 'P', lat: 1, lng: 2 } }, 'collection writes require an authenticated user context'],
['collections.copyToTrip', { input: { trip_id: 1, place_ids: [1] } }, 'collection writes require an authenticated user context'],
['collections.deletePlace', { placeId: 1 }, 'collection writes require an authenticated user context'],
['collab.createNote', { tripId: 1, input: { title: 'n' } }, 'collab note writes require an authenticated user context'],
['collab.createPoll', { tripId: 1, input: { question: 'q', options: ['a', 'b'] } }, 'collab poll writes require an authenticated user context'],
['collab.votePoll', { tripId: 1, pollId: 1, optionIndex: 0 }, 'collab poll writes require an authenticated user context'],
['collab.createMessage', { tripId: 1, text: 'hi' }, 'collab message writes require an authenticated user context'],
];
describe('addon-gated domains refuse a job or onLoad', () => {
for (const [method, params, message] of USERLESS) {
it(`ADDONERR-userless-${method}`, async () => {
const res = await build().dispatch(req(method, params), undefined);
expect(err(res).code).toBe('RESOURCE_FORBIDDEN');
expect(err(res).message).toBe(message);
});
}
});
describe('addon-gated domains validate their input', () => {
it('ADDONERR-001 collab refuses a blank note title, a thin poll and an oversized message', async () => {
const host = build();
expect(err(await host.dispatch(req('collab.createNote', { tripId: 1, input: { title: ' ' } }), 42)).message).toBe('note title is required');
expect(err(await host.dispatch(req('collab.createPoll', { tripId: 1, input: { question: ' ', options: ['a', 'b'] } }), 42)).message).toBe('poll question is required');
expect(err(await host.dispatch(req('collab.createPoll', { tripId: 1, input: { question: 'q', options: ['a'] } }), 42)).message).toBe('a poll needs at least two options');
expect(err(await host.dispatch(req('collab.createMessage', { tripId: 1, text: 'x'.repeat(4001) }), 42)).message).toBe('message text is required (max 4000 chars)');
expect(err(await host.dispatch(req('collab.createMessage', { tripId: 1, text: ' ' }), 42)).message).toBe('message text is required (max 4000 chars)');
});
it('ADDONERR-002 the collab service reports its own failures as BAD_PARAMS', async () => {
const host = build({ collab: { votePoll: vi.fn(() => ({ error: 'poll is closed' })), createMessage: vi.fn(() => ({ error: 'reply target is gone' })) } });
expect(err(await host.dispatch(req('collab.votePoll', { tripId: 1, pollId: 1, optionIndex: 0 }), 42))).toMatchObject({ code: 'BAD_PARAMS', message: 'poll is closed' });
expect(err(await host.dispatch(req('collab.createMessage', { tripId: 1, text: 'hi' }), 42))).toMatchObject({ code: 'BAD_PARAMS', message: 'reply target is gone' });
});
it('ADDONERR-003 atlas rejects a code that is empty or too long', async () => {
const host = build();
expect(err(await host.dispatch(req('atlas.markCountry', { code: '' }), 42)).message).toBe('code must be a short code');
expect(err(await host.dispatch(req('atlas.markCountry', { code: 'TOOLONGCODE' }), 42)).message).toBe('code must be a short code');
expect(err(await host.dispatch(req('atlas.markRegion', { regionCode: 'JP-13', countryCode: '' }), 42)).message).toBe('countryCode must be a short code');
expect(err(await host.dispatch(req('atlas.createBucketItem', { input: { name: ' ' } }), 42)).message).toBe('bucket item name is required');
});
it('ADDONERR-004 a missing bucket item is refused, naming it', async () => {
const host = build({ atlas: { deleteBucketItem: vi.fn(() => false) } });
expect(err(await host.dispatch(req('atlas.deleteBucketItem', { itemId: 404 }), 42)).message).toBe('no bucket item 404 for this user');
});
it('ADDONERR-005 vacay insists on an ISO date', async () => {
const host = build();
expect(err(await host.dispatch(req('vacay.toggleEntry', { date: '01.01.2027' }), 42)).message).toBe('date must be YYYY-MM-DD');
expect(err(await host.dispatch(req('vacay.toggleCompanyHoliday', { date: 42 }), 42)).message).toBe('date must be YYYY-MM-DD');
});
it('ADDONERR-006 journal needs an entry_date and a journal title', async () => {
const host = build();
expect(err(await host.dispatch(req('journal.createEntry', { journeyId: 7, input: {} }), 42)).message).toBe('entry_date is required');
expect(err(await host.dispatch(req('journal.createJourney', { input: { title: ' ' } }), 42)).message).toBe('journal title is required');
});
it('ADDONERR-007 an unreadable or uneditable journey is RESOURCE_FORBIDDEN', async () => {
const host = build({
journey: {
listEntries: vi.fn(() => null),
createEntry: vi.fn(() => null),
updateEntry: vi.fn(() => null),
deleteEntry: vi.fn(() => false),
deleteJourney: vi.fn(() => false),
},
});
expect(err(await host.dispatch(req('journal.getEntries', { journeyId: 7 }), 42)).message).toBe('no access to journey 7');
expect(err(await host.dispatch(req('journal.createEntry', { journeyId: 7, input: { entry_date: '2027-01-01' } }), 42)).message).toBe('no editable journey 7 for this user');
expect(err(await host.dispatch(req('journal.updateEntry', { entryId: 3, input: {} }), 42)).message).toBe('no editable journal entry 3 for this user');
expect(err(await host.dispatch(req('journal.deleteEntry', { entryId: 3 }), 42)).message).toBe('no editable journal entry 3 for this user');
expect(err(await host.dispatch(req('journal.deleteJourney', { journeyId: 7 }), 42)).message).toBe('no deletable journal 7 for this user');
});
it('ADDONERR-008 collections map the service status onto the RPC error taxonomy', async () => {
// 403/404 become RESOURCE_FORBIDDEN, 400/409 become BAD_PARAMS. Without this the
// plugin would see an opaque HOST_ERROR and could not tell the cases apart.
const forbidden = build({ collections: { createCollection: vi.fn(() => { throw statusError(403, 'not your collection'); }) } });
expect(err(await forbidden.dispatch(req('collections.create', { input: { name: 'C' } }), 42))).toMatchObject({ code: 'RESOURCE_FORBIDDEN', message: 'not your collection' });
const missing = build({ collections: { updateCollection: vi.fn(() => { throw statusError(404, 'no such collection'); }) } });
expect(err(await missing.dispatch(req('collections.update', { id: 1, input: { name: 'C' } }), 42))).toMatchObject({ code: 'RESOURCE_FORBIDDEN' });
const conflict = build({ collections: { savePlace: vi.fn(() => { throw statusError(409, 'already saved'); }) } });
expect(err(await conflict.dispatch(req('collections.savePlace', { input: { collection_id: 1, name: 'P', lat: 1, lng: 2 } }), 42))).toMatchObject({ code: 'BAD_PARAMS', message: 'already saved' });
const badRequest = build({ collections: { copyToTrip: vi.fn(() => { throw statusError(400, 'nothing to copy'); }) } });
expect(err(await badRequest.dispatch(req('collections.copyToTrip', { input: { trip_id: 1, place_ids: [1] } }), 42))).toMatchObject({ code: 'BAD_PARAMS' });
});
it('ADDONERR-009 an untagged collections failure stays a HOST_ERROR', async () => {
// Only the known statuses are translated; anything else keeps its own taxonomy
// rather than being dressed up as a permission problem.
const host = build({ collections: { deletePlace: vi.fn(() => { throw new Error('disk on fire'); }) } });
expect(err(await host.dispatch(req('collections.deletePlace', { placeId: 1 }), 42))).toMatchObject({ code: 'HOST_ERROR', message: 'disk on fire' });
});
it('ADDONERR-010 collections reject a payload the shared schema refuses', async () => {
const host = build();
expect(err(await host.dispatch(req('collections.create', { input: {} }), 42)).code).toBe('BAD_PARAMS');
expect(err(await host.dispatch(req('collections.update', { id: 1, input: { name: 42 } }), 42)).code).toBe('BAD_PARAMS');
expect(err(await host.dispatch(req('collections.savePlace', { input: {} }), 42)).code).toBe('BAD_PARAMS');
expect(err(await host.dispatch(req('collections.copyToTrip', { input: { trip_id: 1, place_ids: [] } }), 42)).code).toBe('BAD_PARAMS');
});
it('ADDONERR-010b an update or savePlace with only some fields still passes', async () => {
const updateCollection = vi.fn(() => ({}));
const host = build({ collections: { updateCollection } });
await host.dispatch(req('collections.update', { id: 1, input: { description: 'only this' } }), 42);
expect(updateCollection).toHaveBeenCalled();
});
it('ADDONERR-010c a journal entry update carries a non-object input through asPayload', async () => {
const updateEntry = vi.fn(() => ({ id: 1 }));
const host = build({ journey: { updateEntry } });
// asPayload wraps a non-object in { value }, which is the published contract.
await host.dispatch(req('journal.updateEntry', { entryId: 1, input: 'note' }), 42);
expect(updateEntry).toHaveBeenCalledWith(1, 42, { value: 'note' });
});
it('ADDONERR-010d a company holiday without a note passes undefined, not an empty string', async () => {
const toggleCompanyHoliday = vi.fn(() => ({}));
const host = build({ vacay: { toggleCompanyHoliday } });
await host.dispatch(req('vacay.toggleCompanyHoliday', { date: '2027-01-01' }), 42);
expect(toggleCompanyHoliday).toHaveBeenCalledWith(1, '2027-01-01', undefined, undefined);
});
it('ADDONERR-010e a collab message without a replyTo passes null', async () => {
const createMessage = vi.fn(() => ({ error: null, message: {} }));
const host = build({ collab: { createMessage } });
await host.dispatch(req('collab.createMessage', { tripId: 1, text: 'hi' }), 42);
expect(createMessage).toHaveBeenCalledWith('1', 42, 'hi', null);
await host.dispatch(req('collab.createMessage', { tripId: 1, text: 'hi', replyTo: 5 }), 42);
expect(createMessage).toHaveBeenLastCalledWith('1', 42, 'hi', 5);
});
it('ADDONERR-010f listMessages passes the before cursor only when given', async () => {
const listMessages = vi.fn(() => []);
const host = build({ collab: { listMessages } });
await host.dispatch(req('collab.listMessages', { tripId: 1 }), 42);
expect(listMessages).toHaveBeenCalledWith(1, undefined);
await host.dispatch(req('collab.listMessages', { tripId: 1, before: 9 }), 42);
expect(listMessages).toHaveBeenLastCalledWith(1, 9);
});
it('ADDONERR-011 a region without a name falls back to its code', async () => {
const markRegion = vi.fn();
const host = build({ atlas: { markRegion } });
await host.dispatch(req('atlas.markRegion', { regionCode: 'jp-13', countryCode: 'jp' }), 42);
// Codes are upper-cased on the way in, and the name defaults to the code.
expect(markRegion).toHaveBeenCalledWith(42, 'JP-13', 'jp-13', 'JP');
});
});
@@ -0,0 +1,148 @@
/**
* The addon gates of the migrated plugin surface, checked as one table.
*
* These gates used to live inside the deps factory's closure rather than in the
* router, which made them the single most likely thing to lose in the decorator
* migration: a handler that calls its service directly still works, just without the
* addon check, and neither the compiler nor the router tests would notice. The plan
* calls it out as the most probable security regression of the whole rollout.
*
* So every addon-gated method gets the same two assertions: with the addon off it is
* refused with that addon's message, and the underlying service is never touched.
*/
import { describe, it, expect, vi } from 'vitest';
import { PluginRpcHost } from '../../../src/nest/plugins/host/rpc-host';
import { createTestPluginRegistry } from '../../../src/nest/plugins/host/rpc-kit/testing';
import { PluginGuards } from '../../../src/nest/plugins/host/plugin-guards.service';
import { CollabRpc } from '../../../src/nest/collab/collab.rpc';
import { AtlasRpc } from '../../../src/nest/atlas/atlas.rpc';
import { VacayRpc } from '../../../src/nest/vacay/vacay.rpc';
import { JournalRpc } from '../../../src/nest/journey/journal.rpc';
import { CollectionsRpc } from '../../../src/nest/collections/collections.rpc';
import { CostsRpc } from '../../../src/nest/budget/costs.rpc';
import type { DatabaseService } from '../../../src/nest/database/database.service';
import type { PermissionsService } from '../../../src/nest/permissions/permissions.service';
import type { AddonsService } from '../../../src/nest/addons/addons.service';
import type { RpcRequest, RpcError } from '../../../src/nest/plugins/protocol/envelope';
import { makeDeps } from '../../helpers/rpc-host-deps';
vi.mock('../../../src/nest/trips/trips.bridge', () => ({ listTripsForUser: vi.fn(() => [{ id: 1 }]) }));
const req = (method: string, params: Record<string, unknown> = {}): RpcRequest => ({ k: 'req', id: 'x', method, params });
/** Records every service call, so "the service was never touched" is checkable. */
function spyService(calls: string[], name: string) {
return new Proxy(
{},
{
get: (_t, prop) => (...args: unknown[]) => {
calls.push(`${name}.${String(prop)}`);
// Shapes the handlers destructure on the happy path.
if (prop === 'votePoll' || prop === 'createMessage') return { error: null, poll: {}, message: {} };
if (prop === 'listEntries') return [];
if (prop === 'getActivePlanId') return 1;
if (String(prop).startsWith('delete')) return true;
if (String(prop).startsWith('list')) return [];
return { id: 1 };
},
},
) as never;
}
/** Everything granted, every trip accessible, every permission allowed, addons OFF. */
function build(addonOn: boolean) {
const calls: string[] = [];
const db = {
canAccessTrip: vi.fn(() => ({ id: 1, user_id: 42 })),
prepare: vi.fn(() => ({ get: () => ({ role: 'user' }), all: () => [] })),
} as unknown as DatabaseService;
const guards = new PluginGuards(
db,
{ checkPermission: vi.fn(() => true) } as unknown as PermissionsService,
{ isAddonEnabled: vi.fn(() => addonOn) } as unknown as AddonsService,
);
const registry = createTestPluginRegistry([
new CollabRpc(spyService(calls, 'collab'), { broadcast: vi.fn() } as never, guards),
new AtlasRpc(spyService(calls, 'atlas'), guards),
new VacayRpc(spyService(calls, 'vacay'), guards),
new JournalRpc(spyService(calls, 'journey'), guards),
new CollectionsRpc(spyService(calls, 'collections'), guards),
new CostsRpc(spyService(calls, 'budget'), db, { broadcast: vi.fn() } as never, guards),
]);
const granted = new Set([
'db:read:collab', 'db:write:collab', 'db:read:journal', 'db:write:journal',
'db:read:atlas', 'db:write:atlas', 'db:read:vacay', 'db:write:vacay',
'db:read:collections', 'db:write:collections', 'db:read:costs', 'db:write:costs',
]);
return { calls, host: new PluginRpcHost('p', granted, makeDeps(), registry) };
}
/** Every addon-gated method with a payload that reaches its gate. */
const GATED: Array<[string, Record<string, unknown>, string]> = [
['collab.listNotes', { tripId: 1 }, 'collab'],
['collab.listPolls', { tripId: 1 }, 'collab'],
['collab.listMessages', { tripId: 1 }, 'collab'],
['collab.createNote', { tripId: 1, input: { title: 'n' } }, 'collab'],
['collab.createPoll', { tripId: 1, input: { question: 'q?', options: ['a', 'b'] } }, 'collab'],
['collab.votePoll', { tripId: 1, pollId: 1, optionIndex: 0 }, 'collab'],
['collab.createMessage', { tripId: 1, text: 'hi' }, 'collab'],
['journal.listMine', {}, 'journey'],
['journal.getEntries', { journeyId: 7 }, 'journey'],
['journal.createEntry', { journeyId: 7, input: { entry_date: '2027-01-01' } }, 'journey'],
['journal.updateEntry', { entryId: 1, input: {} }, 'journey'],
['journal.deleteEntry', { entryId: 1 }, 'journey'],
['journal.createJourney', { input: { title: 'J' } }, 'journey'],
['journal.deleteJourney', { journeyId: 7 }, 'journey'],
['atlas.visited', {}, 'atlas'],
['atlas.bucketList', {}, 'atlas'],
['atlas.markCountry', { code: 'JP' }, 'atlas'],
['atlas.unmarkCountry', { code: 'JP' }, 'atlas'],
['atlas.markRegion', { regionCode: 'JP-13', countryCode: 'JP' }, 'atlas'],
['atlas.unmarkRegion', { regionCode: 'JP-13' }, 'atlas'],
['atlas.createBucketItem', { input: { name: 'Kyoto' } }, 'atlas'],
['atlas.deleteBucketItem', { itemId: 1 }, 'atlas'],
['vacay.mine', {}, 'vacay'],
['vacay.toggleEntry', { date: '2027-01-01' }, 'vacay'],
['vacay.toggleCompanyHoliday', { date: '2027-01-01' }, 'vacay'],
['collections.listMine', {}, 'collections'],
['collections.get', { id: 1 }, 'collections'],
['collections.create', { input: { name: 'C' } }, 'collections'],
['collections.update', { id: 1, input: { name: 'C' } }, 'collections'],
['collections.savePlace', { input: { collection_id: 1, name: 'P', lat: 1, lng: 2 } }, 'collections'],
['collections.copyToTrip', { input: { trip_id: 1, place_ids: [1] } }, 'collections'],
['collections.deletePlace', { placeId: 1 }, 'collections'],
['costs.getByTrip', { tripId: 1 }, 'costs'],
['costs.listMine', {}, 'costs'],
['costs.create', { tripId: 1, input: { name: 'H', price: 1 } }, 'costs'],
['costs.update', { tripId: 1, itemId: 1, input: { name: 'H' } }, 'costs'],
['costs.delete', { tripId: 1, itemId: 1 }, 'costs'],
];
describe('every addon-gated plugin method refuses when its addon is off', () => {
for (const [method, params, addon] of GATED) {
it(`ADDONGATE-${method} is refused with "the ${addon} addon is disabled"`, async () => {
const f = build(false);
const res = (await f.host.dispatch(req(method, params), 42)) as RpcError;
expect(res.ok).toBe(false);
expect(res.error.code).toBe('RESOURCE_FORBIDDEN');
expect(res.error.message).toBe(`the ${addon} addon is disabled`);
// The gate has to come before the service, not after it.
expect(f.calls).toEqual([]);
});
}
it('ADDONGATE-covers-every-gated-method', () => {
// Guards the table itself: if a later PR adds an addon-gated method without a row
// here, this number is the reminder.
expect(GATED).toHaveLength(37);
});
it('ADDONGATE-the-same-calls-succeed-with-the-addon-on', async () => {
const f = build(true);
for (const [method, params] of GATED) {
const res = await f.host.dispatch(req(method, params), 42);
expect(res.ok, `${method} should pass with the addon on`).toBe(true);
}
expect(f.calls.length).toBeGreaterThan(0);
});
});
@@ -474,32 +474,7 @@ describe('host-deps factory — planner write + metadata deps', () => {
});
});
describe('host-deps factory — reservations, day notes, cross-trip + addon reads (Waves 1-5)', () => {
const host = (...perms: string[]) => createRealRpcHost('w15', new Set(perms));
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const call = async (h: ReturnType<typeof host>, method: string, params: Record<string, unknown>, uid: number | undefined = 5): Promise<any> =>
h.dispatch({ k: 'req', id: 'x', method, params }, uid);
beforeEach(() => {
checkPermission.mockReset(); checkPermission.mockReturnValue(true);
isAddonEnabled.mockReset(); isAddonEnabled.mockReturnValue(true);
});
afterAll(() => closePluginDataDb('w15'));
// daynotes.* left this factory with the decorator migration; the cases now run in
// tests/unit/days/day-notes.rpc.test.ts against DayNotesRpc.
it('addon reads delegate, and a disabled addon is refused', async () => {
const h = host('db:read:journal', 'db:read:atlas', 'db:read:vacay', 'db:read:collections');
expect((await call(h, 'journal.listMine', {})).ok).toBe(true);
expect((await call(h, 'atlas.visited', {})).ok).toBe(true);
expect((await call(h, 'vacay.mine', {})).ok).toBe(true);
expect((await call(h, 'collections.listMine', {})).ok).toBe(true);
expect((await call(h, 'collections.get', { id: 1 })).ok).toBe(true);
isAddonEnabled.mockReturnValue(false);
expect((await call(h, 'journal.listMine', {})).error.code).toBe('RESOURCE_FORBIDDEN');
expect((await call(h, 'collections.listMine', {})).error.code).toBe('RESOURCE_FORBIDDEN');
});
});
// The 'reservations, day notes, cross-trip + addon reads' suite is gone: every case in it moved onto the decorators.
// The packing write deps left this factory with the decorator migration. The #858
// transitions are asserted in tests/unit/packing/packing.rpc.test.ts, against the
@@ -509,81 +484,9 @@ describe('host-deps factory — reservations, day notes, cross-trip + addon read
// roster and the packing bags all moved onto the decorators, so there was nothing
// left in it. Their cases live in the domain suites now.
describe('host-deps factory — Wave 2 wiring (atlas/vacay/journal/collections writes)', () => {
const host = (...perms: string[]) => createRealRpcHost('w2', new Set(perms))
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const call = async (h: ReturnType<typeof host>, method: string, params: Record<string, unknown>, uid: number | undefined = 5): Promise<any> =>
h.dispatch({ k: 'req', id: 'x', method, params }, uid)
beforeEach(() => { checkPermission.mockReset(); checkPermission.mockReturnValue(true); isAddonEnabled.mockReset(); isAddonEnabled.mockReturnValue(true) })
afterAll(() => closePluginDataDb('w2'))
// The 'Wave 2 wiring' suite is gone: every case in it moved onto the decorators.
it('atlas writes delegate uid-scoped; disabled addon refused; missing bucket item forbidden', async () => {
const h = host('db:write:atlas')
expect((await call(h, 'atlas.markCountry', { code: 'JP' })).ok).toBe(true)
expect((await call(h, 'atlas.markRegion', { regionCode: 'JP-13', countryCode: 'JP' })).ok).toBe(true)
expect((await call(h, 'atlas.unmarkRegion', { regionCode: 'JP-13' })).ok).toBe(true)
expect((await call(h, 'atlas.createBucketItem', { input: { name: 'Kyoto' } })).ok).toBe(true)
expect((await call(h, 'atlas.deleteBucketItem', { itemId: 110 })).ok).toBe(true)
expect(((await call(h, 'atlas.deleteBucketItem', { itemId: 404 })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN')
isAddonEnabled.mockReturnValue(false)
expect(((await call(h, 'atlas.markCountry', { code: 'JP' })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN')
})
it('vacay writes resolve the plan host-side from the acting user', async () => {
const h = host('db:write:vacay')
const r = await call(h, 'vacay.toggleEntry', { date: '2026-08-01' })
expect(r.ok).toBe(true)
expect(r.result).toMatchObject({ uid: 5, planId: 77 }) // uid + the user's own active plan, never a plugin-named one
expect((await call(h, 'vacay.toggleCompanyHoliday', { date: '2026-12-24' })).ok).toBe(true)
})
it('journal writes map an uneditable journey/entry to RESOURCE_FORBIDDEN', async () => {
const h = host('db:write:journal')
expect((await call(h, 'journal.createEntry', { journeyId: 1, input: { entry_date: '2026-08-01' } })).ok).toBe(true)
expect(((await call(h, 'journal.createEntry', { journeyId: 99, input: { entry_date: '2026-08-01' } })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN')
expect((await call(h, 'journal.updateEntry', { entryId: 120, input: { story: 'x' } })).ok).toBe(true)
expect(((await call(h, 'journal.updateEntry', { entryId: 99, input: {} })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN')
expect((await call(h, 'journal.deleteEntry', { entryId: 120 })).ok).toBe(true)
expect(((await call(h, 'journal.deleteEntry', { entryId: 99 })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN')
})
it('collections writes map the service 403/404 to RESOURCE_FORBIDDEN', async () => {
const h = host('db:write:collections')
expect((await call(h, 'collections.create', { input: { name: 'Tokyo eats' } })).ok).toBe(true)
expect((await call(h, 'collections.update', { id: 1, input: { name: 'Renamed' } })).ok).toBe(true)
expect(((await call(h, 'collections.update', { id: 99, input: { name: 'x' } })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN') // viewer-only 403
expect(((await call(h, 'collections.update', { id: 404, input: { name: 'x' } })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN') // invisible 404
expect((await call(h, 'collections.savePlace', { input: { collection_id: 1, name: 'Ramen' } })).ok).toBe(true)
expect((await call(h, 'collections.copyToTrip', { input: { trip_id: 1, place_ids: [101] } })).ok).toBe(true)
expect((await call(h, 'collections.deletePlace', { placeId: 101 })).ok).toBe(true)
expect(((await call(h, 'collections.deletePlace', { placeId: 404 })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN')
})
})
describe('host-deps factory — Wave 3 wiring (files write / collab / member-add)', () => {
const host = (...perms: string[]) => createRealRpcHost('w3', new Set(perms))
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const call = async (h: ReturnType<typeof host>, method: string, params: Record<string, unknown>, uid: number | undefined = 5): Promise<any> =>
h.dispatch({ k: 'req', id: 'x', method, params }, uid)
beforeEach(() => { checkPermission.mockReset(); checkPermission.mockReturnValue(true); isAddonEnabled.mockReset(); isAddonEnabled.mockReturnValue(true); broadcast.mockClear() })
afterAll(() => closePluginDataDb('w3'))
// The files write deps left this factory with the decorator migration; the cases
// now run in tests/unit/files/files.rpc.test.ts against FilesRpc.
it('collab writes delegate + broadcast; service errors map to BAD_PARAMS; addon gated', async () => {
const h = host('db:write:collab')
expect((await call(h, 'collab.createNote', { tripId: 1, input: { title: 'Ideas' } })).ok).toBe(true)
expect(broadcast.mock.calls.some((c) => c[1] === 'collab:note:created')).toBe(true)
expect((await call(h, 'collab.createPoll', { tripId: 1, input: { question: 'Where?', options: ['A', 'B'] } })).ok).toBe(true)
expect((await call(h, 'collab.votePoll', { tripId: 1, pollId: 141, optionIndex: 0 })).ok).toBe(true)
expect(((await call(h, 'collab.votePoll', { tripId: 1, pollId: 141, optionIndex: 9 })) as { error: { code: string } }).error.code).toBe('BAD_PARAMS')
expect((await call(h, 'collab.createMessage', { tripId: 1, text: 'hi' })).ok).toBe(true)
expect(((await call(h, 'collab.createMessage', { tripId: 1, text: 'toolong' })) as { error: { code: string } }).error.code).toBe('BAD_PARAMS')
isAddonEnabled.mockReturnValue(false)
expect(((await call(h, 'collab.createNote', { tripId: 1, input: { title: 'x' } })) as { error: { code: string } }).error.code).toBe('RESOURCE_FORBIDDEN')
})
})
// The 'Wave 3 wiring' suite is gone: every case in it moved onto the decorators.
describe('host-deps factory — Wave 4 wiring (notify / ai)', () => {
const host = (...perms: string[]) => createRealRpcHost('w4', new Set(perms))
+34 -2
View File
@@ -54,8 +54,8 @@ describe('plugin RPC coverage ledger', () => {
// Update these two numbers in every rollout PR. They make the diff state the size
// of the move out loud, which is the number a reviewer wants to see.
const total = KNOWN_METHODS.length + UNCONDITIONAL_METHODS.length;
expect(fromRegistry.size).toBe(61);
expect(legacy.size).toBe(total - 61);
expect(fromRegistry.size).toBe(93);
expect(legacy.size).toBe(total - 93);
});
it('RPCLEDGER-006 the migrated methods are exactly the ones this PR claims', () => {
@@ -63,7 +63,29 @@ describe('plugin RPC coverage ledger', () => {
'accommodations.create',
'accommodations.delete',
'accommodations.update',
'atlas.bucketList',
'atlas.createBucketItem',
'atlas.deleteBucketItem',
'atlas.markCountry',
'atlas.markRegion',
'atlas.unmarkCountry',
'atlas.unmarkRegion',
'atlas.visited',
'categories.list',
'collab.createMessage',
'collab.createNote',
'collab.createPoll',
'collab.listMessages',
'collab.listNotes',
'collab.listPolls',
'collab.votePoll',
'collections.copyToTrip',
'collections.create',
'collections.deletePlace',
'collections.get',
'collections.listMine',
'collections.savePlace',
'collections.update',
'costs.create',
'costs.delete',
'costs.getByTrip',
@@ -84,6 +106,13 @@ describe('plugin RPC coverage ledger', () => {
'files.update',
'itinerary.assign',
'itinerary.unassign',
'journal.createEntry',
'journal.createJourney',
'journal.deleteEntry',
'journal.deleteJourney',
'journal.getEntries',
'journal.listMine',
'journal.updateEntry',
'packing.create',
'packing.createBag',
'packing.delete',
@@ -120,6 +149,9 @@ describe('plugin RPC coverage ledger', () => {
'trips.members',
'trips.removeMember',
'trips.update',
'vacay.mine',
'vacay.toggleCompanyHoliday',
'vacay.toggleEntry',
'weather.get',
]);
});
+2 -70
View File
@@ -118,83 +118,15 @@ describe('PluginRpcHost — capability enforcement', () => {
});
// The costs, reservation and accommodation cases moved to their domain suites.
it('user-scoped addon reads (journal/atlas/vacay) need a bound user; a job is refused', async () => {
const host = new PluginRpcHost('p', new Set(['db:read:journal', 'db:read:atlas', 'db:read:vacay']), deps);
expect(ok(await host.dispatch(req('journal.listMine'), 42))).toBe(true);
expect(ok(await host.dispatch(req('atlas.visited'), 42))).toBe(true);
expect(ok(await host.dispatch(req('vacay.mine'), 42))).toBe(true);
for (const m of ['journal.listMine', 'atlas.visited', 'vacay.mine']) {
expect((await host.dispatch(req(m), undefined)).ok).toBe(false);
}
});
// The addon-gated domains moved to their own suites; addon-gates.rpc.test.ts
// covers every gate in one table.
// The daynotes cases moved to tests/unit/days/day-notes.rpc.test.ts.
it('collections reads are user-scoped and need db:read:collections + a bound user', async () => {
const host = new PluginRpcHost('p', new Set(['db:read:collections']), deps);
expect(ok(await host.dispatch(req('collections.listMine'), 42))).toBe(true);
const one = await host.dispatch(req('collections.get', { id: 1 }), 42);
expect(ok(one)).toBe(true);
expect(deps.getCollectionForUser).toHaveBeenCalledWith(42, 1);
expect((await host.dispatch(req('collections.listMine'), undefined)).ok).toBe(false);
});
// weather.get, categories.list and rates.get moved to tests/unit/plugins/tenant-free.rpc.test.ts.
// The tags cases moved to tests/unit/tags/tags.rpc.test.ts with the handlers.
it('atlas writes are uid-bound (code-validated, userless refused)', async () => {
const host = new PluginRpcHost('p', new Set(['db:write:atlas']), deps);
expect(ok(await host.dispatch(req('atlas.markCountry', { code: 'jp' }), 42))).toBe(true);
expect(deps.markCountryVisited).toHaveBeenCalledWith(42, 'JP'); // uid host-bound, code normalized
expect(ok(await host.dispatch(req('atlas.markRegion', { regionCode: 'JP-13', countryCode: 'JP' }), 42))).toBe(true);
expect(ok(await host.dispatch(req('atlas.createBucketItem', { input: { name: 'Kyoto' } }), 42))).toBe(true);
expect((await host.dispatch(req('atlas.markCountry', { code: 'JP' }), undefined)).ok).toBe(false); // no user
expect((await host.dispatch(req('atlas.markCountry', { code: 'not-a-code-way-too-long' }), 42)).ok).toBe(false);
expect((await host.dispatch(req('atlas.createBucketItem', { input: { name: '' } }), 42)).ok).toBe(false);
});
it('vacay writes validate the date and are uid-bound', async () => {
const host = new PluginRpcHost('p', new Set(['db:write:vacay']), deps);
expect(ok(await host.dispatch(req('vacay.toggleEntry', { date: '2026-08-01' }), 42))).toBe(true);
expect(deps.vacayToggleEntry).toHaveBeenCalledWith(42, '2026-08-01');
expect(ok(await host.dispatch(req('vacay.toggleCompanyHoliday', { date: '2026-12-24', note: 'Xmas' }), 42))).toBe(true);
expect((await host.dispatch(req('vacay.toggleEntry', { date: 'tomorrow' }), 42)).ok).toBe(false);
expect((await host.dispatch(req('vacay.toggleEntry', { date: '2026-08-01' }), undefined)).ok).toBe(false);
});
it('journal writes require entry_date on create and a bound user', async () => {
const host = new PluginRpcHost('p', new Set(['db:write:journal']), deps);
expect(ok(await host.dispatch(req('journal.createEntry', { journeyId: 3, input: { entry_date: '2026-08-01', story: 'x' } }), 42))).toBe(true);
expect(deps.createJournalEntry).toHaveBeenCalledWith(42, 3, expect.objectContaining({ entry_date: '2026-08-01' }));
expect((await host.dispatch(req('journal.createEntry', { journeyId: 3, input: { story: 'no date' } }), 42)).ok).toBe(false);
expect((await host.dispatch(req('journal.updateEntry', { entryId: 120, input: {} }), undefined)).ok).toBe(false);
expect(ok(await host.dispatch(req('journal.deleteEntry', { entryId: 120 }), 42))).toBe(true);
});
it('collections writes are schema-validated and uid-bound', async () => {
const host = new PluginRpcHost('p', new Set(['db:write:collections']), deps);
expect(ok(await host.dispatch(req('collections.create', { input: { name: 'Tokyo eats' } }), 42))).toBe(true);
expect(deps.createCollectionForUser).toHaveBeenCalledWith(42, expect.objectContaining({ name: 'Tokyo eats' }));
expect(ok(await host.dispatch(req('collections.deletePlace', { placeId: 7 }), 42))).toBe(true);
expect((await host.dispatch(req('collections.create', { input: { name: 'x' } }), undefined)).ok).toBe(false);
const noGrant = new PluginRpcHost('p', new Set(['db:read:collections']), deps);
expect((await noGrant.dispatch(req('collections.create', { input: { name: 'x' } }), 42)).ok).toBe(false);
});
// The files cases moved to tests/unit/files/files.rpc.test.ts with the handlers.
it('collab writes are gated by collab_edit and validate their inputs', async () => {
const host = new PluginRpcHost('p', new Set(['db:write:collab']), deps);
expect(ok(await host.dispatch(req('collab.createNote', { tripId: 1, input: { title: 'Ideas' } }), 42))).toBe(true);
expect((await host.dispatch(req('collab.createNote', { tripId: 1, input: { title: '' } }), 42)).ok).toBe(false);
expect(ok(await host.dispatch(req('collab.createPoll', { tripId: 1, input: { question: 'Where?', options: ['A', 'B'] } }), 42))).toBe(true);
expect((await host.dispatch(req('collab.createPoll', { tripId: 1, input: { question: 'Where?', options: ['A'] } }), 42)).ok).toBe(false);
expect(ok(await host.dispatch(req('collab.votePoll', { tripId: 1, pollId: 141, optionIndex: 0 }), 42))).toBe(true);
expect(ok(await host.dispatch(req('collab.createMessage', { tripId: 1, text: 'hi' }), 42))).toBe(true);
expect((await host.dispatch(req('collab.createMessage', { tripId: 1, text: '' }), 42)).ok).toBe(false);
expect(((await host.dispatch(req('collab.createNote', { tripId: 2, input: { title: 'x' } }), 42)) as RpcError).error.code).toBe('RESOURCE_FORBIDDEN');
});
it('notify.send forces the recipient to the acting user or a member trip; admin scope refused', async () => {
const host = new PluginRpcHost('p', new Set(['notify:send']), deps);
expect(ok(await host.dispatch(req('notify.send', { input: { title: 'Delay', body: 'AB123 is late', scope: 'user', targetId: 42 } }), 42))).toBe(true);