diff --git a/.changeset/fast-pears-ring.md b/.changeset/fast-pears-ring.md new file mode 100644 index 000000000000..6ef522b61da7 --- /dev/null +++ b/.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. diff --git a/packages/miniflare/src/plugins/kv/assets.ts b/packages/miniflare/src/plugins/kv/assets.ts index 05d62032abc4..1a9731196b05 100644 --- a/packages/miniflare/src/plugins/kv/assets.ts +++ b/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. diff --git a/packages/pages-shared/metadata-generator/parseRedirects.ts b/packages/pages-shared/metadata-generator/parseRedirects.ts index 12a669a823d5..c7c26b0f79d1 100644 --- a/packages/pages-shared/metadata-generator/parseRedirects.ts +++ b/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({ diff --git a/packages/workers-shared/README.md b/packages/workers-shared/README.md index 48be3b4b5815..04d2a36893a7 100644 --- a/packages/workers-shared/README.md +++ b/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. diff --git a/packages/workers-shared/asset-server-worker/README.md b/packages/workers-shared/asset-worker/README.md similarity index 61% rename from packages/workers-shared/asset-server-worker/README.md rename to packages/workers-shared/asset-worker/README.md index 88a6e0d953e5..eee3c83195aa 100644 --- a/packages/workers-shared/asset-server-worker/README.md +++ b/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. diff --git a/packages/workers-shared/asset-server-worker/src/assets-manifest.ts b/packages/workers-shared/asset-worker/src/assets-manifest.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/src/assets-manifest.ts rename to packages/workers-shared/asset-worker/src/assets-manifest.ts diff --git a/packages/workers-shared/asset-server-worker/src/constants.ts b/packages/workers-shared/asset-worker/src/constants.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/src/constants.ts rename to packages/workers-shared/asset-worker/src/constants.ts diff --git a/packages/workers-shared/asset-server-worker/src/global.d.ts b/packages/workers-shared/asset-worker/src/global.d.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/src/global.d.ts rename to packages/workers-shared/asset-worker/src/global.d.ts diff --git a/packages/workers-shared/asset-server-worker/src/index.ts b/packages/workers-shared/asset-worker/src/index.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/src/index.ts rename to packages/workers-shared/asset-worker/src/index.ts diff --git a/packages/workers-shared/asset-server-worker/src/responses.ts b/packages/workers-shared/asset-worker/src/responses.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/src/responses.ts rename to packages/workers-shared/asset-worker/src/responses.ts diff --git a/packages/workers-shared/asset-server-worker/src/utils/headers.ts b/packages/workers-shared/asset-worker/src/utils/headers.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/src/utils/headers.ts rename to packages/workers-shared/asset-worker/src/utils/headers.ts diff --git a/packages/workers-shared/asset-server-worker/src/utils/kv.ts b/packages/workers-shared/asset-worker/src/utils/kv.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/src/utils/kv.ts rename to packages/workers-shared/asset-worker/src/utils/kv.ts diff --git a/packages/workers-shared/asset-server-worker/tests/headers.test.ts b/packages/workers-shared/asset-worker/tests/headers.test.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/tests/headers.test.ts rename to packages/workers-shared/asset-worker/tests/headers.test.ts diff --git a/packages/workers-shared/asset-server-worker/tests/kv.test.ts b/packages/workers-shared/asset-worker/tests/kv.test.ts similarity index 100% rename from packages/workers-shared/asset-server-worker/tests/kv.test.ts rename to packages/workers-shared/asset-worker/tests/kv.test.ts diff --git a/packages/workers-shared/asset-server-worker/tests/tsconfig.json b/packages/workers-shared/asset-worker/tests/tsconfig.json similarity index 100% rename from packages/workers-shared/asset-server-worker/tests/tsconfig.json rename to packages/workers-shared/asset-worker/tests/tsconfig.json diff --git a/packages/workers-shared/asset-server-worker/wrangler.toml b/packages/workers-shared/asset-worker/wrangler.toml similarity index 84% rename from packages/workers-shared/asset-server-worker/wrangler.toml rename to packages/workers-shared/asset-worker/wrangler.toml index e18ef43cc683..52c101d14c04 100644 --- a/packages/workers-shared/asset-server-worker/wrangler.toml +++ b/packages/workers-shared/asset-worker/wrangler.toml @@ -1,5 +1,5 @@ ## -# 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 @@ -7,6 +7,6 @@ # 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" diff --git a/packages/workers-shared/package.json b/packages/workers-shared/package.json index 459e3f7e5cee..3bd2a53dff32 100644 --- a/packages/workers-shared/package.json +++ b/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", diff --git a/packages/workers-shared/router-worker/src/index.ts b/packages/workers-shared/router-worker/src/index.ts index fe05c7d87dad..91b284deed96 100644 --- a/packages/workers-shared/router-worker/src/index.ts +++ b/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); diff --git a/packages/workers-shared/vitest.config.mts b/packages/workers-shared/vitest.config.mts index 93aa07a68a67..363c185f0a91 100644 --- a/packages/workers-shared/vitest.config.mts +++ b/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, }, }) diff --git a/packages/wrangler/src/dev/miniflare.ts b/packages/wrangler/src/dev/miniflare.ts index cd8ea270b710..72b8c3e0f4d5 100644 --- a/packages/wrangler/src/dev/miniflare.ts +++ b/packages/wrangler/src/dev/miniflare.ts @@ -412,9 +412,7 @@ export function buildMiniflareBindingOptions(config: MiniflareBindingsConfig): { // Setup service bindings to external services const serviceBindings: NonNullable = { ...config.serviceBindings, - ...(config.experimentalAssets - ? { ASSET_SERVER: "asset-server-worker" } - : {}), + ...(config.experimentalAssets ? { ASSET_WORKER: "asset-worker" } : {}), }; const notFoundServices = new Set(); @@ -924,10 +922,10 @@ 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; @@ -935,7 +933,7 @@ function getAssetServerWorker( 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}` ); } diff --git a/packages/wrangler/templates/no-op-assets-worker.ts b/packages/wrangler/templates/no-op-assets-worker.ts index 7f9a0636d0dc..4aa2c1412b72 100644 --- a/packages/wrangler/templates/no-op-assets-worker.ts +++ b/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); }, };