test(api): add characterization tests for resume service

2026-08-21 05:51:46 +10:00 · 2026-07-08 15:51:15 +02:00
parent 73daf22b2f
commit 373c95733c
1 changed files with 338 additions and 0 deletions
@@ -0,0 +1,338 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+// Characterization tests for the resume service. The goal is to pin down CURRENT behavior
+// (CRUD / lock / password / statistics branching) so later changes are deliberate. The DB
+// layer and side-effecting helpers are mocked; the branching in service.ts is what's under test.
+
+const dbMock = vi.hoisted(() => ({
+	select: vi.fn(),
+	insert: vi.fn(),
+	update: vi.fn(),
+	delete: vi.fn(),
+	transaction: vi.fn(),
+}));
+const hashMock = vi.hoisted(() => vi.fn());
+const compareMock = vi.hoisted(() => vi.fn());
+const publishResumeUpdatedMock = vi.hoisted(() => vi.fn());
+const grantResumeAccessMock = vi.hoisted(() => vi.fn());
+const hasResumeAccessMock = vi.hoisted(() => vi.fn());
+const storageDeleteMock = vi.hoisted(() => vi.fn());
+
+vi.mock("@reactive-resume/db/client", () => ({ db: dbMock }));
+vi.mock("@reactive-resume/db/schema", () => ({
+	resume: {
+		id: "id",
+		userId: "user_id",
+		slug: "slug",
+		name: "name",
+		tags: "tags",
+		data: "data",
+		isPublic: "is_public",
+		isLocked: "is_locked",
+		password: "password",
+		updatedAt: "updated_at",
+		createdAt: "created_at",
+	},
+	resumeStatistics: {
+		resumeId: "resume_id",
+		views: "views",
+		downloads: "downloads",
+		lastViewedAt: "last_viewed_at",
+		lastDownloadedAt: "last_downloaded_at",
+	},
+	resumeStatisticsDaily: {
+		resumeId: "resume_id",
+		date: "date",
+		views: "views",
+		downloads: "downloads",
+	},
+	resumeVersion: {
+		id: "id",
+		resumeId: "resume_id",
+		userId: "user_id",
+		data: "data",
+		label: "label",
+		createdAt: "created_at",
+	},
+	resumeAnalysis: { resumeId: "resume_id", analysis: "analysis" },
+	user: { id: "id", username: "username" },
+}));
+vi.mock("drizzle-orm", () => ({
+	and: (...a: unknown[]) => a,
+	arrayContains: (...a: unknown[]) => a,
+	asc: (x: unknown) => x,
+	desc: (x: unknown) => x,
+	eq: (...a: unknown[]) => a,
+	gte: (...a: unknown[]) => a,
+	isNotNull: (...a: unknown[]) => a,
+	notInArray: (...a: unknown[]) => a,
+	sql: Object.assign((strings: TemplateStringsArray, ...values: unknown[]) => ({ strings, values }), {
+		join: (values: unknown[]) => values,
+	}),
+}));
+vi.mock("bcrypt", () => ({ hash: hashMock, compare: compareMock }));
+vi.mock("./events", () => ({ publishResumeUpdated: publishResumeUpdatedMock }));
+vi.mock("./access", () => ({
+	grantResumeAccess: grantResumeAccessMock,
+	hasResumeAccess: hasResumeAccessMock,
+}));
+vi.mock("../storage/service", () => ({
+	getStorageService: () => ({ delete: storageDeleteMock }),
+}));
+
+const { resumeService } = await import("./service");
+
+// A `db.update(...).set(...).where(...).returning(...)` chain that resolves to `rows`.
+const createUpdateChain = (rows: unknown[]) => {
+	const returning = vi.fn(() => Promise.resolve(rows));
+	const where = vi.fn(() => ({ returning }));
+	const set = vi.fn(() => ({ where }));
+	return { chain: { set }, set, where, returning };
+};
+
+// A `db.select(...).from(...).where(...)` chain that resolves to `rows`.
+const createSelectChain = (rows: unknown[]) => ({
+	from: () => ({ where: () => Promise.resolve(rows) }),
+});
+
+beforeEach(() => {
+	dbMock.select.mockReset();
+	dbMock.insert.mockReset();
+	dbMock.update.mockReset();
+	dbMock.delete.mockReset();
+	dbMock.transaction.mockReset();
+	hashMock.mockReset();
+	compareMock.mockReset();
+	publishResumeUpdatedMock.mockReset();
+	grantResumeAccessMock.mockReset();
+	hasResumeAccessMock.mockReset();
+	storageDeleteMock.mockReset();
+	hashMock.mockResolvedValue("hashed-password");
+	publishResumeUpdatedMock.mockResolvedValue(undefined);
+	storageDeleteMock.mockResolvedValue(true);
+});
+
+it("imports", () => {
+	expect(resumeService).toBeDefined();
+});
+
+describe("update", () => {
+	it("throws RESUME_LOCKED when the pre-read reports the resume is locked", async () => {
+		dbMock.select.mockReturnValueOnce(createSelectChain([{ isLocked: true }]));
+
+		await expect(resumeService.update({ id: "r1", userId: "u1", name: "New" })).rejects.toMatchObject({
+			code: "RESUME_LOCKED",
+		});
+	});
+
+	it("returns the updated row on success", async () => {
+		dbMock.select.mockReturnValueOnce(createSelectChain([{ isLocked: false }]));
+		const row = {
+			id: "r1",
+			name: "New",
+			slug: "slug",
+			tags: [],
+			data: {},
+			isPublic: false,
+			isLocked: false,
+			updatedAt: new Date("2026-01-01T00:00:00Z"),
+			hasPassword: false,
+		};
+		dbMock.update.mockReturnValueOnce(createUpdateChain([row]).chain);
+
+		const result = await resumeService.update({ id: "r1", userId: "u1", name: "New" });
+
+		expect(result).toEqual(row);
+		expect(publishResumeUpdatedMock).toHaveBeenCalledTimes(1);
+	});
+
+	it("throws NOT_FOUND when the UPDATE ... RETURNING matches no row", async () => {
+		dbMock.select.mockReturnValueOnce(createSelectChain([{ isLocked: false }]));
+		dbMock.update.mockReturnValueOnce(createUpdateChain([]).chain);
+
+		await expect(resumeService.update({ id: "r1", userId: "u1", name: "New" })).rejects.toMatchObject({
+			code: "NOT_FOUND",
+		});
+	});
+
+	it("maps a resume_slug_user_id_unique violation to RESUME_SLUG_ALREADY_EXISTS", async () => {
+		dbMock.select.mockReturnValueOnce(createSelectChain([{ isLocked: false }]));
+		dbMock.update.mockReturnValueOnce({
+			set: () => ({
+				where: () => ({
+					returning: () => {
+						const error = new Error("duplicate key") as Error & { cause: { constraint: string } };
+						error.cause = { constraint: "resume_slug_user_id_unique" };
+						return Promise.reject(error);
+					},
+				}),
+			}),
+		});
+
+		await expect(resumeService.update({ id: "r1", userId: "u1", slug: "taken" })).rejects.toMatchObject({
+			code: "RESUME_SLUG_ALREADY_EXISTS",
+		});
+	});
+});
+
+describe("setLocked", () => {
+	it("resolves and notifies on success (mutation: lock)", async () => {
+		dbMock.update.mockReturnValueOnce(
+			createUpdateChain([{ id: "r1", updatedAt: new Date("2026-01-01T00:00:00Z") }]).chain,
+		);
+
+		await expect(resumeService.setLocked({ id: "r1", userId: "u1", isLocked: true })).resolves.toBeUndefined();
+
+		expect(publishResumeUpdatedMock).toHaveBeenCalledTimes(1);
+		expect(publishResumeUpdatedMock).toHaveBeenCalledWith(expect.objectContaining({ mutation: "lock" }));
+	});
+
+	// Characterizes current behavior: silent no-op when no row matches. Plan 003 flips this to
+	// reject with NOT_FOUND (that test diff is the intended signal the behavior changed).
+	it("silently resolves undefined when no row matches, without notifying", async () => {
+		dbMock.update.mockReturnValueOnce(createUpdateChain([]).chain);
+
+		await expect(resumeService.setLocked({ id: "r1", userId: "u1", isLocked: true })).resolves.toBeUndefined();
+		expect(publishResumeUpdatedMock).not.toHaveBeenCalled();
+	});
+});
+
+describe("setPassword", () => {
+	it("hashes the password then resolves and notifies on success (mutation: password)", async () => {
+		dbMock.update.mockReturnValueOnce(
+			createUpdateChain([{ id: "r1", updatedAt: new Date("2026-01-01T00:00:00Z") }]).chain,
+		);
+
+		await expect(resumeService.setPassword({ id: "r1", userId: "u1", password: "secret" })).resolves.toBeUndefined();
+
+		expect(hashMock).toHaveBeenCalledWith("secret", 10);
+		expect(publishResumeUpdatedMock).toHaveBeenCalledTimes(1);
+		expect(publishResumeUpdatedMock).toHaveBeenCalledWith(expect.objectContaining({ mutation: "password" }));
+	});
+
+	// Characterizes current behavior: silent no-op when no row matches. Plan 003 flips this to
+	// reject with NOT_FOUND (that test diff is the intended signal the behavior changed).
+	it("silently resolves undefined when no row matches, without notifying", async () => {
+		dbMock.update.mockReturnValueOnce(createUpdateChain([]).chain);
+
+		await expect(resumeService.setPassword({ id: "r1", userId: "u1", password: "secret" })).resolves.toBeUndefined();
+		expect(publishResumeUpdatedMock).not.toHaveBeenCalled();
+	});
+});
+
+describe("removePassword", () => {
+	it("resolves and notifies on success (mutation: password)", async () => {
+		dbMock.update.mockReturnValueOnce(
+			createUpdateChain([{ id: "r1", updatedAt: new Date("2026-01-01T00:00:00Z") }]).chain,
+		);
+
+		await expect(resumeService.removePassword({ id: "r1", userId: "u1" })).resolves.toBeUndefined();
+
+		expect(publishResumeUpdatedMock).toHaveBeenCalledTimes(1);
+		expect(publishResumeUpdatedMock).toHaveBeenCalledWith(expect.objectContaining({ mutation: "password" }));
+	});
+
+	// Characterizes current behavior: silent no-op when no row matches. Plan 003 flips this to
+	// reject with NOT_FOUND (that test diff is the intended signal the behavior changed).
+	it("silently resolves undefined when no row matches, without notifying", async () => {
+		dbMock.update.mockReturnValueOnce(createUpdateChain([]).chain);
+
+		await expect(resumeService.removePassword({ id: "r1", userId: "u1" })).resolves.toBeUndefined();
+		expect(publishResumeUpdatedMock).not.toHaveBeenCalled();
+	});
+});
+
+describe("verifyPassword", () => {
+	it("throws INVALID_PASSWORD when no matching row is found", async () => {
+		dbMock.select.mockReturnValueOnce({
+			from: () => ({ innerJoin: () => ({ where: () => Promise.resolve([]) }) }),
+		});
+
+		await expect(resumeService.verifyPassword({ slug: "s", username: "u", password: "p" })).rejects.toMatchObject({
+			code: "INVALID_PASSWORD",
+		});
+	});
+
+	it("throws INVALID_PASSWORD when bcrypt.compare returns false", async () => {
+		dbMock.select.mockReturnValueOnce({
+			from: () => ({ innerJoin: () => ({ where: () => Promise.resolve([{ id: "r1", password: "hash" }]) }) }),
+		});
+		compareMock.mockResolvedValueOnce(false);
+
+		await expect(resumeService.verifyPassword({ slug: "s", username: "u", password: "p" })).rejects.toMatchObject({
+			code: "INVALID_PASSWORD",
+		});
+	});
+
+	it("returns true and grants access when bcrypt.compare returns true", async () => {
+		dbMock.select.mockReturnValueOnce({
+			from: () => ({ innerJoin: () => ({ where: () => Promise.resolve([{ id: "r1", password: "hash" }]) }) }),
+		});
+		compareMock.mockResolvedValueOnce(true);
+		const responseHeaders = new Headers();
+
+		const result = await resumeService.verifyPassword({
+			slug: "s",
+			username: "u",
+			password: "p",
+			responseHeaders,
+		});
+
+		expect(result).toBe(true);
+		expect(grantResumeAccessMock).toHaveBeenCalledWith(responseHeaders, "r1", "hash");
+	});
+});
+
+describe("delete", () => {
+	const runTransaction = (tx: unknown) => {
+		dbMock.transaction.mockImplementationOnce(async (cb: (tx: unknown) => Promise<unknown>) => cb(tx));
+	};
+
+	it("throws NOT_FOUND when the row is missing", async () => {
+		runTransaction({
+			select: () => createSelectChain([]),
+		});
+
+		await expect(resumeService.delete({ id: "r1", userId: "u1" })).rejects.toMatchObject({ code: "NOT_FOUND" });
+	});
+
+	it("throws RESUME_LOCKED when the row is locked", async () => {
+		runTransaction({
+			select: () => createSelectChain([{ isLocked: true }]),
+		});
+
+		await expect(resumeService.delete({ id: "r1", userId: "u1" })).rejects.toMatchObject({
+			code: "RESUME_LOCKED",
+		});
+	});
+
+	it("deletes storage for screenshot and pdf keys on success", async () => {
+		const deleteWhere = vi.fn(() => Promise.resolve());
+		runTransaction({
+			select: () => createSelectChain([{ isLocked: false }]),
+			delete: () => ({ where: deleteWhere }),
+		});
+
+		await resumeService.delete({ id: "r1", userId: "u1" });
+
+		expect(deleteWhere).toHaveBeenCalledTimes(1);
+		expect(storageDeleteMock).toHaveBeenCalledWith("uploads/u1/screenshots/r1");
+		expect(storageDeleteMock).toHaveBeenCalledWith("uploads/u1/pdfs/r1");
+		expect(publishResumeUpdatedMock).toHaveBeenCalledWith(expect.objectContaining({ mutation: "delete" }));
+	});
+});
+
+describe("statistics.increment", () => {
+	it("writes both resumeStatistics and resumeStatisticsDaily inside one transaction", async () => {
+		const values = vi.fn(() => ({ onConflictDoUpdate: vi.fn(() => Promise.resolve()) }));
+		const txInsert = vi.fn(() => ({ values }));
+		dbMock.transaction.mockImplementationOnce(async (cb: (tx: unknown) => Promise<unknown>) =>
+			cb({ insert: txInsert }),
+		);
+
+		await resumeService.statistics.increment({ id: "r1", views: true });
+
+		expect(dbMock.transaction).toHaveBeenCalledTimes(1);
+		expect(txInsert).toHaveBeenCalledTimes(2);
+	});
+});