@argos-ci/core 0.12.0 → 0.12.1-alpha.7

package/dist/index.d.ts

@@ -38,11 +38,11 @@ declare const upload: (params: UploadParameters) => Promise<{
         url: string;
     };
     screenshots: {
+        metadata: import("@argos-ci/util").ScreenshotMetadata | null;
         optimizedPath: string;
         hash: string;
         name: string;
         path: string;
     }[];
 }>;
-
-export { type UploadParameters, upload };
+export { UploadParameters, upload };

package/dist/index.mjs

@@ -2,7 +2,6 @@ import convict from 'convict';
 import { execSync } from 'node:child_process';
 import { existsSync, readFileSync, createReadStream } from 'node:fs';
 import createDebug from 'debug';
-import envCi from 'env-ci';
 import { resolve } from 'node:path';
 import glob from 'fast-glob';
 import { promisify } from 'node:util';
@@ -11,6 +10,7 @@ import tmp from 'tmp';
 import { createHash } from 'node:crypto';
 import axios from 'axios';
 import { readFile } from 'node:fs/promises';
+import { readMetadata } from '@argos-ci/util';
 
 const mustBeApiBaseUrl = (value)=>{
     const URL_REGEX = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
@@ -133,6 +133,15 @@ const createConfig = ()=>{
     });
 };
 
+/**
+ * Check if the current directory is a git repository.
+ */ const checkIsGitRepository = ()=>{
+    try {
+        return execSync("git rev-parse --is-inside-work-tree").toString().trim() === "true";
+    } catch  {
+        return false;
+    }
+};
 /**
  * Returns the head commit.
  */ const head = ()=>{
@@ -156,7 +165,7 @@ const createConfig = ()=>{
     }
 };
 
-const service$5 = {
+const service$6 = {
     name: "Buildkite",
     detect: ({ env })=>Boolean(env.BUILDKITE),
     config: ({ env })=>{
@@ -174,7 +183,7 @@ const service$5 = {
     }
 };
 
-const service$4 = {
+const service$5 = {
     name: "Heroku",
     detect: ({ env })=>Boolean(env.HEROKU_TEST_RUN_ID),
     config: ({ env })=>({
@@ -209,16 +218,17 @@ const readEventPayload = ({ env })=>{
     if (!existsSync(env.GITHUB_EVENT_PATH)) return null;
     return JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf-8"));
 };
-const service$3 = {
+const service$4 = {
     name: "GitHub Actions",
     detect: ({ env })=>Boolean(env.GITHUB_ACTIONS),
     config: ({ env })=>{
+        var _payload_pull_request, _payload_pull_request1, _payload_pull_request2;
         const payload = readEventPayload({
             env
         });
         return {
             commit: process.env.GITHUB_SHA || null,
-            branch: payload?.pull_request?.head.ref || getBranch({
+            branch: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request = payload.pull_request) === null || _payload_pull_request === void 0 ? void 0 : _payload_pull_request.head.ref) || getBranch({
                 env
             }) || null,
             owner: env.GITHUB_REPOSITORY_OWNER || null,
@@ -227,8 +237,8 @@ const service$3 = {
             }),
             jobId: env.GITHUB_JOB || null,
             runId: env.GITHUB_RUN_ID || null,
-            prNumber: payload?.pull_request?.number || null,
-            prHeadCommit: payload?.pull_request?.head.sha ?? null
+            prNumber: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request1 = payload.pull_request) === null || _payload_pull_request1 === void 0 ? void 0 : _payload_pull_request1.number) || null,
+            prHeadCommit: (payload === null || payload === void 0 ? void 0 : (_payload_pull_request2 = payload.pull_request) === null || _payload_pull_request2 === void 0 ? void 0 : _payload_pull_request2.head.sha) ?? null
         };
     }
 };
@@ -241,7 +251,7 @@ const getPrNumber$1 = ({ env })=>{
     }
     return null;
 };
-const service$2 = {
+const service$3 = {
     name: "CircleCI",
     detect: ({ env })=>Boolean(env.CIRCLECI),
     config: ({ env })=>{
@@ -272,7 +282,7 @@ const getPrNumber = ({ env })=>{
     if (env.TRAVIS_PULL_REQUEST) return Number(env.TRAVIS_PULL_REQUEST);
     return null;
 };
-const service$1 = {
+const service$2 = {
     name: "Travis CI",
     detect: ({ env })=>Boolean(env.TRAVIS),
     config: (ctx)=>{
@@ -290,7 +300,7 @@ const service$1 = {
     }
 };
 
-const service = {
+const service$1 = {
     name: "GitLab",
     detect: ({ env })=>env.GITLAB_CI === "true",
     config: ({ env })=>{
@@ -307,6 +317,24 @@ const service = {
     }
 };
 
+const service = {
+    name: "Git",
+    detect: ()=>checkIsGitRepository(),
+    config: ()=>{
+        return {
+            // Buildkite doesn't work well so we fallback to git to ensure we have commit and branch
+            commit: head() || null,
+            branch: branch() || null,
+            owner: null,
+            repository: null,
+            jobId: null,
+            runId: null,
+            prNumber: null,
+            prHeadCommit: null
+        };
+    }
+};
+
 const KEY = "@argos-ci/core";
 const debug = createDebug(KEY);
 const debugTime = (arg)=>{
@@ -322,37 +350,13 @@ const debugTimeEnd = (arg)=>{
     }
 };
 
-const getCiEnvironmentFromEnvCi = (ctx)=>{
-    const ciContext = envCi(ctx);
-    const name = ciContext.isCi ? ciContext.name ?? null : ciContext.commit ? "Git" : null;
-    const commit = ciContext.commit ?? null;
-    const branch = (ciContext.branch || ciContext.prBranch) ?? null;
-    const slug = ciContext.slug ? ciContext.slug.split("/") : null;
-    const owner = slug ? slug[0] : null;
-    const repository = slug ? slug[1] : null;
-    const jobId = ciContext.job ?? null;
-    const runId = null;
-    const prNumber = null;
-    const prHeadCommit = null;
-    return commit ? {
-        name,
-        commit,
-        branch,
-        owner,
-        repository,
-        jobId,
-        runId,
-        prNumber,
-        prHeadCommit
-    } : null;
-};
-
 const services = [
+    service$5,
     service$4,
     service$3,
     service$2,
+    service$6,
     service$1,
-    service$5,
     service
 ];
 const getCiEnvironment = ({ env = process.env } = {})=>{
@@ -374,11 +378,7 @@ const getCiEnvironment = ({ env = process.env } = {})=>{
         debug("CI environment", ciEnvironment);
         return ciEnvironment;
     }
-    // We fallback on "env-ci" library, not very good but it's better than nothing
-    debug("Falling back on env-ci");
-    const ciEnvironment = getCiEnvironmentFromEnvCi(ctx);
-    debug("CI environment", ciEnvironment);
-    return ciEnvironment;
+    return null;
 };
 
 const discoverScreenshots = async (patterns, { root = process.cwd(), ignore } = {})=>{
@@ -387,10 +387,13 @@ const discoverScreenshots = async (patterns, { root = process.cwd(), ignore } =
         ignore,
         cwd: root
     });
-    return matches.map((match)=>({
+    return matches.map((match)=>{
+        const path = resolve(root, match);
+        return {
             name: match,
-            path: resolve(root, match)
-        }));
+            path
+        };
+    });
 };
 
 const tmpFile = promisify(tmp.file);
@@ -465,7 +468,8 @@ const createArgosApiClient = (options)=>{
             });
             return response.data;
         } catch (error) {
-            if (error?.response?.data?.error?.message) {
+            var _error_response_data_error, _error_response_data, _error_response;
+            if (error === null || error === void 0 ? void 0 : (_error_response = error.response) === null || _error_response === void 0 ? void 0 : (_error_response_data = _error_response.data) === null || _error_response_data === void 0 ? void 0 : (_error_response_data_error = _error_response_data.error) === null || _error_response_data_error === void 0 ? void 0 : _error_response_data_error.message) {
                 // @ts-ignore
                 throw new Error(error.response.data.error.message, {
                     cause: error
@@ -518,19 +522,19 @@ const getConfigFromOptions = (options)=>{
     const ciEnv = getCiEnvironment();
     config.load({
         apiBaseUrl: options.apiBaseUrl ?? config.get("apiBaseUrl"),
-        commit: options.commit ?? config.get("commit") ?? ciEnv?.commit ?? null,
-        branch: options.branch ?? config.get("branch") ?? ciEnv?.branch ?? null,
+        commit: options.commit ?? config.get("commit") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.commit) ?? null,
+        branch: options.branch ?? config.get("branch") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.branch) ?? null,
         token: options.token ?? config.get("token") ?? null,
         buildName: options.buildName ?? config.get("buildName") ?? null,
-        prNumber: options.prNumber ?? config.get("prNumber") ?? ciEnv?.prNumber ?? null,
-        prHeadCommit: config.get("prHeadCommit") ?? ciEnv?.prHeadCommit ?? null,
+        prNumber: options.prNumber ?? config.get("prNumber") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.prNumber) ?? null,
+        prHeadCommit: config.get("prHeadCommit") ?? (ciEnv === null || ciEnv === void 0 ? void 0 : 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
+        ciService: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.name) ?? null,
+        owner: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.owner) ?? null,
+        repository: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.repository) ?? null,
+        jobId: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.jobId) ?? null,
+        runId: (ciEnv === null || ciEnv === void 0 ? void 0 : ciEnv.runId) ?? null
     });
     if (options.parallel) {
         config.load({
@@ -564,10 +568,14 @@ const getConfigFromOptions = (options)=>{
     debug("Found screenshots", foundScreenshots);
     // Optimize & compute hashes
     const screenshots = await Promise.all(foundScreenshots.map(async (screenshot)=>{
-        const optimizedPath = await optimizeScreenshot(screenshot.path);
+        const [metadata, optimizedPath] = await Promise.all([
+            readMetadata(screenshot.path),
+            optimizeScreenshot(screenshot.path)
+        ]);
         const hash = await hashFile(optimizedPath);
         return {
             ...screenshot,
+            metadata,
             optimizedPath,
             hash
         };
@@ -612,7 +620,8 @@ const getConfigFromOptions = (options)=>{
         buildId: result.build.id,
         screenshots: screenshots.map((screenshot)=>({
                 key: screenshot.hash,
-                name: screenshot.name
+                name: screenshot.name,
+                metadata: screenshot.metadata
             })),
         parallel: config.parallel,
         parallelTotal: config.parallelTotal

package/package.json

@@ -1,12 +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.12.0",
-  "scripts": {
-    "prebuild": "rm -rf dist",
-    "build": "rollup -c",
-    "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
-  },
+  "version": "0.12.1-alpha.7+b2cbada",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -45,21 +40,24 @@
     "access": "public"
   },
   "dependencies": {
+    "@argos-ci/util": "0.0.1-alpha.187+b2cbada",
     "axios": "^1.5.0",
     "convict": "^6.2.4",
     "debug": "^4.3.4",
-    "env-ci": "^9.1.1",
     "fast-glob": "^3.3.1",
     "sharp": "^0.32.5",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
     "@types/convict": "^6.1.4",
+    "@types/debug": "^4.1.9",
     "@types/tmp": "^0.2.3",
-    "msw": "^1.3.0",
-    "rollup": "^3.29.0",
-    "rollup-plugin-dts": "^6.0.1",
-    "rollup-plugin-swc3": "^0.10.1"
+    "msw": "^1.3.0"
+  },
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "rollup -c",
+    "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "e58b26f5c3a9998d89353c4435aa742b5ae3d244"
+  "gitHead": "b2cbadab77b42d32946e7ed315290e9b9bd7d245"
 }