fix(workers-shared): Stabilise Workers naming across workers-shared (…

…#6588)

The Asset Worker and Router Worker use inconsistent naming
conventions across `workers-shared`. This commit stabilizes
the naming to Asset Worker and Router Worker and permutations
of those.

.changeset/fast-pears-ring.md

@@ -0,0 +1,7 @@
+---
+"@cloudflare/workers-shared": patch
+---
+
+fix: Stabilize Workers naming across `workers-shared`
+
+The Asset Worker and Router Worker use inconsistent naming conventions across `workers-shared`. This commit stabilizes the naming to Asset Worker and Router Worker and permutations of those.

packages/miniflare/src/plugins/kv/assets.ts

@@ -237,8 +237,8 @@ const encodeManifest = (manifest: Uint8Array[]) => {
 // ASSET REVERSE MAP
 //
 // In prod, the contentHash is used as the key for the KV store that holds the assets.
-// ASW will hash the path of an incoming request, look for that pathHash in the stored manifest,
-// and get the corresponding contentHash to use as the KV key.
+// Asset Worker will hash the path of an incoming request, look for that pathHash in
+// the stored manifest, and get the corresponding contentHash to use as the KV key.
 // In dev, we fake out this KV store and just get the assets from disk. However we still need
 // to map a given "contentHash" to the filePath. This is what the ASSET REVERSE MAP is for.
 // This is available to the FAKE_KV_NAMESPACE service (assets.worker.ts) as a binding.

packages/pages-shared/metadata-generator/parseRedirects.ts

@@ -112,7 +112,7 @@ export function parseRedirects(input: string): ParsedRedirects {
 		}
 
 		// We want to always block the `/* /index.html` redirect - this will cause TOO_MANY_REDIRECTS errors as
-		// the asset server will redirect it back to `/`, removing the `/index.html`. This is the case for regular
+		// the asset worker will redirect it back to `/`, removing the `/index.html`. This is the case for regular
 		// redirects, as well as proxied (200) rewrites. We only want to run this on relative urls
 		if (/\/\*?$/.test(from) && /\/index(.html)?$/.test(to) && !urlHasHost(to)) {
 			invalid.push({

packages/workers-shared/README.md

@@ -2,15 +2,15 @@
 
 This is a package that is used at Cloudflare to power some internal features of [Cloudflare Workers](https://developers.cloudflare.com/workers/), as well as their open-source equivalents here in workers-sdk and Wrangler.
 
-## `asset-server`
+## `asset-worker`
 
-The Asset Server Worker.
+The Asset Worker.
 
 For more details please refer to the dedicated README file.
 
 ## `router-worker`
 
-Router Worker.
+The Router Worker.
 
 For more details please refer to the dedicated README file.
 

packages/workers-shared/asset-server-worker/README.md → packages/workers-shared/asset-worker/README.md

@@ -1,3 +1,3 @@
-# `asset-server`
+# `asset-worker`
 
-The Asset Server is a [Cloudflare Worker](https://developers.cloudflare.com/workers/) that is responsible of serving assets for Workers deployed on the edge, that contain static assets as well.
+The Asset Worker is a [Cloudflare Worker](https://developers.cloudflare.com/workers/) that is responsible of serving assets for Workers deployed on the edge, that contain static assets as well.

packages/workers-shared/asset-server-worker/wrangler.toml → packages/workers-shared/asset-worker/wrangler.toml

@@ -1,12 +1,12 @@
 ##
-# Configuration file for the Asset Server Worker
+# Configuration file for the Asset Worker
 #
 # Please note that wrangler has a dependency on this file, and will
 # attempt to read it as part of setting up a new Miniflare instance
 # in developemnt mode. We should ensure that any configuration changes
 # to this file are persisted in wrangler as well, when necessary.
 # (see packages/wrangler/src/dev/miniflare.ts -> buildMiniflareOptions())
 ##
-name = "asset-server-worker"
+name = "asset-worker"
 main = "src/index.ts"
 compatibility_date = "2024-07-31"

packages/workers-shared/package.json

@@ -23,13 +23,13 @@
 	],
 	"scripts": {
 		"build": "pnpm run clean && pnpm run bundle:asset-worker:prod && pnpm run bundle:router-worker:prod",
-		"bundle:asset-worker": "esbuild asset-server-worker/src/index.ts --format=esm --bundle --outfile=dist/asset-server-worker.mjs --sourcemap=external --external:cloudflare:*",
+		"bundle:asset-worker": "esbuild asset-worker/src/index.ts --format=esm --bundle --outfile=dist/asset-worker.mjs --sourcemap=external --external:cloudflare:*",
 		"bundle:asset-worker:prod": "pnpm run bundle:asset-worker --minify",
 		"bundle:router-worker": "esbuild router-worker/src/index.ts --format=esm --bundle --outfile=dist/router-worker.mjs --sourcemap=external",
 		"bundle:router-worker:prod": "pnpm run bundle:router-worker --minify",
 		"check:lint": "eslint . --max-warnings=0",
 		"check:type": "pnpm run check:type:tests && tsc",
-		"check:type:tests": "tsc -p ./asset-server-worker/tests/tsconfig.json",
+		"check:type:tests": "tsc -p ./asset-worker/tests/tsconfig.json",
 		"clean": "rimraf dist",
 		"dev": "pnpm run clean && concurrently -n bundle:asset-worker,bundle:router-worker -c blue,magenta \"pnpm run bundle:asset-worker --watch\" \"pnpm run bundle:router-worker --watch\"",
 		"test": "vitest",

packages/workers-shared/router-worker/src/index.ts

@@ -1,12 +1,12 @@
 import type { Fetcher, Request } from "@cloudflare/workers-types";
 
 interface Env {
-	ASSET_SERVER: Fetcher;
+	ASSET_WORKER: Fetcher;
 	USER_WORKER: Fetcher;
 }
 export default {
 	async fetch(request: Request, env: Env) {
-		const result = await env.ASSET_SERVER.fetch(request);
+		const result = await env.ASSET_WORKER.fetch(request);
 		if (!result.ok) {
 			if (result.status === 404) {
 				return await env.USER_WORKER.fetch(request);

packages/workers-shared/vitest.config.mts

@@ -5,7 +5,7 @@ export default mergeConfig(
 	configShared,
 	defineProject({
 		test: {
-			include: ["asset-server-worker/tests/**.{test,spec}.{ts,js}"],
+			include: ["asset-worker/tests/**.{test,spec}.{ts,js}"],
 			globals: true,
 		},
 	})

packages/wrangler/src/dev/miniflare.ts

@@ -412,9 +412,7 @@ export function buildMiniflareBindingOptions(config: MiniflareBindingsConfig): {
 	// Setup service bindings to external services
 	const serviceBindings: NonNullable<WorkerOptions["serviceBindings"]> = {
 		...config.serviceBindings,
-		...(config.experimentalAssets
-			? { ASSET_SERVER: "asset-server-worker" }
-			: {}),
+		...(config.experimentalAssets ? { ASSET_WORKER: "asset-worker" } : {}),
 	};
 
 	const notFoundServices = new Set<string>();
@@ -924,18 +922,18 @@ function getAssetServerWorker(
 		return [];
 	}
 	const assetServerModulePath = require.resolve(
-		"@cloudflare/workers-shared/dist/asset-server-worker.mjs"
+		"@cloudflare/workers-shared/dist/asset-worker.mjs"
 	);
 	const assetServerConfigPath = require.resolve(
-		"@cloudflare/workers-shared/asset-server-worker/wrangler.toml"
+		"@cloudflare/workers-shared/asset-worker/wrangler.toml"
 	);
 	let assetServerConfig: Config | undefined;
 
 	try {
 		assetServerConfig = readConfig(assetServerConfigPath, {});
 	} catch (err) {
 		throw new UserError(
-			"Failed to read the Asset Server Worker configuration file.\n" + `${err}`
+			"Failed to read the Asset Worker configuration file.\n" + `${err}`
 		);
 	}
 

packages/wrangler/templates/no-op-assets-worker.ts

@@ -23,11 +23,11 @@
  * this Worker is.
  */
 type Env = {
-	ASSET_SERVER: Fetcher;
+	ASSET_WORKER: Fetcher;
 };
 
 export default {
 	async fetch(request: Request, env: Env) {
-		return env.ASSET_SERVER.fetch(request);
+		return env.ASSET_WORKER.fetch(request);
 	},
 };