// @effect-diagnostics nodeBuiltinImport:off - Builds a Firefox-shaped
// `cookies.sqlite` fixture with the same native bindings Firefox itself uses.
import * as NodePath from "@effect/platform-node/NodePath";
import * as NodeServices from "@effect/platform-node/NodeServices";
import { describe, expect, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as FileSystem from "effect/FileSystem";
import * as Path from "effect/Path";
import * as Scope from "effect/Scope";
import * as NodeSqlite from "node:sqlite";
import { readFirefoxCookies } from "./FirefoxCookies.ts";
import { parseFirefoxProfiles } from "./Sources.ts";
const parsePosixFirefoxProfiles = (ini: string, root = "/home/user/.mozilla/firefox") =>
Effect.gen(function* () {
const path = yield* Path.Path;
return parseFirefoxProfiles(ini, path, root);
}).pipe(Effect.provide(NodePath.layerPosix));
const parseWindowsFirefoxProfiles = (ini: string, root = "C:\\Users\\user\\Firefox") =>
Effect.gen(function* () {
const path = yield* Path.Path;
return parseFirefoxProfiles(ini, path, root);
}).pipe(Effect.provide(NodePath.layerWin32));
const writeFirefoxCookieDatabase = Effect.fnUntraced(function* (
rows: ReadonlyArray<{
host: string;
name: string;
value: string;
path: string;
expiry: number;
isSecure: number;
isHttpOnly: number;
sameSite: number | null;
rawSameSite?: number;
originAttributes?: string;
}>,
schemaVersion = 15,
) {
const fileSystem = yield* FileSystem.FileSystem;
const directory = yield* fileSystem.makeTempDirectoryScoped({ prefix: "t3code-firefox-test-" });
const file = `${directory}/cookies.sqlite`;
const database = new NodeSqlite.DatabaseSync(file);
database.exec(`pragma user_version = ${schemaVersion}`);
const hasRawSameSite = schemaVersion >= 10 && schemaVersion <= 14;
database.exec(
`create table moz_cookies (
id integer primary key, host text, name text, value text, path text,
expiry integer, isSecure integer, isHttpOnly integer, sameSite integer,
${hasRawSameSite ? "rawSameSite integer," : ""}
originAttributes text not null default ''
)`,
);
const insert = database.prepare(
`insert into moz_cookies
(host, name, value, path, expiry, isSecure, isHttpOnly, sameSite,
${hasRawSameSite ? "rawSameSite," : ""} originAttributes)
values (?, ?, ?, ?, ?, ?, ?, ?, ${hasRawSameSite ? "?," : ""} ?)`,
);
for (const row of rows) {
insert.run(
row.host,
row.name,
row.value,
row.path,
row.expiry,
row.isSecure,
row.isHttpOnly,
row.sameSite,
...(hasRawSameSite ? [row.rawSameSite ?? row.sameSite] : []),
row.originAttributes ?? "",
);
}
database.close();
return file;
});
const run = <A, E>(effect: Effect.Effect<A, E, FileSystem.FileSystem | Path.Path | Scope.Scope>) =>
effect.pipe(Effect.provide(NodeServices.layer), Effect.scoped);
describe("readFirefoxCookies", () => {
it.effect("converts millisecond expiries from schema 16 and newer", () =>
run(
Effect.gen(function* () {
const row = {
host: "example.test",
name: "c",
value: "v",
path: "/",
expiry: 1_800_000_000_000,
isSecure: 0,
isHttpOnly: 0,
sameSite: 0,
};
const modern = yield* readFirefoxCookies(yield* writeFirefoxCookieDatabase([row], 16));
expect(modern[0]?.expirationDate).toBe(1_800_000_000);
const legacy = yield* readFirefoxCookies(
yield* writeFirefoxCookieDatabase([{ ...row, expiry: 1_800_000_000 }], 15),
);
expect(legacy[0]?.expirationDate).toBe(1_800_000_000);
}),
),
);
it.effect("maps moz_cookies onto the shape Electron accepts", () =>
run(
Effect.gen(function* () {
const file = yield* writeFirefoxCookieDatabase([
{
host: ".github.com",
name: "session",
value: "abc",
path: "/",
expiry: 1_800_000_000,
isSecure: 1,
isHttpOnly: 1,
sameSite: 1,
},
{
host: "example.test",
name: "plain",
value: "v",
path: "/app",
expiry: 0,
isSecure: 0,
isHttpOnly: 0,
sameSite: 0,
},
]);
const cookies = yield* readFirefoxCookies(file);
expect(cookies).toEqual([
{
url: "https://github.com/",
name: "session",
value: "abc",
domain: ".github.com",
path: "/",
secure: true,
httpOnly: true,
expirationDate: 1_800_000_000,
sameSite: "lax",
},
{
url: "http://example.test/app",
name: "plain",
value: "v",
domain: undefined,
path: "/app",
secure: false,
httpOnly: false,
expirationDate: undefined,
sameSite: "no_restriction",
},
]);
}),
),
);
it.effect("keeps an unset SameSite unspecified instead of widening it to none", () =>
run(
Effect.gen(function* () {
const row = {
host: "example.test",
name: "c",
value: "v",
path: "/",
expiry: 0,
isSecure: 0,
isHttpOnly: 0,
};
const cookies = yield* readFirefoxCookies(
yield* writeFirefoxCookieDatabase([
{ ...row, name: "unset", sameSite: 256 },
{ ...row, name: "none", sameSite: 0 },
]),
);
expect(cookies.map(({ name, sameSite }) => ({ name, sameSite }))).toEqual([
{ name: "unset", sameSite: "unspecified" },
{ name: "none", sameSite: "no_restriction" },
]);
}),
),
);
it.effect("imports rows whose SameSite was never written", () =>
run(
Effect.gen(function* () {
const row = {
host: "example.test",
name: "c",
value: "v",
path: "/",
expiry: 0,
isSecure: 0,
isHttpOnly: 0,
};
const cookies = yield* readFirefoxCookies(
yield* writeFirefoxCookieDatabase(
[
{ ...row, name: "legacy", sameSite: null },
{ ...row, name: "strict", sameSite: 2 },
],
9,
),
);
expect(cookies.map(({ name, sameSite }) => ({ name, sameSite }))).toEqual([
{ name: "legacy", sameSite: "unspecified" },
{ name: "strict", sameSite: "strict" },
]);
}),
),
);
it.effect("applies the schema-15 rawSameSite rule to older databases", () =>
run(
Effect.gen(function* () {
const row = {
host: "example.test",
name: "c",
value: "v",
path: "/",
expiry: 0,
isSecure: 0,
isHttpOnly: 0,
};
const cookies = yield* readFirefoxCookies(
yield* writeFirefoxCookieDatabase(
[
{ ...row, name: "defaulted", sameSite: 1, rawSameSite: 0 },
{ ...row, name: "declared", sameSite: 1, rawSameSite: 1 },
{ ...row, name: "none", sameSite: 0, rawSameSite: 0 },
],
14,
),
);
expect(cookies.map(({ name, sameSite }) => ({ name, sameSite }))).toEqual([
{ name: "defaulted", sameSite: "unspecified" },
{ name: "declared", sameSite: "lax" },
{ name: "none", sameSite: "no_restriction" },
]);
}),
),
);
it.effect("imports only the default container", () =>
run(
Effect.gen(function* () {
const file = yield* writeFirefoxCookieDatabase([
{
host: "mail.test",
name: "session",
value: "default-container",
path: "/",
expiry: 1_800_000_000,
isSecure: 1,
isHttpOnly: 0,
sameSite: 1,
},
{
host: "mail.test",
name: "session",
value: "work-container",
path: "/",
expiry: 1_800_000_000,
isSecure: 1,
isHttpOnly: 0,
sameSite: 1,
originAttributes: "^userContextId=2",
},
{
host: "mail.test",
name: "private",
value: "private-window",
path: "/",
expiry: 1_800_000_000,
isSecure: 1,
isHttpOnly: 0,
sameSite: 1,
originAttributes: "^privateBrowsingId=1",
},
]);
const cookies = yield* readFirefoxCookies(file);
expect(cookies.map((cookie) => cookie.value)).toEqual(["default-container"]);
}),
),
);
it.effect("reads without mutating the source database", () =>
run(
Effect.gen(function* () {
const fileSystem = yield* FileSystem.FileSystem;
const file = yield* writeFirefoxCookieDatabase([
{
host: "a.test",
name: "n",
value: "v",
path: "/",
expiry: 1_800_000_000,
isSecure: 1,
isHttpOnly: 0,
sameSite: 2,
},
]);
const before = yield* fileSystem.stat(file);
yield* readFirefoxCookies(file);
const after = yield* fileSystem.stat(file);
expect(after.mtime).toEqual(before.mtime);
expect(after.size).toBe(before.size);
}),
),
);
});
describe("parseFirefoxProfiles", () => {
it.effect("reads named profiles and ignores Install sections", () =>
Effect.gen(function* () {
const parsed = yield* parsePosixFirefoxProfiles(
[
"[Install4F96D1932A9F858E]",
"Default=Profiles/abcd1234.default-release",
"Locked=1",
"",
"[Profile0]",
"Name=default-release",
"IsRelative=1",
"Path=Profiles/abcd1234.default-release",
"",
"[Profile1]",
"Name=Work",
"IsRelative=0",
"Path=/Volumes/External/firefox-work",
"",
"[General]",
"StartWithLastProfile=1",
].join("\n"),
);
expect(parsed).toEqual([
{ directory: "Profiles/abcd1234.default-release", name: "default-release" },
{ directory: "/Volumes/External/firefox-work", name: "Work" },
]);
}),
);
it.effect.each([
{ platform: "Linux", root: "/home/user/.mozilla/firefox" },
{ platform: "macOS", root: "/Users/user/Library/Application Support/Firefox" },
])("validates relative and absolute $platform profile paths", ({ root }) =>
Effect.gen(function* () {
const parsed = yield* parsePosixFirefoxProfiles(
[
"[Profile0]",
"Name=Relative",
"IsRelative=1",
"Path=Profiles/relative.default",
"[Profile1]",
"Name=Custom",
"IsRelative=0",
"Path=/mnt/custom/firefox-profile",
"[Profile2]",
"IsRelative=1",
"Path=../../escape",
"[Profile3]",
"IsRelative=1",
"Path=/absolute-marked-relative",
"[Profile4]",
"IsRelative=0",
"Path=relative-marked-absolute",
"[Profile5]",
"IsRelative=1",
"Path=Profiles/nul\u0000escape",
].join("\n"),
root,
);
expect(parsed).toEqual([
{ directory: "Profiles/relative.default", name: "Relative" },
{ directory: "/mnt/custom/firefox-profile", name: "Custom" },
]);
}),
);
it.effect("uses Windows path rules for relative and absolute profiles", () =>
Effect.gen(function* () {
const parsed = yield* parseWindowsFirefoxProfiles(
[
"[Profile0]",
"Name=Relative",
"IsRelative=1",
"Path=Profiles\\relative.default",
"[Profile1]",
"Name=Custom",
"IsRelative=0",
"Path=D:\\Firefox Profiles\\Work",
"[Profile2]",
"IsRelative=1",
"Path=..\\..\\escape",
"[Profile3]",
"IsRelative=1",
"Path=D:\\absolute-marked-relative",
"[Profile4]",
"IsRelative=0",
"Path=relative-marked-absolute",
].join("\n"),
);
expect(parsed).toEqual([
{ directory: "Profiles\\relative.default", name: "Relative" },
{ directory: "D:\\Firefox Profiles\\Work", name: "Custom" },
]);
}),
);
});