Granular e2e caching (#6201)

.github/workflows/e2e.yml

@@ -51,7 +51,7 @@ jobs:
           NODE_ENV: "production"
 
       - name: Run tests
-        run: pnpm run test:e2e --filter=wrangler
+        run: pnpm run test:e2e:wrangler
         env:
           CLOUDFLARE_API_TOKEN: ${{ secrets.TEST_CLOUDFLARE_API_TOKEN }}
           CLOUDFLARE_ACCOUNT_ID: ${{ secrets.TEST_CLOUDFLARE_ACCOUNT_ID }}
@@ -75,3 +75,10 @@ jobs:
         with:
           name: e2e-test-report-${{ matrix.os }}-${{ matrix.node }}
           path: ${{ runner.temp }}/test-report/
+
+      - name: Upload turbo logs
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: turbo-runs-${{ matrix.os }}-${{ matrix.node }}
+          path: .turbo/runs

package.json

@@ -22,7 +22,8 @@
 		"prettify": "prettier . --write --ignore-unknown",
 		"test": "vitest run --no-file-parallelism && dotenv -- turbo test --filter=wrangler --filter=miniflare --filter=kv-asset-handler --filter=@cloudflare/vitest-pool-workers --filter=@cloudflare/vitest-pool-workers-examples",
 		"test:ci": "dotenv -- turbo test:ci",
-		"test:e2e": "dotenv -- turbo test:e2e --log-order=stream",
+		"test:e2e": "dotenv -- turbo test:e2e",
+		"test:e2e:wrangler": "node -r esbuild-register tools/e2e/runIndividualE2EFiles.ts",
 		"test:watch": "turbo test:watch",
 		"type:tests": "dotenv -- turbo type:tests"
 	},

tools/e2e/runIndividualE2EFiles.ts

@@ -0,0 +1,32 @@
+/**
+ * Turbo only supports caching on the individual task level, but for Wrangler's
+ * e2e tests we want to support caching on a more granular basis—at the file level.
+ *
+ * As such, we run the `test:e2e` turbo task multiple times—once per e2e test file
+ * with different arguments, ensuring that each file's tests can be cached individually.
+ *
+ * The intended flow here is that CI will run this file, which will trigger turbo to run
+ * an individual task for each Wrangler e2e test file, using `execSync`.
+ */
+import { execSync } from "child_process";
+import { readdirSync } from "fs";
+
+// Get a list of e2e test files, each of which should have an associated script
+const e2eTests = readdirSync("packages/wrangler/e2e");
+
+const tasks = new Set<string>();
+
+for (const file of e2eTests) {
+	// Ignore other files in the e2e directory (the README, for instance)
+	if (file.endsWith(".test.ts")) {
+		tasks.add(
+			`pnpm test:e2e --log-order=stream --summarize --filter wrangler --concurrency 1 -- run ./e2e/${file}`
+		);
+	}
+}
+
+for (const task of tasks.values()) {
+	execSync(task, {
+		stdio: "inherit",
+	});
+}

turbo.json

@@ -9,7 +9,9 @@
 			"persistent": true,
 			"cache": false
 		},
-		"build": { "dependsOn": ["^build"] },
+		"build": {
+			"dependsOn": ["^build"]
+		},
 		"test": {
 			"dependsOn": ["build"]
 		},
@@ -33,6 +35,8 @@
 			"dependsOn": ["build"]
 		},
 		"test:e2e": {},
-		"//#check:format": { "cache": true }
+		"//#check:format": {
+			"cache": true
+		}
 	}
 }