eggjs / tegg

Strong Type framework with eggjs.
MIT License
240 stars 35 forks source link

feat: support optional inject #254

Closed gxkl closed 2 weeks ago

gxkl commented 2 weeks ago
Checklist
Affected core subsystem(s)
Description of change

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces enhancements to the Inject decorator and related classes, allowing for optional dependency injection. Key modifications include the addition of the InjectOptional function, updates to existing decorators to support optional parameters, and refinements in the handling of injected objects. The changes extend to various test cases and interfaces, ensuring comprehensive coverage of the new functionality. Overall, the updates improve the clarity and flexibility of dependency management within the framework.

Changes

File Path Change Summary
core/core-decorator/src/decorator/Inject.ts Modified the Inject decorator to handle parameters more consistently, added InjectOptional function for optional injections, and streamlined logic.
core/core-decorator/test/decorators.test.ts Updated tests to include new optional injection objects and modified existing test cases to reflect optional dependencies.
core/core-decorator/test/fixtures/decators/CacheService.ts Added optional service injections in CacheService, updated import paths, and modified existing injection configurations.
core/core-decorator/test/fixtures/decators/ConstructorObject.ts Enhanced ConstructorObject to support optional constructor parameters using Inject and InjectOptional.
core/metadata/src/impl/EggPrototypeBuilder.ts Updated findInjectObjectPrototype method to accept InjectConstructor, refactored build method for better error handling with optional injects.
core/metadata/test/LoadUnit.test.ts Introduced a new test suite for optional injection, validating the creation of load units with optional dependencies.
core/metadata/test/fixtures/modules/optional-inject-module/OptionalInjectService.ts Created new OptionalInjectService class with optional dependency properties.
core/metadata/test/fixtures/modules/optional-inject-module/package.json Added package.json for the optional-inject-service module.
core/types/core-decorator/Inject.ts Modified InjectParams interface to include an optional optional property.
core/types/core-decorator/model/InjectObjectInfo.ts Added an optional optional property to InjectObjectInfo interface.
core/types/metadata/model/EggPrototype.ts Introduced an optional optional property to several interfaces: InjectObjectProto, InjectConstructorProto, InjectObject, and InjectConstructor.
core/types/core-decorator/model/InjectConstructorInfo.ts Added an optional optional property to InjectConstructorInfo interface.
plugin/tegg/test/Inject.test.ts Introduced a new test suite for optional injection scenarios within the tegg plugin, validating functionality and error handling.
plugin/tegg/test/fixtures/apps/invalid-inject/app/modules/module-a/BarService.ts Created BarService class with an injected property marked for dependency injection.
plugin/tegg/test/fixtures/apps/optional-inject/app/modules/module-a/BarService.ts Defined BarService class with optional injected properties and a method to check their presence.
plugin/tegg/test/fixtures/apps/optional-inject/app/modules/module-a/FooService.ts Defined FooService class with optional injected properties and a method to check their presence.
standalone/standalone/test/fixtures/optional-inject/bar.ts Introduced Bar class with optional parameters for dependency injection.
standalone/standalone/test/fixtures/optional-inject/foo.ts Introduced Foo class implementing MainRunner with optional injected properties.
standalone/standalone/test/index.test.ts Added a new test suite for optional injection scenarios, verifying expected behaviors and error handling.

Possibly related PRs

🐰 "In the garden where we play,
Optional injections come our way.
With Inject and InjectOptional too,
Flexibility blooms, oh what a view!
Hops of joy, we celebrate,
For dependencies now cooperate!" 🐇


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between facba7e486354d6828090fdda0409f65695afb08 and e44fe71184626eb8c2214f8ea43d04cab0496900.
📒 Files selected for processing (1) * standalone/standalone/test/index.test.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * standalone/standalone/test/index.test.ts
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.