Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(server): rename CompositePlugin -> CompositeHandlerPlugin #268

Merged
merged 2 commits into from
Mar 19, 2025

Conversation

unnoq
Copy link
Owner

@unnoq unnoq commented Mar 19, 2025

Summary by CodeRabbit

  • Refactor
    • Refined the internal plugin structure for improved consistency and maintainability.
  • Tests
    • Updated test cases to align with the internal enhancements, ensuring proper plugin initialization and reliable system behavior.

These updates optimize the backend processes without changing any functionality visible to end-users.

Copy link

vercel bot commented Mar 19, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
orpc ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 19, 2025 10:01am

Copy link

coderabbitai bot commented Mar 19, 2025

Walkthrough

The changes update the plugin implementation by renaming the CompositePlugin to CompositeHandlerPlugin across several files. In the handler file, the import statement, private member type, and instantiation have been updated. The test file and the plugin definition file similarly reflect the new class name. The overall functionality remains unchanged while the naming and type specification are adjusted.

Changes

Files Change Summary
packages/.../handler.ts Updated import from CompositePlugin to CompositeHandlerPlugin; changed the private member type and its instantiation accordingly.
packages/.../base.ts, packages/.../base.test.ts Renamed the CompositePlugin class to CompositeHandlerPlugin and updated test references to reflect the new name.

Possibly related PRs

  • test(server): plugins #220: Addresses similar modifications by renaming and updating references from CompositePlugin to CompositeHandlerPlugin.

Poem

I'm a nimble rabbit with a coding flare,
Hopping through changes with a twitch and a stare.
Renamed plugins make my heart sing,
New names bring a fresh, cheerful spring.
🐇💻 Cheers to changes that keep our code rare!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 28aa60a and 28a8b7c.

📒 Files selected for processing (3)
  • packages/server/src/adapters/standard/handler.ts (2 hunks)
  • packages/server/src/plugins/base.test.ts (1 hunks)
  • packages/server/src/plugins/base.ts (1 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
packages/server/src/plugins/base.test.ts (1)
packages/server/src/plugins/base.ts (1) (1)
  • CompositeHandlerPlugin (8-16)
🔇 Additional comments (7)
packages/server/src/plugins/base.ts (1)

8-8: Class renaming looks good.

Renaming CompositePlugin to CompositeHandlerPlugin better reflects the purpose of this class as it implements the HandlerPlugin interface. This naming convention is more descriptive and improves code readability.

packages/server/src/plugins/base.test.ts (3)

1-1: Import statement correctly updated.

The import statement has been correctly updated to use the renamed CompositeHandlerPlugin class.


3-3: Test name appropriately updated to match the class name.

The test name has been updated from compositePlugin to compositeHandlerPlugin to reflect the class rename, maintaining consistency.


8-8: Class instantiation correctly updated.

The instantiation of the composite object has been properly updated to use CompositeHandlerPlugin instead of CompositePlugin.

packages/server/src/adapters/standard/handler.ts (3)

11-11: Import statement correctly updated.

The import statement has been properly updated to use the renamed CompositeHandlerPlugin class.


49-49: Type declaration correctly updated.

The private member variable type has been properly updated from CompositePlugin<T> to CompositeHandlerPlugin<T>.


57-57: Class instantiation correctly updated.

The instantiation has been properly updated to use CompositeHandlerPlugin instead of CompositePlugin.

✨ 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
🪧 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.

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 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.

Copy link

pkg-pr-new bot commented Mar 19, 2025

Open in Stackblitz

More templates

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@268

@orpc/client

npm i https://pkg.pr.new/@orpc/client@268

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@268

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@268

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@268

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@268

@orpc/server

npm i https://pkg.pr.new/@orpc/server@268

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@268

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@268

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@268

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@268

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@268

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@268

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@268

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@268

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@268

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@268

commit: 28a8b7c

Copy link

codecov bot commented Mar 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@unnoq unnoq merged commit e563486 into main Mar 19, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant