@argos-ci/core 2.2.0 → 2.3.0

package/dist/index.d.ts

@@ -25,6 +25,8 @@ interface UploadParameters {
         nonce: string;
         /** The number of parallel nodes being ran */
         total: number;
+        /** The index of the parallel node */
+        index?: number;
     } | false;
     /** Branch used as baseline for screenshot comparison */
     referenceBranch?: string;
@@ -59,6 +61,7 @@ interface Config {
     buildName: string | null;
     parallel: boolean;
     parallelNonce: string | null;
+    parallelIndex: number | null;
     parallelTotal: number | null;
     referenceBranch: string | null;
     referenceCommit: string | null;
@@ -66,9 +69,11 @@ interface Config {
     repository: string | null;
     jobId: string | null;
     runId: string | null;
+    runAttempt: number | null;
     prNumber: number | null;
     prHeadCommit: string | null;
     mode: "ci" | "monitoring" | null;
+    ciProvider: string | null;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;
 export { UploadParameters, upload, Config, readConfig };

package/dist/index.mjs

@@ -10,13 +10,15 @@ import sharp from 'sharp';
 import tmp from 'tmp';
 import { createHash } from 'node:crypto';
 import { readFile } from 'node:fs/promises';
-import { readMetadata, getPlaywrightTracePath } from '@argos-ci/util';
+import { readVersionFromPackage, readMetadata, getPlaywrightTracePath } from '@argos-ci/util';
+import { createRequire } from 'node:module';
 
 const getPrNumber$2 = ({ env })=>{
     return env.BITRISE_PULL_REQUEST ? Number(env.BITRISE_PULL_REQUEST) : null;
 };
 const service$7 = {
     name: "Bitrise",
+    key: "bitrise",
     detect: ({ env })=>Boolean(env.BITRISE_IO),
     config: ({ env })=>{
         return {
@@ -26,6 +28,7 @@ const service$7 = {
             repository: env.BITRISEIO_GIT_REPOSITORY_SLUG || null,
             jobId: null,
             runId: null,
+            runAttempt: null,
             prNumber: getPrNumber$2({
                 env
             }),
@@ -69,6 +72,7 @@ const service$7 = {
 
 const service$6 = {
     name: "Buildkite",
+    key: "buildkite",
     detect: ({ env })=>Boolean(env.BUILDKITE),
     config: ({ env })=>{
         return {
@@ -79,6 +83,7 @@ const service$6 = {
             repository: env.BUILDKITE_PROJECT_SLUG || null,
             jobId: null,
             runId: null,
+            runAttempt: null,
             prNumber: env.BUILDKITE_PULL_REQUEST ? Number(env.BUILDKITE_PULL_REQUEST) : null,
             prHeadCommit: null,
             nonce: env.BUILDKITE_BUILD_ID || null
@@ -88,6 +93,7 @@ const service$6 = {
 
 const service$5 = {
     name: "Heroku",
+    key: "heroku",
     detect: ({ env })=>Boolean(env.HEROKU_TEST_RUN_ID),
     config: ({ env })=>({
             commit: env.HEROKU_TEST_RUN_COMMIT_VERSION || null,
@@ -96,6 +102,7 @@ const service$5 = {
             repository: null,
             jobId: null,
             runId: null,
+            runAttempt: null,
             prNumber: null,
             prHeadCommit: null,
             nonce: env.HEROKU_TEST_RUN_ID || null
@@ -194,6 +201,7 @@ const readEventPayload = ({ env })=>{
 };
 const service$4 = {
     name: "GitHub Actions",
+    key: "github-actions",
     detect: ({ env })=>Boolean(env.GITHUB_ACTIONS),
     config: async ({ env })=>{
         const payload = readEventPayload({
@@ -211,6 +219,7 @@ const service$4 = {
             }),
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || null,
+            runAttempt: env.GITHUB_RUN_ATTEMPT ? Number(env.GITHUB_RUN_ATTEMPT) : null,
             nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}` || null
         };
         // If the job is triggered by from a "deployment" or a "deployment_status"
@@ -250,6 +259,7 @@ const getPrNumber$1 = ({ env })=>{
 };
 const service$3 = {
     name: "CircleCI",
+    key: "circleci",
     detect: ({ env })=>Boolean(env.CIRCLECI),
     config: ({ env })=>{
         return {
@@ -259,6 +269,7 @@ const service$3 = {
             repository: env.CIRCLE_PROJECT_REPONAME || null,
             jobId: null,
             runId: null,
+            runAttempt: null,
             prNumber: getPrNumber$1({
                 env
             }),
@@ -282,6 +293,7 @@ const getPrNumber = ({ env })=>{
 };
 const service$2 = {
     name: "Travis CI",
+    key: "travis",
     detect: ({ env })=>Boolean(env.TRAVIS),
     config: (ctx)=>{
         const { env } = ctx;
@@ -292,6 +304,7 @@ const service$2 = {
             repository: getRepository(ctx),
             jobId: null,
             runId: null,
+            runAttempt: null,
             prNumber: getPrNumber(ctx),
             prHeadCommit: null,
             nonce: env.TRAVIS_BUILD_ID || null
@@ -301,6 +314,7 @@ const service$2 = {
 
 const service$1 = {
     name: "GitLab",
+    key: "gitlab",
     detect: ({ env })=>env.GITLAB_CI === "true",
     config: ({ env })=>{
         return {
@@ -310,6 +324,7 @@ const service$1 = {
             repository: null,
             jobId: null,
             runId: null,
+            runAttempt: null,
             prNumber: null,
             prHeadCommit: null,
             nonce: env.CI_PIPELINE_ID || null
@@ -319,6 +334,7 @@ const service$1 = {
 
 const service = {
     name: "Git",
+    key: "git",
     detect: ()=>checkIsGitRepository(),
     config: ()=>{
         return {
@@ -328,6 +344,7 @@ const service = {
             repository: null,
             jobId: null,
             runId: null,
+            runAttempt: null,
             prNumber: null,
             prHeadCommit: null,
             nonce: null
@@ -361,6 +378,7 @@ async function getCiEnvironment({ env = process.env } = {}) {
         const variables = await service.config(ctx);
         const ciEnvironment = {
             name: service.name,
+            key: service.key,
             ...variables
         };
         debug("CI environment", ciEnvironment);
@@ -449,6 +467,12 @@ const schema = {
         default: null,
         nullable: true
     },
+    parallelIndex: {
+        env: "ARGOS_PARALLEL_INDEX",
+        format: "nat",
+        default: null,
+        nullable: true
+    },
     parallelTotal: {
         env: "ARGOS_PARALLEL_TOTAL",
         format: "nat",
@@ -467,18 +491,18 @@ const schema = {
         default: null,
         nullable: true
     },
-    ciService: {
+    jobId: {
         format: String,
         default: null,
         nullable: true
     },
-    jobId: {
+    runId: {
         format: String,
         default: null,
         nullable: true
     },
-    runId: {
-        format: String,
+    runAttempt: {
+        format: "nat",
         default: null,
         nullable: true
     },
@@ -491,6 +515,11 @@ const schema = {
         format: String,
         default: null,
         nullable: true
+    },
+    ciProvider: {
+        format: String,
+        default: null,
+        nullable: true
     }
 };
 const createConfig = ()=>{
@@ -511,15 +540,17 @@ 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,
         runId: ciEnv?.runId || null,
+        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,
-        mode: options.mode || config.get("mode") || null
+        parallelIndex: options.parallelIndex || config.get("parallelIndex") || null,
+        mode: options.mode || config.get("mode") || null,
+        ciProvider: ciEnv?.key || null
     });
     config.validate();
     return config.get();
@@ -574,13 +605,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,
@@ -593,7 +624,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,
@@ -666,6 +697,15 @@ const upload$1 = async (input)=>{
     return result;
 };
 
+const require = createRequire(import.meta.url);
+/**
+ * Get the version of the @argos-ci/core package.
+ */ async function getArgosCoreSDKIdentifier() {
+    const pkgPath = require.resolve("@argos-ci/core/package.json");
+    const version = await readVersionFromPackage(pkgPath);
+    return `@argos-ci/core@${version}`;
+}
+
 /**
  * Size of the chunks used to upload screenshots to Argos.
  */ const CHUNK_SIZE = 10;
@@ -674,7 +714,8 @@ async function getConfigFromOptions({ parallel, ...options }) {
         ...options,
         parallel: Boolean(parallel),
         parallelNonce: parallel ? parallel.nonce : null,
-        parallelTotal: parallel ? parallel.total : null
+        parallelTotal: parallel ? parallel.total : null,
+        parallelIndex: parallel ? parallel.index : null
     });
 }
 async function uploadFilesToS3(files) {
@@ -705,7 +746,10 @@ async function uploadFilesToS3(files) {
  */ async function upload(params) {
     debug("Starting upload with params", params);
     // Read config
-    const config = await getConfigFromOptions(params);
+    const [config, argosSdk] = await Promise.all([
+        getConfigFromOptions(params),
+        getArgosCoreSDKIdentifier()
+    ]);
     const files = params.files ?? [
         "**/*.{png,jpg,jpeg}"
     ];
@@ -771,7 +815,11 @@ async function uploadFilesToS3(files) {
         prNumber: config.prNumber,
         prHeadCommit: config.prHeadCommit,
         referenceBranch: config.referenceBranch,
-        referenceCommit: config.referenceCommit
+        referenceCommit: config.referenceCommit,
+        argosSdk,
+        ciProvider: config.ciProvider,
+        runId: config.runId,
+        runAttempt: config.runAttempt
     });
     debug("Got uploads url", result);
     const uploadFiles = [
@@ -810,7 +858,8 @@ async function uploadFilesToS3(files) {
                 pwTraceKey: screenshot.pwTrace?.hash ?? null
             })),
         parallel: config.parallel,
-        parallelTotal: config.parallelTotal
+        parallelTotal: config.parallelTotal,
+        parallelIndex: config.parallelIndex
     });
     return {
         build: result.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": "2.2.0",
+  "version": "2.3.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -59,5 +59,5 @@
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "5b18339a0b9e3a1e7529dfa999ed91227842c43c"
+  "gitHead": "0c328bfcd6475ad625c0335cab11e912e856173c"
 }