Add plugin priorities

Author: pepeiborra

exe/Plugins.hs

@@ -211,12 +211,8 @@ idePlugins recorder includeExamples = pluginDescToIdePlugins allPlugins
 #if hls_gadt
       GADT.descriptor "gadt" :
 #endif
-    -- The ghcide descriptors should come last so that the notification handlers
-    -- (which restart the Shake build) run after everything else
       GhcIde.descriptors pluginRecorder
 #if explicitFixity
-    -- Make this plugin has a lower priority than ghcide's plugin to ensure
-    -- type info display first.
       ++ [ExplicitFixity.descriptor pluginRecorder]
 #endif
     examplePlugins =

ghcide/ghcide.cabal

@@ -192,6 +192,7 @@ library
         Development.IDE.Monitoring.EKG
         Development.IDE.LSP.HoverDefinition
         Development.IDE.LSP.LanguageServer
+        Development.IDE.LSP.Notifications
         Development.IDE.LSP.Outline
         Development.IDE.LSP.Server
         Development.IDE.Session
@@ -225,7 +226,6 @@ library
         Development.IDE.Core.FileExists
         Development.IDE.GHC.CPP
         Development.IDE.GHC.Warnings
-        Development.IDE.LSP.Notifications
         Development.IDE.Plugin.CodeAction.PositionIndexed
         Development.IDE.Plugin.CodeAction.Args
         Development.IDE.Plugin.Completions.Logic

ghcide/src/Development/IDE/LSP/Notifications.hs

@@ -10,6 +10,7 @@ module Development.IDE.LSP.Notifications
     ( whenUriFile
     , descriptor
     , Log(..)
+    , ghcideNotificationsPluginPriority
     ) where
 
 import           Language.LSP.Types
@@ -38,6 +39,7 @@ import           Development.IDE.Types.Location
 import           Development.IDE.Types.Logger
 import           Development.IDE.Types.Shake           (toKey)
 import           Ide.Types
+import           Numeric.Natural
 
 data Log
   = LogShake Shake.Log
@@ -138,5 +140,12 @@ descriptor recorder plId = (defaultPluginDescriptor plId) { pluginNotificationHa
       success <- registerFileWatches globs
       unless success $
         liftIO $ logDebug (ideLogger ide) "Warning: Client does not support watched files. Falling back to OS polling"
-  ]
+  ],
+
+    -- The ghcide descriptors should come last'ish so that the notification handlers
+    -- (which restart the Shake build) run after everything else
+        pluginPriority = ghcideNotificationsPluginPriority
     }
+
+ghcideNotificationsPluginPriority :: Natural
+ghcideNotificationsPluginPriority = defaultPluginPriority - 900

hls-plugin-api/src/Ide/Types.hs

@@ -22,6 +22,7 @@
 
 module Ide.Types
 ( PluginDescriptor(..), defaultPluginDescriptor, defaultCabalPluginDescriptor
+, defaultPluginPriority
 , IdeCommand(..)
 , IdeMethod(..)
 , IdeNotification(..)
@@ -61,10 +62,14 @@ import           Data.Dependent.Map              (DMap)
 import qualified Data.Dependent.Map              as DMap
 import qualified Data.DList                      as DList
 import           Data.GADT.Compare
-import           Data.List.Extra                 (nubOrdOn)
+import           Data.Hashable                   (Hashable)
+import           Data.HashMap.Strict             (HashMap)
+import qualified Data.HashMap.Strict             as HashMap
+import           Data.List.Extra                 (sortOn)
 import           Data.List.NonEmpty              (NonEmpty (..), toList)
 import qualified Data.Map                        as Map
 import           Data.Maybe
+import           Data.Ord
 import           Data.Semigroup
 import           Data.String
 import qualified Data.Text                       as T
@@ -94,6 +99,7 @@ import           Language.LSP.Types.Lens         as J (HasChildren (children),
                                                        HasTitle (title),
                                                        HasUri (..))
 import           Language.LSP.VFS
+import           Numeric.Natural
 import           OpenTelemetry.Eventlog
 import           Options.Applicative             (ParserInfo)
 import           System.FilePath
@@ -102,20 +108,16 @@ import           Text.Regex.TDFA.Text            ()
 
 -- ---------------------------------------------------------------------
 
-newtype IdePlugins ideState = IdePlugins_
-  { ipMap_ :: [(PluginId, PluginDescriptor ideState)]}
-  deriving newtype Monoid
+newtype IdePlugins ideState = IdePlugins_ { ipMap_ :: HashMap PluginId (PluginDescriptor ideState)}
+  deriving newtype (Semigroup, Monoid)
 
 -- | Smart constructor that deduplicates plugins
 pattern IdePlugins :: [(PluginId, PluginDescriptor ideState)] -> IdePlugins ideState
-pattern IdePlugins{ipMap} <- IdePlugins_ ipMap
+pattern IdePlugins{ipMap} <- IdePlugins_ (sortOn (Down . pluginPriority . snd) . HashMap.toList -> ipMap)
   where
-    IdePlugins ipMap = IdePlugins_{ipMap_ = nubOrdOn fst ipMap}
+    IdePlugins ipMap = IdePlugins_{ipMap_ = HashMap.fromList ipMap}
 {-# COMPLETE IdePlugins #-}
 
-instance Semigroup (IdePlugins s) where
-    IdePlugins a <> IdePlugins b = IdePlugins(a <> b)
-
 -- | Hooks for modifying the 'DynFlags' at different times of the compilation
 -- process. Plugins can install a 'DynFlagsModifications' via
 -- 'pluginModifyDynflags' in their 'PluginDescriptor'.
@@ -149,6 +151,8 @@ instance Show (IdeCommand st) where show _ = "<ide command>"
 data PluginDescriptor (ideState :: *) =
   PluginDescriptor { pluginId           :: !PluginId
                    -- ^ Unique identifier of the plugin.
+                   , pluginPriority     :: Natural
+                   -- ^ Plugin handlers are called in priority order, higher priority first
                    , pluginRules        :: !(Rules ())
                    , pluginCommands     :: ![PluginCommand ideState]
                    , pluginHandlers     :: PluginHandlers ideState
@@ -631,6 +635,9 @@ mkPluginNotificationHandler m f
   where
     f' pid ide vfs = f ide vfs pid
 
+defaultPluginPriority :: Natural
+defaultPluginPriority = 1000
+
 -- | Set up a plugin descriptor, initialized with default values.
 -- This is plugin descriptor is prepared for @haskell@ files, such as
 --
@@ -644,6 +651,7 @@ defaultPluginDescriptor :: PluginId -> PluginDescriptor ideState
 defaultPluginDescriptor plId =
   PluginDescriptor
     plId
+    defaultPluginPriority
     mempty
     mempty
     mempty
@@ -663,6 +671,7 @@ defaultCabalPluginDescriptor :: PluginId -> PluginDescriptor ideState
 defaultCabalPluginDescriptor plId =
   PluginDescriptor
     plId
+    defaultPluginPriority
     mempty
     mempty
     mempty
@@ -694,6 +703,7 @@ type CommandFunction ideState a
 
 newtype PluginId = PluginId T.Text
   deriving (Show, Read, Eq, Ord)
+  deriving newtype Hashable
 
 instance IsString PluginId where
   fromString = PluginId . T.pack

plugins/hls-explicit-fixity-plugin/src/Ide/Plugin/ExplicitFixity.hs

@@ -28,6 +28,7 @@ import qualified Development.IDE.Core.Shake           as Shake
 import           Development.IDE.GHC.Compat
 import           Development.IDE.GHC.Compat.Util      (FastString)
 import qualified Development.IDE.GHC.Compat.Util      as Util
+import           Development.IDE.LSP.Notifications    (ghcideNotificationsPluginPriority)
 import           GHC.Generics                         (Generic)
 import           Ide.PluginUtils                      (getNormalizedFilePath,
                                                        handleMaybeM,
@@ -42,6 +43,9 @@ descriptor :: Recorder (WithPriority Log) -> PluginDescriptor IdeState
 descriptor recorder = (defaultPluginDescriptor pluginId)
     { pluginRules = fixityRule recorder
     , pluginHandlers = mkPluginHandler STextDocumentHover hover
+    -- Make this plugin has a lower priority than ghcide's plugin to ensure
+    -- type info display first.
+    , pluginPriority = ghcideNotificationsPluginPriority - 1
     }
 
 hover :: PluginMethodHandler IdeState TextDocumentHover