@argos-ci/cli 4.1.3 → 4.1.5-alpha.2

package/dist/index.mjs

@@ -4,6 +4,7 @@ import { resolve } from "node:path";
 import { Option, program } from "commander";
 import { finalize, skip, upload } from "@argos-ci/core";
 import ora from "ora";
+import { createClient, throwAPIError } from "@argos-ci/api-client";
 //#region src/options.ts
 const parallelNonceOption = new Option("--parallel-nonce <string>", "A unique ID for this parallel build").env("ARGOS_PARALLEL_NONCE");
 const tokenOption = new Option("--token <token>", "Repository token").env("ARGOS_TOKEN");
@@ -91,6 +92,196 @@ function skipCommand(program) {
 	});
 }
 //#endregion
+//#region src/commands/build.ts
+function getToken(options) {
+	const token = options.token ?? process.env["ARGOS_TOKEN"];
+	if (!token) {
+		console.error("Error: No Argos token found. Use --token or set ARGOS_TOKEN.");
+		process.exit(1);
+	}
+	return token;
+}
+function getAPIBaseURL() {
+	return process.env["ARGOS_API_BASE_URL"];
+}
+function createBuildsClient(options) {
+	return createClient({
+		authToken: getToken(options),
+		baseUrl: getAPIBaseURL()
+	});
+}
+function isBuildPending(build) {
+	return build.status === "pending" || build.status === "progress";
+}
+function parseBuildReferenceOrExit(buildReference) {
+	const parsedBuildNumber = Number(buildReference);
+	if (Number.isFinite(parsedBuildNumber) && Number.isInteger(parsedBuildNumber)) return parsedBuildNumber;
+	const urlMatch = buildReference.match(/^https:\/\/app\.argos-ci\.(?:com|dev(?::\d+)?)\/.+\/builds\/(\d+)(?:\/?$|[?#])/);
+	if (urlMatch) return Number(urlMatch[1]);
+	console.error(`Error: Build reference must be a valid build number or Argos build URL (https://app.argos-ci.com/.../builds/<number>), got "${buildReference}".`);
+	process.exit(1);
+}
+function formatValue(value) {
+	if (value === null || value === void 0 || value === "") return "-";
+	return String(value);
+}
+function formatStats(stats) {
+	if (!stats) return "-";
+	return [
+		`total ${stats.total}`,
+		`changed ${stats.changed}`,
+		`added ${stats.added}`,
+		`removed ${stats.removed}`,
+		`unchanged ${stats.unchanged}`
+	].join(", ");
+}
+function formatSnapshotSummary(diffs) {
+	const counts = /* @__PURE__ */ new Map();
+	for (const diff of diffs) counts.set(diff.status, (counts.get(diff.status) ?? 0) + 1);
+	return [
+		"changed",
+		"added",
+		"removed",
+		"unchanged",
+		"ignored",
+		"pending",
+		"failure",
+		"retryFailure"
+	].map((status) => {
+		const count = counts.get(status);
+		return count ? `${status} ${count}` : null;
+	}).filter((part) => Boolean(part)).join(", ");
+}
+function printBuild(build) {
+	const lines = [
+		`Build #${build.number}`,
+		`Status: ${build.status}`,
+		`Snapshots: ${formatStats(build.stats)}`,
+		`Conclusion: ${formatValue(build.conclusion)}`,
+		`Branch: ${formatValue(build.head?.branch)}`,
+		`Commit: ${formatValue(build.head?.sha)}`,
+		`Base branch: ${formatValue(build.base?.branch)}`,
+		`Base commit: ${formatValue(build.base?.sha)}`,
+		`URL: ${build.url}`
+	];
+	console.log(lines.join("\n"));
+}
+function printSnapshots(diffs, build) {
+	if (diffs.length === 0) {
+		console.log("No snapshots found.");
+		return;
+	}
+	const lines = [
+		`Snapshots for build #${build.number}`,
+		`Count: ${diffs.length}`,
+		`Summary: ${formatSnapshotSummary(diffs)}`,
+		"",
+		...diffs.flatMap((diff) => {
+			return [
+				`${diff.name} [${diff.status}]`,
+				`  Review: ${build.url}/${diff.id}`,
+				`  Mask: ${formatValue(diff.url)}`,
+				`  Base file: ${formatValue(diff.base?.url)}`,
+				`  Head file: ${formatValue(diff.head?.url)}`,
+				`  Score: ${formatValue(diff.score)}`,
+				`  Group: ${formatValue(diff.group)}`,
+				""
+			];
+		})
+	];
+	console.log(lines.slice(0, -1).join("\n"));
+}
+async function fetchAllDiffs(client, project, buildNumber, options) {
+	const results = [];
+	let page = 1;
+	const perPage = 100;
+	while (true) {
+		const query = {
+			page: String(page),
+			perPage: String(perPage),
+			...options?.needsReview ? { needsReview: true } : {}
+		};
+		const { data, error } = await client.GET("/projects/{owner}/{project}/builds/{buildNumber}/diffs", { params: {
+			path: {
+				owner: project.account.slug,
+				project: project.name,
+				buildNumber
+			},
+			query
+		} });
+		if (error || !data) {
+			if (error) throwAPIError(error);
+			throw new Error("Unexpected empty response from API.");
+		}
+		results.push(...data.results);
+		if (results.length >= data.pageInfo.total) break;
+		page++;
+	}
+	return results;
+}
+async function fetchProject(client) {
+	const { data, error } = await client.GET("/project");
+	if (error) throwAPIError(error);
+	if (!data) {
+		console.error("Error: Unexpected empty response from API.");
+		process.exit(1);
+	}
+	return data;
+}
+async function fetchBuildByNumber(client, project, buildNumber, errorLabel) {
+	const { data, error, response } = await client.GET("/projects/{owner}/{project}/builds/{buildNumber}", { params: { path: {
+		owner: project.account.slug,
+		project: project.name,
+		buildNumber
+	} } });
+	if (error) {
+		if (response.status === 404) {
+			console.error(`Error: Build number ${errorLabel} not found.`);
+			process.exit(1);
+		}
+		throwAPIError(error);
+	}
+	if (!data) {
+		console.error("Error: Unexpected empty response from API.");
+		process.exit(1);
+	}
+	return data;
+}
+function buildCommand(program) {
+	const build = program.command("build").description("Manage Argos builds");
+	const createJsonOption = () => new Option("--json", "Output machine-readable JSON instead of human-readable text");
+	build.command("get").description("Fetch build metadata").argument("<buildReference>", "Build number or Argos build URL").addOption(tokenOption).addOption(createJsonOption()).action(async (buildReference, options) => {
+		const buildNumber = parseBuildReferenceOrExit(buildReference);
+		const client = createBuildsClient(options);
+		const build = await fetchBuildByNumber(client, await fetchProject(client), buildNumber, buildReference);
+		if (options.json) {
+			console.log(JSON.stringify(build, null, 2));
+			return;
+		}
+		printBuild(build);
+	});
+	build.command("snapshots").description("Fetch snapshot diffs for a build").argument("<buildReference>", "Build number or Argos build URL").option("--needs-review", "Only include snapshot diffs that require review").addOption(tokenOption).addOption(createJsonOption()).action(async (buildReference, options) => {
+		const buildNumber = parseBuildReferenceOrExit(buildReference);
+		const client = createBuildsClient(options);
+		const project = await fetchProject(client);
+		const build = await fetchBuildByNumber(client, project, buildNumber, buildReference);
+		if (isBuildPending(build)) {
+			if (options.json) {
+				console.error(`Error: Build #${build.number} is still processing (${build.status}). Try again in a moment.`);
+				process.exit(1);
+			}
+			console.log(`Build #${build.number} is still processing (${build.status}). Try again in a moment.`);
+			return;
+		}
+		const diffs = await fetchAllDiffs(client, project, build.number, { needsReview: Boolean(options.needsReview) });
+		if (options.json) {
+			console.log(JSON.stringify(diffs, null, 2));
+			return;
+		}
+		printSnapshots(diffs, build);
+	});
+}
+//#endregion
 //#region src/index.ts
 const rawPkg = await readFile(resolve(fileURLToPath(new URL(".", import.meta.url)), "..", "package.json"), "utf8");
 const pkg = JSON.parse(rawPkg);
@@ -98,6 +289,7 @@ program.name(pkg.name).description("Interact with and upload screenshots to Argo
 uploadCommand(program);
 skipCommand(program);
 finalizeCommand(program);
+buildCommand(program);
 if (!process.argv.slice(2).length) program.outputHelp();
 else program.parse(process.argv);
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/cli",
   "description": "Command-line (CLI) for visual testing with Argos.",
-  "version": "4.1.3",
+  "version": "4.1.5-alpha.2+3431e7d",
   "bin": {
     "argos": "./bin/argos-cli.js"
   },
@@ -34,17 +34,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/core": "5.1.3",
+    "@argos-ci/api-client": "0.17.1-alpha.2+3431e7d",
+    "@argos-ci/core": "5.2.1-alpha.2+3431e7d",
     "commander": "^14.0.3",
     "ora": "^9.3.0",
     "update-notifier": "^7.3.1"
   },
   "scripts": {
     "build": "tsdown",
-    "e2e": "node e2e/upload.js && node e2e/skip.js",
+    "e2e": "node e2e/upload.js && node e2e/skip.js && node e2e/build.js",
     "check-types": "tsc",
     "check-format": "prettier --check --ignore-unknown --ignore-path=../../.gitignore --ignore-path=../../.prettierignore .",
     "lint": "eslint ."
   },
-  "gitHead": "b49d186d5eb6e1338982a4cd5c3cb29e6cb0b7af"
+  "gitHead": "3431e7d43acf6b1f043b55e53dec32318cabcd4c"
 }