cloudflare--workers-sdk/fixtures/workers-shared-asset-config/html-handling.test.ts

import { AssetWorkerInner } from "@cloudflare/workers-shared/asset-worker";
import { normalizeConfiguration } from "@cloudflare/workers-shared/asset-worker/src/configuration";
import { getAssetWithMetadataFromKV } from "@cloudflare/workers-shared/asset-worker/src/utils/kv";
import { SELF } from "cloudflare:test";
import { afterEach, beforeEach, describe, it, vi } from "vitest";
import { encodingTestCases } from "./test-cases/encoding-test-cases";
import { htmlHandlingTestCases } from "./test-cases/html-handling-test-cases";
import type { AssetMetadata } from "@cloudflare/workers-shared/asset-worker/src/utils/kv";

const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;

vi.mock("@cloudflare/workers-shared/asset-worker/src/utils/kv.ts");
vi.mock("@cloudflare/workers-shared/asset-worker/src/configuration");
const existsMock = (fileList: Set<string>) => {
	const mockImplementation = async (pathname: string) => {
		if (fileList.has(pathname)) {
			return pathname;
		}
		return null;
	};

	vi.spyOn(AssetWorkerInner.prototype, "unstable_exists").mockImplementation(
		mockImplementation
	);
};
const BASE_URL = "http://example.com";

export type TestCase = {
	title: string;
	files: string[];
	requestPath: string;
	matchedFile?: string;
	finalPath?: string;
};

const testSuites = [
	{
		title: "htmlHanding options",
		suite: htmlHandlingTestCases,
	},
	{
		title: "encoding options",
		suite: encodingTestCases,
	},
];

describe.each(testSuites)("$title", ({ title, suite }) => {
	beforeEach(() => {
		vi.mocked(getAssetWithMetadataFromKV).mockImplementation(
			() =>
				Promise.resolve({
					value: "no-op",
					metadata: {
						contentType: "no-op",
					},
				}) as unknown as Promise<
					KVNamespaceGetWithMetadataResult<ReadableStream, AssetMetadata>
				>
		);
	});
	afterEach(() => {
		vi.restoreAllMocks();
		vi.mocked(getAssetWithMetadataFromKV).mockReset();
	});
	describe.each(suite)(`$html_handling`, ({ html_handling, cases }) => {
		beforeEach(async () => {
			const originalApplyConfigurationDefaults = (
				await vi.importActual<
					typeof import("@cloudflare/workers-shared/asset-worker/src/configuration")
				>("@cloudflare/workers-shared/asset-worker/src/configuration")
			).normalizeConfiguration;
			vi.mocked(normalizeConfiguration).mockImplementation(() => ({
				...originalApplyConfigurationDefaults({}),
				html_handling,
				not_found_handling: "none",
			}));
		});
		it.for(cases)(
			"$title",
			async ({ files, requestPath, matchedFile, finalPath }, { expect }) => {
				existsMock(new Set(files));
				const request = new IncomingRequest(BASE_URL + requestPath);
				let response = await SELF.fetch(request);
				if (matchedFile && finalPath) {
					expect(getAssetWithMetadataFromKV).toHaveBeenCalledTimes(1);
					expect(getAssetWithMetadataFromKV).toHaveBeenCalledWith(
						undefined,
						matchedFile
					);
					expect(response.status).toBe(200);
					expect(response.url).toBe(BASE_URL + finalPath);
					// can't check intermediate 307 directly:
					expect(response.redirected).toBe(requestPath !== finalPath);
				} else {
					expect(getAssetWithMetadataFromKV).not.toHaveBeenCalled();
					expect(response.status).toBe(404);
				}
			}
		);
	});
});