Files
orca/src/main/network/proxy-settings.ts
T
Brennan BensonandJinwoo-H d9870c6c75 fix(browser): apply the app-wide HTTP proxy to embedded browser sessions (#15536)
* fix(browser): apply the app-wide HTTP proxy to embedded browser sessions

The proxy setting was only ever written to `session.defaultSession`, but browser
guests run on their own `persist:orca-*` partitions. Any host reachable only via
the configured proxy failed to load in an embedded tab, landing on
`chrome-error://chromewebdata/`, while the same setting worked everywhere else.

Adds a per-session applier alongside the existing defaultSession path, keyed by a
WeakMap so one session's applied config can't suppress another's, and applies it
to every browser partition through the single installer they all pass through.
Startup awaits an explicit sweep so the first guest navigation can't race the
installer's fire-and-forget write, and a settings change re-sweeps so toggling
the proxy takes effect without a restart.

Env-var fallback and the system-proxy probe mirror the defaultSession behaviour,
so a browser partition resolves the proxy the same way the rest of the app does.

Fixes STA-4779

* fix(browser): await per-session proxy readiness

* fix(proxy): preserve loopback and authenticate

* fix(proxy): settle browser partition update races

* fix(proxy): close partition policy races

* fix(proxy): order settings and release removed sessions

* test(browser): await partition proxy readiness

* fix(proxy): cancel removed partition retries

* refactor(proxy): keep OpenCode rate limits out of scope

* fix(proxy): preserve sessionless host policy

* fix(proxy): gate requests on policy readiness

* fix(proxy): retire deleted browser sessions

* fix(proxy): close retired browser guests

* fix(proxy): retain retired session guards

* fix(proxy): retain retired partition policies

* fix(browser): retry transient proxy application failures

* fix(browser): release deleted partition installer state

* fix(proxy): retry delayed transient failures

* fix(proxy): preserve route session authority after rebase

* fix(proxy): clear retired session credentials

* fix(proxy): retire failed browser profiles

* fix(proxy): harden failed session cleanup

---------

Co-authored-by: Jinwoo-H <jinwoo0825@gmail.com>
2026-08-30 04:53:20 -04:00

326 lines
10 KiB
TypeScript

import {
getProxyBypassRulesFromEnvironment,
getProxyUrlFromEnvironment,
normalizeProxyBypassRules,
normalizeProxyUrl,
type NetworkProxySettings
} from '../../shared/network-proxy'
import {
clearElectronProxyCredentialsForSession,
haveSameElectronProxyCredentials,
resetElectronProxyCredentialsForTests,
separateElectronProxyCredentials,
setElectronProxyCredentialsForSession,
type ElectronProxyCredentials
} from './electron-proxy-credentials'
import { runBoundedProxyApplication } from './bounded-proxy-application'
import { defaultProxySession, type ProxySession } from './electron-default-proxy-session'
import { resolveProxyPolicyWithoutSession, type ProxyApplyResult } from './proxy-policy-resolution'
export { setDefaultProxySessionResolver } from './electron-default-proxy-session'
export type { ProxyApplyResult } from './proxy-policy-resolution'
const PROXY_PROBE_URL = 'https://api.anthropic.com/'
type SessionProxyApplicationState = {
appliedKey: string | null
settledKey: string | null
appliedResult: Extract<ProxyApplyResult, { source: 'settings' | 'env' }> | null
credentials: ElectronProxyCredentials | null
tail: Promise<unknown>
readiness: 'ready' | 'pending' | 'failed'
retired: boolean
}
let sessionProxyApplications = new WeakMap<ProxySession, SessionProxyApplicationState>()
function proxyMemoKey(result: ProxyApplyResult): string {
return result.source === 'settings' || result.source === 'env'
? `${result.source}\0${result.proxyRules}\0${result.proxyBypassRules ?? ''}`
: result.source
}
export function resetProxyApplicationForTests(): void {
sessionProxyApplications = new WeakMap()
resetElectronProxyCredentialsForTests()
}
export function resetSessionProxyApplicationForTests(proxySession: ProxySession): void {
sessionProxyApplications.delete(proxySession)
clearElectronProxyCredentialsForSession(proxySession)
}
export function clearProxySessionCredentials(proxySession: ProxySession): void {
const state = sessionProxyApplications.get(proxySession)
if (state) {
state.credentials = null
}
clearElectronProxyCredentialsForSession(proxySession)
}
/** Wait for the newest queued policy; false keeps requests fail-closed after an apply error. */
export async function awaitProxySessionApplication(proxySession: ProxySession): Promise<boolean> {
while (true) {
const state = sessionProxyApplications.get(proxySession)
if (!state || state.retired) {
return !state
}
const observed = state.tail
try {
await observed
} catch {
if (state.tail === observed) {
return false
}
continue
}
if (state.tail === observed) {
return !state.retired
}
}
}
export function getProxySessionApplicationReadiness(
proxySession: ProxySession
): boolean | Promise<boolean> {
const state = sessionProxyApplications.get(proxySession)
if (!state) {
return true
}
if (state.retired || state.readiness === 'failed') {
return false
}
if (state.readiness === 'ready') {
return true
}
return awaitProxySessionApplication(proxySession)
}
export async function releaseProxySessionApplication(
proxySession: ProxySession,
allowRetired = false
): Promise<void> {
await enqueueSessionProxyApplication(
proxySession,
async (state) => {
await releaseSessionProxyPin(proxySession, state)
clearElectronProxyCredentialsForSession(proxySession)
return { source: 'none' }
},
allowRetired
)
}
/** Permanently close request readiness before releasing a deleted partition. */
export async function retireProxySessionApplication(proxySession: ProxySession): Promise<void> {
const state = getSessionProxyApplicationState(proxySession)
state.retired = true
try {
await releaseProxySessionApplication(proxySession, true)
} finally {
clearProxySessionCredentials(proxySession)
}
}
function getSessionProxyApplicationState(proxySession: ProxySession): SessionProxyApplicationState {
let state = sessionProxyApplications.get(proxySession)
if (!state) {
state = {
appliedKey: null,
settledKey: null,
appliedResult: null,
credentials: null,
tail: Promise.resolve(),
readiness: 'ready',
retired: false
}
sessionProxyApplications.set(proxySession, state)
}
return state
}
async function enqueueSessionProxyApplication(
proxySession: ProxySession,
apply: (state: SessionProxyApplicationState) => Promise<ProxyApplyResult>,
allowRetired = false
): Promise<ProxyApplyResult> {
const state = getSessionProxyApplicationState(proxySession)
if (state.retired && !allowRetired) {
throw new Error('Proxy session is retired')
}
const operation = state.tail
.catch(() => {})
.then(() => runBoundedProxyApplication(() => apply(state)))
state.tail = operation
state.readiness = 'pending'
void operation.then(
() => {
if (state.tail === operation) {
state.readiness = 'ready'
}
},
() => {
if (state.tail === operation) {
state.readiness = 'failed'
}
}
)
return operation
}
/** Apply the app-wide proxy to one session, serializing writes in call order. */
export function applyProxySettingsToSession(
proxySession: ProxySession,
settings: NetworkProxySettings,
options: { env?: Record<string, string | undefined>; probeUrl?: string } = {}
): Promise<ProxyApplyResult> {
return enqueueSessionProxyApplication(proxySession, (state) =>
resolveAndApplySessionProxy(proxySession, state, settings, options)
)
}
async function resolveAndApplySessionProxy(
proxySession: ProxySession,
state: SessionProxyApplicationState,
settings: NetworkProxySettings,
options: { env?: Record<string, string | undefined>; probeUrl?: string }
): Promise<ProxyApplyResult> {
const env = options.env ?? process.env
const configured = normalizeProxyUrl(settings.httpProxyUrl)
if (configured.ok && configured.value) {
const { proxyRules, credentials } = separateElectronProxyCredentials(configured.value)
const bypassRules = normalizeProxyBypassRules(settings.httpProxyBypassRules)
const result: ProxyApplyResult = {
source: 'settings',
proxyRules,
...(bypassRules ? { proxyBypassRules: bypassRules } : {})
}
return applySessionProxyResult(proxySession, state, result, credentials)
}
const envProxy = getProxyUrlFromEnvironment(env)
if (envProxy.ok && envProxy.value) {
const { proxyRules, credentials } = separateElectronProxyCredentials(envProxy.value)
const bypassRules = normalizeProxyBypassRules(getProxyBypassRulesFromEnvironment(env))
const result: Extract<ProxyApplyResult, { source: 'env' }> = {
source: 'env',
proxyRules,
...(bypassRules ? { proxyBypassRules: bypassRules } : {})
}
if (
state.settledKey === proxyMemoKey(result) &&
haveSameElectronProxyCredentials(state.credentials, credentials)
) {
return result
}
}
// Why: a pinned session resolves to its own pin, so release it before probing the system proxy.
await releaseSessionProxyPin(proxySession, state)
if ((await proxySession.resolveProxy(options.probeUrl ?? PROXY_PROBE_URL)) !== 'DIRECT') {
return { source: 'system' }
}
if (!envProxy.ok) {
return { source: configured.ok ? 'invalid-env' : 'invalid-settings' }
}
if (!envProxy.value) {
return { source: configured.ok ? 'none' : 'invalid-settings' }
}
const { proxyRules, credentials } = separateElectronProxyCredentials(envProxy.value)
const bypassRules = normalizeProxyBypassRules(getProxyBypassRulesFromEnvironment(env))
return applySessionProxyResult(
proxySession,
state,
{
source: 'env',
proxyRules,
...(bypassRules ? { proxyBypassRules: bypassRules } : {})
},
credentials
)
}
async function releaseSessionProxyPin(
proxySession: ProxySession,
state: SessionProxyApplicationState
): Promise<void> {
if (state.appliedKey === null) {
return
}
await proxySession.setProxy({ mode: 'system' })
// Why: keep the pin marker until stale pooled connections are closed so a retry cannot skip them.
state.settledKey = null
state.credentials = null
setElectronProxyCredentialsForSession(proxySession, null)
await proxySession.closeAllConnections?.()
state.appliedKey = null
state.appliedResult = null
}
async function applySessionProxyResult(
proxySession: ProxySession,
state: SessionProxyApplicationState,
result: Extract<ProxyApplyResult, { source: 'settings' | 'env' }>,
credentials: ElectronProxyCredentials | null
): Promise<ProxyApplyResult> {
const key = proxyMemoKey(result)
if (
state.settledKey === key &&
haveSameElectronProxyCredentials(state.credentials, credentials)
) {
return result
}
await proxySession.setProxy({
mode: 'fixed_servers',
proxyRules: result.proxyRules,
...(result.proxyBypassRules ? { proxyBypassRules: result.proxyBypassRules } : {})
})
state.appliedKey = key
state.settledKey = null
state.appliedResult = result
state.credentials = credentials
setElectronProxyCredentialsForSession(proxySession, credentials)
await proxySession.closeAllConnections?.()
state.settledKey = key
return result
}
export async function ensureElectronProxyFromEnvironment(
options: {
proxySession?: ProxySession
env?: Record<string, string | undefined>
force?: boolean
probeUrl?: string
} = {}
): Promise<ProxyApplyResult> {
const proxySession = options.proxySession ?? defaultProxySession()
if (!proxySession) {
return resolveProxyPolicyWithoutSession({}, options.env ?? process.env)
}
return enqueueSessionProxyApplication(proxySession, (state) => {
if (!options.force && state.appliedResult !== null) {
if (state.settledKey === proxyMemoKey(state.appliedResult)) {
return Promise.resolve(state.appliedResult)
}
return applySessionProxyResult(proxySession, state, state.appliedResult, state.credentials)
}
return resolveAndApplySessionProxy(proxySession, state, {}, options)
})
}
export function applyElectronProxySettings(
settings: NetworkProxySettings,
options: {
proxySession?: ProxySession
env?: Record<string, string | undefined>
probeUrl?: string
} = {}
): Promise<ProxyApplyResult> {
const proxySession = options.proxySession ?? defaultProxySession()
if (!proxySession) {
return Promise.resolve(resolveProxyPolicyWithoutSession(settings, options.env ?? process.env))
}
return applyProxySettingsToSession(proxySession, settings, {
env: options.env,
probeUrl: options.probeUrl
})
}