File size: 24,562 Bytes
c0af099 | 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 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 | /**
* Static-frontend Development Stack
*
* Same as the default automation stack but serves a production build of the
* frontend via `scripts/static-server.mjs` instead of the Vite dev server.
* Designed for slow / flaky network situations (e.g. plane wifi)
* where Vite's ~1000 individual module requests per page load are the
* bottleneck. The static build collapses the frontend into ~50 hashed
* chunks that all 304 cleanly on reload.
*
* Architecture (identical to dev-with-automation, only the frontend differs):
* ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
* β http://localhost:8000 (Ingress Proxy) β
* β /api/automation/* β Automation Backend β
* β /api/*, /sockets β Agent Server β
* β /* β Static Frontend β
* ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
* β β β
* βΌ βΌ βΌ
* βββββββββββββββ βββββββββββββββββ ββββββββββββββββββββ
* β sirv-cli β β Agent Server β β Automation β
* β build/ β β (uvx) :18000 β β Backend (uvx) β
* β :3001 β β β β :18001 β
* βββββββββββββββ βββββββββββββββββ ββββββββββββββββββββ
*
* Usage:
* npm run dev:static
* npm run dev:static -- --port 12000
* npm run dev:static -- --skip-build # reuse an existing build/
* npm run dev:static -- --automation-ref feat/my-branch
*
* Environment variables (all optional, same as dev):
* - PORT: Ingress port (default: 8000)
* - OH_AUTOMATION_GIT_REF: Git ref for automation (default: main)
* - OH_AGENT_SERVER_GIT_REF: Git ref for agent-server
* - OH_SECRET_KEY: Session secret key
*/
import { spawn, spawnSync } from "node:child_process";
import { join, resolve, dirname } from "node:path";
import { fileURLToPath, pathToFileURL } from "node:url";
import { setTimeout as delay } from "node:timers/promises";
import process from "node:process";
import { buildFrontend } from "./static-build.mjs";
import {
buildAgentServerCommand,
buildSafeDevConfig,
buildAgentServerEnv,
formatMissingUvxGuidance,
isPortBusy,
releaseStaleConversationLeases,
} from "./dev-safe.mjs";
import {
getProcessTreeSpawnOptions,
isProcessRunning,
resolveWindowsCommand,
signalProcessTree,
} from "./dev-process-utils.mjs";
import {
buildAgentServerAutomationEnv,
buildAutomationCommand,
buildAutomationTelemetryEnv,
buildAutomationRuntimeServicesInfo,
buildConfig,
buildRouteArgs,
getAgentServerBaseUrl,
getLocalServiceRoutes,
getNoReferrerPrefixArgs,
getVSCodeAdvertiseArgs,
} from "./dev-with-automation.mjs";
const __dirname = dirname(fileURLToPath(import.meta.url));
const projectRoot = resolve(__dirname, "..");
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Terminal Styling
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
const c = {
reset: "\x1b[0m",
bold: "\x1b[1m",
dim: "\x1b[2m",
red: "\x1b[31m",
green: "\x1b[32m",
yellow: "\x1b[33m",
blue: "\x1b[34m",
magenta: "\x1b[35m",
cyan: "\x1b[36m",
};
function logService(name, message, color = c.reset) {
const ts = new Date().toISOString().split("T")[1].split(".")[0];
console.log(`${c.dim}${ts}${c.reset} ${color}[${name}]${c.reset} ${message}`);
}
function logStep(step, message) {
console.log(`${c.cyan}[${step}]${c.reset} ${message}`);
}
function logSuccess(message) {
console.log(`${c.green}β${c.reset} ${message}`);
}
function logError(message) {
console.error(`${c.red}β${c.reset} ${message}`);
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// CLI parsing
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
export function parseArgs(argv = process.argv.slice(2)) {
const config = {
port: null,
automationGitRef: null,
automationRepo: null,
skipBuild: false,
verbose: false,
};
for (let i = 0; i < argv.length; i++) {
switch (argv[i]) {
case "-p":
case "--port":
config.port = parseInt(argv[++i], 10);
break;
case "--automation-ref":
config.automationGitRef = argv[++i];
break;
case "--automation-repo":
config.automationRepo = argv[++i];
break;
case "--skip-build":
config.skipBuild = true;
break;
case "-v":
case "--verbose":
config.verbose = true;
break;
case "-h":
case "--help":
showHelp();
process.exit(0);
}
}
return config;
}
function showHelp() {
console.log(`
Agent Canvas Static-frontend Development Stack
Runs the automation stack, but serves a production build of the
frontend via scripts/static-server.mjs. Use this when a remote or flaky network
makes Vite's per-module requests painful (e.g. ngrok or plane wifi).
USAGE:
npm run dev:static [-- options]
OPTIONS:
-p, --port <port> Ingress port (default: 8000)
--automation-ref <ref> Git ref for automation backend (default: main)
--automation-repo <url> Git repo URL for automation
--skip-build Reuse existing build/ directory (faster restart)
-v, --verbose Show detailed output
-h, --help Show this help
ENVIRONMENT VARIABLES:
PORT Alternative to --port
OH_AUTOMATION_GIT_REF Alternative to --automation-ref
OH_AGENT_SERVER_GIT_REF Git ref for agent-server SDK
OH_SECRET_KEY Secret key for sessions
ACCESS POINTS:
Main UI: http://localhost:PORT/
API Docs: http://localhost:PORT/api/automation/docs
NOTES:
β’ The build is produced once at startup. Edit the source and rerun this
command (or rebuild with \`npm run build:app\`) to pick up changes.
β’ The static server sends ETag headers, so reloads return 304s instead of
refetching content β much friendlier on slow links.
`);
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Prerequisites & Setup
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function commandExists(cmd) {
const result =
process.platform === "win32"
? spawnSync("where.exe", [cmd], { stdio: "pipe" })
: spawnSync("sh", ["-c", `command -v ${cmd}`], { stdio: "pipe" });
return result.status === 0;
}
function checkPrerequisites() {
logStep("1/3", "Checking prerequisites...");
if (!commandExists("uvx")) {
console.error(formatMissingUvxGuidance(projectRoot));
process.exit(1);
}
logSuccess("uvx found");
if (!commandExists("npm")) {
logError("npm is required but not found");
process.exit(1);
}
logSuccess("npm found");
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Process Management
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
const processes = new Map();
let shuttingDown = false;
function spawnService(name, command, args, options = {}) {
const proc = spawn(
resolveWindowsCommand(command),
args,
getProcessTreeSpawnOptions({
stdio: ["ignore", "pipe", "pipe"],
env: { ...process.env, ...options.env },
cwd: options.cwd,
}),
);
const color = options.color || c.reset;
proc.stdout.on("data", (data) => {
data
.toString()
.split("\n")
.filter(Boolean)
.forEach((line) => logService(name, line.trim(), color));
});
proc.stderr.on("data", (data) => {
data
.toString()
.split("\n")
.filter(Boolean)
.forEach((line) => logService(name, line.trim(), c.yellow));
});
proc.on("error", (error) => {
logError(`${name} failed to start: ${error.message}`);
});
proc.on("exit", (code) => {
if (code !== 0 && code !== null && !shuttingDown) {
logService(name, `Exited with code ${code}`, c.red);
}
processes.delete(name);
});
processes.set(name, proc);
return proc;
}
async function waitForService(name, url, timeoutMs = 30000) {
const start = Date.now();
while (Date.now() - start < timeoutMs) {
try {
const res = await fetch(url);
if (res.ok) {
logService(name, `Ready at ${url}`, c.green);
return true;
}
} catch {
// Keep trying
}
await delay(500);
}
logService(name, `Timeout waiting for ${url}`, c.red);
return false;
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Service Starters (agent-server + automation are byte-for-byte the same as
// dev-with-automation; the only difference is the frontend service.)
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// The static server and the ingress proxy front the same local backends, so
// they share one route table β dev-with-automation's, rather than a second
// copy here. The copy this replaces claimed to stay identical to that table
// but nothing enforced it, and it had already drifted: the editor prefix was
// missing, so `/vscode` fell through to the SPA fallback and answered editor
// requests with the canvas shell.
//
// This mode always launches both local backends (it never runs frontend-only),
// so it asks for their routes unconditionally. Every target is IPv4 loopback:
// the backends bind to `0.0.0.0`, which only accepts IPv4, but localhost can
// resolve to ::1 first (notably on Windows).
function buildLocalServiceRouteArgs(config) {
return buildRouteArgs(
getLocalServiceRoutes({
...config,
launchAgentServer: true,
launchAutomation: true,
}),
);
}
function startAgentServer(config) {
logService(
"agent-server",
`Starting on port ${config.agentServerPort}...`,
c.blue,
);
const agentServerCmd = buildAgentServerCommand(process.env);
logService("agent-server", `Using ${agentServerCmd.source}`, c.dim);
const safeConfig = buildSafeDevConfig(config.canvasPath, {
...process.env,
OH_CANVAS_SAFE_STATE_DIR: config.stateDir,
OH_CANVAS_SAFE_BACKEND_PORT: config.agentServerPort.toString(),
OH_CANVAS_SAFE_VSCODE_PORT: config.vscodePort.toString(),
});
const agentServerEnv = {
// Opt into prefix-mode: both the static server and the ingress below build
// their route tables from `getLocalServiceRoutes`, which registers this
// same prefix against `config.vscodePort`.
...buildAgentServerEnv(safeConfig, {
vscodeBasePath: config.vscodeBasePath,
}),
...buildAgentServerAutomationEnv(config),
};
spawnService(
"agent-server",
agentServerCmd.command,
[
...agentServerCmd.args,
"--host",
"0.0.0.0",
"--port",
String(config.agentServerPort),
],
{
cwd: safeConfig.workspacesPath,
env: agentServerEnv,
color: c.blue,
},
);
}
function buildAutomationBackendEnv(config, env = process.env) {
// Both backends share the same session API key value.
return {
AUTOMATION_AGENT_SERVER_URL: getAgentServerBaseUrl(config),
AUTOMATION_AGENT_SERVER_API_KEY: config.sessionApiKey,
AUTOMATION_DB_URL: `sqlite+aiosqlite:///${join(config.stateDir, "automations.db")}`,
AUTOMATION_BASE_URL: `http://localhost:${config.ingressPort}`,
AUTOMATION_WORKSPACE_BASE: join(config.stateDir, "workspaces"),
AUTOMATION_LOCAL_API_KEY: config.sessionApiKey,
...buildAutomationTelemetryEnv(env),
AUTOMATION_CORS_ORIGINS: `http://localhost:${config.ingressPort},http://127.0.0.1:${config.ingressPort},http://localhost:3001,http://127.0.0.1:3001`,
FILE_STORE: "local",
LOCAL_STORAGE_PATH: join(config.stateDir, "storage"),
OPENHANDS_SUPPRESS_BANNER: "1",
};
}
function startAutomationBackend(config) {
logService(
"automation",
`Starting on port ${config.autoBackendPort}...`,
c.green,
);
const automationCmd = buildAutomationCommand(process.env);
logService("automation", `Using ${automationCmd.source}`, c.dim);
spawnService(
"automation",
automationCmd.command,
[
...automationCmd.args,
"--host",
"0.0.0.0",
"--port",
config.autoBackendPort.toString(),
],
{
cwd: config.stateDir,
env: buildAutomationBackendEnv(config),
color: c.green,
},
);
}
function startStaticServer(config) {
// Reuse `vitePort` as the upstream port name so the ingress route table
// below stays identical to dev-with-automation.mjs.
logService("static", `Starting on port ${config.vitePort}...`, c.magenta);
// Mirror the proxy targets that vite.config.ts exposes in dev mode so that
// hitting :3001 directly behaves like Vite's dev server (e.g. /server_info
// is forwarded to the agent-server instead of falling back to the SPA
// shell). Without this, /server_info on :3001 returns index.html.
const staticServerScript = join(projectRoot, "scripts", "static-server.mjs");
const runtimeServicesInfo = JSON.stringify(
buildAutomationRuntimeServicesInfo({
...config,
frontendKind: "static",
}),
);
spawnService(
"static",
"node",
[
staticServerScript,
"--dir",
join(config.canvasPath, "build"),
"--port",
String(config.vitePort),
...(process.env.VITE_BASE_PATH
? ["--base-path", process.env.VITE_BASE_PATH]
: []),
// Inject the API key so the pre-built frontend can authenticate
// to the agent-server without a baked-in VITE_SESSION_API_KEY.
...(config.sessionApiKey
? ["--session-api-key", config.sessionApiKey]
: []),
"--runtime-services-info",
runtimeServicesInfo,
...buildLocalServiceRouteArgs(config),
// Only the static server injects into the document, so only it can tell
// the frontend this origin serves the editor. The ingress below routes
// the same prefix but proxies the HTML through untouched.
...getVSCodeAdvertiseArgs(config),
...getNoReferrerPrefixArgs(config),
],
{
cwd: config.canvasPath,
color: c.magenta,
},
);
}
function startIngress(config) {
logService("ingress", `Starting on port ${config.ingressPort}...`, c.yellow);
const ingressScript = join(projectRoot, "scripts", "ingress.mjs");
const runtimeServicesInfo = JSON.stringify(
buildAutomationRuntimeServicesInfo({
...config,
frontendKind: "static",
}),
);
spawnService(
"ingress",
"node",
[
ingressScript,
"--port",
config.ingressPort.toString(),
"--runtime-services-info",
runtimeServicesInfo,
...buildLocalServiceRouteArgs(config),
...getNoReferrerPrefixArgs(config),
"--default",
`http://localhost:${config.vitePort}`,
],
{
cwd: projectRoot,
color: c.yellow,
},
);
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Shutdown / Banner
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function shutdown() {
if (shuttingDown) return;
shuttingDown = true;
console.log("");
console.log(`${c.yellow}Shutting down...${c.reset}`);
for (const [name, proc] of processes) {
logService(name, "Stopping...", c.dim);
signalProcessTree(proc, "SIGTERM");
}
setTimeout(() => {
for (const [name, proc] of processes) {
if (isProcessRunning(proc)) {
logService(name, "Force stopping...", c.dim);
signalProcessTree(proc, "SIGKILL");
}
}
process.exit(0);
}, 3000);
}
process.on("SIGINT", shutdown);
process.on("SIGTERM", shutdown);
function printBanner(config) {
console.log("");
console.log(
`${c.green}${c.bold}ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ${c.reset}`,
);
console.log(
`${c.green}${c.bold}β${c.reset} ${c.bold}Agent Canvas Static-frontend Stack${c.reset} ${c.green}${c.bold}β${c.reset}`,
);
console.log(
`${c.green}${c.bold}β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£${c.reset}`,
);
console.log(
`${c.green}${c.bold}β${c.reset} ${c.green}${c.bold}β${c.reset}`,
);
console.log(
`${c.green}${c.bold}β${c.reset} Main UI: ${c.cyan}http://localhost:${config.ingressPort}/${c.reset}`.padEnd(
75,
) + `${c.green}${c.bold}β${c.reset}`,
);
console.log(
`${c.green}${c.bold}β${c.reset} API Docs: ${c.cyan}http://localhost:${config.ingressPort}/api/automation/docs${c.reset}`.padEnd(
75,
) + `${c.green}${c.bold}β${c.reset}`,
);
console.log(
`${c.green}${c.bold}β${c.reset} ${c.green}${c.bold}β${c.reset}`,
);
console.log(
`${c.green}${c.bold}ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ${c.reset}`,
);
console.log("");
console.log(`${c.dim}State directory: ${config.stateDir}${c.reset}`);
console.log(
`${c.dim}Frontend served from: ${join(config.canvasPath, "build")}${c.reset}`,
);
console.log(
`${c.dim}Edit sources, then re-run \`npm run dev:static\` to rebuild.${c.reset}`,
);
console.log(`${c.dim}Press Ctrl+C to stop${c.reset}`);
console.log("");
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Main
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
async function main() {
const args = parseArgs();
const config = await buildConfig(args);
console.log("");
console.log(
`${c.cyan}${c.bold}Agent Canvas Static-frontend Development Stack${c.reset}`,
);
console.log("");
// Setup phase (1/3)
checkPrerequisites();
// Ensure isolated state dirs (same as dev-with-automation).
const { mkdirSync } = await import("node:fs");
for (const dir of [
config.stateDir,
join(config.stateDir, "dev_conversations"),
join(config.stateDir, "workspaces"),
join(config.stateDir, "bash_events"),
join(config.stateDir, "storage"),
]) {
mkdirSync(dir, { recursive: true });
}
// Build phase (2/3): block until the SPA is ready to serve.
buildFrontend(config, args);
// Service phase (3/3)
logStep("3/3", "Starting services...");
// The agent-server skip-loads any conversation whose `owner_lease.json`
// is held by a different `owner_instance_id` and not yet expired (45 s
// TTL). If a previous agent-server (e.g. from `npm run dev`) was killed
// ungracefully β or we restart faster than the lease TTL β every
// conversation gets hidden until those stale leases age out, which
// looks like "the new agent-server doesn't inherit my conversations".
// Bail out if a live agent-server is already bound to our port (we'd
// collide anyway), otherwise unlink the stale leases so the new server
// can claim ownership immediately.
if (await isPortBusy(config.agentServerPort)) {
logError(
`Port ${config.agentServerPort} is already in use β another ` +
`agent-server is running. Stop it (e.g. quit \`npm run dev\`) ` +
`before running dev:static.`,
);
process.exit(1);
}
const conversationsPath = join(config.stateDir, "dev_conversations");
const cleared = releaseStaleConversationLeases(conversationsPath);
if (cleared > 0) {
logService(
"agent-server",
`Released ${cleared} stale conversation lease(s) so the new ` +
`agent-server can resume ownership.`,
c.dim,
);
}
startAgentServer(config);
await waitForService(
"agent-server",
`${getAgentServerBaseUrl(config)}/server_info`,
);
startAutomationBackend(config);
startStaticServer(config);
await delay(2000);
startIngress(config);
await delay(1000);
printBanner(config);
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Exports for testing
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
export {
buildAutomationBackendEnv,
buildFrontend,
buildLocalServiceRouteArgs,
startStaticServer,
};
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Main entry point (only when run directly, not when imported)
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
const isMainModule =
process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href;
if (isMainModule) {
main().catch((err) => {
logError(`Fatal error: ${err.message}`);
if (err.stack) {
console.error(c.dim + err.stack + c.reset);
}
process.exit(1);
});
}
|