Don't delete RBI files for missing constants in LSP addon mode#2526
Draft
Don't delete RBI files for missing constants in LSP addon mode#2526
Conversation
When the LSP addon requests DSL generation for a constant that can't be found (e.g., due to a failed reload or mid-edit syntax error), the existing code deletes the RBI file and raises an error. This is wrong in addon mode — the constant may be temporarily unavailable and its RBI should be preserved. Skip both deletion paths in addon mode: - constantize: don't delete RBI or raise for unprocessable constants - dsl_generate: don't purge "stale" RBI files Fixes Shopify/team-ruby-dx#1711
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
When the LSP addon requests DSL generation for a constant that can't be found (e.g., due to a failed reload or a mid-edit syntax error), the existing code:
This is wrong in addon mode. The constant may be temporarily unavailable (user is mid-edit, reload failed, server has stale state). Deleting the RBI means Sorbet loses type information until the next successful generation.
Changes
Two deletion paths are fixed:
abstract_dsl.rb(constantize): Skip deleting RBI and skip raising error when@lsp_addonis truedsl_generate.rb(execute): Skippurge_stale_dsl_rbi_fileswhen@lsp_addonis trueTesting
End-to-end test with a real Rails runner client:
NotifyUserJobAll 4 existing addon tests pass.
Related