File size: 4,365 Bytes
34810d2 | 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 | // Proxy capture env helpers build proxy-related env vars for child processes.
import { randomUUID } from "node:crypto";
import type { Agent } from "node:http";
import process from "node:process";
import { createAmbientNodeProxyAgent } from "@openclaw/proxyline";
import {
resolveDebugProxyBlobDir,
resolveDebugProxyCertDir,
resolveDebugProxyDbPath,
} from "./paths.js";
// Environment contract for debug proxy capture. These vars are passed to child
// processes and provider transports so capture sessions share one store/proxy.
const OPENCLAW_DEBUG_PROXY_ENABLED = "OPENCLAW_DEBUG_PROXY_ENABLED";
const OPENCLAW_DEBUG_PROXY_URL = "OPENCLAW_DEBUG_PROXY_URL";
const OPENCLAW_DEBUG_PROXY_CERT_DIR = "OPENCLAW_DEBUG_PROXY_CERT_DIR";
const OPENCLAW_DEBUG_PROXY_SESSION_ID = "OPENCLAW_DEBUG_PROXY_SESSION_ID";
const OPENCLAW_DEBUG_PROXY_REQUIRE = "OPENCLAW_DEBUG_PROXY_REQUIRE";
export type DebugProxySettings = {
enabled: boolean;
required: boolean;
proxyUrl?: string;
/** @deprecated Capture storage now lives in the shared state database. */
dbPath: string;
/** @deprecated Capture payloads now live in the shared state database. */
blobDir: string;
certDir: string;
sessionId: string;
sourceProcess: string;
};
let cachedImplicitSessionId: string | undefined;
function isTruthy(value: string | undefined): boolean {
return value === "1" || value === "true" || value === "yes" || value === "on";
}
export function resolveDebugProxySettings(
env: NodeJS.ProcessEnv = process.env,
): DebugProxySettings {
const enabled = isTruthy(env[OPENCLAW_DEBUG_PROXY_ENABLED]);
const explicitSessionId = env[OPENCLAW_DEBUG_PROXY_SESSION_ID]?.trim() || undefined;
// Local implicit sessions stay stable within one process so repeated callers
// write to the same capture session until an explicit id overrides it.
const sessionId = explicitSessionId ?? (cachedImplicitSessionId ??= randomUUID());
return {
enabled,
required: isTruthy(env[OPENCLAW_DEBUG_PROXY_REQUIRE]),
proxyUrl: env[OPENCLAW_DEBUG_PROXY_URL]?.trim() || undefined,
dbPath: resolveDebugProxyDbPath(env),
blobDir: resolveDebugProxyBlobDir(env),
certDir: env[OPENCLAW_DEBUG_PROXY_CERT_DIR]?.trim() || resolveDebugProxyCertDir(env),
sessionId,
sourceProcess: "openclaw",
};
}
export function resolveEnabledDebugProxySettings(
resolved?: DebugProxySettings,
): DebugProxySettings | undefined {
// Disabled transport capture must not discover filesystem paths on every frame.
// Explicit settings retain their lifecycle; ambient callers observe current env.
if (!(resolved?.enabled ?? isTruthy(process.env[OPENCLAW_DEBUG_PROXY_ENABLED]))) {
return undefined;
}
return resolved ?? resolveDebugProxySettings();
}
export function applyDebugProxyEnv(
env: NodeJS.ProcessEnv,
params: {
proxyUrl: string;
sessionId: string;
certDir?: string;
},
): NodeJS.ProcessEnv {
// Child process env forces proxy capture and standard proxy variables while
// preserving unrelated environment values.
return {
...env,
[OPENCLAW_DEBUG_PROXY_ENABLED]: "1",
[OPENCLAW_DEBUG_PROXY_REQUIRE]: "1",
[OPENCLAW_DEBUG_PROXY_URL]: params.proxyUrl,
[OPENCLAW_DEBUG_PROXY_CERT_DIR]: params.certDir ?? resolveDebugProxyCertDir(env),
[OPENCLAW_DEBUG_PROXY_SESSION_ID]: params.sessionId,
HTTP_PROXY: params.proxyUrl,
HTTPS_PROXY: params.proxyUrl,
ALL_PROXY: params.proxyUrl,
};
}
export function createDebugProxyWebSocketAgent(settings: DebugProxySettings): Agent | undefined {
if (!settings.enabled || !settings.proxyUrl) {
return undefined;
}
return createAmbientNodeProxyAgent({
protocol: "https",
env: {
HTTP_PROXY: settings.proxyUrl,
HTTPS_PROXY: settings.proxyUrl,
ALL_PROXY: undefined,
NO_PROXY: undefined,
http_proxy: undefined,
https_proxy: undefined,
all_proxy: undefined,
no_proxy: undefined,
},
}) as Agent | undefined;
}
// Configured URLs win over ambient capture settings; callers use this when a
// channel/provider already exposes an explicit proxy option.
export function resolveEffectiveDebugProxyUrl(configuredProxyUrl?: string): string | undefined {
const explicit = configuredProxyUrl?.trim();
if (explicit) {
return explicit;
}
return resolveEnabledDebugProxySettings()?.proxyUrl;
}
|