feat: compound id fields support

[ymc9]

Summary by CodeRabbit

• Bug Fixes

  • Improved handling of compound unique and compound ID fields, ensuring correct behavior for create, update, upsert, and delete operations, including nested relation updates.
  • Disconnect operations on non-existing or mismatched related entities now succeed silently without errors.
  • Disconnect and delete operations are now restricted to optional or to-many relations where appropriate.

• New Features

  • Added comprehensive support and validation for compound unique fields and compound IDs in filters and relation operations.

• Tests

  • Introduced extensive tests for compound ID handling in both to-one and to-many relations.
  • Updated existing tests to reflect new disconnect behavior and compound ID support.

• Documentation

  • Updated TODO list to reflect completed and updated tasks related to ORM features and multi-schema support.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces comprehensive support for compound (multi-field) unique identifiers throughout the ORM client, including CRUD types, filter normalization, validation, and relation manipulation. It also refines disconnect behavior for relations, updates test expectations for disconnect operations, and adds a new test suite to verify compound ID handling in various CRUD and nested mutation scenarios.

Changes

File(s)	Change Summary
packages/runtime/src/client/crud-types.ts	Renamed WhereUnique to WhereUniqueInput, updated all usages, and refactored relation update input types for clearer handling of to-one and to-many relations and compound unique keys.
packages/runtime/src/client/crud/operations/base.ts	Added normalization for relation manipulation inputs, improved disconnect logic, introduced compound unique filter flattening, and added policy plugin detection.
packages/runtime/src/client/crud/operations/update.ts	Modified error throwing for policy rejection to depend on policy plugin status; added comment about null result on cascading deletes.
packages/runtime/src/client/crud/dialects/base.ts	Integrated compound unique filter flattening in filter building logic.
packages/runtime/src/client/crud/validator.ts	Enhanced validation for compound unique fields, refined required field checks, and restricted disconnect/delete operations to appropriate relation types.
packages/runtime/src/client/query-utils.ts	Changed structure of getUniqueFields return type and added flattenCompoundUniqueFilters utility for compound unique filters.
packages/runtime/src/client/helpers/schema-db-pusher.ts	Updated createModelField to accept model definition and only set primary key at column level for single-field IDs.
packages/runtime/test/client-api/compound-id.test.ts	Added a comprehensive test suite for CRUD and nested operations involving compound IDs in to-one and to-many relations.
packages/runtime/test/client-api/relation.test.ts	Added a test for disconnecting a non-matching tag in many-to-many relations, ensuring no effect on the relation.
packages/runtime/test/client-api/update.test.ts	Adjusted disconnect operation tests to expect silent success when disconnecting non-existing or mismatched related entities.
packages/runtime/test/policy/connect-disconnect.test.ts	Updated disconnect tests to expect successful resolution and inclusion of related data, even when policy restrictions apply.
TODO.md	Updated task statuses for ORM features, marking compound ID and related tasks as complete or incomplete as appropriate.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ORM
    participant Validator
    participant DB

    Client->>ORM: Request (e.g., update with compound ID)
    ORM->>Validator: Validate input (compound unique)
    Validator->>ORM: Return validation result
    ORM->>ORM: Flatten compound unique filters
    ORM->>DB: Build and execute query with flattened filter
    DB-->>ORM: Return result
    ORM-->>Client: Return final result

Loading

sequenceDiagram
    participant Client
    participant ORM
    participant Validator
    participant DB

    Client->>ORM: Relation manipulation (connect/disconnect/set) with compound ID
    ORM->>ORM: Normalize relation input (flatten compound filters)
    ORM->>Validator: Validate normalized input
    Validator->>ORM: Return validation result
    ORM->>DB: Perform relation operation
    DB-->>ORM: Return operation result
    ORM-->>Client: Return updated entity/relation

Loading

Possibly related PRs

• zenstackhq/zenstack-v3#6: Adjusts RejectedByPolicyError throwing logic for update operations, closely related to the policy enforcement changes in this PR.

Poem

In fields where IDs entwine and grow,
Compound keys now steal the show.
Relations connect, disconnect with grace,
Filters flatten, tests embrace.
With every hop, the data flows—
A rabbit’s code, where logic glows!
🐇✨

---

📜 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 b4321e7 and 3a99a24.

📒 Files selected for processing (12)

• TODO.md (3 hunks)
• packages/runtime/src/client/crud-types.ts (15 hunks)
• packages/runtime/src/client/crud/dialects/base.ts (3 hunks)
• packages/runtime/src/client/crud/operations/base.ts (16 hunks)
• packages/runtime/src/client/crud/operations/update.ts (1 hunks)
• packages/runtime/src/client/crud/validator.ts (6 hunks)
• packages/runtime/src/client/helpers/schema-db-pusher.ts (2 hunks)
• packages/runtime/src/client/query-utils.ts (3 hunks)
• packages/runtime/test/client-api/compound-id.test.ts (1 hunks)
• packages/runtime/test/client-api/relation.test.ts (1 hunks)
• packages/runtime/test/client-api/update.test.ts (4 hunks)
• packages/runtime/test/policy/connect-disconnect.test.ts (2 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.