Merge branch 'master' into ghc-9.2

Author: Anton-Latukha

.github/workflows/bench.yml

@@ -24,7 +24,7 @@ jobs:
         uses: fkirc/[email protected]
         with:
           cancel_others: false
-          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**.nix", "**/test/**", "flake.lock", "**/README.md", "FUNDING.yml"]'
+          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**.nix", "**/test/**", "flake.lock", "**/README.md", "FUNDING.yml", "**/stack*.yaml"]'
 
   bench_init:
     if: needs.pre_job.outputs.should_skip != 'true'

.github/workflows/caching.yml

@@ -30,6 +30,18 @@ on:
   push:
     branches:
       - master
+  schedule:
+    # Refresh snapshot every (02+8*x):25 UTC
+    # When cache is present it is a light check workflow with early termination.
+    # When primary cache is not hit - runs the cache generation.
+    # Why: GitHub repo has 10G pool & on overflow GitHub removes caches in FIFO manner.
+    # When internal branche PRs save into the same pool -
+    #   their cache is accessible only inside of the scope of the PR.
+    # If main cache is forced out - there are no cache shared between PRs,
+    #   which implies all PRs would start to create & save their cache.
+    # Reinstitution of the main chache puts it back into FIFO
+    #   & so it gets shared across all PRs.
+    - cron: "25 2/8 * * *"
 
 env:
   cabalBuild: "v2-build all --enable-tests --enable-benchmarks"
@@ -78,7 +90,7 @@ jobs:
       - if: runner.os == 'Windows'
         name: (Windows) Platform config
         run: |
-          echo "CABAL_PKGS_DIR=~\\AppData\\cabal\\packages" >> $GITHUB_ENV
+          echo "CABAL_PKGS_DIR=C:\\cabal\\packages" >> $GITHUB_ENV
       - if: ( runner.os == 'Linux' ) || ( runner.os == 'macOS' )
         name: (Linux,macOS) Platform config
         run: |
@@ -130,6 +142,7 @@ jobs:
           restore-keys: ${{ env.cache-name }}-
 
       - name: Compiled deps cache
+        id: compiled-deps
         uses: actions/cache@v2
         env:
           cache-name: compiled-deps
@@ -141,9 +154,12 @@ jobs:
                 ${{ env.cache-name }}-${{ runner.os }}-${{ matrix.ghc }}-
                 ${{ env.cache-name }}-${{ runner.os }}-
 
-      - run: cabal update
+      - if: (! steps.compiled-deps.outputs.cache-hit)
+        run: |
+          cabal update
 
-      - name: Download all sources
+      - if: (! steps.compiled-deps.outputs.cache-hit)
+        name: Download all sources
         run: |
           cabal $cabalBuild --only-download
 
@@ -152,7 +168,8 @@ jobs:
       # but to cache what can be cached, so step is fault tolerant & would always succseed.
       # 2021-12-11: NOTE: Building all targets, since
       # current Cabal does not allow `all --enable-tests --enable-benchmarks --only-dependencies`
-      - name: Build all targets; try 3 times
+      - if: (! steps.compiled-deps.outputs.cache-hit)
+        name: Build all targets; try 3 times
         continue-on-error: true
         run: |
           cabal $cabalBuild || cabal $cabalBuild || cabal $cabalBuild

.github/workflows/nix.yml

@@ -24,7 +24,7 @@ jobs:
         uses: fkirc/[email protected]
         with:
           cancel_others: false
-          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**/README.md", "FUNDING.yml"]'
+          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**/README.md", "FUNDING.yml", "**/stack*.yaml"]'
       - id: skip_check_no_nix
         uses: fkirc/[email protected]
         with:

.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
         uses: fkirc/[email protected]
         with:
           cancel_others: false
-          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", "install/**", "**.nix", "flake.lock", "**/README.md", "FUNDING.yml", ".circleci/**"]'
+          paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", "install/**", "**.nix", "flake.lock", "**/README.md", "FUNDING.yml", ".circleci/**", "**/stack*.yaml"]'
       # If we only change ghcide downstream packages we have not test ghcide itself
       - id: skip_ghcide_check
         uses: fkirc/[email protected]
@@ -85,7 +85,7 @@ jobs:
       - if: runner.os == 'Windows'
         name: (Windows) Platform config
         run: |
-          echo "CABAL_PKGS_DIR=~\\AppData\\cabal\\packages" >> $GITHUB_ENV
+          echo "CABAL_PKGS_DIR=C:\\cabal\\packages" >> $GITHUB_ENV
       - if: ( runner.os == 'Linux' ) || ( runner.os == 'macOS' )
         name: (Linux,macOS) Platform config
         run: |

cabal-ghc901.project

@@ -37,7 +37,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-11-29T12:30:07Z
+index-state: 2021-11-29T12:30:08Z
 
 constraints:
   -- These plugins don't work on GHC9 yet

cabal.project

@@ -40,7 +40,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2021-11-29T12:30:07Z
+index-state: 2021-11-29T12:30:08Z
 
 constraints:
     hyphenation +embed

ghcide/ghcide.cabal

@@ -146,6 +146,7 @@ library
         Development.IDE
         Development.IDE.Main
         Development.IDE.Core.Actions
+        Development.IDE.Main.HeapStats
         Development.IDE.Core.Debouncer
         Development.IDE.Core.FileStore
         Development.IDE.Core.IdeConfiguration
@@ -300,7 +301,8 @@ executable ghcide
                 -rtsopts
                 -- disable idle GC
                 -- increase nursery size
-                "-with-rtsopts=-I0 -A128M"
+                -- Enable collection of heap statistics
+                "-with-rtsopts=-I0 -A128M -T"
     main-is: Main.hs
     build-depends:
         hiedb,

ghcide/src/Development/IDE/Core/Rules.hs

@@ -149,9 +149,6 @@ import           Ide.Types                                    (DynFlagsModificat
                                                                PluginId)
 import Control.Concurrent.STM.Stats (atomically)
 import Language.LSP.Server (LspT)
-import System.Environment (getExecutablePath)
-import System.Process.Extra (readProcessWithExitCode)
-import Text.Read (readMaybe)
 import System.Info.Extra (isMac)
 import HIE.Bios.Ghc.Gap (hostIsDynamic)
 

ghcide/src/Development/IDE/Core/Shake.hs

@@ -154,7 +154,7 @@ import           Data.Aeson                             (toJSON)
 import qualified Data.ByteString.Char8                  as BS8
 import           Data.Coerce                            (coerce)
 import           Data.Default
-import           Data.Foldable                          (toList)
+import           Data.Foldable                          (for_, toList)
 import           Data.HashSet                           (HashSet)
 import qualified Data.HashSet                           as HSet
 import           Data.String                            (fromString)
@@ -455,7 +455,7 @@ recordDirtyKeys
 recordDirtyKeys ShakeExtras{dirtyKeys} key file = do
     modifyTVar' dirtyKeys $ \x -> foldl' (flip HSet.insert) x (toKey key <$> file)
     return $ withEventTrace "recordDirtyKeys" $ \addEvent -> do
-        addEvent (fromString $ "dirty " <> show key) (fromString $ unlines $ map fromNormalizedFilePath file)
+        addEvent (fromString $ unlines $ "dirty " <> show key : map fromNormalizedFilePath file)
 
 -- | We return Nothing if the rule has not run and Just Failed if it has failed to produce a value.
 getValues ::
@@ -583,15 +583,17 @@ startTelemetry db extras@ShakeExtras{..}
 
 -- | Must be called in the 'Initialized' handler and only once
 shakeSessionInit :: IdeState -> IO ()
-shakeSessionInit IdeState{..} = do
+shakeSessionInit ide@IdeState{..} = do
     initSession <- newSession shakeExtras shakeDb [] "shakeSessionInit"
     putMVar shakeSession initSession
+    logDebug (ideLogger ide) "Shake session initialized"
 
 shakeShut :: IdeState -> IO ()
-shakeShut IdeState{..} = withMVar shakeSession $ \runner -> do
+shakeShut IdeState{..} = do
+    runner <- tryReadMVar shakeSession
     -- Shake gets unhappy if you try to close when there is a running
     -- request so we first abort that.
-    void $ cancelShakeSession runner
+    for_ runner cancelShakeSession
     void $ shakeDatabaseProfile shakeDb
     shakeClose
     progressStop $ progress shakeExtras

ghcide/src/Development/IDE/Core/Tracing.hs

@@ -71,11 +71,11 @@ import qualified StmContainers.Map                 as STM
 #if MIN_VERSION_ghc(8,8,0)
 otTracedProvider :: MonadUnliftIO m => PluginId -> ByteString -> m a -> m a
 otTracedGarbageCollection :: (MonadMask f, MonadIO f, Show a) => ByteString -> f [a] -> f [a]
-withEventTrace :: (MonadMask m, MonadIO m) => String -> ((ByteString -> ByteString -> m ()) -> m a) -> m a
+withEventTrace :: (MonadMask m, MonadIO m) => String -> ((ByteString -> m ()) -> m a) -> m a
 #else
 otTracedProvider :: MonadUnliftIO m => PluginId -> String -> m a -> m a
 otTracedGarbageCollection :: (MonadMask f, MonadIO f, Show a) => String -> f [a] -> f [a]
-withEventTrace :: (MonadMask m, MonadIO m) => String -> ((String -> ByteString -> m ()) -> m a) -> m a
+withEventTrace :: (MonadMask m, MonadIO m) => String -> ((ByteString -> m ()) -> m a) -> m a
 #endif
 
 withTrace :: (MonadMask m, MonadIO m) =>
@@ -90,8 +90,8 @@ withTrace name act
 withEventTrace name act
   | userTracingEnabled
   = withSpan (fromString name) $ \sp -> do
-      act (addEvent sp)
-  | otherwise = act (\_ _ -> pure ())
+      act (addEvent sp "")
+  | otherwise = act (\_ -> pure ())
 
 -- | Returns a logger that produces telemetry events in a single span
 withTelemetryLogger :: (MonadIO m, MonadMask m) => (Logger -> m a) -> m a