Drop dependency on Shake

Author: pepeiborra

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

@@ -18,7 +18,6 @@ module Development.IDE.Core.RuleTypes(
 import           Control.DeepSeq
 import           Control.Lens
 import           Data.Aeson.Types                             (Value)
-import           Data.Binary
 import           Data.Hashable
 import qualified Data.Map                                     as M
 import           Data.Time.Clock.POSIX
@@ -82,7 +81,6 @@ data GetKnownTargets = GetKnownTargets
   deriving (Show, Generic, Eq, Ord)
 instance Hashable GetKnownTargets
 instance NFData   GetKnownTargets
-instance Binary   GetKnownTargets
 type instance RuleResult GetKnownTargets = KnownTargets
 
 -- | Convert to Core, requires TypeCheck*
@@ -92,13 +90,11 @@ data GenerateCore = GenerateCore
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GenerateCore
 instance NFData   GenerateCore
-instance Binary   GenerateCore
 
 data GetImportMap = GetImportMap
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetImportMap
 instance NFData   GetImportMap
-instance Binary   GetImportMap
 
 type instance RuleResult GetImportMap = ImportMap
 newtype ImportMap = ImportMap
@@ -287,7 +283,6 @@ instance Hashable GetModificationTime where
     hashWithSalt salt _ = salt
 
 instance NFData   GetModificationTime
-instance Binary   GetModificationTime
 
 pattern GetModificationTime :: GetModificationTime
 pattern GetModificationTime = GetModificationTime_ {missingFileDiagnostics=True}
@@ -310,14 +305,12 @@ data GetFileContents = GetFileContents
     deriving (Eq, Show, Generic)
 instance Hashable GetFileContents
 instance NFData   GetFileContents
-instance Binary   GetFileContents
 
 data GetFileExists = GetFileExists
     deriving (Eq, Show, Typeable, Generic)
 
 instance NFData   GetFileExists
 instance Hashable GetFileExists
-instance Binary   GetFileExists
 
 data FileOfInterestStatus
   = OnDisk
@@ -326,13 +319,11 @@ data FileOfInterestStatus
   deriving (Eq, Show, Typeable, Generic)
 instance Hashable FileOfInterestStatus
 instance NFData   FileOfInterestStatus
-instance Binary   FileOfInterestStatus
 
 data IsFileOfInterestResult = NotFOI | IsFOI FileOfInterestStatus
   deriving (Eq, Show, Typeable, Generic)
 instance Hashable IsFileOfInterestResult
 instance NFData   IsFileOfInterestResult
-instance Binary   IsFileOfInterestResult
 
 type instance RuleResult IsFileOfInterest = IsFileOfInterestResult
 
@@ -359,19 +350,16 @@ data GetParsedModule = GetParsedModule
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetParsedModule
 instance NFData   GetParsedModule
-instance Binary   GetParsedModule
 
 data GetParsedModuleWithComments = GetParsedModuleWithComments
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetParsedModuleWithComments
 instance NFData   GetParsedModuleWithComments
-instance Binary   GetParsedModuleWithComments
 
 data GetLocatedImports = GetLocatedImports
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetLocatedImports
 instance NFData   GetLocatedImports
-instance Binary   GetLocatedImports
 
 -- | Does this module need to be compiled?
 type instance RuleResult NeedsCompilation = Maybe LinkableType
@@ -380,122 +368,102 @@ data NeedsCompilation = NeedsCompilation
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable NeedsCompilation
 instance NFData   NeedsCompilation
-instance Binary   NeedsCompilation
 
 data GetDependencyInformation = GetDependencyInformation
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetDependencyInformation
 instance NFData   GetDependencyInformation
-instance Binary   GetDependencyInformation
 
 data GetModuleGraph = GetModuleGraph
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetModuleGraph
 instance NFData   GetModuleGraph
-instance Binary   GetModuleGraph
 
 data ReportImportCycles = ReportImportCycles
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable ReportImportCycles
 instance NFData   ReportImportCycles
-instance Binary   ReportImportCycles
 
 data GetDependencies = GetDependencies
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetDependencies
 instance NFData   GetDependencies
-instance Binary   GetDependencies
 
 data TypeCheck = TypeCheck
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable TypeCheck
 instance NFData   TypeCheck
-instance Binary   TypeCheck
 
 data GetDocMap = GetDocMap
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetDocMap
 instance NFData   GetDocMap
-instance Binary   GetDocMap
 
 data GetHieAst = GetHieAst
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetHieAst
 instance NFData   GetHieAst
-instance Binary   GetHieAst
 
 data GetBindings = GetBindings
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetBindings
 instance NFData   GetBindings
-instance Binary   GetBindings
 
 data GhcSession = GhcSession
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GhcSession
 instance NFData   GhcSession
-instance Binary   GhcSession
 
 data GhcSessionDeps = GhcSessionDeps deriving (Eq, Show, Typeable, Generic)
 instance Hashable GhcSessionDeps
 instance NFData   GhcSessionDeps
-instance Binary   GhcSessionDeps
 
 data GetModIfaceFromDisk = GetModIfaceFromDisk
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetModIfaceFromDisk
 instance NFData   GetModIfaceFromDisk
-instance Binary   GetModIfaceFromDisk
 
 data GetModIfaceFromDiskAndIndex = GetModIfaceFromDiskAndIndex
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetModIfaceFromDiskAndIndex
 instance NFData   GetModIfaceFromDiskAndIndex
-instance Binary   GetModIfaceFromDiskAndIndex
 
 data GetModIface = GetModIface
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetModIface
 instance NFData   GetModIface
-instance Binary   GetModIface
 
 data GetModIfaceWithoutLinkable = GetModIfaceWithoutLinkable
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetModIfaceWithoutLinkable
 instance NFData   GetModIfaceWithoutLinkable
-instance Binary   GetModIfaceWithoutLinkable
 
 data IsFileOfInterest = IsFileOfInterest
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable IsFileOfInterest
 instance NFData   IsFileOfInterest
-instance Binary   IsFileOfInterest
 
 data GetModSummaryWithoutTimestamps = GetModSummaryWithoutTimestamps
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetModSummaryWithoutTimestamps
 instance NFData   GetModSummaryWithoutTimestamps
-instance Binary   GetModSummaryWithoutTimestamps
 
 data GetModSummary = GetModSummary
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetModSummary
 instance NFData   GetModSummary
-instance Binary   GetModSummary
 
 -- | Get the vscode client settings stored in the ide state
 data GetClientSettings = GetClientSettings
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable GetClientSettings
 instance NFData   GetClientSettings
-instance Binary   GetClientSettings
 
 type instance RuleResult GetClientSettings = Hashed (Maybe Value)
 
 data AddWatchedFile = AddWatchedFile deriving (Eq, Show, Typeable, Generic)
 instance Hashable AddWatchedFile
 instance NFData   AddWatchedFile
-instance Binary   AddWatchedFile
 
 
 -- A local rule type to get caching. We want to use newCache, but it has
@@ -516,7 +484,6 @@ instance NFData IdeGhcSession where rnf !_ = ()
 data GhcSessionIO = GhcSessionIO deriving (Eq, Show, Typeable, Generic)
 instance Hashable GhcSessionIO
 instance NFData   GhcSessionIO
-instance Binary   GhcSessionIO
 
 makeLensesWith
     (lensRules & lensField .~ mappingNamer (pure . (++ "L")))

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

@@ -114,7 +114,7 @@ import           Development.IDE.GHC.ExactPrint
 import           Development.IDE.GHC.Util                     hiding
                                                               (modifyDynFlags)
 import           Development.IDE.Graph
-import           Development.IDE.Graph.Classes                hiding (get, put)
+import           Development.IDE.Graph.Classes
 import           Development.IDE.Import.DependencyInformation
 import           Development.IDE.Import.FindImports
 import qualified Development.IDE.Spans.AtPoint                as AtPoint

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

@@ -114,7 +114,6 @@ import           Development.IDE.GHC.Compat             (NameCacheUpdater (..),
 import           Development.IDE.GHC.Orphans            ()
 import           Development.IDE.Graph                  hiding (ShakeValue)
 import qualified Development.IDE.Graph                  as Shake
-import           Development.IDE.Graph.Classes
 import           Development.IDE.Graph.Database
 import           Development.IDE.Graph.Rule
 import           Development.IDE.Types.Action
@@ -960,8 +959,6 @@ instance Hashable k => Hashable (QDisk k)
 
 instance NFData k => NFData (QDisk k)
 
-instance Binary k => Binary (QDisk k)
-
 instance Show k => Show (QDisk k) where
     show (QDisk k file) =
         show k ++ "; " ++ fromNormalizedFilePath file

ghcide/src/Development/IDE/GHC/ExactPrint.hs

@@ -81,7 +81,6 @@ data GetAnnotatedParsedSource = GetAnnotatedParsedSource
 
 instance Hashable GetAnnotatedParsedSource
 instance NFData GetAnnotatedParsedSource
-instance Binary GetAnnotatedParsedSource
 type instance RuleResult GetAnnotatedParsedSource = Annotated ParsedSource
 
 -- | Get the latest version of the annotated parse source with comments.

ghcide/src/Development/IDE/Plugin/CodeAction/RuleTypes.hs

@@ -5,7 +5,6 @@ module Development.IDE.Plugin.CodeAction.RuleTypes
     ) where
 
 import           Control.DeepSeq                (NFData)
-import           Data.Binary                    (Binary)
 import           Data.Hashable                  (Hashable)
 import           Data.Typeable                  (Typeable)
 import           Development.IDE.Graph          (RuleResult)
@@ -21,4 +20,3 @@ newtype PackageExports = PackageExports HscEnvEq
 
 instance Hashable PackageExports
 instance NFData   PackageExports
-instance Binary   PackageExports

ghcide/src/Development/IDE/Plugin/Completions.hs

@@ -109,13 +109,11 @@ data LocalCompletions = LocalCompletions
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable LocalCompletions
 instance NFData   LocalCompletions
-instance Binary   LocalCompletions
 
 data NonLocalCompletions = NonLocalCompletions
     deriving (Eq, Show, Typeable, Generic)
 instance Hashable NonLocalCompletions
 instance NFData   NonLocalCompletions
-instance Binary   NonLocalCompletions
 
 -- | Generate code actions.
 getCompletionsLSP

ghcide/src/Development/IDE/Plugin/TypeLenses.hs

@@ -233,7 +233,7 @@ showDocRdrEnv :: DynFlags -> GlobalRdrEnv -> SDoc -> String
 showDocRdrEnv dflags rdrEnv = showSDocForUser dflags (mkPrintUnqualified dflags rdrEnv)
 
 data GetGlobalBindingTypeSigs = GetGlobalBindingTypeSigs
-  deriving (Generic, Show, Eq, Ord, Hashable, NFData, Binary)
+  deriving (Generic, Show, Eq, Ord, Hashable, NFData)
 
 data GlobalBindingTypeSig = GlobalBindingTypeSig
   { gbName     :: Name

ghcide/src/Development/IDE/Types/HscEnvEq.hs

@@ -139,12 +139,6 @@ instance NFData HscEnvEq where
 instance Hashable HscEnvEq where
   hashWithSalt s = hashWithSalt s . envUnique
 
--- Fake instance needed to persuade Shake to accept this type as a key.
--- No harm done as ghcide never persists these keys currently
-instance Binary HscEnvEq where
-  put _ = error "not really"
-  get = error "not really"
-
 -- | Given an action, produce a wrapped action that runs at most once.
 --   The action is run in an async so it won't be killed by async exceptions
 --   If the function raises an exception, the same exception will be reraised each time.

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

@@ -23,10 +23,8 @@ import           Data.HashMap.Strict
 import           Data.Hashable
 import           Data.Vector                          (Vector)
 import           Development.IDE.Core.PositionMapping
-import           Development.IDE.Graph                (Key (..), RuleResult,
-                                                       ShakeException (shakeExceptionInner))
+import           Development.IDE.Graph                (Key (..), RuleResult)
 import qualified Development.IDE.Graph                as Shake
-import           Development.IDE.Graph.Classes
 import           Development.IDE.Types.Diagnostics
 import           Development.IDE.Types.Location
 import           GHC.Generics
@@ -60,28 +58,18 @@ instance Exception BadDependency
 
 isBadDependency :: SomeException -> Bool
 isBadDependency x
-    | Just (x :: ShakeException) <- fromException x = isBadDependency $ shakeExceptionInner x
     | Just (_ :: BadDependency) <- fromException x = True
     | otherwise = False
 
 toKey :: Shake.ShakeValue k => k -> NormalizedFilePath -> Key
 toKey = (Key.) . curry Q
 
-toNoFileKey :: (Show k, Typeable k, Eq k, Hashable k, Binary k) => k -> Key
+toNoFileKey :: (Show k, Typeable k, Eq k, Hashable k) => k -> Key
 toNoFileKey k = Key $ Q (k, emptyFilePath)
 
 newtype Q k = Q (k, NormalizedFilePath)
     deriving newtype (Eq, Hashable, NFData)
 
-instance Binary k => Binary (Q k) where
-    put (Q (k, fp)) = put (k, fp)
-    get = do
-        (k, fp) <- get
-        -- The `get` implementation of NormalizedFilePath
-        -- does not handle empty file paths so we
-        -- need to handle this ourselves here.
-        pure (Q (k, toNormalizedFilePath' fp))
-
 instance Show k => Show (Q k) where
     show (Q (k, file)) = show k ++ "; " ++ fromNormalizedFilePath file
 

ghcide/test/exe/Main.hs

@@ -21,7 +21,6 @@ import           Control.Monad
 import           Control.Monad.IO.Class                   (MonadIO, liftIO)
 import           Data.Aeson                               (fromJSON, toJSON)
 import qualified Data.Aeson                               as A
-import qualified Data.Binary                              as Binary
 import           Data.Default
 import           Data.Foldable
 import           Data.List.Extra
@@ -34,7 +33,6 @@ import           Development.IDE.Core.PositionMapping     (PositionResult (..),
                                                            fromCurrent,
                                                            positionResultToMaybe,
                                                            toCurrent)
-import           Development.IDE.Core.Shake               (Q (..))
 import           Development.IDE.GHC.Compat               (GhcVersion (..),
                                                            ghcVersion)
 import           Development.IDE.GHC.Util
@@ -5647,8 +5645,6 @@ unitTests = do
      , testCase "from empty path URI" $ do
          let uri = Uri "file://"
          uriToFilePath' uri @?= Just ""
-     , testCase "Key with empty file path roundtrips via Binary"  $
-         Binary.decode (Binary.encode (Q ((), emptyFilePath))) @?= Q ((), emptyFilePath)
      , testCase "showDiagnostics prints ranges 1-based (like vscode)" $ do
          let diag = ("", Diagnostics.ShowDiag, Diagnostic
                { _range = Range