@argos-ci/core 2.11.1 → 3.0.0

package/dist/index.js

@@ -181,12 +181,16 @@ async function getPullRequestFromHeadSha({ env }, sha) {
     if (!env.DISABLE_GITHUB_TOKEN_WARNING) {
       console.log(
         `
-Running argos from a "deployment_status" event requires a GITHUB_TOKEN.
-Please add \`GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}\` as environment variable.
+Argos couldn\u2019t find a relevant pull request in the current environment.
+To resolve this, Argos requires a GITHUB_TOKEN to fetch the pull request associated with the head SHA. Please ensure the following environment variable is added:
 
-Read more at https://argos-ci.com/docs/run-on-preview-deployment
+GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}
 
-To disable this warning, add \`DISABLE_GITHUB_TOKEN_WARNING: true\` as environment variable.
+For more details, check out the documentation: Read more at https://argos-ci.com/docs/run-on-preview-deployment
+
+If you want to disable this warning, you can set the following environment variable:
+
+DISABLE_GITHUB_TOKEN_WARNING: true
 `.trim()
       );
     }
@@ -225,10 +229,7 @@ To disable this warning, add \`DISABLE_GITHUB_TOKEN_WARNING: true\` as environme
     return null;
   }
 }
-function getBranch(context, eventPayload) {
-  if (eventPayload?.pull_request?.head.ref) {
-    return eventPayload.pull_request.head.ref;
-  }
+function getBranchFromContext(context) {
   const { env } = context;
   if (env.GITHUB_HEAD_REF) {
     return env.GITHUB_HEAD_REF;
@@ -240,7 +241,16 @@ function getBranch(context, eventPayload) {
   const matches = branchRegex.exec(env.GITHUB_REF);
   return matches?.[1] ?? null;
 }
-function getRepository({ env }) {
+function getBranchFromPayload(payload) {
+  if ("workflow_run" in payload && payload.workflow_run) {
+    return payload.workflow_run.head_branch;
+  }
+  if ("deployment" in payload && payload.deployment) {
+    return payload.deployment.environment;
+  }
+  return null;
+}
+function getRepositoryFromContext({ env }) {
   if (!env.GITHUB_REPOSITORY) return null;
   return env.GITHUB_REPOSITORY.split("/")[1] || null;
 }
@@ -249,6 +259,18 @@ function readEventPayload({ env }) {
   if (!existsSync(env.GITHUB_EVENT_PATH)) return null;
   return JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf-8"));
 }
+function getPullRequestFromPayload(payload) {
+  if ("pull_request" in payload && payload.pull_request && payload.pull_request) {
+    return payload.pull_request;
+  }
+  if ("workflow_run" in payload && payload.workflow_run && payload.workflow_run.pull_requests[0]) {
+    return payload.workflow_run.pull_requests[0];
+  }
+  if ("check_run" in payload && payload.check_run && "pull_requests" in payload.check_run && payload.check_run.pull_requests[0]) {
+    return payload.check_run.pull_requests[0];
+  }
+  return null;
+}
 var service4 = {
   name: "GitHub Actions",
   key: "github-actions",
@@ -260,34 +282,19 @@ var service4 = {
     if (!sha) {
       throw new Error(`GITHUB_SHA is missing`);
     }
-    const commonConfig = {
+    const pullRequest = payload ? getPullRequestFromPayload(payload) : await getPullRequestFromHeadSha(context, sha);
+    return {
       commit: sha,
       owner: env.GITHUB_REPOSITORY_OWNER || null,
-      repository: getRepository(context),
+      repository: getRepositoryFromContext(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}` || null
-    };
-    if (payload?.deployment) {
-      debug("Deployment event detected");
-      const pullRequest = await getPullRequestFromHeadSha(context, sha);
-      return {
-        ...commonConfig,
-        // If no pull request is found, we fallback to the deployment environment as branch name
-        // Branch name is required to create a build but has no real impact on the build.
-        branch: pullRequest?.head.ref || payload.deployment.environment || null,
-        prNumber: pullRequest?.number || null,
-        prHeadCommit: pullRequest?.head.sha || null,
-        prBaseBranch: null
-      };
-    }
-    return {
-      ...commonConfig,
-      branch: payload?.pull_request?.head.ref || getBranch(context, payload) || null,
-      prNumber: payload?.pull_request?.number || null,
-      prHeadCommit: payload?.pull_request?.head.sha ?? null,
-      prBaseBranch: payload?.pull_request?.base.ref ?? null
+      nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}` || null,
+      branch: getBranchFromContext(context) || pullRequest?.head.ref || (payload ? getBranchFromPayload(payload) : null) || null,
+      prNumber: pullRequest?.number || null,
+      prHeadCommit: pullRequest?.head.sha ?? null,
+      prBaseBranch: pullRequest?.base.ref ?? null
     };
   },
   getMergeBaseCommitSha,
@@ -333,7 +340,7 @@ var getOwner = ({ env }) => {
   if (!env.TRAVIS_REPO_SLUG) return null;
   return env.TRAVIS_REPO_SLUG.split("/")[0] || null;
 };
-var getRepository2 = ({ env }) => {
+var getRepository = ({ env }) => {
   if (!env.TRAVIS_REPO_SLUG) return null;
   return env.TRAVIS_REPO_SLUG.split("/")[1] || null;
 };
@@ -351,7 +358,7 @@ var service6 = {
       commit: env.TRAVIS_COMMIT || null,
       branch: env.TRAVIS_BRANCH || null,
       owner: getOwner(ctx),
-      repository: getRepository2(ctx),
+      repository: getRepository(ctx),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -678,16 +685,61 @@ var discoverScreenshots = async (patterns, { root = process.cwd(), ignore } = {}
 
 // src/optimize.ts
 import { promisify } from "node:util";
+import { basename } from "node:path";
 import sharp from "sharp";
 import tmp from "tmp";
 var tmpFile = promisify(tmp.file);
+var MAX_PIXELS = 8e7;
+var DEFAULT_MAX_WIDTH = 2048;
 var optimizeScreenshot = async (filepath) => {
   try {
-    const resultFilePath = await tmpFile();
-    await sharp(filepath).resize(2048, 64e3, {
-      fit: "inside",
-      withoutEnlargement: true
-    }).png({ force: true }).toFile(resultFilePath);
+    const [resultFilePath, metadata] = await Promise.all([
+      tmpFile(),
+      sharp(filepath).metadata()
+    ]);
+    const { width, height } = metadata;
+    const maxDimensions = (() => {
+      if (!width || !height) {
+        return {
+          width: DEFAULT_MAX_WIDTH,
+          height: Math.floor(MAX_PIXELS / DEFAULT_MAX_WIDTH)
+        };
+      }
+      const nbPixels = width * height;
+      if (nbPixels <= MAX_PIXELS) {
+        return null;
+      }
+      if (width < height) {
+        return {
+          width: DEFAULT_MAX_WIDTH,
+          height: Math.floor(MAX_PIXELS / DEFAULT_MAX_WIDTH)
+        };
+      }
+      const scaleFactor = Math.sqrt(MAX_PIXELS / nbPixels);
+      return {
+        width: Math.floor(width * scaleFactor),
+        height: Math.floor(height * scaleFactor)
+      };
+    })();
+    let operation = sharp(filepath);
+    if (maxDimensions) {
+      operation = operation.resize(maxDimensions.width, maxDimensions.height, {
+        fit: "inside",
+        withoutEnlargement: true
+      });
+    }
+    await operation.png({ force: true }).toFile(resultFilePath);
+    if (width && height && maxDimensions) {
+      const { width: maxWidth, height: maxHeight } = maxDimensions;
+      const widthRatio = maxWidth / width;
+      const heightRatio = maxHeight / height;
+      const scaleFactor = Math.min(widthRatio, heightRatio);
+      const newWidth = Math.floor(width * scaleFactor);
+      const newHeight = Math.floor(height * scaleFactor);
+      console.warn(
+        `Image ${basename(filepath)} resized from ${width}x${height} to ${newWidth}x${newHeight}.`
+      );
+    }
     return resultFilePath;
   } catch (error) {
     const message = error instanceof Error ? error.message : "Unknown Error";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "2.11.1",
+  "version": "3.0.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,24 +40,25 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.7.1",
-    "@argos-ci/util": "2.2.1",
-    "axios": "^1.7.7",
+    "@argos-ci/api-client": "0.7.2",
+    "@argos-ci/util": "2.2.2",
+    "axios": "^1.7.9",
     "convict": "^6.2.4",
-    "debug": "^4.3.7",
-    "fast-glob": "^3.3.2",
+    "debug": "^4.4.0",
+    "fast-glob": "^3.3.3",
     "sharp": "^0.33.5",
     "tmp": "^0.2.3"
   },
   "devDependencies": {
+    "@octokit/webhooks": "^13.4.2",
     "@types/convict": "^6.1.6",
     "@types/debug": "^4.1.12",
     "@types/tmp": "^0.2.6",
-    "msw": "^2.5.1"
+    "msw": "^2.7.0"
   },
   "scripts": {
     "build": "tsup && cp ./src/index.cjs ./dist",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "1dd8b4240b76b0756d8784e3320b7f57d915aeaf"
+  "gitHead": "0c91306ae0cb8bec5ef93db79565635e405086f7"
 }