108 lines
4.1 KiB
TypeScript
108 lines
4.1 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import {
|
|
buildUnsubscribeUrl,
|
|
signUnsubscribeToken,
|
|
UnsubscribeTokenSecretMissingError,
|
|
verifyUnsubscribeToken,
|
|
} from "./unsubscribe-token.js";
|
|
|
|
const SECRET = "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef";
|
|
|
|
describe("signUnsubscribeToken", () => {
|
|
it("throws when no secret is configured", () => {
|
|
expect(() => signUnsubscribeToken({ runId: "run_1" })).toThrow(UnsubscribeTokenSecretMissingError);
|
|
});
|
|
|
|
it("throws when secret is too short", () => {
|
|
expect(() => signUnsubscribeToken({ runId: "run_1", secret: "short" })).toThrow(UnsubscribeTokenSecretMissingError);
|
|
});
|
|
|
|
it("requires runId", () => {
|
|
expect(() => signUnsubscribeToken({ runId: "" as unknown as string, secret: SECRET })).toThrow(TypeError);
|
|
});
|
|
|
|
it("returns a u1 payload signature string", () => {
|
|
const token = signUnsubscribeToken({ runId: "run_1", secret: SECRET });
|
|
expect(token.split(".")).toHaveLength(3);
|
|
expect(token.startsWith("u1.")).toBe(true);
|
|
});
|
|
|
|
it("uses MARKETING_TOKEN_SECRET when an env record is injected", () => {
|
|
const env = { MARKETING_TOKEN_SECRET: SECRET };
|
|
const token = signUnsubscribeToken({ runId: "run_1", env });
|
|
expect(verifyUnsubscribeToken(token, { env })).toMatchObject({ runId: "run_1" });
|
|
});
|
|
|
|
it("falls back to LEAD_CONVERSION_SECRET when an env record is injected", () => {
|
|
const env = { LEAD_CONVERSION_SECRET: SECRET };
|
|
const token = signUnsubscribeToken({ runId: "run_1", env });
|
|
expect(verifyUnsubscribeToken(token, { env })).toMatchObject({ runId: "run_1" });
|
|
});
|
|
});
|
|
|
|
describe("verifyUnsubscribeToken", () => {
|
|
it("returns null for null or empty input", () => {
|
|
expect(verifyUnsubscribeToken(null, { secret: SECRET })).toBeNull();
|
|
expect(verifyUnsubscribeToken("", { secret: SECRET })).toBeNull();
|
|
});
|
|
|
|
it("returns null when secret is missing", () => {
|
|
const token = signUnsubscribeToken({ runId: "run_1", secret: SECRET });
|
|
expect(verifyUnsubscribeToken(token)).toBeNull();
|
|
});
|
|
|
|
it("returns null on tampered signature", () => {
|
|
const token = signUnsubscribeToken({ runId: "run_1", secret: SECRET });
|
|
const tampered = `${token.slice(0, -2)}XX`;
|
|
expect(verifyUnsubscribeToken(tampered, { secret: SECRET })).toBeNull();
|
|
});
|
|
|
|
it("returns null on tampered payload", () => {
|
|
const token = signUnsubscribeToken({ runId: "run_1", secret: SECRET });
|
|
const parts = token.split(".");
|
|
const tamperedPayload = Buffer.from(JSON.stringify({ runId: "run_2", iat: 0 }), "utf8").toString("base64url");
|
|
const tampered = `${parts[0]}.${tamperedPayload}.${parts[2]}`;
|
|
expect(verifyUnsubscribeToken(tampered, { secret: SECRET })).toBeNull();
|
|
});
|
|
|
|
it("returns null on wrong version prefix", () => {
|
|
const token = signUnsubscribeToken({ runId: "run_1", secret: SECRET });
|
|
const tampered = token.replace("u1.", "u2.");
|
|
expect(verifyUnsubscribeToken(tampered, { secret: SECRET })).toBeNull();
|
|
});
|
|
|
|
it("returns the payload on a valid token", () => {
|
|
const token = signUnsubscribeToken({ runId: "run_1", leadId: "lead_1", tenantId: "tenant_1", secret: SECRET });
|
|
expect(verifyUnsubscribeToken(token, { secret: SECRET })).toMatchObject({
|
|
runId: "run_1",
|
|
leadId: "lead_1",
|
|
tenantId: "tenant_1",
|
|
});
|
|
});
|
|
|
|
it("returns null when verifying with a different secret", () => {
|
|
const token = signUnsubscribeToken({ runId: "run_1", secret: SECRET });
|
|
expect(verifyUnsubscribeToken(token, { secret: "f".repeat(64) })).toBeNull();
|
|
});
|
|
});
|
|
|
|
describe("buildUnsubscribeUrl", () => {
|
|
it("builds an absolute url with the signed token", () => {
|
|
const url = buildUnsubscribeUrl({
|
|
baseUrl: "https://app.example.com",
|
|
runId: "run_1",
|
|
secret: SECRET,
|
|
});
|
|
expect(url.startsWith("https://app.example.com/unsubscribe/u1.")).toBe(true);
|
|
});
|
|
|
|
it("strips trailing slashes from the base url", () => {
|
|
const url = buildUnsubscribeUrl({
|
|
baseUrl: "https://app.example.com/",
|
|
runId: "run_1",
|
|
secret: SECRET,
|
|
});
|
|
expect(url.startsWith("https://app.example.com/unsubscribe/u1.")).toBe(true);
|
|
});
|
|
});
|