refactor: make query helpers more consistently fit our loose definition of helpers #14350
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
hasezoey
approved these changes
Feb 14, 2024
AbdelrahmanHafez
approved these changes
Feb 14, 2024
Co-authored-by: hasezoey <hasezoey@gmail.com>
Co-authored-by: hasezoey <hasezoey@gmail.com>
hasezoey
approved these changes
Feb 20, 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.
Summary
This PR is more of an architecture discussion. In my mind, a "helper" ideally should be a function that takes as argument only non-Mongoose objects, with the potential exception of schemas and SchemaTypes. So no models or queries or constructors or anything like that, unless they are only used as context for some callback function like in
castFilterPath.Why is this important? Makes helpers much easier to test, reason about, and reuse. Once you have to instantiate a model and a connection, that makes testing slower.
In that vein, in this PR I'm moving a couple of functions in
helpers/queryout intoquery.js, refactored a couple of helpers to use just POJO options objects rather than a full model, and moved some constants into aconstants.jsfile (helpers should always be functions).WDYT @AbdelrahmanHafez @hasezoey @IslandRhythms ?
Examples