-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
types(models+query): infer return type from schema for 1-level deep nested paths #14632
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
hasezoey
reviewed
Jun 2, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Merging this into 8.5 branch in the interest of caution |
This was referenced Jul 30, 2024
This was referenced Jul 30, 2024
This was referenced Aug 2, 2024
This was referenced Sep 1, 2024
This was referenced Sep 3, 2024
This was referenced Sep 4, 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.
Fix #14615
Re: #13836
Re: #12064
Summary
Fixes #14615 by inferring the type of 1-level deep schema paths to help with query filters. Consider the following schema:
Currently, Mongoose can infer
await MyRecord.distinct('foo').exec()
return type becausefoo
is a top-level path. But notawait MyRecord.distinct('foo.one').exec()
becausefoo.one
is nested.As per discussion in #12064, we don't want to infer arbitrarily deep nested paths: too risky because we don't want to run into the dreaded
Type instantiation is excessively deep and possibly infinite
error in an unforeseen case, and we don't want to cause performance issues.However, #14615 encourages us to consider just the case of 1-level deep nested paths. If we cut off at 1 level, we don't need to worry about infinite recursion and risk of performance degradation is much lower.
This PR adds a reasonably simple
WithLevel1NestedPaths
helper which, given a type, also adds all the 1-level deep nested paths to the result type. That makes it easy to get the correct result type fordistinct()
with 1-level deep nested paths. This PR intentionally avoids arrays.Examples