eas-build-cache-provider 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+# eas-build-cache-provider
+
+A build cache provider plugin for the Expo CLI

package/build/helpers.d.ts

@@ -0,0 +1,9 @@
+import { SpawnResult } from '@expo/spawn-async';
+type RunOptions = any;
+export declare function isSpawnResultError(obj: any): obj is Error & SpawnResult;
+export declare function isDevClientBuild({ runOptions, projectRoot, }: {
+    runOptions: RunOptions;
+    projectRoot: string;
+}): boolean;
+export declare function hasDirectDevClientDependency(projectRoot: string): boolean;
+export {};

package/build/helpers.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasDirectDevClientDependency = exports.isDevClientBuild = exports.isSpawnResultError = void 0;
+const config_1 = require("@expo/config");
+function isSpawnResultError(obj) {
+    return (obj &&
+        'message' in obj &&
+        obj.status !== undefined &&
+        obj.stdout !== undefined &&
+        obj.stderr !== undefined);
+}
+exports.isSpawnResultError = isSpawnResultError;
+function isDevClientBuild({ runOptions, projectRoot, }) {
+    if (!hasDirectDevClientDependency(projectRoot)) {
+        return false;
+    }
+    if ('variant' in runOptions && runOptions.variant !== undefined) {
+        return runOptions.variant === 'debug';
+    }
+    if ('configuration' in runOptions && runOptions.configuration !== undefined) {
+        return runOptions.configuration === 'Debug';
+    }
+    return true;
+}
+exports.isDevClientBuild = isDevClientBuild;
+function hasDirectDevClientDependency(projectRoot) {
+    const { dependencies = {}, devDependencies = {} } = (0, config_1.getPackageJson)(projectRoot);
+    return !!dependencies['expo-dev-client'] || !!devDependencies['expo-dev-client'];
+}
+exports.hasDirectDevClientDependency = hasDirectDevClientDependency;

package/build/index.d.ts

@@ -0,0 +1,3 @@
+type RemoteBuildCachePlugin = any;
+declare const EASRemoteBuildCacheProvider: RemoteBuildCachePlugin;
+export default EASRemoteBuildCacheProvider;

package/build/index.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const spawn_async_1 = tslib_1.__importDefault(require("@expo/spawn-async"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const helpers_1 = require("./helpers");
+const log_1 = tslib_1.__importDefault(require("./log"));
+async function resolveRemoteBuildCacheAsync({ projectRoot, platform, fingerprintHash, runOptions, }) {
+    const easJsonPath = path_1.default.join(projectRoot, 'eas.json');
+    if (!(await fs_extra_1.default.exists(easJsonPath))) {
+        log_1.default.debug('eas.json not found, skip checking for remote builds');
+        return null;
+    }
+    log_1.default.log((0, chalk_1.default) `{whiteBright \u203A} {bold Searching builds with matching fingerprint on EAS servers}`);
+    try {
+        const results = await (0, spawn_async_1.default)('npx', [
+            'eas-cli',
+            'build:download',
+            `--platform=${platform}`,
+            `--fingerprint=${fingerprintHash}`,
+            '--non-interactive',
+            (0, helpers_1.isDevClientBuild)({ runOptions, projectRoot }) ? '--dev-client' : '--no-dev-client',
+            '--json',
+        ], {
+            cwd: projectRoot,
+        });
+        log_1.default.log((0, chalk_1.default) `{whiteBright \u203A} {bold Successfully downloaded cached build}`);
+        // {
+        //   "path": "/var/folders/03/lppcpcnn61q3mz5ckzmzd8w80000gn/T/eas-cli-nodejs/eas-build-run-cache/c0f9ba9c-0cf1-4c5c-8566-b28b7971050f_22f1bbfa-1c09-4b67-9e4a-721906546b58.app"
+        // }
+        const json = JSON.parse(results.stdout.trim());
+        return json?.path;
+    }
+    catch (error) {
+        log_1.default.debug('eas-cli error:', error);
+        // @TODO(2025-04-11): remove this in a future release
+        if ((0, helpers_1.isSpawnResultError)(error) && error.stderr.includes('command build:download not found')) {
+            log_1.default.warn(`To take advantage of remote build cache, upgrade your eas-cli installation to latest.`);
+        }
+        return null;
+    }
+}
+async function uploadEASRemoteBuildCacheAsync({ projectRoot, platform, fingerprintHash, buildPath, }) {
+    const easJsonPath = path_1.default.join(projectRoot, 'eas.json');
+    if (!(await fs_extra_1.default.exists(easJsonPath))) {
+        log_1.default.debug('eas.json not found, skip uploading builds');
+        return null;
+    }
+    try {
+        log_1.default.log((0, chalk_1.default) `{whiteBright \u203A} {bold Uploading build to remote cache}`);
+        const results = await (0, spawn_async_1.default)('npx', [
+            'eas-cli',
+            'upload',
+            `--platform=${platform}`,
+            `--fingerprint=${fingerprintHash}`,
+            buildPath ? `--build-path=${buildPath}` : '',
+            '--non-interactive',
+            '--json',
+        ], {
+            cwd: projectRoot,
+        });
+        // {
+        //   "url": "/var/folders/03/lppcpcnn61q3mz5ckzmzd8w80000gn/T/eas-cli-nodejs/eas-build-run-cache/c0f9ba9c-0cf1-4c5c-8566-b28b7971050f_22f1bbfa-1c09-4b67-9e4a-721906546b58.app"
+        // }
+        const json = JSON.parse(results.stdout.trim());
+        log_1.default.log((0, chalk_1.default) `{whiteBright \u203A} {bold Build successfully uploaded: ${json?.url}}`);
+        return json?.url;
+    }
+    catch (error) {
+        log_1.default.debug('eas-cli error:', error);
+    }
+    return null;
+}
+async function calculateEASFingerprintHashAsync({ projectRoot, platform, }) {
+    // prefer using `eas fingerprint:generate` because it automatically upload sources
+    try {
+        const results = await (0, spawn_async_1.default)('npx', ['eas-cli', 'fingerprint:generate', `--platform=${platform}`, '--json', '--non-interactive'], {
+            cwd: projectRoot,
+        });
+        // {
+        //   "hash": "203f960b965e154b77dc31c6c42e5582e8d77196"
+        // }
+        const json = JSON.parse(results.stdout.trim());
+        return json?.hash;
+    }
+    catch (error) {
+        log_1.default.debug('eas-cli error:', error);
+    }
+    return null;
+}
+const EASRemoteBuildCacheProvider = {
+    resolveRemoteBuildCache: resolveRemoteBuildCacheAsync,
+    uploadRemoteBuildCache: uploadEASRemoteBuildCacheAsync,
+    calculateFingerprintHash: calculateEASFingerprintHashAsync,
+};
+exports.default = EASRemoteBuildCacheProvider;

package/build/log.d.ts

@@ -0,0 +1,40 @@
+export default class Log {
+    static readonly isDebug: boolean;
+    static log(...args: any[]): void;
+    static newLine(): void;
+    static addNewLineIfNone(): void;
+    static error(...args: any[]): void;
+    static warn(...args: any[]): void;
+    static debug(...args: any[]): void;
+    static gray(...args: any[]): void;
+    static warnDeprecatedFlag(flag: string, message: string): void;
+    static fail(message: string): void;
+    static succeed(message: string): void;
+    static withTick(...args: any[]): void;
+    static withInfo(...args: any[]): void;
+    private static consoleLog;
+    private static withTextColor;
+    private static isLastLineNewLine;
+    private static updateIsLastLineNewLine;
+}
+/**
+ * Prints a link for given URL, using text if provided, otherwise text is just the URL.
+ * Format links as dim (unless disabled) and with an underline.
+ *
+ * @example https://expo.dev
+ */
+export declare function link(url: string, { text, fallback, dim }?: {
+    text?: string;
+    dim?: boolean;
+    fallback?: string;
+}): string;
+/**
+ * Provide a consistent "Learn more" link experience.
+ * Format links as dim (unless disabled) with an underline.
+ *
+ * @example Learn more: https://expo.dev
+ */
+export declare function learnMore(url: string, { learnMoreMessage: maybeLearnMoreMessage, dim, }?: {
+    learnMoreMessage?: string;
+    dim?: boolean;
+}): string;

package/build/log.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.learnMore = exports.link = void 0;
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const figures_1 = tslib_1.__importDefault(require("figures"));
+const getenv_1 = require("getenv");
+const log_symbols_1 = tslib_1.__importDefault(require("log-symbols"));
+const terminal_link_1 = tslib_1.__importDefault(require("terminal-link"));
+class Log {
+    static isDebug = (0, getenv_1.boolish)('EXPO_DEBUG', false);
+    static log(...args) {
+        Log.consoleLog(...args);
+    }
+    static newLine() {
+        Log.consoleLog();
+    }
+    static addNewLineIfNone() {
+        if (!Log.isLastLineNewLine) {
+            Log.newLine();
+        }
+    }
+    static error(...args) {
+        Log.consoleLog(...Log.withTextColor(args, chalk_1.default.red));
+    }
+    static warn(...args) {
+        Log.consoleLog(...Log.withTextColor(args, chalk_1.default.yellow));
+    }
+    static debug(...args) {
+        if (Log.isDebug) {
+            Log.consoleLog(...args);
+        }
+    }
+    static gray(...args) {
+        Log.consoleLog(...Log.withTextColor(args, chalk_1.default.gray));
+    }
+    static warnDeprecatedFlag(flag, message) {
+        Log.warn(`› ${chalk_1.default.bold('--' + flag)} flag is deprecated. ${message}`);
+    }
+    static fail(message) {
+        Log.log(`${chalk_1.default.red(log_symbols_1.default.error)} ${message}`);
+    }
+    static succeed(message) {
+        Log.log(`${chalk_1.default.green(log_symbols_1.default.success)} ${message}`);
+    }
+    static withTick(...args) {
+        Log.consoleLog(chalk_1.default.green(figures_1.default.tick), ...args);
+    }
+    static withInfo(...args) {
+        Log.consoleLog(chalk_1.default.green(figures_1.default.info), ...args);
+    }
+    static consoleLog(...args) {
+        Log.updateIsLastLineNewLine(args);
+        // eslint-disable-next-line no-console
+        console.log(...args);
+    }
+    static withTextColor(args, chalkColor) {
+        return args.map(arg => chalkColor(arg));
+    }
+    static isLastLineNewLine = false;
+    static updateIsLastLineNewLine(args) {
+        if (args.length === 0) {
+            Log.isLastLineNewLine = true;
+        }
+        else {
+            const lastArg = args[args.length - 1];
+            if (typeof lastArg === 'string' && (lastArg === '' || lastArg.match(/[\r\n]$/))) {
+                Log.isLastLineNewLine = true;
+            }
+            else {
+                Log.isLastLineNewLine = false;
+            }
+        }
+    }
+}
+exports.default = Log;
+/**
+ * Prints a link for given URL, using text if provided, otherwise text is just the URL.
+ * Format links as dim (unless disabled) and with an underline.
+ *
+ * @example https://expo.dev
+ */
+function link(url, { text = url, fallback, dim = true } = {}) {
+    // Links can be disabled via env variables https://github.com/jamestalmage/supports-hyperlinks/blob/master/index.js
+    const output = (0, terminal_link_1.default)(text, url, {
+        fallback: () => fallback ?? (text === url ? chalk_1.default.underline(url) : `${text}: ${chalk_1.default.underline(url)}`),
+    });
+    return dim ? chalk_1.default.dim(output) : output;
+}
+exports.link = link;
+/**
+ * Provide a consistent "Learn more" link experience.
+ * Format links as dim (unless disabled) with an underline.
+ *
+ * @example Learn more: https://expo.dev
+ */
+function learnMore(url, { learnMoreMessage: maybeLearnMoreMessage, dim = true, } = {}) {
+    return link(url, { text: maybeLearnMoreMessage ?? 'Learn more', dim });
+}
+exports.learnMore = learnMore;

package/build/types.js

@@ -0,0 +1 @@
+"use strict";

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "eas-build-cache-provider",
+  "description": "A build cache provider plugin for the Expo CLI",
+  "version": "0.0.1",
+  "author": "Expo <support@expo.dev>",
+  "bugs": "https://github.com/expo/eas-cli/issues",
+  "dependencies": {
+    "@babel/code-frame": "7.23.5",
+    "@expo/config-plugins": "9.0.12",
+    "@expo/spawn-async": "^1.7.2",
+    "chalk": "4.1.2",
+    "fs-extra": "11.2.0",
+    "log-symbols": "4.1.0",
+    "semver": "7.5.2",
+    "terminal-link": "2.1.1",
+    "tslib": "2.4.1"
+  },
+  "devDependencies": {
+    "@tsconfig/node18": "18.2.4",
+    "@types/babel__code-frame": "7.0.3",
+    "@types/fs-extra": "11.0.4",
+    "memfs": "3.4.13",
+    "rimraf": "3.0.2",
+    "typescript": "5.3.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "homepage": "https://github.com/expo/eas-cli",
+  "license": "MIT",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "repository": "expo/eas-cli",
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "build-allow-unused": "tsc --project tsconfig.allowUnused.json",
+    "watch": "yarn build --watch --preserveWatchOutput",
+    "watch-allow-unused": "yarn build-allow-unused --watch --preserveWatchOutput",
+    "typecheck": "tsc",
+    "prepack": "yarn rebuild",
+    "rebuild": "rimraf build && yarn build",
+    "test": "jest",
+    "clean": "rimraf build node_modules yarn-error.log"
+  },
+  "files": [
+    "/build"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "volta": {
+    "node": "20.11.0",
+    "yarn": "1.22.21"
+  }
+}