Skip to content

Conversation

@ymc9
Copy link
Member

@ymc9 ymc9 commented May 25, 2025

Summary by CodeRabbit

  • New Features

    • Added support for selecting nested relations in queries, allowing more flexible data retrieval.
    • Introduced a comprehensive test suite for deep nested operations under complex policy rules.
  • Bug Fixes

    • Improved error handling by providing more detailed context in policy rejection errors.
    • Enhanced handling of boolean expressions to treat null values as false in policy checks.
  • Documentation

    • Updated breaking changes documentation to clarify access policy behavior for non-optional to-one relations.
  • Refactor

    • Standardized expression usage and foreign key declarations in schema definitions for better consistency.

@coderabbitai
Copy link

coderabbitai bot commented May 25, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce enhanced error context for policy enforcement, improved handling of nested relation selections in SQLite, and significant internal refactoring of policy expression transformation to support member filters and selections. The schema definition syntax is standardized, and a comprehensive test suite for deep nested policy scenarios is added. A new breaking change is documented.

Changes

File(s) Change Summary
BREAKINGCHANGES.md Added a breaking change note: non-optional to-one relations no longer auto-filter the parent read operation during access policy evaluation.
packages/runtime/src/client/crud/dialects/sqlite.ts Refactored buildRelationJSON to support nested relation selections in the select payload; improved type clarity.
packages/runtime/src/client/crud/operations/create.ts
packages/runtime/src/client/crud/operations/update.ts
Updated error construction in runCreate and runUpdate to include the model context in RejectedByPolicyError.
packages/runtime/src/client/executor/zenstack-query-executor.ts Made proceedQuery asynchronous, added error handling and rethrowing as QueryError with SQL context.
packages/runtime/src/plugins/policy/errors.ts Modified RejectedByPolicyError constructor to accept a model argument and an optional reason, updating error messages to include model context.
packages/runtime/src/plugins/policy/expression-transformer.ts Added support for memberFilter and memberSelect in the transformation context; refactored handling of collection predicates and member access; removed recursive select query updates.
packages/runtime/src/plugins/policy/policy-handler.ts Updated all RejectedByPolicyError throws to include model or context as the first argument for better error specificity.
packages/runtime/src/plugins/policy/utils.ts Changed buildIsFalse to use coalesce for null safety in boolean expressions.
packages/runtime/test/policy/deep-nested.test.ts Added a comprehensive test suite for deep nested CRUD operations under complex policy rules, covering reads, creates, updates, deletes, and bulk operations.
samples/blog/zenstack/schema.ts Standardized default and relation expressions using Expression.call, Expression.literal, and Expression.field; marked foreign keys explicitly.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant PolicyHandler
    participant Error
    Note over PolicyHandler: During CRUD operation
    Client->>PolicyHandler: Perform operation (create/update/read)
    PolicyHandler->>PolicyHandler: Evaluate access policy
    alt Policy denied
        PolicyHandler->>Error: Throw RejectedByPolicyError(model, reason)
        Error-->>Client: Error with model context
    else Policy allowed
        PolicyHandler-->>Client: Operation proceeds
    end
Loading
sequenceDiagram
    participant Client
    participant SQLiteDialect
    participant Database
    Note over Client,SQLiteDialect: Nested relation select
    Client->>SQLiteDialect: Query with nested select
    SQLiteDialect->>SQLiteDialect: buildRelationJSON (recursive for nested relations)
    SQLiteDialect->>Database: Execute SQL with nested JSON selection
    Database-->>SQLiteDialect: Results
    SQLiteDialect-->>Client: Nested results
Loading

Poem

In tunnels deep where policies dwell,
Relations nest and stories swell.
Errors now with context gleam,
Transformers thread a clever scheme.
Foreign keys marked, expressions neat—
Rabbits hop to tests complete!
🐇✨


📜 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 742962a and ace6315.

📒 Files selected for processing (11)
  • BREAKINGCHANGES.md (1 hunks)
  • packages/runtime/src/client/crud/dialects/sqlite.ts (3 hunks)
  • packages/runtime/src/client/crud/operations/create.ts (1 hunks)
  • packages/runtime/src/client/crud/operations/update.ts (1 hunks)
  • packages/runtime/src/client/executor/zenstack-query-executor.ts (2 hunks)
  • packages/runtime/src/plugins/policy/errors.ts (1 hunks)
  • packages/runtime/src/plugins/policy/expression-transformer.ts (7 hunks)
  • packages/runtime/src/plugins/policy/policy-handler.ts (4 hunks)
  • packages/runtime/src/plugins/policy/utils.ts (2 hunks)
  • packages/runtime/test/policy/deep-nested.test.ts (1 hunks)
  • samples/blog/zenstack/schema.ts (6 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
🪧 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants