feat(workers-shared): Add Asset Server Worker behaviour

.changeset/dull-ants-check.md

@@ -0,0 +1,11 @@
+---
+"@cloudflare/workers-shared": minor
+---
+
+feat: Add basic Asset Worker behaviour
+
+This commit implements a basic Asset Worker behaviour, including:
+
+- headers handling
+- `200`/`404`/`500` response handling
+- fetching data from KV

fixtures/workers-with-assets/public/README.md

@@ -0,0 +1,57 @@
+# Workers with Assets
+
+Welcome to Workers + Assets YAY!
+
+Please proceed with much excitement ^.^
+
+                                                                                 .................
+                                                                            .......-++**********:.
+                                                                            ..-+****++**********#:
+                                                                       ...-+***+++====+********##=
+                                                                  ....:=****+======+***********##+
+                                                                ....-****+======+*************###+
+                                                                .:==+*+======+***************####=
+                                                           ....-===--=====++****************#####:
+                                                        ....:====-:::-==+******************#####+.
+                                                        ..-====:::::::+*******************#####*..
+                                                      ..-===-:::::::-==+*****************######=..
+                                                    ..-===-::::::-=======***************######*.
+                                                 ...-===-::::::-==========+************######*:.
+                                               ...-===-::::::-==----========+*********#######:..
+                                               .-===-::::::--::::::::::-======+******#######-. .
+                                            ..:====::::::-=:::-*####*-:::-=======+**#######-.
+                                           .:====-:::::-==:::*#########-::========+**#####-
+                                         ..====-:::::-===-::###########*:::======*******+..
+                                       ..=+====:::::=====::-############:::====+*******=...
+                                   ....:=++====:::-======-::###########*:::===+*******-..
+                    ...........:-==+**+=++++=============-:::*#########-::===********:..
+                 ....--=+************====+++===============:::=*####*=:::-=+*******=..
+                 .:*************###*=====++++================::::::::::-==********:..
+               ..*****#############=======++++==========================+*******+...
+            ...+****#############*==:::-===++++========================********-.
+          ...+****###############+=::::=====+++++====================********+...
+          .=****################*=-:::-======+++++=================+********:..
+       ..-****##################===:-=========++++++=============+********:..
+       .+***####################===========+***#++++++=========+********=..
+        .*###################+-.-=======+****##*==+++++++====+********=...
+       ...-+#############*=...-++=====+****####+=====++++++*********+...
+          ....-*######+:.....++++===******####==========+*######**+..
+               ...+=.....:::-+++++******#####=========+***######*..
+                .......::::::=++******#####+========***********:...
+                 ....::::::...+*****######=======+**********##*.
+                 ..:::::....-*****######+=====+**********#####*.
+               ...:::::...:******#####*+++++*********#########+.
+               ..:::::...+*****######+++++++=.=###############:.
+               .:::::..-*****######-..-=++=..-##########***###..
+            ....::::..=****######=....::::..:########******##*..
+            ...::::..+***######-.....::::...*##***********###=..
+            ..::::...-**####*:......::::...###************###-..
+            ..:::......=##*:......:::::...+##*************###:
+          ...::::...............:::::....+##*************####.
+          ...::::::::::::::..:::::::......**************###-..
+          .::::::::::::::::::::::..... ...:***********###+....
+          ..::::.......::::::......      ..:********###*:...
+                    ........             ...=******###=..
+                                            .=***###+..
+                                            ..*####:...
+                                            ........

fixtures/workers-with-assets/public/yay.txt

@@ -0,0 +1,12 @@
+
+ .----------------.  .----------------.  .----------------.
+| .--------------. || .--------------. || .--------------. |
+| |  ____  ____  | || |      __      | || |  ____  ____  | |
+| | |_  _||_  _| | || |     /  \     | || | |_  _||_  _| | |
+| |   \ \  / /   | || |    / /\ \    | || |   \ \  / /   | |
+| |    \ \/ /    | || |   / ____ \   | || |    \ \/ /    | |
+| |    _|  |_    | || | _/ /    \ \_ | || |    _|  |_    | |
+| |   |______|   | || ||____|  |____|| || |   |______|   | |
+| |              | || |              | || |              | |
+| '--------------' || '--------------' || '--------------' |
+ '----------------'  '----------------'  '----------------'

fixtures/workers-with-assets/tests/index.test.ts

@@ -31,8 +31,86 @@ describe("[Workers + Assets] `wrangler dev`", () => {
 
 	it("should not resolve '/' to '/index.html' ", async ({ expect }) => {
 		let response = await fetch(`http://${ip}:${port}/`);
-		let text = await response.text();
 		expect(response.status).toBe(404);
-		expect(text).toContain("Not Found");
+	});
+
+	it("should 404 if asset is not found in the asset manifest", async ({
+		expect,
+	}) => {
+		let response = await fetch(`http://${ip}:${port}/hello.html`);
+		expect(response.status).toBe(404);
+
+		response = await fetch(`http://${ip}:${port}/hello.txt`);
+		expect(response.status).toBe(404);
+	});
+
+	it("should handle content types correctly", async ({ expect }) => {
+		let response = await fetch(`http://${ip}:${port}/index.html`);
+		let text = await response.text();
+		expect(response.status).toBe(200);
+		expect(response.headers.get("Content-Type")).toBe(
+			"text/html; charset=utf-8"
+		);
+
+		response = await fetch(`http://${ip}:${port}/README.md`);
+		text = await response.text();
+		expect(response.status).toBe(200);
+		expect(response.headers.get("Content-Type")).toBe(
+			"text/markdown; charset=utf-8"
+		);
+		expect(text).toContain(`Welcome to Workers + Assets YAY!`);
+
+		response = await fetch(`http://${ip}:${port}/yay.txt`);
+		text = await response.text();
+		expect(response.status).toBe(200);
+		expect(response.headers.get("Content-Type")).toBe(
+			"text/plain; charset=utf-8"
+		);
+		expect(text).toContain(`.----------------.`);
+
+		response = await fetch(`http://${ip}:${port}/lava-lamps.jpg`);
+		expect(response.status).toBe(200);
+		expect(response.headers.get("Content-Type")).toBe("image/jpeg");
+	});
+
+	it("should only ever handle GET requests", async ({ expect }) => {
+		// as per https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
+		// excl. TRACE and CONNECT which are not supported
+
+		let response = await fetch(`http://${ip}:${port}/hello.html`, {
+			method: "HEAD",
+		});
+		expect(response.status).toBe(405);
+		expect(response.statusText).toBe("Method Not Allowed");
+
+		response = await fetch(`http://${ip}:${port}/hello.html`, {
+			method: "POST",
+		});
+		expect(response.status).toBe(405);
+		expect(response.statusText).toBe("Method Not Allowed");
+
+		response = await fetch(`http://${ip}:${port}/hello.html`, {
+			method: "PUT",
+		});
+		expect(response.status).toBe(405);
+		expect(response.statusText).toBe("Method Not Allowed");
+
+		response = await fetch(`http://${ip}:${port}/hello.html`, {
+			method: "DELETE",
+		});
+		expect(response.status).toBe(405);
+		expect(response.statusText).toBe("Method Not Allowed");
+
+		response = await fetch(`http://${ip}:${port}/hello.html`, {
+			method: "OPTIONS",
+		});
+		expect(response.status).toBe(405);
+		expect(response.statusText).toBe("Method Not Allowed");
+
+		response = await fetch(`http://${ip}:${port}/hello.html`, {
+			method: "PATCH",
+		});
+		expect(response.status).toBe(405);
+		expect(response.statusText).toBe("Method Not Allowed");
 	});
 });

packages/miniflare/src/workers/kv/assets.worker.ts

@@ -27,6 +27,15 @@ export default <ExportedHandler<Env>>{
 		// eslint-disable-next-line @typescript-eslint/no-unused-vars
 		const { filePath, contentType } = entry;
 		const blobsService = env[SharedBindings.MAYBE_SERVICE_BLOBS];
-		return blobsService.fetch(new URL(filePath, "http://placeholder"));
+		const response = await blobsService.fetch(
+			new URL(filePath, "http://placeholder")
+		);
+		const newResponse = new Response(response.body, response);
+		// ensure the runtime will return the metadata we need
+		newResponse.headers.append(
+			"cf-kv-metadata",
+			`{"contentType": "${contentType}"}`
+		);
+		return newResponse;
 	},
 };

packages/workers-shared/asset-server-worker/src/assets-manifest.ts

@@ -4,6 +4,11 @@ const CONTENT_HASH_SIZE = 16;
 const TAIL_SIZE = 8;
 const ENTRY_SIZE = PATH_HASH_SIZE + CONTENT_HASH_SIZE + TAIL_SIZE;
 
+export type AssetEntry = {
+	path: string;
+	contentHash: string;
+};
+
 export class AssetsManifest {
 	private data: ArrayBuffer;
 

packages/workers-shared/asset-server-worker/src/constants.ts

@@ -0,0 +1,2 @@
+// have the browser check in with the server to make sure its local cache is valid before using it
+export const CACHE_CONTROL_BROWSER = "public, max-age=0, must-revalidate";

packages/workers-shared/asset-server-worker/src/global.d.ts

@@ -0,0 +1,9 @@
+type Env = {
+	// ASSETS_MANIFEST is a pipeline binding to an ArrayBuffer containing the
+	// binary-encoded site manifest
+	ASSETS_MANIFEST: ArrayBuffer;
+
+	// ASSETS_KV_NAMESPACE is a pipeline binding to the KV namespace that the
+	// assets are in.
+	ASSETS_KV_NAMESPACE: KVNamespace;
+};

packages/workers-shared/asset-server-worker/src/index.ts

@@ -1,38 +1,62 @@
+import { WorkerEntrypoint } from "cloudflare:workers";
 import { AssetsManifest } from "./assets-manifest";
+import {
+	InternalServerErrorResponse,
+	MethodNotAllowedResponse,
+	NotFoundResponse,
+	OkResponse,
+} from "./responses";
+import { getAdditionalHeaders, getMergedHeaders } from "./utils/headers";
+import { getAssetWithMetadataFromKV } from "./utils/kv";
 
-interface Env {
-	/**
-	 * ASSETS_MANIFEST is a pipeline binding to an ArrayBuffer containing the
-	 * binary-encoded site manifest
-	 */
-	ASSETS_MANIFEST: ArrayBuffer;
-	/**
-	 * ASSETS_KV_NAMESPACE is a pipeline binding to the KV namespace that the
-	 *  assets are in.
-	 */
-	ASSETS_KV_NAMESPACE: KVNamespace;
-}
-
-export default {
-	async fetch(request: Request, env: Env) {
-		const { ASSETS_MANIFEST, ASSETS_KV_NAMESPACE } = env;
+export default class extends WorkerEntrypoint<Env> {
+	async fetch(request: Request) {
+		if (request.method.toLowerCase() !== "get") {
+			return new MethodNotAllowedResponse();
+		}
 
-		const url = new URL(request.url);
-		const { pathname } = url;
+		try {
+			return this.handleRequest(request);
+		} catch (err) {
+			return new InternalServerErrorResponse(err);
+		}
+	}
 
-		const assetsManifest = new AssetsManifest(ASSETS_MANIFEST);
-		const assetKey = await assetsManifest.get(pathname);
-		if (!assetKey) {
-			return new Response("Not Found", { status: 404 });
+	async handleRequest(request: Request) {
+		const assetEntry = await this.getAssetEntry(request);
+		if (!assetEntry) {
+			return new NotFoundResponse();
 		}
 
-		const content = await ASSETS_KV_NAMESPACE.get(assetKey);
-		if (!content) {
+		const assetResponse = await getAssetWithMetadataFromKV(
+			this.env.ASSETS_KV_NAMESPACE,
+			assetEntry
+		);
+
+		if (!assetResponse || !assetResponse.value) {
 			throw new Error(
-				`Requested asset ${assetKey} exists in the asset manifest but not in the KV namespace.`
+				`Requested asset ${assetEntry} exists in the asset manifest but not in the KV namespace.`
 			);
 		}
 
-		return new Response(content);
-	},
-};
+		const { value: assetContent, metadata: assetMetadata } = assetResponse;
+		const additionalHeaders = getAdditionalHeaders(
+			assetEntry,
+			assetMetadata,
+			request
+		);
+		const headers = getMergedHeaders(request.headers, additionalHeaders);
+
+		return new OkResponse(assetContent, { headers });
+	}
+
+	private async getAssetEntry(request: Request) {
+		const url = new URL(request.url);
+		let { pathname } = url;
+
+		const assetsManifest = new AssetsManifest(this.env.ASSETS_MANIFEST);
+		pathname = globalThis.decodeURIComponent(pathname);
+
+		return await assetsManifest.get(pathname);
+	}
+}

packages/workers-shared/asset-server-worker/src/responses.ts

@@ -0,0 +1,46 @@
+export class OkResponse extends Response {
+	constructor(body: BodyInit | null, init?: ResponseInit) {
+		super(body, {
+			...init,
+			status: 200,
+		});
+	}
+}
+
+export class NotFoundResponse extends Response {
+	constructor(...[body, init]: ConstructorParameters<typeof Response>) {
+		super(body, {
+			...init,
+			status: 404,
+			statusText: "Not Found",
+		});
+	}
+}
+
+export class MethodNotAllowedResponse extends Response {
+	constructor(...[body, init]: ConstructorParameters<typeof Response>) {
+		super(body, {
+			...init,
+			status: 405,
+			statusText: "Method Not Allowed",
+		});
+	}
+}
+
+export class InternalServerErrorResponse extends Response {
+	constructor(err: Error, init?: ResponseInit) {
+		super(undefined, {
+			...init,
+			status: 500,
+		});
+	}
+}
+
+export class NotModifiedResponse extends Response {
+	constructor(...[_body, _init]: ConstructorParameters<typeof Response>) {
+		super(undefined, {
+			status: 304,
+			statusText: "Not Modified",
+		});
+	}
+}