chore: simplify plugin contract to improve tsc performance

[ymc9]

No description provided.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/simplify-plugin-contract

---

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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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.

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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]

Claude finished @ymc9's task —— View job

---

Code Review Complete ✅

I've thoroughly reviewed PR #164: "chore: simplify plugin contract to improve tsc performance". Here's my comprehensive feedback:

✅ Strengths

1. Performance Optimization: The simplification of the plugin contract should indeed improve TypeScript compilation performance by reducing complex type relationships
2. Code Organization: Test reorganization into focused files (on-query-hooks.test.ts, entity-mutation-hooks.test.ts) improves maintainability
3. Backwards Compatibility: The plugin API maintains its core functionality while streamlining the internal contract
4. TypeScript Performance: Explicit type annotations in client-impl.ts:238-240, 248-254, 264-267 help TypeScript compiler performance

🔍 Code Quality & Best Practices

Strong Points:

• Clean separation of concerns in plugin system
• Good use of TypeScript conditional types and generics
• Proper error handling with specific error types (QueryError, NotFoundError)
• Comprehensive JSDoc documentation in contract.ts

Minor Suggestions:

• Consider extracting magic strings like zenstack-${nanoid()} in zenstack-query-executor.ts:405 to constants
• The executor has good performance optimizations with the "tsc perf" comments - smart approach

🛡️ Security Assessment

No security concerns identified:

• Raw SQL execution properly parameterized ($executeRaw, $queryRaw methods)
• Plugin system doesn't expose unsafe operations
• Input validation maintained through InputValidator
• Database connections properly managed through connection provider pattern

🧪 Test Coverage

Excellent test organization:

• Tests properly split by functionality (query hooks vs entity mutation hooks)
• Maintains comprehensive coverage of plugin interception scenarios
• Good use of mock data and isolation in test setup
• New on-query-hooks.test.ts demonstrates proper plugin usage patterns

⚡ Performance Considerations

Positive improvements:

• Plugin loop optimizations with explicit type casting (lines 117-122 in zenstack-query-executor.ts)
• Reduced type complexity should improve compilation times
• Connection reuse pattern in query executor is efficient

Potential considerations:

• Plugin hooks are called sequentially - this is appropriate for correctness but worth documenting the performance characteristics
• Entity loading for mutation hooks could be expensive on large datasets, but the optional nature (loadBeforeMutationEntities) provides good control

🐛 Potential Issues

Minor issues identified:

1. zenstack-query-executor.ts:101-102: TODO comment about trimming results suggests incomplete implementation

   if (oldQueryNode !== queryNode) {
       // TODO: trim the result to the original query node
   }

2. Error handling: zenstack-query-executor.ts:378-380 logs errors but continues - consider if this should fail fast in some cases

3. Type safety: The use of any in a few places (like line 159) could be more strictly typed

📋 Recommendations

1. Complete the TODO: Implement the result trimming logic or remove the TODO if not needed
2. Consider error handling strategy: Document the intended behavior for plugin hook failures
3. Add performance documentation: Document the performance characteristics of the plugin system
4. Type strengthening: Consider replacing remaining any types with more specific interfaces where possible

🎯 Overall Assessment

This is a well-executed refactoring that achieves its stated goal of improving TypeScript performance while maintaining functionality. The code quality is high, security is properly handled, and the test coverage is comprehensive. The plugin system architecture is clean and extensible.

Recommendation: ✅ Approve - This change improves the codebase with no breaking changes and achieves the performance optimization goals.

---

[Copilot]

Pull Request Overview

This PR simplifies the plugin contract for the ZenStack runtime by flattening the nested query hook structure. The main purpose is to improve TypeScript compiler performance by reducing the complexity of the plugin type definitions.

Key changes:

• Replaced nested onQuery.model.operation structure with a single onQuery callback function
• Wrapped entity mutation hooks under an onEntityMutation object
• Updated all test files and examples to use the new simplified contract

Reviewed Changes

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

Show a summary per file

File	Description
samples/blog/main.ts	Updated plugin usage to use simplified onQuery structure
packages/runtime/test/policy/client-extensions.test.ts	Converted nested query hooks to single callback format
packages/runtime/test/plugin/query-lifecycle.test.ts	Removed entire file (284 lines deleted)
packages/runtime/test/plugin/on-query-hooks.test.ts	Added new test file with simplified query hook tests
packages/runtime/test/plugin/on-kysely-query.test.ts	Updated test description
packages/runtime/test/plugin/entity-mutation-hooks.test.ts	Wrapped mutation hooks under onEntityMutation object
packages/runtime/src/client/plugin.ts	Simplified plugin type definitions and interface
packages/runtime/src/client/executor/zenstack-query-executor.ts	Updated to access hooks via onEntityMutation property
packages/runtime/src/client/contract.ts	Renamed ModelOperations type and added AllModelOperations
packages/runtime/src/client/client-impl.ts	Simplified query hook processing logic
TODO.md	Added new TODO item for "insert into select from"
README.md	Updated documentation examples to use new plugin structure
.vscode/launch.json	Formatting changes to JSON arrays

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.}