separate getPropertyBatchLoader #329
Merged
Conversation
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
magicmark
reviewed
Aug 3, 2021
src/implementation.ts
Outdated
| requestGroups = partitionItems('${resourceConfig.newKey}', keys); | ||
| } | ||
| function getBatchResourceCommonLoader(resourceConfig: BatchResourceConfig, resourcePath: ReadonlyArray<string>) { |
There was a problem hiding this comment.
As I understand it, there's now 3 top level loader implementation functions:
- getPropertyBatchLoader
- getBatchLoader
- getNonBatchLoader
which makes sense.
The naming of "getBatchResourceCommonLoader" makes me think it might be another top level factory function (it follows the same naming getXYZLoader pattern), but I guess it's not - it's a helper shared between getPropertyBatchLoader and getBatchLoader? So maybe we could just tweak the name to clarify this?
maybe something like:
Suggested change
| function getBatchResourceCommonLoader(resourceConfig: BatchResourceConfig, resourcePath: ReadonlyArray<string>) { | |
| /** | |
| * This is a helper to implement the batch logic, shared between blah blah blah | |
| * | |
| function batchLoaderLogic(resourceConfig: BatchResourceConfig, resourcePath: ReadonlyArray<string>) { |
(with a lil docstring to clarify)
magicmark
reviewed
Aug 3, 2021
Comment on lines
-84
to
-91
| assert( | ||
| resourceConfig.isBatchResource === true, | ||
| `${errorPrefix(resourcePath)} Expected getBatchLoader to be called with a batch resource config`, | ||
| ); | ||
| assert( | ||
| typeof resourceConfig.batchKey === 'string' && typeof resourceConfig.newKey === 'string', | ||
| `${errorPrefix(resourcePath)} Expected both batchKey and newKey for a batch resource`, | ||
| ); |
There was a problem hiding this comment.
do we want to keep these assertions?
There was a problem hiding this comment.
gyDBD
added a commit
that referenced
this pull request
Aug 4, 2021
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.
function
unPartitionResultsByBatchKeyPartitionis used to help us split the results back up into the order that they were requested. And it requires some certain contract of the resource, see https://github.com/Yelp/dataloader-codegen/blob/master/API_DOCS.md#batch-resources-with-properties-parametersI have to separate the
getPropertyBatchLoaderand the normalgetBatchLoader, otherwise, all resources withisBatchResource: truewill haveunPartitionResultsByBatchKeyPartitioninside the codegen, and throw flow errors.What's the change?
getPropertyBatchLoader, which will only be called whenproperyBatchkey is being used.getPropertyBatchLoaderand thegetBatchLoaderinto a functiongetBatchResourceCommonLoaderto avoid copy and paste hundred of lines of codetest
make test passed
test on swapi example