Add caching to the github workflows

.github/actions/restore-cache/action.yml

@@ -0,0 +1,119 @@
+name: Restore cached files
+description: Restores backend, vcpkg, and electron-builder from cache
+
+inputs:
+  backend:
+    description: Set to true to cache backend
+    required: false
+    default: 'false'
+
+outputs:
+  backend:
+    description: True if backend was restored from cache
+    value: ${{ steps.backend.outputs.cache-hit }}
+  afv-native:
+    description: True if libuiohook was restored from cache
+    value: ${{ steps.libuiohook.outputs.cache-hit }}
+  electron-builder:
+    description: True if electron-builder was restored from cache
+    value: ${{ steps.electron-builder.outputs.cache-hit }}
+  vcpkg:
+    description: True if vcpkg was restored from cache
+    value: ${{ steps.vcpkg.outputs.cache-hit }}
+
+runs:
+  using: 'composite'
+  steps:
+    # The cache folder for electron and electron-builder is different across the three platforms.
+    # Furthermore, the ELECTRON_CACHE and ELECTRON_BUILDER_CACHE environment variables don't work.
+    # So there has to be separate steps for the different platforms to set the proper cache locations,
+    # which were determined by looking at the code here:
+    # https://github.com/develar/app-builder/blob/c87157ae504895a7e9e1329437293846b8e57beb/pkg/download/artifactDownloader.go#L195
+    - name: Set Electron cache paths (macos and linux)
+      if: matrix.os != 'windows-2022'
+      shell: bash
+      run: |
+        if [[ "$RUNNER_OS" == "Linux" ]]; then
+          echo "ELECTRON_CACHE_DIR=$HOME/.cache/electron" >> $GITHUB_ENV
+          echo "ELECTRON_BUILDER_CACHE_DIR=$HOME/.cache/electron-builder" >> $GITHUB_ENV
+        elif [[ "$RUNNER_OS" == "macOS" ]]; then
+          echo "ELECTRON_CACHE_DIR=$HOME/Library/Caches/electron" >> $GITHUB_ENV
+          echo "ELECTRON_BUILDER_CACHE_DIR=$HOME/Library/Caches/electron-builder" >> $GITHUB_ENV
+        fi
+
+    - name: Set Electron cache paths (Windows)
+      if: matrix.os == 'windows-2022'
+      shell: pwsh
+      run: |
+        echo "ELECTRON_CACHE_DIR=$Env:LOCALAPPDATA\electron\Cache" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
+        echo "ELECTRON_BUILDER_CACHE_DIR=$Env:LOCALAPPDATA\electron-builder\Cache" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
+
+    # Get the afv-native submodule revision to use as the cache key for restoring afv-native.
+    - name: Get afv-native submodule revision
+      shell: bash
+      run: |
+        AFVNATIVE_REV=$(git rev-parse HEAD:./backend/extern/afv-native)
+        echo "AFVNATIVE_REV=$AFVNATIVE_REV" >> $GITHUB_ENV
+        echo "afv-native submodule revision $AFVNATIVE_REV"
+
+    # Get the libuiohook submodule revision to use as the cache key for restoring libuiohook.
+    - name: Get libuiohook submodule revision
+      shell: bash
+      run: |
+        LIBUIOHOOK_REV=$(git rev-parse HEAD:./backend/extern/libuiohook)
+        echo "LIBUIOHOOK_REV=$LIBUIOHOOK_REV" >> $GITHUB_ENV
+        echo "libuiohook submodule revision $LIBUIOHOOK_REV"
+
+    # Get the vcpkg submodule revision to use as the cache key for restoring vcpkg.
+    - name: Get vcpkg submodule revision
+      shell: bash
+      run: |
+        VCPKG_REV=$(git rev-parse HEAD:./backend/vcpkg)
+        echo "VCPKG_REV=$VCPKG_REV" >> $GITHUB_ENV
+        echo "vcpkg submodule revision $VCPKG_REV"
+
+    # The cache key for backend has to be constructed differently on windows vs
+    # macos/linux because hashFiles doesn't work on windows if you specify `backend/**`.
+    # backend is cached based on the SHA of backend and the hash of all files under
+    # backend/. The key is all the files under backend, the afv-native SHA, and libuiohook SHA.
+    - name: Set backend cache key (windows)
+      if: matrix.os == 'windows-2022'
+      shell: pwsh
+      run: echo "BACKEND_CACHE_KEY=${{ runner.os }}-backend-${{ hashFiles('backend\\**') }}-${{ env.AFVNATIVE_REV }}-${{ env.LIBUIOHOOK_REV }}" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+    - name: Set backend cache key (macos and linux)
+      if: matrix.os != 'windows-2022'
+      shell: bash
+      run: echo "BACKEND_CACHE_KEY=${{ runner.os }}-backend-${{ hashFiles('backend/**') }}-${{ env.AFVNATIVE_REV }}-${{ env.LIBUIOHOOK_REV }}" >> $GITHUB_ENV
+
+    - name: Restore electron-builder cache
+      id: electron-builder
+      uses: actions/cache@v4
+      with:
+        path: |
+          ${{ env.ELECTRON_CACHE_DIR }}
+          ${{ env.ELECTRON_BUILDER_CACHE_DIR }}
+        key: ${{ runner.os }}-electron-builder-${{ hashFiles('package-lock.json') }}
+
+    # The backend only gets cached if backend is set to 'true' when calling this composite
+    # action, currently only in the ci.yml flow. release.yml does not cache backend.
+    - name: Restore backend from cache
+      id: backend
+      uses: actions/cache@v4
+      if: ${{ inputs.backend }} == 'true'
+      with:
+        path: |
+          backend/trackaudio-afv-1.0.0.tgz
+        key: ${{ env.BACKEND_CACHE_KEY }}
+
+    # vcpkg only get restored if the backend cache wasn't found. That's because if the backend cache
+    # is found there's no native build at all, so no need to restore vcpkg for the native components.
+    - name: Restore vcpkg from cache
+      id: vcpkg
+      uses: actions/cache@v4
+      if: steps.backend.outputs.cache-hit != 'true'
+      with:
+        path: |
+          backend/vcpkg
+          backend/build/vcpkg_installed
+        key: ${{ runner.os }}-vcpkg-${{ hashFiles('backend/vcpkg.json')}}-${{ env.VCPKG_REV }}

.github/workflows/ci.yml

@@ -39,10 +39,17 @@ jobs:
           cd backend/extern/afv-native
           git checkout modern-chained-callback
 
+      - name: Restore cache
+        id: restore-cache
+        uses: ./.github/actions/restore-cache
+        with:
+          backend: 'true'
+
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'npm'
 
       - name: Install Python 3.x
         uses: actions/setup-python@v5
@@ -68,11 +75,15 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y libx11-dev libxrandr-dev libxcursor-dev libxi-dev libudev-dev libgl1-mesa-dev pkg-config libxtst-dev libxinerama-dev libx11-xcb-dev libxkbcommon-dev libxkbcommon-x11-dev libxkbfile-dev
 
-      - name: Install dependencies
+      - name: Build backend and install dependencies
+        if: steps.restore-cache.outputs.backend != 'true'
         run: |
           npm -g i cmake-js
           npm run build:backend
-          npm install
+
+      - name: Install cached backend and dependencies
+        if: steps.restore-cache.outputs.backend == 'true'
+        run: npm install ./backend/trackaudio-afv-1.0.0.tgz
 
       - name: Run eslint
         run: npm run lint

.github/workflows/release.yml

@@ -3,6 +3,10 @@ name: Release
 on:
   workflow_dispatch:
 
+env:
+  ELECTRON_CACHE: .cache/electron
+  ELECTRON_BUILDER_CACHE: .cache/electron-builder
+
 jobs:
   build:
     runs-on: ${{ matrix.os }}
@@ -31,15 +35,20 @@ jobs:
           cd backend/extern/afv-native
           git checkout modern-chained-callback
 
+      - name: Restore cache
+        id: restore-cache
+        uses: ./.github/actions/restore-cache
+
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: 'npm'
 
       - name: Install Python 3.x
         uses: actions/setup-python@v5
         with:
-          python-version: "3.11.x"
+          python-version: '3.11.x'
 
       - name: Update cmake
         if: matrix.os != 'macos-latest'
@@ -91,7 +100,7 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y desktop-file-utils ninja-build gcc-aarch64-linux-gnu:amd64 g++-aarch64-linux-gnu:amd64 python3-jinja2:amd64 libgcrypt20:arm64 libgcrypt20-dev:arm64 libgpg-error-dev:arm64 libx11-dev:arm64 libxrandr-dev:arm64 libxcursor-dev:arm64 libxi-dev:arm64 libudev-dev:arm64 libgl1-mesa-dev:arm64
 
-      - name: Install dependencies and building backend (x64)
+      - name: Build backend (x64)
         if: matrix.arch == 'x64'
         run: |
           npm -g i cmake-js
@@ -102,9 +111,8 @@ jobs:
           npm pack
           cd ..
           npm install ./backend/trackaudio-afv-1.0.0.tgz
-          npm install
 
-      - name: Install dependencies and building backend (macOs arm64)
+      - name: Build backend (macOs arm64)
         if: matrix.arch == 'arm64' && matrix.os == 'macos-latest'
         run: |
           npm -g i cmake-js
@@ -115,9 +123,8 @@ jobs:
           npm pack
           cd ..
           npm install ./backend/trackaudio-afv-1.0.0.tgz
-          npm install
 
-      - name: Install dependencies and building backend (linux arm64 cross compile)
+      - name: Build backend (linux arm64 cross compile)
         if: matrix.arch == 'arm64' && matrix.os == 'ubuntu-latest'
         run: |
           npm -g i cmake-js
@@ -128,7 +135,6 @@ jobs:
           npm pack
           cd ..
           npm install ./backend/trackaudio-afv-1.0.0.tgz
-          npm install
 
       - name: Package app
         if: matrix.os == 'windows-2022'
@@ -149,7 +155,7 @@ jobs:
         shell: bash
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          APPLE_API_KEY: "./.a.p8"
+          APPLE_API_KEY: './.a.p8'
           APPLE_API_KEY_ID: ${{ secrets.APPLE_API_KEY_ID }}
           APPLE_API_ISSUER: ${{ secrets.APPLE_API_ISSUER }}
         run: |
@@ -191,7 +197,7 @@ jobs:
         if: matrix.os == 'macos-latest'
         with:
           tag_name: ${{ steps.relinfo.outputs.release }}
-          files: "dist/*.dmg"
+          files: 'dist/*.dmg'
 
       - name: Upload artifacts
         uses: softprops/action-gh-release@v2