Add terminateCircularRelationships option #31
Merged
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
Closed
ardeois
approved these changes
Oct 8, 2020
package.json
Outdated
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "graphql-codegen-typescript-mock-data", | |||
| "version": "1.2.1", | |||
| "version": "1.3.0", | |||
There was a problem hiding this comment.
don't bump the version yourself, the CI will handle that
There was a problem hiding this comment.
Ah cool, reverted that change
|
Thank you for the quick review! That's awesome |
|
@ardeois Any chance this could get merged and released this week? I'd like to be able to pull it in directly rather than have to use a fork in the interim |
|
Yes thanks for the reminder, I'll check it today |
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.
I ran into #13 when trying to bring in this plugin.
This introduces an option, terminateCircularRelationships, that when enabled, allows a particular type to only be resolved once by the mocks in a particular call stack. After the first time, subsequent resolutions will return an empty object.
This does not affect overrides, so if you need a circular structure, it can still be achieved using overrides.
Testing was a little tricky, because this issue doesn't present itself until you actually call one of the generated mock functions.
What I've done is created a script (tests/circular-mocks/create-mocks.ts) that generates a set of mock functions for a schema with circular relationships. I hooked it up as a jest global set up script, so it will run before any test runs.
Then added a new test that imports the generated file and runs the mock functions (tests/circular-mocks/spec.ts)
I also pulled the code into our codebase, turned on the option, and it resolved the infinite recursion.