bugfix/ErrorMessages reflective field scan runs before object is fully initialized#2856
Open
jutur wants to merge 1 commit into
Open
bugfix/ErrorMessages reflective field scan runs before object is fully initialized#2856jutur wants to merge 1 commit into
jutur wants to merge 1 commit into
Conversation
…y initialized allFields (used to build the Swagger error-code lookup table) reflectively scans this object's own declared fields, but as an eager val this scan can run while the ErrorMessages object is still being constructed. Fields declared later in the file (errorToCode, isValidName) are not yet assigned at that point, and the outcome depends on JVM/reflection field-ordering, which the JVM spec doesn't guarantee and which can differ between environments (e.g. a local run vs. a packaged Docker deployment). Making allFields a lazy val defers the reflective scan until first actual use. Its only consumer (SwaggerJSONFactory.errorDefinitions) accesses it well after application boot during on-demand Swagger doc generation, so by then the object is guaranteed to be fully initialized regardless of field-declaration order. I have read and agree to the Harmony Individual Contributor Assignment Agreement (Harmony_Individual_Contributor_Assignment_Agreement.txt). Signed: Abhinav Reddy
|
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.
Related to #2624
allFields (used to build the Swagger error-code lookup table) reflectively scans this object's own declared fields, but as an eager val this scan can run while the ErrorMessages object is still being constructed. Fields declared later in the file (errorToCode, isValidName) are not yet assigned at that point, and the outcome depends on JVM/reflection field-ordering, which the JVM spec doesn't guarantee and which can differ between environments (e.g. a local run vs. a packaged Docker deployment).
Making allFields a lazy val defers the reflective scan until first actual use. Its only consumer (SwaggerJSONFactory.errorDefinitions) accesses it well after application boot during on-demand Swagger doc generation, so by then the object is guaranteed to be fully initialized regardless of field-declaration order.
I have read and agree to the Harmony Individual Contributor Assignment Agreement (Harmony_Individual_Contributor_Assignment_Agreement.txt).
Signed: Abhinav Reddy