Skip to content

Use a workspace level TokenMap and Engines #7139

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.

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 18 commits into from
May 20, 2025
Merged

Use a workspace level TokenMap and Engines #7139

merged 18 commits into from
May 20, 2025

Conversation

JoshuaBatty
Copy link
Member

@JoshuaBatty JoshuaBatty commented May 1, 2025

Description

This PR moves TokenMap and Engines out of the Session type up to ServerState so a single instance of each can be shared across all workspace members.

Up until now, each workspace member used a unique Engines. This meant the standard library and any other dependancies were unable to utilise the QueryEngine cache, leading to lots of duplicate entries. This was leading to inflated initialization times when opening a new workspace member and significantly increasing the RAM footprint of the language server.

For example, opening each workspace member in the FUSD projects workspace would see RAM usage exceeding ~30.0 gig. Now we no longer exceed 2.0 gig of RAM.

Future PR's will move the BuildPlanCache up to the ServerState level as well.

part of #7111 & #6226
closes #5645
closes #5856

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@JoshuaBatty JoshuaBatty requested a review from a team as a code owner May 1, 2025 01:25
@JoshuaBatty JoshuaBatty marked this pull request as draft May 1, 2025 01:25
@JoshuaBatty JoshuaBatty added language server LSP server performance Everything related to performance, speed wise or memory wise. labels May 1, 2025
@JoshuaBatty JoshuaBatty self-assigned this May 1, 2025
Copy link

codspeed-hq bot commented May 1, 2025

CodSpeed Performance Report

Merging #7139 will not alter performance

Comparing josh/token_map (58ff25b) with master (512bbfc)

Summary

✅ 23 untouched benchmarks
🆕 1 new benchmarks

Benchmarks breakdown

Benchmark BASE HEAD Change
🆕 tokens_for_program N/A 555.7 µs N/A

IGI-111 pushed a commit that referenced this pull request May 5, 2025
## Description
This PR replaces our custom Tokio-based thread watcher for `Forc.toml`
files with the built-in LSP `didChangeWatchedFiles` notification system.
The changes:

* Remove the Tokio thread-based file watching system and associated
cleanup code
* Implement client-side file watching registration during initialization
* Handle `Forc.toml` file changes through the LSP notification protocol
* Update tests to use the new notification system
* Simplify manifest syncing with a direct approach

This approach is more efficient as it leverages the client's native file
watching capabilities rather than spawning a separate thread. The PR
maintains the same functionality while reducing resource usage and
complexity.

Note: This doesn't yet implement the recompilation on `Forc.toml`
changes as mentioned in issue #7103, but adds a TODO placeholder for
that functionality.

This PR is a precursor to #7139

## Checklist

- [x] I have linked to any relevant issues.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.
JoshuaBatty added a commit that referenced this pull request May 19, 2025
## Description
* Moves `SyncWorkspace` ownership from individual `Session` instances to
a single, global instance within `ServerState`.
* `SyncWorkspace` is now initialized once when the LSP server starts,
creating a single temporary workspace clone.

Also removes the `resync` function. This was causing the server and the
IDE to fall out of sync with each other. For example, if you have 2
panels open and then save a file in one of the tabs but have unsaved
changes in the other tab then those changes would not be reflected in
the temp memory folder. This meant everything would be out of sync. We
already are syncing everything on each keystroke per file so this fn was
not necessary in the first place.

This PR is a precursor to #7139
part of #7111

## Checklist

- [x] I have linked to any relevant issues.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.

---------

Co-authored-by: zees-dev <[email protected]>
@JoshuaBatty JoshuaBatty marked this pull request as ready for review May 20, 2025 04:11
@JoshuaBatty JoshuaBatty requested a review from a team May 20, 2025 04:11
@JoshuaBatty JoshuaBatty merged commit c2bb986 into master May 20, 2025
43 checks passed
@JoshuaBatty JoshuaBatty deleted the josh/token_map branch May 20, 2025 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language server LSP server performance Everything related to performance, speed wise or memory wise.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow a single Engines to be used across a workspace forc-lsp consuming a ton of memory
3 participants