@argos-ci/cli 0.4.0 → 0.4.2

package/dist/index.mjs

@@ -3,8 +3,10 @@ import { fileURLToPath } from 'node:url';
 import { resolve } from 'node:path';
 import { program } from 'commander';
 import convict from 'convict';
+import { execSync } from 'node:child_process';
+import { execSync as execSync$1 } from 'child_process';
+import createDebug from 'debug';
 import envCi from 'env-ci';
-import { execSync } from 'child_process';
 import glob from 'fast-glob';
 import { promisify } from 'node:util';
 import sharp from 'sharp';
@@ -12,7 +14,6 @@ import tmp from 'tmp';
 import { createReadStream } from 'node:fs';
 import { createHash } from 'node:crypto';
 import axios from 'axios';
-import createDebug from 'debug';
 import ora from 'ora';
 
 const mustBeApiBaseUrl = (value)=>{
@@ -44,14 +45,13 @@ const schema = {
     },
     commit: {
         env: "ARGOS_COMMIT",
-        default: "",
+        default: null,
         format: mustBeCommit
     },
     branch: {
         env: "ARGOS_BRANCH",
         default: null,
-        format: String,
-        nullable: true
+        format: String
     },
     token: {
         env: "ARGOS_TOKEN",
@@ -64,6 +64,12 @@ const schema = {
         format: String,
         nullable: true
     },
+    prNumber: {
+        env: "ARGOS_PR_NUMBER",
+        format: Number,
+        default: null,
+        nullable: true
+    },
     parallel: {
         env: "ARGOS_PARALLEL",
         default: false,
@@ -96,11 +102,6 @@ const schema = {
         default: null,
         nullable: true
     },
-    prNumber: {
-        format: Number,
-        default: null,
-        nullable: true
-    },
     owner: {
         format: String,
         default: null,
@@ -119,45 +120,54 @@ const createConfig = ()=>{
 };
 
 /**
- * Omit undefined properties from an object.
- */ const omitUndefined = (obj)=>{
-    const result = {};
-    Object.keys(obj).forEach((key)=>{
-        if (obj[key] !== undefined) {
-            result[key] = obj[key];
+ * Returns the head commit.
+ */ const head = ()=>{
+    try {
+        return execSync("git rev-parse HEAD").toString().trim();
+    } catch  {
+        return null;
+    }
+};
+/**
+ * Returns the current branch.
+ */ const branch = ()=>{
+    try {
+        const headRef = execSync("git rev-parse --abbrev-ref HEAD").toString().trim();
+        if (headRef === "HEAD") {
+            return null;
         }
-    });
-    return result;
+        return headRef;
+    } catch  {
+        return null;
+    }
 };
 
 const service$4 = {
+    name: "Buildkite",
     detect: ({ env  })=>Boolean(env.BUILDKITE),
     config: ({ env  })=>{
-        const ciProps = envCiDetection({
-            env
-        });
         return {
-            name: "Buildkite",
-            commit: ciProps?.commit || null,
-            branch: env.BUILDKITE_BRANCH || null,
+            // Buildkite doesn't work well so we fallback to git to ensure we have commit and branch
+            commit: env.BUILDKITE_COMMIT || head() || null,
+            branch: env.BUILDKITE_BRANCH || branch() || null,
             owner: env.BUILDKITE_ORGANIZATION_SLUG || null,
             repository: env.BUILDKITE_PROJECT_SLUG || null,
-            jobId: env.BUILDKITE_JOB_ID || null,
-            runId: ciProps?.runId || null,
+            jobId: null,
+            runId: null,
             prNumber: env.BUILDKITE_PULL_REQUEST ? Number(env.BUILDKITE_PULL_REQUEST) : null
         };
     }
 };
 
 const service$3 = {
+    name: "Heroku",
     detect: ({ env  })=>Boolean(env.HEROKU_TEST_RUN_ID),
     config: ({ env  })=>({
-            name: "Heroku",
             commit: env.HEROKU_TEST_RUN_COMMIT_VERSION || null,
             branch: env.HEROKU_TEST_RUN_BRANCH || null,
             owner: null,
             repository: null,
-            jobId: env.HEROKU_TEST_RUN_ID || null,
+            jobId: null,
             runId: null,
             prNumber: null
         })
@@ -167,7 +177,7 @@ 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("git show --no-patch --format=%P").toString().trim();
+        const mergeCommitMessage = execSync$1("git show --no-patch --format=%P").toString().trim();
         // console.log(
         //   `Handling PR with parent hash(es) '${mergeCommitMessage}' of current commit.`
         // );
@@ -196,22 +206,22 @@ Please run "actions/checkout" with "fetch-depth: 2". Example:
     }
     return process.env.GITHUB_SHA ?? null;
 };
-function getBranch({ env  }) {
+const getBranch = ({ env  })=>{
     if (env.GITHUB_HEAD_REF) {
         return env.GITHUB_HEAD_REF;
     }
     const branchRegex = /refs\/heads\/(.*)/;
-    const branchMatches = branchRegex.exec(env.GITHUB_REF || "");
-    if (branchMatches) {
-        return branchMatches[1];
+    const matches = branchRegex.exec(env.GITHUB_REF || "");
+    if (matches) {
+        return matches[1];
     }
     return null;
-}
-function getRepository({ env  }) {
+};
+const getRepository$1 = ({ env  })=>{
     if (!env.GITHUB_REPOSITORY) return null;
     return env.GITHUB_REPOSITORY.split("/")[1];
-}
-const getPrNumber$1 = ({ env  })=>{
+};
+const getPrNumber$2 = ({ env  })=>{
     const branchRegex = /refs\/pull\/(\d+)/;
     const branchMatches = branchRegex.exec(env.GITHUB_REF || "");
     if (branchMatches) {
@@ -220,9 +230,9 @@ const getPrNumber$1 = ({ env  })=>{
     return null;
 };
 const service$2 = {
+    name: "GitHub Actions",
     detect: ({ env  })=>Boolean(env.GITHUB_ACTIONS),
     config: ({ env  })=>({
-            name: "GitHub Actions",
             commit: getSha({
                 env
             }),
@@ -230,73 +240,75 @@ const service$2 = {
                 env
             }),
             owner: env.GITHUB_REPOSITORY_OWNER || null,
-            repository: getRepository({
+            repository: getRepository$1({
                 env
             }),
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || null,
-            prNumber: getPrNumber$1({
+            prNumber: getPrNumber$2({
                 env
             })
         })
 };
 
-const getPrNumber = ({ env  })=>{
+const getPrNumber$1 = ({ env  })=>{
     const branchRegex = /pull\/(\d+)/;
-    const branchMatches = branchRegex.exec(env.CIRCLE_PULL_REQUEST || "");
-    if (branchMatches) {
-        return Number(branchMatches[1]);
+    const matches = branchRegex.exec(env.CIRCLE_PULL_REQUEST || "");
+    if (matches) {
+        return Number(matches[1]);
     }
     return null;
 };
 const service$1 = {
+    name: "CircleCI",
     detect: ({ env  })=>Boolean(env.CIRCLECI),
     config: ({ env  })=>{
-        const ciProps = envCiDetection({
-            env
-        });
         return {
-            name: "CircleCI",
-            commit: ciProps?.commit || null,
-            branch: ciProps?.branch || null,
-            owner: ciProps?.owner || null,
-            repository: ciProps?.repository || null,
-            jobId: ciProps?.jobId || null,
-            runId: ciProps?.runId || null,
-            prNumber: getPrNumber({
+            commit: env.CIRCLE_SHA1 || null,
+            branch: env.CIRCLE_BRANCH || null,
+            owner: env.CIRCLE_PROJECT_USERNAME || null,
+            repository: env.CIRCLE_PROJECT_REPONAME || null,
+            jobId: null,
+            runId: null,
+            prNumber: getPrNumber$1({
                 env
             })
         };
     }
 };
 
+const getOwner = ({ env  })=>{
+    if (!env.TRAVIS_REPO_SLUG) return null;
+    return env.TRAVIS_REPO_SLUG.split("/")[0] || null;
+};
+const getRepository = ({ env  })=>{
+    if (!env.TRAVIS_REPO_SLUG) return null;
+    return env.TRAVIS_REPO_SLUG.split("/")[1] || null;
+};
+const getPrNumber = ({ env  })=>{
+    if (env.TRAVIS_PULL_REQUEST) return Number(env.TRAVIS_PULL_REQUEST);
+    return null;
+};
 const service = {
+    name: "Travis CI",
     detect: ({ env  })=>Boolean(env.TRAVIS),
-    config: ({ env  })=>{
-        const ciProps = envCiDetection({
-            env
-        });
+    config: (ctx)=>{
+        const { env  } = ctx;
         return {
-            name: "Travis CI",
-            commit: ciProps?.commit || null,
-            branch: ciProps?.branch || null,
-            owner: ciProps?.owner || null,
-            repository: ciProps?.repository || null,
-            jobId: ciProps?.jobId || null,
-            runId: ciProps?.runId || null,
-            prNumber: env.TRAVIS_PULL_REQUEST ? Number(env.TRAVIS_PULL_REQUEST) : null
+            commit: env.TRAVIS_COMMIT || null,
+            branch: env.TRAVIS_BRANCH || null,
+            owner: getOwner(ctx),
+            repository: getRepository(ctx),
+            jobId: null,
+            runId: null,
+            prNumber: getPrNumber(ctx)
         };
     }
 };
 
-const services = [
-    service$3,
-    service$2,
-    service$1,
-    service,
-    service$4
-];
-const envCiDetection = (ctx)=>{
+const debug = createDebug("@argos-ci/core");
+
+const getCiEnvironmentFromEnvCi = (ctx)=>{
     const ciContext = envCi(ctx);
     const name = ciContext.isCi ? ciContext.name ?? null : ciContext.commit ? "Git" : null;
     const commit = ciContext.commit ?? null;
@@ -318,16 +330,38 @@ const envCiDetection = (ctx)=>{
         prNumber
     } : null;
 };
+
+const services = [
+    service$3,
+    service$2,
+    service$1,
+    service,
+    service$4
+];
 const getCiEnvironment = ({ env =process.env  } = {})=>{
     const ctx = {
         env
     };
+    debug("Detecting CI environment", {
+        env
+    });
     const service = services.find((service)=>service.detect(ctx));
-    // Internal service matched
+    // Service matched
     if (service) {
-        return service.config(ctx);
+        debug("Internal service matched", service.name);
+        const variables = service.config(ctx);
+        const ciEnvironment = {
+            name: service.name,
+            ...variables
+        };
+        debug("CI environment", ciEnvironment);
+        return ciEnvironment;
     }
-    return envCiDetection(ctx);
+    // We fallback on "env-ci" library, not very good but it's better than nothing
+    debug("Falling back on env-ci");
+    const ciEnvironment1 = getCiEnvironmentFromEnvCi(ctx);
+    debug("CI environment", ciEnvironment1);
+    return ciEnvironment1;
 };
 
 const discoverScreenshots = async (patterns, { root =process.cwd() , ignore  } = {})=>{
@@ -398,11 +432,20 @@ const createArgosApiClient = (options)=>{
     });
     const call = async (method, path, data)=>{
         try {
+            debug("Sending request", {
+                method,
+                path,
+                data
+            });
             const response = await axiosInstance.request({
                 method,
                 url: path,
                 data
             });
+            debug("Getting response", {
+                status: response.status,
+                data: response.data
+            });
             return response.data;
         } catch (error) {
             if (error?.response?.data?.error?.message) {
@@ -437,45 +480,42 @@ const upload$1 = async (input)=>{
     });
 };
 
-const debug = createDebug("@argos-ci/core");
-
 const getConfigFromOptions = (options)=>{
     const config = createConfig();
     const ciEnv = getCiEnvironment();
-    if (ciEnv) {
-        config.load(omitUndefined({
-            commit: ciEnv.commit,
-            branch: ciEnv.branch,
-            ciService: ciEnv.name,
-            owner: ciEnv.owner,
-            repository: ciEnv.repository,
-            jobId: ciEnv.jobId,
-            runId: ciEnv.runId,
-            prNumber: ciEnv.prNumber
-        }));
+    config.load({
+        apiBaseUrl: config.get("apiBaseUrl") ?? options.apiBaseUrl,
+        commit: config.get("commit") ?? options.commit ?? ciEnv?.commit ?? null,
+        branch: config.get("branch") ?? options.branch ?? ciEnv?.branch ?? null,
+        token: config.get("token") ?? options.token ?? null,
+        buildName: config.get("buildName") ?? options.buildName ?? null,
+        prNumber: config.get("prNumber") ?? options.prNumber ?? ciEnv?.prNumber ?? null,
+        ciService: ciEnv?.name ?? null,
+        owner: ciEnv?.owner ?? null,
+        repository: ciEnv?.repository ?? null,
+        jobId: ciEnv?.jobId ?? null,
+        runId: ciEnv?.runId ?? null
+    });
+    if (options.parallel) {
+        config.load({
+            parallel: Boolean(options.parallel),
+            parallelNonce: options.parallel ? options.parallel.nonce : null,
+            parallelTotal: options.parallel ? options.parallel.total : null
+        });
     }
-    config.load(omitUndefined({
-        apiBaseUrl: options.apiBaseUrl,
-        commit: options.commit,
-        branch: options.branch,
-        token: options.token,
-        prNumber: options.prNumber,
-        buildName: options.buildName,
-        parallel: Boolean(options.parallel),
-        parallelNonce: options.parallel ? options.parallel.nonce : null,
-        parallelTotal: options.parallel ? options.parallel.total : null
-    }));
     config.validate();
     return config.get();
 };
 /**
  * Upload screenshots to argos-ci.com.
  */ const upload = async (params)=>{
+    debug("Starting upload with params", params);
     // Read config
     const config = getConfigFromOptions(params);
     const files = params.files ?? [
         "**/*.{png,jpg,jpeg}"
     ];
+    debug("Using config and files", config, files);
     const apiClient = createArgosApiClient({
         baseUrl: config.apiBaseUrl,
         bearerToken: getBearerToken(config)
@@ -485,6 +525,7 @@ const getConfigFromOptions = (options)=>{
         root: params.root,
         ignore: params.ignore
     });
+    debug("Found screenshots", foundScreenshots);
     // Optimize & compute hashes
     const screenshots = await Promise.all(foundScreenshots.map(async (screenshot)=>{
         const optimizedPath = await optimizeScreenshot(screenshot.path);
@@ -540,7 +581,7 @@ const __dirname = fileURLToPath(new URL(".", import.meta.url));
 const rawPkg = await readFile(resolve(__dirname, "..", "package.json"), "utf8");
 const pkg = JSON.parse(rawPkg);
 program.name(pkg.name).description("Interact with and upload screenshots to argos-ci.com via command line.").version(pkg.version);
-program.command("upload").argument("<directory>", "Directory to upload").description("Upload screenshots to argos-ci.com").option("-f, --files <patterns...>", "One or more globs matching image file paths to upload", "**/*.{png,jpg,jpeg}").option("-i, --ignore <patterns...>", 'One or more globs matching image file paths to ignore (ex: "**/*.png **/diff.jpg")').option("--token <token>", "Repository token").option("--pull-request <number>", "Pull-request number").option("--build-name <string>", "Name of the build, in case you want to run multiple Argos builds in a single CI job").option("--parallel", "Enable parallel mode. Run multiple Argos builds and combine them at the end").option("--parallel-total <number>", "The number of parallel nodes being ran").option("--parallel-nonce <string>", "A unique ID for this parallel build").action(async (directory, options)=>{
+program.command("upload").argument("<directory>", "Directory to upload").description("Upload screenshots to argos-ci.com").option("-f, --files <patterns...>", "One or more globs matching image file paths to upload", "**/*.{png,jpg,jpeg}").option("-i, --ignore <patterns...>", 'One or more globs matching image file paths to ignore (ex: "**/*.png **/diff.jpg")').option("--token <token>", "Repository token").option("--build-name <string>", "Name of the build, in case you want to run multiple Argos builds in a single CI job").option("--parallel", "Enable parallel mode. Run multiple Argos builds and combine them at the end").option("--parallel-total <number>", "The number of parallel nodes being ran").option("--parallel-nonce <string>", "A unique ID for this parallel build").action(async (directory, options)=>{
     const spinner = ora("Uploading screenshots").start();
     try {
         const result = await upload({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cli",
   "description": "Visual testing solution to avoid visual regression. Argos CLI is used to interact with and upload screenshots to argos-ci.com via command line.",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "bin": {
     "argos": "./bin/argos-cli.js"
   },
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/core": "^0.7.0",
+    "@argos-ci/core": "^0.7.2",
     "commander": "^9.4.1",
     "ora": "^6.1.2",
     "update-notifier": "^6.0.2"
@@ -49,5 +49,5 @@
     "rollup": "^2.79.1",
     "rollup-plugin-swc3": "^0.6.0"
   },
-  "gitHead": "a7603beaf95ec4be8be9405450a445bfe94a6a12"
+  "gitHead": "7adf2cb62ceb13887c7ddf675f4d19e2bd2572b9"
 }