hls graph runtime engine experiment

.github/workflows/bench.yml

@@ -23,10 +23,6 @@ jobs:
     steps:
       - id: set_ghc_versions
         run: |
-          # benching the two latest GHCs we support now
-          # since benchmark are expansive.
-          # choosing the two latest are easier to maintain and more forward looking
-          # see discussion https://github.com/haskell/haskell-language-server/pull/4118
           # Benchmarking only the two latest GHCs we support now
           # since benchmark are expensive.
           # Choosing the two latest is easier to maintain and more forward looking.

cabal.project

@@ -51,7 +51,6 @@ constraints:
 allow-newer:
   cabal-install-parsers:Cabal-syntax,
 
-
 if impl(ghc >= 9.13)
   allow-newer:
     cabal-install-parsers:base,

ghcide-bench/src/Experiments.hs

@@ -396,7 +396,28 @@ examplesPath :: FilePath
 examplesPath = "bench/example"
 
 defConfig :: Config
-Success defConfig = execParserPure defaultPrefs (info configP fullDesc) []
+defConfig = Config
+  { verbosity = Normal
+  , shakeProfiling = Nothing
+  , otMemoryProfiling = Nothing
+  , outputCSV = "results.csv"
+  , buildTool = Cabal
+  , ghcideOptions = []
+  , matches = []
+  , repetitions = Nothing
+  , ghcide = "ghcide"
+  , timeoutLsp = 60
+  , example = Example
+      { exampleName = "Cabal"
+      , exampleDetails = ExampleHackage ExamplePackage
+          { packageName = "Cabal"
+          , packageVersion = makeVersion [3,16,1,0]
+          }
+      , exampleModules = ["src/Distribution/Simple.hs"]
+      , exampleExtraArgs = []
+      }
+  , lspConfig = False
+  }
 
 quiet, verbose :: Config -> Bool
 verbose = (== All) . verbosity

ghcide/session-loader/Development/IDE/Session.hs

@@ -905,14 +905,15 @@ session recorder sessionShake sessionState knownTargetsVar(hieYaml, cfp, opts, l
         -- Typecheck all files in the project on startup
         unless (null new_components_info || not checkProject) $ do
             cfps' <- liftIO $ filterM (IO.doesFileExist . fromNormalizedFilePath) (concatMap targetLocations all_targets)
-            void $ enqueueActions sessionShake $ mkDelayedAction "InitialLoad" Debug $ void $ do
+            initialLoad <- mkDelayedAction "InitialLoad" Debug $ void $ do
                 mmt <- uses GetModificationTime cfps'
                 let cs_exist = catMaybes (zipWith (<$) cfps' mmt)
                 modIfaces <- uses GetModIface cs_exist
                 -- update exports map
                 shakeExtras <- getShakeExtras
                 let !exportsMap' = createExportsMap $ mapMaybe (fmap hirModIface) modIfaces
                 liftIO $ atomically $ modifyTVar' (exportsMap shakeExtras) (exportsMap' <>)
+            void $ enqueueActions sessionShake initialLoad
         return [keys1, keys2]
 
 -- | Create a new HscEnv from a hieYaml root and a set of options

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

@@ -286,8 +286,9 @@ setFileModified recorder vfs state saved nfp actionBefore = do
       typecheckParents recorder state nfp
 
 typecheckParents :: Recorder (WithPriority Log) -> IdeState -> NormalizedFilePath -> IO ()
-typecheckParents recorder state nfp = void $ shakeEnqueue (shakeExtras state) parents
-  where parents = mkDelayedAction "ParentTC" L.Debug (typecheckParentsAction recorder nfp)
+typecheckParents recorder state nfp = do
+  parents <- mkDelayedAction "ParentTC" L.Debug (typecheckParentsAction recorder nfp)
+  void $ shakeEnqueue (shakeExtras state) parents
 
 typecheckParentsAction :: Recorder (WithPriority Log) -> NormalizedFilePath -> Action ()
 typecheckParentsAction recorder nfp = do

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

@@ -15,7 +15,7 @@ module Development.IDE.Core.OfInterest(
     kick, FileOfInterestStatus(..),
     OfInterestVar(..),
     scheduleGarbageCollection,
-    Log(..)
+    Log(..), doKick
     ) where
 
 import           Control.Concurrent.Strict
@@ -39,7 +39,7 @@ import           Development.IDE.Plugin.Completions.Types
 import           Development.IDE.Types.Exports
 import           Development.IDE.Types.Location
 import           Development.IDE.Types.Options            (IdeTesting (..))
-import           Development.IDE.Types.Shake              (toKey)
+import           Development.IDE.Types.Shake              (toKey, toNoFileKey)
 import           GHC.TypeLits                             (KnownSymbol)
 import           Ide.Logger                               (Pretty (pretty),
                                                            Priority (..),
@@ -66,6 +66,10 @@ ofInterestRules :: Recorder (WithPriority Log) -> Rules ()
 ofInterestRules recorder = do
     addIdeGlobal . OfInterestVar =<< liftIO (newVar HashMap.empty)
     addIdeGlobal . GarbageCollectVar =<< liftIO (newVar False)
+    -- A no-file rule to perform the global kick action
+    defineEarlyCutOffNoFile (cmapWithPrio LogShake recorder) $ \Kick -> do
+        kick
+        pure ("", ())
     defineEarlyCutoff (cmapWithPrio LogShake recorder) $ RuleNoDiagnostics $ \IsFileOfInterest f -> do
         alwaysRerun
         filesOfInterest <- getFilesOfInterestUntracked
@@ -113,7 +117,7 @@ addFileOfInterest state f v = do
     then do
         logWith (ideLogger state) Debug $
             LogSetFilesOfInterest (HashMap.toList files)
-        return [toKey IsFileOfInterest f]
+        return [toKey IsFileOfInterest f, toNoFileKey Kick]
     else return []
 
 deleteFileOfInterest :: IdeState -> NormalizedFilePath -> IO [Key]
@@ -122,12 +126,21 @@ deleteFileOfInterest state f = do
     files <- modifyVar' var $ HashMap.delete f
     logWith (ideLogger state) Debug $
         LogSetFilesOfInterest (HashMap.toList files)
-    return [toKey IsFileOfInterest f]
+    return [toKey IsFileOfInterest f, toNoFileKey Kick]
 scheduleGarbageCollection :: IdeState -> IO ()
 scheduleGarbageCollection state = do
     GarbageCollectVar var <- getIdeGlobalState state
     writeVar var True
 
+doKick :: Action ()
+doKick = do
+    ShakeExtras{ideTesting = IdeTesting testing} <- getShakeExtras
+    -- only kick always if testing, otherwise we rely on the kick rule
+    if testing
+      then kick
+      else void $ useNoFile Kick
+
+
 -- | Typecheck all the files of interest.
 --   Could be improved
 kick :: Action ()

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

@@ -71,14 +71,16 @@ import qualified StmContainers.Map                    as STM
 -- |ExceptT version of `runAction`, takes a ExceptT Action
 runActionE :: MonadIO m => String -> IdeState -> ExceptT e Action a -> ExceptT e m a
 runActionE herald ide act =
-  mapExceptT liftIO . ExceptT $
-    join $ shakeEnqueue (shakeExtras ide) (mkDelayedAction herald Logger.Debug $ runExceptT act)
+  mapExceptT liftIO . ExceptT $ do
+    delayed <- mkDelayedAction herald Logger.Debug $ runExceptT act
+    join $ shakeEnqueue (shakeExtras ide) delayed
 
 -- |MaybeT version of `runAction`, takes a MaybeT Action
 runActionMT :: MonadIO m => String -> IdeState -> MaybeT Action a -> MaybeT m a
 runActionMT herald ide act =
-  mapMaybeT liftIO . MaybeT $
-    join $ shakeEnqueue (shakeExtras ide) (mkDelayedAction herald Logger.Debug $ runMaybeT act)
+  mapMaybeT liftIO . MaybeT $ do
+    delayed <- mkDelayedAction herald Logger.Debug $ runMaybeT act
+    join $ shakeEnqueue (shakeExtras ide) delayed
 
 -- |ExceptT version of `use` that throws a PluginRuleFailed upon failure
 useE :: IdeRule k v => k -> NormalizedFilePath -> ExceptT PluginError Action v

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

@@ -518,6 +518,14 @@ data IsFileOfInterest = IsFileOfInterest
 instance Hashable IsFileOfInterest
 instance NFData   IsFileOfInterest
 
+-- | A no-file rule that triggers the IDE "kick" action
+data Kick = Kick
+    deriving (Eq, Show, Generic)
+instance Hashable Kick
+instance NFData   Kick
+
+type instance RuleResult Kick = ()
+
 data GetModSummaryWithoutTimestamps = GetModSummaryWithoutTimestamps
     deriving (Eq, Show, Generic)
 instance Hashable GetModSummaryWithoutTimestamps

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

@@ -108,5 +108,6 @@ shutdown = shakeShut
 -- available.  There might still be other rules running at this point,
 -- e.g., the ofInterestRule.
 runAction :: String -> IdeState -> Action a -> IO a
-runAction herald ide act =
-  join $ shakeEnqueue (shakeExtras ide) (mkDelayedAction herald Logger.Debug act)
+runAction herald ide act = do
+  delayed <- mkDelayedAction herald Logger.Debug act
+  join $ shakeEnqueue (shakeExtras ide) delayed