Reduce amount of rules in routes json file (#394)

.changeset/twenty-deers-wink.md

@@ -0,0 +1,5 @@
+---
+'@astrojs/cloudflare': minor
+---
+
+Added functionality to compare include and exclude rules to reduce the amount of cloudflare rules

packages/cloudflare/src/utils/generate-routes-json.ts

@@ -128,6 +128,31 @@ class PathTrie {
 		}
 	}
 
+	/**
+	 * The reduce function is used to remove unnecessary paths from the trie.
+	 * It receives a trie node to compare with the current node.
+	 */
+	private reduce(compNode: TrieNode, node: TrieNode): void {
+		if (node.hasWildcardChild || compNode.hasWildcardChild) return;
+
+		for (const [segment, childNode] of node.children) {
+			if (childNode.children.size === 0) continue;
+
+			const compChildNode = compNode.children.get(segment);
+			if (compChildNode === undefined) {
+				childNode.hasWildcardChild = true;
+				continue;
+			}
+
+			this.reduce(compChildNode, childNode);
+		}
+	}
+
+	reduceAllPaths(compTrie: PathTrie): this {
+		this.reduce(compTrie.root, this.root);
+		return this;
+	}
+
 	getAllPaths(): [string[][], boolean] {
 		const allPaths: string[][] = [];
 		this.dfs(this.root, [], allPaths);
@@ -244,7 +269,6 @@ export async function createRoutesFile(
 	for (const includePath of includePaths) {
 		includeTrie.insert(includePath);
 	}
-	const [deduplicatedIncludePaths, includedPathsHaveWildcard] = includeTrie.getAllPaths();
 
 	const excludeTrie = new PathTrie();
 	for (const excludePath of excludePaths) {
@@ -256,7 +280,14 @@ export async function createRoutesFile(
 		if (excludePath[0] === '*') continue;
 		excludeTrie.insert(excludePath);
 	}
-	const [deduplicatedExcludePaths, _excludedPathsHaveWildcard] = excludeTrie.getAllPaths();
+
+	const [deduplicatedIncludePaths, includedPathsHaveWildcard] = includeTrie
+		.reduceAllPaths(excludeTrie)
+		.getAllPaths();
+
+	const [deduplicatedExcludePaths, _excludedPathsHaveWildcard] = excludeTrie
+		.reduceAllPaths(includeTrie)
+		.getAllPaths();
 
 	/**
 	 * Cloudflare allows no more than 100 include/exclude rules combined

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/env.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="../../.astro/types.d.ts" />
+/// <reference types="astro/client" />

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/404.astro

@@ -0,0 +1,3 @@
+---
+export const prerender = true;
+---

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/dynamicPages/dynamic1.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=false;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/dynamicPages/dynamic2.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=false;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/dynamicPages/dynamic3.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=false;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/index.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=false;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/mixedPages/dynamic.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=false;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/mixedPages/static.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=true;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/mixedPages/subfolder/dynamic.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=false;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/mixedPages/subfolder/static.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=true;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/staticPages/static1.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=true;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/staticPages/static2.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=true;
+---
+
+ok

packages/cloudflare/test/fixtures/routes-json/src/reduceComplexity/pages/staticPages/static3.astro

@@ -0,0 +1,5 @@
+---
+export const prerender=true;
+---
+
+ok

packages/cloudflare/test/routes-json.test.js

@@ -48,7 +48,7 @@ describe('_routes.json generation', () => {
 			assert.deepEqual(routes, {
 				version: 1,
 				include: ['/*'],
-				exclude: ['/_astro/*', '/redirectme', '/public.txt', '/a/redirect'],
+				exclude: ['/_astro/*', '/redirectme', '/public.txt', '/a/*'],
 			});
 		});
 	});
@@ -146,4 +146,43 @@ describe('_routes.json generation', () => {
 			});
 		});
 	});
+
+	describe('with nested on demand and prerendered routes', () => {
+		let fixture;
+
+		before(async () => {
+			fixture = await loadFixture({
+				root: new URL('./fixtures/routes-json/', import.meta.url).toString(),
+				srcDir: './src/reduceComplexity',
+				adapter: cloudflare({}),
+			});
+			await fixture.build();
+		});
+
+		it('reduces the amount of include and exclude entries by applying wildcards wherever possible', async () => {
+			const _routesJson = await fixture.readFile('/_routes.json');
+			const routes = JSON.parse(_routesJson);
+
+			assert.deepEqual(routes, {
+				version: 1,
+				include: [
+					'/',
+					'/_image',
+					'/dynamicPages/*',
+					'/mixedPages/dynamic',
+					'/mixedPages/subfolder/dynamic',
+				],
+				exclude: [
+					'/_astro/*',
+					'/redirectme',
+					'/public.txt',
+					'/a/*',
+					'/404',
+					'/mixedPages/static',
+					'/mixedPages/subfolder/static',
+					'/staticPages/*',
+				],
+			});
+		});
+	});
 });