annotate queries with context, support for "currentModel" and "currentOperation"

[ymc9]

Summary by CodeRabbit

• New Features

  • Added support for context-aware SQL comments in all CRUD queries, enabling better query annotation.
  • Introduced functions to access the current model and operation within policy rules, with flexible casing options.
  • Enhanced policy expression capabilities with an 'in' operator for array inclusion checks.

• Bug Fixes

  • Improved error handling for invalid casing arguments and usage of context functions outside policy contexts.

• Tests

  • Added comprehensive tests for current model and operation functions in policy rules, including casing and error scenarios.

• Refactor

  • Unified the definition and usage of CRUD operation types across the codebase for better consistency.
  • Updated function signatures and context objects to provide richer contextual information during policy evaluation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce context-aware SQL comment annotations for all CRUD operations, add and propagate a shared CRUD type, and enhance function signatures to receive a consolidated context object. New utility functions currentModel and currentOperation are implemented with casing options, and comprehensive tests are added to validate their behavior within policy rules.

Changes

File(s)	Change Summary
packages/runtime/src/client/constants.ts	Added the CONTEXT_COMMENT_PREFIX constant for annotating context in SQL comments.
packages/runtime/src/client/contract.ts	Introduced a new exported type alias CRUD for CRUD operation strings.
packages/runtime/src/client/crud/operations/base.ts	Appended context comments to all CRUD queries using a new private makeContextComment method; imported and used CONTEXT_COMMENT_PREFIX and CRUD.
packages/runtime/src/client/executor/zenstack-query-executor.ts	Removed the unused private method isCrudQueryNode from the class.
packages/runtime/src/client/functions.ts	Updated isEmpty and now to use a context object; added currentModel and currentOperation functions with casing options and validation; introduced a casing helper.
packages/runtime/src/client/options.ts	Added ZModelFunctionContext type; updated ZModelFunction to accept a context object instead of just a dialect.
packages/runtime/src/plugins/policy/expression-evaluator.ts	Added support for the 'in' binary operator in ExpressionEvaluator.
packages/runtime/src/plugins/policy/expression-transformer.ts	Extended ExpressionTransformerContext with operation: CRUD; updated function calls to receive full context.
packages/runtime/src/plugins/policy/policy-handler.ts	Changed method signatures to use CRUD instead of PolicyOperation; propagated operation context through policy filtering and transformation.
packages/runtime/src/plugins/policy/types.ts	Updated PolicyOperation type alias to use `CRUD
packages/runtime/test/policy/current-model.test.ts	Added tests for currentModel() in policies, covering casing, context, and error conditions.
packages/runtime/test/policy/current-operation.test.ts	Added tests for currentOperation() in policies, including casing options and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant BaseOperationHandler
    participant SQLQueryBuilder

    Client->>BaseOperationHandler: Initiate CRUD operation (create/read/update/delete)
    BaseOperationHandler->>SQLQueryBuilder: Build query
    BaseOperationHandler->>SQLQueryBuilder: Append context comment (model, operation)
    SQLQueryBuilder-->>BaseOperationHandler: Return query with comment
    BaseOperationHandler-->>Client: Return result

Loading

sequenceDiagram
    participant PolicyRule
    participant currentModel/currentOperation
    participant Context

    PolicyRule->>currentModel/currentOperation: Invoke function (with optional casing)
    currentModel/currentOperation->>Context: Access model/operation name
    currentModel/currentOperation->>PolicyRule: Return value (with applied casing)

Loading

Poem

🐇
In the warren where queries hop,
Context comments now adorn each stop.
CRUD and casing, functions new,
Model and operation—each gets its due.
With tests to check each clever trick,
This rabbit’s code is strong and slick!
🥕

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 0450d8b and 4bfed0a.

📒 Files selected for processing (12)

• packages/runtime/src/client/constants.ts (1 hunks)
• packages/runtime/src/client/contract.ts (1 hunks)
• packages/runtime/src/client/crud/operations/base.ts (19 hunks)
• packages/runtime/src/client/executor/zenstack-query-executor.ts (0 hunks)
• packages/runtime/src/client/functions.ts (3 hunks)
• packages/runtime/src/client/options.ts (2 hunks)
• packages/runtime/src/plugins/policy/expression-evaluator.ts (2 hunks)
• packages/runtime/src/plugins/policy/expression-transformer.ts (2 hunks)
• packages/runtime/src/plugins/policy/policy-handler.ts (5 hunks)
• packages/runtime/src/plugins/policy/types.ts (2 hunks)
• packages/runtime/test/policy/current-model.test.ts (1 hunks)
• packages/runtime/test/policy/current-operation.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.