Files
orca/src/main/plugins/plugin-worker-supervision.integration.test.ts
T
NeilandOrca 97e4776dfe feat(plugins): Orca plugin system — kernel, content packs, panels, workers, marketplace v0 (experimental) (#8549)
* feat(plugins): Orca plugin system — kernel, content packs, panels, workers, marketplace v0 (experimental)

Adds Orca's experimental plugin system behind a settings flag: a
supervised kernel, declarative content packs (VM recipes, commands and
keybindings, language packs), sandboxed iframe panels, forked worker
hosts, and a Git-backed marketplace v0 with consent, provenance and
kill-list enforcement.

Theme, icon-theme and terminal-theme contributions are deferred to a
follow-up pass.

* fix(plugins): make unsupported marketplace listings unreachable by key

findPlugin() backs preview/install/previewInstalledUpdate via
requireListing(), so filtering only listPlugins() hid the catalog card
while leaving the dead install path reachable one click later.

* fix(plugins): fan Pi session-only status out to plugin subscribers

The providerSessionOnly early-return in applyNormalizedStatus emitted to
onAgentStatus (main-window fanout) but skipped enrichedStatusListeners, so
plugins subscribed to agent.status.changed silently missed every Pi
session_start event. Route both emit sites through one helper so a future
early return cannot drop the plugin tap again.

Co-authored-by: Orca <help@stably.ai>

* plugins: drop dead code and hoist duplicated trust-boundary patterns

Cleanup pass over the P1 diff, no behavior change:

- Delete `readPluginTreeSnapshot`/`readSnapshotFile` and their types, plus
  the now-vestigial `directories`/`signal` plumbing in `collectFiles`.
- Delete `resolveContainedPluginDirectory` (no callers).
- Delete `plugin-content-load-pool.ts`; it reimplemented the existing
  `mapWithConcurrency`, whose index arg also removes the pairing wrapper
  in `buildPluginList`.
- Hoist `PLUGIN_CONTENT_HASH_PATTERN` and `PLUGIN_COMMIT_PATTERN` into
  the install-lockfile module; 11 sites hand-rolled these identically.
- Point the new reliability gate at the PR instead of gitignored docs
  paths, matching every other gate's link form.

* fix(plugins): retry plugin state renames on Windows AV/EPERM locks

Six plugin write paths (lockfile, provenance, current pointer, kill
list, marketplace cache, staged install dir) did a plain rename, so an
antivirus or indexer holding the target open surfaced as a failed
install. The repo already retries this hazard for issue #1507, but only
through a sync helper; these paths are all async.

Adds one bounded async retry + atomic write used by all six, and trims a
consent-provenance header that restated its own JSX.

* test(plugins): cover the Windows rename retry path

The retry loop shipped untested: both existing cases hit the non-retry path,
and the temp-cleanup test passed identically with the `finally` removed.
Mock `rename` to queue errno codes so CI can exercise locks it cannot provoke.

Co-authored-by: Orca <help@stably.ai>

* fix(plugins): pin bundled plugin resources to LF

Windows CI checks out with autocrlf, so the byte-hashed launch tree arrived
as CRLF and verify-packaged-plugin-resources rejected it — the packaged build
could never pass on Windows. Reproduced locally: CRLF yields the exact CI
error, LF verifies clean. Files are already LF, so nothing renormalizes.

Co-authored-by: Orca <help@stably.ai>

* test: guard the bundled-plugin LF pin against a CRLF checkout

The byte-hash mismatch only surfaced in Windows packaging CI. Assert the
.gitattributes pin and that a CRLF tree is rejected, so a regression fails
on any platform instead of waiting for a packaged Windows build.

Co-authored-by: Orca <help@stably.ai>

* ci: trigger packaged-build check on bundled plugin resource changes

The launch tree is byte-hashed during packaging, but no trigger path covered
it — so the CRLF fix for that check would not have re-run the check. Add the
resources, verifier and .gitattributes paths that can break packaging.

Co-authored-by: Orca <help@stably.ai>

* perf(plugins): rebuild the panel frame only when its baked theme values change

The revision keys the panel iframe, so every bump destroys the sandboxed
frame and its in-panel state. It counted root attribute mutations, but
--workspace-sidebar-live-width is written every rAF of a sidebar drag, so
dragging with a panel open blanked it ~60x/sec. Compare the two values the
shell actually bakes in instead.

Co-authored-by: Orca <help@stably.ai>

* test: stop pinning a plugin name in the CRLF guard

The CRLF case rewrites every launch file, so the reported mismatch is
whichever plugin sorts first. P2 adds theme plugins that sort ahead of
orca-navigation-shortcuts, which broke the assertion there.

Co-authored-by: Orca <help@stably.ai>

* style: drop stray blank lines left by the rebase resolutions

Both sides of the agent-hooks and orca-runtime conflicts contributed a
trailing blank, which oxfmt rejects. Whitespace only.

Co-authored-by: Orca <help@stably.ai>

* test(plugins): stop the startup budget failing on machine load

P95 runs 16-34ms idle but exceeds the 50ms bound under full-suite
parallelism, so the gate flaked. Widen it to catch an order-of-magnitude
regression instead; the no-worker/no-plugin-code assertions are the real
guarantee. Verified a 400ms regression still fails.

Co-authored-by: Orca <help@stably.ai>

---------

Co-authored-by: Orca <help@stably.ai>
2026-07-27 01:14:33 -07:00

178 lines
5.7 KiB
TypeScript

import { mkdtemp, rm, writeFile } from 'node:fs/promises'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import { performance } from 'node:perf_hooks'
import { build } from 'esbuild'
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest'
import type { PluginWorkerHandle } from './plugin-host-process'
import { PluginWorkerManager, type PluginWorkerSpawnSpec } from './plugin-worker-manager'
type LogEntry = {
at: number
level: 'info' | 'warn' | 'error'
line: string
}
const pluginRoots: string[] = []
const managers: PluginWorkerManager[] = []
let bundleRoot = ''
let hostEntryPath = ''
function createStateNotifications(): {
notify: () => void
waitFor: (predicate: () => boolean, description: string, timeoutMs?: number) => Promise<void>
} {
const listeners = new Set<() => void>()
return {
notify: () => {
for (const listener of listeners) {
listener()
}
},
waitFor: (predicate, description, timeoutMs = 10_000) => {
if (predicate()) {
return Promise.resolve()
}
return new Promise<void>((resolve, reject) => {
const timeout = setTimeout(() => {
listeners.delete(check)
reject(new Error(`timed out waiting for ${description}`))
}, timeoutMs)
const check = (): void => {
if (!predicate()) {
return
}
clearTimeout(timeout)
listeners.delete(check)
resolve()
}
listeners.add(check)
})
}
}
}
beforeAll(async () => {
bundleRoot = await mkdtemp(join(tmpdir(), 'orca-plugin-host-bundle-'))
hostEntryPath = join(bundleRoot, 'plugin-host-entry.cjs')
await build({
entryPoints: [join(process.cwd(), 'src', 'main', 'plugins', 'plugin-host-entry.ts')],
outfile: hostEntryPath,
bundle: true,
platform: 'node',
target: 'node18',
format: 'cjs',
sourcemap: false,
logLevel: 'silent'
})
}, 30_000)
afterEach(async () => {
await Promise.all(managers.splice(0).map((manager) => manager.disposeAll()))
await Promise.all(pluginRoots.splice(0).map((root) => rm(root, { recursive: true, force: true })))
})
afterAll(async () => {
if (bundleRoot) {
await rm(bundleRoot, { recursive: true, force: true })
}
})
async function createPluginSpec(
source = `export default function activate(orca) { orca.commands.register('run', async () => ({ ok: true })); }`
): Promise<PluginWorkerSpawnSpec> {
const rootDir = await mkdtemp(join(tmpdir(), 'orca-plugin-supervision-'))
pluginRoots.push(rootDir)
await writeFile(join(rootDir, 'main.mjs'), source)
return {
pluginKey: 'orca-samples.supervision',
rootDir,
mainEntry: 'main.mjs',
grantedCapabilities: []
}
}
describe('real plugin worker supervision', () => {
it('terminates and supervises a live worker that disconnects IPC', async () => {
const spec = await createPluginSpec(`
export default function activate(orca) {
orca.commands.register('disconnect', async () => {
process.disconnect?.()
setInterval(() => {}, 1_000)
await new Promise(() => {})
})
}
`)
const notifications = createStateNotifications()
const manager = new PluginWorkerManager({
entryPath: hostEntryPath,
executeHostCall: async () => ({ ok: true, value: null }),
log: vi.fn(),
onWorkerStateChange: notifications.notify,
onWorkerGone: vi.fn()
})
managers.push(manager)
const worker = await manager.ensureActive(spec)
const command = worker.invokeCommand('disconnect')
await expect(command).rejects.toThrow('disconnected')
await notifications.waitFor(
() => manager.runState(spec.pluginKey) === 'restarting',
'disconnected worker to enter supervised backoff'
)
expect(manager.restartCount(spec.pluginKey)).toBe(1)
})
it('restarts forced exits with 500/2000/5000ms backoff, then stays errored', async () => {
const spec = await createPluginSpec()
const notifications = createStateNotifications()
const logs: LogEntry[] = []
const manager = new PluginWorkerManager({
entryPath: hostEntryPath,
executeHostCall: async () => ({ ok: true, value: null }),
log: (_pluginKey, level, line) => logs.push({ at: performance.now(), level, line }),
onWorkerStateChange: notifications.notify,
onWorkerGone: vi.fn()
})
managers.push(manager)
let current: PluginWorkerHandle = await manager.ensureActive(spec)
expect(current.commands).toContain('run')
expect(manager.runState(spec.pluginKey)).toBe('running')
for (const [index, delayMs] of [500, 2_000, 5_000].entries()) {
const exited = current
exited.kill()
await notifications.waitFor(
() =>
manager.runState(spec.pluginKey) === 'restarting' &&
manager.restartCount(spec.pluginKey) === index + 1,
`restart ${index + 1} to enter backoff`
)
const restartLog = logs.find((entry) =>
entry.line.includes(`restart ${index + 1} in ${delayMs}ms`)
)
expect(restartLog?.level).toBe('warn')
current = await manager.ensureActive(spec)
expect(current).not.toBe(exited)
expect(manager.runState(spec.pluginKey)).toBe('running')
expect(performance.now() - restartLog!.at).toBeGreaterThanOrEqual(delayMs - 25)
}
current.kill()
await notifications.waitFor(
() => manager.runState(spec.pluginKey) === 'errored',
'fourth forced exit to become terminally errored'
)
expect(manager.restartCount(spec.pluginKey)).toBe(3)
expect(
logs.some((entry) => entry.level === 'error' && entry.line.includes('marked errored'))
).toBe(true)
await expect(manager.ensureActive(spec)).rejects.toThrow('errored after repeated failures')
}, 45_000)
})