Files
OmniRoute/tests/unit/cursor-token-extractor.test.ts
Will Gordon df6f401465 refactor(cursor): extracts token extraction into shared lib
Moves tryIdeAuth/tryAgentAuth and supporting helpers out of the
auto-import route into src/lib/cursor/tokenExtractor.ts, and adds
an agent-cli-state.json fallback candidate path to tryAgentAuth
(alongside the existing auth.json candidate) so the extraction
logic can be reused by the upcoming renewal orchestrator.
2026-08-04 11:43:50 -03:00

408 lines
15 KiB
TypeScript

import { describe, it, beforeEach, afterEach } from "node:test";
import assert from "node:assert/strict";
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import {
normalizeVscDbValue,
extractCursorTokensFromRows,
fuzzyExtractCursorTokensFromRows,
cursorDbCandidatePaths,
verifyLinuxCursorInstalled,
tryAgentAuth,
tryIdeAuth,
} from "@/lib/cursor/tokenExtractor";
describe("normalizeVscDbValue", () => {
it("unwraps a JSON-encoded string", () => {
assert.equal(normalizeVscDbValue('"abc"'), "abc");
});
it("returns the raw string when JSON parse fails", () => {
assert.equal(normalizeVscDbValue("not-json"), "not-json");
});
it("returns the raw string when JSON parses to non-string", () => {
assert.equal(normalizeVscDbValue("123"), "123");
assert.equal(normalizeVscDbValue("{}"), "{}");
});
it("passes non-strings through unchanged", () => {
assert.equal(normalizeVscDbValue(42 as unknown as string), 42);
assert.equal(normalizeVscDbValue(null as unknown as string), null);
});
});
describe("extractCursorTokensFromRows", () => {
it("extracts tokens using exact primary keys", () => {
const tokens = extractCursorTokensFromRows([
{ key: "cursorAuth/accessToken", value: "tok-1" },
{ key: "storage.serviceMachineId", value: "machine-1" },
]);
assert.equal(tokens.accessToken, "tok-1");
assert.equal(tokens.machineId, "machine-1");
});
it("accepts the alternative `cursorAuth/token` key", () => {
const tokens = extractCursorTokensFromRows([
{ key: "cursorAuth/token", value: "tok-2" },
{ key: "storage.machineId", value: "machine-2" },
]);
assert.equal(tokens.accessToken, "tok-2");
assert.equal(tokens.machineId, "machine-2");
});
it("accepts the alternative `telemetry.machineId` key", () => {
const tokens = extractCursorTokensFromRows([
{ key: "cursorAuth/accessToken", value: "tok-3" },
{ key: "telemetry.machineId", value: "machine-3" },
]);
assert.equal(tokens.machineId, "machine-3");
});
it("prefers the first match and ignores duplicates", () => {
const tokens = extractCursorTokensFromRows([
{ key: "cursorAuth/accessToken", value: "first" },
{ key: "cursorAuth/token", value: "second" },
]);
assert.equal(tokens.accessToken, "first");
});
it("normalizes JSON-encoded values", () => {
const tokens = extractCursorTokensFromRows([
{ key: "cursorAuth/accessToken", value: '"json-token"' },
{ key: "storage.serviceMachineId", value: '"json-machine"' },
]);
assert.equal(tokens.accessToken, "json-token");
assert.equal(tokens.machineId, "json-machine");
});
it("returns empty on no matches", () => {
const tokens = extractCursorTokensFromRows([{ key: "irrelevant", value: "x" }]);
assert.equal(tokens.accessToken, undefined);
assert.equal(tokens.machineId, undefined);
});
});
describe("fuzzyExtractCursorTokensFromRows", () => {
it("matches keys by substring containing `accesstoken` and `machineid`", () => {
const tokens = fuzzyExtractCursorTokensFromRows([
{ key: "cursorAuth/someOtherAccessTokenKey", value: "fallback-token" },
{ key: "storage.someMachineId", value: "fallback-machine" },
]);
assert.equal(tokens.accessToken, "fallback-token");
assert.equal(tokens.machineId, "fallback-machine");
});
it("preserves already-found tokens (passes existing through)", () => {
const tokens = fuzzyExtractCursorTokensFromRows(
[
{ key: "cursorAuth/someOtherAccessTokenKey", value: "fallback-token" },
{ key: "storage.someMachineId", value: "fallback-machine" },
],
{ accessToken: "already-have-it" }
);
assert.equal(tokens.accessToken, "already-have-it");
assert.equal(tokens.machineId, "fallback-machine");
});
it("is case-insensitive on the key match", () => {
const tokens = fuzzyExtractCursorTokensFromRows([
{ key: "Some.ACCESSTOKEN.suffix", value: "tok" },
{ key: "Some.MACHINEID.suffix", value: "mid" },
]);
assert.equal(tokens.accessToken, "tok");
assert.equal(tokens.machineId, "mid");
});
});
describe("cursorDbCandidatePaths", () => {
it("returns standard + Insiders paths on macOS", () => {
const paths = cursorDbCandidatePaths("darwin", { home: "/Users/test" });
assert.equal(paths.length, 2);
assert.ok(paths[0].includes("Cursor/User/globalStorage/state.vscdb"));
assert.ok(paths[1].includes("Cursor - Insiders/User/globalStorage/state.vscdb"));
});
it("returns a single path on Linux", () => {
const paths = cursorDbCandidatePaths("linux", { home: "/home/test" });
assert.deepEqual(paths, ["/home/test/.config/Cursor/User/globalStorage/state.vscdb"]);
});
it("returns a single path on Windows using APPDATA", () => {
const paths = cursorDbCandidatePaths("win32", {
home: "C:/Users/test",
appdata: "C:/Users/test/AppData/Roaming",
});
assert.equal(paths.length, 1);
assert.ok(paths[0].includes("Cursor/User/globalStorage/state.vscdb"));
});
it("returns empty array for unsupported platforms", () => {
assert.deepEqual(cursorDbCandidatePaths("freebsd" as NodeJS.Platform, { home: "/x" }), []);
});
});
describe("verifyLinuxCursorInstalled (port: 9router#313)", () => {
const okExec = async () => ({ stdout: "/usr/bin/cursor\n", stderr: "" });
const failExec = async () => {
throw new Error("which: no cursor in PATH");
};
const okAccess = async () => {};
const failAccess = async () => {
throw Object.assign(new Error("ENOENT"), { code: "ENOENT" });
};
it("returns true when `which cursor` succeeds (does not probe the .desktop file)", async () => {
let accessCalled = false;
const installed = await verifyLinuxCursorInstalled({
execFile: okExec,
access: async () => {
accessCalled = true;
},
home: "/home/test",
});
assert.equal(installed, true);
assert.equal(accessCalled, false);
});
it("falls back to the cursor.desktop launcher when `which` fails", async () => {
let probedPath = "";
const installed = await verifyLinuxCursorInstalled({
execFile: failExec,
access: async (p) => {
probedPath = p;
},
home: "/home/test",
});
assert.equal(installed, true);
assert.equal(probedPath, "/home/test/.local/share/applications/cursor.desktop");
});
it("returns false when neither `which` nor the .desktop file resolve (phantom config)", async () => {
const installed = await verifyLinuxCursorInstalled({
execFile: failExec,
access: failAccess,
home: "/home/test",
});
assert.equal(installed, false);
});
it("probes `which cursor` with a fixed binary name and a bounded timeout", async () => {
let calledWith: { file: string; args: string[]; timeout: number } | null = null;
const installed = await verifyLinuxCursorInstalled({
execFile: async (file, args, options) => {
calledWith = { file, args, timeout: options.timeout };
return { stdout: "/usr/bin/cursor", stderr: "" };
},
access: okAccess,
home: "/home/test",
});
assert.equal(installed, true);
assert.deepEqual(calledWith, {
file: "which",
args: ["cursor"],
timeout: 5000,
});
});
});
describe("tryAgentAuth", () => {
const ORIGINAL_HOME = process.env.HOME;
const ORIGINAL_USERPROFILE = process.env.USERPROFILE;
let tmpHome: string;
beforeEach(() => {
tmpHome = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-cursor-agent-auth-"));
process.env.HOME = tmpHome;
process.env.USERPROFILE = tmpHome;
});
afterEach(() => {
process.env.HOME = ORIGINAL_HOME;
if (ORIGINAL_USERPROFILE !== undefined) {
process.env.USERPROFILE = ORIGINAL_USERPROFILE;
} else {
delete process.env.USERPROFILE;
}
fs.rmSync(tmpHome, { recursive: true, force: true });
});
it("finds a token in the primary auth.json candidate", async () => {
const authDir = path.join(tmpHome, ".config", "cursor");
fs.mkdirSync(authDir, { recursive: true });
fs.writeFileSync(
path.join(authDir, "auth.json"),
JSON.stringify({ accessToken: "primary-token" })
);
const result = await tryAgentAuth();
assert.equal(result.found, true);
assert.equal(result.accessToken, "primary-token");
assert.equal(result.source, "cursor-agent");
});
it("falls back to agent-cli-state.json when auth.json is missing", async () => {
const stateDir = path.join(tmpHome, ".cursor");
fs.mkdirSync(stateDir, { recursive: true });
fs.writeFileSync(
path.join(stateDir, "agent-cli-state.json"),
JSON.stringify({ accessToken: "fallback-token" })
);
const result = await tryAgentAuth();
assert.equal(result.found, true);
assert.equal(result.accessToken, "fallback-token");
assert.equal(result.source, "cursor-agent");
});
it("reports not found when neither candidate has a usable accessToken", async () => {
const stateDir = path.join(tmpHome, ".cursor");
fs.mkdirSync(stateDir, { recursive: true });
// Schema differs from what's expected — no accessToken field.
fs.writeFileSync(
path.join(stateDir, "agent-cli-state.json"),
JSON.stringify({ authId: "some-id", displayName: "someone" })
);
const result = await tryAgentAuth();
assert.equal(result.found, false);
assert.equal(result.error, "cursor-agent auth.json not found");
});
it("reports not found when neither file exists", async () => {
const result = await tryAgentAuth();
assert.equal(result.found, false);
assert.equal(result.error, "cursor-agent auth.json not found");
});
it("reports not found (does not throw) when auth.json contains malformed JSON", async () => {
const authDir = path.join(tmpHome, ".config", "cursor");
fs.mkdirSync(authDir, { recursive: true });
fs.writeFileSync(path.join(authDir, "auth.json"), "{ this is not valid json ");
const result = await tryAgentAuth();
assert.equal(result.found, false);
assert.equal(result.error, "cursor-agent auth.json not found");
});
it("falls through to the second candidate when the primary file is malformed JSON", async () => {
const authDir = path.join(tmpHome, ".config", "cursor");
fs.mkdirSync(authDir, { recursive: true });
fs.writeFileSync(path.join(authDir, "auth.json"), "not json at all");
const stateDir = path.join(tmpHome, ".cursor");
fs.mkdirSync(stateDir, { recursive: true });
fs.writeFileSync(
path.join(stateDir, "agent-cli-state.json"),
JSON.stringify({ accessToken: "fallback-after-malformed" })
);
const result = await tryAgentAuth();
assert.equal(result.found, true);
assert.equal(result.accessToken, "fallback-after-malformed");
});
});
describe("tryIdeAuth", () => {
let originalPlatformDescriptor: PropertyDescriptor | undefined;
const ORIGINAL_HOME = process.env.HOME;
const ORIGINAL_USERPROFILE = process.env.USERPROFILE;
let tmpHome: string | undefined;
beforeEach(() => {
originalPlatformDescriptor = Object.getOwnPropertyDescriptor(process, "platform");
});
afterEach(() => {
if (originalPlatformDescriptor) {
Object.defineProperty(process, "platform", originalPlatformDescriptor);
}
process.env.HOME = ORIGINAL_HOME;
if (ORIGINAL_USERPROFILE !== undefined) {
process.env.USERPROFILE = ORIGINAL_USERPROFILE;
} else {
delete process.env.USERPROFILE;
}
if (tmpHome) {
fs.rmSync(tmpHome, { recursive: true, force: true });
tmpHome = undefined;
}
});
it("dispatches to the unsupported-platform branch for a platform with no candidate paths", async () => {
Object.defineProperty(process, "platform", { value: "freebsd", configurable: true });
const result = await tryIdeAuth();
assert.equal(result.found, false);
assert.equal(result.error, "Unsupported platform");
});
// The following exercise the SUPPORTED-platform dispatch branch through to a
// real tryOpenSync() call. mock.module() is unavailable in this tsx/ESM +
// Node native test-runner setup (see tests/unit/token-health-check-sweep.test.ts),
// and tryIdeAuth() takes no injectable options — so instead of mocking the
// driver, these seed a REAL sqlite file at the exact candidate path via the
// same resilient driver factory (openDatabaseAsync), matching the technique
// tests/unit/db-import-resilient-driver-3025.test.ts already uses.
describe("on a supported platform (darwin), against a real state.vscdb", () => {
beforeEach(() => {
Object.defineProperty(process, "platform", { value: "darwin", configurable: true });
tmpHome = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-cursor-ide-auth-"));
process.env.HOME = tmpHome;
process.env.USERPROFILE = tmpHome;
});
it("finds tokens when the real database contains the expected keys", async () => {
const dbPath = cursorDbCandidatePaths("darwin", { home: tmpHome as string })[0];
fs.mkdirSync(path.dirname(dbPath), { recursive: true });
const { openDatabaseAsync } = await import("@/lib/db/adapters/driverFactory");
const seed = await openDatabaseAsync(dbPath);
seed.exec("CREATE TABLE itemTable (key TEXT PRIMARY KEY, value TEXT)");
seed
.prepare("INSERT INTO itemTable (key, value) VALUES (?, ?)")
.run("cursorAuth/accessToken", "found-token");
seed
.prepare("INSERT INTO itemTable (key, value) VALUES (?, ?)")
.run("storage.serviceMachineId", "found-machine");
seed.close();
const result = await tryIdeAuth();
assert.equal(result.found, true);
assert.equal(result.accessToken, "found-token");
assert.equal(result.machineId, "found-machine");
assert.equal(result.source, "cursor-ide");
});
it("reports tokens not found when the real database has no matching keys", async () => {
const dbPath = cursorDbCandidatePaths("darwin", { home: tmpHome as string })[0];
fs.mkdirSync(path.dirname(dbPath), { recursive: true });
const { openDatabaseAsync } = await import("@/lib/db/adapters/driverFactory");
const seed = await openDatabaseAsync(dbPath);
seed.exec("CREATE TABLE itemTable (key TEXT PRIMARY KEY, value TEXT)");
seed.prepare("INSERT INTO itemTable (key, value) VALUES (?, ?)").run("irrelevant.key", "x");
seed.close();
const result = await tryIdeAuth();
assert.equal(result.found, false);
assert.equal(result.error, "Tokens not found in database");
});
it("reports a db-open failure (not a thrown exception) when the file is not a valid sqlite database", async () => {
// better-sqlite3's Database constructor opens lazily — it does not
// validate the file format until the first prepare()/query, so this
// exercises the query-time catch block (SQLITE_NOTADB), not the
// upfront `!db` "(driver unavailable)" branch.
const dbPath = cursorDbCandidatePaths("darwin", { home: tmpHome as string })[0];
fs.mkdirSync(path.dirname(dbPath), { recursive: true });
fs.writeFileSync(dbPath, "not a real sqlite database file");
const result = await tryIdeAuth();
assert.equal(result.found, false);
assert.equal(result.error, "Failed to read database");
});
});
});