Skip to content

Never stop coding. Free MIT AI gateway: one endpoint, 375 providers (150+ free), 1,400+ models Kimi, Claude, GPT, Gemini, GLM, DeepSeek, MiniMax. Works with Claude Code, Codex, Cursor, OpenCode, Cline & Copilot. Quota-aware auto-fallback, RTK+Caveman compression saves 15-95% tokens, MCP/A2A, Desktop/PWA. Built by 900+ contributors

8.8 KB
Raw Blame
import { spawn } from "node:child_process";

export function parsePort(value, fallback) {
  const parsed = Number.parseInt(String(value), 10);
  return Number.isFinite(parsed) && parsed > 0 && parsed <= 65535 ? parsed : fallback;
}

/**
 * Resolve the V8 heap ceiling (MB) for the server process from
 * `OMNIROUTE_MEMORY_MB`, mirroring `omniroute serve`. Clamped to [64, 16384];
 * invalid/unset → fallback (512). The standalone launcher uses this so
 * OMNIROUTE_MEMORY_MB can override the Docker image's NODE_OPTIONS fallback
 * without clobbering any other runtime flags (#2939).
 * @param {string | number | undefined | null} value
 * @param {number} [fallback]
 */
export function resolveMaxOldSpaceMb(value, fallback = 512) {
  const parsed = Number.parseInt(String(value), 10);
  return Number.isFinite(parsed) && parsed >= 64 && parsed <= 16384 ? parsed : fallback;
}

/**
 * Derive a sane DEFAULT V8 heap ceiling (MB) from the host's physical RAM, used
 * when `OMNIROUTE_MEMORY_MB` is unset. A fixed 512MB default crashed boxes with
 * plenty of RAM under load (65 providers / 2600 models → "Ineffective
 * mark-compacts near heap limit ~500MB"); see #5172 / #5160 / #5152. Targets
 * ~35% of total RAM, clamped to [512, 4096]. Invalid/zero totalmem → 512.
 * Pass the result as the `fallback` of {@link resolveMaxOldSpaceMb} so an
 * explicit OMNIROUTE_MEMORY_MB override always wins.
 * @param {number | undefined | null} totalmemBytes — typically `os.totalmem()`
 */
export function calibrateHeapFallbackMb(totalmemBytes) {
  const totalMb = Number(totalmemBytes) / (1024 * 1024);
  if (!Number.isFinite(totalMb) || totalMb <= 0) return 512;
  const target = Math.floor(totalMb * 0.35);
  return Math.min(4096, Math.max(512, target));
}

const MAX_OLD_SPACE_FLAG = "--max-old-space-size";

/**
 * True when the caller already pinned the V8 heap via NODE_OPTIONS
 * (`--max-old-space-size=…`). Used to decide whether `omniroute serve` may
 * append/inject the calibrated default — a user-set value must always win.
 * @param {NodeJS.ProcessEnv | Record<string, string | undefined>} [env]
 */
export function envHasExplicitHeapFlag(env) {
  const sourceEnv = arguments.length === 0 ? process.env : env;
  return String(sourceEnv?.NODE_OPTIONS || "").includes(MAX_OLD_SPACE_FLAG);
}

/** Last `--max-old-space-size=` value in NODE_OPTIONS, or null if absent. */
export function parseNodeOptionsHeapMb(nodeOptions) {
  const matches = [...String(nodeOptions || "").matchAll(/--max-old-space-size=(\d+)/g)];
  if (matches.length === 0) return null;
  const parsed = Number.parseInt(matches[matches.length - 1][1], 10);
  return Number.isFinite(parsed) ? parsed : null;
}

/**
 * True when OMNIROUTE_MEMORY_MB is an explicit in-range integer (not the
 * unset/invalid fallback). Docker images set this; Compose may also set
 * NODE_OPTIONS — #10353 needs to know both knobs were intentionally present.
 */
export function envHasExplicitOmnirouteMemoryMb(env) {
  const sourceEnv = arguments.length === 0 ? process.env : env;
  const parsed = Number.parseInt(String(sourceEnv?.OMNIROUTE_MEMORY_MB ?? ""), 10);
  return Number.isFinite(parsed) && parsed >= 64 && parsed <= 16384;
}

/**
 * Docker `run-standalone.mjs` appends `--max-old-space-size` from
 * OMNIROUTE_MEMORY_MB. V8 last-flag semantics mean that appended value wins
 * over an earlier NODE_OPTIONS heap. Warn once when both are set and disagree
 * so env dumps stop looking like NODE_OPTIONS is in effect (#10353).
 *
 * @returns {boolean} true when a warn was emitted
 */
export function warnConflictingHeapLimits(env, omnirouteMb, log = console.warn) {
  const nodeMb = parseNodeOptionsHeapMb(env?.NODE_OPTIONS);
  if (nodeMb == null || !envHasExplicitOmnirouteMemoryMb(env)) return false;
  if (nodeMb === omnirouteMb) return false;
  log(
    `[omniroute] heap limit conflict: OMNIROUTE_MEMORY_MB=${omnirouteMb} disagrees with NODE_OPTIONS --max-old-space-size=${nodeMb}. ` +
      `run-standalone.mjs / Docker appends OMNIROUTE_MEMORY_MB last, so the effective V8 heap is ${omnirouteMb} MB. ` +
      `Set only OMNIROUTE_MEMORY_MB (recommended) or make both values match.`
  );
  return true;
}

/**
 * NODE_OPTIONS string for Docker / run-standalone.mjs.
 * Explicit OMNIROUTE_MEMORY_MB always appends (wins). Otherwise keep an
 * existing NODE_OPTIONS heap flag (#5238). Otherwise append the fallback.
 */
export function buildStandaloneNodeOptions(env = process.env, omnirouteMb) {
  const existing = String(env?.NODE_OPTIONS || "").trim();
  if (envHasExplicitOmnirouteMemoryMb(env)) {
    return `${existing} ${MAX_OLD_SPACE_FLAG}=${omnirouteMb}`.trim();
  }
  if (existing.includes(MAX_OLD_SPACE_FLAG)) return existing;
  return `${existing} ${MAX_OLD_SPACE_FLAG}=${omnirouteMb}`.trim();
}

/**
 * Assemble the NODE_OPTIONS string for the spawned server, preserving any flags
 * the user already exported. #5238: `omniroute serve` used to UNCONDITIONALLY
 * overwrite NODE_OPTIONS with the calibrated `--max-old-space-size`, silently
 * discarding a user-set `NODE_OPTIONS=--max-old-space-size=8192` (reporter set
 * 8192 and still OOM'd at ~505MB). Mirrors the Electron (electron/main.js) and
 * standalone (scripts/dev/run-standalone.mjs) launchers:
 *   - if NODE_OPTIONS already contains `--max-old-space-size`, keep it as-is
 *     (the user's value wins);
 *   - otherwise append the calibrated `--max-old-space-size=<memoryLimit>` to
 *     the existing NODE_OPTIONS, preserving unrelated flags (e.g.
 *     `--enable-source-maps`).
 * @param {NodeJS.ProcessEnv | Record<string, string | undefined>} [env]
 * @param {number} memoryLimit — calibrated V8 heap ceiling (MB)
 * @returns {string} the NODE_OPTIONS value to pass to the child process
 */
export function buildServerNodeOptions(env = process.env, memoryLimit) {
  const existing = String(env?.NODE_OPTIONS || "").trim();
  if (existing.includes(MAX_OLD_SPACE_FLAG)) return existing;
  return `${existing} ${MAX_OLD_SPACE_FLAG}=${memoryLimit}`.trim();
}

/**
 * Build the leading `node` CLI args that pin the V8 heap. When the user already
 * pinned the heap via NODE_OPTIONS, return `[]` so we do NOT inject a
 * conflicting/shadowing CLI `--max-old-space-size` (CLI args override
 * NODE_OPTIONS, which would re-introduce #5238). Otherwise return the calibrated
 * flag — NODE_OPTIONS already carries the same value, so this stays redundant
 * (identical value), never conflicting.
 * @param {NodeJS.ProcessEnv | Record<string, string | undefined>} [env]
 * @param {number} memoryLimit — calibrated V8 heap ceiling (MB)
 * @returns {string[]}
 */
export function buildNodeHeapArgs(env = process.env, memoryLimit) {
  return envHasExplicitHeapFlag(env) ? [] : [`${MAX_OLD_SPACE_FLAG}=${memoryLimit}`];
}

/**
 * Build the complete argument list for spawning the Node.js server runtime.
 * Prefer IPv4 DNS results before starting the application so undici does not
 * stall on hosts whose IPv6 route silently drops outbound connections.
 *
 * @param {NodeJS.ProcessEnv | Record<string, string | undefined>} [env]
 * @param {number} memoryLimit — calibrated V8 heap ceiling (MB)
 * @param {string} serverPath — standalone server entrypoint
 * @returns {string[]}
 */
export function buildNodeRuntimeArgs(env = process.env, memoryLimit, serverPath) {
  return ["--dns-result-order=ipv4first", ...buildNodeHeapArgs(env, memoryLimit), serverPath];
}

/**
 * @param {NodeJS.ProcessEnv | Record<string, string | undefined>} [fromEnv]
 *        Defaults to process.env. Pass bootstrap `merged` so project `.env` PORT applies before spawn.
 */
export function resolveRuntimePorts(fromEnv = process.env) {
  const basePort = parsePort(fromEnv.PORT || "20128", 20128);
  const apiPort = parsePort(fromEnv.API_PORT || String(basePort), basePort);
  const dashboardPort = parsePort(fromEnv.DASHBOARD_PORT || String(basePort), basePort);

  return { basePort, apiPort, dashboardPort };
}

export function withRuntimePortEnv(env, runtimePorts) {
  const { basePort, apiPort, dashboardPort } = runtimePorts;

  return {
    ...env,
    OMNIROUTE_PORT: String(basePort),
    PORT: String(dashboardPort),
    DASHBOARD_PORT: String(dashboardPort),
    API_PORT: String(apiPort),
    HOSTNAME: env.OMNIROUTE_HOSTNAME || "0.0.0.0",
  };
}

export function sanitizeColorEnv(env = {}) {
  const sanitized = { ...env };

  // Node warns when both FORCE_COLOR and NO_COLOR are set.
  // Prefer NO_COLOR in test tooling to avoid noisy process warnings.
  if (typeof sanitized.FORCE_COLOR !== "undefined" && typeof sanitized.NO_COLOR !== "undefined") {
    delete sanitized.FORCE_COLOR;
  }

  return sanitized;
}

export function spawnWithForwardedSignals(command, args, options = {}) {
  const child = spawn(command, args, options);

  child.on("exit", (code, signal) => {
    if (signal) {
      process.kill(process.pid, signal);
      return;
    }
    process.exit(code ?? 0);
  });

  process.on("SIGINT", () => child.kill("SIGINT"));
  process.on("SIGTERM", () => child.kill("SIGTERM"));

  return child;
}