Skip to content

dont force state results #4545 #4546

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
rhendric merged 6 commits into from
Sep 29, 2024
Merged

dont force state results #4545 #4546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
33939ad
dont force state results #4545
roryc89 Jul 19, 2024
bedc325
add myself to contributors
roryc89 Jul 22, 2024
99fa9d0
update changelog
roryc89 Jul 22, 2024
5ae86b0
Merge branch 'master' of https://github.com/purescript/purescript int…
roryc89 Aug 9, 2024
e989935
Remove Generic and NFData instances from IDE types
roryc89 Sep 9, 2024
4bf5d8d
Remove perf log as result is no longer forced
roryc89 Sep 9, 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
1 change: 1 addition & 0 deletions CHANGELOG.d/fix_issue-4545.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Speed up IDE performance on large projects
1 change: 1 addition & 0 deletions CONTRIBUTORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ If you would prefer to use different terms, please use the section below instead
| [@woody88](https://github.com/woody88) | Woodson Delhia | [MIT license] |
| [@xgrommx](https://github.com/xgrommx) | Denis Stoyanov | [MIT license] |
| [@zudov](https://github.com/zudov) | Konstantin Zudov | [MIT license] |
| [@roryc89](https://github.com/roryc89) | Rory Campbell | [MIT license] |


### Contributors using Modified Terms
Expand Down
3 changes: 1 addition & 2 deletions src/Language/PureScript/Ide/Reexports.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ data ReexportResult a
= ReexportResult
{ reResolved :: a
, reFailed :: [(P.ModuleName, P.DeclarationRef)]
} deriving (Show, Eq, Functor, Generic)
} deriving (Show, Eq, Functor)

instance NFData a => NFData (ReexportResult a)

-- | Uses the passed formatter to format the resolved module, and adds possible
-- failures
Expand Down
9 changes: 3 additions & 6 deletions src/Language/PureScript/Ide/State.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import Language.PureScript.Ide.Externs (convertExterns)
import Language.PureScript.Ide.Reexports (ReexportResult(..), prettyPrintReexportResult, reexportHasFailures, resolveReexports)
import Language.PureScript.Ide.SourceFile (extractAstInformation)
import Language.PureScript.Ide.Types
import Language.PureScript.Ide.Util (discardAnn, displayTimeSpec, logPerf, opNameT, properNameT, runLogger)
import Language.PureScript.Ide.Util (discardAnn, opNameT, properNameT, runLogger)
import System.Directory (getModificationTime)

-- | Resets all State inside psc-ide
Expand Down Expand Up @@ -199,10 +199,7 @@ cachedRebuild = vsCachedRebuild <$> getVolatileState
populateVolatileStateSync :: (Ide m, MonadLogger m) => m ()
populateVolatileStateSync = do
st <- ideStateVar <$> ask
let message duration = "Finished populating volatile state in: " <> displayTimeSpec duration
results <- logPerf message $ do
!r <- liftIO (atomically (populateVolatileStateSTM st))
pure r
results <- liftIO (atomically (populateVolatileStateSTM st))
void $ Map.traverseWithKey
(\mn -> logWarnN . prettyPrintReexportResult (const (P.runModuleName mn)))
(Map.filter reexportHasFailures results)
Expand Down Expand Up @@ -235,7 +232,7 @@ populateVolatileStateSTM ref = do
& resolveOperators
& resolveReexports reexportRefs
setVolatileStateSTM ref (IdeVolatileState (AstData asts) (map reResolved results) rebuildCache)
pure (force results)
pure results

@roryc89 roryc89 Jul 19, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have limited haskell XP so may be misunderstanding but I suspect that by allowing results to be lazy, the IDE doesn't have to calculate all of the results as the state may be recomputed before much or any of an old result is used.

Whereas, when it is forced, it is possible for many computations to be queued up on a large project and the results value can use up so much memory that the IDE starts to grind to a halt.


resolveLocations
:: ModuleMap (DefinitionSites P.SourceSpan, TypeAnnotations)
Expand Down
28 changes: 14 additions & 14 deletions src/Language/PureScript/Ide/Types.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,59 +31,59 @@ data IdeDeclaration
| IdeDeclValueOperator IdeValueOperator
| IdeDeclTypeOperator IdeTypeOperator
| IdeDeclModule P.ModuleName
deriving (Show, Eq, Ord, Generic, NFData)
deriving (Show, Eq, Ord)

data IdeValue = IdeValue
{ _ideValueIdent :: P.Ident
, _ideValueType :: P.SourceType
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

data IdeType = IdeType
{ _ideTypeName :: P.ProperName 'P.TypeName
, _ideTypeKind :: P.SourceType
, _ideTypeDtors :: [(P.ProperName 'P.ConstructorName, P.SourceType)]
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

data IdeTypeSynonym = IdeTypeSynonym
{ _ideSynonymName :: P.ProperName 'P.TypeName
, _ideSynonymType :: P.SourceType
, _ideSynonymKind :: P.SourceType
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

data IdeDataConstructor = IdeDataConstructor
{ _ideDtorName :: P.ProperName 'P.ConstructorName
, _ideDtorTypeName :: P.ProperName 'P.TypeName
, _ideDtorType :: P.SourceType
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

data IdeTypeClass = IdeTypeClass
{ _ideTCName :: P.ProperName 'P.ClassName
, _ideTCKind :: P.SourceType
, _ideTCInstances :: [IdeInstance]
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

data IdeInstance = IdeInstance
{ _ideInstanceModule :: P.ModuleName
, _ideInstanceName :: P.Ident
, _ideInstanceTypes :: [P.SourceType]
, _ideInstanceConstraints :: Maybe [P.SourceConstraint]
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

data IdeValueOperator = IdeValueOperator
{ _ideValueOpName :: P.OpName 'P.ValueOpName
, _ideValueOpAlias :: P.Qualified (Either P.Ident (P.ProperName 'P.ConstructorName))
, _ideValueOpPrecedence :: P.Precedence
, _ideValueOpAssociativity :: P.Associativity
, _ideValueOpType :: Maybe P.SourceType
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

data IdeTypeOperator = IdeTypeOperator
{ _ideTypeOpName :: P.OpName 'P.TypeOpName
, _ideTypeOpAlias :: P.Qualified (P.ProperName 'P.TypeName)
, _ideTypeOpPrecedence :: P.Precedence
, _ideTypeOpAssociativity :: P.Associativity
, _ideTypeOpKind :: Maybe P.SourceType
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

_IdeDeclValue :: Traversal' IdeDeclaration IdeValue
_IdeDeclValue f (IdeDeclValue x) = map IdeDeclValue (f x)
Expand Down Expand Up @@ -131,15 +131,15 @@ makeLenses ''IdeTypeOperator
data IdeDeclarationAnn = IdeDeclarationAnn
{ _idaAnnotation :: Annotation
, _idaDeclaration :: IdeDeclaration
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

data Annotation
= Annotation
{ _annLocation :: Maybe P.SourceSpan
, _annExportedFrom :: Maybe P.ModuleName
, _annTypeAnnotation :: Maybe P.SourceType
, _annDocumentation :: Maybe Text
} deriving (Show, Eq, Ord, Generic, NFData)
} deriving (Show, Eq, Ord)

makeLenses ''Annotation
makeLenses ''IdeDeclarationAnn
Expand All @@ -152,7 +152,7 @@ type TypeAnnotations = Map P.Ident P.SourceType
newtype AstData a = AstData (ModuleMap (DefinitionSites a, TypeAnnotations))
-- ^ SourceSpans for the definition sites of values and types as well as type
-- annotations found in a module
deriving (Show, Eq, Ord, Generic, NFData, Functor, Foldable)
deriving (Show, Eq, Ord, Functor, Foldable)

data IdeLogLevel = LogDebug | LogPerf | LogAll | LogDefault | LogNone
deriving (Show, Eq)
Expand Down Expand Up @@ -313,7 +313,7 @@ encodeImport (P.runModuleName -> mn, importType, map P.runModuleName -> qualifie

-- | Denotes the different namespaces a name in PureScript can reside in.
data IdeNamespace = IdeNSValue | IdeNSType | IdeNSModule
deriving (Show, Eq, Ord, Generic, NFData)
deriving (Show, Eq, Ord)

instance FromJSON IdeNamespace where
parseJSON = Aeson.withText "Namespace" $ \case
Expand All @@ -324,4 +324,4 @@ instance FromJSON IdeNamespace where

-- | A name tagged with a namespace
data IdeNamespaced = IdeNamespaced IdeNamespace Text
deriving (Show, Eq, Ord, Generic, NFData)
deriving (Show, Eq, Ord)