From 8997ab0812164aee2cad02be900f4bb43b278d50 Mon Sep 17 00:00:00 2001
From: JJ Kasper <jj@jjsweb.site>
Date: Sat, 26 Aug 2023 18:54:14 -0700
Subject: [PATCH] Implement granular rust caching (#54582)

This fixes our caching for the docker builds as they were missing inputs
the other jobs had also enables caching the rust target cache which
improves build times when only changing our package and the lockfile
isn't invalidated.

Tested here https://github.com/vercel/next.js/actions/runs/5987764387
---
 .github/workflows/build_and_deploy.yml |  7 ++++
 .github/workflows/build_reusable.yml   | 12 +++++++
 scripts/pull-turbo-cache.js            | 50 +++++++++++++++++++++-----
 turbo.json                             |  8 +++++
 4 files changed, 69 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/build_and_deploy.yml b/.github/workflows/build_and_deploy.yml
index 45a57ae29e4ca..d02156a4f8b7f 100644
--- a/.github/workflows/build_and_deploy.yml
+++ b/.github/workflows/build_and_deploy.yml
@@ -268,6 +268,13 @@ jobs:
         run: ${{ matrix.settings.setup }}
         if: ${{ matrix.settings.setup }}
 
+      - name: Cache on ${{ github.ref_name }}
+        uses: ijjk/rust-cache@turbo-cache-v1.0.7
+        with:
+          shared-key: build-${{ matrix.settings.target }}
+          save-if: 'true'
+          cache-provider: 'turbo'
+
       # we only need custom caching for docker builds
       # as they are on an older Node.js version and have
       # issues with turbo caching
diff --git a/.github/workflows/build_reusable.yml b/.github/workflows/build_reusable.yml
index 9bf8e93fae08f..40102b1031581 100644
--- a/.github/workflows/build_reusable.yml
+++ b/.github/workflows/build_reusable.yml
@@ -49,6 +49,10 @@ on:
         required: false
         description: 'if test trace needs uploading'
         type: string
+      rustCacheKey:
+        required: false
+        description: 'rustCacheKey to cache shared target assets'
+        type: string
 
 env:
   NAPI_CLI_VERSION: 2.14.7
@@ -114,6 +118,14 @@ jobs:
 
       - run: corepack prepare --activate yarn@1.22.19 && npm i -g "turbo@${TURBO_VERSION}" "@napi-rs/cli@${NAPI_CLI_VERSION}"
 
+      - name: Cache on ${{ github.ref_name }}
+        uses: ijjk/rust-cache@turbo-cache-v1.0.7
+        if: ${{ inputs.rustCacheKey }}
+        with:
+          shared-key: ${{ inputs.rustCacheKey }}-x86_64-unknown-linux-gnu
+          save-if: ${{ github.ref_name == 'canary' }}
+          cache-provider: 'turbo'
+
       # clean up any previous artifacts to avoid hitting disk space limits
       - run: git clean -xdf && rm -rf /tmp/next-repo-*; rm -rf /tmp/next-install-* /tmp/yarn-* /tmp/ncc-cache target
 
diff --git a/scripts/pull-turbo-cache.js b/scripts/pull-turbo-cache.js
index 45486139db0c2..919618a347f61 100644
--- a/scripts/pull-turbo-cache.js
+++ b/scripts/pull-turbo-cache.js
@@ -1,14 +1,35 @@
 #!/usr/bin/env node
 // @ts-check
 
-const { execSync } = require('child_process')
+const { spawn } = require('child_process')
 
 ;(async function () {
   const target = process.argv[process.argv.length - 1]
 
-  const turboResult = execSync(
-    `pnpm turbo run cache-build-native --dry=json -- ${target}`
-  ).toString()
+  let turboResult = ''
+
+  await new Promise((resolve, reject) => {
+    const child = spawn(
+      '/bin/bash',
+      ['-c', `pnpm turbo run cache-build-native --dry=json -- ${target}`],
+      {
+        stdio: 'pipe',
+      }
+    )
+
+    child.stdout.on('data', (data) => {
+      turboResult += data.toString()
+    })
+
+    child.on('exit', (code, signal) => {
+      if (code || signal) {
+        return reject(
+          new Error(`invalid exit code ${code} or signal ${signal}`)
+        )
+      }
+      resolve(0)
+    })
+  })
 
   const turboData = JSON.parse(turboResult)
 
@@ -21,10 +42,23 @@ const { execSync } = require('child_process')
 
   // pull cache if it was available
   if (task.cache.local || task.cache.remote) {
-    const pullResult = execSync(
-      `pnpm turbo run cache-build-native -- ${target}`
-    ).toString()
-    console.log(pullResult)
+    await new Promise((resolve, reject) => {
+      const child = spawn(
+        '/bin/bash',
+        ['-c', `pnpm turbo run cache-build-native -- ${target}`],
+        {
+          stdio: 'inherit',
+        }
+      )
+      child.on('exit', (code, signal) => {
+        if (code || signal) {
+          return reject(
+            new Error(`invalid exit code ${code} or signal ${signal}`)
+          )
+        }
+        resolve(0)
+      })
+    })
   } else {
     console.warn(`No turbo cache was available, continuing...`)
     console.warn(task)
diff --git a/turbo.json b/turbo.json
index b47d68773dd46..61e3698a76128 100644
--- a/turbo.json
+++ b/turbo.json
@@ -74,6 +74,14 @@
       "outputs": ["crates/wasm/pkg/*"]
     },
     "cache-build-native": {
+      "inputs": [
+        "../../.cargo/**",
+        "../../packages/next-swc/crates/**",
+        "../../**/Cargo.toml",
+        "../../**/Cargo.lock",
+        "../../.github/workflows/build_and_deploy.yml",
+        "../../rust-toolchain"
+      ],
       "dependsOn": ["^cache-build-native"],
       "outputs": ["native/*.node"]
     },