merge dev to main (v3.0.0-alpha.14) #125

ymc9 · 2025-07-29T14:55:17Z

Summary by CodeRabbit

New Features
- Enhanced mutation hook handling to ensure after-mutation hooks are triggered appropriately, including support for transactional and non-transactional scenarios.
- Improved test utilities for more flexible schema and database setup in testing environments.
Bug Fixes
- Fixed issues with after-mutation hooks not being called or being called incorrectly in certain transaction contexts.
Refactor
- Centralized and standardized query execution with consistent query IDs and unified helper methods.
- Improved type safety and clarity in plugin callback definitions and test code.
- Streamlined test setup and schema generation logic for better maintainability.
Chores
- Updated package versions to 3.0.0-alpha.14 across all packages.
- Updated documentation and TODO lists to reflect completed and new tasks.
Tests
- Enhanced and reorganized test coverage for mutation hooks, transactional behavior, and delegate model handling.
- Removed obsolete or redundant test cases to streamline the test suite.

* chore: reorg test runs * update * update

* feat: trigger after mutation hooks after transaction is committed * update

Co-authored-by: ymc9 <[email protected]>

coderabbitai · 2025-07-29T14:55:25Z

Caution

Review failed

The pull request is closed.

Walkthrough

This update primarily advances the runtime's transaction and plugin infrastructure, standardizes query execution with enhanced connection and hook management, and refines test utilities and type safety across the codebase. Numerous package versions were incremented to "3.0.0-alpha.14". Several test files and utilities were refactored for improved type handling, schema management, and transactional test coverage.

Changes

Cohort / File(s)	Change Summary
Version Bumps `package.json`, `packages/cli/package.json`, `packages/common-helpers/package.json`, `packages/create-zenstack/package.json`, `packages/eslint-config/package.json`, `packages/ide/vscode/package.json`, `packages/language/package.json`, `packages/runtime/package.json`, `packages/sdk/package.json`, `packages/tanstack-query/package.json`, `packages/testtools/package.json`, `packages/typescript-config/package.json`, `packages/zod/package.json`, `samples/blog/package.json`, `tests/e2e/package.json`	Updated package versions from "3.0.0-alpha.13" to "3.0.0-alpha.14". No other changes.
Runtime Query Execution & Transaction Refactor `packages/runtime/src/client/crud/operations/base.ts`, `packages/runtime/src/client/crud/operations/aggregate.ts`, `packages/runtime/src/client/crud/operations/count.ts`, `packages/runtime/src/client/crud/operations/delete.ts`, `packages/runtime/src/client/crud/operations/group-by.ts`, `packages/runtime/src/client/executor/zenstack-driver.ts`, `packages/runtime/src/client/executor/zenstack-query-executor.ts`	Centralized query execution with new helper methods, improved transaction connection tracking, enhanced after-mutation hook management, and updated result access patterns.
Runtime Plugin & Type Refactor `packages/runtime/src/client/plugin.ts`, `packages/runtime/src/client/client-impl.ts`	Introduced type aliases for plugin callbacks, updated plugin interface signatures, and optimized plugin array handling for TypeScript performance.
Test Utilities & Schema Handling `packages/runtime/test/utils.ts`, `packages/testtools/src/schema.ts`, `packages/runtime/test/policy/utils.ts`	Enhanced test client creation with improved schema file and database URL handling, updated parameter names, and relaxed type assertions.
Test Suite Refactors `packages/runtime/test/client-api/client-specs.ts`, `packages/runtime/test/client-api/delegate.test.ts`, `packages/runtime/test/client-api/relation.test.ts`, `packages/runtime/test/plugin/kysely-on-query.test.ts`, `packages/runtime/test/plugin/mutation-hooks.test.ts`, `packages/runtime/test/plugin/query-lifecycle.test.ts`	Improved type safety, externalized schemas, clarified test logic, removed or updated transaction-related tests, and adjusted test metadata.
E2E Test Schema Invocation Changes `tests/e2e/cal.com/cal-com.test.ts`, `tests/e2e/formbricks/formbricks.test.ts`, `tests/e2e/trigger.dev/trigger-dev.test.ts`	Updated calls to `generateTsSchema` by removing the third argument, aligning with new function signatures.
Documentation & TODOs `TODO.md`	Updated TODOs: added a new subtask, marked Plugin tasks as completed.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Poem

🐇
A hop and a skip, new hooks in the air,
Transactions now tracked with meticulous care.
Plugins refactored, types shining bright,
Tests get a polish, schemas set right.
With version bumps tall and code ever neat,
This rabbit declares: the release is sweet!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 30fc2fa and 7c7183d.

📒 Files selected for processing (37)

TODO.md (2 hunks)
package.json (1 hunks)
packages/cli/package.json (1 hunks)
packages/common-helpers/package.json (1 hunks)
packages/create-zenstack/package.json (1 hunks)
packages/eslint-config/package.json (1 hunks)
packages/ide/vscode/package.json (1 hunks)
packages/language/package.json (1 hunks)
packages/runtime/package.json (1 hunks)
packages/runtime/src/client/client-impl.ts (2 hunks)
packages/runtime/src/client/crud/operations/aggregate.ts (1 hunks)
packages/runtime/src/client/crud/operations/base.ts (18 hunks)
packages/runtime/src/client/crud/operations/count.ts (1 hunks)
packages/runtime/src/client/crud/operations/delete.ts (1 hunks)
packages/runtime/src/client/crud/operations/group-by.ts (1 hunks)
packages/runtime/src/client/executor/zenstack-driver.ts (3 hunks)
packages/runtime/src/client/executor/zenstack-query-executor.ts (10 hunks)
packages/runtime/src/client/plugin.ts (3 hunks)
packages/runtime/test/client-api/client-specs.ts (2 hunks)
packages/runtime/test/client-api/delegate.test.ts (7 hunks)
packages/runtime/test/client-api/relation.test.ts (2 hunks)
packages/runtime/test/plugin/kysely-on-query.test.ts (0 hunks)
packages/runtime/test/plugin/mutation-hooks.test.ts (1 hunks)
packages/runtime/test/plugin/query-lifecycle.test.ts (0 hunks)
packages/runtime/test/policy/utils.ts (1 hunks)
packages/runtime/test/utils.ts (6 hunks)
packages/sdk/package.json (1 hunks)
packages/tanstack-query/package.json (1 hunks)
packages/testtools/package.json (1 hunks)
packages/testtools/src/schema.ts (2 hunks)
packages/typescript-config/package.json (1 hunks)
packages/zod/package.json (1 hunks)
samples/blog/package.json (1 hunks)
tests/e2e/cal.com/cal-com.test.ts (1 hunks)
tests/e2e/formbricks/formbricks.test.ts (1 hunks)
tests/e2e/package.json (1 hunks)
tests/e2e/trigger.dev/trigger-dev.test.ts (1 hunks)

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch dev

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 generate unit tests to generate unit tests for 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.

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.

claude · 2025-07-29T14:55:36Z

Claude finished @ymc9's task —— View job

PR Review: merge dev to main (v3.0.0-alpha.14)

I'll review this pull request focusing on code quality, potential bugs, performance, security, and test coverage.

Review Tasks:

Analyze version bump changes across packages
Review runtime client implementation changes
Examine CRUD operations modifications
Check plugin system and query executor updates
Review test changes and coverage implications
Identify potential bugs, security issues, and performance concerns
Provide comprehensive feedback summary

Review Summary

This is a solid PR that implements a significant improvement to ZenStack's plugin system. The changes are well-implemented with excellent test coverage.

Key Changes ✅

1. Plugin System Refactor - Major Enhancement

Removed: Generic onQuery and onKyselyQuery hooks (simplified API)
Added: Focused mutation lifecycle hooks:
- mutationInterceptionFilter - Controls which mutations to intercept
- beforeEntityMutation - Pre-mutation hooks
- afterEntityMutation - Transaction-aware post-mutation hooks

Code Quality: packages/runtime/src/client/plugin.ts:147-165 - Well-structured interface design

2. Transaction-Aware Hook Execution - Critical Feature

Implementation: packages/runtime/src/client/executor/zenstack-driver.ts:68-90
Hooks now execute after transaction commit, preventing issues with rollbacks
Proper callback registration and cleanup on commit/rollback

Security/Reliability: Excellent - prevents hooks from executing on failed transactions

3. Enhanced Query Executor - Performance Improvement

File: packages/runtime/src/client/executor/zenstack-query-executor.ts:58-108
Better lifecycle management for mutations
Optimized hook execution flow
Proper error handling and connection management

Code Quality Assessment 🔍

Strengths ✅

Clean Architecture: Separation of concerns between filtering, before/after hooks
Type Safety: Strong TypeScript usage throughout packages/runtime/src/client/plugin.ts
Error Handling: Proper try/catch blocks in hook execution zenstack-query-executor.ts:372-375
Memory Management: WeakMap usage for transaction callbacks zenstack-driver.ts:14

Areas of Excellence ⭐

Test Coverage: Comprehensive test suite in mutation-hooks.test.ts (396 lines)
- Tests all mutation types (create, update, delete)
- Transaction rollback scenarios
- Multi-entity operations
- Nested mutations
Documentation: Clear JSDoc comments for plugin interfaces
Performance: Query ID generation with nanoid for tracing base.ts:213

Potential Concerns ⚠️

Minor Issues

Error Handling: zenstack-query-executor.ts:372-375 logs errors but continues execution
- Consider adding error aggregation or circuit breaker pattern for repeated failures
Memory Usage: Hook callbacks stored until transaction commit
- Low risk but monitor for long-running transactions
Backwards Compatibility: Removed onQuery/onKyselyQuery hooks
- Breaking change - ensure this is documented in changelog

Performance Assessment 📈

Positive Impact:

Reduced complexity by removing generic query interception
Transaction-aware execution prevents wasted work on rollbacks
Better resource cleanup with WeakMap usage

No Performance Regressions: Clean implementation without obvious bottlenecks

Security Assessment 🔒

No Security Issues Found:

No sensitive data exposure
Proper connection handling
Transaction isolation maintained
Error information appropriately limited

Test Coverage Assessment ✅

Excellent Coverage:

Added: 118 lines of comprehensive mutation hook tests
Removed: 296 lines of outdated query interception tests
Tests cover edge cases: rollbacks, multi-operations, nested mutations
E2E tests maintained across all providers

Recommendations 💡

Documentation: Update migration guide for onQuery → mutation hooks transition
Monitoring: Consider adding metrics for hook execution times in production
Future: The loadBeforeMutationEntity/loadAfterMutationEntity pattern is well-designed for future optimizations

Verdict: APPROVED ✅

This PR represents a significant improvement to ZenStack's plugin architecture. The transaction-aware mutation hooks solve real reliability issues while simplifying the API. The implementation is robust, well-tested, and maintains backward compatibility where possible.

The code quality is high, test coverage is comprehensive, and no security or performance concerns were identified.

Copilot

Pull Request Overview

This PR merges the dev branch to main, implementing version bump to 3.0.0-alpha.14 and refactors the database schema generation and test utilities. The changes include significant improvements to transaction handling, mutation hooks, and test infrastructure.

Version bump from 3.0.0-alpha.13 to 3.0.0-alpha.14 across all packages
Refactored generateTsSchema function to use database URLs instead of database names
Improved transaction handling and mutation hooks with proper commit callbacks

Reviewed Changes

Copilot reviewed 37 out of 37 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
package.json files	Version bump to 3.0.0-alpha.14 across all packages
tests/e2e/*/test.ts	Updated test calls to match new generateTsSchema signature
packages/testtools/src/schema.ts	Refactored to use dbUrl parameter instead of dbName
packages/runtime/test/utils.ts	Enhanced createTestClient with better database handling
packages/runtime/src/client/executor/	Improved transaction handling and mutation hooks
packages/runtime/src/client/crud/operations/	Updated query execution methods
TODO.md	Updated task completion status

Comments suppressed due to low confidence (1)

tests/e2e/trigger.dev/trigger-dev.test.ts

packages/runtime/test/utils.ts

packages/runtime/test/client-api/relation.test.ts

packages/runtime/src/client/executor/zenstack-query-executor.ts

ymc9 and others added 4 commits July 29, 2025 15:59

chore: reorg test runs (#121)

330be71

* chore: reorg test runs * update * update

perf: improve type checking performance (magically...) (#122)

1667ce1

feat: trigger after mutation hooks after transaction is committed (#123)

d6bb0c0

* feat: trigger after mutation hooks after transaction is committed * update

chore: bump version 3.0.0-alpha.14 (#124)

7c7183d

Co-authored-by: ymc9 <[email protected]>

Copilot AI review requested due to automatic review settings July 29, 2025 14:55

ymc9 changed the title ~~merge dev to main~~ merge dev to main (v3.0.0-alpha.14) Jul 29, 2025

Copilot AI reviewed Jul 29, 2025

View reviewed changes

ymc9 added this pull request to the merge queue Jul 29, 2025

Merged via the queue into main with commit c9d5e1d Jul 29, 2025
6 of 7 checks passed

This was referenced Aug 14, 2025

merge dev to main (v3.0.0-alpha.24) #166

Merged

merge dev to main (v3.0.0-alpha.26) #177

Merged

This was referenced Aug 26, 2025

refactor: clean up transaction semantics for entity mutation hooks #206

Merged

refactor: remove filter from entity mutation hooks #208

Merged

merge dev to main #209

Merged

coderabbitai bot mentioned this pull request Sep 7, 2025

feat: "create" access policy implementation #242

Merged

coderabbitai bot mentioned this pull request Sep 17, 2025

chore: migrate more v2 tests #254

Merged

coderabbitai bot mentioned this pull request Oct 10, 2025

test: migrate more migration cases, a few minor fixes #293

Merged

coderabbitai bot mentioned this pull request Nov 8, 2025

fix(orm): update to kysely 0.28.x and simplify typing #380

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

merge dev to main (v3.0.0-alpha.14) #125

merge dev to main (v3.0.0-alpha.14) #125

Uh oh!

ymc9 commented Jul 29, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 29, 2025 •

edited

Loading

Review failed

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

claude bot commented Jul 29, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

merge dev to main (v3.0.0-alpha.14) #125

merge dev to main (v3.0.0-alpha.14) #125

Uh oh!

Conversation

ymc9 commented Jul 29, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

claude bot commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Review: merge dev to main (v3.0.0-alpha.14)

Review Tasks:

Review Summary

Key Changes ✅

1. Plugin System Refactor - Major Enhancement

2. Transaction-Aware Hook Execution - Critical Feature

3. Enhanced Query Executor - Performance Improvement

Code Quality Assessment 🔍

Strengths ✅

Areas of Excellence ⭐

Potential Concerns ⚠️

Minor Issues

Performance Assessment 📈

Security Assessment 🔒

Test Coverage Assessment ✅

Recommendations 💡

Verdict: APPROVED ✅

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ymc9 commented Jul 29, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 29, 2025 •

edited

Loading

claude bot commented Jul 29, 2025 •

edited

Loading