fix(lsp): make update_workspace_folders perform incremental updates per LSP spec #7789

fronterior · 2025-10-19T16:17:14Z

Summary

The current implementation of update_workspace_folders incorrectly replaces the entire workspace folders list with only the added folders from the didChangeWorkspaceFolders event.

According to the LSP specification, the added and removed fields contain only the delta changes, not the complete list. This can be verified by logging event.added and event.removed in VSCode Extension's workspace.onDidChangeWorkspaceFolders handler.

This behavior may cause issues depending on how the plugin is implemented. When a new workspace folder is added to an already-open workspace, the existing folders are removed from the session's workspace_folders list, causing Biome diagnostics to stop working in those folders.

The official Biome VSCode extension does not experience this issue due to two implementation details:

It restarts the session in workspace.onDidChangeWorkspaceFolders (code)
When creating the LanguageClient, it provides the workspaceFolder field as an option. This prevents the LSP from receiving the DidChangeWorkspaceFolders event (code) (ref)

Therefore, this change does not affect the behavior of the official plugin.

Test Plan

I personally verified that there are no issues with the operation by adding logs in both the extension plugin and the update_workspace_folders function to observe behavior in VSCode. I believe it would be difficult to verify this behavior without adding such code.

The verification steps were as follows:

Run cargo build --bin biome on the current branch to build the CLI.
In the Biome Monorepo extension (which does not use the workspace field in LanguageClient), set the Biome binary path to the CLI built in step 1, build the extension, and install it in VSCode.
Add a new workspace in VSCode to trigger the DidChangeWorkspaceFolders event.
Check whether Biome diagnostics are visible for the focused file.

ASIS: Diagnostics disappeared from files in the existing workspace and did not work while editing.
TODO: Worked correctly.

I also confirmed that the official plugin is unaffected by setting the biome.lsp.bin configuration.
If reproduction is needed, I can share the branch used for these tests.

Docs

Currently, this change has no impact on end users.

changeset-bot · 2025-10-19T16:17:17Z

🦋 Changeset detected

Latest commit: 5afef18

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 13 packages

Name	Type
@biomejs/biome	Patch
@biomejs/cli-win32-x64	Patch
@biomejs/cli-win32-arm64	Patch
@biomejs/cli-darwin-x64	Patch
@biomejs/cli-darwin-arm64	Patch
@biomejs/cli-linux-x64	Patch
@biomejs/cli-linux-arm64	Patch
@biomejs/cli-linux-x64-musl	Patch
@biomejs/cli-linux-arm64-musl	Patch
@biomejs/wasm-web	Patch
@biomejs/wasm-bundler	Patch
@biomejs/wasm-nodejs	Patch
@biomejs/backend-jsonrpc	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-10-19T16:19:58Z

Walkthrough

The PR changes LSP workspace-folder handling from replacing the entire list to performing incremental updates. The did_change_workspace_folders handler now forwards both added and removed lists to update_workspace_folders (signature changed to added: Vec<WorkspaceFolder>, removed: Vec<WorkspaceFolder>). update_workspace_folders removes folders present in removed, appends those in added, and seeds the list with added if none existed.

Possibly related PRs

fix(lsp): project loading #7418: Modifies Session.update_workspace_folders to accept separate added and removed lists and updates server call sites accordingly.

Suggested reviewers

siketyan

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "fix(lsp): make update_workspace_folders perform incremental updates per LSP spec" is directly aligned with the main changeset. It accurately describes the core change: converting the workspace folders update logic from complete replacement to incremental delta-based updates as per the LSP specification. The title is concise, specific, and follows conventional commit format, making it immediately clear to anyone scanning the git history what this fix addresses.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

crates/biome_lsp/src/session.rs (1)

618-619: Optional: Remove trailing blank lines.

Two consecutive blank lines here—one would suffice.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9047c44 and 28a3a0d.

📒 Files selected for processing (3)

.changeset/fair-crabs-play.md (1 hunks)
crates/biome_lsp/src/server.rs (1 hunks)
crates/biome_lsp/src/session.rs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

crates/biome_*/**

📄 CodeRabbit inference engine (CLAUDE.md)

Place core crates under /crates/biome_*/

Files:

crates/biome_lsp/src/session.rs
crates/biome_lsp/src/server.rs

**/*.rs

📄 CodeRabbit inference engine (CONTRIBUTING.md)

**/*.rs: Format Rust files before committing (e.g., via just f which formats Rust)
Document rules, assists, and options with inline rustdoc in source

Files:

crates/biome_lsp/src/session.rs
crates/biome_lsp/src/server.rs

.changeset/*.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

.changeset/*.md: In changesets, only use #### or ##### headers; other header levels are not allowed
Changesets should cover user-facing changes only; internal changes do not need changesets
Use past tense for what you did and present tense for current Biome behavior in changesets
When fixing a bug in a changeset, start with an issue link (e.g., “Fixed #1234: …”)
When referencing a rule or assist in a changeset, include a link to its page on the website
Include code blocks in changesets when applicable to illustrate changes
End every sentence in a changeset with a period

Files:

.changeset/fair-crabs-play.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)

GitHub Check: Documentation
GitHub Check: End-to-end tests
GitHub Check: Test (depot-ubuntu-24.04-arm-16)
GitHub Check: Test Node.js API
GitHub Check: Test (depot-windows-2022-16)
GitHub Check: Lint project (depot-windows-2022)
GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
GitHub Check: Check Dependencies
GitHub Check: autofix
GitHub Check: lint

🔇 Additional comments (3)

.changeset/fair-crabs-play.md (1)

1-5: LGTM!

The changeset clearly describes the fix in past tense and follows the guidelines.

crates/biome_lsp/src/session.rs (1)

598-616: Incremental update logic looks correct.

The implementation properly handles both cases: updating existing folders (retain + extend) and initialising when none exist. The empty checks are sensible optimisations.

crates/biome_lsp/src/server.rs (1)

410-410: LGTM!

The call now correctly passes both added and removed to align with the updated API signature. The removed folders are properly used earlier (lines 390-408) to close projects before updating the list.

arendjr · 2025-10-24T15:26:05Z

.changeset/fair-crabs-play.md

+"@biomejs/biome": patch
+---
+
+Fixed workspace/didChangeWorkspaceFolders to perform incremental updates per LSP spec instead of replacing the entire folder list


Suggested change

Fixed workspace/didChangeWorkspaceFolders to perform incremental updates per LSP spec instead of replacing the entire folder list

Fixed the LSP method `workspace/didChangeWorkspaceFolders` to perform incremental updates instead of replacing the entire folder list.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

.changeset/fair-crabs-play.md (1)

1-5: Consider adding an issue link if applicable.

The changeset is well-formed and compliant with most guidelines (correct frontmatter, past tense, trailing period). However, per the coding guidelines, bug-fix changesets should start with an issue link. If there's a related issue (e.g., "Fixed #1234: …"), please prepend it to the description.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 86bf00d and 5afef18.

📒 Files selected for processing (1)

.changeset/fair-crabs-play.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

.changeset/*.md

📄 CodeRabbit inference engine (CONTRIBUTING.md)

.changeset/*.md: In changesets, only use #### or ##### headers; other header levels are not allowed
Changesets should cover user-facing changes only; internal changes do not need changesets
Use past tense for what you did and present tense for current Biome behavior in changesets
When fixing a bug in a changeset, start with an issue link (e.g., “Fixed #1234: …”)
When referencing a rule or assist in a changeset, include a link to its page on the website
Include code blocks in changesets when applicable to illustrate changes
End every sentence in a changeset with a period

Files:

.changeset/fair-crabs-play.md

…er LSP spec (biomejs#7789) Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

…er LSP spec (#7789) Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

fix(lsp): handle workspace folders changes incrementally

28a3a0d

github-actions bot added the A-LSP Area: language server protocol label Oct 19, 2025

coderabbitai bot reviewed Oct 19, 2025

View reviewed changes

fronterior and others added 2 commits October 20, 2025 01:22

chore: remove extra blank lines

2a9bbea

[autofix.ci] apply automated fixes

86bf00d

arendjr approved these changes Oct 24, 2025

View reviewed changes

docs: improve changes description clarity

5afef18

coderabbitai bot reviewed Oct 24, 2025

View reviewed changes

ematipico approved these changes Oct 25, 2025

View reviewed changes

ematipico merged commit d5b416e into biomejs:main Oct 25, 2025
12 of 13 checks passed

github-actions bot mentioned this pull request Oct 24, 2025

ci: release #7842

Merged

This was referenced Oct 26, 2025

chore(deps): update dependency @biomejs/biome to 2.3.10 stacksjs/biome-config#22

Open

chore(deps): update dependency @biomejs/biome to 2.3.10 pickier/pickier#519

Open

Jagget pushed a commit to Jagget/biome that referenced this pull request Oct 27, 2025

fix(lsp): make update_workspace_folders perform incremental updates p…

ddac769

…er LSP spec (biomejs#7789) Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Conaclos pushed a commit that referenced this pull request Nov 1, 2025

fix(lsp): make update_workspace_folders perform incremental updates p…

a44e1b2

…er LSP spec (#7789) Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(lsp): make update_workspace_folders perform incremental updates per LSP spec #7789

fix(lsp): make update_workspace_folders perform incremental updates per LSP spec #7789

Uh oh!

fronterior commented Oct 19, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Oct 19, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Oct 19, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

arendjr Oct 24, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	Fixed workspace/didChangeWorkspaceFolders to perform incremental updates per LSP spec instead of replacing the entire folder list
	Fixed the LSP method `workspace/didChangeWorkspaceFolders` to perform incremental updates instead of replacing the entire folder list.

Uh oh!

fix(lsp): make update_workspace_folders perform incremental updates per LSP spec #7789

fix(lsp): make update_workspace_folders perform incremental updates per LSP spec #7789

Uh oh!

Conversation

fronterior commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Docs

Uh oh!

changeset-bot bot commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Possibly related PRs

Suggested reviewers

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

arendjr Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fronterior commented Oct 19, 2025 •

edited

Loading

changeset-bot bot commented Oct 19, 2025 •

edited

Loading

coderabbitai bot commented Oct 19, 2025 •

edited

Loading