@argos-ci/core 0.6.1 → 0.6.3-alpha.1

package/README.md

@@ -16,5 +16,5 @@ Argos Core JavaScript SDK contains interface definitions, base classes and utili
 
 ## Links
 
-- [Official SDK Docs](https://docs.argos-ci.com)
+- [Official SDK Docs](https://argos-ci.com/docs)
 - [API Reference](https://js-sdk-reference.argos-ci.com)

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import * as sharp from 'sharp';
-
 interface UploadParameters {
     /** Globs matching image file paths to upload */
     files?: string[];
@@ -15,6 +13,8 @@ interface UploadParameters {
     branch?: string;
     /** Argos repository token */
     token?: string;
+    /** Pull-request number */
+    prNumber?: number;
     /** Name of the build used to trigger multiple Argos builds on one commit */
     buildName?: string;
     /** Parallel test suite mode */
@@ -35,8 +35,7 @@ declare const upload: (params: UploadParameters) => Promise<{
     };
     screenshots: {
         optimizedPath: string;
-        format: keyof sharp.FormatEnum;
-        hash: any;
+        hash: string;
         name: string;
         path: string;
     }[];

package/dist/index.mjs

@@ -93,6 +93,11 @@ const schema = {
         default: null,
         nullable: true
     },
+    prNumber: {
+        format: String,
+        default: null,
+        nullable: true
+    },
     owner: {
         format: String,
         default: null,
@@ -122,7 +127,7 @@ const createConfig = ()=>{
     return result;
 };
 
-const service$1 = {
+const service$3 = {
     detect: ({ env  })=>Boolean(env.HEROKU_TEST_RUN_ID),
     config: ({ env  })=>({
             name: "Heroku",
@@ -131,7 +136,8 @@ const service$1 = {
             owner: null,
             repository: null,
             jobId: env.HEROKU_TEST_RUN_ID || null,
-            runId: null
+            runId: null,
+            prNumber: null
         })
 };
 
@@ -183,7 +189,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",
@@ -198,24 +212,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;
@@ -225,6 +283,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,
@@ -232,9 +291,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, {
@@ -249,33 +320,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;
 };
 
@@ -288,11 +340,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":
@@ -304,7 +356,8 @@ const getBearerToken = ({ token , ciService , owner , repository , jobId , runId
                     owner,
                     repository,
                     jobId,
-                    runId
+                    runId,
+                    prNumber
                 })}`;
             }
         default:
@@ -349,17 +402,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({
@@ -367,7 +409,7 @@ const upload$1 = async (input)=>{
         url: input.url,
         data: file,
         headers: {
-            "Content-Type": formatToContentType(input.format)
+            "Content-Type": "image/png"
         }
     });
 };
@@ -375,13 +417,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,
@@ -397,7 +440,8 @@ const getConfigFromOptions = (options)=>{
                 owner: ciEnv.owner,
                 repository: ciEnv.repository,
                 jobId: ciEnv.jobId,
-                runId: ciEnv.runId
+                runId: ciEnv.runId,
+                prNumber: ciEnv.prNumber
             }));
         }
     }
@@ -423,13 +467,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
         };
     }));
@@ -453,8 +495,7 @@ const getConfigFromOptions = (options)=>{
         }
         await upload$1({
             url: putUrl,
-            path: screenshot.optimizedPath,
-            format: screenshot.format
+            path: screenshot.optimizedPath
         });
     }));
     // Update build

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.6.1",
+  "version": "0.6.3-alpha.1+46d7443",
   "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": "653c9799ae22607b6bc8442c94ceb98ae1eaf0d5"
+  "gitHead": "46d7443fe360fe5d42482e404bd3ab5c05116567"
 }