Merge branch 'codex/extract-dokick-optimization' into codex/hls-graph-runtime-engine

Author: soulomoon

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/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/Main.hs

@@ -40,7 +40,7 @@ import           Development.IDE.Core.IdeConfiguration    (IdeConfiguration (..)
                                                            modifyClientSettings,
                                                            registerIdeConfiguration)
 import           Development.IDE.Core.OfInterest          (FileOfInterestStatus (OnDisk),
-                                                           kick,
+                                                           doKick,
                                                            setFilesOfInterest)
 import           Development.IDE.Core.Rules               (mainRule)
 import qualified Development.IDE.Core.Rules               as Rules
@@ -304,7 +304,7 @@ defaultMain recorder Arguments{..} = withHeapStats (cmapWithPrio LogHeapStats re
         argsParseConfig = getConfigFromNotification argsHlsPlugins
         rules = do
             argsRules
-            unless argsDisableKick $ action kick
+            unless argsDisableKick $ action $ doKick
             pluginRules plugins
         -- install the main and ghcide-plugin rules
         -- install the kick action, which triggers a typecheck on every