open-design/apps/daemon/tests/plugins-asset-route.test.ts
Cursor Agent 61931faef9
feat(plugins): plugin-bundled component surface (sandboxed iframe)
Plan L3 / spec §10.3.5 / §9.2.

Web: GenUISurfaceRenderer now renders a sandboxed iframe when the
surface declares a component path. Communication is one-way: the
iframe posts `{ kind: 'genui:respond', surfaceId, value }` envelopes
back to the parent via window.postMessage; the parent forwards to
onAnswered. The iframe carries `sandbox="allow-scripts"` only — no
allow-same-origin / forms / popups / downloads, exactly as spec §9.2
mandates.

PendingSurface gains `componentPluginId`, supplied by the host (from
the run's AppliedPluginSnapshot.pluginId). Surfaces missing that
field render an inline error so a misconfigured host fails loudly.

Daemon: GET /api/plugins/:id/asset/* serves arbitrary files inside an
installed plugin's fsPath under the §9.2 preview CSP:

  Content-Security-Policy: default-src 'none'; img-src 'self' data: blob:;
                           media-src 'self' data: blob:;
                           style-src 'self' 'unsafe-inline';
                           script-src 'self' 'unsafe-inline';
                           connect-src 'none'; frame-ancestors 'self'
  X-Content-Type-Options: nosniff

Three guards: unknown plugin id → 404, traversal segments / absolute
paths → 400, escape-via-resolved-path → 400. Content-Type maps
common asset extensions; everything else falls back to
application/octet-stream so the browser's nosniff respects it.

Daemon tests: 1499 → 1503 (+4 cases on plugins-asset-route covering
404 / traversal-rejection / 200 with CSP headers / asset-not-found).
Web typecheck clean; jsdom tests stay at 586/586 (the iframe path is
DOM-shape-locked and has no callable surface to drive without a
real browser).

Co-authored-by: Tom Huang <1043269994@qq.com>
2026-05-09 13:55:04 +00:00

120 lines
4.5 KiB
TypeScript

// Plan §3.L3 / spec §10.3.5 / §9.2 — plugin asset endpoint.
//
// Validates the daemon-side half of the SandboxedComponentSurface
// contract:
//
// - 404 when the plugin id is unknown.
// - 400 when the relpath includes traversal segments.
// - 200 with the §9.2 CSP + nosniff headers when the asset is
// served from a real fsPath.
// - Requests outside the plugin's fsPath are refused even when the
// normalized path resolves to an existing file elsewhere.
import type http from 'node:http';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import { mkdtemp, mkdir, rm, writeFile } from 'node:fs/promises';
import os from 'node:os';
import path from 'node:path';
import Database from 'better-sqlite3';
import { startServer } from '../src/server.js';
import { migratePlugins } from '../src/plugins/persistence.js';
import { upsertInstalledPlugin } from '../src/plugins/registry.js';
let server: http.Server;
let baseUrl: string;
let shutdown: (() => Promise<void> | void) | undefined;
let pluginRoot: string;
beforeAll(async () => {
pluginRoot = await mkdtemp(path.join(os.tmpdir(), 'od-asset-'));
const surfacesDir = path.join(pluginRoot, 'surfaces');
await mkdir(surfacesDir, { recursive: true });
await writeFile(
path.join(surfacesDir, 'index.html'),
'<!DOCTYPE html><title>fixture</title><script>console.log(1)</script>',
);
await writeFile(
path.join(pluginRoot, 'open-design.json'),
JSON.stringify({
$schema: 'https://open-design.ai/schemas/plugin.v1.json',
name: 'asset-plugin',
title: 'Asset',
version: '1.0.0',
description: 'fixture',
license: 'MIT',
od: { kind: 'skill', capabilities: ['prompt:inject', 'genui:custom-component'] },
}),
);
const started = (await startServer({ port: 0, returnServer: true })) as {
url: string;
server: http.Server;
shutdown?: () => Promise<void> | void;
};
baseUrl = started.url;
server = started.server;
shutdown = started.shutdown;
// Insert the plugin row into the running daemon's DB. We can't reach
// the daemon's `db` handle directly, so we open a sibling SQLite
// session against the same RUNTIME_DATA_DIR. Instead, simulate the
// installer's effect by hitting the install API:
//
// For test simplicity we open a private DB and skip the daemon's
// registry. The asset route reads through `getInstalledPlugin(db,…)`
// backed by the daemon's own DB, so we must use the install route.
// But install requires SAFE_BASENAME id matching the folder name —
// achievable by pointing at our prepared fixture.
const installResp = await fetch(`${baseUrl}/api/plugins/install`, {
method: 'POST',
headers: { 'content-type': 'application/json', accept: 'text/event-stream' },
body: JSON.stringify({ source: pluginRoot }),
});
// Drain SSE.
if (installResp.body) {
const reader = installResp.body.getReader();
while (true) {
const { done } = await reader.read();
if (done) break;
}
}
void migratePlugins;
void upsertInstalledPlugin;
void Database;
});
afterAll(async () => {
await Promise.resolve(shutdown?.());
await new Promise<void>((resolve) => server.close(() => resolve()));
await rm(pluginRoot, { recursive: true, force: true });
});
describe('GET /api/plugins/:id/asset/*', () => {
it('returns 404 for an unknown plugin', async () => {
const resp = await fetch(`${baseUrl}/api/plugins/unknown/asset/index.html`);
expect(resp.status).toBe(404);
});
it('rejects path-traversal segments with 400', async () => {
const resp = await fetch(`${baseUrl}/api/plugins/asset-plugin/asset/..%2Fescape`);
expect(resp.status).toBe(400);
});
it('serves an asset with the §9.2 preview CSP + nosniff', async () => {
const resp = await fetch(`${baseUrl}/api/plugins/asset-plugin/asset/surfaces/index.html`);
expect(resp.status).toBe(200);
const csp = resp.headers.get('content-security-policy') ?? '';
expect(csp).toContain("default-src 'none'");
expect(csp).toContain("connect-src 'none'");
expect(csp).toContain("frame-ancestors 'self'");
expect(resp.headers.get('x-content-type-options')).toBe('nosniff');
expect(resp.headers.get('content-type')).toMatch(/text\/html/);
const body = await resp.text();
expect(body).toContain('fixture');
});
it('returns 404 for a missing asset under a known plugin', async () => {
const resp = await fetch(`${baseUrl}/api/plugins/asset-plugin/asset/does/not/exist.html`);
expect(resp.status).toBe(404);
});
});