fix: fix data race in schema merging logic by creating a copy instead of modifying the original struct instance #397
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
ansgarm
force-pushed
the
b-fix-data-race-schema-merging
branch
from
a1758a4
to
38e6601
Compare
ansgarm
changed the title
ansgarm
force-pushed
the
b-fix-data-race-schema-merging
branch
from
38e6601
to
e632be0
Compare
jpogran
requested changes
Jun 5, 2024
… of modifying the original struct instance Different jobs in terraform-ls use the same `hcl.Block` instance simultaneously and the schema merger modified it in the past. We fixed this by creating a copy first which uncovered another bug: The `buildDynamicBlockSchema` function implicitly read that change from the dependent schema, which we fixed by reading from the `mergedSchema` instead. This in turn required us to also pass the dependent schema into the function as the `mergedSchema` also contains the static `lifecycle` block which can't be set via a dynamic block. This means we now iterate over all blocks in the dependent schema but copy their bodies from the `mergedSchema`.
ansgarm
force-pushed
the
b-fix-data-race-schema-merging
branch
from
e632be0
to
e29c68b
Compare
jpogran
approved these changes
Jun 5, 2024
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.
Different jobs in terraform-ls use the same
hcl.Blockinstance simultaneously and the schema merger modified it in the past.We fixed this by creating a copy first which uncovered another bug: The
buildDynamicBlockSchemafunction implicitly read that change from the dependent schema, which we fixed by reading from themergedSchemainstead. This in turn required us to also pass the dependent schema into the function as themergedSchemaalso contains the staticlifecycleblock which can't be set via a dynamic block. This means we now iterate over all blocks in the dependent schema but copy their bodies from themergedSchema.Fixes #395