@argos-ci/cli 0.3.1 → 0.3.3-alpha.1

package/README.md

@@ -16,4 +16,4 @@ Argos CLI is used to interact with and upload screenshots to [argos-ci.com](http
 
 ## Links
 
-- [Official CLI Docs](https://docs.argos-ci.com)
+- [Official CLI Docs](https://argos-ci.com/docs)

package/dist/index.mjs

@@ -96,6 +96,11 @@ const schema = {
         default: null,
         nullable: true
     },
+    prNumber: {
+        format: String,
+        default: null,
+        nullable: true
+    },
     owner: {
         format: String,
         default: null,
@@ -125,7 +130,7 @@ const createConfig = ()=>{
     return result;
 };
 
-const service$1 = {
+const service$3 = {
     detect: ({ env  })=>Boolean(env.HEROKU_TEST_RUN_ID),
     config: ({ env  })=>({
             name: "Heroku",
@@ -134,7 +139,8 @@ const service$1 = {
             owner: null,
             repository: null,
             jobId: env.HEROKU_TEST_RUN_ID || null,
-            runId: null
+            runId: null,
+            prNumber: null
         })
 };
 
@@ -186,7 +192,15 @@ function getRepository({ env  }) {
     if (!env.GITHUB_REPOSITORY) return null;
     return env.GITHUB_REPOSITORY.split("/")[1];
 }
-const service = {
+const getPrNumber$1 = ({ env  })=>{
+    const branchRegex = /refs\/pull\/(\d+)/;
+    const branchMatches = branchRegex.exec(env.GITHUB_REF || "");
+    if (branchMatches) {
+        branchMatches[1];
+    }
+    return null;
+};
+const service$2 = {
     detect: ({ env  })=>Boolean(env.GITHUB_ACTIONS),
     config: ({ env  })=>({
             name: "GitHub Actions",
@@ -201,24 +215,68 @@ const service = {
                 env
             }),
             jobId: env.GITHUB_JOB || null,
-            runId: env.GITHUB_RUN_ID || null
+            runId: env.GITHUB_RUN_ID || null,
+            prNumber: getPrNumber$1({
+                env
+            })
         })
 };
 
+const getPrNumber = ({ env  })=>{
+    const branchRegex = /pull\/(\d+)/;
+    const branchMatches = branchRegex.exec(env.CIRCLE_PULL_REQUEST || "");
+    if (branchMatches) {
+        branchMatches[1];
+    }
+    return null;
+};
+const service$1 = {
+    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({
+                env
+            })
+        };
+    }
+};
+
+const service = {
+    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,
+            repository: ciProps?.repository || null,
+            jobId: ciProps?.jobId || null,
+            runId: ciProps?.runId || null,
+            prNumber: env.TRAVIS_PULL_REQUEST || null
+        };
+    }
+};
+
 const services = [
+    service$3,
+    service$2,
     service$1,
     service
 ];
-const getCiEnvironment = ({ env =process.env  } = {})=>{
-    const ctx = {
-        env
-    };
-    const service = services.find((service)=>service.detect(ctx));
-    // Internal service matched
-    if (service) {
-        return service.config(ctx);
-    }
-    // Fallback on env-ci detection
+const envCiDetection = (ctx)=>{
     const ciContext = envCi(ctx);
     const name = ciContext.isCi ? ciContext.name ?? null : ciContext.commit ? "Git" : null;
     const commit = ciContext.commit ?? null;
@@ -228,6 +286,7 @@ const getCiEnvironment = ({ env =process.env  } = {})=>{
     const repository = slug ? slug[1] : null;
     const jobId = ciContext.job ?? null;
     const runId = null;
+    const prNumber = null;
     return commit ? {
         name,
         commit,
@@ -235,9 +294,21 @@ const getCiEnvironment = ({ env =process.env  } = {})=>{
         owner,
         repository,
         jobId,
-        runId
+        runId,
+        prNumber
     } : null;
 };
+const getCiEnvironment = ({ env =process.env  } = {})=>{
+    const ctx = {
+        env
+    };
+    const service = services.find((service)=>service.detect(ctx));
+    // Internal service matched
+    if (service) {
+        return service.config(ctx);
+    }
+    return envCiDetection(ctx);
+};
 
 const discoverScreenshots = async (patterns, { root =process.cwd() , ignore  } = {})=>{
     const matches = await glob(patterns, {
@@ -252,33 +323,14 @@ const discoverScreenshots = async (patterns, { root =process.cwd() , ignore  } =
 };
 
 const tmpFile = promisify(tmp.file);
-const getImageFormat = async (filepath)=>{
-    const metadata = await sharp(filepath).metadata();
-    if (!metadata.format) {
-        throw new Error(`Could not get image format for ${filepath}`);
-    }
-    return metadata.format;
-};
-const optimizeScreenshot = async (filepath, format)=>{
+const optimizeScreenshot = async (filepath)=>{
     const resultFilePath = await tmpFile();
-    const optimization = sharp(filepath).resize(2048, 20480, {
+    await sharp(filepath).resize(2048, 20480, {
         fit: "inside",
         withoutEnlargement: true
-    });
-    switch(format){
-        case "jpeg":
-        case "jpg":
-            {
-                optimization.jpeg();
-                break;
-            }
-        case "png":
-            {
-                optimization.png();
-                break;
-            }
-    }
-    await optimization.toFile(resultFilePath);
+    }).png({
+        force: true
+    }).toFile(resultFilePath);
     return resultFilePath;
 };
 
@@ -291,11 +343,11 @@ const hashFile = async (filepath)=>{
         hash.on("finish", resolve);
         fileStream.pipe(hash);
     });
-    return hash.read().toString("hex");
+    return hash.digest("hex");
 };
 
 const base64Encode = (obj)=>Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
-const getBearerToken = ({ token , ciService , owner , repository , jobId , runId  })=>{
+const getBearerToken = ({ token , ciService , owner , repository , jobId , runId , prNumber  })=>{
     if (token) return `Bearer ${token}`;
     switch(ciService){
         case "GitHub Actions":
@@ -307,7 +359,8 @@ const getBearerToken = ({ token , ciService , owner , repository , jobId , runId
                     owner,
                     repository,
                     jobId,
-                    runId
+                    runId,
+                    prNumber
                 })}`;
             }
         default:
@@ -352,17 +405,6 @@ const createArgosApiClient = (options)=>{
     };
 };
 
-const formatToContentType = (format)=>{
-    switch(format){
-        case "jpeg":
-        case "jpg":
-            return "image/jpeg";
-        case "png":
-            return "image/png";
-        default:
-            throw new Error(`Unsupported format ${format}`);
-    }
-};
 const upload$1 = async (input)=>{
     const file = await readFile(input.path);
     await axios({
@@ -370,7 +412,7 @@ const upload$1 = async (input)=>{
         url: input.url,
         data: file,
         headers: {
-            "Content-Type": formatToContentType(input.format)
+            "Content-Type": "image/png"
         }
     });
 };
@@ -378,13 +420,14 @@ const upload$1 = async (input)=>{
 const debug = createDebug("@argos-ci/core");
 
 const getConfigFromOptions = (options)=>{
-    const { apiBaseUrl , commit , branch , token , buildName , parallel  } = options;
+    const { apiBaseUrl , commit , branch , token , buildName , parallel , prNumber  } = options;
     const config = createConfig();
     config.load(omitUndefined({
         apiBaseUrl,
         commit,
         branch,
         token,
+        prNumber,
         buildName,
         parallel: Boolean(parallel),
         parallelNonce: parallel ? parallel.nonce : null,
@@ -400,7 +443,8 @@ const getConfigFromOptions = (options)=>{
                 owner: ciEnv.owner,
                 repository: ciEnv.repository,
                 jobId: ciEnv.jobId,
-                runId: ciEnv.runId
+                runId: ciEnv.runId,
+                prNumber: ciEnv.prNumber
             }));
         }
     }
@@ -426,13 +470,11 @@ const getConfigFromOptions = (options)=>{
     });
     // Optimize & compute hashes
     const screenshots = await Promise.all(foundScreenshots.map(async (screenshot)=>{
-        const format = await getImageFormat(screenshot.path);
-        const optimizedPath = await optimizeScreenshot(screenshot.path, format);
+        const optimizedPath = await optimizeScreenshot(screenshot.path);
         const hash = await hashFile(optimizedPath);
         return {
             ...screenshot,
             optimizedPath,
-            format,
             hash
         };
     }));
@@ -456,8 +498,7 @@ const getConfigFromOptions = (options)=>{
         }
         await upload$1({
             url: putUrl,
-            path: screenshot.optimizedPath,
-            format: screenshot.format
+            path: screenshot.optimizedPath
         });
     }));
     // Update build
@@ -481,7 +522,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("--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("--prNumber <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)=>{
     const spinner = ora("Uploading screenshots").start();
     try {
         const result = await upload({
@@ -489,6 +530,7 @@ program.command("upload").argument("<directory>", "Directory to upload").descrip
             buildName: options.buildName,
             files: options.files,
             ignore: options.ignore,
+            prNumber: options.prNumber,
             parallel: options.parallel ? {
                 nonce: options.parallelNonce,
                 total: options.parallelTotal

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.3.1",
+  "version": "0.3.3-alpha.1+46d7443",
   "bin": {
     "argos": "./bin/argos-cli.js"
   },
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/core": "^0.6.1",
+    "@argos-ci/core": "^0.6.3-alpha.1+46d7443",
     "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": "653c9799ae22607b6bc8442c94ceb98ae1eaf0d5"
+  "gitHead": "46d7443fe360fe5d42482e404bd3ab5c05116567"
 }