-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathplugin-manager.test.ts
More file actions
427 lines (367 loc) · 14 KB
/
Copy pathplugin-manager.test.ts
File metadata and controls
427 lines (367 loc) · 14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
import { afterEach, describe, expect, test } from 'bun:test';
import { existsSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs';
import { join } from 'node:path';
import { Context } from 'cordis';
import { ConfigService, type GatewayConfig } from './config.js';
import { ContractsService } from './contracts.js';
import { PluginManagerService } from './plugin-manager.js';
import type { PluginDatabase, PluginRegistryEntry } from '@tradinggoose/db';
const TEMP_DIRS: string[] = [];
function makeTempDir(): string {
const dir = mkdtempSync(join(process.cwd(), '.tmp-tradinggoose-plugin-manager-'));
TEMP_DIRS.push(dir);
return dir;
}
function writePlugin(pluginDir: string, name: string, source = 'export default function plugin() {}'): string {
const dir = join(pluginDir, name);
mkdirSync(dir, { recursive: true });
writeFileSync(join(dir, 'index.ts'), source);
writeFileSync(
join(dir, 'manifest.ts'),
`
export const manifest = {
id: '${name}',
displayName: '${name}',
version: '0.1.0',
description: '${name} plugin.',
provides: [],
consumes: [],
};
`,
);
return dir;
}
function writeManifest(pluginPath: string, source: string): void {
writeFileSync(join(pluginPath, 'manifest.ts'), source);
}
function makeConfig(rootDir: string, overrides: Partial<GatewayConfig> = {}): GatewayConfig {
return {
databaseUrl: 'postgresql://example.test:5432/gateway',
databaseMode: 'postgres',
embeddedPostgresDataDir: join(rootDir, 'data', '_gateway', 'postgres'),
embeddedPostgresPort: 54329,
logLevel: 'debug',
pluginDir: join(rootDir, 'plugins'),
dataDir: join(rootDir, 'data'),
...overrides,
};
}
async function withMutedConsole<T>(fn: () => Promise<T> | T): Promise<T> {
const originalLog = console.log;
const originalWarn = console.warn;
const originalError = console.error;
console.log = (() => {}) as typeof console.log;
console.warn = (() => {}) as typeof console.warn;
console.error = (() => {}) as typeof console.error;
try {
return await fn();
} finally {
console.log = originalLog;
console.warn = originalWarn;
console.error = originalError;
}
}
function mockDb() {
const plugins: PluginRegistryEntry[] = [];
const schemas = new Set<string>();
const activities: string[] = [];
const errors: unknown[] = [];
return {
_plugins: plugins,
_schemas: schemas,
_activities: activities,
_errors: errors,
async getEnabledPlugins() {
return plugins.filter((plugin) => plugin.enabled);
},
async getAllPlugins() {
return [...plugins];
},
async getPlugin(name: string) {
return plugins.find((plugin) => plugin.name === name) ?? null;
},
async registerPlugin(name: string, source: string) {
const existing = plugins.find((plugin) => plugin.name === name);
if (existing) {
existing.source = source;
existing.enabled = true;
} else {
plugins.push({
name,
source,
enabled: true,
installed_at: new Date().toISOString(),
updated_at: new Date().toISOString(),
});
}
},
async unregisterPlugin(name: string) {
const index = plugins.findIndex((plugin) => plugin.name === name);
if (index !== -1) plugins.splice(index, 1);
},
async setPluginEnabled(name: string, enabled: boolean) {
const existing = plugins.find((plugin) => plugin.name === name);
if (existing) existing.enabled = enabled;
},
async createPluginSchema(name: string) {
schemas.add(name);
},
async dropPluginSchema(name: string) {
schemas.delete(name);
},
async runPluginMigrations() {},
createPluginDb(name: string) {
return {
schema: name.replace(/[^a-zA-Z0-9_]/g, '_'),
drizzle() {
return {} as any;
},
} as PluginDatabase;
},
async logActivity(input: { action: string }) {
activities.push(input.action);
},
async logEvent() {},
async logError(input: unknown) {
errors.push(input);
},
};
}
async function createManagerHarness() {
const rootDir = makeTempDir();
const pluginDir = join(rootDir, 'plugins');
const dataDir = join(rootDir, 'data');
writePlugin(pluginDir, 'example');
const config = makeConfig(rootDir, { pluginDir, dataDir });
const db = mockDb();
await db.registerPlugin('example', 'github:user/example');
const ctx = new Context();
await ctx.plugin(ConfigService, config);
ctx.provide('dbRoot', db as any);
await ctx.plugin(ContractsService);
await ctx.plugin(PluginManagerService, config);
return { ctx, db, config };
}
afterEach(() => {
for (const dir of TEMP_DIRS.splice(0)) {
rmSync(dir, { recursive: true, force: true });
}
delete (globalThis as { __tgSequence?: string[] }).__tgSequence;
});
describe('PluginManagerService', () => {
test('loads boot plugins and reports user plugin state', async () => {
const { ctx } = await createManagerHarness();
const loaded = await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
expect(loaded.some((plugin) => plugin.name === 'example' && !plugin.bootstrap)).toBe(true);
const info = await ctx.pluginManager.getInfo('example');
expect(info).toMatchObject({
name: 'example',
enabled: true,
running: true,
bootstrap: false,
});
});
test('disable and enable update registry state and running state', async () => {
const { ctx, db } = await createManagerHarness();
await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
await withMutedConsole(() => ctx.pluginManager.disable('example'));
expect(db._plugins.find((plugin) => plugin.name === 'example')?.enabled).toBe(false);
expect((await ctx.pluginManager.getInfo('example'))?.running).toBe(false);
await withMutedConsole(() => ctx.pluginManager.enable('example'));
expect(db._plugins.find((plugin) => plugin.name === 'example')?.enabled).toBe(true);
expect((await ctx.pluginManager.getInfo('example'))?.running).toBe(true);
});
test('soft uninstall removes files and registry but preserves schema', async () => {
const { ctx, db, config } = await createManagerHarness();
await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
const result = await withMutedConsole(() => ctx.pluginManager.uninstall('example', { keepData: true }));
expect(result).toMatchObject({ success: true, restartRequired: true });
expect(db._plugins).toEqual([]);
expect(db._schemas.has('example')).toBe(true);
expect(existsSync(join(config.pluginDir, 'example'))).toBe(false);
expect(existsSync(join(config.dataDir, 'example'))).toBe(false);
});
test('disabling one plugin leaves unrelated plugins active', async () => {
const rootDir = makeTempDir();
const pluginDir = join(rootDir, 'plugins');
const dataDir = join(rootDir, 'data');
writePlugin(pluginDir, 'alpha');
writePlugin(pluginDir, 'bravo');
const config = makeConfig(rootDir, { pluginDir, dataDir });
const db = mockDb();
await db.registerPlugin('alpha', 'github:user/alpha');
await db.registerPlugin('bravo', 'github:user/bravo');
const ctx = new Context();
await ctx.plugin(ConfigService, config);
ctx.provide('dbRoot', db as any);
await ctx.plugin(ContractsService);
await ctx.plugin(PluginManagerService, config);
await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
await withMutedConsole(() => ctx.pluginManager.disable('alpha'));
await Bun.sleep(0);
expect((await ctx.pluginManager.getInfo('alpha'))?.running).toBe(false);
expect((await ctx.pluginManager.getInfo('bravo'))?.running).toBe(true);
});
test('hard inject activates after a later plugin provides the service', async () => {
const rootDir = makeTempDir();
const pluginDir = join(rootDir, 'plugins');
const dataDir = join(rootDir, 'data');
writePlugin(
pluginDir,
'alpha-consumer',
`
export const inject = ['demoService'];
export default function plugin(ctx: any) {
(globalThis as any).__tgSequence ??= [];
const service = ctx.get('demoService');
(globalThis as any).__tgSequence.push(\`consumer:\${service?.ping?.()}\`);
}
`,
);
writePlugin(
pluginDir,
'zeta-provider',
`
export default function plugin(ctx: any) {
(globalThis as any).__tgSequence ??= [];
(globalThis as any).__tgSequence.push('provider');
ctx.provide('demoService', { ping: () => 'ok' });
}
`,
);
const config = makeConfig(rootDir, { pluginDir, dataDir });
const db = mockDb();
await db.registerPlugin('alpha-consumer', 'github:user/alpha-consumer');
await db.registerPlugin('zeta-provider', 'github:user/zeta-provider');
(globalThis as { __tgSequence?: string[] }).__tgSequence = [];
const ctx = new Context();
await ctx.plugin(ConfigService, config);
ctx.provide('dbRoot', db as any);
await ctx.plugin(ContractsService);
await ctx.plugin(PluginManagerService, config);
await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
expect((globalThis as { __tgSequence?: string[] }).__tgSequence).toEqual([
'provider',
'consumer:ok',
]);
expect((await ctx.pluginManager.getInfo('alpha-consumer'))?.state).toBe('active');
expect((await ctx.pluginManager.getInfo('alpha-consumer'))?.running).toBe(true);
delete (globalThis as { __tgSequence?: string[] }).__tgSequence;
});
test('plugin remains pending when a required injected service never appears', async () => {
const rootDir = makeTempDir();
const pluginDir = join(rootDir, 'plugins');
const dataDir = join(rootDir, 'data');
writePlugin(
pluginDir,
'needs-service',
`
export const inject = ['missingService'];
export default function plugin() {}
`,
);
const config = makeConfig(rootDir, { pluginDir, dataDir });
const db = mockDb();
await db.registerPlugin('needs-service', 'github:user/needs-service');
const ctx = new Context();
await ctx.plugin(ConfigService, config);
ctx.provide('dbRoot', db as any);
await ctx.plugin(ContractsService);
await ctx.plugin(PluginManagerService, config);
await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
expect((await ctx.pluginManager.getInfo('needs-service'))).toMatchObject({
running: false,
state: 'pending',
});
});
test('ctx.inject supports lazy binding when a provider appears later', async () => {
const rootDir = makeTempDir();
const pluginDir = join(rootDir, 'plugins');
const dataDir = join(rootDir, 'data');
writePlugin(
pluginDir,
'alpha-consumer',
`
export default function plugin(ctx: any) {
(globalThis as any).__tgSequence ??= [];
(globalThis as any).__tgSequence.push('consumer:start');
ctx.inject(['demoService'], (readyCtx: any) => {
(globalThis as any).__tgSequence.push(\`consumer:bound:\${readyCtx.get('demoService')?.ping?.()}\`);
});
}
`,
);
writePlugin(
pluginDir,
'zeta-provider',
`
export default function plugin(ctx: any) {
(globalThis as any).__tgSequence ??= [];
(globalThis as any).__tgSequence.push('provider');
ctx.provide('demoService', { ping: () => 'ok' });
}
`,
);
const config = makeConfig(rootDir, { pluginDir, dataDir });
const db = mockDb();
await db.registerPlugin('alpha-consumer', 'github:user/alpha-consumer');
await db.registerPlugin('zeta-provider', 'github:user/zeta-provider');
(globalThis as { __tgSequence?: string[] }).__tgSequence = [];
const ctx = new Context();
await ctx.plugin(ConfigService, config);
ctx.provide('dbRoot', db as any);
await ctx.plugin(ContractsService);
await ctx.plugin(PluginManagerService, config);
await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
await Bun.sleep(0);
expect((globalThis as { __tgSequence?: string[] }).__tgSequence).toEqual([
'consumer:start',
'provider',
'consumer:bound:ok',
]);
delete (globalThis as { __tgSequence?: string[] }).__tgSequence;
});
test('plugin info reports manifest capabilities and runtime contract registrations', async () => {
const { ctx } = await createManagerHarness();
await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
ctx.contracts.register({
contract: 'llm.chat/v1',
plugin: 'example',
implementationId: 'chat',
implementation: { name: 'openai' },
priority: 10,
});
await Bun.sleep(0);
const info = await ctx.pluginManager.getInfo('example');
expect(info?.provides).toEqual([]);
expect(info?.registeredContracts).toEqual(['llm.chat/v1']);
});
test('plugin manager methods work from a plugin child context with dbRoot isolated', async () => {
const rootDir = makeTempDir();
const pluginDir = join(rootDir, 'plugins');
const dataDir = join(rootDir, 'data');
writePlugin(
pluginDir,
'observer',
`
export const inject = ['pluginManager'];
export default async function plugin(ctx: any) {
(globalThis as any).__tgPluginList = await ctx.pluginManager.list();
}
`,
);
const config = makeConfig(rootDir, { pluginDir, dataDir });
const db = mockDb();
await db.registerPlugin('observer', 'github:user/observer');
const ctx = new Context();
await ctx.plugin(ConfigService, config);
ctx.provide('dbRoot', db as any);
await ctx.plugin(ContractsService);
await ctx.plugin(PluginManagerService, config);
await withMutedConsole(() => ctx.pluginManager.loadBootPlugins());
const listed = (globalThis as { __tgPluginList?: Array<{ name: string }> }).__tgPluginList ?? [];
expect(Array.isArray(listed)).toBe(true);
expect((await ctx.pluginManager.getInfo('observer'))?.running).toBe(true);
delete (globalThis as { __tgPluginList?: Array<{ name: string }> }).__tgPluginList;
});
});