feat: remote (and local) build caching

CONTRIBUTING.md

@@ -93,6 +93,8 @@ NPM_CONFIG_REGISTRY=http://localhost:4873 pnpm create @rnef/app --registry http:
 # Then use pnpm install with registry
 echo "node-linker=hoisted" > .npmrc
 NPM_CONFIG_REGISTRY=http://localhost:4873 pnpm install
+# Then link packages (see above)
+pnpm link --global ... 
 
 # Clean up
 pnpm verdaccio-reset

nx.json

@@ -26,6 +26,12 @@
           "outDir": "packages/{projectRoot}/dist"
         }
       }
+    },
+    "publish:npm": {
+      "dependsOn": ["build"]
+    },
+    "verdaccio:publish": {
+      "dependsOn": ["build"]
     }
   },
   "release": {

package.json

@@ -12,6 +12,7 @@
     "typecheck": "nx run-many --target typecheck",
     "watch": "nx watch --all -- nx run \\$NX_PROJECT_NAME:build",
     "link-packages": "node ./scripts/linkPackages.mjs",
+    "publish:npm": "./scripts/npm-publish.sh",
     "verdaccio:init": "node ./scripts/verdaccio-init.mjs",
     "verdaccio:publish": "node ./scripts/verdaccio-publish.mjs",
     "verdaccio:reset": "./scripts/verdaccio-reset.sh"

packages/cli/package.json

@@ -11,6 +11,7 @@
   },
   "scripts": {
     "clean-dist": "rm -f dist/package.json",
+    "publish:npm": "npm publish --access restricted",
     "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
   },
   "dependencies": {
@@ -23,5 +24,8 @@
   },
   "devDependencies": {
     "@react-native-community/cli-types": "^16.0.2"
+  },
+  "publishConfig": {
+    "access": "restricted"
   }
 }

packages/cli/src/lib/commands/fingerprint.ts

@@ -17,7 +17,7 @@ export async function nativeFingerprintCommand(
   path = path ?? '.';
   const platform = options?.platform ?? 'ios';
   const loader = spinner();
-  logger.debug(`Fingerprinting "${resolveAbsolutePath(path)}"...`);
+  logger.debug(`Fingerprinting "${resolveAbsolutePath(path)}".`);
 
   let start = 0;
   if (logger.isVerbose()) {

packages/config/package.json

@@ -8,9 +8,13 @@
   },
   "scripts": {
     "clean-dist": "rm -f dist/package.json",
+    "publish:npm": "npm publish --access restricted",
     "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
   },
   "dependencies": {
     "tslib": "^2.3.0"
+  },
+  "publishConfig": {
+    "access": "restricted"
   }
 }

packages/create-app/package.json

@@ -11,6 +11,7 @@
   ],
   "scripts": {
     "clean-dist": "rm -f dist/package.json",
+    "publish:npm": "npm publish --access restricted",
     "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc",
     "e2e": "vitest --config vite.e2e.config.js"
   },
@@ -30,5 +31,8 @@
     "@rnef/test-helpers": "^0.0.1",
     "@types/gradient-string": "^1.1.6",
     "@types/minimist": "^1.2.5"
+  },
+  "publishConfig": {
+    "access": "restricted"
   }
 }

packages/create-app/src/lib/utils/package-json.ts

@@ -30,6 +30,8 @@ export function rewritePackageJson(projectPath: string, packageName: string) {
   packageJson.version = '1.0.0';
   packageJson.private = true;
 
+  delete packageJson.publishConfig;
+
   if (packageJson.dependencies) {
     packageJson.dependencies = Object.fromEntries(
       Object.entries(packageJson.dependencies).sort()

packages/plugin-metro/package.json

@@ -13,6 +13,7 @@
   ],
   "scripts": {
     "clean-dist": "rm -f dist/package.json",
+    "publish:npm": "npm publish --access restricted",
     "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
   },
   "dependencies": {
@@ -23,5 +24,8 @@
   },
   "devDependencies": {
     "@rnef/config": "^0.0.1"
+  },
+  "publishConfig": {
+    "access": "restricted"
   }
 }

packages/plugin-platform-android/package.json

@@ -14,6 +14,7 @@
   ],
   "scripts": {
     "clean-dist": "rm -f dist/package.json",
+    "publish:npm": "npm publish --access restricted",
     "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
   },
   "dependencies": {
@@ -28,5 +29,8 @@
   "devDependencies": {
     "@react-native-community/cli-types": "^16.0.2",
     "@rnef/config": "^0.0.1"
+  },
+  "publishConfig": {
+    "access": "restricted"
   }
 }

packages/plugin-platform-android/src/lib/commands/listAndroidTasks.ts

@@ -59,7 +59,7 @@ export const promptForTaskSelection = async (
 ): Promise<string> => {
   const tasks = await getGradleTasks(taskType, sourceDir);
   if (!tasks.length) {
-    throw new Error(`No actionable ${taskType} tasks were found...`);
+    throw new Error(`No actionable ${taskType} tasks were found.`);
   }
   const task = checkCancelPrompt<string>(
     await select({

packages/plugin-platform-android/src/lib/commands/runAndroid/runAndroid.ts

@@ -3,7 +3,18 @@ import {
   AndroidProjectConfig,
   Config,
 } from '@react-native-community/cli-types';
-import { checkCancelPrompt, logger } from '@rnef/tools';
+import {
+  checkCancelPrompt,
+  downloadGitHubArtifact,
+  fetchGitHubArtifactsByName,
+  getProjectRoot,
+  hasGitHubToken,
+  logger,
+  nativeFingerprint,
+} from '@rnef/tools';
+import { log, outro, select, spinner } from '@clack/prompts';
+import color from 'picocolors';
+import isInteractive from 'is-interactive';
 import { getDevices } from './adb.js';
 import { toPascalCase } from '../toPascalCase.js';
 import { tryLaunchAppOnDevice } from './tryLaunchAppOnDevice.js';
@@ -14,8 +25,6 @@ import path from 'path';
 import { BuildFlags, options } from '../buildAndroid/buildAndroid.js';
 import { promptForTaskSelection } from '../listAndroidTasks.js';
 import { runGradle } from '../runGradle.js';
-import { outro, select } from '@clack/prompts';
-import isInteractive from 'is-interactive';
 
 export interface Flags extends BuildFlags {
   appId: string;
@@ -48,6 +57,17 @@ export async function runAndroid(
     ? [await promptForTaskSelection(mainTaskType, androidProject.sourceDir)]
     : [...(args.tasks ?? []), `${mainTaskType}${toPascalCase(args.mode)}`];
 
+  if (!args.binaryPath) {
+    const cachedBuild = await fetchCachedBuild(
+      androidProject.sourceDir,
+      args.mode
+    );
+    if (cachedBuild) {
+      // @todo replace with a more generic way to pass binary path
+      args.binaryPath = cachedBuild.artifactPath;
+    }
+  }
+
   if (deviceId) {
     await runGradle({ tasks, androidProject, args });
     if (!(await getDevices()).find((d) => d === deviceId)) {
@@ -64,21 +84,72 @@ export async function runAndroid(
         await selectAndLaunchDevice();
       } else {
         logger.debug(
-          'No booted devices or emulators found. Launching first available mulator...'
+          'No booted devices or emulators found. Launching first available mulator.'
         );
         await tryLaunchEmulator();
       }
     }
 
-    await runGradle({ tasks, androidProject, args });
+    if (!args.binaryPath) {
+      await runGradle({ tasks, androidProject, args });
+    }
 
     for (const device of await getDevices()) {
+      if (args.binaryPath) {
+        await tryInstallAppOnDevice(device, androidProject, args, tasks);
+      }
       await tryLaunchAppOnDevice(device, androidProject, args);
     }
   }
   outro('Success 🎉.');
 }
 
+export type CachedBuild = {
+  fingerprint: string;
+  artifactName: string;
+  artifactPath: string;
+};
+
+// TODO: pass relevant build variables
+async function fetchCachedBuild(
+  sourceDir: string,
+  mode: string
+): Promise<CachedBuild | null> {
+  const loader = spinner();
+  loader.start('Checking for cached build');
+
+  if (!hasGitHubToken()) {
+    loader.stop('No GitHub token found, skipping cached build.');
+    log.warn(
+      'Please set GITHUB_TOKEN environment variable to use cached builds.'
+    );
+    return null;
+  }
+
+  const root = getProjectRoot();
+  loader.message('Calculating fingerprint');
+  const fingerprint = await nativeFingerprint(root, { platform: 'android' });
+
+  loader.message('Querying cached build');
+  const artifactName = `app-${mode}-${fingerprint.hash}.apk`;
+  const artifacts = await fetchGitHubArtifactsByName(artifactName);
+  if (artifacts.length === 0) {
+    loader.stop(`No cached build found for hash ${fingerprint.hash}.`);
+    return null;
+  }
+
+  loader.message('Downloading cached build');
+  const cachePath = path.join(sourceDir, 'build/cache');
+  const artifactPath = await downloadGitHubArtifact(artifacts[0], cachePath);
+  loader.stop(`Downloaded cached build to: ${color.cyan(artifactPath)}`);
+
+  return {
+    fingerprint: fingerprint.hash,
+    artifactName,
+    artifactPath,
+  };
+}
+
 async function selectAndLaunchDevice() {
   const allDevices = await listAndroidDevices();
   const device = await promptForDeviceSelection(allDevices);

packages/plugin-platform-android/src/lib/commands/runAndroid/tryInstallAppOnDevice.ts

@@ -37,7 +37,7 @@ export async function tryInstallAppOnDevice(
 
   const adbPath = getAdbPath();
   const loader = spinner();
-  loader.start(`Installing the app on "${device}"...`);
+  loader.start(`Installing the app on "${device}"`);
   const { stderr } = await spawn(adbPath, adbArgs, {
     stdio: ['ignore', 'ignore', 'pipe'],
   });

packages/plugin-platform-android/src/lib/commands/runAndroid/tryLaunchAppOnDevice.ts

@@ -46,7 +46,7 @@ export async function tryLaunchAppOnDevice(
   const adbPath = getAdbPath();
   logger.debug(`Running ${adbPath} ${adbArgs.join(' ')}.`);
   const loader = spinner();
-  loader.start(`Installing the app on "${device}"...`);
+  loader.start(`Installing the app on "${device}"`);
   const { stderr } = await spawn(adbPath, adbArgs, {
     stdio: ['ignore', 'ignore', 'pipe'],
   });

packages/plugin-platform-android/src/lib/commands/runGradle.ts

@@ -5,15 +5,17 @@ import spawn from 'nano-spawn';
 import type { BuildFlags } from './buildAndroid/buildAndroid.js';
 import { spinner } from '@clack/prompts';
 
+export type RunGradleArgs = {
+  tasks: string[];
+  androidProject: AndroidProject;
+  args: BuildFlags | Flags;
+};
+
 export async function runGradle({
   tasks,
   androidProject,
   args,
-}: {
-  tasks: string[];
-  androidProject: AndroidProject;
-  args: BuildFlags | Flags;
-}) {
+}: RunGradleArgs) {
   if ('binaryPath' in args) {
     return;
   }

packages/plugin-platform-android/template/.github/actions/rnef-remote-build-android/action.yml

@@ -34,7 +34,7 @@ runs:
       id: fingerprint
       uses: ./.github/actions/rnef-native-fingerprint
       with:
-        platforms: android
+        platform: android
 
     - name: Find artifact URL
       id: cached-url
@@ -43,7 +43,7 @@ runs:
         name: ${{inputs.artifact-name-prefix}}-${{ steps.fingerprint.outputs.hash}}.${{inputs.artifact-name-extension}}
 
     - name: Post Cached Build (if found)
-      if: steps.cached-url.outputs.artifact-url
+      if: ${{ steps.cached-url.outputs.artifact-url && github.event_name == 'pull_request' }}
       uses: ./.github/actions/rnef-post-build
       with:
         platform: Android
@@ -65,10 +65,10 @@ runs:
       if: ${{ !steps.cached-url.outputs.artifact-url }}
       run: |
         cd android
-        pnpm rnef build:android --tasks assembleDebug
+        npx rnef build:android --tasks assembleDebug
       shell: bash
 
-    - name: Upload APK
+    - name: Upload Artifact
       id: upload-artifact
       if: ${{ !steps.cached-url.outputs.artifact-url }}
       uses: actions/upload-artifact@v4
@@ -78,7 +78,7 @@ runs:
         if-no-files-found: error
 
     - name: Post Build
-      if: ${{ !steps.cached-url.outputs.artifact-url }}
+      if: ${{ !steps.cached-url.outputs.artifact-url && github.event_name == 'pull_request' }}
       uses: ./.github/actions/rnef-post-build
       with:
         platform: Android

packages/plugin-platform-android/template/.github/workflows/remote-build-android.yml

@@ -27,7 +27,11 @@ jobs:
           cache: 'npm'
 
       - name: Install dependencies
-        run: npm install
+        run: |
+          # Remove next line after public release
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
+          npm install
 
       - name: RNEF Remote Build - Android
         uses: ./.github/actions/rnef-remote-build-android
+

packages/plugin-platform-apple/package.json

@@ -12,6 +12,7 @@
   ],
   "scripts": {
     "clean-dist": "rm -f dist/package.json",
+    "publish:npm": "npm publish --access restricted",
     "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
   },
   "dependencies": {
@@ -27,5 +28,8 @@
   },
   "devDependencies": {
     "@rnef/config": "^0.0.1"
+  },
+  "publishConfig": {
+    "access": "restricted"
   }
 }

packages/plugin-platform-ios/package.json

@@ -14,6 +14,7 @@
   ],
   "scripts": {
     "clean-dist": "rm -f dist/package.json",
+    "publish:npm": "npm publish --access restricted",
     "publish:verdaccio": "npm publish --registry http://localhost:4873 --userconfig ../../.npmrc"
   },
   "dependencies": {
@@ -23,5 +24,8 @@
   },
   "devDependencies": {
     "@rnef/config": "^0.0.1"
+  },
+  "publishConfig": {
+    "access": "restricted"
   }
 }