[core] rename CookieStore to CookieJar to avoid conflicting with existing browser api

velzie · velzie · commit 99c5917f7edf · 2025-10-03T18:29:42.000-04:00
diff --git a/packages/scramjet/src/client/client.ts b/packages/scramjet/src/client/client.ts
@@ -7,7 +7,7 @@ import { createWrapFn } from "@client/shared/wrap";
 import { NavigateEvent } from "@client/events";
 import { rewriteUrl, unrewriteUrl, type URLMeta } from "@rewriters/url";
 import { config, flagEnabled } from "@/shared";
-import { CookieStore } from "@/shared/cookie";
+import { CookieJar } from "@/shared/cookie";
 import { iswindow } from "./entry";
 import { SingletonBox } from "./singletonbox";
 
@@ -70,7 +70,7 @@ export class ScramjetClient {
 	descriptors: DescriptorStore;
 	wrapfn: (i: any, ...args: any) => any;
 
-	cookieStore = new CookieStore();
+	cookieStore = new CookieJar();
 
 	eventcallbacks: Map<
 		any,
diff --git a/packages/scramjet/src/shared/cookie.ts b/packages/scramjet/src/shared/cookie.ts
@@ -13,7 +13,7 @@ export type Cookie = {
 	sameSite?: "strict" | "lax" | "none";
 };
 
-export class CookieStore {
+export class CookieJar {
 	private cookies: Record<string, Cookie> = {};
 
 	setCookies(cookies: string[], url: URL) {
diff --git a/packages/scramjet/src/shared/htmlRules.ts b/packages/scramjet/src/shared/htmlRules.ts
@@ -1,11 +1,11 @@
-import { CookieStore } from "@/shared/cookie";
+import { CookieJar } from "@/shared/cookie";
 import { rewriteCss } from "@rewriters/css";
 import { rewriteHtml, rewriteSrcset } from "@rewriters/html";
 import { rewriteUrl, unrewriteBlob, URLMeta } from "@rewriters/url";
 
 export const htmlRules: {
 	[key: string]: "*" | string[] | ((...any: any[]) => string | null);
-	fn: (value: string, meta: URLMeta, cookieStore: CookieStore) => string | null;
+	fn: (value: string, meta: URLMeta, cookieStore: CookieJar) => string | null;
 }[] = [
 	{
 		fn: (value: string, meta: URLMeta) => {
@@ -71,7 +71,7 @@ export const htmlRules: {
 		imagesrcset: ["link"],
 	},
 	{
-		fn: (value: string, meta: URLMeta, cookieStore: CookieStore) =>
+		fn: (value: string, meta: URLMeta, cookieStore: CookieJar) =>
 			rewriteHtml(
 				value,
 				cookieStore,
diff --git a/packages/scramjet/src/shared/rewriters/html.ts b/packages/scramjet/src/shared/rewriters/html.ts
@@ -4,12 +4,12 @@ import render from "dom-serializer";
 import { URLMeta, rewriteUrl } from "@rewriters/url";
 import { rewriteCss } from "@rewriters/css";
 import { rewriteJs } from "@rewriters/js";
-import { CookieStore } from "@/shared/cookie";
+import { CookieJar } from "@/shared/cookie";
 import { config } from "@/shared";
 import { htmlRules } from "@/shared/htmlRules";
 
 export function getInjectScripts<T>(
-	cookieStore: CookieStore,
+	cookieStore: CookieJar,
 	script: (src: string) => T
 ): T[] {
 	const dump = JSON.stringify(cookieStore.dump());
@@ -34,7 +34,7 @@ export function getInjectScripts<T>(
 const encoder = new TextEncoder();
 function rewriteHtmlInner(
 	html: string,
-	cookieStore: CookieStore,
+	cookieStore: CookieJar,
 	meta: URLMeta,
 	fromTop: boolean = false,
 	preRewrite?: (handler: DomHandler) => void,
@@ -82,7 +82,7 @@ function rewriteHtmlInner(
 
 export function rewriteHtml(
 	html: string,
-	cookieStore: CookieStore,
+	cookieStore: CookieJar,
 	meta: URLMeta,
 	fromTop: boolean = false,
 	preRewrite?: (handler: DomHandler) => void,
@@ -146,11 +146,7 @@ export function unrewriteHtml(html: string) {
 
 // i need to add the attributes in during rewriting
 
-function traverseParsedHtml(
-	node: any,
-	cookieStore: CookieStore,
-	meta: URLMeta
-) {
+function traverseParsedHtml(node: any, cookieStore: CookieJar, meta: URLMeta) {
 	if (node.name === "base" && node.attribs.href !== undefined) {
 		meta.base = new URL(node.attribs.href, meta.origin);
 	}
diff --git a/packages/scramjet/src/shared/rewriters/wasm.ts b/packages/scramjet/src/shared/rewriters/wasm.ts
@@ -10,7 +10,7 @@ import { htmlRules } from "@/shared/htmlRules";
 import { rewriteCss } from "@rewriters/css";
 import { rewriteJs } from "@rewriters/js";
 import { getInjectScripts } from "@rewriters/html";
-import { CookieStore } from "@/shared/cookie";
+import { CookieJar } from "@/shared/cookie";
 
 let wasm_u8: Uint8Array<ArrayBuffer>;
 
@@ -64,7 +64,7 @@ export function getRewriter(meta: URLMeta): [Rewriter, () => void] {
 					rewriteUrl,
 					rewriteCss,
 					rewriteJs,
-					getHtmlInjectCode(cookieStore: CookieStore, foundHead: boolean) {
+					getHtmlInjectCode(cookieStore: CookieJar, foundHead: boolean) {
 						let inject = getInjectScripts(
 							cookieStore,
 							(src) => `<script src="${src}"></script>`
diff --git a/packages/scramjet/src/shared/security/index.ts b/packages/scramjet/src/shared/security/index.ts
@@ -1,2 +1,2 @@
-export * from "./forceReferrer";
+// export * from "./forceReferrer";
 export * from "./siteTests";
diff --git a/packages/scramjet/src/worker/fetch.ts b/packages/scramjet/src/worker/fetch.ts
@@ -3,7 +3,7 @@ import { BareClient, BareHeaders, BareResponseFetch } from "../bare-mux-custom";
 import { MessageW2C, ScramjetServiceWorker } from "@/worker";
 import { renderError } from "@/worker/error";
 import { FakeServiceWorker } from "@/worker/fakesw";
-import { CookieStore } from "@/shared/cookie";
+import { CookieJar } from "@/shared/cookie";
 
 import {
 	rewriteUrl,
@@ -32,7 +32,7 @@ export interface ScramjetFetchContext {
 
 	forceCrossOriginIsolated: boolean;
 	initialHeaders: ScramjetHeaders;
-	cookieStore: CookieStore;
+	cookieStore: CookieJar;
 
 	rawClientUrl?: URL;
 }
@@ -584,57 +584,57 @@ export async function rewriteHeaders(
 	// Emulate the referrer policy to set it back to what it should've been without Force Referrer in place
 	if (typeof headers["referer"] === "string") {
 		const referrerUrl = new URL(headers["referer"]);
-		const storedPolicyData = await getReferrerPolicy(referrerUrl.href);
-		if (storedPolicyData) {
-			const storedReferrerPolicy = storedPolicyData.policy
-				.toLowerCase()
-				.split(",")
-				.map((rawDir) => rawDir.trim());
-			if (
-				storedReferrerPolicy.includes("no-referrer") ||
-				(storedReferrerPolicy.includes("no-referrer-when-downgrade") &&
-					parsed.meta.origin.protocol === "http:" &&
-					referrerUrl.protocol === "https:")
-			) {
-				delete headers["referer"];
-			} else if (storedReferrerPolicy.includes("origin")) {
-				headers["referer"] = referrerUrl.origin;
-			} else if (storedReferrerPolicy.includes("origin-when-cross-origin")) {
-				if (referrerUrl.origin !== parsed.meta.origin.origin) {
-					headers["referer"] = referrerUrl.origin;
-				} else {
-					headers["referer"] = referrerUrl.href;
-				}
-			} else if (storedReferrerPolicy.includes("same-origin")) {
-				if (referrerUrl.origin === parsed.meta.origin.origin) {
-					headers["referer"] = referrerUrl.href;
-				} else {
-					delete headers["referer"];
-				}
-			} else if (storedReferrerPolicy.includes("strict-origin")) {
-				if (
-					parsed.meta.origin.protocol === "http:" &&
-					referrerUrl.protocol === "https:"
-				) {
-					delete headers["referer"];
-				} else {
-					headers["referer"] = referrerUrl.origin;
-				}
-			}
-			// `strict-origin-when-cross-origin` is the default behavior anyway
-			else {
-				if (referrerUrl.origin === parsed.meta.origin.origin) {
-					headers["referer"] = referrerUrl.href;
-				} else if (
-					parsed.meta.origin.protocol === "http:" &&
-					referrerUrl.protocol === "https:"
-				) {
-					delete headers["referer"];
-				} else {
-					headers["referer"] = referrerUrl.origin;
-				}
-			}
+		// const storedPolicyData = await getReferrerPolicy(referrerUrl.href);
+		// if (storedPolicyData) {
+		// 	const storedReferrerPolicy = storedPolicyData.policy
+		// 		.toLowerCase()
+		// 		.split(",")
+		// 		.map((rawDir) => rawDir.trim());
+		// 	if (
+		// 		storedReferrerPolicy.includes("no-referrer") ||
+		// 		(storedReferrerPolicy.includes("no-referrer-when-downgrade") &&
+		// 			parsed.meta.origin.protocol === "http:" &&
+		// 			referrerUrl.protocol === "https:")
+		// 	) {
+		// 		delete headers["referer"];
+		// 	} else if (storedReferrerPolicy.includes("origin")) {
+		// 		headers["referer"] = referrerUrl.origin;
+		// 	} else if (storedReferrerPolicy.includes("origin-when-cross-origin")) {
+		// 		if (referrerUrl.origin !== parsed.meta.origin.origin) {
+		// 			headers["referer"] = referrerUrl.origin;
+		// 		} else {
+		// 			headers["referer"] = referrerUrl.href;
+		// 		}
+		// 	} else if (storedReferrerPolicy.includes("same-origin")) {
+		// 		if (referrerUrl.origin === parsed.meta.origin.origin) {
+		// 			headers["referer"] = referrerUrl.href;
+		// 		} else {
+		// 			delete headers["referer"];
+		// 		}
+		// 	} else if (storedReferrerPolicy.includes("strict-origin")) {
+		// 		if (
+		// 			parsed.meta.origin.protocol === "http:" &&
+		// 			referrerUrl.protocol === "https:"
+		// 		) {
+		// 			delete headers["referer"];
+		// 		} else {
+		// 			headers["referer"] = referrerUrl.origin;
+		// 		}
+		// 	}
+		// 	// `strict-origin-when-cross-origin` is the default behavior anyway
+		// 	else {
+		if (referrerUrl.origin === parsed.meta.origin.origin) {
+			headers["referer"] = referrerUrl.href;
+		} else if (
+			parsed.meta.origin.protocol === "http:" &&
+			referrerUrl.protocol === "https:"
+		) {
+			delete headers["referer"];
+		} else {
+			headers["referer"] = referrerUrl.origin;
 		}
+		// }
+		// }
 	}
 	if (
 		typeof headers["sec-fetch-dest"] === "string" &&
@@ -661,18 +661,18 @@ export async function rewriteHeaders(
 		}
 	}
 
-	const isNavigationRequest =
-		context.mode === "navigate" &&
-		["document", "iframe"].includes(context.destination);
+	// const isNavigationRequest =
+	// 	context.mode === "navigate" &&
+	// 	["document", "iframe"].includes(context.destination);
 
 	// Store referrer policy from navigation responses for Force Referrer
-	if (isNavigationRequest && headers["referrer-policy"] && context.referrer) {
-		await storeReferrerPolicy(
-			parsed.url.href,
-			headers["referrer-policy"],
-			context.referrer
-		);
-	}
+	// if (isNavigationRequest && headers["referrer-policy"] && context.referrer) {
+	// 	await storeReferrerPolicy(
+	// 		parsed.url.href,
+	// 		headers["referrer-policy"],
+	// 		context.referrer
+	// 	);
+	// }
 
 	if (headers["accept"] === "text/event-stream") {
 		headers["content-type"] = "text/event-stream";
diff --git a/packages/scramjet/src/worker/index.ts b/packages/scramjet/src/worker/index.ts
@@ -7,7 +7,7 @@ import { handleFetch, ScramjetFetchContext } from "@/worker/fetch";
 import { BareClient } from "../bare-mux-custom";
 import { ScramjetConfig, ScramjetDB } from "@/types";
 import { asyncSetWasm } from "@rewriters/wasm";
-import { CookieStore } from "@/shared/cookie";
+import { CookieJar } from "@/shared/cookie";
 import { ScramjetHeaders, setConfig, unrewriteUrl } from "@/shared";
 import { openDB } from "idb";
 import { ScramjetDownload } from "@client/events";
@@ -42,7 +42,7 @@ export class ScramjetServiceWorker extends EventTarget {
 	/**
 	 * Scramjet's cookie jar for cookie emulation through other storage means, connected to a client.
 	 */
-	cookieStore = new CookieStore();
+	cookieStore = new CookieJar();
 
 	/**
 	 * Fake service worker registrations, so that some sites don't complain.

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-export * from "./forceReferrer";`
	`1`	`+// export * from "./forceReferrer";`
`2`	`2`	`export * from "./siteTests";`