File size: 10,635 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 | #!/usr/bin/env node
/**
* Standalone Ingress / Reverse Proxy
*
* A minimal HTTP reverse proxy that routes requests to multiple backends
* based on URL path. Completely independent of any backend implementation.
*
* Usage:
* node scripts/ingress.mjs [options]
* node scripts/ingress.mjs --port 8000 --route "/api/automation=http://localhost:18001" --route "/api=http://localhost:18000" --default "http://localhost:3001"
*
* Environment variables:
* INGRESS_PORT - Port to listen on (default: 8000)
* INGRESS_ROUTES - JSON object of path prefix -> backend URL
* INGRESS_DEFAULT - Default backend for unmatched routes
* INGRESS_RUNTIME_SERVICES_INFO - Runtime services JSON appended to
* /server_info
*
* Route matching:
* - Routes are matched by longest prefix first
* - More specific routes take precedence (e.g., /api/automation before /api)
*/
import { createServer } from "node:http";
import process from "node:process";
import { pathToFileURL } from "node:url";
import {
createProxyHandlers,
createRouter,
isBenignSocketError,
isServerInfoRequest,
matchesPathPrefix,
proxyServerInfoRequest,
} from "./proxy-utils.mjs";
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Configuration
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
function parseArgs() {
const args = process.argv.slice(2);
const config = {
port: 8000,
routes: {},
defaultBackend: null,
noReferrerPrefixes: [],
runtimeServicesInfo: null,
};
for (let i = 0; i < args.length; i++) {
switch (args[i]) {
case "-p":
case "--port":
config.port = parseInt(args[++i], 10);
break;
case "-r":
case "--route":
// Format: "/path=http://host:port"
const [path, url] = args[++i].split("=");
config.routes[path] = url;
break;
case "-d":
case "--default":
config.defaultBackend = args[++i];
break;
case "--no-referrer-prefix": {
const prefix = args[++i];
if (!prefix || !prefix.startsWith("/")) {
throw new Error(
`--no-referrer-prefix value must start with '/': ${prefix ?? "(empty)"}`,
);
}
config.noReferrerPrefixes.push(prefix);
break;
}
case "--runtime-services-info":
config.runtimeServicesInfo = args[++i] || null;
break;
case "-h":
case "--help":
showHelp();
process.exit(0);
}
}
return config;
}
function showHelp() {
console.log(`
Standalone Ingress / Reverse Proxy
Routes HTTP requests to multiple backends based on URL path prefix.
USAGE:
node scripts/ingress.mjs [options]
OPTIONS:
-p, --port <port> Port to listen on (default: 8000)
-r, --route <path=url> Add a route (can be repeated)
-d, --default <url> Default backend for unmatched routes
--no-referrer-prefix <p> Send "Referrer-Policy: no-referrer" on proxied
responses under <p>. For upstreams whose URL
carries a credential in the query string.
--runtime-services-info Runtime services JSON for /server_info
-h, --help Show this help
ENVIRONMENT VARIABLES:
INGRESS_PORT Port to listen on
INGRESS_ROUTES JSON object: {"path": "url", ...}
INGRESS_DEFAULT Default backend URL
INGRESS_RUNTIME_SERVICES_INFO
Runtime services JSON for /server_info
EXAMPLES:
# Basic setup with agent server and automation
node scripts/ingress.mjs \\
--port 8000 \\
--route "/api/automation=http://localhost:18001" \\
--route "/api=http://localhost:18000" \\
--route "/sockets=http://localhost:18000" \\
--default "http://localhost:3001"
# Using environment variables
INGRESS_PORT=8000 \\
INGRESS_ROUTES='{"/ api/automation":"http://localhost:18001","/api":"http://localhost:18000"}' \\
INGRESS_DEFAULT="http://localhost:3001" \\
node scripts/ingress.mjs
ROUTE MATCHING:
Routes are sorted by path length (longest first), so more specific
routes like /api/automation will match before /api.
`);
}
function buildConfig(args, env = process.env) {
let routes = { ...args.routes };
// Merge env routes
if (env.INGRESS_ROUTES) {
try {
const envRoutes = JSON.parse(env.INGRESS_ROUTES);
routes = { ...routes, ...envRoutes };
} catch (e) {
console.error("Failed to parse INGRESS_ROUTES:", e.message);
}
}
return {
port: args.port || parseInt(env.INGRESS_PORT, 10) || 8000,
routes,
defaultBackend: args.defaultBackend || env.INGRESS_DEFAULT || null,
noReferrerPrefixes: args.noReferrerPrefixes ?? [],
runtimeServicesInfo:
args.runtimeServicesInfo || env.INGRESS_RUNTIME_SERVICES_INFO || null,
};
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Server
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
export function startIngress(config) {
const route = createRouter(config.routes, config.defaultBackend);
const proxy = createProxyHandlers({ label: `ingress:${config.port}` });
const uninstallDiagnostics = proxy.installDiagnostics();
const noReferrerPrefixes = config.noReferrerPrefixes ?? [];
const server = createServer((req, res) => {
const url = req.url ?? "/";
const backend = route(url);
if (!backend) {
res.writeHead(503);
res.end("No backend configured for this route");
return;
}
// See the matching note in static-server.mjs: the editor's URL carries
// agent-server's session key as a query parameter, so the document must
// not send a Referer on the subresources the workbench loads.
if (noReferrerPrefixes.some((prefix) => matchesPathPrefix(url, prefix))) {
res.setHeader("Referrer-Policy", "no-referrer");
}
if (
config.runtimeServicesInfo &&
isServerInfoRequest(req) &&
(req.method === "GET" || req.method === "HEAD")
) {
proxyServerInfoRequest(req, res, backend, config.runtimeServicesInfo);
return;
}
proxy.proxyHttp(req, res, backend);
});
// Handle WebSocket upgrades
server.on("upgrade", (req, socket, head) => {
const backend = route(req.url ?? "/");
if (!backend) {
socket.destroy();
return;
}
proxy.proxyWebSocket(req, socket, head, backend);
});
// Built-in protection against malformed client requests that can otherwise
// bubble up as unhandled errors on the underlying TCP socket.
server.on("clientError", (err, socket) => {
if (!isBenignSocketError(err)) {
console.error("Client error:", err.message);
}
if (socket.writable) {
socket.end("HTTP/1.1 400 Bad Request\r\n\r\n");
} else {
socket.destroy();
}
});
server.on("close", uninstallDiagnostics);
server.listen(config.port, () => {
console.log("");
console.log(
"βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ",
);
console.log(
"β Ingress Proxy β",
);
console.log(
"β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£",
);
console.log(
`β Listening on: http://localhost:${config.port}/`.padEnd(66) + "β",
);
console.log(
"β ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£",
);
console.log(
"β Routes: β",
);
const sortedRoutes = Object.entries(config.routes).sort(
([a], [b]) => b.length - a.length,
);
for (const [path, backend] of sortedRoutes) {
const line = ` ${path} β ${backend}`;
console.log(`β ${line.padEnd(61)}β`);
}
if (config.defaultBackend) {
const line = ` * (default) β ${config.defaultBackend}`;
console.log(`β ${line.padEnd(61)}β`);
}
console.log(
"β β",
);
console.log(
"βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ",
);
console.log("");
});
return server;
}
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
// Main
// βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
const isMainModule =
process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href;
if (isMainModule) {
const args = parseArgs();
const config = buildConfig(args);
if (Object.keys(config.routes).length === 0 && !config.defaultBackend) {
console.error(
"Error: No routes configured. Use --route or --default options.",
);
console.error("Run with --help for usage information.");
process.exit(1);
}
startIngress(config);
// Handle graceful shutdown
process.on("SIGINT", () => {
console.log("\nShutting down...");
process.exit(0);
});
process.on("SIGTERM", () => {
console.log("\nShutting down...");
process.exit(0);
});
}
|