This repository was archived by the owner on Nov 8, 2024. It is now read-only.
Prevent throwing during freeze for required annotations #502
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
opichals
reviewed
Jun 24, 2020
| @@ -141,6 +144,13 @@ describe('#parseObject', () => { | |||
| "'Example Object' is missing required property 'required1'", | |||
| "'Example Object' is missing required property 'required2'", | |||
| ]); | |||
|
|
|||
| // assert errors can be frozen (we're testing that the source map | |||
| // for object was cloned instead of referenced) | |||
There was a problem hiding this comment.
Out of curiosity how would it look like without the clone? It is not completely obvious for me how this is testing the not-a-reference.
There was a problem hiding this comment.
freeze() would throw the following error:
Cannot assign to read only property 'parent' of object '#'
There was a problem hiding this comment.
That’s because effectively it’s doing this:
freeze() {
freeze “this”
for element in (all meta, attributes, content):
element.parent = this
element.freeze()
}
Where a re-used element would fail as we can’t set .parent on the second time around
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 parser can create multiple errors from an object which contain the exact same instance of a source map element. Thus creating integration problems using the parse result as the same element instance is re-used and thus a modification to one causes modification to others. This can be demonstrated by using
.freeze()method as that requires each element to only be used a single time within the tree.Prevents the error from being throw to users as per apiaryio/dredd#1762