@argos-ci/core 2.4.1 → 2.4.2-alpha.6

package/dist/index.mjs

@@ -1,3 +1,4 @@
+import { createClient } from '@argos-ci/api-client';
 import convict from 'convict';
 import { execSync } from 'node:child_process';
 import { existsSync, readFileSync, createReadStream } from 'node:fs';
@@ -13,52 +14,27 @@ import { readFile } from 'node:fs/promises';
 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 {
-            commit: env.BITRISE_GIT_COMMIT || null,
-            branch: env.BITRISE_GIT_BRANCH || null,
-            owner: env.BITRISEIO_GIT_REPOSITORY_OWNER || null,
-            repository: env.BITRISEIO_GIT_REPOSITORY_SLUG || null,
-            jobId: null,
-            runId: null,
-            runAttempt: null,
-            prNumber: getPrNumber$2({
-                env
-            }),
-            prHeadCommit: null,
-            nonce: env.BITRISEIO_PIPELINE_ID || null
-        };
-    }
-};
-
 /**
  * Check if the current directory is a git repository.
- */ const checkIsGitRepository = ()=>{
+ */ function checkIsGitRepository() {
     try {
         return execSync("git rev-parse --is-inside-work-tree").toString().trim() === "true";
     } catch  {
         return false;
     }
-};
+}
 /**
  * Returns the head commit.
- */ const head = ()=>{
+ */ function head() {
     try {
         return execSync("git rev-parse HEAD").toString().trim();
     } catch  {
         return null;
     }
-};
+}
 /**
  * Returns the current branch.
- */ const branch = ()=>{
+ */ function branch() {
     try {
         const headRef = execSync("git rev-parse --abbrev-ref HEAD").toString().trim();
         if (headRef === "HEAD") {
@@ -68,6 +44,57 @@ const service$7 = {
     } catch  {
         return null;
     }
+}
+function getMergeBaseCommitShaWithDepth(input) {
+    const head = input.head || `HEAD`;
+    try {
+        execSync(`git fetch origin ${head} --depth ${input.depth}`);
+        execSync(`git fetch origin ${input.base}:${input.base} --depth ${input.depth}`);
+        const mergeBase = execSync(`git merge-base ${head} ${input.base}`).toString().trim();
+        return mergeBase || null;
+    } catch  {
+        return null;
+    }
+}
+function getMergeBaseCommitSha$1(input) {
+    let depth = 50;
+    while(depth < 1000){
+        const mergeBase = getMergeBaseCommitShaWithDepth({
+            ...input,
+            depth
+        });
+        if (mergeBase) {
+            return mergeBase;
+        }
+        depth += 50;
+    }
+    return null;
+}
+
+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 {
+            commit: env.BITRISE_GIT_COMMIT || null,
+            branch: env.BITRISE_GIT_BRANCH || null,
+            owner: env.BITRISEIO_GIT_REPOSITORY_OWNER || null,
+            repository: env.BITRISEIO_GIT_REPOSITORY_SLUG || null,
+            jobId: null,
+            runId: null,
+            runAttempt: null,
+            prNumber: getPrNumber$2({
+                env
+            }),
+            prHeadCommit: null,
+            nonce: env.BITRISEIO_PIPELINE_ID || null
+        };
+    },
+    getMergeBaseCommitSha: getMergeBaseCommitSha$1
 };
 
 const service$6 = {
@@ -88,7 +115,8 @@ const service$6 = {
             prHeadCommit: null,
             nonce: env.BUILDKITE_BUILD_ID || null
         };
-    }
+    },
+    getMergeBaseCommitSha: getMergeBaseCommitSha$1
 };
 
 const service$5 = {
@@ -106,7 +134,8 @@ const service$5 = {
             prNumber: null,
             prHeadCommit: null,
             nonce: env.HEROKU_TEST_RUN_ID || null
-        })
+        }),
+    getMergeBaseCommitSha: getMergeBaseCommitSha$1
 };
 
 const KEY = "@argos-ci/core";
@@ -179,34 +208,37 @@ To disable this warning, add \`DISABLE_GITHUB_TOKEN_WARNING: true\` as environme
         return null;
     }
 }
-const getBranch = ({ env })=>{
+function getBranch(context, eventPayload) {
+    if (eventPayload?.pull_request?.head.ref) {
+        return eventPayload.pull_request.head.ref;
+    }
+    const { env } = context;
     if (env.GITHUB_HEAD_REF) {
         return env.GITHUB_HEAD_REF;
     }
-    const branchRegex = /refs\/heads\/(.*)/;
     if (!env.GITHUB_REF) {
         return null;
     }
+    const branchRegex = /refs\/heads\/(.*)/;
     const matches = branchRegex.exec(env.GITHUB_REF);
     return matches?.[1] ?? null;
-};
-const getRepository$1 = ({ env })=>{
+}
+function getRepository$1({ env }) {
     if (!env.GITHUB_REPOSITORY) return null;
     return env.GITHUB_REPOSITORY.split("/")[1] || null;
-};
-const readEventPayload = ({ env })=>{
+}
+function readEventPayload({ env }) {
     if (!env.GITHUB_EVENT_PATH) return null;
     if (!existsSync(env.GITHUB_EVENT_PATH)) return null;
     return JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf-8"));
-};
+}
 const service$4 = {
     name: "GitHub Actions",
     key: "github-actions",
-    detect: ({ env })=>Boolean(env.GITHUB_ACTIONS),
-    config: async ({ env })=>{
-        const payload = readEventPayload({
-            env
-        });
+    detect: (context)=>Boolean(context.env.GITHUB_ACTIONS),
+    config: async (context)=>{
+        const { env } = context;
+        const payload = readEventPayload(context);
         const sha = process.env.GITHUB_SHA || null;
         if (!sha) {
             throw new Error(`GITHUB_SHA is missing`);
@@ -214,9 +246,7 @@ const service$4 = {
         const commonConfig = {
             commit: sha,
             owner: env.GITHUB_REPOSITORY_OWNER || null,
-            repository: getRepository$1({
-                env
-            }),
+            repository: getRepository$1(context),
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || null,
             runAttempt: env.GITHUB_RUN_ATTEMPT ? Number(env.GITHUB_RUN_ATTEMPT) : null,
@@ -226,9 +256,7 @@ const service$4 = {
         if (payload?.deployment) {
             debug("Deployment event detected");
             // Try to find a relevant pull request for the sha
-            const pullRequest = await getPullRequestFromHeadSha({
-                env
-            }, sha);
+            const pullRequest = await getPullRequestFromHeadSha(context, sha);
             return {
                 ...commonConfig,
                 // If no pull request is found, we fallback to the deployment environment as branch name
@@ -240,12 +268,20 @@ const service$4 = {
         }
         return {
             ...commonConfig,
-            branch: payload?.pull_request?.head.ref || getBranch({
-                env
-            }) || null,
+            branch: payload?.pull_request?.head.ref || getBranch(context, payload) || null,
             prNumber: payload?.pull_request?.number || null,
             prHeadCommit: payload?.pull_request?.head.sha ?? null
         };
+    },
+    getMergeBaseCommitSha: (input, ctx)=>{
+        const payload = readEventPayload(ctx);
+        const branch = getBranch(ctx, payload);
+        // Unshallow the repository to get the merge base commit
+        execSync(`git config remote.origin.fetch "+refs/heads/*:refs/remotes/origin/*"`);
+        return getMergeBaseCommitSha$1({
+            base: input.base,
+            head: branch
+        });
     }
 };
 
@@ -276,7 +312,8 @@ const service$3 = {
             prHeadCommit: null,
             nonce: env.CIRCLE_WORKFLOW_ID || env.CIRCLE_BUILD_NUM || null
         };
-    }
+    },
+    getMergeBaseCommitSha: getMergeBaseCommitSha$1
 };
 
 const getOwner = ({ env })=>{
@@ -309,7 +346,8 @@ const service$2 = {
             prHeadCommit: null,
             nonce: env.TRAVIS_BUILD_ID || null
         };
-    }
+    },
+    getMergeBaseCommitSha: getMergeBaseCommitSha$1
 };
 
 const service$1 = {
@@ -329,7 +367,8 @@ const service$1 = {
             prHeadCommit: null,
             nonce: env.CI_PIPELINE_ID || null
         };
-    }
+    },
+    getMergeBaseCommitSha: getMergeBaseCommitSha$1
 };
 
 const service = {
@@ -349,7 +388,8 @@ const service = {
             prHeadCommit: null,
             nonce: null
         };
-    }
+    },
+    getMergeBaseCommitSha: getMergeBaseCommitSha$1
 };
 
 // List of services ordered by usage
@@ -364,18 +404,38 @@ const services = [
     service$7,
     service
 ];
-async function getCiEnvironment({ env = process.env } = {}) {
-    const ctx = {
-        env
+/**
+ * Create the context for the CI service detection.
+ */ function createContext() {
+    return {
+        env: process.env
     };
-    debug("Detecting CI environment", {
-        env
-    });
-    const service = services.find((service)=>service.detect(ctx));
+}
+/**
+ * Get the CI service that is currently running.
+ */ function getCiService(context) {
+    return services.find((service)=>service.detect(context));
+}
+/**
+ * Get the merge base commit.
+ */ function getMergeBaseCommitSha(input) {
+    const context = createContext();
+    const service = getCiService(context);
+    if (!service) {
+        return null;
+    }
+    return service.getMergeBaseCommitSha(input, context);
+}
+/**
+ * Get the CI environment.
+ */ async function getCiEnvironment() {
+    const context = createContext();
+    debug("Detecting CI environment", context);
+    const service = getCiService(context);
     // Service matched
     if (service) {
         debug("Internal service matched", service.name);
-        const variables = await service.config(ctx);
+        const variables = await service.config(context);
         const ciEnvironment = {
             name: service.name,
             key: service.key,
@@ -622,15 +682,17 @@ const hashFile = async (filepath)=>{
 };
 
 const base64Encode = (obj)=>Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
-function getBearerToken({ token, ciProvider, owner, repository, jobId, runId, prNumber }) {
-    if (token) return `Bearer ${token}`;
+function getAuthToken({ token, ciProvider, owner, repository, jobId, runId, prNumber }) {
+    if (token) {
+        return token;
+    }
     switch(ciProvider){
         case "github-actions":
             {
                 if (!owner || !repository || !jobId || !runId) {
                     throw new Error(`Automatic GitHub Actions variables detection failed. Please add the 'ARGOS_TOKEN'`);
                 }
-                return `Bearer tokenless-github-${base64Encode({
+                return `tokenless-github-${base64Encode({
                     owner,
                     repository,
                     jobId,
@@ -642,7 +704,7 @@ function getBearerToken({ token, ciProvider, owner, repository, jobId, runId, pr
             throw new Error("Missing Argos repository token 'ARGOS_TOKEN'");
     }
 }
-const createArgosApiClient = (options)=>{
+const createArgosLegacyAPIClient = (options)=>{
     const axiosInstance = axios.create({
         baseURL: options.baseUrl,
         headers: {
@@ -771,9 +833,14 @@ async function uploadFilesToS3(files) {
         "**/*.{png,jpg,jpeg}"
     ];
     debug("Using config and files", config, files);
-    const apiClient = createArgosApiClient({
+    const authToken = getAuthToken(config);
+    const apiClient = createClient({
+        baseUrl: config.apiBaseUrl,
+        authToken
+    });
+    const legacyApiClient = createArgosLegacyAPIClient({
         baseUrl: config.apiBaseUrl,
-        bearerToken: getBearerToken(config)
+        bearerToken: `Bearer ${authToken}`
     });
     // Collect screenshots
     const foundScreenshots = await discoverScreenshots(files, {
@@ -810,6 +877,31 @@ async function uploadFilesToS3(files) {
             } : null
         };
     }));
+    debug("Fetch project");
+    const { data: project, error } = await apiClient.GET("/project");
+    if (error) {
+        throw new Error(error.error);
+    }
+    const { defaultBaseBranch, hasRemoteContentAccess } = project;
+    const referenceBranch = config.referenceBranch || defaultBaseBranch;
+    const referenceCommit = (()=>{
+        if (config.referenceCommit) {
+            debug("Found reference commit in config", config.referenceCommit);
+            return config.referenceCommit;
+        }
+        if (hasRemoteContentAccess) {
+            return null;
+        }
+        const sha = getMergeBaseCommitSha({
+            base: referenceBranch
+        });
+        if (sha) {
+            debug("Found reference commit from git", sha);
+        } else {
+            debug("No reference commit found in git");
+        }
+        return sha;
+    })();
     // Create build
     debug("Creating build");
     const [pwTraceKeys, screenshotKeys] = screenshots.reduce(([pwTraceKeys, screenshotKeys], screenshot)=>{
@@ -827,7 +919,7 @@ async function uploadFilesToS3(files) {
         [],
         []
     ]);
-    const result = await apiClient.createBuild({
+    const result = await legacyApiClient.createBuild({
         commit: config.commit,
         branch: config.branch,
         name: config.buildName,
@@ -838,8 +930,8 @@ async function uploadFilesToS3(files) {
         pwTraceKeys,
         prNumber: config.prNumber,
         prHeadCommit: config.prHeadCommit,
-        referenceBranch: config.referenceBranch,
-        referenceCommit: config.referenceCommit,
+        referenceBranch,
+        referenceCommit,
         argosSdk,
         ciProvider: config.ciProvider,
         runId: config.runId,
@@ -873,7 +965,7 @@ async function uploadFilesToS3(files) {
     await uploadFilesToS3(uploadFiles);
     // Update build
     debug("Updating build");
-    await apiClient.updateBuild({
+    await legacyApiClient.updateBuild({
         buildId: result.build.id,
         screenshots: screenshots.map((screenshot)=>({
                 key: screenshot.hash,

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.4.1",
+  "version": "2.4.2-alpha.6+6b6c15f",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -40,24 +40,25 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/util": "2.1.0",
-    "axios": "^1.6.8",
+    "@argos-ci/api-client": "0.1.1-alpha.34+6b6c15f",
+    "@argos-ci/util": "2.1.1-alpha.14+6b6c15f",
+    "axios": "^1.7.4",
     "convict": "^6.2.4",
-    "debug": "^4.3.4",
+    "debug": "^4.3.6",
     "fast-glob": "^3.3.2",
-    "sharp": "^0.33.3",
+    "sharp": "^0.33.5",
     "tmp": "^0.2.3"
   },
   "devDependencies": {
     "@types/convict": "^6.1.6",
     "@types/debug": "^4.1.12",
     "@types/tmp": "^0.2.6",
-    "msw": "^2.2.13"
+    "msw": "^2.3.5"
   },
   "scripts": {
     "prebuild": "rm -rf dist",
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "8fbd0bb85ba9df1e8ca39d46acfe9903264d0b51"
+  "gitHead": "6b6c15f62882eb38e36a59f80f5ad2aa6d7ee3ff"
 }