[Nullable Context] Proposal for better null-state static analysis with IPostConfigureOptions
#6950
Conversation
This file contains 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
schmittjoseph
commented
Jul 3, 2024
| // Guaranteed to not be null by StoragePostConfigureOptions.PostConfigure. | ||
| string dumpTempFolder = _storageOptions.CurrentValue.DumpTempFolder!; | ||
| StorageOptions options = _storageOptions.CurrentValue; | ||
| OptionsUtils.ThrowIfNotConfigured<StorageOptions>(options.Configured); |
There was a problem hiding this comment.
This properly informs the compiler's null-state static analysis because:
Options.ThrowIfNotConfiguredstatically tell the compiler that ifoptions.Configuredis false it will never return.StorageOptions.Configured's getter method statically tells the compiler that if it is true then certain members (e.g.DumpTempFolder) will not be null.
Ref: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/attributes/nullable-analysis
schmittjoseph
changed the title
IPostConfigureOptionsIPostConfigureOptions
schmittjoseph
commented
Jul 3, 2024
|
|
||
| internal bool Configured | ||
| { | ||
| [MemberNotNullWhen(true, nameof(DumpTempFolder))] |
There was a problem hiding this comment.
note: This supports specifying multiple members, e.g.
[MemberNotNullWhen(true, nameof(DumpTempFolder), nameof(SharedLibraryPath))]
dotnet-policy-service
bot
added
the
no-recent-activity
|
The 'no-recent-activity' label has been added to this pull request due to four weeks without any activity. If there is no activity in the next six weeks, this pull request will automatically be closed. You can learn more about our stale PR policy here: https://github.com/dotnet/dotnet-monitor/blob/main/CONTRIBUTING.md#stale-pr-policy |
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
This PR is a proposal for how we can have better null-state static analysis when dealing with our Options classes the rely on
IPostConfigureOptionsto set default values.(Also partially addresses #6929)
Release Notes Entry