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

feat(plugin-di): add Dependency Injection support for services and clients, and di plugin samples to _examples as new folder #2855

Merged
merged 19 commits into from
Jan 29, 2025

Conversation

btspoony
Copy link
Contributor

Relates to

#2115

Risks

Low

Background

What does this PR do?

In the previous submission, since the sampleService was missing, DI support was not added to services and clients. It has now been updated to include this.

Additionally, the samples have been placed in the _examples directory, and a di-driven sampleService has been added.

What kind of change is this?

Improvements (misc. changes to existing features)

Documentation changes needed?

My changes do not require a change to the project documentation.

Testing

Where should a reviewer start?

pnpm test --filter=@elizaos/plugin-di

Detailed testing steps

run test cases

Discord username

bt.wood

Copy link
Contributor

coderabbitai bot commented Jan 27, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

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.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
  • @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

graphite-app bot commented Jan 27, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • merge-queue-hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

@wtfsayo
Copy link
Member

wtfsayo commented Jan 27, 2025

lovely!!!

@wtfsayo wtfsayo self-requested a review January 27, 2025 16:33
@wtfsayo
Copy link
Member

wtfsayo commented Jan 28, 2025

is this ready to review @btspoony ? just want to confirm

@btspoony
Copy link
Contributor Author

btspoony commented Jan 28, 2025

is this ready to review @btspoony ? just want to confirm

Yeah, it‘s ready.

There aren't many changes to the actual code; the main update is the support for Service and Client.
Additionally, the location of the examples has been moved, and a sampleService based on di has been included.

@wtfsayo
Copy link
Member

wtfsayo commented Jan 28, 2025

support for Service and Client.

can you document usage for that or point me to it? maybe add a readme

@btspoony
Copy link
Contributor Author

support for Service and Client.

can you document usage for that or point me to it? maybe add a readme

Docs and examples are updated in the README.md:

https://github.com/elizaOS/eliza/pull/2855/files#diff-ac6a06799b9e65c2e7929fae6dd3f8c5a130d7d46afd0ab12eec591a0bdcdecaR11-R21

@btspoony
Copy link
Contributor Author

Done README updating

@wtfsayo wtfsayo merged commit 23f8d1d into elizaOS:develop Jan 29, 2025
7 of 8 checks passed
@btspoony btspoony deleted the tbh-di-improvement branch January 29, 2025 07:02
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.

2 participants