Files
OmniRoute/open-sse/services/sessionPool/webExecutorWrapper.ts
Diego Rodrigues de Sa e Souza 7d57d9f4a1 fix(providers): retire common ChatGPT Web provider (#11754)
Rebased onto the current release/v3.8.51 tip as part of a combined provider-retirement/provenance merge batch (Designer Web, Felo Web, Runtime, GPL-derived removal, Qwen Web already landed). Large conflict set (this is the biggest PR in the batch — the common ChatGPT Web provider touches chat, images, count-tokens, session leases, and combos). Conflicts resolved:

- `open-sse/config/providers/registry/chatgpt-web/*`, `open-sse/executors/chatgpt-web*`, `open-sse/handlers/imageGeneration/providers/chatgptWeb.ts`, and their tests: kept deleted, matching the PR's stated scope.
- `open-sse/config/providers/registry/minimax/web/index.ts`, `open-sse/handlers/imageGeneration/providers/geminiWeb.ts`, `open-sse/executors/gemini-web.ts`'s stale image-mode branch: base-drift collisions against already-merged sibling retirements (#11691, #11708) — kept deleted / dropped the dead code, since this PR's own branch forked before those merged.
- `src/shared/constants/reservedProviderPrefixes.ts`, `open-sse/executors/index.ts`, `executorProxy.ts`, `virtualFactory.ts`, `autoStrategy.ts`, `src/lib/db/providers.ts`, `src/sse/handlers/chat.ts`: combined the Designer + Runtime (Felo/Qwen) + common-ChatGPT-Web retirement guard calls at each shared chokepoint — compute-once-then-OR pattern, consistent with prior combinations in this batch.
- `src/sse/services/model.ts` / `src/sse/handlers/chatHelpers.ts`: adopted this PR's new `getModelInfoOrRetirementResponse()` central wrapper (a real improvement over ad-hoc try/catch), and extended it to also catch the Designer + Runtime retirement errors it didn't originally cover, so the consolidation doesn't regress the other two mechanisms.
- `src/app/api/v1/images/edits/route.ts`: this PR moved the retirement check earlier (before `enforceApiKeyPolicy`) but left the old later call+catch block in place from base drift — removed the now-redundant duplicate `resolveImageRouteModel()` call and merged the Designer catch into the earlier one.
- `open-sse/config/imageRegistry.ts`, `tests/snapshots/executors/executor-map.json` (`keyCount` recomputed to 133), `tests/snapshots/provider/translate-path.json`: same "both sides inserted a different retired provider at the same slot" pattern — resolved by dropping both.
- `tests/unit/chatcore-executor-proxy.test.ts`, `provider-node-reserved-prefix.test.ts`, `combo-auto-candidate-expansion.test.ts`, `messages-count-tokens-route.test.ts`, `virtual-auto-combo.test.ts`: split into independent per-mechanism test blocks (established pattern); `virtual-auto-combo.test.ts`'s old "includes cookie web-session providers" positive-inclusion test (which used chatgpt-web as its example) was retired along with the provider and replaced by this PR's negative-exclusion test for the same slot.
- `docs/architecture/ARCHITECTURE.md`, `CODEBASE_DOCUMENTATION.md` (+ 4 i18n mirrors), `README.md`, `FREE-TIERS-GUIDE.md`, `docs/diagrams/free-tier-budget.svg`, `docs/screenshots/free-tier-budget-card.svg`, `docs/reference/PROVIDER_REFERENCE.md`: recomputed every stale count from the real merged state — 104 executors (`countFiles` gate logic), 351 providers (regenerated via `gen:provider-reference`), 152/351 `hasFree` entries, 445/438/7 free-tier catalog rows, 13 ToS-avoid providers, budget-card regenerated via its real generator script. One doc conflict (`oauth/` module list) needed picking HEAD's side specifically — theirs still listed the already-removed `raycast` module instead of the real `openference`.
- `config/quality/test-masking-allowlist.json`: additive merge of the PR's 17 `_deletedWithReplacement` entries alongside the batch's existing ones (one real duplicate-key mistake in my first pass, caught and fixed via a `object_pairs_hook` duplicate-key check before finalizing).

Also fixed two real, unrelated-to-my-merge issues surfaced by the focused suite:
- `tests/unit/resolve-web-provider-host.test.ts`: the PR's own test had a typo — it asserted `perplexity-web`'s resolved host as `"perplexity.ai"`, but the provider's registered `website` is `"https://www.perplexity.ai"` and the resolver returns the URL's `host` verbatim (no www-stripping), so the correct value is `"www.perplexity.ai"` (consistent with the same test's own `url` assertion).
- `tests/unit/hard-session-lease-bypass-inventory.test.ts`: this golden call-site inventory was already stale on the pristine post-#11713 tip (confirmed via a throwaway probe worktree) — `src/lib/db/providers.ts`'s 3 connection-fallback sites and a third `src/app/api/providers/route.ts` site were never added to the golden list by the earlier-merged #11698/#11720 PRs. Updated it to the real current inventory (dated inline comments explain each delta and which PR introduced it), plus this PR's own legitimate deltas (image-edits duplicate-call removal, `ChatGptWebExecutor.execute()` site removed).

Focused suite green (433/433 across executor-proxy, reserved-prefix, hard-session-lease-bypass-inventory, resolve-web-provider-host, retirement/runtime-block/source-retirement/management-retirement/image-handler-retirement, migration-168, combo-auto-candidate-expansion, virtual-auto-combo, executor-map-golden and siblings), plus `typecheck:core`, `check-file-size`, and `check-changelog-integrity` clean. Thanks for the thorough provenance-hold retirement work — appreciated.
2026-08-28 06:52:46 -03:00

133 lines
3.6 KiB
TypeScript

/**
* WebExecutorWrapper — Wraps any web executor with session pool support
*
* This is the integration bridge between the session pool and OmniRoute's
* executor system. It intercepts the fetch() call to add session-pool
* headers (fingerprint-based User-Agent, Sec-CH-UA, etc.) and handles
* 429/5xx responses with pool-level cooldown management.
*
* Future: For browser-session providers (DeepSeek Web, etc.)
* the wrapper will also inject cookies from the Playwright-authenticated
* session.
*/
import { Session } from "./session.ts";
import { SessionPool } from "./sessionPool.ts";
export interface WebExecutorRequest {
url: string;
method?: string;
headers?: Record<string, string>;
body?: string;
signal?: AbortSignal;
[key: string]: unknown;
}
export interface WebExecutorResponse {
status: number;
statusText?: string;
headers?: Record<string, string>;
body: string;
ok: boolean;
[key: string]: unknown;
}
export interface WebExecutorFn {
(req: WebExecutorRequest): Promise<WebExecutorResponse>;
}
/**
* Decorate a web executor function with session pool support.
*
* Before the underlying executor fires:
* 1. Acquires a session from the pool (reusable, fingerprint-isolated)
* 2. Merges session headers (UA + Sec-CH-UA) into the request
* 3. Handles 429 → pool cooldown, 5xx → session death
*
* For zero-auth providers like Pollinations this is all
* that's needed for "truly unlimited" — the fingerprint rotation alone
* defeats burst-based rate limiting.
*/
export function withSessionPool(
executor: WebExecutorFn,
pool: SessionPool,
options?: {
/** When true, wraps the response body for error handling */
wrapResponse?: boolean;
}
): WebExecutorFn {
const wrapResponse = options?.wrapResponse ?? true;
return async (req: WebExecutorRequest): Promise<WebExecutorResponse> => {
// Acquire session from pool (blocking with backoff)
let session: Session | null = null;
try {
session = await pool.acquireBlocking();
} catch (err) {
return {
status: 503,
statusText: "Service Unavailable",
body: JSON.stringify({
error: "session_pool_exhausted",
message: `[SessionPool:${pool.provider}] ${(err as Error).message}`,
}),
ok: false,
headers: {},
};
}
try {
// Build request with session fingerprint headers
const sessionHeaders = session.buildHeaders(req.headers);
const poolReq: WebExecutorRequest = {
...req,
headers: sessionHeaders,
};
// Execute the underlying web request
const res = await executor(poolReq);
// Handle response status
if (res.status === 429) {
pool.reportCooldown(session);
if (wrapResponse) {
return {
...res,
body: JSON.stringify({
error: "pool_rate_limited",
message: `[SessionPool:${pool.provider}] Rate limited, session ${session.id} in cooldown`,
}),
};
}
return res;
}
if (res.status >= 500) {
pool.reportDead(session);
return res;
}
// Success
pool.reportSuccess(session);
pool.totalRequests++;
return res;
} catch (err) {
// Network error — cooldown, not dead (may be transient)
pool.reportCooldown(session);
return {
status: 502,
statusText: "Bad Gateway",
body: JSON.stringify({
error: "pool_network_error",
message: (err as Error).message,
}),
ok: false,
headers: {},
};
} finally {
session.release();
}
};
}