Fixing the cache situation

.github/workflows/bench.yml

@@ -1,10 +1,5 @@
 name: Benchmark
 
-# See: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency.
-concurrency:
-  group: ${{ github.head_ref }}-${{ github.workflow }}
-  cancel-in-progress: true
-
 on:
   pull_request:
     branches:
@@ -31,6 +26,7 @@ jobs:
       fail-fast: false
       matrix:
         ghc: ['8.10.7']
+        cabal: ["3.6"]
         os: [ubuntu-latest]
 
     steps:
@@ -39,24 +35,57 @@ jobs:
     - run: git fetch origin master # check the master branch for benchmarking
 
     - uses: haskell/actions/setup@v1
+      id: HaskEnvSetup
       with:
         ghc-version: ${{ matrix.ghc }}
-        cabal-version: '3.2'
+        cabal-version: ${{ matrix.cabal }}
         enable-stack: false
 
-    - name: Cache Cabal
+    - if: ( runner.os == 'Linux' ) || ( runner.os == 'macOS' )
+      name: (Linux,macOS) Platform config
+      run: |
+        echo "CABAL_PKGS_DIR=~/.cabal/packages" >> $GITHUB_ENV
+
+    # Needs to be before Cache Cabal so the cache can detect changes to the modified cabal.project file
+    - if: matrix.ghc == '9.0.1'
+      name: (GHC 9.0.1) Use modified `cabal.project`
+      run: cp cabal-ghc901.project cabal.project
+
+    - name: Retrieving `cabal.project` Hackage timestamp
+      run: |
+        # Form: index-state: 2021-11-29T08:11:08Z
+        INDEX_STATE_ENTRY=$(grep index-state cabal.project)
+        # Form: 2021-11-29T08-11-08Z
+        INDEX_STATE1=$(echo "$INDEX_STATE_ENTRY" | cut -d' ' -f2 | tr ':' '-')
+        echo "INDEX_STATE=$INDEX_STATE1" >> $GITHUB_ENV
+
+    # 2021-12-02: NOTE: Cabal Hackage source tree storage does not depend on OS or GHC really,
+    # but can depend on `base`.
+    # But this caching is happens only inside `master` for `master` purposes of compiling the deps
+    # so having a shared pool here that depends only on Hackage pin & does not depend on `base` is "good enough"
+    # & used such because it preserves 10% of a global cache storage pool.
+    - name: Hackage sources cache
       uses: actions/cache@v2
+      env:
+        cache-name: hackage-sources
       with:
-        path: |
-          ~/.cabal/packages
-          ~/.cabal/store
-        key: v2-${{ runner.os }}-${{ matrix.ghc }}-bench-${{ hashFiles('cabal.project') }}
+        path: ${{ env.CABAL_PKGS_DIR }}
+        key:          ${{ env.cache-name }}-${{ env.INDEX_STATE }}
+        restore-keys: ${{ env.cache-name }}-
+
+    - name: Compiled deps cache
+      uses: actions/cache@v2
+      env:
+        cache-name: compiled-deps
+      with:
+        path: ${{ steps.HaskEnvSetup.outputs.cabal-store }}
+        key:  ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-${{ env.INDEX_STATE }}-${{ hashFiles('cabal.project') }}
         restore-keys: |
-            v2-${{ runner.os }}-${{ matrix.ghc }}-build-${{ hashFiles('cabal.project') }}
-            v2-${{ runner.os }}-${{ matrix.ghc }}-bench-
-            v2-${{ runner.os }}-${{ matrix.ghc }}
+              ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-${{ env.INDEX_STATE }}-
+              ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-
+              ${{ env.cache-name }}-${{ runner.os }}-
 
-    - run: cabal update
+    - run: cabal v2-update
 
     # max-backjumps is increased as a temporary solution
     # for dependency resolution failure

.github/workflows/build.yml

@@ -18,7 +18,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ghc: ['9.0.1', '8.10.7', '8.10.6', '8.10.5', '8.8.4', '8.8.3', '8.6.5']
+        ghc: ['9.0.1', '8.10.7', '8.10.6', '8.8.4', '8.8.3', '8.6.5']
+        cabal: ["3.6"]
         os: [ubuntu-18.04, macOS-latest, windows-latest]
         exclude:
           - os: windows-latest
@@ -31,7 +32,7 @@ jobs:
     - uses: haskell/actions/setup@v1
       with:
         ghc-version: ${{ matrix.ghc }}
-        cabal-version: '3.4'
+        cabal-version: ${{ matrix.cabal }}
 
     - name: Use modified cabal.project for ghc9
       if: ${{ matrix.ghc == '9.0.1' }}
@@ -68,12 +69,6 @@ jobs:
       run: |
         echo "GHC_VERSION=$GHC_VER" >> $GITHUB_ENV
 
-    - name: Workaround for GHC 8.10.5 on macOS
-      if: matrix.os == 'macOS-latest' && matrix.ghc == '8.10.5'
-      run: |
-        echo "# uninstalling CommandLineTools (see https://github.com/haskell/haskell-language-server/issues/1913#issuecomment-861667786)"
-        sudo rm -rf /Library/Developer/CommandLineTools
-
     - name: Modify cabal.project to workaround segfaults for ghc-8.8.4 and windows
       if: matrix.ghc == '8.8.4' && matrix.os == 'windows-latest'
       run: |

.github/workflows/cache.yml

@@ -0,0 +1,129 @@
+name: Caching
+
+#  2021-11-30: NOTE: This workflow currently a trimmed copy of a main `test.yml` workflow. Workflows need further deduplication: https://docs.github.com/en/actions/learn-github-actions/reusing-workflows#overview
+
+defaults:
+  run:
+    shell: bash
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - '**'
+
+env:
+  cabalBuild: "v2-build all --enable-tests --enable-benchmarks"
+
+jobs:
+
+  caches:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ghc: ["9.0.1", '8.10.7', '8.10.6', "8.8.4", "8.8.3", "8.6.5"]
+        cabal: ["3.6"]
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+        exclude:
+          - os: windows-latest
+            ghc: '8.8.3'
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - uses: haskell/actions/setup@v1
+        id: HaskEnvSetup
+        with:
+          ghc-version: ${{ matrix.ghc }}
+          cabal-version: ${{ matrix.cabal }}
+
+      - if: runner.os == 'Windows'
+        name: (Windows) Platform config
+        run: |
+          echo "CABAL_PKGS_DIR=~\\AppData\\cabal\\packages" >> $GITHUB_ENV
+
+      - if: ( runner.os == 'Linux' ) || ( runner.os == 'macOS' )
+        name: (Linux,macOS) Platform config
+        run: |
+          echo "CABAL_PKGS_DIR=~/.cabal/packages"           >> $GITHUB_ENV
+
+      # Needs to be before Cache Cabal so the cache can detect changes to the modified cabal.project file
+      - if: matrix.ghc == '9.0.1'
+        name: (GHC 9.0.1) Use modified `cabal.project`
+        run: |
+          cp cabal-ghc901.project cabal.project
+
+      - if: runner.os == 'Windows' && matrix.ghc == '8.8.4'
+        name: (Windows,GHC 8.8) Modify `cabal.project` to workaround segfaults
+        run: |
+          echo "package floskell"   >> cabal.project
+          echo "  ghc-options: -O0" >> cabal.project
+
+      # Work around for filepath length limits in Windows
+      - name: (Windows) Shorten binary names
+        run: |
+          sed -i.bak -e 's/haskell-language-server/hls/g' \
+                     -e 's/haskell_language_server/hls/g' \
+                     haskell-language-server.cabal cabal.project
+          sed -i.bak -e 's/Paths_haskell_language_server/Paths_hls/g' \
+                     src/**/*.hs exe/*.hs
+
+      - name: Retrieving `cabal.project` Hackage timestamp
+        run: |
+          # Form: index-state: 2021-11-29T08:11:08Z
+          INDEX_STATE_ENTRY=$(grep index-state cabal.project)
+          # Form: 2021-11-29T08-11-08Z
+          INDEX_STATE1=$(echo "$INDEX_STATE_ENTRY" | cut -d' ' -f2 | tr ':' '-')
+          echo "INDEX_STATE=$INDEX_STATE1" >> $GITHUB_ENV
+
+      # 2021-12-02: NOTE: Cabal Hackage source tree storage does not depend on OS or GHC really,
+      # but can depend on `base`.
+      # But this caching is happens only inside `master` for `master` purposes of compiling the deps
+      # so having a shared pool here that depends only on Hackage pin & does not depend on `base` is "good enough"
+      # & used such because it preserves 10% of a global cache storage pool.
+      - name: Hackage sources cache
+        uses: actions/cache@v2
+        env:
+          cache-name: hackage-sources
+        with:
+          path: ${{ env.CABAL_PKGS_DIR }}
+          key:          ${{ env.cache-name }}-${{ env.INDEX_STATE }}
+          restore-keys: ${{ env.cache-name }}-
+
+      - name: Compiled deps cache
+        uses: actions/cache@v2
+        env:
+          cache-name: compiled-deps
+        with:
+          path: ${{ steps.HaskEnvSetup.outputs.cabal-store }}
+          key:  ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-${{ env.INDEX_STATE }}-${{ hashFiles('cabal.project') }}
+          restore-keys: |
+                ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-${{ env.INDEX_STATE }}-
+                ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-
+                ${{ env.cache-name }}-${{ runner.os }}-
+
+      - run: cabal v2-update
+
+      - name: Download all sources
+        run: |
+          cabal $cabalBuild --only-download
+
+      - if: runner.os != 'Windows'
+        name: (Default) Build all targets
+        # If some builds not passed, atill cache what is available.
+        continue-on-error: true
+        run: |
+          cabal $cabalBuild
+
+      # repeating builds to workaround segfaults in windows and ghc-8.8.4
+      # separate build steps for platforms are needed because if Windows build aborts once - it returns the error code but despite how it is on other platforms - repeated compilation may succeed.
+      - if: runner.os == 'Windows'
+        name: (Windows) Build all targets; Restart build 3 times
+        continue-on-error: true
+        run: |
+          cabal $cabalBuild || cabal $cabalBuild || cabal $cabalBuild