Files
OmniRoute/tests/unit/8200-perplexity-web-cookie-rotation.test.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

188 lines
6.3 KiB
TypeScript

// Issue #8200: perplexity-web must persist Set-Cookie session-token rotations
// via onCredentialsRefreshed using the shared mergeRefreshedCookie +
// buildSessionCookieHeader in open-sse/utils/nextAuthCookie.ts).
import test from "node:test";
import assert from "node:assert/strict";
const { mergeRefreshedCookie, buildSessionCookieHeader } =
await import("../../open-sse/utils/nextAuthCookie.ts");
const { PerplexityWebExecutor } = await import("../../open-sse/executors/perplexity-web.ts");
const { __setTlsFetchOverrideForTesting } =
await import("../../open-sse/services/perplexityTlsClient.ts");
function mockPplxStream(answer = "Hello, world!") {
const encoder = new TextEncoder();
const body =
`event: message\r\ndata: ${JSON.stringify({
backend_uuid: "uuid-8200",
blocks: [
{
intended_usage: "markdown",
markdown_block: { chunks: [answer], progress: "DONE" },
},
],
status: "COMPLETED",
})}\r\n\r\n` + "event: end_of_stream\r\n\r\n";
return new ReadableStream({
start(controller) {
controller.enqueue(encoder.encode(body));
controller.close();
},
});
}
test("nextAuthCookie: buildSessionCookieHeader passes full DevTools cookie blob verbatim", () => {
const blob =
"__Secure-next-auth.session-token.0=partA; __Secure-next-auth.session-token.1=partB; cf_clearance=CF";
assert.equal(buildSessionCookieHeader(blob), blob);
assert.equal(buildSessionCookieHeader(`Cookie: ${blob}`), blob);
});
test("nextAuthCookie: buildSessionCookieHeader wraps bare session-token value", () => {
assert.equal(
buildSessionCookieHeader("eyJhbGciOiJIUzI1NiJ9"),
"__Secure-next-auth.session-token=eyJhbGciOiJIUzI1NiJ9"
);
});
test("nextAuthCookie: mergeRefreshedCookie preserves cf_clearance and drops stale chunks", () => {
const merged = mergeRefreshedCookie(
"__Secure-next-auth.session-token.0=OLD0; __Secure-next-auth.session-token.1=OLD1; cf_clearance=CFCLEAR",
"__Secure-next-auth.session-token.0=NEW0; Path=/; HttpOnly, __Secure-next-auth.session-token.1=NEW1; Path=/; HttpOnly"
);
assert.ok(merged);
assert.match(merged, /session-token\.0=NEW0/);
assert.match(merged, /session-token\.1=NEW1/);
assert.match(merged, /cf_clearance=CFCLEAR/);
assert.doesNotMatch(merged, /OLD0/);
assert.doesNotMatch(merged, /OLD1/);
});
test("#8200: PerplexityWebExecutor persists rotated session-token via onCredentialsRefreshed", async () => {
const captured: { cookie?: string; headers?: Record<string, string> } = {};
let persisted: Record<string, unknown> | null = null;
__setTlsFetchOverrideForTesting(async (_url, opts) => {
captured.cookie = opts.headers?.Cookie as string | undefined;
captured.headers = opts.headers as Record<string, string>;
const headers = new Headers({
"Content-Type": "text/event-stream",
"set-cookie": "__Secure-next-auth.session-token=ROTATED-VALUE; Path=/; HttpOnly; Secure",
});
return {
status: 200,
headers,
text: null,
body: mockPplxStream(),
};
});
try {
const executor = new PerplexityWebExecutor();
const result = await executor.execute({
model: "pplx-auto",
body: { messages: [{ role: "user", content: "hi" }], stream: false },
stream: false,
credentials: { apiKey: "old-cookie-value" },
signal: AbortSignal.timeout(10_000),
log: null,
onCredentialsRefreshed: async (creds) => {
persisted = creds as Record<string, unknown>;
},
});
assert.equal(result.response.status, 200);
assert.equal(
captured.cookie,
"__Secure-next-auth.session-token=old-cookie-value",
"bare apiKey must be normalized for the upstream Cookie header"
);
assert.ok(
persisted,
"onCredentialsRefreshed must fire when Set-Cookie rotates the session token"
);
assert.equal(
persisted.apiKey,
"__Secure-next-auth.session-token=ROTATED-VALUE",
"rotated cookie must round-trip as a full cookie line for DB persistence"
);
} finally {
__setTlsFetchOverrideForTesting(null);
}
});
test("#8200: PerplexityWebExecutor preserves cf_clearance when session-token rotates", async () => {
let persisted: Record<string, unknown> | null = null;
__setTlsFetchOverrideForTesting(async () => {
const headers = new Headers({
"Content-Type": "text/event-stream",
"set-cookie":
"__Secure-next-auth.session-token.0=NEW0; Path=/; HttpOnly, " +
"__Secure-next-auth.session-token.1=NEW1; Path=/; HttpOnly",
});
return {
status: 200,
headers,
text: null,
body: mockPplxStream(),
};
});
try {
const executor = new PerplexityWebExecutor();
await executor.execute({
model: "pplx-auto",
body: { messages: [{ role: "user", content: "hi" }], stream: false },
stream: false,
credentials: {
apiKey: "__Secure-next-auth.session-token=UNCHUNKED_OLD; cf_clearance=CFCLEAR",
},
signal: AbortSignal.timeout(10_000),
log: null,
onCredentialsRefreshed: async (creds) => {
persisted = creds as Record<string, unknown>;
},
});
assert.ok(persisted);
const apiKey = String(persisted.apiKey);
assert.match(apiKey, /cf_clearance=CFCLEAR/, "non-session cookies must survive rotation merge");
assert.match(apiKey, /session-token\.0=NEW0/);
assert.match(apiKey, /session-token\.1=NEW1/);
assert.doesNotMatch(apiKey, /UNCHUNKED_OLD/);
} finally {
__setTlsFetchOverrideForTesting(null);
}
});
test("#8200: PerplexityWebExecutor skips onCredentialsRefreshed when Set-Cookie is absent", async () => {
let persisted = false;
__setTlsFetchOverrideForTesting(async () => ({
status: 200,
headers: new Headers({ "Content-Type": "text/event-stream" }),
text: null,
body: mockPplxStream(),
}));
try {
const executor = new PerplexityWebExecutor();
await executor.execute({
model: "pplx-auto",
body: { messages: [{ role: "user", content: "hi" }], stream: false },
stream: false,
credentials: { apiKey: "stable-cookie" },
signal: AbortSignal.timeout(10_000),
log: null,
onCredentialsRefreshed: async () => {
persisted = true;
},
});
assert.equal(persisted, false, "callback must not fire without a session-token rotation");
} finally {
__setTlsFetchOverrideForTesting(null);
}
});