feat: got policies to work with todo sample

[ymc9]

Summary by CodeRabbit

• New Features

  • Introduced advanced row-level policy enforcement for CRUD operations, supporting complex access control rules based on authentication context.
  • Added support for new authentication constructs in the modeling language, including an auth() function and @@auth attribute for specifying authentication models.
  • Enhanced client API with methods to manage authentication state and reset plugins immutably.

• Improvements

  • Refined expression handling and schema generation to support more complex policy expressions, including member access and collection predicates.
  • Improved error messages for policy rejections and invariant violations.
  • Expanded test utilities and matchers for more expressive policy and not-found error assertions.
  • Added new sample and test schemas demonstrating collaborative Todo application with detailed access policies.

• Refactor

  • Replaced legacy policy plugin implementation with a new, more robust policy handler and supporting utilities.
  • Centralized and streamlined SDK utilities and schema generation logic.

• Bug Fixes

  • Fixed transaction handling and field selection in create, update, and delete operations to improve correctness and reliability.

• Chores

  • Added new SDK and test tools packages with build configurations and manifest files.
  • Updated dependencies and improved package structure for better modularity.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces a comprehensive overhaul of ZenStack's policy enforcement and authentication infrastructure. It migrates policy and authentication model configuration from plugin-based settings to a new authType property directly on the schema. The runtime policy enforcement mechanism is refactored with a new PolicyHandler class, new error types, and enhanced expression transformation logic. Supporting utilities, SDK, and test tools are modularized into new packages, with TypeScript schemas and test utilities now generated via dedicated workspace packages. Extensive changes are made to expression handling, plugin interfaces, and test matchers to align with the new architecture.

Changes

Files / Groups	Change Summary
packages/cli/package.json, packages/runtime/package.json	Updated dependencies: added/removed workspace packages, adjusted Node.js types.
packages/cli/src/actions/generate.ts, packages/cli/src/prisma/prisma-schema-generator.ts	Migrated utility and generator imports to new @zenstackhq/sdk package; updated invocation signatures.
packages/cli/test/ts-schema-gen.test.ts	Updated schema generation imports and adjusted test assertions for new relation attribute representations.
packages/cli/tsup.config.ts	Added CommonJS output format to build configuration.
packages/language/res/stdlib.zmodel	Added auth() function and @@auth() attribute for authentication context.
packages/language/src/index.ts	Extended loadDocument to accept plugin model files for loading.
packages/language/src/utils.ts	Uncommented and exported isAuthInvocation, isAuthOrAuthMemberAccess, and getAuthDecl utilities.
packages/language/src/validators/expression-validator.ts, packages/language/src/zmodel-linker.ts, packages/language/src/zmodel-scope.ts	Re-enabled and integrated handling for auth() expressions and scoping.
packages/runtime/src/client/client-impl.ts, packages/runtime/src/client/contract.ts	Added $auth, $setAuth, and $unuseAll methods for authentication state and plugin management.
packages/runtime/src/client/crud/dialects/base.ts, packages/runtime/src/client/helpers/schema-db-pusher.ts	Improved invariant error messages for array/object checks.
packages/runtime/src/client/crud/operations/base.ts, create.ts, delete.ts, update.ts	Refactored transaction handling, selective field returning, and error handling in CRUD operations.
packages/runtime/src/client/executor/name-mapper.ts	Refined select query transformation and error handling for multiple tables.
packages/runtime/src/client/executor/zenstack-query-executor.ts	Added CRUD query node detection and refactored query execution flow.
packages/runtime/src/client/options.ts	Enhanced computed fields detection with generic type guard.
packages/runtime/src/client/plugin.ts	Introduced OnKyselyQueryTransaction type alias for plugin transaction handling.
packages/runtime/src/client/query-utils.ts	Explicitly cast getIdFields return type.
packages/runtime/src/plugins/policy/column-collector.ts	Added ColumnCollector class for collecting query column names.
packages/runtime/src/plugins/policy/errors.ts	Added RejectedByPolicyError for policy rejection errors.
packages/runtime/src/plugins/policy/expression-transformer.ts	Major refactor: enhanced expression transformation for relations, member access, logical and collection predicates, and error handling.
packages/runtime/src/plugins/policy/policy-handler.ts	Added new PolicyHandler class for enforcing row-level policies on CRUD queries.
packages/runtime/src/plugins/policy/utils.ts	Added utility functions for boolean nodes, logical combinators, and table name extraction.
packages/runtime/src/schema/expression.ts	Renamed and restructured field/member expression types; added new binary operators and type guards.
packages/runtime/src/schema/schema.ts	Added authType property, removed policy types from schema, and introduced AuthType type alias.
packages/runtime/src/utils/default-operation-node-visitor.ts	Added DefaultOperationNodeVisitor for generic query AST traversal.
packages/runtime/test/client-api/delete.test.ts, update.test.ts	Renamed test matcher from .toRejectNotFound() to .toBeRejectedNotFound().
packages/runtime/test/plugin/kysely-on-query.test.ts	Added conditional query kind checks in interceptors; removed a test on partial success without transactions.
packages/runtime/test/plugin/mutation-hooks.test.ts	Skipped a test on mutation hooks and transactions for future review.
packages/runtime/test/policy/read.test.ts	Simplified policy plugin usage and switched to client-based authentication context.
packages/runtime/test/policy/todo-sample.test.ts, samples/blog/zenstack/schema.ts, samples/blog/zenstack/schema.zmodel, packages/runtime/test/schemas/todo.zmodel	Added comprehensive policy enforcement tests and migrated schema/plugin configuration to new authType property.
packages/runtime/test/test-schema.ts	Replaced policies with attributes for model policies; added authType property.
packages/runtime/test/vitest-ext.ts, vitest.d.ts	Renamed and added custom matchers for policy and not-found rejections.
packages/sdk/package.json, tsconfig.json, tsup.config.ts, src/index.ts, src/model-utils.ts, src/ts-schema-generator.ts, src/zmodel-code-generator.ts	Introduced new SDK package with utilities, code generators, and model helpers.
packages/testtools/package.json, tsup.config.ts, src/index.ts, src/schema.ts	Introduced new test tools package with schema generation helpers and test utilities.
packages/runtime/src/plugins/policy/generator.ts, policy-transformer.ts, policy/options.ts	Deleted legacy policy plugin generator and transformer code, and related types.
packages/runtime/src/plugins/policy/index.ts, plugin.ts, plugin.zmodel, types.ts	Removed legacy exports and plugin configuration, introduced new policy type definitions.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application
    participant Client as ZenStack Client
    participant Policy as PolicyHandler
    participant DB as Database

    App->>Client: .findMany(), .create(), etc.
    Client->>Policy: handle(query, client, proceed, transaction)
    alt Read Query
        Policy->>DB: SELECT ... WHERE [policy filters]
        DB-->>Policy: Result rows
        Policy-->>Client: Filtered rows
    else Mutation Query
        Policy->>DB: INSERT/UPDATE/DELETE (pre-check with policy)
        DB-->>Policy: Mutation result
        Policy->>DB: SELECT ... WHERE [policy filters] (if returning)
        DB-->>Policy: Filtered mutation result
        Policy-->>Client: Final result or policy error
    end
    Client-->>App: Result or error

Loading

Poem

🐇✨
A hop, a leap, a bounding stride,
Policies enforced with logic wide.
AuthType now within the schema’s heart,
Plugins trimmed, new handlers start!
SDKs and test tools freshly grown,
With every change, the garden’s sown—
ZenStack’s code, a field well-tended,
Hops ahead, refactored and splendid!

Tip

⚡️ 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

📥 Commits

Reviewing files that changed from the base of the PR and between aa7630c and 3db450a.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (63)

• packages/cli/package.json (2 hunks)
• packages/cli/src/actions/generate.ts (2 hunks)
• packages/cli/src/prisma/prisma-schema-generator.ts (4 hunks)
• packages/cli/test/ts-schema-gen.test.ts (4 hunks)
• packages/cli/tsup.config.ts (1 hunks)
• packages/language/res/stdlib.zmodel (1 hunks)
• packages/language/src/index.ts (2 hunks)
• packages/language/src/utils.ts (3 hunks)
• packages/language/src/validators/expression-validator.ts (3 hunks)
• packages/language/src/zmodel-linker.ts (3 hunks)
• packages/language/src/zmodel-scope.ts (4 hunks)
• packages/runtime/package.json (1 hunks)
• packages/runtime/src/client/client-impl.ts (3 hunks)
• packages/runtime/src/client/contract.ts (3 hunks)
• packages/runtime/src/client/crud/dialects/base.ts (1 hunks)
• packages/runtime/src/client/crud/operations/base.ts (4 hunks)
• packages/runtime/src/client/crud/operations/create.ts (2 hunks)
• packages/runtime/src/client/crud/operations/delete.ts (1 hunks)
• packages/runtime/src/client/crud/operations/update.ts (1 hunks)
• packages/runtime/src/client/executor/name-mapper.ts (1 hunks)
• packages/runtime/src/client/executor/zenstack-query-executor.ts (4 hunks)
• packages/runtime/src/client/helpers/schema-db-pusher.ts (2 hunks)
• packages/runtime/src/client/options.ts (1 hunks)
• packages/runtime/src/client/plugin.ts (1 hunks)
• packages/runtime/src/client/query-utils.ts (1 hunks)
• packages/runtime/src/plugins/policy/column-collector.ts (1 hunks)
• packages/runtime/src/plugins/policy/errors.ts (1 hunks)
• packages/runtime/src/plugins/policy/expression-transformer.ts (4 hunks)
• packages/runtime/src/plugins/policy/generator.ts (0 hunks)
• packages/runtime/src/plugins/policy/index.ts (0 hunks)
• packages/runtime/src/plugins/policy/options.ts (0 hunks)
• packages/runtime/src/plugins/policy/plugin.ts (2 hunks)
• packages/runtime/src/plugins/policy/plugin.zmodel (0 hunks)
• packages/runtime/src/plugins/policy/policy-handler.ts (1 hunks)
• packages/runtime/src/plugins/policy/policy-transformer.ts (0 hunks)
• packages/runtime/src/plugins/policy/types.ts (1 hunks)
• packages/runtime/src/plugins/policy/utils.ts (1 hunks)
• packages/runtime/src/schema/expression.ts (5 hunks)
• packages/runtime/src/schema/schema.ts (3 hunks)
• packages/runtime/src/utils/default-operation-node-visitor.ts (1 hunks)
• packages/runtime/test/client-api/delete.test.ts (1 hunks)
• packages/runtime/test/client-api/update.test.ts (22 hunks)
• packages/runtime/test/plugin/kysely-on-query.test.ts (4 hunks)
• packages/runtime/test/plugin/mutation-hooks.test.ts (2 hunks)
• packages/runtime/test/policy/read.test.ts (4 hunks)
• packages/runtime/test/policy/todo-sample.test.ts (1 hunks)
• packages/runtime/test/schemas/todo.zmodel (1 hunks)
• packages/runtime/test/test-schema.ts (3 hunks)
• packages/runtime/test/vitest-ext.ts (3 hunks)
• packages/runtime/test/vitest.d.ts (1 hunks)
• packages/sdk/package.json (1 hunks)
• packages/sdk/src/index.ts (1 hunks)
• packages/sdk/src/model-utils.ts (1 hunks)
• packages/sdk/src/ts-schema-generator.ts (12 hunks)
• packages/sdk/src/zmodel-code-generator.ts (1 hunks)
• packages/sdk/tsconfig.json (1 hunks)
• packages/sdk/tsup.config.ts (1 hunks)
• packages/testtools/package.json (1 hunks)
• packages/testtools/src/index.ts (1 hunks)
• packages/testtools/src/schema.ts (3 hunks)
• packages/testtools/tsup.config.ts (1 hunks)
• samples/blog/zenstack/schema.ts (4 hunks)
• samples/blog/zenstack/schema.zmodel (0 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.