{{ message }}
Repository navigation
Expand file tree
/
Copy pathhook-plugin-opencode2-setup.test.ts
More file actions
571 lines (544 loc) · 20 KB
/
Copy pathhook-plugin-opencode2-setup.test.ts
File metadata and controls
571 lines (544 loc) · 20 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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { mkdtempSync, rmSync, writeFileSync } from 'node:fs'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import { pathToFileURL } from 'node:url'
const { getPathMock } = vi.hoisted(() => ({
getPathMock: vi.fn<(name: string) => string>()
}))
vi.mock('electron', () => ({
app: {
getPath: getPathMock
}
}))
import { _internals } from './hook-service'
// Execute the generated module against legacy and current plugin contracts.
describe.each(['opencode', 'opencode2'] as const)('%s plugin on OpenCode 2', (agent) => {
type PostBody = { payload?: unknown }
function record(value: unknown): Record<string, unknown> | undefined {
return typeof value === 'object' && value !== null
? Object.fromEntries(Object.entries(value))
: undefined
}
function payload(body: PostBody): Record<string, unknown> {
return record(body.payload) ?? {}
}
type PluginHooks = {
event: (input: { event: unknown }) => Promise<void>
dispose?: () => Promise<void>
}
type PluginModule = {
default?: {
id?: unknown
server?: (ctx: unknown) => Promise<PluginHooks>
setup?: (ctx: unknown) => Promise<() => Promise<void>>
}
OrcaOpenCodeStatusPlugin?: (ctx: unknown) => Promise<PluginHooks>
}
// Why: the plugin resolves hook coords from the endpoint file first and only then from
// env. Pin every input here so the run does not depend on the developer's Orca session
// (an inherited ORCA_AGENT_HOOK_ENDPOINT would otherwise redirect the post to a live app).
const ENV_KEYS = [
'ORCA_PANE_KEY',
'ORCA_OPENCODE_AGENT',
'ORCA_OPENCODE_PLUGIN_API',
'ORCA_AGENT_HOOK_ENDPOINT',
'ORCA_AGENT_HOOK_PORT',
'ORCA_AGENT_HOOK_TOKEN'
] as const
let tempDir: string
let savedFetch: typeof globalThis.fetch
let savedEnv: Record<string, string | undefined>
beforeEach(() => {
tempDir = mkdtempSync(join(tmpdir(), 'orca-opencode-plugin-contract-'))
savedFetch = globalThis.fetch
savedEnv = {}
for (const key of ENV_KEYS) {
savedEnv[key] = process.env[key]
}
process.env.ORCA_OPENCODE_AGENT = agent
process.env.ORCA_OPENCODE_PLUGIN_API = 'v2'
delete process.env.ORCA_AGENT_HOOK_ENDPOINT
process.env.ORCA_AGENT_HOOK_PORT = '59999'
process.env.ORCA_AGENT_HOOK_TOKEN = 'test-token'
})
afterEach(() => {
globalThis.fetch = savedFetch
for (const key of ENV_KEYS) {
if (savedEnv[key] === undefined) {
delete process.env[key]
} else {
process.env[key] = savedEnv[key]
}
}
rmSync(tempDir, { recursive: true, force: true })
})
async function loadPluginModule(
source = _internals.getOpenCodePluginSource()
): Promise<PluginModule> {
// Why: a unique basename per load defeats the ESM module cache between cases.
const pluginPath = join(
tempDir,
`orca-opencode-status-${Math.random().toString(36).slice(2)}.mjs`
)
writeFileSync(pluginPath, source)
// oxlint-disable-next-line typescript/consistent-type-assertions -- SAFETY: Runtime validation or the local test fixture establishes the asserted shape.
return (await import(pathToFileURL(pluginPath).href)) as PluginModule
}
it('does not register hooks for the other pane variant', async () => {
process.env.ORCA_OPENCODE_AGENT = agent === 'opencode' ? 'opencode2' : 'opencode'
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
const hook = vi.fn()
const subscribe = vi.fn()
const cleanup = await module.default?.setup?.({ session: { hook }, event: { subscribe } })
expect(hook).not.toHaveBeenCalled()
expect(subscribe).not.toHaveBeenCalled()
await cleanup?.()
})
it('fails open when setup is probed without a usable context', async () => {
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
// Why: OpenCode probes setup() during startup, and the setup API shape can
// drift between releases. A throw surfaces as a plugin failed error in the
// TUI, so every shape must resolve to a callable cleanup instead.
const contexts: unknown[] = [
undefined,
{},
{ session: {} },
{ session: { hook: vi.fn() }, event: {} }
]
for (const ctx of contexts) {
const cleanup = await module.default?.setup?.(ctx)
expect(cleanup).toBeTypeOf('function')
await cleanup?.()
}
})
it('disposes cleanly when the prompt hook returns nothing to dispose', async () => {
process.env.ORCA_PANE_KEY = 'tab-1:leaf-1'
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
const cleanup = await module.default?.setup?.({
session: {
get: async ({ sessionID }: { sessionID: string }) => ({ data: { id: sessionID } }),
hook: async () => undefined
},
event: {
subscribe: async function* () {}
}
})
expect(cleanup).toBeTypeOf('function')
await cleanup?.()
})
it('exposes a distinct plugin id per agent variant', async () => {
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
// Why: both plugin files share one config dir, so distinct ids keep the
// loader from reporting a duplicate-id collision as a plugin failure.
expect(module.default?.id).toBe(
agent === 'opencode2' ? 'orca-opencode2-status' : 'orca-opencode-status'
)
})
it('subscribes through the OpenCode 2 setup API and disposes its registrations', async () => {
process.env.ORCA_PANE_KEY = 'tab-1:leaf-1'
const posts: unknown[] = []
globalThis.fetch = vi.fn(async (_input, init) => {
posts.push(JSON.parse(String(init?.body)))
return new Response('{}', { status: 200 })
})
const dispose = vi.fn()
let subscriptionSignal: AbortSignal | undefined
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
expect(module.default?.setup).toBeTypeOf('function')
const cleanup = await module.default?.setup?.({
session: {
get: async ({ sessionID }: { sessionID: string }) => ({ data: { id: sessionID } }),
hook: async () => ({ dispose })
},
event: {
subscribe: async function* ({ signal }: { signal: AbortSignal }) {
subscriptionSignal = signal
yield { type: 'session.created', data: { sessionID: 'ses_root' } }
yield {
type: 'session.execution.started',
data: { sessionID: 'ses_root' }
}
yield {
type: 'session.execution.succeeded',
data: { sessionID: 'ses_root' }
}
}
}
})
await vi.waitFor(() => {
expect(posts).toEqual(
expect.arrayContaining([
expect.objectContaining({
opencodeMajor: 2,
payload: expect.objectContaining({ hook_event_name: 'SessionBusy' })
}),
expect.objectContaining({
payload: expect.objectContaining({ hook_event_name: 'SessionIdle' })
})
])
)
})
expect(globalThis.fetch).toHaveBeenCalledWith(
`http://127.0.0.1:59999/hook/${agent}`,
expect.objectContaining({ method: 'POST' })
)
await cleanup?.()
expect(dispose).toHaveBeenCalledOnce()
expect(subscriptionSignal?.aborted).toBe(true)
})
// Why: the host's OpenCode 1 session binder must stay off OpenCode 2 posts only.
it('declares no OpenCode major on posts from the OpenCode 1 server() entry', async () => {
process.env.ORCA_PANE_KEY = 'tab-1:leaf-1'
const bodies: Record<string, unknown>[] = []
globalThis.fetch = vi.fn(async (_input, init) => {
bodies.push(record(JSON.parse(String(init?.body))) ?? {})
return new Response('{}', { status: 200 })
})
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
const hooks = await module.default?.server?.({
client: { session: { get: async () => ({ data: { id: 'ses_root' } }) } }
})
await hooks?.event({
event: {
type: 'session.status',
properties: { sessionID: 'ses_root', status: { type: 'busy' } }
}
})
await vi.waitFor(() => expect(bodies.length).toBeGreaterThan(0))
expect(bodies.filter((body) => 'opencodeMajor' in body)).toEqual([])
await hooks?.dispose?.()
})
it('maps permission, form, and text events through the live setup bridge', async () => {
process.env.ORCA_PANE_KEY = 'tab-1:leaf-1'
const posts: { body: PostBody }[] = []
globalThis.fetch = vi.fn(async (_input, init) => {
posts.push({ body: record(JSON.parse(String(init?.body))) ?? {} })
return new Response('{}', { status: 200 })
})
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
const cleanup = await module.default?.setup?.({
session: {
get: async ({ sessionID }: { sessionID: string }) => ({ data: { id: sessionID } }),
hook: async () => ({ dispose: vi.fn() })
},
event: {
subscribe: async function* () {
yield {
type: 'permission.asked',
data: { id: 'perm-1', sessionID: 'ses_root', action: 'bash', resources: ['pwd'] }
}
yield {
type: 'permission.replied',
data: { id: 'perm-1', requestID: 'perm-1', sessionID: 'ses_root' }
}
yield {
type: 'form.created',
data: {
form: {
id: 'form-1',
sessionID: 'ses_root',
title: 'Pick',
metadata: { kind: 'question', tool: { messageID: 'msg-0', id: 'tool-0' } },
fields: [
{
title: 'Color',
description: 'Choose',
type: 'string',
options: [{ label: 'Red', value: 'red' }]
}
]
}
}
}
yield {
type: 'session.text.started',
data: { sessionID: 'ses_root', assistantMessageID: 'msg-1' }
}
yield {
type: 'session.text.delta',
data: { sessionID: 'ses_root', assistantMessageID: 'msg-1', delta: 'hello' }
}
yield {
type: 'session.text.ended',
data: { sessionID: 'ses_root', assistantMessageID: 'msg-1', text: 'hello' }
}
yield { type: 'form.cancelled', data: { id: 'form-1', sessionID: 'ses_root' } }
}
}
})
await vi.waitFor(() => {
const names = posts.map(({ body }) => payload(body).hook_event_name)
expect(names).toEqual(expect.arrayContaining(['PermissionRequest', 'MessagePart']))
})
await vi.waitFor(() => {
const names = posts.map(({ body }) => payload(body).hook_event_name)
expect(names).toContain('AskUserQuestion')
expect(posts).toEqual(
expect.arrayContaining([
expect.objectContaining({
body: expect.objectContaining({
payload: expect.objectContaining({
hook_event_name: 'AskUserQuestion',
sessionID: 'ses_root'
})
})
})
])
)
})
await vi.waitFor(() => {
const names = posts.map(({ body }) => payload(body).hook_event_name)
expect(names.at(-1)).toBe('SessionIdle')
})
await cleanup?.()
})
// Why: OpenCode 2 raises one form primitive for several producers, and its owner
// id — not its metadata — decides whether Orca can ever retire the blocker
// (v2.0.12 capture in docs/bug-reproductions/opencode2-form-created-kinds).
async function runSetupBridge(
events: { type: string; data: Record<string, unknown> }[]
): Promise<{ names: string[]; cleanup?: () => Promise<void> }> {
process.env.ORCA_PANE_KEY = 'tab-1:leaf-1'
const names: string[] = []
globalThis.fetch = vi.fn(async (_input, init) => {
names.push(String(payload(record(JSON.parse(String(init?.body))) ?? {}).hook_event_name))
return new Response('{}', { status: 200 })
})
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
const cleanup = await module.default?.setup?.({
session: {
get: async ({ sessionID }: { sessionID: string }) => ({ data: { id: sessionID } }),
hook: async () => ({ dispose: vi.fn() })
},
event: {
subscribe: async function* () {
for (const event of events) {
yield event
}
}
}
})
return { names, cleanup }
}
function questionForm(id: string): Record<string, unknown> {
return {
id,
sessionID: 'ses_root',
title: 'Questions',
metadata: { kind: 'question', tool: { messageID: 'msg-0', id: 'tool-0' } },
fields: [{ key: 'q0', title: 'Proceed?', type: 'string', options: [] }]
}
}
it('ignores a form owned by the non-session elicitation sentinel', async () => {
const { names, cleanup } = await runSetupBridge([
{ type: 'session.execution.started', data: { sessionID: 'ses_root' } },
{
type: 'form.created',
data: {
form: {
id: 'form-mcp',
sessionID: 'global',
title: 'server is requesting input',
metadata: { kind: 'mcp-elicitation', server: 'server' },
fields: [{ key: 'elicitation', title: 'Input', type: 'string', options: [] }]
}
}
},
{ type: 'form.cancelled', data: { id: 'form-mcp', sessionID: 'global' } },
{ type: 'session.execution.succeeded', data: { sessionID: 'ses_root' } }
])
await vi.waitFor(() => {
expect(names.at(-1)).toBe('SessionIdle')
})
expect(names).not.toContain('AskUserQuestion')
await cleanup?.()
})
// Why: metadata is optional in OpenCode's schema and its kind is a convention,
// so any session-owned form must block rather than silently disappear.
it.each([
['no metadata at all', undefined],
['metadata without a kind', { server: 'server' }],
['an unrecognised kind', { kind: 'some.future.kind' }],
['the web search provider picker', { kind: 'websearch.provider' }]
])('blocks the pane on a session-owned form with %s', async (_label, metadata) => {
const { names, cleanup } = await runSetupBridge([
{ type: 'session.execution.started', data: { sessionID: 'ses_root' } },
{
type: 'form.created',
data: {
form: {
id: 'form-unknown',
sessionID: 'ses_root',
title: 'Choose a web search provider',
...(metadata === undefined ? {} : { metadata }),
fields: [{ key: 'provider', title: 'Provider', type: 'string', options: [] }]
}
}
}
])
await vi.waitFor(() => {
expect(names).toContain('AskUserQuestion')
})
expect(names.at(-1)).toBe('AskUserQuestion')
await cleanup?.()
})
it.each(['form.replied', 'form.cancelled'])(
'retires an admitted unknown-kind blocker on %s',
async (resolution) => {
const { names, cleanup } = await runSetupBridge([
{ type: 'session.execution.started', data: { sessionID: 'ses_root' } },
{
type: 'form.created',
data: {
form: {
id: 'form-unknown',
sessionID: 'ses_root',
title: 'Web Search',
fields: [{ key: 'choice', title: 'Allow?', type: 'string', options: [] }]
}
}
},
{ type: resolution, data: { id: 'form-unknown', sessionID: 'ses_root' } },
{ type: 'session.execution.succeeded', data: { sessionID: 'ses_root' } }
])
await vi.waitFor(() => {
expect(names).toContain('AskUserQuestion')
expect(names.at(-1)).toBe('SessionIdle')
})
await cleanup?.()
}
)
it('still blocks on a real question form and retires it on reply', async () => {
const { names, cleanup } = await runSetupBridge([
{ type: 'session.execution.started', data: { sessionID: 'ses_root' } },
{ type: 'form.created', data: { form: questionForm('form-q') } },
{
type: 'form.replied',
data: { id: 'form-q', sessionID: 'ses_root', answer: { q0: 'Yes' } }
},
{ type: 'session.execution.succeeded', data: { sessionID: 'ses_root' } }
])
await vi.waitFor(() => {
expect(names).toContain('AskUserQuestion')
expect(names.at(-1)).toBe('SessionIdle')
})
await cleanup?.()
})
it('keeps a live question blocker while an ignored form is raised and resolved', async () => {
const { names, cleanup } = await runSetupBridge([
{ type: 'session.execution.started', data: { sessionID: 'ses_root' } },
{ type: 'form.created', data: { form: questionForm('form-q') } },
{
type: 'form.created',
data: {
form: {
id: 'form-mcp',
sessionID: 'global',
title: 'server is requesting input',
metadata: { kind: 'mcp-elicitation', server: 'server' },
fields: [{ key: 'elicitation', title: 'Input', type: 'string', options: [] }]
}
}
},
{ type: 'form.cancelled', data: { id: 'form-mcp', sessionID: 'global' } }
])
await vi.waitFor(() => {
expect(names).toContain('AskUserQuestion')
})
expect(names.at(-1)).toBe('AskUserQuestion')
await cleanup?.()
})
it.each(['waiting', 'idle', 'disposed'])(
'drops an admitted prompt overtaken by %s',
async (transition) => {
process.env.ORCA_PANE_KEY = 'tab-1:leaf-1'
const posts: unknown[] = []
globalThis.fetch = vi.fn(async (_input, init) => {
posts.push(JSON.parse(String(init?.body)))
return new Response('{}', { status: 200 })
})
let releaseLookup: (value: { data: { id: string } }) => void = () => {}
const lookup = new Promise<{ data: { id: string } }>((resolve) => {
releaseLookup = resolve
})
const module = await loadPluginModule(
agent === 'opencode2'
? _internals.getOpenCode2PluginSource()
: _internals.getOpenCodePluginSource()
)
const hooks = await module.default?.server?.({ client: { session: { get: () => lookup } } })
expect(hooks).toBeDefined()
const prompt = hooks?.event({
event: {
type: 'session.next.prompt.admitted',
properties: {
sessionID: 'ses_root',
messageID: 'msg_user',
prompt: { text: 'stale prompt' }
}
}
})
if (transition === 'disposed') {
await hooks?.dispose?.()
} else {
// Seed ancestry while the earlier prompt lookup remains suspended.
await hooks?.event({
event: { type: 'session.created', properties: { info: { id: 'ses_root' } } }
})
await hooks?.event({
event:
transition === 'waiting'
? {
type: 'permission.asked',
properties: {
id: 'perm_1',
sessionID: 'ses_root',
permission: 'bash',
patterns: ['sleep 25']
}
}
: { type: 'session.idle', properties: { sessionID: 'ses_root' } }
})
}
releaseLookup({ data: { id: 'ses_root' } })
await prompt
expect(posts).not.toContainEqual(
expect.objectContaining({ payload: expect.objectContaining({ role: 'user' }) })
)
await hooks?.dispose?.()
}
)
})
You can’t perform that action at this time.