@argos-ci/core 0.7.2 → 0.8.0

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import convict from 'convict';
 import { execSync } from 'node:child_process';
-import { execSync as execSync$1 } from 'child_process';
+import { existsSync, readFileSync, createReadStream } from 'node:fs';
 import createDebug from 'debug';
 import envCi from 'env-ci';
 import { resolve } from 'node:path';
@@ -8,7 +8,6 @@ import glob from 'fast-glob';
 import { promisify } from 'node:util';
 import sharp from 'sharp';
 import tmp from 'tmp';
-import { createReadStream } from 'node:fs';
 import { createHash } from 'node:crypto';
 import axios from 'axios';
 import { readFile } from 'node:fs/promises';
@@ -170,39 +169,6 @@ const service$3 = {
         })
 };
 
-const getSha = ({ env  })=>{
-    const isPr = env.GITHUB_EVENT_NAME === "pull_request" || env.GITHUB_EVENT_NAME === "pull_request_target";
-    if (isPr) {
-        const mergeCommitRegex = /^[a-z0-9]{40} [a-z0-9]{40}$/;
-        const mergeCommitMessage = execSync$1("git show --no-patch --format=%P").toString().trim();
-        // console.log(
-        //   `Handling PR with parent hash(es) '${mergeCommitMessage}' of current commit.`
-        // );
-        if (mergeCommitRegex.exec(mergeCommitMessage)) {
-            const mergeCommit = mergeCommitMessage.split(" ")[1];
-            // console.log(
-            //   `Fixing merge commit SHA ${process.env.GITHUB_SHA} -> ${mergeCommit}`
-            // );
-            return mergeCommit;
-        } else if (mergeCommitMessage === "") {
-            console.error(`Error: automatic detection of commit SHA failed.
-
-Please run "actions/checkout" with "fetch-depth: 2". Example:
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 2
-
-`);
-            process.exit(1);
-        } else {
-            console.error(`Commit with SHA ${process.env.GITHUB_SHA} is not a valid commit`);
-            process.exit(1);
-        }
-    }
-    return process.env.GITHUB_SHA ?? null;
-};
 const getBranch = ({ env  })=>{
     if (env.GITHUB_HEAD_REF) {
         return env.GITHUB_HEAD_REF;
@@ -218,34 +184,32 @@ const getRepository$1 = ({ env  })=>{
     if (!env.GITHUB_REPOSITORY) return null;
     return env.GITHUB_REPOSITORY.split("/")[1];
 };
-const getPrNumber$2 = ({ env  })=>{
-    const branchRegex = /refs\/pull\/(\d+)/;
-    const branchMatches = branchRegex.exec(env.GITHUB_REF || "");
-    if (branchMatches) {
-        return Number(branchMatches[1]);
-    }
-    return null;
+const 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"));
 };
 const service$2 = {
     name: "GitHub Actions",
     detect: ({ env  })=>Boolean(env.GITHUB_ACTIONS),
-    config: ({ env  })=>({
-            commit: getSha({
-                env
-            }),
-            branch: getBranch({
+    config: ({ env  })=>{
+        const payload = readEventPayload({
+            env
+        });
+        return {
+            commit: payload?.pull_request?.head.sha || process.env.GITHUB_SHA || null,
+            branch: payload?.pull_request?.head.ref || getBranch({
                 env
-            }),
+            }) || null,
             owner: env.GITHUB_REPOSITORY_OWNER || null,
             repository: getRepository$1({
                 env
             }),
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || null,
-            prNumber: getPrNumber$2({
-                env
-            })
-        })
+            prNumber: payload?.pull_request?.number || null
+        };
+    }
 };
 
 const getPrNumber$1 = ({ env  })=>{
@@ -303,7 +267,20 @@ const service = {
     }
 };
 
-const debug = createDebug("@argos-ci/core");
+const KEY = "@argos-ci/core";
+const debug = createDebug(KEY);
+const debugTime = (arg)=>{
+    const enabled = createDebug.enabled(KEY);
+    if (enabled) {
+        console.time(arg);
+    }
+};
+const debugTimeEnd = (arg)=>{
+    const enabled = createDebug.enabled(KEY);
+    if (enabled) {
+        console.timeEnd(arg);
+    }
+};
 
 const getCiEnvironmentFromEnvCi = (ctx)=>{
     const ciContext = envCi(ctx);
@@ -477,6 +454,22 @@ const upload$1 = async (input)=>{
     });
 };
 
+/**
+ * Split an array into chunks of a given size.
+ */ const chunk = (collection, size)=>{
+    const result = [];
+    // add each chunk to the result
+    for(let x = 0; x < Math.ceil(collection.length / size); x++){
+        let start = x * size;
+        let end = start + size;
+        result.push(collection.slice(start, end));
+    }
+    return result;
+};
+
+/**
+ * Size of the chunks used to upload screenshots to Argos.
+ */ const CHUNK_SIZE = 10;
 const getConfigFromOptions = (options)=>{
     const config = createConfig();
     const ciEnv = getCiEnvironment();
@@ -545,18 +538,25 @@ const getConfigFromOptions = (options)=>{
         prNumber: config.prNumber
     });
     debug("Got screenshots", result);
-    // Upload screenshots
-    debug("Uploading screenshots");
-    await Promise.all(result.screenshots.map(async ({ key , putUrl  })=>{
-        const screenshot = screenshots.find((s)=>s.hash === key);
-        if (!screenshot) {
-            throw new Error(`Invariant: screenshot with hash ${key} not found`);
-        }
-        await upload$1({
-            url: putUrl,
-            path: screenshot.optimizedPath
-        });
-    }));
+    debug(`Split screenshots in chunks of ${CHUNK_SIZE}`);
+    const chunks = chunk(result.screenshots, CHUNK_SIZE);
+    debug(`Starting upload of ${chunks.length} chunks`);
+    for(let i = 0; i < chunks.length; i++){
+        debug(`Uploading chunk ${i + 1}/${chunks.length}`);
+        const timeLabel = `Chunk ${i + 1}/${chunks.length}`;
+        debugTime(timeLabel);
+        await Promise.all(chunks[i].map(async ({ key , putUrl  })=>{
+            const screenshot = screenshots.find((s)=>s.hash === key);
+            if (!screenshot) {
+                throw new Error(`Invariant: screenshot with hash ${key} not found`);
+            }
+            await upload$1({
+                url: putUrl,
+                path: screenshot.optimizedPath
+            });
+        }));
+        debugTimeEnd(timeLabel);
+    }
     // Update build
     debug("Updating build");
     await apiClient.updateBuild({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Visual testing solution to avoid visual regression. The core component of Argos SDK that handles build creation.",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "scripts": {
     "prebuild": "rm -rf dist",
     "build": "rollup -c",
@@ -60,5 +60,5 @@
     "rollup-plugin-dts": "^4.2.3",
     "rollup-plugin-swc3": "^0.6.0"
   },
-  "gitHead": "7adf2cb62ceb13887c7ddf675f4d19e2bd2572b9"
+  "gitHead": "bad0f5b5bf1dc1672b05cf08a4fec5d011ac4b0a"
 }