Files
TREK/server/tests/unit/plugins/plugins-proxy.test.ts
T
mauriceboe d823ac443b feat(plugins): activation, HTTP route proxy + instance settings (M2)
Wires the isolated runtime into TREK. Admins can now activate a plugin from the
panel and its HTTP routes work end to end, still behind the kill switch.

- PluginRuntimeService owns the supervisor: activate spawns the child with its
  granted permissions + decrypted instance config, deactivate kills it, status
  and errors are persisted to the plugins / plugin_error_log tables, and active
  plugins are booted on startup (OnModuleInit).
- Bidirectional RPC: the child now handles host→child invokes (routes/jobs) and
  reports its declared routes on load; the supervisor gained invoke()/routesOf().
- /api/plugins/:id/* proxy controller — a single static route that matches the
  plugin's declared routes, enforces per-route auth (auth:false routes are public
  for OAuth callbacks/webhooks), forwards only a whitelisted request view (never
  the session cookie), and strips unsafe response headers.
- Admin endpoints: POST :id/activate, POST :id/deactivate, GET/PUT :id/config —
  instance settings with secret fields encrypted (apiKeyCrypto) and masked.
- Kill switch moved to its own module so it never collides with test config mocks.

Photo/calendar hook consumers are deferred to a later slice.
2026-07-03 16:50:23 +02:00

119 lines
5.3 KiB
TypeScript

/**
* The plugin HTTP proxy (#plugins, M2): route matching, per-route auth (auth:false
* routes are public), the whitelisted request view forwarded to the child, and
* error/404 handling — all without a real fork (the runtime is faked).
*/
import { describe, it, expect, vi, beforeEach } from 'vitest';
const { pluginsEnabledMock, extractTokenMock, verifyMock } = vi.hoisted(() => ({
pluginsEnabledMock: vi.fn(() => true),
extractTokenMock: vi.fn(() => 'tok'),
verifyMock: vi.fn(() => ({ id: 5, username: 'ada', is_admin: false })),
}));
vi.mock('../../../src/nest/plugins/kill-switch', () => ({ pluginsEnabled: pluginsEnabledMock }));
vi.mock('../../../src/middleware/auth', () => ({ extractToken: extractTokenMock, verifyJwtAndLoadUser: verifyMock }));
import { PluginsProxyController } from '../../../src/nest/plugins/plugins-proxy.controller';
import type { PluginRuntimeService } from '../../../src/nest/plugins/plugin-runtime.service';
function fakeRes() {
const res = {
statusCode: 0,
headers: {} as Record<string, string>,
body: undefined as unknown,
status(c: number) { res.statusCode = c; return res; },
setHeader(k: string, v: string) { res.headers[k] = v; },
json(b: unknown) { res.body = b; return res; },
send(b: unknown) { res.body = b; return res; },
};
return res;
}
function fakeReq(method: string, sub: string, extra: Record<string, unknown> = {}) {
return { method, params: { 0: sub.replace(/^\//, '') }, query: {}, body: null, ...extra } as never;
}
function makeRuntime(over: Partial<PluginRuntimeService> = {}): PluginRuntimeService {
return {
isActive: vi.fn(() => true),
routesOf: vi.fn(() => [{ i: 0, method: 'GET', path: '/status', auth: true }]),
invoke: vi.fn(async () => ({ status: 200, headers: { 'content-type': 'application/json' }, body: '{"ok":true}' })),
...over,
} as unknown as PluginRuntimeService;
}
beforeEach(() => {
pluginsEnabledMock.mockClear().mockReturnValue(true);
verifyMock.mockClear().mockReturnValue({ id: 5, username: 'ada', is_admin: false });
extractTokenMock.mockClear().mockReturnValue('tok');
});
describe('PluginsProxyController', () => {
it('404 when the runtime is disabled', async () => {
pluginsEnabledMock.mockReturnValue(false);
const res = fakeRes();
await new PluginsProxyController(makeRuntime()).proxy('p', fakeReq('GET', '/status'), res as never);
expect(res.statusCode).toBe(404);
});
it('404 when the plugin is not active', async () => {
const res = fakeRes();
await new PluginsProxyController(makeRuntime({ isActive: vi.fn(() => false) } as never)).proxy('p', fakeReq('GET', '/status'), res as never);
expect(res.statusCode).toBe(404);
});
it('404 when no declared route matches', async () => {
const res = fakeRes();
await new PluginsProxyController(makeRuntime()).proxy('p', fakeReq('GET', '/nope'), res as never);
expect(res.statusCode).toBe(404);
});
it('401 on an auth route without a valid session', async () => {
verifyMock.mockReturnValue(null as never);
const res = fakeRes();
await new PluginsProxyController(makeRuntime()).proxy('p', fakeReq('GET', '/status'), res as never);
expect(res.statusCode).toBe(401);
});
it('forwards an authenticated request and returns the child response', async () => {
const runtime = makeRuntime();
const res = fakeRes();
await new PluginsProxyController(runtime).proxy('p', fakeReq('GET', '/status'), res as never);
expect(res.statusCode).toBe(200);
expect(res.headers['content-type']).toBe('application/json');
expect(res.body).toBe('{"ok":true}');
// the child receives only a whitelisted user view, never the token/cookie
expect(runtime.invoke).toHaveBeenCalledWith('p', 'invoke.route', expect.objectContaining({
routeId: 0,
req: expect.objectContaining({ user: { id: 5, username: 'ada', isAdmin: false } }),
}));
});
it('a public (auth:false) route skips the session check', async () => {
const runtime = makeRuntime({ routesOf: vi.fn(() => [{ i: 1, method: 'POST', path: '/webhook', auth: false }]) } as never);
const res = fakeRes();
await new PluginsProxyController(runtime).proxy('p', fakeReq('POST', '/webhook'), res as never);
expect(res.statusCode).toBe(200);
expect(extractTokenMock).not.toHaveBeenCalled();
expect(runtime.invoke).toHaveBeenCalledWith('p', 'invoke.route', expect.objectContaining({
req: expect.objectContaining({ user: null }),
}));
});
it('strips unsafe response headers from the child', async () => {
const runtime = makeRuntime({
invoke: vi.fn(async () => ({ status: 200, headers: { 'content-type': 'text/plain', 'set-cookie': 'evil=1' }, body: 'ok' })),
} as never);
const res = fakeRes();
await new PluginsProxyController(runtime).proxy('p', fakeReq('GET', '/status'), res as never);
expect(res.headers['content-type']).toBe('text/plain');
expect(res.headers['set-cookie']).toBeUndefined(); // a plugin cannot set cookies
});
it('502 when the plugin invoke throws', async () => {
const runtime = makeRuntime({ invoke: vi.fn(async () => { throw new Error('down'); }) } as never);
const res = fakeRes();
await new PluginsProxyController(runtime).proxy('p', fakeReq('GET', '/status'), res as never);
expect(res.statusCode).toBe(502);
});
});