server.cjs 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723
  1. const crypto = require('crypto');
  2. const http = require('http');
  3. const fs = require('fs');
  4. const path = require('path');
  5. // ========== WebSocket Protocol (RFC 6455) ==========
  6. const OPCODES = { TEXT: 0x01, CLOSE: 0x08, PING: 0x09, PONG: 0x0A };
  7. const WS_MAGIC = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
  8. const MAX_FRAME_PAYLOAD_BYTES = 10 * 1024 * 1024;
  9. function computeAcceptKey(clientKey) {
  10. return crypto.createHash('sha1').update(clientKey + WS_MAGIC).digest('base64');
  11. }
  12. function encodeFrame(opcode, payload) {
  13. const fin = 0x80;
  14. const len = payload.length;
  15. let header;
  16. if (len < 126) {
  17. header = Buffer.alloc(2);
  18. header[0] = fin | opcode;
  19. header[1] = len;
  20. } else if (len < 65536) {
  21. header = Buffer.alloc(4);
  22. header[0] = fin | opcode;
  23. header[1] = 126;
  24. header.writeUInt16BE(len, 2);
  25. } else {
  26. header = Buffer.alloc(10);
  27. header[0] = fin | opcode;
  28. header[1] = 127;
  29. header.writeBigUInt64BE(BigInt(len), 2);
  30. }
  31. return Buffer.concat([header, payload]);
  32. }
  33. function decodeFrame(buffer) {
  34. if (buffer.length < 2) return null;
  35. const secondByte = buffer[1];
  36. const opcode = buffer[0] & 0x0F;
  37. const masked = (secondByte & 0x80) !== 0;
  38. let payloadLen = secondByte & 0x7F;
  39. let offset = 2;
  40. if (!masked) throw new Error('Client frames must be masked');
  41. if (payloadLen === 126) {
  42. if (buffer.length < 4) return null;
  43. payloadLen = buffer.readUInt16BE(2);
  44. offset = 4;
  45. } else if (payloadLen === 127) {
  46. if (buffer.length < 10) return null;
  47. const extendedLen = buffer.readBigUInt64BE(2);
  48. if (extendedLen > BigInt(MAX_FRAME_PAYLOAD_BYTES)) {
  49. throw new Error('WebSocket frame payload exceeds maximum allowed size');
  50. }
  51. payloadLen = Number(extendedLen);
  52. offset = 10;
  53. }
  54. if (payloadLen > MAX_FRAME_PAYLOAD_BYTES) {
  55. throw new Error('WebSocket frame payload exceeds maximum allowed size');
  56. }
  57. const maskOffset = offset;
  58. const dataOffset = offset + 4;
  59. const totalLen = dataOffset + payloadLen;
  60. if (buffer.length < totalLen) return null;
  61. const mask = buffer.slice(maskOffset, dataOffset);
  62. const data = Buffer.alloc(payloadLen);
  63. for (let i = 0; i < payloadLen; i++) {
  64. data[i] = buffer[dataOffset + i] ^ mask[i % 4];
  65. }
  66. return { opcode, payload: data, bytesConsumed: totalLen };
  67. }
  68. // ========== Configuration ==========
  69. const PORT_FILE = process.env.BRAINSTORM_PORT_FILE || null;
  70. const randomPort = () => 49152 + Math.floor(Math.random() * 16383);
  71. // Prefer an explicit port, else the port this session last bound (so a restart
  72. // reuses it and an already-open browser tab reconnects), else a random high port.
  73. function preferredPort() {
  74. if (process.env.BRAINSTORM_PORT) return Number(process.env.BRAINSTORM_PORT);
  75. if (PORT_FILE) {
  76. try {
  77. const p = Number(fs.readFileSync(PORT_FILE, 'utf-8').trim());
  78. if (Number.isInteger(p) && p > 1023 && p < 65536) return p;
  79. } catch (e) { /* no prior port recorded */ }
  80. }
  81. return randomPort();
  82. }
  83. let PORT = preferredPort();
  84. const HOST = process.env.BRAINSTORM_HOST || '127.0.0.1';
  85. const URL_HOST = process.env.BRAINSTORM_URL_HOST || (HOST === '127.0.0.1' ? 'localhost' : HOST);
  86. const SESSION_DIR = process.env.BRAINSTORM_DIR || '/tmp/brainstorm';
  87. const CONTENT_DIR = path.join(SESSION_DIR, 'content');
  88. const STATE_DIR = path.join(SESSION_DIR, 'state');
  89. const SUPERPOWERS_VERSION = readSuperpowersVersion();
  90. const SUPERPOWERS_BRAND_IMAGE_URL = 'https://primeradiant.com/brand/superpowers-visual-brainstorming-logo.png';
  91. const TELEMETRY_DISABLE_ENV_VARS = [
  92. 'SUPERPOWERS_DISABLE_TELEMETRY',
  93. 'DISABLE_TELEMETRY',
  94. 'CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC'
  95. ];
  96. const SUPERPOWERS_TELEMETRY_DISABLED = TELEMETRY_DISABLE_ENV_VARS.some(name => isTruthyEnv(process.env[name]));
  97. let ownerPid = process.env.BRAINSTORM_OWNER_PID ? Number(process.env.BRAINSTORM_OWNER_PID) : null;
  98. // Per-session secret key. The companion is reachable by any local browser tab
  99. // and, when bound to a non-loopback host, by any host that can route to it.
  100. // The key authenticates the real client uniformly across loopback, tunnel, and
  101. // remote binds — and defeats DNS rebinding — where a Host/Origin allowlist
  102. // cannot. It rides the served URL as ?key= and is mirrored into a cookie on
  103. // first load so same-origin subresources and the WebSocket carry it for free.
  104. // Persisted alongside the port (BRAINSTORM_TOKEN_FILE) so a restart keeps the
  105. // same key and an already-open tab's cookie still validates.
  106. const TOKEN_FILE = process.env.BRAINSTORM_TOKEN_FILE || null;
  107. function generateToken() {
  108. return crypto.randomBytes(32).toString('hex');
  109. }
  110. function chmodOwnerOnly(file) {
  111. try { fs.chmodSync(file, 0o600); } catch (e) { /* best effort */ }
  112. }
  113. function initialToken() {
  114. if (process.env.BRAINSTORM_TOKEN) {
  115. return { value: process.env.BRAINSTORM_TOKEN, source: 'env' };
  116. }
  117. if (TOKEN_FILE) {
  118. try {
  119. const t = fs.readFileSync(TOKEN_FILE, 'utf-8').trim();
  120. if (/^[0-9a-f]{32,}$/i.test(t)) {
  121. chmodOwnerOnly(TOKEN_FILE);
  122. return { value: t, source: 'file' };
  123. }
  124. } catch (e) { /* no prior token recorded */ }
  125. }
  126. return { value: generateToken(), source: 'generated' };
  127. }
  128. const tokenInfo = initialToken();
  129. let TOKEN = tokenInfo.value;
  130. let tokenSource = tokenInfo.source;
  131. let COOKIE_NAME = 'brainstorm-key-' + PORT; // refined to the actual bound port in onListen
  132. const MIME_TYPES = {
  133. '.html': 'text/html', '.css': 'text/css', '.js': 'application/javascript',
  134. '.json': 'application/json', '.png': 'image/png', '.jpg': 'image/jpeg',
  135. '.jpeg': 'image/jpeg', '.gif': 'image/gif', '.svg': 'image/svg+xml'
  136. };
  137. // ========== Templates and Constants ==========
  138. function waitingPage() {
  139. return renderBranding(`<!DOCTYPE html>
  140. <html>
  141. <head><meta charset="utf-8"><title>Brainstorm Companion</title>
  142. <style>
  143. body { font-family: system-ui, sans-serif; padding: 2rem; max-width: 800px; margin: 0 auto; }
  144. h1 { color: #333; } p { color: #666; }
  145. .brand { display: flex; align-items: center; min-width: 0; overflow: hidden; margin-bottom: 1.5rem; color: #666; font-size: 0.9rem; line-height: 1; }
  146. .brand a { color: inherit; text-decoration: none; display: flex; align-items: center; gap: 0.5rem; min-width: 0; max-width: 100%; line-height: 1; }
  147. .brand-copy { display: block; min-width: 0; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; line-height: 1; transform: translateY(-1px); }
  148. .brand-logo { display: block; height: 1em; width: auto; max-width: 180px; filter: invert(1); }
  149. </style>
  150. </head>
  151. <body><!-- BRANDING --><h1>Brainstorm Companion</h1>
  152. <p>Waiting for the agent to push a screen...</p></body></html>`);
  153. }
  154. const FORBIDDEN_PAGE = `<!DOCTYPE html>
  155. <html>
  156. <head><meta charset="utf-8"><title>Session key required</title>
  157. <style>body { font-family: system-ui, sans-serif; padding: 2rem; max-width: 800px; margin: 0 auto; }
  158. h1 { color: #333; } p { color: #666; } code { background: #f0f0f0; padding: 0.1em 0.3em; border-radius: 4px; }</style>
  159. </head>
  160. <body><h1>Session key required</h1>
  161. <p>This page needs the full URL your coding agent gave you, including the
  162. <code>?key=&hellip;</code> part. Copy the complete URL and open it again.</p></body></html>`;
  163. function bootstrapPage(key) {
  164. const jsonKey = JSON.stringify(String(key));
  165. return `<!DOCTYPE html>
  166. <html>
  167. <head><meta charset="utf-8"><title>Opening Brainstorm Companion</title></head>
  168. <body>
  169. <script>
  170. try { sessionStorage.setItem('brainstorm-session-key', ${jsonKey}); } catch (e) {}
  171. location.replace('/');
  172. </script>
  173. </body>
  174. </html>`;
  175. }
  176. const frameTemplate = fs.readFileSync(path.join(__dirname, 'frame-template.html'), 'utf-8');
  177. const helperScript = fs.readFileSync(path.join(__dirname, 'helper.js'), 'utf-8');
  178. const helperInjection = '<script>\n' + helperScript + '\n</script>';
  179. // ========== Helper Functions ==========
  180. function readSuperpowersVersion() {
  181. const root = path.join(__dirname, '../../..');
  182. const manifests = [
  183. path.join(root, 'package.json'),
  184. path.join(root, '.codex-plugin/plugin.json')
  185. ];
  186. for (const manifest of manifests) {
  187. try {
  188. const data = JSON.parse(fs.readFileSync(manifest, 'utf-8'));
  189. if (data.version) return String(data.version);
  190. } catch (e) {
  191. // Packaged Codex plugins omit package.json; try the next manifest.
  192. }
  193. }
  194. return 'unknown';
  195. }
  196. function isTruthyEnv(value) {
  197. if (!value) return false;
  198. const normalized = String(value).trim().toLowerCase();
  199. if (!normalized) return false;
  200. return !['0', 'false', 'no', 'off'].includes(normalized);
  201. }
  202. function escapeHtmlText(value) {
  203. return String(value)
  204. .replace(/&/g, '&amp;')
  205. .replace(/</g, '&lt;')
  206. .replace(/>/g, '&gt;')
  207. .replace(/"/g, '&quot;');
  208. }
  209. function brandMarkup() {
  210. const version = escapeHtmlText(SUPERPOWERS_VERSION);
  211. const text = SUPERPOWERS_TELEMETRY_DISABLED
  212. ? 'Prime Radiant Superpowers v' + version
  213. : 'Superpowers v' + version;
  214. const logo = SUPERPOWERS_TELEMETRY_DISABLED
  215. ? ''
  216. : '<img class="brand-logo" src="' + SUPERPOWERS_BRAND_IMAGE_URL + '?v=' + encodeURIComponent(SUPERPOWERS_VERSION) + '" alt="Prime Radiant" referrerpolicy="no-referrer" decoding="async">';
  217. return '<div class="brand"><a href="https://github.com/obra/superpowers">' + logo + '<span class="brand-copy">' + text + '</span></a></div>';
  218. }
  219. function renderBranding(html) {
  220. return html.split('<!-- BRANDING -->').join(brandMarkup());
  221. }
  222. function isFullDocument(html) {
  223. const trimmed = html.trimStart().toLowerCase();
  224. return trimmed.startsWith('<!doctype') || trimmed.startsWith('<html');
  225. }
  226. function wrapInFrame(content) {
  227. return renderBranding(frameTemplate).replace('<!-- CONTENT -->', content);
  228. }
  229. function getNewestScreen() {
  230. const files = fs.readdirSync(CONTENT_DIR)
  231. .filter(f => !f.startsWith('.') && f.endsWith('.html'))
  232. .map(f => {
  233. const fp = path.join(CONTENT_DIR, f);
  234. if (!isRegularFileInsideContentDir(fp)) return null;
  235. return { path: fp, mtime: fs.statSync(fp).mtime.getTime() };
  236. })
  237. .filter(Boolean)
  238. .sort((a, b) => b.mtime - a.mtime);
  239. return files.length > 0 ? files[0].path : null;
  240. }
  241. function urlHostForHttp(host) {
  242. const h = String(host);
  243. if (h.startsWith('[') && h.endsWith(']')) return h;
  244. return h.includes(':') ? '[' + h + ']' : h;
  245. }
  246. function companionUrl() {
  247. return 'http://' + urlHostForHttp(URL_HOST) + ':' + PORT + '/?key=' + TOKEN;
  248. }
  249. function browserLauncherForPlatform(url, {
  250. platform = process.platform,
  251. osRelease = require('os').release(),
  252. env = process.env
  253. } = {}) {
  254. const isWSL = platform === 'linux' && /microsoft/i.test(osRelease);
  255. if (platform === 'darwin') return { bin: 'open', args: [url] };
  256. if (platform === 'win32' || isWSL) {
  257. return { bin: 'rundll32.exe', args: ['url.dll,FileProtocolHandler', url] };
  258. }
  259. if (env.DISPLAY || env.WAYLAND_DISPLAY) return { bin: 'xdg-open', args: [url] };
  260. return null;
  261. }
  262. function isRegularFileInsideContentDir(filePath) {
  263. let stat, realContentDir, realFilePath;
  264. try {
  265. stat = fs.lstatSync(filePath);
  266. if (stat.isSymbolicLink()) return false;
  267. if (!stat.isFile()) return false;
  268. if (stat.nlink !== 1) return false;
  269. realContentDir = fs.realpathSync(CONTENT_DIR);
  270. realFilePath = fs.realpathSync(filePath);
  271. } catch (e) {
  272. return false;
  273. }
  274. return realFilePath.startsWith(realContentDir + path.sep);
  275. }
  276. // ========== Authentication ==========
  277. function timingSafeEqualStr(a, b) {
  278. const ab = Buffer.from(String(a));
  279. const bb = Buffer.from(String(b));
  280. if (ab.length !== bb.length) return false;
  281. return crypto.timingSafeEqual(ab, bb);
  282. }
  283. function parseCookies(header) {
  284. const out = {};
  285. if (!header) return out;
  286. for (const part of header.split(';')) {
  287. const eq = part.indexOf('=');
  288. if (eq < 0) continue;
  289. out[part.slice(0, eq).trim()] = part.slice(eq + 1).trim();
  290. }
  291. return out;
  292. }
  293. // A request is authorized if it carries the session key as ?key= or as the
  294. // session cookie. Both are compared in constant time.
  295. function isAuthorized(req) {
  296. const q = req.url.indexOf('?');
  297. if (q >= 0) {
  298. const params = new URLSearchParams(req.url.slice(q + 1));
  299. if (params.has('key')) {
  300. const key = params.get('key');
  301. return Boolean(key && timingSafeEqualStr(key, TOKEN));
  302. }
  303. }
  304. const cookie = parseCookies(req.headers['cookie'])[COOKIE_NAME];
  305. if (cookie && timingSafeEqualStr(cookie, TOKEN)) return true;
  306. return false;
  307. }
  308. function pathnameOf(url) {
  309. const q = url.indexOf('?');
  310. return q >= 0 ? url.slice(0, q) : url;
  311. }
  312. function queryKey(url) {
  313. const q = url.indexOf('?');
  314. if (q < 0) return null;
  315. return new URLSearchParams(url.slice(q + 1)).get('key');
  316. }
  317. function securityHeaders(headers = {}) {
  318. return {
  319. 'Referrer-Policy': 'no-referrer',
  320. 'Cache-Control': 'no-store',
  321. 'X-Frame-Options': 'DENY',
  322. 'Content-Security-Policy': "frame-ancestors 'none'",
  323. 'Cross-Origin-Resource-Policy': 'same-origin',
  324. ...headers
  325. };
  326. }
  327. function isAllowedWebSocketOrigin(req) {
  328. const origin = req.headers.origin;
  329. if (!origin) return true;
  330. const host = req.headers.host;
  331. if (!host) return false;
  332. return origin === 'http://' + host;
  333. }
  334. // ========== HTTP Request Handler ==========
  335. function handleRequest(req, res) {
  336. if (!isAuthorized(req)) {
  337. res.writeHead(403, securityHeaders({ 'Content-Type': 'text/html; charset=utf-8' }));
  338. res.end(FORBIDDEN_PAGE);
  339. return;
  340. }
  341. touchActivity(); // only authorized requests count as activity
  342. // Mirror the key into a cookie so same-origin subresources (/files/*) can
  343. // authenticate after bootstrap. HttpOnly keeps it away from page scripts; the
  344. // WebSocket Origin check below is what blocks cross-origin localhost injection.
  345. res.setHeader('Set-Cookie',
  346. COOKIE_NAME + '=' + TOKEN + '; HttpOnly; SameSite=Strict; Path=/');
  347. const pathname = pathnameOf(req.url);
  348. const keyFromQuery = queryKey(req.url);
  349. if (req.method === 'GET' && pathname === '/' && keyFromQuery && timingSafeEqualStr(keyFromQuery, TOKEN)) {
  350. res.writeHead(200, securityHeaders({ 'Content-Type': 'text/html; charset=utf-8' }));
  351. res.end(bootstrapPage(keyFromQuery));
  352. } else if (req.method === 'GET' && pathname === '/') {
  353. const screenFile = getNewestScreen();
  354. let html = screenFile
  355. ? (raw => isFullDocument(raw) ? raw : wrapInFrame(raw))(fs.readFileSync(screenFile, 'utf-8'))
  356. : waitingPage();
  357. if (html.includes('</body>')) {
  358. html = html.replace('</body>', helperInjection + '\n</body>');
  359. } else {
  360. html += helperInjection;
  361. }
  362. res.writeHead(200, securityHeaders({ 'Content-Type': 'text/html; charset=utf-8' }));
  363. res.end(html);
  364. } else if (req.method === 'GET' && pathname.startsWith('/files/')) {
  365. const fileName = path.basename(pathname.slice(7));
  366. const filePath = path.join(CONTENT_DIR, fileName);
  367. // Reject empty/dotfile names and anything that isn't a regular file —
  368. // `/files/` would otherwise resolve to CONTENT_DIR and crash readFileSync (EISDIR).
  369. if (!fileName || fileName.startsWith('.') || !isRegularFileInsideContentDir(filePath)) {
  370. res.writeHead(404, securityHeaders());
  371. res.end('Not found');
  372. return;
  373. }
  374. const ext = path.extname(filePath).toLowerCase();
  375. const contentType = MIME_TYPES[ext] || 'application/octet-stream';
  376. res.writeHead(200, securityHeaders({ 'Content-Type': contentType }));
  377. res.end(fs.readFileSync(filePath));
  378. } else {
  379. res.writeHead(404, securityHeaders());
  380. res.end('Not found');
  381. }
  382. }
  383. // ========== WebSocket Connection Handling ==========
  384. const clients = new Set();
  385. function handleUpgrade(req, socket) {
  386. if (!isAuthorized(req) || !isAllowedWebSocketOrigin(req)) { socket.destroy(); return; }
  387. const key = req.headers['sec-websocket-key'];
  388. if (!key) { socket.destroy(); return; }
  389. const accept = computeAcceptKey(key);
  390. socket.write(
  391. 'HTTP/1.1 101 Switching Protocols\r\n' +
  392. 'Upgrade: websocket\r\n' +
  393. 'Connection: Upgrade\r\n' +
  394. 'Sec-WebSocket-Accept: ' + accept + '\r\n\r\n'
  395. );
  396. let buffer = Buffer.alloc(0);
  397. clients.add(socket);
  398. socket.on('data', (chunk) => {
  399. buffer = Buffer.concat([buffer, chunk]);
  400. while (buffer.length > 0) {
  401. let result;
  402. try {
  403. result = decodeFrame(buffer);
  404. } catch (e) {
  405. socket.end(encodeFrame(OPCODES.CLOSE, Buffer.alloc(0)));
  406. clients.delete(socket);
  407. return;
  408. }
  409. if (!result) break;
  410. buffer = buffer.slice(result.bytesConsumed);
  411. switch (result.opcode) {
  412. case OPCODES.TEXT:
  413. handleMessage(result.payload.toString());
  414. break;
  415. case OPCODES.CLOSE:
  416. socket.end(encodeFrame(OPCODES.CLOSE, Buffer.alloc(0)));
  417. clients.delete(socket);
  418. return;
  419. case OPCODES.PING:
  420. socket.write(encodeFrame(OPCODES.PONG, result.payload));
  421. break;
  422. case OPCODES.PONG:
  423. break;
  424. default: {
  425. const closeBuf = Buffer.alloc(2);
  426. closeBuf.writeUInt16BE(1003);
  427. socket.end(encodeFrame(OPCODES.CLOSE, closeBuf));
  428. clients.delete(socket);
  429. return;
  430. }
  431. }
  432. }
  433. });
  434. socket.on('close', () => clients.delete(socket));
  435. socket.on('error', () => clients.delete(socket));
  436. }
  437. function handleMessage(text) {
  438. let event;
  439. try {
  440. event = JSON.parse(text);
  441. } catch (e) {
  442. console.error('Failed to parse WebSocket message:', e.message);
  443. return;
  444. }
  445. touchActivity();
  446. console.log(JSON.stringify({ source: 'user-event', ...event }));
  447. if (event && event.choice) {
  448. const eventsFile = path.join(STATE_DIR, 'events');
  449. fs.appendFileSync(eventsFile, JSON.stringify(event) + '\n');
  450. }
  451. }
  452. function broadcast(msg) {
  453. const frame = encodeFrame(OPCODES.TEXT, Buffer.from(JSON.stringify(msg)));
  454. for (const socket of clients) {
  455. try { socket.write(frame); } catch (e) { clients.delete(socket); }
  456. }
  457. }
  458. // Best-effort: open the user's browser the first time a screen is actually ready
  459. // to show. Skips when disabled, on a non-loopback (remote) bind, or when a
  460. // browser is already connected. Override the launcher with BRAINSTORM_OPEN_CMD.
  461. let browserOpened = false;
  462. function maybeOpenBrowser() {
  463. if (browserOpened) return;
  464. browserOpened = true;
  465. if (!process.env.BRAINSTORM_OPEN) return; // opt-in: only after the user approves the companion
  466. if (HOST !== '127.0.0.1' && HOST !== 'localhost') return;
  467. if (clients.size > 0) return; // the user already opened it
  468. const url = companionUrl(); // must carry the key or the gate 403s it
  469. const cp = require('child_process');
  470. // Operator-provided launcher: run as given (this env var is trusted operator input).
  471. if (process.env.BRAINSTORM_OPEN_CMD) {
  472. try { cp.exec(process.env.BRAINSTORM_OPEN_CMD + ' ' + JSON.stringify(url), () => {}); } catch (e) { /* best effort */ }
  473. return;
  474. }
  475. // Platform launchers: pass the URL as an argv element via execFile (no shell),
  476. // so a url-host containing shell metacharacters can't inject a command.
  477. const launcher = browserLauncherForPlatform(url);
  478. if (!launcher) return; // headless: nothing to open
  479. try { cp.execFile(launcher.bin, launcher.args, () => {}); } catch (e) { /* best effort */ }
  480. }
  481. // ========== Activity Tracking ==========
  482. // Idle timeout: shut down after this long with no activity. Default 4 hours;
  483. // override with BRAINSTORM_IDLE_TIMEOUT_MS (start-server.sh: --idle-timeout-minutes).
  484. const IDLE_TIMEOUT_MS = (() => {
  485. const ms = Number(process.env.BRAINSTORM_IDLE_TIMEOUT_MS);
  486. return Number.isFinite(ms) && ms > 0 ? ms : 4 * 60 * 60 * 1000;
  487. })();
  488. // How often the watchdog checks for owner-death / idleness. Configurable mainly
  489. // so tests can run fast; production default is 60s.
  490. const LIFECYCLE_CHECK_MS = (() => {
  491. const ms = Number(process.env.BRAINSTORM_LIFECYCLE_CHECK_MS);
  492. return Number.isFinite(ms) && ms > 0 ? ms : 60 * 1000;
  493. })();
  494. let lastActivity = Date.now();
  495. function touchActivity() {
  496. lastActivity = Date.now();
  497. }
  498. // ========== File Watching ==========
  499. const debounceTimers = new Map();
  500. // ========== Server Startup ==========
  501. function startServer() {
  502. if (!fs.existsSync(CONTENT_DIR)) fs.mkdirSync(CONTENT_DIR, { recursive: true });
  503. if (!fs.existsSync(STATE_DIR)) fs.mkdirSync(STATE_DIR, { recursive: true });
  504. // Track known files to distinguish new screens from updates.
  505. // macOS fs.watch reports 'rename' for both new files and overwrites,
  506. // so we can't rely on eventType alone.
  507. const knownFiles = new Set(
  508. fs.readdirSync(CONTENT_DIR).filter(f => !f.startsWith('.') && f.endsWith('.html'))
  509. );
  510. const server = http.createServer(handleRequest);
  511. server.on('upgrade', handleUpgrade);
  512. const watcher = fs.watch(CONTENT_DIR, (eventType, filename) => {
  513. if (!filename || filename.startsWith('.') || !filename.endsWith('.html')) return;
  514. if (debounceTimers.has(filename)) clearTimeout(debounceTimers.get(filename));
  515. debounceTimers.set(filename, setTimeout(() => {
  516. debounceTimers.delete(filename);
  517. const filePath = path.join(CONTENT_DIR, filename);
  518. if (!fs.existsSync(filePath)) return; // file was deleted
  519. touchActivity();
  520. if (!knownFiles.has(filename)) {
  521. knownFiles.add(filename);
  522. const eventsFile = path.join(STATE_DIR, 'events');
  523. if (fs.existsSync(eventsFile)) fs.unlinkSync(eventsFile);
  524. console.log(JSON.stringify({ type: 'screen-added', file: filePath }));
  525. maybeOpenBrowser();
  526. } else {
  527. console.log(JSON.stringify({ type: 'screen-updated', file: filePath }));
  528. }
  529. broadcast({ type: 'reload' });
  530. }, 100));
  531. });
  532. watcher.on('error', (err) => console.error('fs.watch error:', err.message));
  533. function shutdown(reason) {
  534. console.log(JSON.stringify({ type: 'server-stopped', reason }));
  535. const infoFile = path.join(STATE_DIR, 'server-info');
  536. if (fs.existsSync(infoFile)) fs.unlinkSync(infoFile);
  537. fs.writeFileSync(
  538. path.join(STATE_DIR, 'server-stopped'),
  539. JSON.stringify({ reason, timestamp: Date.now() }) + '\n'
  540. );
  541. watcher.close();
  542. clearInterval(lifecycleCheck);
  543. // Close any upgraded WebSocket sockets so server.close() can complete and
  544. // the process actually exits instead of lingering on an open connection.
  545. for (const socket of clients) {
  546. try { socket.destroy(); } catch (e) { /* already gone */ }
  547. }
  548. server.close(() => process.exit(0));
  549. }
  550. function ownerAlive() {
  551. if (!ownerPid) return true;
  552. try { process.kill(ownerPid, 0); return true; } catch (e) { return e.code === 'EPERM'; }
  553. }
  554. // Periodically exit if the owner process died or we've been idle too long.
  555. const lifecycleCheck = setInterval(() => {
  556. if (!ownerAlive()) shutdown('owner process exited');
  557. else if (Date.now() - lastActivity > IDLE_TIMEOUT_MS) shutdown('idle timeout');
  558. }, LIFECYCLE_CHECK_MS);
  559. lifecycleCheck.unref();
  560. // Validate owner PID at startup. If it's already dead, the PID resolution
  561. // was wrong (common on WSL, Tailscale SSH, and cross-user scenarios).
  562. // Disable monitoring and rely on the idle timeout instead.
  563. if (ownerPid) {
  564. try { process.kill(ownerPid, 0); }
  565. catch (e) {
  566. if (e.code !== 'EPERM') {
  567. console.log(JSON.stringify({ type: 'owner-pid-invalid', pid: ownerPid, reason: 'dead at startup' }));
  568. ownerPid = null;
  569. }
  570. }
  571. }
  572. // If the preferred port is already taken (e.g. a previous server is still
  573. // alive), fall back to a random port once instead of failing.
  574. let triedFallback = false;
  575. function onListen() {
  576. // Cookie name keys on the ACTUAL bound port (may differ from the preferred
  577. // one after an EADDRINUSE fallback) so it can't collide with another server's
  578. // cookie in the shared localhost jar.
  579. COOKIE_NAME = 'brainstorm-key-' + PORT;
  580. // Record the bound port AND token so the next restart of this session reuses
  581. // them — but ONLY when we got our preferred port. On a fallback we bound a
  582. // *different* port because someone else holds the preferred one; persisting
  583. // would overwrite the shared files and strand that other session's open tab.
  584. if (PORT_FILE && !triedFallback) {
  585. try { fs.writeFileSync(PORT_FILE, String(PORT)); } catch (e) { /* best effort */ }
  586. if (TOKEN_FILE) {
  587. try {
  588. fs.writeFileSync(TOKEN_FILE, TOKEN, { mode: 0o600 });
  589. chmodOwnerOnly(TOKEN_FILE);
  590. } catch (e) { /* best effort */ }
  591. }
  592. }
  593. const info = JSON.stringify({
  594. type: 'server-started', port: Number(PORT), host: HOST,
  595. url_host: URL_HOST, url: companionUrl(),
  596. screen_dir: CONTENT_DIR, state_dir: STATE_DIR, idle_timeout_ms: IDLE_TIMEOUT_MS
  597. });
  598. console.log(info);
  599. // server-info embeds the key — keep it owner-only.
  600. fs.writeFileSync(path.join(STATE_DIR, 'server-info'), info + '\n', { mode: 0o600 });
  601. }
  602. server.on('error', (err) => {
  603. if (err.code === 'EADDRINUSE' && !triedFallback) {
  604. if (tokenSource === 'env') {
  605. console.error('Server failed to bind: preferred port is in use and BRAINSTORM_TOKEN is set; refusing fallback with explicit token');
  606. process.exit(1);
  607. }
  608. triedFallback = true;
  609. PORT = randomPort();
  610. if (tokenSource === 'file') {
  611. TOKEN = generateToken();
  612. tokenSource = 'generated-fallback';
  613. }
  614. server.listen(PORT, HOST, onListen);
  615. } else {
  616. console.error('Server failed to bind:', err.message);
  617. process.exit(1);
  618. }
  619. });
  620. server.listen(PORT, HOST, onListen);
  621. }
  622. if (require.main === module) {
  623. startServer();
  624. }
  625. module.exports = {
  626. computeAcceptKey,
  627. encodeFrame,
  628. decodeFrame,
  629. browserLauncherForPlatform,
  630. OPCODES,
  631. MAX_FRAME_PAYLOAD_BYTES
  632. };