implementing groupBy

[ymc9]

Summary by CodeRabbit

• New Features

  • Added support for "group by" queries, enabling users to group results by one or more fields and apply aggregations such as count, average, sum, min, and max.
  • Enhanced aggregate queries to support ordering by scalar, relational, and aggregation fields.

• Bug Fixes

  • Improved error handling and validation for group-by and aggregate queries, ensuring proper usage and clearer error messages.

• Tests

  • Introduced comprehensive tests for group-by and aggregate query functionalities, including validation of various aggregation and ordering scenarios.

• Chores

  • Updated build process to include type-checking for test files.
  • Adjusted TypeScript configurations to better separate source and test code compilation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce full support for the "groupBy" feature in the ORM runtime, including type definitions, validation, query execution, and comprehensive tests. Enhancements were made to aggregation and ordering logic, type safety, and test infrastructure. The build process now includes type-checking for both source and test files, with new configuration files to support this workflow.

Changes

File(s)	Change Summary
TODO.md	Marked "Group by" feature as completed in the ORM tasks.
packages/runtime/package.json, tsconfig.json, tsconfig.test.json	Updated build script to include type-checking for tests; added test-specific TypeScript config.
.../src/client/client-impl.ts, .../crud/operations/group-by.ts, .../crud/validator.ts	Added and integrated groupBy operation: handler, validation, and client API support.
.../src/client/crud-types.ts, .../utils/type-utils.ts	Refined and extended type definitions for filtering, ordering, aggregation, and grouping.
.../src/client/crud/dialects/base.ts, .../crud/operations/aggregate.ts	Enhanced orderBy logic to support aggregation fields and improved query construction for aggregation.
.../src/client/crud/operations/base.ts	Updated type usage for filter conditions in update operations.
.../src/client/executor/name-mapper.ts	Refactored selection transformation logic for more flexible select-all and alias handling.
.../src/client/executor/zenstack-query-executor.ts	Simplified error message for query execution failures.
.../test/client-api/aggregate.test.ts	Added/updated tests for aggregate queries, including ordering and type safety.
.../test/client-api/group-by.test.ts	Added comprehensive tests for the new groupBy feature, covering various scenarios and error cases.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ModelHandler
    participant GroupByHandler
    participant Validator
    participant QueryBuilder
    participant Database

    Client->>ModelHandler: client.<model>.groupBy(args)
    ModelHandler->>Validator: validateGroupByArgs(model, args)
    Validator-->>ModelHandler: validatedArgs
    ModelHandler->>GroupByHandler: handle('groupBy', validatedArgs)
    GroupByHandler->>QueryBuilder: build groupBy query (with filter, order, aggregation)
    QueryBuilder->>Database: Execute SQL
    Database-->>QueryBuilder: Result rows
    GroupByHandler->>GroupByHandler: Post-process results (nesting, type conversion)
    GroupByHandler-->>ModelHandler: Grouped results
    ModelHandler-->>Client: Grouped results

Loading

Poem

In the garden of code, a new feature grew,
GroupBy hops in, with columns to view!
Aggregates and filters, relations in tow,
Type safety checked, as the carrots all know.
With tests in the meadow and queries that fly—
Hooray for the rabbits, who group and reply!
🥕✨

---

📜 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 8ceca57 and a21fd2e.

📒 Files selected for processing (16)

• TODO.md (1 hunks)
• packages/runtime/package.json (1 hunks)
• packages/runtime/src/client/client-impl.ts (2 hunks)
• packages/runtime/src/client/crud-types.ts (21 hunks)
• packages/runtime/src/client/crud/dialects/base.ts (2 hunks)
• packages/runtime/src/client/crud/operations/aggregate.ts (2 hunks)
• packages/runtime/src/client/crud/operations/base.ts (2 hunks)
• packages/runtime/src/client/crud/operations/group-by.ts (1 hunks)
• packages/runtime/src/client/crud/validator.ts (8 hunks)
• packages/runtime/src/client/executor/name-mapper.ts (2 hunks)
• packages/runtime/src/client/executor/zenstack-query-executor.ts (1 hunks)
• packages/runtime/src/utils/type-utils.ts (1 hunks)
• packages/runtime/test/client-api/aggregate.test.ts (3 hunks)
• packages/runtime/test/client-api/group-by.test.ts (1 hunks)
• packages/runtime/tsconfig.json (1 hunks)
• packages/runtime/tsconfig.test.json (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.