@argos-ci/core 2.2.1-alpha.7 → 2.4.0

package/dist/index.d.ts

@@ -32,6 +32,12 @@ interface UploadParameters {
     referenceBranch?: string;
     /** Commit used as baseline for screenshot comparison */
     referenceCommit?: string;
+    /**
+     * Sensitivity threshold between 0 and 1.
+     * The higher the threshold, the less sensitive the diff will be.
+     * @default 0.5
+     */
+    threshold?: number;
 }
 /**
  * Upload screenshots to argos-ci.com.
@@ -45,6 +51,8 @@ declare function upload(params: UploadParameters): Promise<{
         hash: string;
         optimizedPath: string;
         metadata: import("@argos-ci/util").ScreenshotMetadata | null;
+        threshold: number | null;
+        baseName: string | null;
         pwTrace: {
             path: string;
             hash: string;
@@ -74,6 +82,7 @@ interface Config {
     prHeadCommit: string | null;
     mode: "ci" | "monitoring" | null;
     ciProvider: string | null;
+    threshold: number | null;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;
 export { UploadParameters, upload, Config, readConfig };

package/dist/index.mjs

@@ -408,6 +408,17 @@ const mustBeArgosToken = (value)=>{
         throw new Error("Invalid Argos repository token (must be 40 characters)");
     }
 };
+convict.addFormat({
+    name: "float-percent",
+    validate: function(val) {
+        if (val !== 0 && (!val || val > 1 || val < 0)) {
+            throw new Error("Must be a float between 0 and 1, inclusive.");
+        }
+    },
+    coerce: function(val) {
+        return parseFloat(val);
+    }
+});
 const schema = {
     apiBaseUrl: {
         env: "ARGOS_API_BASE_URL",
@@ -491,11 +502,6 @@ const schema = {
         default: null,
         nullable: true
     },
-    ciService: {
-        format: String,
-        default: null,
-        nullable: true
-    },
     jobId: {
         format: String,
         default: null,
@@ -507,7 +513,7 @@ const schema = {
         nullable: true
     },
     runAttempt: {
-        format: String,
+        format: "nat",
         default: null,
         nullable: true
     },
@@ -525,6 +531,12 @@ const schema = {
         format: String,
         default: null,
         nullable: true
+    },
+    threshold: {
+        env: "ARGOS_THRESHOLD",
+        format: "float-percent",
+        default: null,
+        nullable: true
     }
 };
 const createConfig = ()=>{
@@ -545,7 +557,6 @@ async function readConfig(options = {}) {
         prHeadCommit: config.get("prHeadCommit") || ciEnv?.prHeadCommit || null,
         referenceBranch: options.referenceBranch || config.get("referenceBranch") || null,
         referenceCommit: options.referenceCommit || config.get("referenceCommit") || null,
-        ciService: ciEnv?.name || null,
         owner: ciEnv?.owner || null,
         repository: ciEnv?.repository || null,
         jobId: ciEnv?.jobId || null,
@@ -611,13 +622,13 @@ const hashFile = async (filepath)=>{
 };
 
 const base64Encode = (obj)=>Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
-const getBearerToken = ({ token, ciService, owner, repository, jobId, runId, prNumber })=>{
+function getBearerToken({ token, ciProvider, owner, repository, jobId, runId, prNumber }) {
     if (token) return `Bearer ${token}`;
-    switch(ciService){
-        case "GitHub Actions":
+    switch(ciProvider){
+        case "github-actions":
             {
                 if (!owner || !repository || !jobId || !runId) {
-                    throw new Error(`Automatic ${ciService} variables detection failed. Please add the 'ARGOS_TOKEN'`);
+                    throw new Error(`Automatic GitHub Actions variables detection failed. Please add the 'ARGOS_TOKEN'`);
                 }
                 return `Bearer tokenless-github-${base64Encode({
                     owner,
@@ -630,7 +641,7 @@ const getBearerToken = ({ token, ciService, owner, repository, jobId, runId, prN
         default:
             throw new Error("Missing Argos repository token 'ARGOS_TOKEN'");
     }
-};
+}
 const createArgosApiClient = (options)=>{
     const axiosInstance = axios.create({
         baseURL: options.baseUrl,
@@ -781,11 +792,18 @@ async function uploadFilesToS3(files) {
             hashFile(optimizedPath),
             pwTracePath ? hashFile(pwTracePath) : null
         ]);
+        const threshold = metadata?.transient?.threshold ?? null;
+        const baseName = metadata?.transient?.baseName ?? null;
+        if (metadata) {
+            delete metadata.transient;
+        }
         return {
             ...screenshot,
             hash,
             optimizedPath,
             metadata,
+            threshold,
+            baseName,
             pwTrace: pwTracePath && pwTraceHash ? {
                 path: pwTracePath,
                 hash: pwTraceHash
@@ -861,7 +879,9 @@ async function uploadFilesToS3(files) {
                 key: screenshot.hash,
                 name: screenshot.name,
                 metadata: screenshot.metadata,
-                pwTraceKey: screenshot.pwTrace?.hash ?? null
+                pwTraceKey: screenshot.pwTrace?.hash ?? null,
+                threshold: screenshot.threshold ?? config?.threshold ?? null,
+                baseName: screenshot.baseName
             })),
         parallel: config.parallel,
         parallelTotal: config.parallelTotal,

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": "2.2.1-alpha.7+d1a818a",
+  "version": "2.4.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/util": "2.0.0",
+    "@argos-ci/util": "2.1.0",
     "axios": "^1.6.8",
     "convict": "^6.2.4",
     "debug": "^4.3.4",
@@ -59,5 +59,5 @@
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "d1a818aeee5bcba93c0492be43704f8c3682222e"
+  "gitHead": "aca82cf842a6d8310611a8594c581794df85cbd8"
 }