chore: add workflow to check v3 patch status (#8962)

Co-authored-by: lrapoport-cf <[email protected]>

Author: edmundhung

.github/workflows/open-v3-maintenance-prs.yml

@@ -2,14 +2,19 @@ name: v3 Maintenance
 
 on:
   pull_request:
-    branches: main
+    branches: [main, v3-maintenance]
     types: [synchronize, opened, reopened, labeled, unlabeled]
     paths:
       - ".changeset/**.md"
 
 jobs:
   open-pr:
-    if: ${{ github.repository_owner == 'cloudflare' && !contains(github.event.pull_request.labels.*.name, 'skip-v3-pr') }}
+    if: ${{
+      github.repository_owner == 'cloudflare' &&
+      github.base_ref == 'main' &&
+      github.event.pull_request.draft == false &&
+      contains(github.event.pull_request.labels.*.name, 'skip-v3-pr') == false
+      }}
     name: Open backport PR for patches
     runs-on: macos-latest
     concurrency:
@@ -55,3 +60,26 @@ jobs:
           header: v3-backport
           message: |
             These changes have been automatically backported to Wrangler v3 :tada: You can view the automatically updated PR at https://github.com/cloudflare/workers-sdk/compare/v3-maintenance...v3-maintenance-${{ github.event.number }}. Please check that PR for correctness, and make sure it's merged after this one. Thank you for helping us keep Wrangler v3 supported!
+
+  check-status:
+    if: ${{ github.repository_owner == 'cloudflare' && github.base_ref == 'v3-maintenance' }}
+    name: Check v3 patch status
+    runs-on: macos-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+    timeout-minutes: 30
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Dependencies
+        uses: ./.github/actions/install-dependencies
+
+      - name: Check if the original PR is merged
+        run: node -r esbuild-register tools/deployments/check-v3-patch-status.ts
+        env:
+          GH_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }}
+          BRANCH_NAME: ${{ github.head_ref }}

tools/deployments/__tests__/check-v3-patch-status.test.ts

@@ -0,0 +1,45 @@
+import { describe, expect, it, vi } from "vitest";
+import { validateBackportPR } from "../check-v3-patch-status";
+
+describe("validateBackportPR", () => {
+	it("should return false if the branch name does not match the pattern", () => {
+		const consoleLog = vi.spyOn(console, "log").mockImplementation(() => {});
+		const consoleError = vi
+			.spyOn(console, "error")
+			.mockImplementation(() => {});
+		const result = validateBackportPR("example/v3-maintenance-demo", () => {
+			throw new Error("Unexpected");
+		});
+
+		expect(result).toBe(false);
+		expect(consoleLog).not.toBeCalled();
+		expect(consoleError).toBeCalledWith(
+			`❌ Branch name "example/v3-maintenance-demo" does not match the expected pattern "v3-maintenance-<PR_NUMBER>"`
+		);
+	});
+
+	it("should return false if the original PR is not merged", () => {
+		const consoleLog = vi.spyOn(console, "log").mockImplementation(() => {});
+		const consoleError = vi
+			.spyOn(console, "error")
+			.mockImplementation(() => {});
+		const isMergedMock = vi.fn(() => false);
+		const result = validateBackportPR("v3-maintenance-13579", isMergedMock);
+
+		expect(result).toBe(false);
+		expect(isMergedMock).toBeCalledWith("13579");
+		expect(consoleLog).toBeCalledWith(`🔍 Checking if PR #13579 is merged...`);
+		expect(consoleError).toBeCalledWith(`❌ PR #13579 is not merged.`);
+	});
+
+	it("should return true if the original PR is merged", () => {
+		const consoleLog = vi.spyOn(console, "log").mockImplementation(() => {});
+		const isMergedMock = vi.fn(() => true);
+		const result = validateBackportPR("v3-maintenance-2468", isMergedMock);
+
+		expect(result).toBe(true);
+		expect(isMergedMock).toBeCalledWith("2468");
+		expect(consoleLog).toBeCalledWith(`🔍 Checking if PR #2468 is merged...`);
+		expect(consoleLog).toBeCalledWith(`✅ PR #2468 is merged.`);
+	});
+});

tools/deployments/check-v3-patch-status.ts

@@ -0,0 +1,62 @@
+import { execSync } from "node:child_process";
+
+/* eslint-disable turbo/no-undeclared-env-vars */
+if (require.main === module) {
+	const branchName = process.env.BRANCH_NAME;
+
+	if (!branchName) {
+		console.error("Missing BRANCH_NAME environment variables.");
+		process.exit(1);
+	}
+
+	if (!validateBackportPR(branchName, isPullRequestMerged)) {
+		process.exit(1);
+	}
+}
+
+export function validateBackportPR(
+	branchName: string,
+	isMerged: (prNumber: string) => boolean
+): boolean {
+	const prNumber = extractPullRequestNumber(branchName);
+
+	if (!prNumber) {
+		console.error(
+			`❌ Branch name "${branchName}" does not match the expected pattern "v3-maintenance-<PR_NUMBER>"`
+		);
+		return false;
+	}
+
+	console.log(`🔍 Checking if PR #${prNumber} is merged...`);
+
+	try {
+		if (isMerged(prNumber)) {
+			console.log(`✅ PR #${prNumber} is merged.`);
+			return true;
+		} else {
+			console.error(`❌ PR #${prNumber} is not merged.`);
+			return false;
+		}
+	} catch (exception) {
+		console.error(`❌ Failed to fetch PR #${prNumber}:`, exception);
+		return false;
+	}
+}
+
+export function extractPullRequestNumber(branchName: string): string | null {
+	const match = branchName.match(/^v3-maintenance-(\d+)$/);
+
+	if (match && match[1]) {
+		return match[1];
+	}
+
+	return null;
+}
+
+export function isPullRequestMerged(prNumber: string): boolean {
+	const result = execSync(`gh pr view ${prNumber} --json state --jq .state`)
+		.toString()
+		.trim();
+
+	return result === "MERGED";
+}