@argos-ci/core 5.0.1 → 5.0.3-alpha.1

package/dist/index.js

@@ -238,11 +238,19 @@ var heroku_default = service3;
 
 // src/ci-environment/services/github-actions.ts
 import { existsSync, readFileSync } from "fs";
-async function getPullRequestFromHeadSha({ env }, sha) {
-  debug("Fetching pull request number from head sha", sha);
-  if (!env.GITHUB_REPOSITORY) {
+
+// src/ci-environment/github.ts
+function getGitHubRepository(ctx) {
+  return ctx.env.GITHUB_REPOSITORY || null;
+}
+function assertGitHubRepository(ctx) {
+  const repo = getGitHubRepository(ctx);
+  if (!repo) {
     throw new Error("GITHUB_REPOSITORY is missing");
   }
+  return repo;
+}
+function getGitHubToken({ env }) {
   if (!env.GITHUB_TOKEN) {
     if (!env.DISABLE_GITHUB_TOKEN_WARNING) {
       console.log(
@@ -262,43 +270,113 @@ DISABLE_GITHUB_TOKEN_WARNING: true
     }
     return null;
   }
-  try {
-    const url = new URL(
-      `https://api.github.com/repos/${env.GITHUB_REPOSITORY}/pulls`
+  return env.GITHUB_TOKEN;
+}
+async function fetchGitHubAPI(ctx, url) {
+  const githubToken = getGitHubToken(ctx);
+  if (!githubToken) {
+    return null;
+  }
+  const response = await fetch(url, {
+    headers: {
+      Accept: "application/vnd.github+json",
+      Authorization: `Bearer ${githubToken}`,
+      "X-GitHub-Api-Version": "2022-11-28"
+    },
+    signal: AbortSignal.timeout(1e4)
+  });
+  return response;
+}
+var GITHUB_API_BASE_URL = "https://api.github.com";
+async function getPullRequestFromHeadSha(ctx, sha) {
+  debug(`Fetching pull request details from head sha: ${sha}`);
+  const githubRepository = assertGitHubRepository(ctx);
+  const url = new URL(`/repos/${githubRepository}/pulls`, GITHUB_API_BASE_URL);
+  url.search = new URLSearchParams({
+    state: "open",
+    sort: "updated",
+    per_page: "30",
+    page: "1"
+  }).toString();
+  const response = await fetchGitHubAPI(ctx, url);
+  if (!response) {
+    return null;
+  }
+  if (!response.ok) {
+    throw new Error(
+      `Non-OK response (status: ${response.status}) while fetching pull request details from head sha (${sha})`
     );
-    url.search = new URLSearchParams({
-      state: "open",
-      sort: "updated",
-      per_page: "30",
-      page: "1"
-    }).toString();
-    const response = await fetch(url, {
-      headers: {
-        Accept: "application/vnd.github+json",
-        Authorization: `Bearer ${process.env.GITHUB_TOKEN}`,
-        "X-GitHub-Api-Version": "2022-11-28"
-      },
-      signal: AbortSignal.timeout(1e4)
-    });
-    if (!response.ok) {
-      throw new Error(`Failed to fetch pull requests: ${response.statusText}`);
-    }
-    const result = await response.json();
-    if (result.length === 0) {
-      debug("Aborting because no pull request found");
-      return null;
-    }
-    const matchingPr = result.find((pr) => pr.head.sha === sha);
-    if (matchingPr) {
-      debug("Pull request found", matchingPr);
-      return matchingPr;
-    }
-    debug("Aborting because no pull request found");
+  }
+  const result = await response.json();
+  if (result.length === 0) {
+    debug("No results, no pull request found");
     return null;
-  } catch (error) {
-    debug("Error while fetching pull request from head sha", error);
+  }
+  const matchingPr = result.find((pr) => pr.head.sha === sha);
+  if (matchingPr) {
+    debug("Pull request found", matchingPr);
+    return matchingPr;
+  }
+  debug("No matching pull request found");
+  return null;
+}
+async function getPullRequestFromPrNumber(ctx, prNumber) {
+  debug(`Fetching pull request #${prNumber}`);
+  const githubRepository = assertGitHubRepository(ctx);
+  const response = await fetchGitHubAPI(
+    ctx,
+    new URL(
+      `/repos/${githubRepository}/pulls/${prNumber}`,
+      GITHUB_API_BASE_URL
+    )
+  );
+  if (!response) {
+    return null;
+  }
+  if (response.status === 404) {
+    debug(
+      "No pull request found, pr detection from branch was probably a mistake"
+    );
     return null;
   }
+  if (!response.ok) {
+    throw new Error(
+      `Non-OK response (status: ${response.status}) while fetching pull request #${prNumber}`
+    );
+  }
+  const result = await response.json();
+  return result;
+}
+function getPRNumberFromMergeGroupBranch(branch2) {
+  const prMatch = /queue\/[^/]*\/pr-(\d+)-/.exec(branch2);
+  if (prMatch) {
+    const prNumber = Number(prMatch[1]);
+    return prNumber;
+  }
+  return null;
+}
+
+// src/ci-environment/services/github-actions.ts
+function readEventPayload({ env }) {
+  if (!env.GITHUB_EVENT_PATH) {
+    return null;
+  }
+  if (!existsSync(env.GITHUB_EVENT_PATH)) {
+    return null;
+  }
+  return JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf-8"));
+}
+function getVercelDeploymentPayload(payload) {
+  if (process.env.GITHUB_EVENT_NAME === "repository_dispatch" && payload && "action" in payload && payload.action === "vercel.deployment.success") {
+    return payload;
+  }
+  return null;
+}
+function getMergeGroupPayload(payload) {
+  if (payload && process.env.GITHUB_EVENT_NAME === "merge_group" && "action" in payload && payload.action === "checks_requested") {
+    return payload;
+  }
+  return null;
 }
 function getBranchFromContext(context) {
   const { env } = context;
@@ -321,6 +399,29 @@ function getBranchFromPayload(payload) {
   }
   return null;
 }
+function getBranch(args) {
+  const { payload, mergeGroupPayload, vercelPayload, pullRequest, context } = args;
+  if (mergeGroupPayload && pullRequest?.head.ref) {
+    return pullRequest.head.ref;
+  }
+  if (vercelPayload) {
+    return vercelPayload.client_payload.git.ref;
+  }
+  if (payload) {
+    const fromPayload = getBranchFromPayload(payload);
+    if (fromPayload) {
+      return fromPayload;
+    }
+  }
+  const fromContext = getBranchFromContext(context);
+  if (fromContext) {
+    return fromContext;
+  }
+  if (pullRequest) {
+    return pullRequest.head.ref;
+  }
+  return null;
+}
 function getRepository3(context, payload) {
   if (payload && "pull_request" in payload && payload.pull_request) {
     const pr = payload.pull_request;
@@ -328,20 +429,16 @@ function getRepository3(context, payload) {
       return pr.head.repo.full_name;
     }
   }
-  return getOriginalRepository(context);
-}
-function getOriginalRepository(context) {
-  const { env } = context;
-  return env.GITHUB_REPOSITORY || null;
+  return getGitHubRepository(context);
 }
-function readEventPayload({ env }) {
-  if (!env.GITHUB_EVENT_PATH) {
-    return null;
+function getSha(context, vercelPayload) {
+  if (vercelPayload) {
+    return vercelPayload.client_payload.git.sha;
   }
-  if (!existsSync(env.GITHUB_EVENT_PATH)) {
-    return null;
+  if (!context.env.GITHUB_SHA) {
+    throw new Error(`GITHUB_SHA is missing`);
   }
-  return JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf-8"));
+  return context.env.GITHUB_SHA;
 }
 function getPullRequestFromPayload(payload) {
   if ("pull_request" in payload && payload.pull_request && payload.pull_request) {
@@ -355,26 +452,27 @@ function getPullRequestFromPayload(payload) {
   }
   return null;
 }
-function getVercelDeploymentPayload(payload) {
-  if (process.env.GITHUB_EVENT_NAME === "repository_dispatch" && payload && "action" in payload && payload.action === "vercel.deployment.success") {
-    return payload;
-  }
-  return null;
-}
-function getMergeGroupPayload(payload) {
-  if (payload && process.env.GITHUB_EVENT_NAME === "merge_group" && "action" in payload && payload.action === "checks_requested") {
-    return payload;
+async function getPullRequest(args) {
+  const { payload, vercelPayload, mergeGroupPayload, context, sha } = args;
+  if (vercelPayload || !payload) {
+    return getPullRequestFromHeadSha(context, sha);
+  }
+  if (mergeGroupPayload) {
+    const prNumber = getPRNumberFromMergeGroupBranch(
+      mergeGroupPayload.merge_group.head_ref
+    );
+    if (!prNumber) {
+      debug(
+        `No PR found from merge group head ref: ${mergeGroupPayload.merge_group.head_ref}`
+      );
+      return null;
+    }
+    debug(
+      `PR #${prNumber} found from merge group head ref (${mergeGroupPayload.merge_group.head_ref})`
+    );
+    return getPullRequestFromPrNumber(context, prNumber);
   }
-  return null;
-}
-function getSha(context, vercelPayload) {
-  if (vercelPayload) {
-    return vercelPayload.client_payload.git.sha;
-  }
-  if (!context.env.GITHUB_SHA) {
-    throw new Error(`GITHUB_SHA is missing`);
-  }
-  return context.env.GITHUB_SHA;
+  return getPullRequestFromPayload(payload);
 }
 var service4 = {
   name: "GitHub Actions",
@@ -386,20 +484,33 @@ var service4 = {
     const vercelPayload = getVercelDeploymentPayload(payload);
     const mergeGroupPayload = getMergeGroupPayload(payload);
     const sha = getSha(context, vercelPayload);
-    const pullRequest = payload && !vercelPayload ? getPullRequestFromPayload(payload) : await getPullRequestFromHeadSha(context, sha);
+    const pullRequest = await getPullRequest({
+      payload,
+      vercelPayload,
+      mergeGroupPayload,
+      sha,
+      context
+    });
+    const branch2 = getBranch({
+      payload,
+      vercelPayload,
+      mergeGroupPayload,
+      context,
+      pullRequest
+    });
     return {
       commit: sha,
       repository: getRepository3(context, payload),
-      originalRepository: getOriginalRepository(context),
+      originalRepository: getGitHubRepository(context),
       jobId: env.GITHUB_JOB || null,
       runId: env.GITHUB_RUN_ID || null,
       runAttempt: env.GITHUB_RUN_ATTEMPT ? Number(env.GITHUB_RUN_ATTEMPT) : null,
       nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}`,
-      branch: vercelPayload?.client_payload?.git?.ref || getBranchFromContext(context) || pullRequest?.head.ref || (payload ? getBranchFromPayload(payload) : null) || null,
+      branch: branch2,
       prNumber: pullRequest?.number || null,
       prHeadCommit: pullRequest?.head.sha ?? null,
       prBaseBranch: pullRequest?.base.ref ?? null,
-      mergeQueue: mergeGroupPayload?.action === "checks_requested"
+      mergeQueue: Boolean(mergeGroupPayload)
     };
   },
   getMergeBaseCommitSha,
@@ -421,9 +532,9 @@ function getRepository4(context) {
   if (env.CIRCLE_PR_REPONAME && env.CIRCLE_PR_USERNAME) {
     return `${env.CIRCLE_PR_USERNAME}/${env.CIRCLE_PR_REPONAME}`;
   }
-  return getOriginalRepository2(context);
+  return getOriginalRepository(context);
 }
-function getOriginalRepository2(context) {
+function getOriginalRepository(context) {
   const { env } = context;
   if (env.CIRCLE_PROJECT_USERNAME && env.CIRCLE_PROJECT_REPONAME) {
     return `${env.CIRCLE_PROJECT_USERNAME}/${env.CIRCLE_PROJECT_REPONAME}`;
@@ -440,7 +551,7 @@ var service5 = {
       commit: env.CIRCLE_SHA1 || null,
       branch: env.CIRCLE_BRANCH || null,
       repository: getRepository4(context),
-      originalRepository: getOriginalRepository2(context),
+      originalRepository: getOriginalRepository(context),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -462,9 +573,9 @@ function getRepository5(context) {
   if (env.TRAVIS_PULL_REQUEST_SLUG) {
     return env.TRAVIS_PULL_REQUEST_SLUG;
   }
-  return getOriginalRepository3(context);
+  return getOriginalRepository2(context);
 }
-function getOriginalRepository3(context) {
+function getOriginalRepository2(context) {
   const { env } = context;
   return env.TRAVIS_REPO_SLUG || null;
 }
@@ -485,7 +596,7 @@ var service6 = {
       commit: env.TRAVIS_COMMIT || null,
       branch: env.TRAVIS_BRANCH || null,
       repository: getRepository5(ctx),
-      originalRepository: getOriginalRepository3(ctx),
+      originalRepository: getOriginalRepository2(ctx),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -507,9 +618,9 @@ function getRepository6(context) {
   if (env.CI_MERGE_REQUEST_PROJECT_PATH) {
     return env.CI_MERGE_REQUEST_PROJECT_PATH;
   }
-  return getOriginalRepository4(context);
+  return getOriginalRepository3(context);
 }
-function getOriginalRepository4(context) {
+function getOriginalRepository3(context) {
   const { env } = context;
   return env.CI_PROJECT_PATH || null;
 }
@@ -523,7 +634,7 @@ var service7 = {
       commit: env.CI_COMMIT_SHA || null,
       branch: env.CI_COMMIT_REF_NAME || null,
       repository: getRepository6(context),
-      originalRepository: getOriginalRepository4(context),
+      originalRepository: getOriginalRepository3(context),
       jobId: null,
       runId: null,
       runAttempt: null,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "5.0.1",
+  "version": "5.0.3-alpha.1+4a513df",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,8 +40,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.15.0",
-    "@argos-ci/util": "3.2.0",
+    "@argos-ci/api-client": "0.15.1-alpha.5+4a513df",
+    "@argos-ci/util": "3.2.1-alpha.19+4a513df",
     "convict": "^6.2.4",
     "debug": "^4.4.3",
     "fast-glob": "^3.3.3",
@@ -67,5 +67,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "389e8ae7fe5cd4bf74d2627853b8c62e4b09e86a"
+  "gitHead": "4a513dfc1b959dc5fb000ffb77d122c3096bf481"
 }