fix(delegate): orderBy with base field doesn't work when the clause is an array

[ymc9]

fixes #1755

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing the DelegateProxyHandler class within the delegate.ts file. Key modifications include improvements to the handling of orderBy clauses, the introduction of validation for the skipDuplicates option in creation methods, and strengthened error handling across various methods. Additionally, a new regression test suite has been added to verify the functionality of ordering in polymorphic models, specifically addressing issues related to the findMany method and its interaction with base model properties.

Changes

File Path	Change Summary
packages/runtime/src/enhancements/node/delegate.ts	Updated logic in DelegateProxyHandler methods for data retrieval and manipulation, including enhanced orderBy handling, validation checks for skipDuplicates, and reinforced error handling. Method signatures for aggregate, count, and groupBy were also updated.
tests/regression/tests/issue-1755.test.ts	Introduced a new regression test suite for issue #1755, validating ordering functionality in polymorphic models with various test cases.

Assessment against linked issues

Objective	Addressed	Explanation
Support ordering by base model properties in findMany (1755)	✅
Ensure robust error handling in delegate methods (1755)	✅
Validate the functionality of orderBy in polymorphic models (1755)	✅

Possibly related PRs

• fix(delegate): null reference when reading an optional relation #1491: Addresses a null reference error when reading optional relations, relevant to data handling in DelegateProxyHandler.
• fix(delegate): concrete model fields are not properly included if queried from a nested context from a parent concrete model #1700: Enhances handling of field values during the injection process, aligning with improvements in the main PR.
• fix(delegate): @omit and field-level policies are not enforced when querying with a delegate model #1718: Focuses on enforcing @omit and field-level policies in delegate model queries, relating to robust data handling.
• fix(delegate): policies inherited from delegate base models are not injected into proper hierarchy #1776: Addresses injection of policies inherited from delegate base models, relevant to the main PR's enhancements.
• fix(delegate): self relation support #1821: Resolves issues with self-relations in delegate models, connecting to modifications in data handling logic.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (1)

tests/regression/tests/issue-1755.test.ts (1)

1-33: LGTM! Consider expanding test coverage.

The schema correctly models the polymorphic relationship needed to test the ordering functionality. However, since Video model is defined but not used in tests, consider adding test cases for Video or remove it if not needed.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d985a73 and 201256f.

📒 Files selected for processing (2)

• packages/runtime/src/enhancements/node/delegate.ts (3 hunks)
• tests/regression/tests/issue-1755.test.ts (1 hunks)

🔇 Additional comments (2)

tests/regression/tests/issue-1755.test.ts (1)

3-61: Consider adding error case tests.

While the happy path is well tested, consider adding test cases for error scenarios:

1. Invalid orderBy field names
2. Invalid order directions
3. Mixed valid/invalid fields in array orderBy

packages/runtime/src/enhancements/node/delegate.ts (1)

1042-1042: ⚠️ Potential issue

Verify the usage of orderBy in the aggregate method

In Prisma, the aggregate method does not support the orderBy parameter. Including args.orderBy may lead to unexpected behavior or errors. Please ensure that orderBy is intended to be used here or consider removing it.

Run the following script to check for orderBy usage in aggregate methods:

This script searches for instances where orderBy is used within aggregate method calls, which can help identify potential misuse.