mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-05 10:14:30 +00:00
301 lines
12 KiB
TypeScript
301 lines
12 KiB
TypeScript
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import { setupTempAuthEnv } from "./_test-utils.js";
|
|
import { isAuthError } from "./errors.js";
|
|
import {
|
|
parseTokenResponse,
|
|
refreshTokens,
|
|
resolveClientId,
|
|
revokeTokens,
|
|
startAuthorizationCodeFlow,
|
|
} from "./oauth.js";
|
|
import { readStore, writeStore } from "./store.js";
|
|
|
|
// Mock the interactive bits so startAuthorizationCodeFlow runs headless.
|
|
vi.mock("./loopback.js", () => ({
|
|
startLoopback: vi.fn(async () => ({
|
|
result: Promise.resolve({
|
|
code: "auth_code_123",
|
|
redirectUri: "http://127.0.0.1:12345/oauth/callback",
|
|
}),
|
|
redirectUri: "http://127.0.0.1:12345/oauth/callback",
|
|
close: vi.fn(async () => {}),
|
|
})),
|
|
}));
|
|
vi.mock("./browser.js", () => ({
|
|
openBrowser: vi.fn(async () => ({ opened: true })),
|
|
}));
|
|
|
|
describe("auth/oauth", () => {
|
|
let fixture: Awaited<ReturnType<typeof setupTempAuthEnv>>;
|
|
|
|
beforeEach(async () => {
|
|
fixture = await setupTempAuthEnv("hf-oauth-");
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await fixture.restore();
|
|
});
|
|
|
|
describe("resolveClientId", () => {
|
|
it("returns the env override when set", () => {
|
|
process.env["HYPERFRAMES_OAUTH_CLIENT_ID"] = "test_client_id";
|
|
expect(resolveClientId()).toBe("test_client_id");
|
|
});
|
|
|
|
it("returns the build-time default when env is unset", () => {
|
|
expect(resolveClientId()).toMatch(/.+/);
|
|
});
|
|
});
|
|
|
|
describe("parseTokenResponse", () => {
|
|
it("parses a full token response", () => {
|
|
const tokens = parseTokenResponse({
|
|
access_token: "at_123",
|
|
refresh_token: "rt_456",
|
|
token_type: "Bearer",
|
|
expires_in: 3600,
|
|
scope: "openid profile",
|
|
});
|
|
expect(tokens.access_token).toBe("at_123");
|
|
expect(tokens.refresh_token).toBe("rt_456");
|
|
expect(tokens.token_type).toBe("Bearer");
|
|
expect(tokens.scope).toBe("openid profile");
|
|
expect(tokens.expires_at).toBeDefined();
|
|
const expiresAt = new Date(tokens.expires_at!);
|
|
// Should be approximately 1 hour in the future
|
|
const diff = expiresAt.getTime() - Date.now();
|
|
expect(diff).toBeGreaterThan(3500 * 1000);
|
|
expect(diff).toBeLessThan(3700 * 1000);
|
|
});
|
|
|
|
it("accepts expires_in as a string (some servers serialize as string)", () => {
|
|
const tokens = parseTokenResponse({ access_token: "at", expires_in: "1800" });
|
|
expect(tokens.expires_at).toBeDefined();
|
|
});
|
|
|
|
it("rejects responses missing access_token", () => {
|
|
expect(() => parseTokenResponse({ token_type: "Bearer" })).toThrow();
|
|
});
|
|
|
|
it("rejects array payloads", () => {
|
|
expect(() => parseTokenResponse([])).toThrow();
|
|
});
|
|
|
|
it("rejects null payloads", () => {
|
|
expect(() => parseTokenResponse(null)).toThrow();
|
|
});
|
|
|
|
it("rejects access_token containing CR/LF", () => {
|
|
expect(() => parseTokenResponse({ access_token: "at\r\nX-Evil: 1" })).toSatisfy(
|
|
() => true, // assertion done below via toThrow
|
|
);
|
|
expect(() => parseTokenResponse({ access_token: "at\r\nX-Evil: 1" })).toThrow(
|
|
/control characters/,
|
|
);
|
|
});
|
|
|
|
it("rejects refresh_token containing CR/LF", () => {
|
|
expect(() => parseTokenResponse({ access_token: "at", refresh_token: "rt\nbad" })).toThrow(
|
|
/control characters/,
|
|
);
|
|
});
|
|
|
|
it("clamps non-positive expires_in to avoid an immediate-refresh loop", () => {
|
|
const zero = parseTokenResponse({ access_token: "at", expires_in: 0 });
|
|
const negative = parseTokenResponse({ access_token: "at", expires_in: -100 });
|
|
// both should resolve to a future time
|
|
expect(new Date(zero.expires_at!).getTime()).toBeGreaterThan(Date.now() + 25 * 1000);
|
|
expect(new Date(negative.expires_at!).getTime()).toBeGreaterThan(Date.now() + 25 * 1000);
|
|
});
|
|
|
|
it("uses REFRESH_FAILED error code on shape failures (not API_ERROR)", () => {
|
|
try {
|
|
parseTokenResponse(null);
|
|
} catch (err) {
|
|
expect(isAuthError(err)).toBe(true);
|
|
if (isAuthError(err)) expect(err.code).toBe("REFRESH_FAILED");
|
|
return;
|
|
}
|
|
throw new Error("expected throw");
|
|
});
|
|
});
|
|
|
|
describe("refreshTokens", () => {
|
|
it("posts grant_type=refresh_token and persists the response", async () => {
|
|
process.env["HEYGEN_API_URL"] = "https://api.test.example";
|
|
let capturedBody: string | undefined;
|
|
const fetchImpl = (async (_url: string, init?: RequestInit) => {
|
|
capturedBody = init?.body as string;
|
|
return new Response(
|
|
JSON.stringify({
|
|
access_token: "new_at",
|
|
refresh_token: "new_rt",
|
|
expires_in: 3600,
|
|
token_type: "Bearer",
|
|
scope: "openid profile",
|
|
}),
|
|
{ status: 200, headers: { "content-type": "application/json" } },
|
|
);
|
|
}) as unknown as typeof fetch;
|
|
|
|
const tokens = await refreshTokens("old_rt", { fetchImpl });
|
|
expect(tokens.access_token).toBe("new_at");
|
|
expect(tokens.refresh_token).toBe("new_rt");
|
|
expect(capturedBody).toContain("grant_type=refresh_token");
|
|
expect(capturedBody).toContain("refresh_token=old_rt");
|
|
|
|
// Should have persisted.
|
|
const { credentials } = await readStore();
|
|
expect(credentials.oauth?.access_token).toBe("new_at");
|
|
});
|
|
|
|
it("preserves the prior refresh_token when the server omits it (no rotation)", async () => {
|
|
await writeStore({
|
|
oauth: {
|
|
access_token: "old_at",
|
|
refresh_token: "keep_me_rt",
|
|
expires_at: "2026-01-01T00:00:00Z",
|
|
},
|
|
});
|
|
const fetchImpl = (async () =>
|
|
new Response(JSON.stringify({ access_token: "new_at", expires_in: 3600 }), {
|
|
status: 200,
|
|
headers: { "content-type": "application/json" },
|
|
})) as unknown as typeof fetch;
|
|
await refreshTokens("keep_me_rt", { fetchImpl });
|
|
const { credentials } = await readStore();
|
|
expect(credentials.oauth?.access_token).toBe("new_at");
|
|
// Critical: refresh_token MUST survive a no-rotation refresh.
|
|
expect(credentials.oauth?.refresh_token).toBe("keep_me_rt");
|
|
});
|
|
|
|
it("preserves an existing api_key when persisting refreshed oauth", async () => {
|
|
await writeStore({ api_key: "hg_keep" });
|
|
const fetchImpl = (async () =>
|
|
new Response(JSON.stringify({ access_token: "new_at", expires_in: 60 }), {
|
|
status: 200,
|
|
headers: { "content-type": "application/json" },
|
|
})) as unknown as typeof fetch;
|
|
await refreshTokens("old_rt", { fetchImpl });
|
|
const { credentials } = await readStore();
|
|
expect(credentials.api_key).toBe("hg_keep");
|
|
expect(credentials.oauth?.access_token).toBe("new_at");
|
|
});
|
|
|
|
it("throws REFRESH_FAILED on 400/401", async () => {
|
|
const fetchImpl = (async () =>
|
|
new Response("invalid_grant", { status: 400 })) as unknown as typeof fetch;
|
|
await expect(refreshTokens("bad_rt", { fetchImpl })).rejects.toSatisfy((err) => {
|
|
return isAuthError(err) && (err as { code: string }).code === "REFRESH_FAILED";
|
|
});
|
|
});
|
|
|
|
it("throws API_ERROR on 5xx", async () => {
|
|
const fetchImpl = (async () =>
|
|
new Response("upstream", { status: 503 })) as unknown as typeof fetch;
|
|
await expect(refreshTokens("rt", { fetchImpl })).rejects.toSatisfy((err) => {
|
|
return isAuthError(err) && (err as { code: string }).code === "API_ERROR";
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("revokeTokens", () => {
|
|
it("never throws on network failure (best-effort)", async () => {
|
|
const fetchImpl = (async () => {
|
|
throw new Error("connection refused");
|
|
}) as unknown as typeof fetch;
|
|
await expect(revokeTokens("any_token", { fetchImpl })).resolves.toBeUndefined();
|
|
});
|
|
|
|
it("respects the timeout", async () => {
|
|
let aborted = false;
|
|
const fetchImpl = (async (_url: string, init?: RequestInit) => {
|
|
const signal = init?.signal;
|
|
return new Promise<Response>((_resolve, reject) => {
|
|
signal?.addEventListener("abort", () => {
|
|
aborted = true;
|
|
reject(new Error("aborted"));
|
|
});
|
|
});
|
|
}) as unknown as typeof fetch;
|
|
await revokeTokens("token", { fetchImpl, timeoutMs: 50 });
|
|
expect(aborted).toBe(true);
|
|
});
|
|
|
|
it("sends token_type_hint when provided", async () => {
|
|
let capturedBody = "";
|
|
const fetchImpl = (async (_url: string, init?: RequestInit) => {
|
|
capturedBody = init?.body as string;
|
|
return new Response("", { status: 200 });
|
|
}) as unknown as typeof fetch;
|
|
await revokeTokens("tok", { fetchImpl, token_type_hint: "refresh_token" });
|
|
expect(capturedBody).toContain("token_type_hint=refresh_token");
|
|
});
|
|
|
|
it("returns silently when client_id is unconfigured (no throw)", async () => {
|
|
process.env["HYPERFRAMES_OAUTH_CLIENT_ID"] = "";
|
|
// With the baked-in default cleared from env, revokeTokens still has
|
|
// the build-time default. Force it to fail by setting the override to
|
|
// a value AND nulling the default isn't possible from a test — instead
|
|
// verify that the function never throws via the standard path.
|
|
const fetchImpl = (async () => new Response("", { status: 200 })) as unknown as typeof fetch;
|
|
await expect(revokeTokens("tok", { fetchImpl })).resolves.toBeUndefined();
|
|
});
|
|
});
|
|
|
|
describe("error scrubbing", () => {
|
|
it("refreshTokens does not leak token-shaped secrets from the error body", async () => {
|
|
const fetchImpl = (async () =>
|
|
new Response(
|
|
'{"error":"invalid_grant","echoed":"refresh_token=rt_leak_secret&code_verifier=cv_leak"}',
|
|
{ status: 400 },
|
|
)) as unknown as typeof fetch;
|
|
try {
|
|
await refreshTokens("rt_leak_secret", { fetchImpl });
|
|
throw new Error("expected rejection");
|
|
} catch (err) {
|
|
const msg = (err as Error).message;
|
|
expect(msg).not.toContain("rt_leak_secret");
|
|
expect(msg).not.toContain("cv_leak");
|
|
expect(msg).toContain("<redacted>");
|
|
}
|
|
});
|
|
});
|
|
|
|
describe("startAuthorizationCodeFlow persistence", () => {
|
|
function tokenFetch(body: Record<string, unknown>): typeof fetch {
|
|
return (async () =>
|
|
new Response(JSON.stringify(body), {
|
|
status: 200,
|
|
headers: { "content-type": "application/json" },
|
|
})) as unknown as typeof fetch;
|
|
}
|
|
|
|
it("overwrites the OAuth block on fresh login (no inherited refresh_token)", async () => {
|
|
// Pre-seed a prior session whose refresh_token must NOT leak into
|
|
// the new login when the new response omits one.
|
|
await writeStore({
|
|
oauth: { access_token: "old_at", refresh_token: "OLD_rt_should_not_survive" },
|
|
});
|
|
const fetchImpl = tokenFetch({ access_token: "new_at", expires_in: 3600 });
|
|
await startAuthorizationCodeFlow({ fetchImpl });
|
|
|
|
const { credentials } = await readStore();
|
|
expect(credentials.oauth?.access_token).toBe("new_at");
|
|
// Fresh login is a clean session — the old refresh_token is gone.
|
|
expect(credentials.oauth?.refresh_token).toBeUndefined();
|
|
});
|
|
|
|
it("preserves a co-located api_key across fresh login", async () => {
|
|
await writeStore({ api_key: "hg_keep_me" });
|
|
const fetchImpl = tokenFetch({ access_token: "new_at", refresh_token: "new_rt" });
|
|
await startAuthorizationCodeFlow({ fetchImpl });
|
|
|
|
const { credentials } = await readStore();
|
|
expect(credentials.api_key).toBe("hg_keep_me");
|
|
expect(credentials.oauth?.access_token).toBe("new_at");
|
|
expect(credentials.oauth?.refresh_token).toBe("new_rt");
|
|
});
|
|
});
|
|
});
|