fix: handle multi-file spec circular reference edge case #333
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
Codecov Report
@@ Coverage Diff @@
## main #333 +/- ##
==========================================
+ Coverage 91.90% 91.92% +0.01%
==========================================
Files 73 73
Lines 2348 2353 +5
Branches 598 600 +2
==========================================
+ Hits 2158 2163 +5
Misses 157 157
Partials 33 33
Continue to review full report at Codecov.
|
Legion112
reviewed
Sep 28, 2021
barrett-schonefeld
approved these changes
Sep 28, 2021
The validator chokes on a specific scenario - when a multi-file spec has schemas that reference each other in a ciruclar manner across files. The bundler we use to put together mutli-file specs doesn't store the reference in a helpful way, so there's not really a way to report the location of the circular reference the way we do for other scenarios. All we can really do is avoid crashing completely and send the user the fully resolved path to the problematic schema that they will need to trace manually. A test is added to capture the behavior. This test case would exhibit the crash without the fix.
dpopp07
force-pushed
the
dp/fix-circular-ref-edge-case
branch
from
1ee7897
to
681ae05
Compare
ibm-devx-sdk
pushed a commit
that referenced
this pull request
Sep 29, 2021
## [0.50.1](v0.50.0...v0.50.1) (2021-09-29) ### Bug Fixes * handle multi-file spec circular reference edge case ([#333](#333)) ([172c027](172c027))
|
🎉 This PR is included in version 0.50.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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 validator chokes on a specific scenario - when a multi-file spec
has schemas that reference each other in a ciruclar manner across files.
The bundler we use to put together mutli-file specs doesn't store the
reference in a helpful way, so there's not really a way to report the
location of the circular reference the way we do for other scenarios.
All we can really do is avoid crashing completely and send the user the
fully resolved path to the problematic schema that they will need to
trace manually.
A test is added to capture the behavior. This test case would exhibit the
crash without the fix.
Resolves #326