emdash-cms--emdash/packages/core/tests/unit/cache-hints.test.ts

import type { Kysely } from "kysely";
import { describe, it, expect, beforeEach, afterEach } from "vitest";

import { handleContentCreate } from "../../src/api/index.js";
import type { Database } from "../../src/database/types.js";
import { emdashLoader } from "../../src/loader.js";
import { runWithContext } from "../../src/request-context.js";
import { setupTestDatabaseWithCollections, teardownTestDatabase } from "../utils/test-db.js";

describe("Cache hints", () => {
	let db: Kysely<Database>;

	beforeEach(async () => {
		db = await setupTestDatabaseWithCollections();
	});

	afterEach(async () => {
		await teardownTestDatabase(db);
	});

	async function createPublishedPost(title: string) {
		const result = await handleContentCreate(db, "post", {
			data: { title },
			status: "published",
		});
		if (!result.success) throw new Error("Failed to create post");
		return result.data!.item;
	}

	describe("loadCollection cacheHint", () => {
		it("should tag collection with type name", async () => {
			await createPublishedPost("First Post");
			await createPublishedPost("Second Post");

			const loader = emdashLoader();
			const result = await runWithContext({ editMode: false, db }, () =>
				loader.loadCollection!({ filter: { type: "post" } }),
			);

			expect(result.cacheHint).toBeDefined();
			expect(result.cacheHint!.tags).toEqual(["post"]);
		});

		it("should include lastModified from most recent entry", async () => {
			await createPublishedPost("First Post");
			const second = await createPublishedPost("Second Post");

			const loader = emdashLoader();
			const result = await runWithContext({ editMode: false, db }, () =>
				loader.loadCollection!({ filter: { type: "post" } }),
			);

			expect(result.cacheHint!.lastModified).toBeInstanceOf(Date);
			// lastModified should be >= the second post's updated_at
			const secondUpdated = new Date(second.updatedAt);
			expect(result.cacheHint!.lastModified!.getTime()).toBeGreaterThanOrEqual(
				secondUpdated.getTime(),
			);
		});
	});

	describe("entry-level cacheHint", () => {
		it("should tag each entry with its database ID", async () => {
			const post = await createPublishedPost("Test Post");

			const loader = emdashLoader();
			const result = await runWithContext({ editMode: false, db }, () =>
				loader.loadCollection!({ filter: { type: "post" } }),
			);

			expect(result.entries).toHaveLength(1);
			const entry = result.entries![0];
			expect(entry.cacheHint).toBeDefined();
			expect(entry.cacheHint!.tags).toEqual([post.id]);
		});

		it("should include lastModified on each entry", async () => {
			await createPublishedPost("Test Post");

			const loader = emdashLoader();
			const result = await runWithContext({ editMode: false, db }, () =>
				loader.loadCollection!({ filter: { type: "post" } }),
			);

			const entry = result.entries![0];
			expect(entry.cacheHint!.lastModified).toBeInstanceOf(Date);
		});
	});

	describe("loadEntry cacheHint", () => {
		it("should tag entry with its database ID", async () => {
			const post = await createPublishedPost("Test Post");

			const loader = emdashLoader();
			const result = await runWithContext({ editMode: false, db }, () =>
				loader.loadEntry!({ filter: { type: "post", id: post.slug } }),
			);

			// loadEntry returns the entry directly (LiveDataEntry), not { entry, cacheHint }
			expect(result).toBeDefined();
			expect(result!.cacheHint).toBeDefined();
			expect(result!.cacheHint!.tags).toEqual([post.id]);
		});
	});

	describe("invalidation tag alignment", () => {
		it("should produce tags that match the invalidation pattern", async () => {
			const post = await createPublishedPost("Test Post");

			const loader = emdashLoader();
			const collectionResult = await runWithContext({ editMode: false, db }, () =>
				loader.loadCollection!({ filter: { type: "post" } }),
			);

			// The route invalidates with tags: [collection, id]
			// Collection pages are tagged with [type] -> matches "collection" tag
			// Entry pages are tagged with [entryId] -> matches "id" tag
			const invalidationTags = ["post", post.id];

			// Collection-level tag should be hit by invalidation
			expect(invalidationTags).toContain(collectionResult.cacheHint!.tags![0]);

			// Entry-level tag should be hit by invalidation
			const entry = collectionResult.entries![0];
			expect(invalidationTags).toContain(entry.cacheHint!.tags![0]);
		});
	});
});