tsedio / tsed

:triangular_ruler: Ts.ED is a Node.js and TypeScript framework on top of Express to write your application with TypeScript (or ES6). It provides a lot of decorators and guideline to make your code more readable and less error-prone. ⭐️ Star to support our work!
https://tsed.io/
MIT License
2.86k stars 284 forks source link

fix(di): move locals arg to DIInvokeOptions #2890

Closed Romakita closed 1 day ago

Romakita commented 1 week ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

133 files out of 224 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

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

Walkthrough

The pull request includes extensive updates to the documentation and codebase related to dependency injection in Ts.ED. Key changes involve clarifications in the documentation regarding injection scopes, modifications to method signatures and parameter handling in the code, particularly concerning how locals are passed to various methods. Additionally, several tests have been adjusted to align with the new parameter structures, while some properties in interfaces have been removed or added, reflecting a more streamlined approach to dependency management.

Changes

File Change Summary
docs/docs/injection-scopes.md Updated documentation on injection scopes, clarified behavior of singleton, request, and instance scopes, added examples for request scope, removed import statement for injector.
packages/di/src/common/decorators/autoInjectable.ts Modified resolveAutoInjectableArgs to pass locals and parent as a single object instead of separate arguments.
packages/di/src/common/fn/inject.ts Updated handling of opts parameter to integrate locals into the opts object using a spread operator.
packages/di/src/common/fn/injectMany.ts Changed handling of locals to encapsulate it within a new options object.
packages/di/src/common/integration/di.spec.ts Adjusted test cases to pass locals as an object instead of directly, added new test for class invocation with useClass.
packages/di/src/common/integration/request.spec.ts Updated service invocation in tests to pass locals encapsulated in an object.
packages/di/src/common/interfaces/InvokeOptions.ts Removed scope property from InvokeOptions interface.
packages/di/src/common/interfaces/RegistrySettings.ts Removed locals parameter from onInvoke method signature.
packages/di/src/common/interfaces/ResolvedInvokeOptions.ts Removed scope property and added locals property to ResolvedInvokeOptions interface.
packages/di/src/common/registries/GlobalProviders.spec.ts Updated onInvoke test case to reflect changes in parameter structure.
packages/di/src/common/registries/GlobalProviders.ts Removed locals parameter from onInvoke method signature.
packages/di/src/common/services/InjectorService.spec.ts Modified invoke() method calls in tests to pass locals encapsulated in an object.
packages/di/src/common/services/InjectorService.ts Removed locals parameter from getMany, invoke, and resolve methods, using options.locals instead.
packages/di/src/node/domain/DIContext.ts Removed unused imports and maintained core functionality.
packages/graphql/apollo/src/services/ApolloService.ts Updated createContextHandler to pass locals wrapped in an object.
packages/orm/adapters/src/services/Adapters.ts Simplified invokeAdapter method by removing locals parameter from injector.invoke.
packages/orm/ioredis/src/domain/IORedisStore.spec.ts Added mock implementation for Redis class for testing, enhancing cacheable value handling.
packages/orm/ioredis/src/utils/registerConnectionProvider.spec.ts Modified mock return value to include default property for Redis class.
packages/orm/mikro-orm/src/MikroOrmModule.ts Reformatted code for readability; simplified parameter structure in getUnmanagedSubscribers.
packages/platform/platform-params/src/builder/PlatformParams.ts Updated compileHandler to pass locals as an object during injector invocation.
packages/platform/platform-router/src/domain/PlatformRouters.ts Changed injector access from destructured parameter to function call.
packages/platform/platform-router/test/routers-injection.integration.spec.ts Updated injector usage to invoke injector() directly instead of instantiating InjectorService.
.gitignore Enhanced file ignoring configuration by adding entries for various temporary and build files.
docs/docs/configuration/index.md Updated server configuration documentation, added rawBody option, removed scopes and resolvers, marked componentsScan as deprecated.
docs/docs/configuration/snippets/module-resolvers.ts Deleted file containing module definition with custom resolver.
docs/docs/configuration/snippets/server-resolvers.ts Deleted file containing server configuration with custom resolver.
packages/di/src/common/decorators/module.ts Removed resolvers property from ModuleOptions interface.
packages/di/src/common/domain/Provider.ts Updated get method with overloaded signature and introduced getArgOpts method.
packages/di/src/common/fn/injectable.ts Removed resolvers property from PickedProps type and updated Props constant.
packages/di/src/common/index.ts Removed exports for DIResolver, resolveControllers, and ProviderOpts.
packages/di/src/common/integration/resolvers.spec.ts Deleted file containing tests for the DI system's resolver functionality.
packages/di/src/common/interfaces/DIConfigurationOptions.ts Removed resolvers property from Configuration interface.
packages/di/src/common/interfaces/DIResolver.ts Deleted file defining the DIResolver interface.
packages/di/src/common/interfaces/ProviderOpts.ts Removed resolvers property from ProviderOpts interface.
packages/di/src/common/services/DIConfiguration.spec.ts Removed tests for scopes() and resolvers() methods.
packages/di/src/common/services/DIConfiguration.ts Removed scopes and resolvers properties and their associated methods from DIConfiguration class.
packages/di/src/node/domain/DIContext.spec.ts Updated tests for DIContext class to include new properties and behaviors.
packages/platform/platform-http/src/common/builder/PlatformBuilder.ts Refactored PlatformBuilder class to enhance dependency injection and lifecycle management.
packages/platform/platform-http/src/common/index.ts Added export for resolveControllers utility.
packages/platform/platform-http/src/common/utils/resolveControllers.spec.ts Updated import paths to reflect new directory structure.
packages/platform/platform-http/src/common/utils/resolveControllers.ts Consolidated imports and modified visibility of getTokens and resolveControllers functions.
packages/platform/platform-params/vitest.config.mts Updated coverage thresholds in Vitest configuration.
packages/third-parties/components-scan/src/importProviders.spec.ts Changed import source for resolveControllers function.
tools/vitest/presets/index.js Updated coverage exclusion patterns in Vitest presets configuration.

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://docs.coderabbit.ai) 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.