@argos-ci/cli 0.4.0 → 0.4.1

package/dist/index.mjs

@@ -5,6 +5,7 @@ import { program } from 'commander';
 import convict from 'convict';
 import envCi from 'env-ci';
 import { execSync } from 'child_process';
+import createDebug from 'debug';
 import glob from 'fast-glob';
 import { promisify } from 'node:util';
 import sharp from 'sharp';
@@ -12,7 +13,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 +44,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 +63,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 +101,6 @@ const schema = {
         default: null,
         nullable: true
     },
-    prNumber: {
-        format: Number,
-        default: null,
-        nullable: true
-    },
     owner: {
         format: String,
         default: null,
@@ -118,26 +118,14 @@ 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];
-        }
-    });
-    return result;
-};
-
 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,
             owner: env.BUILDKITE_ORGANIZATION_SLUG || null,
@@ -150,9 +138,9 @@ const service$4 = {
 };
 
 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,
@@ -220,9 +208,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
             }),
@@ -250,13 +238,13 @@ const getPrNumber = ({ env  })=>{
     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,
@@ -271,13 +259,13 @@ const service$1 = {
 };
 
 const service = {
+    name: "Travis CI",
     detect: ({ env  })=>Boolean(env.TRAVIS),
     config: ({ env  })=>{
         const ciProps = envCiDetection({
             env
         });
         return {
-            name: "Travis CI",
             commit: ciProps?.commit || null,
             branch: ciProps?.branch || null,
             owner: ciProps?.owner || null,
@@ -289,6 +277,8 @@ const service = {
     }
 };
 
+const debug = createDebug("@argos-ci/core");
+
 const services = [
     service$3,
     service$2,
@@ -322,12 +312,25 @@ const getCiEnvironment = ({ env =process.env  } = {})=>{
     const ctx = {
         env
     };
+    debug("Detecting CI environment", {
+        env
+    });
     const service = services.find((service)=>service.detect(ctx));
     // Internal 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);
+    debug("Falling back on env-ci");
+    const ciEnvironment1 = envCiDetection(ctx);
+    debug("CI environment", ciEnvironment1);
+    return ciEnvironment1;
 };
 
 const discoverScreenshots = async (patterns, { root =process.cwd() , ignore  } = {})=>{
@@ -398,11 +401,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 +449,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 +494,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 +550,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.1",
   "bin": {
     "argos": "./bin/argos-cli.js"
   },
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/core": "^0.7.0",
+    "@argos-ci/core": "^0.7.1",
     "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": "0ae6b18c7728deb14beb7ffee85e9faf104c4365"
 }