chore: rename query function to proceed for onquery plugin

[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/rename-query

---

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.

[Copilot]

Pull Request Overview

This PR renames the query function parameter to proceed in the onQuery plugin hook interface for better semantic clarity. The change updates the parameter name across the codebase to better reflect that this function continues with the original query execution.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
samples/blog/main.ts	Updates plugin usage to use proceed instead of query
packages/runtime/test/plugin/on-query-hooks.test.ts	Updates test cases to use the renamed proceed function
packages/runtime/src/client/plugin.ts	Updates type definition to rename query to proceed with improved documentation
packages/runtime/src/client/client-impl.ts	Updates plugin context creation to pass proceed instead of query
README.md	Updates documentation example to use proceed instead of query

---

_{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.}

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Renaming query to proceed in onQuery Plugin Hook

Tasks

• Read and analyze all changed files
• Review semantic appropriateness of the rename
• Check consistency across codebase
• Evaluate test coverage
• Assess documentation updates
• Provide comprehensive feedback

Analysis Summary

I've reviewed all the changed files and this is a clean, consistent rename of the query parameter to proceed in the onQuery plugin hook interface. The change affects:

Files Changed:

• packages/runtime/src/client/plugin.ts - Type definition update
• packages/runtime/src/client/client-impl.ts - Implementation update
• packages/runtime/test/plugin/on-query-hooks.test.ts - Test updates (10 occurrences)
• samples/blog/main.ts - Sample code update
• README.md - Documentation update

Review Findings

✅ Excellent semantic improvement: The rename from query to proceed significantly improves the API's clarity. The parameter represents a callback function that proceeds with the original query execution, not a query object itself.

✅ Perfect consistency: All 5 files have been updated consistently with no missed occurrences.

✅ Comprehensive test coverage: The test suite thoroughly covers the renamed parameter across multiple scenarios:

• Simple interception (packages/runtime/src/client/client-impl.ts:382)
• Argument modification
• Result modification
• Error handling
• Plugin encapsulation

✅ Enhanced documentation: The type definition now includes improved JSDoc comments explaining the purpose more clearly:

/**
 * The function to proceed with the original query.
 * It takes the same arguments as the operation method.
 */
proceed: (args: unknown) => Promise<unknown>;

✅ No breaking changes for runtime: This is purely a parameter name change within the callback signature - existing plugin implementations will need to update their parameter names but the functionality remains identical.

Code Quality Assessment

• Best Practices: ✅ Follows TypeScript naming conventions
• API Design: ✅ Much more intuitive naming that matches common patterns (similar to Express middleware's next())
• Backward Compatibility: ⚠️ This is a breaking change for existing plugins, but well-justified for API clarity
• Performance: ✅ No performance impact
• Security: ✅ No security concerns

Suggestions

1. Migration Guide: Consider adding a brief migration note for plugin authors in the changelog or documentation.

2. Consistency Check: The rename aligns well with the similar proceed parameter used in the Kysely query hook (OnKyselyQueryArgs.proceed), creating better API consistency across the plugin system.

Overall Assessment

This is a well-executed improvement that enhances the developer experience. The rename makes the plugin API more intuitive and self-documenting. All implementations have been updated consistently, and the test coverage ensures the change works as expected.

Recommendation: ✅ Approve - This change improves API clarity and maintains full functionality while establishing better naming consistency across the plugin architecture.

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Renaming query to proceed in onQuery Plugin Hook

Tasks

• Read and analyze all changed files
• Review semantic appropriateness of the rename
• Check consistency across codebase
• Evaluate test coverage
• Assess documentation updates
• Provide comprehensive feedback

Analysis Summary

I've reviewed all the changed files and this is a clean, consistent rename of the query parameter to proceed in the onQuery plugin hook interface. The change affects:

Files Changed:

• packages/runtime/src/client/plugin.ts - Type definition update
• packages/runtime/src/client/client-impl.ts - Implementation update
• packages/runtime/test/plugin/on-query-hooks.test.ts - Test updates (10 occurrences)
• packages/runtime/test/policy/client-extensions.test.ts - Test updates (10 occurrences)
• samples/blog/main.ts - Sample code update
• README.md - Documentation update

Review Findings

✅ Excellent semantic improvement: The rename from query to proceed significantly improves the API's clarity. The parameter represents a callback function that proceeds with the original query execution, not a query object itself.

✅ Perfect consistency: All 6 files have been updated consistently with no missed occurrences.

✅ Comprehensive test coverage: The test suite thoroughly covers the renamed parameter across multiple scenarios:

• Simple interception (packages/runtime/src/client/client-impl.ts:382)
• Argument modification
• Result modification
• Error handling
• Plugin encapsulation
• Policy integration tests

✅ Enhanced documentation: The type definition now includes improved JSDoc comments explaining the purpose more clearly:

/**
 * The function to proceed with the original query.
 * It takes the same arguments as the operation method.
 */
proceed: (args: unknown) => Promise<unknown>;

✅ No breaking changes for runtime: This is purely a parameter name change within the callback signature - existing plugin implementations will need to update their parameter names but the functionality remains identical.

Code Quality Assessment

• Best Practices: ✅ Follows TypeScript naming conventions
• API Design: ✅ Much more intuitive naming that matches common patterns (similar to Express middleware's next())
• Backward Compatibility: ⚠️ This is a breaking change for existing plugins, but well-justified for API clarity
• Performance: ✅ No performance impact
• Security: ✅ No security concerns

Suggestions

1. Migration Guide: Consider adding a brief migration note for plugin authors in the changelog or documentation.

2. Consistency Check: The rename aligns well with the similar proceed parameter used in the Kysely query hook (OnKyselyQueryArgs.proceed), creating better API consistency across the plugin system.

Overall Assessment

This is a well-executed improvement that enhances the developer experience. The rename makes the plugin API more intuitive and self-documenting. All implementations have been updated consistently, and the test coverage ensures the change works as expected.

Recommendation: ✅ Approve - This change improves API clarity and maintains full functionality while establishing better naming consistency across the plugin architecture.

---