Fix SecurityObservationSettings sample in docs - #19583
Open
patbaumgartner wants to merge 1 commit into
Open
Conversation
The sample for turning individual observations on and off did not compile. SecurityObservationSettings.Builder has no shouldObserveFilterChains method, and SecurityObservationSettings has no builder() factory. Use shouldObserveRequests and withDefaults instead, which are the methods the class actually exposes. Signed-off-by: Patrick Baumgartner <contact@patbaumgartner.com>
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.
The "turn on and off observations individually" sample in the Observability
section does not compile against any released version of Spring Security.
Two problems in the same snippet:
.shouldObserveFilterChains(true).SecurityObservationSettings.BuilderexposesshouldObserveRequests,shouldObserveAuthentications,shouldObserveAuthorizationsandbuild—there is no
shouldObserveFilterChains.SecurityObservationSettings.builder().The class only offers the static factories
noObservations()andwithDefaults(); there is nobuilder().Since the surrounding prose is about re-enabling the filter chain observations
that
withDefaults()turns off,shouldObserveRequests(true)is the intendedcall —
observeRequestsis the field that gatesspring.security.http.secured.requests.This changes documentation only; no runtime behaviour is affected.
I ran into this while checking a training module against the reference docs: the
lab used
shouldObserveRequests(true)and I initially "corrected" it to matchthe documentation, which then failed to compile.
Happy to fold in the Kotlin
builder()fix separately if you would rather keepthe two changes apart.