feat: implement cursor and negative take

[ymc9]

Summary by CodeRabbit

• New Features

  • Added support for cursor-based pagination in find queries, enabling efficient navigation through large datasets.
  • Enhanced validation to support the new optional cursor field in queries.

• Bug Fixes

  • Corrected result ordering when using negative values for the take parameter, including nested relation results.

• Refactor

  • Unified and improved internal handling of JSON relation data aliases for consistency across different database dialects.

• Tests

  • Added comprehensive tests for cursor pagination, negative take values, and nested pagination scenarios to ensure robust query behavior.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The updates introduce cursor-based pagination to the ORM's find operations, add support for negative take values with correct result ordering, and unify JSON relation aliasing in SQL dialects. The changes include new type definitions, validation logic, utility functions, internal query handling, result post-processing, and comprehensive test coverage for these features.

Changes

File(s)	Change Summary
TODO.md	Marked "Cursor" under "Pagination" in "Find" as complete.
packages/runtime/src/client/client-impl.ts	Passes original query arguments (args) to resultProcessor.processResult for context.
packages/runtime/src/client/crud-types.ts	Added Cursor type and extended FindArgs to support cursor-based pagination.
packages/runtime/src/client/crud/dialects/postgresql.ts packages/runtime/src/client/crud/dialects/sqlite.ts	Unified JSON relation aliasing to .$j and moved join condition logic inside subquery builders.
packages/runtime/src/client/crud/operations/base.ts	Added cursor-based pagination logic in read method and moved in-memory distinct filtering post-query.
packages/runtime/src/client/crud/validator.ts	Added validation for optional cursor field in find queries.
packages/runtime/src/client/query-utils.ts	Introduced safeJSONStringify to handle bigint serialization safely.
packages/runtime/src/client/result-processor.ts	Enhanced processResult to support negative take by reversing results and fixing nested relations; refactored internal logic.
packages/runtime/test/client-api/find.test.ts	Added and updated tests for cursor pagination, negative take, and nested skip/take/orderBy in includes.
packages/runtime/test/client-api/group-by.test.ts	Added test for groupBy with skip and negative take.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant Validator
  participant OperationHandler
  participant SQLDialect
  participant ResultProcessor

  Client->>Validator: Validate find args (with cursor)
  Validator-->>Client: Validated args
  Client->>OperationHandler: read(model, args)
  OperationHandler->>SQLDialect: Build query (apply cursor filter if cursor present)
  SQLDialect-->>OperationHandler: Query with cursor-based WHERE/ORDER BY
  OperationHandler->>OperationHandler: Execute query
  OperationHandler->>ResultProcessor: processResult(data, model, args)
  ResultProcessor->>ResultProcessor: Reverse results if take < 0
  ResultProcessor-->>OperationHandler: Processed result
  OperationHandler-->>Client: Final result

Loading

Poem

In the warren of code, a cursor hops in,
Skipping and taking, it spins with a grin.
Results reversed, relations aligned,
JSON strings safe, all bugs left behind.
With tests that abound, our features now sing—
Pagination perfected, let the queries spring!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5607673 and 6f2e849.

📒 Files selected for processing (11)

• TODO.md (1 hunks)
• packages/runtime/src/client/client-impl.ts (1 hunks)
• packages/runtime/src/client/crud-types.ts (2 hunks)
• packages/runtime/src/client/crud/dialects/postgresql.ts (5 hunks)
• packages/runtime/src/client/crud/dialects/sqlite.ts (3 hunks)
• packages/runtime/src/client/crud/operations/base.ts (5 hunks)
• packages/runtime/src/client/crud/validator.ts (2 hunks)
• packages/runtime/src/client/query-utils.ts (1 hunks)
• packages/runtime/src/client/result-processor.ts (3 hunks)
• packages/runtime/test/client-api/find.test.ts (3 hunks)
• packages/runtime/test/client-api/group-by.test.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.