Bohdan Triapitsyn
a5aa32446d
The preview panel worked by proxying a dev server through OpenChamber's own origin and rewriting the HTML that came back. Anything the rewriter did not anticipate broke, and pages that refuse to be embedded never loaded at all. This deletes the proxy (-1604 lines and its tests) and merges the preview and browser panels into one surface backed by a real Chromium view. What the panel is now - A `<webview>` in its own session partition: logins and cookies persist, hot reload works because nothing is rewritten, DevTools are one click away. - Annotation: pick one element, drag a region, or draw freehand, write a note, and it reaches chat with a screenshot of the visible page with the marks on it. - Toolbar: hard reload, page zoom, device sizes, a light/dark switch that applies to the page rather than the app, and cookie/cache clearing scoped to the panel alone. - Several pages at once, each tab showing the page's own favicon, and an address bar that suggests pages already visited in this project. - Dev servers are listed from what is actually listening on the machine, checked against what a project announced, so a server is offered no matter how it was started. One that is still starting is waited for instead of failing. Remote dev servers The desktop app binds a local port and pipes raw bytes to the OpenChamber host over the existing authenticated connection, so the page keeps its own origin at the root of its own host. The reachable set is exactly what discovery reports and is re-checked per connection, so an authenticated client cannot dial arbitrary local services on the host. Links and redirects to another loopback port stay on the machine that served the page. A tunnel that cannot be opened is reported; it is never replaced by the plain loopback URL, which would answer from the user's own machine under a remote address. Agent control Browser actions are a separate `openchamber_web` tool: open, snapshot, click, type, scroll, inspect computed styles, resize between mobile/tablet/desktop, and capture a screenshot into `.openchamber/screenshots/` in the project. The existing `openchamber` tool keeps sessions, worktrees and scheduled tasks. Each has its own setting in the new Settings -> General -> OpenChamber Tools section, and the plugin is not injected at all when both are off. Capability belongs to the connected client, not to configuration: a client declares on its event stream that it can drive a page, which only a Chromium host does. Exactly one client performs each request — it claims the request before acting, and the first claim wins — because deciding by whose result arrives first would be too late for a click that already happened. No client listening is answered immediately with an explanation rather than a timeout. Runtime boundaries Web tabs get a plain iframe that can display a page but not inspect one. The VS Code extension no longer offers the surface at all, since nothing that makes the panel worth having works there. Mobile is unaffected. Native boundary Camera, microphone, location and device-picker requests from panel pages are denied — Electron grants them by default when no handler is set, and the panel loads whatever address the user types. Page capture, appearance emulation and storage clearing verify that their target belongs to the panel's own session instead of trusting a web-contents id from the renderer. Persisted state Stored `preview` tabs migrate to `browser` (v13 -> v14). Context panel tab limits are now per surface, so filling one surface no longer evicts another's tabs. Address history is stored per project and per runtime. Documentation `preview.mdx` and `desktop-browser.mdx` rewritten across all locales, the agent tool settings path corrected, new `DOCUMENTATION.md` for the browser-control broker and the dev tunnel, and the `ui-api-decoupling` skill updated where it still described the deleted proxy.
283 lines
11 KiB
JavaScript
283 lines
11 KiB
JavaScript
import { afterEach, describe, expect, test } from 'bun:test';
|
|
import http from 'node:http';
|
|
import net from 'node:net';
|
|
|
|
import { createDevTunnelClient } from './client.js';
|
|
import { createDevTunnelRuntime, isDevTunnelPath } from './runtime.js';
|
|
|
|
/**
|
|
* These exercise the real socket path end to end: a dev server, an OpenChamber
|
|
* host tunnelling to it, and a client binding a local port. Anything less would
|
|
* not prove the thing that matters — that a page loads over the tunnel exactly
|
|
* as it does locally.
|
|
*/
|
|
|
|
const started = [];
|
|
|
|
const listen = (server, host = '127.0.0.1') => new Promise((resolve) => {
|
|
server.listen(0, host, () => resolve(server.address().port));
|
|
});
|
|
|
|
const trackSockets = (server) => {
|
|
const sockets = new Set();
|
|
server.on('connection', (socket) => {
|
|
sockets.add(socket);
|
|
socket.on('close', () => sockets.delete(socket));
|
|
});
|
|
return sockets;
|
|
};
|
|
|
|
const stopServer = (server, sockets) => async () => {
|
|
for (const socket of sockets) {
|
|
socket.destroy();
|
|
}
|
|
await new Promise((resolve) => server.close(resolve));
|
|
};
|
|
|
|
const startDevServer = async (handler) => {
|
|
const server = http.createServer(handler);
|
|
const sockets = trackSockets(server);
|
|
const port = await listen(server);
|
|
started.push(stopServer(server, sockets));
|
|
return port;
|
|
};
|
|
|
|
const startHost = async ({ allowedPorts, auth = null, discoveryOk = true }) => {
|
|
const server = http.createServer((_req, res) => res.end('host'));
|
|
const sockets = trackSockets(server);
|
|
const port = await listen(server);
|
|
const runtime = createDevTunnelRuntime({
|
|
server,
|
|
discoverDevServers: async () => (discoveryOk
|
|
? {
|
|
ok: true,
|
|
servers: allowedPorts.map((value) => ({ port: value, url: `http://localhost:${value}/`, command: 'node', pid: 1 })),
|
|
}
|
|
: { ok: false, reason: 'no-listener-source' }),
|
|
uiAuthController: auth ?? { enabled: false },
|
|
isRequestOriginAllowed: async (req) => req.headers.origin === 'http://allowed.example',
|
|
rejectWebSocketUpgrade: (socket, status, message) => {
|
|
socket.write(`HTTP/1.1 ${status} ${message}\r\n\r\n`);
|
|
socket.destroy();
|
|
},
|
|
logger: { warn: () => {} },
|
|
});
|
|
started.push(async () => {
|
|
runtime.dispose();
|
|
await stopServer(server, sockets)();
|
|
});
|
|
return { port, baseUrl: `http://127.0.0.1:${port}`, runtime, sockets };
|
|
};
|
|
|
|
const httpGet = (port, path = '/') => new Promise((resolve, reject) => {
|
|
const request = http.get({ host: '127.0.0.1', port, path }, (response) => {
|
|
let body = '';
|
|
response.on('data', (chunk) => { body += chunk; });
|
|
response.on('end', () => resolve({ status: response.statusCode, body, headers: response.headers }));
|
|
});
|
|
request.on('error', reject);
|
|
request.setTimeout(5_000, () => request.destroy(new Error('timeout')));
|
|
});
|
|
|
|
afterEach(async () => {
|
|
while (started.length) {
|
|
const stop = started.pop();
|
|
await stop();
|
|
}
|
|
});
|
|
|
|
describe('dev tunnel path matching', () => {
|
|
test('only claims its own upgrade path', () => {
|
|
expect(isDevTunnelPath('/api/dev-tunnel?port=5173')).toBe(true);
|
|
expect(isDevTunnelPath('/api/terminal/ws')).toBe(false);
|
|
expect(isDevTunnelPath('')).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe('dev tunnel end to end', () => {
|
|
test('serves the dev server through a local port, unmodified', async () => {
|
|
const devPort = await startDevServer((req, res) => {
|
|
res.setHeader('content-type', 'text/html');
|
|
res.setHeader('x-dev-header', 'kept');
|
|
res.end(`<html><body>path:${req.url}</body></html>`);
|
|
});
|
|
const host = await startHost({ allowedPorts: [devPort] });
|
|
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
started.push(() => client.closeAll());
|
|
const { localPort } = await client.open({ baseUrl: host.baseUrl, port: devPort });
|
|
|
|
const response = await httpGet(localPort, '/some/page?q=1');
|
|
expect(response.status).toBe(200);
|
|
expect(response.body).toBe('<html><body>path:/some/page?q=1</body></html>');
|
|
expect(response.headers['x-dev-header']).toBe('kept');
|
|
});
|
|
|
|
test('drops a connection that floods a handshake that never completes', async () => {
|
|
// A host that accepts the TCP connection and then says nothing: the
|
|
// WebSocket handshake hangs, which is when buffering could run away.
|
|
const stalled = net.createServer(() => {});
|
|
const stalledSockets = trackSockets(stalled);
|
|
const stalledPort = await listen(stalled);
|
|
started.push(stopServer(stalled, stalledSockets));
|
|
|
|
const client = createDevTunnelClient({
|
|
logger: { warn: () => {} },
|
|
handshakeTimeoutMs: 300,
|
|
});
|
|
started.push(() => client.closeAll());
|
|
const { localPort } = await client.open({ baseUrl: `http://127.0.0.1:${stalledPort}`, port: 4321 });
|
|
|
|
const closed = await new Promise((resolve) => {
|
|
const socket = net.createConnection({ port: localPort, host: '127.0.0.1' }, () => {
|
|
const chunk = Buffer.alloc(64 * 1024, 0x61);
|
|
const write = () => {
|
|
// Keep writing while the handshake hangs; the tunnel must stop this
|
|
// rather than hold every byte in the desktop app's memory.
|
|
if (socket.destroyed) return;
|
|
socket.write(chunk, () => setTimeout(write, 1));
|
|
};
|
|
write();
|
|
});
|
|
socket.on('close', () => resolve(true));
|
|
socket.on('error', () => resolve(true));
|
|
setTimeout(() => resolve(false), 3_000);
|
|
});
|
|
|
|
expect(closed).toBe(true);
|
|
});
|
|
|
|
test('reuses one listener for repeat opens of the same target', async () => {
|
|
const devPort = await startDevServer((_req, res) => res.end('ok'));
|
|
const host = await startHost({ allowedPorts: [devPort] });
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
started.push(() => client.closeAll());
|
|
|
|
const first = await client.open({ baseUrl: host.baseUrl, port: devPort });
|
|
const second = await client.open({ baseUrl: host.baseUrl, port: devPort });
|
|
|
|
expect(second.localPort).toBe(first.localPort);
|
|
expect(second.reused).toBe(true);
|
|
});
|
|
|
|
test('refuses a port discovery does not report, so it is not a loopback proxy', async () => {
|
|
const secret = await startDevServer((_req, res) => res.end('secret service'));
|
|
const host = await startHost({ allowedPorts: [] });
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
started.push(() => client.closeAll());
|
|
|
|
const { localPort } = await client.open({ baseUrl: host.baseUrl, port: secret });
|
|
await expect(httpGet(localPort, '/')).rejects.toThrow();
|
|
});
|
|
|
|
test('closing a tunnel frees its local port', async () => {
|
|
const devPort = await startDevServer((_req, res) => res.end('ok'));
|
|
const host = await startHost({ allowedPorts: [devPort] });
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
|
|
const { localPort } = await client.open({ baseUrl: host.baseUrl, port: devPort });
|
|
expect(client.close({ baseUrl: host.baseUrl, port: devPort })).toBe(true);
|
|
expect(client.list()).toEqual([]);
|
|
|
|
// The port is free again: binding it back succeeds.
|
|
const probe = net.createServer();
|
|
await new Promise((resolve, reject) => {
|
|
probe.once('error', reject);
|
|
probe.listen(localPort, '127.0.0.1', resolve);
|
|
});
|
|
await new Promise((resolve) => probe.close(resolve));
|
|
});
|
|
|
|
test('rejects an invalid remote port before binding anything', async () => {
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
await expect(client.open({ baseUrl: 'http://127.0.0.1:1', port: 0 })).rejects.toThrow('valid remote port');
|
|
await expect(client.open({ baseUrl: '', port: 5173 })).rejects.toThrow('base URL');
|
|
expect(client.list()).toEqual([]);
|
|
});
|
|
|
|
// Not covered here: recovery after a request the dev server kills mid-flight.
|
|
// The behaviour is real (each connection tears down independently), but the
|
|
// abandoned socket makes this harness's teardown unreliable, and a flaky test
|
|
// is worse than a documented gap. Verify it by hand against a restarting dev
|
|
// server.
|
|
});
|
|
|
|
/**
|
|
* The desktop shell dials this from the main process, where there is no browser
|
|
* and therefore no Origin header. Requiring one — as the browser-facing sockets
|
|
* rightly do — silently rejected every tunnel and surfaced as an empty response
|
|
* in the panel, with nothing to connect it back to authentication.
|
|
*/
|
|
describe('dev tunnel authentication', () => {
|
|
const clientAuth = {
|
|
enabled: true,
|
|
resolveAuthContext: async (req) => (
|
|
req.headers.authorization === 'Bearer good' ? { type: 'client' } : null
|
|
),
|
|
};
|
|
const sessionAuth = {
|
|
enabled: true,
|
|
resolveAuthContext: async () => ({ type: 'session' }),
|
|
};
|
|
|
|
test('accepts a bearer-authenticated client that sends no origin', async () => {
|
|
const devPort = await startDevServer((_req, res) => res.end('ok'));
|
|
const host = await startHost({ allowedPorts: [devPort], auth: clientAuth });
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
started.push(() => client.closeAll());
|
|
|
|
const { localPort } = await client.open({
|
|
baseUrl: host.baseUrl,
|
|
port: devPort,
|
|
headers: { Authorization: 'Bearer good' },
|
|
});
|
|
expect((await httpGet(localPort, '/')).body).toBe('ok');
|
|
});
|
|
|
|
test('rejects a client with no credentials', async () => {
|
|
const devPort = await startDevServer((_req, res) => res.end('ok'));
|
|
const host = await startHost({ allowedPorts: [devPort], auth: clientAuth });
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
started.push(() => client.closeAll());
|
|
|
|
const { localPort } = await client.open({ baseUrl: host.baseUrl, port: devPort });
|
|
await expect(httpGet(localPort, '/')).rejects.toThrow();
|
|
});
|
|
|
|
test('still refuses a session-authenticated request that sends no origin', async () => {
|
|
// Only an explicit bearer may skip the origin check; ambient session
|
|
// credentials are exactly what the origin check exists to protect.
|
|
const devPort = await startDevServer((_req, res) => res.end('ok'));
|
|
const host = await startHost({ allowedPorts: [devPort], auth: sessionAuth });
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
started.push(() => client.closeAll());
|
|
|
|
const { localPort } = await client.open({ baseUrl: host.baseUrl, port: devPort });
|
|
await expect(httpGet(localPort, '/')).rejects.toThrow();
|
|
});
|
|
|
|
test('rejects a disallowed origin even with valid credentials', async () => {
|
|
const devPort = await startDevServer((_req, res) => res.end('ok'));
|
|
const host = await startHost({ allowedPorts: [devPort], auth: clientAuth });
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
started.push(() => client.closeAll());
|
|
|
|
const { localPort } = await client.open({
|
|
baseUrl: host.baseUrl,
|
|
port: devPort,
|
|
headers: { Authorization: 'Bearer good', Origin: 'http://evil.example' },
|
|
});
|
|
await expect(httpGet(localPort, '/')).rejects.toThrow();
|
|
});
|
|
|
|
test('refuses every port when discovery itself is unavailable', async () => {
|
|
const devPort = await startDevServer((_req, res) => res.end('ok'));
|
|
const host = await startHost({ allowedPorts: [devPort], discoveryOk: false });
|
|
const client = createDevTunnelClient({ logger: { warn: () => {} } });
|
|
started.push(() => client.closeAll());
|
|
|
|
const { localPort } = await client.open({ baseUrl: host.baseUrl, port: devPort });
|
|
await expect(httpGet(localPort, '/')).rejects.toThrow();
|
|
});
|
|
});
|