WC-3583 Update static routing for run_worker_first based configuration

Now that we're not providing this configuration via _routes.json, we can
relax some of the configuration. Much of this happens on the backend,
but some field names have been changed ("include" -> "worker",
"exclude"->"asset")

Author: matthewdavidrodgers

.changeset/tasty-hoops-own.md

@@ -2,10 +2,10 @@
 "@cloudflare/workers-shared": minor
 ---
 
-Adds support for static routing (i.e. \_routes.json) to Workers Assets
+Adds support for static routing to Workers Assets
 
 Implements the proposal noted here https://github.com/cloudflare/workers-sdk/discussions/9143
 
-In brief: when static routing is present for a Worker with assets, routing via those static rules takes precedence. When a request is evaluated in the Router Worker, the request path is first compared to the "exclude" rules. If any match, the request is forwarded directly to the Asset Worker. If instead any "include" rules match, the request is forwarded directly to the User Worker. If neither match (or static routing was not provided), the existing behavior takes over.
+In brief: when static routing is present for a Worker with assets, routing via those static rules takes precedence. When a request is evaluated in the Router Worker, the request path is first compared to the "asset" rules (which are to be specific via "negative" rules, e.g. "!/api/assets"). If any match, the request is forwarded directly to the Asset Worker. If instead any "user_worker" rules match, the request is forwarded directly to the User Worker. If neither match (or static routing was not provided), the existing behavior takes over.
 
-As part of this explicit routing, when static routing is present, the check against "Sec-Fetch-Mode: navigate" (to guess if this should serve an asset or go to the User Worker for not_found_handling) is disabled. Routing can be controlled by uploading a \_routes.json, and asset serving (including when an index.html or 404.html page is served) will be more simple.
+As part of this explicit routing, when static routing is present, the check against "Sec-Fetch-Mode: navigate" (to guess if this should serve an asset or go to the User Worker for not_found_handling) is disabled. Routing can be controlled by setting routing rules via "run_worker_first", and asset serving (including when an index.html or 404.html page is served) will be more simple.

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

@@ -6,8 +6,7 @@ const VERSION = 1;
 export enum STATIC_ROUTING_DECISION {
 	NOT_PROVIDED = 0,
 	NOT_ROUTED = 1,
-	EXCLUDE = 2,
-	INCLUDE = 3,
+	ROUTED = 2,
 }
 
 export enum DISPATCH_TYPE {

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

@@ -11,8 +11,7 @@ export const applyConfigurationDefaults = (
 		script_id: configuration?.script_id ?? -1,
 		debug: configuration?.debug ?? false,
 		static_routing: configuration?.static_routing ?? {
-			version: 1,
-			include: [],
+			worker: [],
 		},
 	};
 };

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

@@ -80,7 +80,7 @@ export default {
 			if (config.static_routing) {
 				// evaluate "exclude" rules
 				const excludeRulesMatcher = generateStaticRoutingRuleMatcher(
-					config.static_routing.exclude ?? []
+					config.static_routing.asset ?? []
 				);
 				if (
 					excludeRulesMatcher({
@@ -90,7 +90,7 @@ export default {
 					// direct to asset worker
 					analytics.setData({
 						dispatchtype: DISPATCH_TYPE.ASSETS,
-						staticRoutingDecision: STATIC_ROUTING_DECISION.EXCLUDE,
+						staticRoutingDecision: STATIC_ROUTING_DECISION.ROUTED,
 					});
 					return await env.JAEGER.enterSpan("dispatch_assets", async (span) => {
 						span.setTags({
@@ -104,7 +104,7 @@ export default {
 				}
 				// evaluate "include" rules
 				const includeRulesMatcher = generateStaticRoutingRuleMatcher(
-					config.static_routing.include
+					config.static_routing.worker
 				);
 				if (
 					includeRulesMatcher({
@@ -119,7 +119,7 @@ export default {
 					// direct to user worker
 					analytics.setData({
 						dispatchtype: DISPATCH_TYPE.WORKER,
-						staticRoutingDecision: STATIC_ROUTING_DECISION.INCLUDE,
+						staticRoutingDecision: STATIC_ROUTING_DECISION.ROUTED,
 					});
 					return await env.JAEGER.enterSpan("dispatch_worker", async (span) => {
 						span.setTags({

packages/workers-shared/router-worker/tests/index.test.ts

@@ -95,16 +95,15 @@ describe("unit tests", async () => {
 		expect(await response.text()).toEqual("hello from asset worker");
 	});
 
-	it("it returns fetch from user worker when static_routing include rule matches", async () => {
+	it("it returns fetch from user worker when static_routing worker rule matches", async () => {
 		const request = new Request("https://example.com/api/includeme");
 		const ctx = createExecutionContext();
 
 		const env = {
 			CONFIG: {
 				has_user_worker: true,
 				static_routing: {
-					version: 1,
-					include: ["/api/*"],
+					worker: ["/api/*"],
 				},
 			},
 			USER_WORKER: {
@@ -126,17 +125,16 @@ describe("unit tests", async () => {
 		expect(await response.text()).toEqual("hello from user worker");
 	});
 
-	it("it returns fetch from asset worker when static_routing exclude rule matches", async () => {
+	it("it returns fetch from asset worker when static_routing asset rule matches", async () => {
 		const request = new Request("https://example.com/api/excludeme");
 		const ctx = createExecutionContext();
 
 		const env = {
 			CONFIG: {
 				has_user_worker: true,
 				static_routing: {
-					version: 1,
-					include: ["/api/includeme"],
-					exclude: ["/api/excludeme"],
+					worker: ["/api/includeme"],
+					asset: ["/api/excludeme"],
 				},
 			},
 			USER_WORKER: {
@@ -158,17 +156,16 @@ describe("unit tests", async () => {
 		expect(await response.text()).toEqual("hello from asset worker");
 	});
 
-	it("it returns fetch from asset worker when static_routing exclude and include rule matches", async () => {
+	it("it returns fetch from asset worker when static_routing asset and worker rule matches", async () => {
 		const request = new Request("https://example.com/api/excludeme");
 		const ctx = createExecutionContext();
 
 		const env = {
 			CONFIG: {
 				has_user_worker: true,
 				static_routing: {
-					version: 1,
-					include: ["/api/*"],
-					exclude: ["/api/excludeme"],
+					worker: ["/api/*"],
+					asset: ["/api/excludeme"],
 				},
 			},
 			USER_WORKER: {
@@ -198,8 +195,7 @@ describe("unit tests", async () => {
 			CONFIG: {
 				has_user_worker: true,
 				static_routing: {
-					version: 1,
-					include: ["/api/*"],
+					worker: ["/api/*"],
 				},
 			},
 			USER_WORKER: {
@@ -229,8 +225,7 @@ describe("unit tests", async () => {
 			CONFIG: {
 				has_user_worker: true,
 				static_routing: {
-					version: 1,
-					include: ["/api/*"],
+					worker: ["/api/*"],
 				},
 			},
 			USER_WORKER: {

packages/workers-shared/utils/types.ts

@@ -7,9 +7,8 @@ const InternalConfigSchema = z.object({
 });
 
 const StaticRoutingSchema = z.object({
-	version: z.literal(1),
-	include: z.array(z.string()),
-	exclude: z.array(z.string()).optional(),
+	worker: z.array(z.string()),
+	asset: z.array(z.string()).optional(),
 });
 
 export const RouterConfigSchema = z.object({