fix: typo affecting commit and compareSHA (#257)

Author: joseph-sentry

packages/bundler-plugin-core/package.json

@@ -47,7 +47,7 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@octokit/webhooks-definitions": "^3.67.3",
+    "@octokit/webhooks-types": "^7.6.1",
     "@sentry/core": "^8.42.0",
     "@types/node": "^20.11.15",
     "@types/semver": "^7.5.6",

packages/bundler-plugin-core/src/utils/providers/GitHubActions.ts

@@ -7,7 +7,10 @@ import {
 } from "../../types.ts";
 import { type Output } from "../Output.ts";
 import { debug } from "../logging.ts";
-import { type PullRequestEvent } from "@octokit/webhooks-definitions/schema";
+import {
+  type PullRequestEvent,
+  type MergeGroupEvent,
+} from "@octokit/webhooks-types";
 
 export function detect(envs: ProviderEnvs): boolean {
   return Boolean(envs?.GITHUB_ACTIONS);
@@ -184,9 +187,12 @@ function _getSHA(
 
   const context = GitHub.context;
   let commit = envs?.GITHUB_SHA;
-  if (["pull_request", " pull_request_target"].includes(context.eventName)) {
+  if (["pull_request", "pull_request_target"].includes(context.eventName)) {
     const payload = context.payload as PullRequestEvent;
     commit = payload.pull_request.head.sha;
+  } else if ("merge_group" === context.eventName) {
+    const payload = context.payload as MergeGroupEvent;
+    commit = payload.merge_group.head_sha;
   }
 
   debug(`Using commit: ${commit ?? null}`, { enabled: output.debug });
@@ -205,9 +211,12 @@ function _getCompareSHA(
 
   let compareSha = null;
   const context = GitHub.context;
-  if (["pull_request", " pull_request_target"].includes(context.eventName)) {
+  if (["pull_request", "pull_request_target"].includes(context.eventName)) {
     const payload = context.payload as PullRequestEvent;
     compareSha = payload.pull_request.base.sha;
+  } else if ("merge_group" === context.eventName) {
+    const payload = context.payload as MergeGroupEvent;
+    compareSha = payload.merge_group.base_sha;
   }
 
   debug(`Using compareSha: ${compareSha}`, { enabled: output.debug });

packages/bundler-plugin-core/src/utils/providers/__tests__/GitHubActions.test.ts

@@ -54,7 +54,7 @@ describe("GitHub Actions Params", () => {
       headLabel = "",
     }: {
       data?: object;
-      eventName?: "" | "pull_request" | "pull_request_target";
+      eventName?: "" | "pull_request" | "pull_request_target" | "merge_group";
       baseLabel?: string;
       headLabel?: string;
     } = { data: {}, eventName: "" },
@@ -63,22 +63,38 @@ describe("GitHub Actions Params", () => {
     mocks.baseLabel.mockReturnValue(baseLabel);
     mocks.headLabel.mockReturnValue(headLabel);
 
-    vi.mocked(GitHub).context = {
-      eventName,
-      payload: {
-        // @ts-expect-error - forcing the payload to be a PullRequestEvent
-        pull_request: {
-          head: {
-            sha: "test-head-sha",
-            label: headLabel,
+    // not sure if empty string is correct here but for parity with previous tests
+    // TODO: verify that empty string belongs here, from a glance it seems PushEvent does not
+    // include a pull_request key
+    if (["pull_request", "pull_request_target", ""].includes(eventName)) {
+      vi.mocked(GitHub).context = {
+        eventName,
+        payload: {
+          // @ts-expect-error - forcing the payload to be a PullRequestEvent
+          pull_request: {
+            head: {
+              sha: "test-head-sha",
+              label: headLabel,
+            },
+            base: {
+              sha: "test-base-sha",
+              label: baseLabel,
+            },
           },
-          base: {
-            sha: "test-base-sha",
-            label: baseLabel,
+        },
+      };
+    } else if (eventName === "merge_group") {
+      // @ts-expect-error - forcing the payload to be a MergeGroupEvent
+      vi.mocked(GitHub).context = {
+        eventName,
+        payload: {
+          merge_group: {
+            base_sha: "test-base-sha",
+            head_sha: "test-head-sha",
           },
         },
-      },
-    };
+      };
+    }
 
     server.use(
       http.get(
@@ -324,7 +340,66 @@ describe("GitHub Actions Params", () => {
         build: "2",
         buildURL: "https://github.com/testOrg/testRepo/actions/runs/2",
         commit: "test-head-sha",
-        compareSha: null,
+        compareSha: "test-base-sha",
+        job: "testWorkflow",
+        pr: "1",
+        service: "github-actions",
+        slug: "testOrg/testRepo",
+      };
+      expect(params).toMatchObject(expected);
+    });
+
+    it("gets the correct branch from a merge group CI run", async () => {
+      setup({
+        data: {
+          jobs: [
+            {
+              id: 1,
+              name: "fakeJob",
+              html_url: "https://fake.com",
+            },
+          ],
+        },
+        eventName: "merge_group",
+        baseLabel: "codecov:baseBranch",
+        headLabel: "testOrg:headBranch",
+      });
+
+      const inputs: ProviderUtilInputs = {
+        args: { ...createEmptyArgs() },
+        envs: {
+          GITHUB_ACTIONS: "true",
+          GITHUB_HEAD_REF: "branch",
+          GITHUB_JOB: "testJob",
+          GITHUB_REF: "refs/pull/1/merge",
+          GITHUB_REPOSITORY: "testOrg/testRepo",
+          GITHUB_RUN_ID: "2",
+          GITHUB_SERVER_URL: "https://github.com",
+          GITHUB_SHA: "test-head-sha",
+          GITHUB_WORKFLOW: "testWorkflow",
+        },
+      };
+
+      const output = new Output(
+        {
+          apiUrl: "http://localhost",
+          bundleName: "GHA-test",
+          debug: false,
+          dryRun: true,
+          enableBundleAnalysis: true,
+          retryCount: 0,
+          telemetry: false,
+        },
+        { metaFramework: "vite" },
+      );
+      const params = await GitHubActions.getServiceParams(inputs, output);
+
+      const expected: ProviderServiceParams = {
+        branch: "branch",
+        build: "2",
+        buildURL: "https://github.com/testOrg/testRepo/actions/runs/2",
+        commit: "test-head-sha",
+        compareSha: "test-base-sha",
         job: "testWorkflow",
         pr: "1",
         service: "github-actions",
@@ -383,7 +458,7 @@ describe("GitHub Actions Params", () => {
         build: "2",
         buildURL: "https://github.com/testOrg/testRepo/actions/runs/2",
         commit: "test-head-sha",
-        compareSha: null,
+        compareSha: "test-base-sha",
         job: "testWorkflow",
         pr: "1",
         service: "github-actions",