@argos-ci/core 1.4.1 → 1.5.0

package/dist/index.d.ts

@@ -32,7 +32,7 @@ interface UploadParameters {
 /**
  * Upload screenshots to argos-ci.com.
  */
-declare const upload: (params: UploadParameters) => Promise<{
+declare function upload(params: UploadParameters): Promise<{
     build: {
         id: string;
         url: string;
@@ -67,5 +67,5 @@ interface Config {
     prNumber: number | null;
     prHeadCommit: string | null;
 }
-declare const readConfig: (options?: Partial<Config>) => Config;
+declare function readConfig(options?: Partial<Config>): Promise<Config>;
 export { UploadParameters, upload, Config, readConfig };

package/dist/index.mjs

@@ -1,6 +1,7 @@
 import convict from 'convict';
 import { execSync } from 'node:child_process';
 import { existsSync, readFileSync, createReadStream } from 'node:fs';
+import axios from 'axios';
 import createDebug from 'debug';
 import { resolve } from 'node:path';
 import glob from 'fast-glob';
@@ -8,7 +9,6 @@ import { promisify } from 'node:util';
 import sharp from 'sharp';
 import tmp from 'tmp';
 import { createHash } from 'node:crypto';
-import axios from 'axios';
 import { readFile } from 'node:fs/promises';
 import { readMetadata, getPlaywrightTracePath } from '@argos-ci/util';
 
@@ -102,6 +102,65 @@ const service$5 = {
         })
 };
 
+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);
+    }
+};
+
+/**
+ * When triggered by a deployment we try to get the pull request number from the
+ * deployment sha.
+ */ async function getPullRequestFromHeadSha({ env }, sha) {
+    debug("Fetching pull request number from head sha", sha);
+    if (!env.GITHUB_REPOSITORY) {
+        throw new Error("GITHUB_REPOSITORY is missing");
+    }
+    if (!env.GITHUB_TOKEN) {
+        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.
+
+Read more at https://argos-ci.com/docs/run-on-preview-deployment
+
+To disable this warning, add \`DISABLE_GITHUB_TOKEN_WARNING: true\` as environment variable.
+`.trim());
+        }
+        return null;
+    }
+    try {
+        const result = await axios.get(`https://api.github.com/repos/${env.GITHUB_REPOSITORY}/pulls`, {
+            params: {
+                head: sha
+            },
+            headers: {
+                Accept: "application/vnd.github+json",
+                Authorization: `Bearer ${process.env.GITHUB_TOKEN}`,
+                "X-GitHub-Api-Version": "2022-11-28"
+            }
+        });
+        if (result.data.length === 0) {
+            debug("Aborting because no pull request found");
+            return null;
+        }
+        const firstPr = result.data[0];
+        debug("PR found", firstPr);
+        return firstPr;
+    } catch (error) {
+        debug("Error while fetching pull request from head sha", error);
+        return null;
+    }
+}
 const getBranch = ({ env })=>{
     if (env.GITHUB_HEAD_REF) {
         return env.GITHUB_HEAD_REF;
@@ -125,26 +184,46 @@ const readEventPayload = ({ env })=>{
 const service$4 = {
     name: "GitHub Actions",
     detect: ({ env })=>Boolean(env.GITHUB_ACTIONS),
-    config: ({ env })=>{
+    config: async ({ env })=>{
         var _payload_pull_request, _payload_pull_request1, _payload_pull_request2;
         const payload = readEventPayload({
             env
         });
-        return {
-            commit: process.env.GITHUB_SHA || null,
-            branch: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request = payload.pull_request) === null || _payload_pull_request === void 0 ? void 0 : _payload_pull_request.head.ref) || getBranch({
-                env
-            }) || null,
+        const sha = process.env.GITHUB_SHA || null;
+        if (!sha) {
+            throw new Error(`GITHUB_SHA is missing`);
+        }
+        const commonConfig = {
+            commit: sha,
             owner: env.GITHUB_REPOSITORY_OWNER || null,
             repository: getRepository$1({
                 env
             }),
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || null,
-            prNumber: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request1 = payload.pull_request) === null || _payload_pull_request1 === void 0 ? void 0 : _payload_pull_request1.number) || null,
-            prHeadCommit: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request2 = payload.pull_request) === null || _payload_pull_request2 === void 0 ? void 0 : _payload_pull_request2.head.sha) ?? null,
             nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}` || null
         };
+        // If the job is triggered by from a "deployment" or a "deployment_status"
+        if (payload === null || payload === void 0 ? void 0 : payload.deployment) {
+            debug("Deployment event detected");
+            const pullRequest = await getPullRequestFromHeadSha({
+                env
+            }, sha);
+            return {
+                ...commonConfig,
+                branch: (pullRequest === null || pullRequest === void 0 ? void 0 : pullRequest.head.ref) || payload.deployment.environment || null,
+                prNumber: (pullRequest === null || pullRequest === void 0 ? void 0 : pullRequest.number) || null,
+                prHeadCommit: (pullRequest === null || pullRequest === void 0 ? void 0 : pullRequest.head.sha) || null
+            };
+        }
+        return {
+            ...commonConfig,
+            branch: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request = payload.pull_request) === null || _payload_pull_request === void 0 ? void 0 : _payload_pull_request.head.ref) || getBranch({
+                env
+            }) || null,
+            prNumber: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request1 = payload.pull_request) === null || _payload_pull_request1 === void 0 ? void 0 : _payload_pull_request1.number) || null,
+            prHeadCommit: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request2 = payload.pull_request) === null || _payload_pull_request2 === void 0 ? void 0 : _payload_pull_request2.head.sha) ?? null
+        };
     }
 };
 
@@ -243,21 +322,6 @@ const service = {
     }
 };
 
-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);
-    }
-};
-
 // List of services ordered by usage
 // "git" must be the last one
 const services = [
@@ -270,7 +334,7 @@ const services = [
     service$7,
     service
 ];
-const getCiEnvironment = ({ env = process.env } = {})=>{
+async function getCiEnvironment({ env = process.env } = {}) {
     const ctx = {
         env
     };
@@ -281,7 +345,7 @@ const getCiEnvironment = ({ env = process.env } = {})=>{
     // Service matched
     if (service) {
         debug("Internal service matched", service.name);
-        const variables = service.config(ctx);
+        const variables = await service.config(ctx);
         const ciEnvironment = {
             name: service.name,
             ...variables
@@ -290,7 +354,7 @@ const getCiEnvironment = ({ env = process.env } = {})=>{
         return ciEnvironment;
     }
     return null;
-};
+}
 
 const mustBeApiBaseUrl = (value)=>{
     const URL_REGEX = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
@@ -412,9 +476,9 @@ const createConfig = ()=>{
         args: []
     });
 };
-const readConfig = (options = {})=>{
+async function readConfig(options = {}) {
     const config = createConfig();
-    const ciEnv = getCiEnvironment();
+    const ciEnv = await getCiEnvironment();
     config.load({
         apiBaseUrl: options.apiBaseUrl ?? config.get("apiBaseUrl"),
         commit: options.commit ?? config.get("commit") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.commit) ?? null,
@@ -436,7 +500,7 @@ const readConfig = (options = {})=>{
     });
     config.validate();
     return config.get();
-};
+}
 
 const discoverScreenshots = async (patterns, { root = process.cwd(), ignore } = {})=>{
     const matches = await glob(patterns, {
@@ -581,15 +645,14 @@ const upload$1 = async (input)=>{
 /**
  * Size of the chunks used to upload screenshots to Argos.
  */ const CHUNK_SIZE = 10;
-const getConfigFromOptions = ({ parallel, ...options })=>{
-    const config = readConfig({
+async function getConfigFromOptions({ parallel, ...options }) {
+    return readConfig({
         ...options,
         parallel: Boolean(parallel),
         parallelNonce: parallel ? parallel.nonce : null,
         parallelTotal: parallel ? parallel.total : null
     });
-    return config;
-};
+}
 async function uploadFilesToS3(files) {
     debug(`Split files in chunks of ${CHUNK_SIZE}`);
     const chunks = chunk(files, CHUNK_SIZE);
@@ -611,11 +674,11 @@ async function uploadFilesToS3(files) {
 }
 /**
  * Upload screenshots to argos-ci.com.
- */ const upload = async (params)=>{
+ */ async function upload(params) {
     var _result_pwTraces;
     debug("Starting upload with params", params);
     // Read config
-    const config = getConfigFromOptions(params);
+    const config = await getConfigFromOptions(params);
     const files = params.files ?? [
         "**/*.{png,jpg,jpeg}"
     ];
@@ -728,6 +791,6 @@ async function uploadFilesToS3(files) {
         build: result.build,
         screenshots
     };
-};
+}
 
 export { readConfig, upload };

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": "1.4.1",
+  "version": "1.5.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -59,5 +59,5 @@
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "b601673bab3248f9a615ded0cca76af78830eeec"
+  "gitHead": "140f6598e42c90fcaa929fd213fadea15b0f5f3d"
 }