Skip to content

improve logging in semantic tokens rule #4135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 11, 2024
Merged

improve logging in semantic tokens rule #4135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fa9c874
improve logging in semantic tokens rule
soulomoon Mar 11, 2024
ebc0606
remove redudent import
soulomoon Mar 11, 2024
e686a4d
refine LogDependencyError
soulomoon Mar 11, 2024
ccdf3e8
Merge branch 'master' into improve-semantic-tokens-rule-logging
soulomoon Mar 11, 2024
f87b444
Merge branch 'master' into improve-semantic-tokens-rule-logging
soulomoon Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions plugins/hls-semantic-tokens-plugin/src/Ide/Plugin/SemanticTokens/Internal.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,14 @@ import Development.IDE (Action,
WithPriority,
cmapWithPrio, define,
fromNormalizedFilePath,
hieKind, use_)
import Development.IDE.Core.PluginUtils (runActionE,
hieKind)
import Development.IDE.Core.PluginUtils (runActionE, useE,
useWithStaleE)
import Development.IDE.Core.Rules (toIdeResult)
import Development.IDE.Core.RuleTypes (DocAndTyThingMap (..))
import Development.IDE.Core.Shake (ShakeExtras (..),
getShakeExtras,
getVirtualFile,
useWithStale_)
getVirtualFile)
import Development.IDE.GHC.Compat hiding (Warning)
import Development.IDE.GHC.Compat.Util (mkFastString)
import Ide.Logger (logWith)
Expand Down Expand Up @@ -124,8 +123,8 @@ semanticTokensFullDelta recorder state pid param = do
getSemanticTokensRule :: Recorder (WithPriority SemanticLog) -> Rules ()
getSemanticTokensRule recorder =
define (cmapWithPrio LogShake recorder) $ \GetSemanticTokens nfp -> handleError recorder $ do
(HAR {..}) <- lift $ use_ GetHieAst nfp
(DKMap {getTyThingMap}, _) <- lift $ useWithStale_ GetDocMap nfp
(HAR {..}) <- withExceptT LogDependencyError $ useE GetHieAst nfp
(DKMap {getTyThingMap}, _) <- withExceptT LogDependencyError $ useWithStaleE GetDocMap nfp
ast <- handleMaybe (LogNoAST $ show nfp) $ getAsts hieAst M.!? (HiePath . mkFastString . fromNormalizedFilePath) nfp
virtualFile <- handleMaybeM LogNoVF $ getVirtualFile nfp
let hsFinder = idSemantic getTyThingMap (hieKindFunMasksKind hieKind) refMap
Expand Down
4 changes: 3 additions & 1 deletion plugins/hls-semantic-tokens-plugin/src/Ide/Plugin/SemanticTokens/Types.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import GHC.Generics (Generic)
import Language.LSP.Protocol.Types
-- import template haskell
import Data.Text (Text)
import Ide.Plugin.Error (PluginError)
import Language.Haskell.TH.Syntax (Lift)


Expand Down Expand Up @@ -137,12 +138,12 @@ data HieFunMaskKind kind where

data SemanticLog
= LogShake Shake.Log
| LogDependencyError PluginError
| LogNoAST FilePath
| LogConfig SemanticTokensConfig
| LogMsg String
| LogNoVF
| LogSemanticTokensDeltaMisMatch Text (Maybe Text)
deriving (Show)

instance Pretty SemanticLog where
pretty theLog = case theLog of
Expand All @@ -154,6 +155,7 @@ instance Pretty SemanticLog where
LogSemanticTokensDeltaMisMatch previousIdFromRequest previousIdFromCache
-> "SemanticTokensDeltaMisMatch: previousIdFromRequest: " <> pretty previousIdFromRequest
<> " previousIdFromCache: " <> pretty previousIdFromCache
LogDependencyError err -> "SemanticTokens' dependency error: " <> pretty err


type SemanticTokenId = Text