Skip to content

[5.10] Never return error for diagnostics request #1022

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

Jump to bottom
Merged
merged 1 commit into from
Jan 17, 2024
Merged

[5.10] Never return error for diagnostics request #1022

merged 1 commit into from
Jan 17, 2024

Conversation

ahoppen
Copy link
Member

@ahoppen ahoppen commented Jan 13, 2024 •
edited
Loading

  • Explanation: VS Code does not request diagnostics again for a document if the diagnostics request failed. Since sourcekit-lsp usually recovers from failures (e.g. after sourcekitd crashes), this is undesirable. Instead of returning an error, return empty results. This causes VS Code to re-request diagnostics after an edit is made, which will succeed after sourcekitd has been restarted.
  • Scope: The SourceKit-LSP diagnostics request after sourcekitd crashed
  • Risk: Very low, just returns empty results where it used to return an error
  • Testing: Manual testing of the change in Never return error for diagnostics request #981. This is functionally equivalent and trivial
  • Issue: SourceKit-LSP not reporting diagnostics #958 / rdar://117732149
  • Reviewer: @bnbarham

@ahoppen
Never return error for diagnostics request
47b1d61 
VS Code does not request diagnostics again for a document if the diagnostics request failed. Since sourcekit-lsp usually recovers from failures (e.g. after sourcekitd crashes), this is undesirable. Instead of returning an error, return empty results.
@ahoppen ahoppen requested a review from bnbarham January 13, 2024 01:23
@ahoppen ahoppen requested a review from benlangmuir as a code owner January 13, 2024 01:23
@ahoppen
Copy link
Member Author

ahoppen commented Jan 13, 2024

@swift-ci Please test

@ahoppen ahoppen merged commit 78c59db into swiftlang:release/5.10 Jan 17, 2024
@ahoppen ahoppen deleted the ahoppen/5.10/never-error-for-diagnostics-request branch January 17, 2024 23:05
@ahoppen ahoppen mentioned this pull request Jan 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bnbarham bnbarham bnbarham approved these changes

@airspeedswift airspeedswift airspeedswift approved these changes

@benlangmuir benlangmuir Awaiting requested review from benlangmuir

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ahoppen @bnbarham @airspeedswift