@argos-ci/core 2.5.1 → 2.6.0

package/dist/index.d.ts

@@ -75,7 +75,19 @@ interface UploadParameters {
 declare function upload(params: UploadParameters): Promise<{
     build: {
         id: string;
+        number: number;
+        status: "accepted" | "rejected" | "stable" | "diffDetected" | "expired" | "pending" | "progress" | "error" | "aborted";
         url: string;
+        notification: {
+            description: string;
+            context: string;
+            github: {
+                state: "pending" | "error" | "success" | "failure";
+            };
+            gitlab: {
+                state: "pending" | "success" | "running" | "failed" | "canceled";
+            };
+        } | null;
     };
     screenshots: {
         hash: string;
@@ -91,6 +103,32 @@ declare function upload(params: UploadParameters): Promise<{
         path: string;
     }[];
 }>;
+type FinalizeParameters = {
+    parallel?: {
+        nonce: string;
+    };
+};
+/**
+ * Finalize pending builds.
+ */
+declare function finalize(params: FinalizeParameters): Promise<{
+    builds: {
+        id: string;
+        number: number;
+        status: "accepted" | "rejected" | "stable" | "diffDetected" | "expired" | "pending" | "progress" | "error" | "aborted";
+        url: string;
+        notification: {
+            description: string;
+            context: string;
+            github: {
+                state: "pending" | "error" | "success" | "failure";
+            };
+            gitlab: {
+                state: "pending" | "success" | "running" | "failed" | "canceled";
+            };
+        } | null;
+    }[];
+}>;
 interface Config {
     apiBaseUrl: string;
     commit: string;
@@ -115,4 +153,4 @@ interface Config {
     threshold: number | null;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;
-export { UploadParameters, upload, Config, readConfig };
+export { UploadParameters, upload, FinalizeParameters, finalize, Config, readConfig };

package/dist/index.mjs

@@ -536,7 +536,7 @@ const schema = {
     },
     parallelTotal: {
         env: "ARGOS_PARALLEL_TOTAL",
-        format: "nat",
+        format: "int",
         default: null,
         nullable: true
     },
@@ -614,8 +614,8 @@ async function readConfig(options = {}) {
         runAttempt: ciEnv?.runAttempt || null,
         parallel: options.parallel ?? config.get("parallel") ?? false,
         parallelNonce: options.parallelNonce || config.get("parallelNonce") || ciEnv?.nonce || null,
-        parallelTotal: options.parallelTotal || config.get("parallelTotal") || null,
-        parallelIndex: options.parallelIndex || config.get("parallelIndex") || null,
+        parallelTotal: options.parallelTotal ?? config.get("parallelTotal") ?? null,
+        parallelIndex: options.parallelIndex ?? config.get("parallelIndex") ?? null,
         mode: options.mode || config.get("mode") || null,
         ciProvider: ciEnv?.key || null
     });
@@ -672,7 +672,9 @@ const hashFile = async (filepath)=>{
 };
 
 const base64Encode = (obj)=>Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
-function getAuthToken({ token, ciProvider, owner, repository, jobId, runId, prNumber }) {
+/**
+ * Get the authentication token.
+ */ function getAuthToken({ token, ciProvider, owner, repository, jobId, runId, prNumber }) {
     if (token) {
         return token;
     }
@@ -694,52 +696,6 @@ function getAuthToken({ token, ciProvider, owner, repository, jobId, runId, prNu
             throw new Error("Missing Argos repository token 'ARGOS_TOKEN'");
     }
 }
-const createArgosLegacyAPIClient = (options)=>{
-    const axiosInstance = axios.create({
-        baseURL: options.baseUrl,
-        headers: {
-            Authorization: options.bearerToken,
-            "Content-Type": "application/json",
-            Accept: "application/json"
-        }
-    });
-    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) {
-                // @ts-ignore
-                throw new Error(error.response.data.error.message, {
-                    cause: error
-                });
-            }
-            throw error;
-        }
-    };
-    return {
-        createBuild: async (input)=>{
-            return call("POST", "/builds", input);
-        },
-        updateBuild: async (input)=>{
-            const { buildId, ...body } = input;
-            return call("PUT", `/builds/${buildId}`, body);
-        }
-    };
-};
 
 const upload$1 = async (input)=>{
     const file = await readFile(input.path);
@@ -828,10 +784,6 @@ async function uploadFilesToS3(files) {
         baseUrl: config.apiBaseUrl,
         authToken
     });
-    const legacyApiClient = createArgosLegacyAPIClient({
-        baseUrl: config.apiBaseUrl,
-        bearerToken: `Bearer ${authToken}`
-    });
     // Collect screenshots
     const foundScreenshots = await discoverScreenshots(files, {
         root: params.root,
@@ -868,11 +820,11 @@ async function uploadFilesToS3(files) {
         };
     }));
     debug("Fetch project");
-    const { data: project, error } = await apiClient.GET("/project");
-    if (error) {
-        throw new Error(error.error);
+    const projectResponse = await apiClient.GET("/project");
+    if (projectResponse.error) {
+        throw new Error(projectResponse.error.error);
     }
-    const { defaultBaseBranch, hasRemoteContentAccess } = project;
+    const { defaultBaseBranch, hasRemoteContentAccess } = projectResponse.data;
     const referenceBranch = config.referenceBranch || defaultBaseBranch;
     const referenceCommit = (()=>{
         if (config.referenceCommit) {
@@ -910,24 +862,30 @@ async function uploadFilesToS3(files) {
         [],
         []
     ]);
-    const result = await legacyApiClient.createBuild({
-        commit: config.commit,
-        branch: config.branch,
-        name: config.buildName,
-        mode: config.mode,
-        parallel: config.parallel,
-        parallelNonce: config.parallelNonce,
-        screenshotKeys,
-        pwTraceKeys,
-        prNumber: config.prNumber,
-        prHeadCommit: config.prHeadCommit,
-        referenceBranch,
-        referenceCommit,
-        argosSdk,
-        ciProvider: config.ciProvider,
-        runId: config.runId,
-        runAttempt: config.runAttempt
+    const createBuildResponse = await apiClient.POST("/builds", {
+        body: {
+            commit: config.commit,
+            branch: config.branch,
+            name: config.buildName,
+            mode: config.mode,
+            parallel: config.parallel,
+            parallelNonce: config.parallelNonce,
+            screenshotKeys,
+            pwTraceKeys,
+            prNumber: config.prNumber,
+            prHeadCommit: config.prHeadCommit,
+            referenceBranch,
+            referenceCommit,
+            argosSdk,
+            ciProvider: config.ciProvider,
+            runId: config.runId,
+            runAttempt: config.runAttempt
+        }
     });
+    if (createBuildResponse.error) {
+        throw new Error(createBuildResponse.error.error);
+    }
+    const result = createBuildResponse.data;
     debug("Got uploads url", result);
     const uploadFiles = [
         ...result.screenshots.map(({ key, putUrl })=>{
@@ -956,24 +914,58 @@ async function uploadFilesToS3(files) {
     await uploadFilesToS3(uploadFiles);
     // Update build
     debug("Updating build");
-    await legacyApiClient.updateBuild({
-        buildId: result.build.id,
-        screenshots: screenshots.map((screenshot)=>({
-                key: screenshot.hash,
-                name: screenshot.name,
-                metadata: screenshot.metadata,
-                pwTraceKey: screenshot.pwTrace?.hash ?? null,
-                threshold: screenshot.threshold ?? config?.threshold ?? null,
-                baseName: screenshot.baseName
-            })),
-        parallel: config.parallel,
-        parallelTotal: config.parallelTotal,
-        parallelIndex: config.parallelIndex
+    const uploadBuildResponse = await apiClient.PUT("/builds/{buildId}", {
+        params: {
+            path: {
+                buildId: result.build.id
+            }
+        },
+        body: {
+            screenshots: screenshots.map((screenshot)=>({
+                    key: screenshot.hash,
+                    name: screenshot.name,
+                    metadata: screenshot.metadata,
+                    pwTraceKey: screenshot.pwTrace?.hash ?? null,
+                    threshold: screenshot.threshold ?? config?.threshold ?? null,
+                    baseName: screenshot.baseName
+                })),
+            parallel: config.parallel,
+            parallelTotal: config.parallelTotal,
+            parallelIndex: config.parallelIndex
+        }
     });
+    if (uploadBuildResponse.error) {
+        throw new Error(uploadBuildResponse.error.error);
+    }
     return {
-        build: result.build,
+        build: uploadBuildResponse.data.build,
         screenshots
     };
 }
 
-export { readConfig, upload };
+/**
+ * Finalize pending builds.
+ */ async function finalize(params) {
+    const config = await readConfig({
+        parallelNonce: params.parallel?.nonce ?? null
+    });
+    const authToken = getAuthToken(config);
+    const apiClient = createClient({
+        baseUrl: config.apiBaseUrl,
+        authToken
+    });
+    if (!config.parallelNonce) {
+        throw new Error("parallel.nonce is required to finalize the build");
+    }
+    const finalizeBuildsResult = await apiClient.POST("/builds/finalize", {
+        body: {
+            parallelNonce: config.parallelNonce
+        }
+    });
+    if (finalizeBuildsResult.error) {
+        throw new Error(finalizeBuildsResult.error.error);
+    }
+    return finalizeBuildsResult.data;
+}
+
+export { finalize, readConfig, upload };

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.5.1",
+  "version": "2.6.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.2.0",
+    "@argos-ci/api-client": "0.3.0",
     "@argos-ci/util": "2.1.1",
     "axios": "^1.7.4",
     "convict": "^6.2.4",
@@ -60,5 +60,5 @@
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "36dc00b48375b72a82aad17bc1465b8933e8e6a9"
+  "gitHead": "fd9935c114e6a948eca173127947cebcf6381007"
 }