fix: mark InstrumentationState callback params as @Nullable - #4435
Open
arimu1 wants to merge 1 commit into
Open
Conversation
createState()/createStateAsync() may return null, and the default SimplePerformantInstrumentation.createState() does. After @NullMarked on instrumentation classes (graphql-java#4272), unannotated state parameters were treated as non-null in Kotlin, causing NPEs for stateless subclasses. Annotate callback state parameters as @nullable to match the optional- state runtime contract. ChainedInstrumentation asserts non-null when casting its own materialized ChainedInstrumentationState. Fixes graphql-java#4433
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
1 participant
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
Fixes #4433
After the JSpecify instrumentation annotations in #4272,
SimplePerformantInstrumentation(and related@NullMarkedinstrumentation types) exposed unannotatedInstrumentationStatecallback parameters as non-null to Kotlin. At runtime,createState()/createStateAsync()remain nullable andSimplePerformantInstrumentation.createState()returnsnullby default, so Kotlin subclasses that override hooks without providing a marker state fail with:This change annotates callback
stateparameters as@Nullableto match the existing optional-state runtime contract (preferred fix from the issue).Changes
InstrumentationStatecallback parameters@NullableonInstrumentation,SimplePerformantInstrumentation,ChainedInstrumentation,NoContextChainedInstrumentation, and built-in implementors that override those hooksChainedInstrumentationasserts non-null when casting to its ownChainedInstrumentationState(always materialized viacreateStateAsync)createStateand full execution with a statelessSimplePerformantInstrumentationsubclassTest plan
./gradlew test --tests graphql.execution.instrumentation.InstrumentationDefaultMethodsTest --tests graphql.execution.instrumentation.InstrumentationTest --tests graphql.execution.instrumentation.ChainedInstrumentationStateTest --tests graphql.execution.instrumentation.NoContextChainedInstrumentationTest --tests graphql.execution.instrumentation.TracingInstrumentationTest(36 tests, Temurin 21)./gradlew compileJava(NullAway / ErrorProne clean)