[Serialization] Intro -Rmodule-recovery to remark on inconsistencies in swiftmodule files
#66139
Conversation
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
Move some deserialization error handling services to methods under ModuleFile. This will give access to the ASTContext and allow to report diagnostics. Also rename `consumeErrorIfXRefNonLoadedModule` into the more general `consumeExpectedError` that is more appropriate for future improvements.
Intro the service `diagnoseAndConsumeError` as the ultimate site to drop deserialization issues we can recover from. It will be used to raise diagnostics on the issues before dropping them silently.
Deserialization recovery silently drops errors and the affected decls. This can lead to surprises when a function from an imported module simply disappears without an explanation. This commit introduces the flag -Rmodule-recovery to report as remarks some of these previously silently dropped issues. It can be used to debug project configuration issues.
|
@swift-ci Please smoke test |
1 similar comment
|
@swift-ci Please smoke test |
bnbarham
approved these changes
May 26, 2023
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.
Deserialization recovery is a long standing feature designed to support reading from swiftmodule files despite small context changes. It is expected for recovery to drop errors related to Swift language version differences or cross-references to implementation-only imported modules. However, it also attempts to recover from project configuration issues, which can lead to unexpected behavior like silently dropping a function because it relies on a type that can't be deserialized. These issues used to be hard to investigate for the general developer.
To improve the situation, this PR introduces the flag
-Rmodule-recoverythat will display remarks when recovery drops a decl for any reason.This follows #65713 that introduced the errors that can now be also displayed as remarks. Next I'll add contextual notes and try to improve how we display these diagnostics.