skip next c3 tests on forks and cleanup r2 buckets from e2e tests (#12699)

Author: emily-shen

packages/create-cloudflare/e2e/tests/frameworks/test-config.ts

@@ -1,5 +1,6 @@
 import { detectPackageManager } from "../../../src/helpers/packageManagers";
 import {
+	CLOUDFLARE_API_TOKEN,
 	frameworkToTestFilter,
 	isExperimental,
 	keys,
@@ -985,6 +986,9 @@ function getExperimentalFrameworkTestConfig(
 			testCommitMessage: true,
 			unsupportedOSs: ["win32"],
 			unsupportedPms: ["npm", "yarn"],
+			// this test creates an R2 bucket, so it requires a Cloudflare API token
+			// and needs to be skipped on forks
+			quarantine: !CLOUDFLARE_API_TOKEN,
 			verifyDeploy: {
 				route: "/",
 				expectedText: "Generated by create next app",

tools/e2e/__tests__/common.test.ts

@@ -4,11 +4,13 @@ import {
 	deleteDatabase,
 	deleteKVNamespace,
 	deleteProject,
+	deleteR2Bucket,
 	deleteWorker,
 	listTmpDatabases,
 	listTmpE2EProjects,
 	listTmpE2EWorkers,
 	listTmpKVNamespaces,
+	listTmpR2Buckets,
 } from "../common";
 
 const originalAccountID = process.env.CLOUDFLARE_ACCOUNT_ID;
@@ -346,3 +348,59 @@ describe("deleteWorker()", () => {
 		await deleteWorker(MOCK_WORKER);
 	});
 });
+
+describe("listTmpR2Buckets()", () => {
+	it("makes a REST request and returns a filtered list of R2 buckets", async () => {
+		agent
+			.get("https://api.cloudflare.com")
+			.intercept({
+				path: `/client/v4/accounts/${MOCK_CLOUDFLARE_ACCOUNT_ID}/r2/buckets`,
+				method: "GET",
+			})
+			.reply(
+				200,
+				JSON.stringify({
+					result: {
+						buckets: [
+							{ name: "my-bucket-1", creation_date: nowStr },
+							{ name: "my-bucket-2", creation_date: oldTimeStr },
+							{
+								name: "tmp-e2e-abc123-next--workers-opennext-cache",
+								creation_date: nowStr,
+							},
+							{
+								name: "tmp-e2e-def456-next--workers-opennext-cache",
+								creation_date: oldTimeStr,
+							},
+							{ name: "tmp-e2e-project-1", creation_date: nowStr },
+							{ name: "tmp-e2e-project-2", creation_date: oldTimeStr },
+						],
+					},
+					success: true,
+				})
+			);
+
+		const result = await listTmpR2Buckets();
+
+		expect(result.map((b) => b.name)).toMatchInlineSnapshot(`
+			[
+			  "tmp-e2e-def456-next--workers-opennext-cache",
+			  "tmp-e2e-project-2",
+			]
+		`);
+	});
+});
+
+describe("deleteR2Bucket()", () => {
+	it("makes a REST request to delete the given R2 bucket", async () => {
+		const MOCK_BUCKET = "tmp-e2e-abc123-next--workers-opennext-cache";
+		agent
+			.get("https://api.cloudflare.com")
+			.intercept({
+				path: `/client/v4/accounts/${MOCK_CLOUDFLARE_ACCOUNT_ID}/r2/buckets/${MOCK_BUCKET}`,
+				method: "DELETE",
+			})
+			.reply(200, JSON.stringify({ result: [] }));
+		await deleteR2Bucket(MOCK_BUCKET);
+	});
+});

tools/e2e/common.ts

@@ -16,6 +16,11 @@ export type Project = {
 	created_on: string;
 };
 
+export type R2Bucket = {
+	name: string;
+	creation_date: string;
+};
+
 export type ContainerApplication = {
 	created_at: string;
 	id: string;
@@ -266,6 +271,30 @@ export const deleteKVNamespace = async (id: string) => {
 	);
 };
 
+export const listTmpR2Buckets = async () => {
+	const response = await apiFetchResponse(`/r2/buckets`, { method: "GET" });
+	if (!response || !response.ok) {
+		return [];
+	}
+	const json = (await response.json()) as {
+		result: { buckets: R2Bucket[] };
+	};
+	return json.result.buckets.filter(
+		(bucket) =>
+			bucket.name.startsWith("tmp-e2e-") &&
+			// Buckets are more than an hour old
+			Date.now() - new Date(bucket.creation_date).valueOf() > 1000 * 60 * 60
+	);
+};
+
+export const deleteR2Bucket = async (name: string) => {
+	return await apiFetch(
+		`/r2/buckets/${name}`,
+		"DELETE",
+		/* failSilently */ true
+	);
+};
+
 export const listTmpDatabases = async () => {
 	return (await apiFetchList<Database>(`/d1/database`)).filter(
 		(db) =>

tools/e2e/e2eCleanup.ts

@@ -6,6 +6,7 @@ import {
 	deleteHyperdriveConfig,
 	deleteKVNamespace,
 	deleteProject,
+	deleteR2Bucket,
 	deleteWorker,
 	listCertificates,
 	listE2eContainerImages,
@@ -15,6 +16,7 @@ import {
 	listTmpE2EProjects,
 	listTmpE2EWorkers,
 	listTmpKVNamespaces,
+	listTmpR2Buckets,
 } from "./common";
 
 if (!process.env.CLOUDFLARE_API_TOKEN) {
@@ -38,6 +40,8 @@ async function run() {
 	// so delete these first to avoid interrupting running e2e jobs (unless you are very very unlucky)
 	await deleteKVNamespaces();
 
+	await deleteR2Buckets();
+
 	await deleteProjects();
 
 	await deleteWorkers();
@@ -174,3 +178,20 @@ async function deleteContainerApplications() {
 		console.log(`Deleted ${container.name} (${container.id})`);
 	}
 }
+
+async function deleteR2Buckets() {
+	const bucketsToDelete = await listTmpR2Buckets();
+
+	for (const bucket of bucketsToDelete) {
+		console.log("Deleting R2 bucket: " + bucket.name);
+		if (await deleteR2Bucket(bucket.name)) {
+			console.log(`Successfully deleted R2 bucket ${bucket.name}`);
+		} else {
+			console.log(`Failed to delete R2 bucket ${bucket.name}`);
+		}
+	}
+
+	if (bucketsToDelete.length === 0) {
+		console.log(`No R2 buckets to delete.`);
+	}
+}