chore: added verbose log level

[hussmartinez]

• added verbose log level -> winston uses log level verbose instead of trace
• modified all test files that mock the logger by adding verbose mock
• modified bootstrap script that was adding { ...console } as logger, by mapping verbose to console.trace

Summary by CodeRabbit

• New Features
  • Introduced a new verbose logging level to capture more granular diagnostic messages.
  • Enhanced logging consistency across various components and tests while preserving existing log levels and behavior.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce a new logging method called verbose across multiple parts of the codebase. In various test suites and mocks, the verbose method is added as a mock function (using vi.fn()) alongside existing logging methods such as debug, error, info, and warn. In one instance, an existing trace property is replaced with verbose within the logging object. Additionally, the ILogger interface and the underlying Logger class have been updated to include the new verbose method and log level. A related script was modified to destructure the console object so that the trace value is passed as verbose when calling a metadata function. Overall, these updates extend the logging functionality for more detailed output without altering the existing control flow or test behavior.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 98655ec and e8b6b05.

📒 Files selected for processing (41)

• apps/processing/test/unit/processing.service.spec.ts (1 hunks)
• apps/processing/test/unit/sharedDependencies.service.spec.ts (1 hunks)
• packages/data-flow/test/data-loader/dataLoader.spec.ts (1 hunks)
• packages/data-flow/test/integration/helpers/setup.ts (1 hunks)
• packages/data-flow/test/registries/cachedEventRegistry.spec.ts (1 hunks)
• packages/data-flow/test/registries/cachedStrategyRegistry.spec.ts (1 hunks)
• packages/data-flow/test/registries/dbEventRegistry.spec.ts (1 hunks)
• packages/data-flow/test/registries/dbStrategyRegistry.spec.ts (1 hunks)
• packages/data-flow/test/unit/orchestrator.spec.ts (1 hunks)
• packages/data-flow/test/unit/retroactiveProcessor.spec.ts (1 hunks)
• packages/metadata/test/providers/cachingProxy.provider.spec.ts (1 hunks)
• packages/metadata/test/providers/publicGateway.provider.spec.ts (1 hunks)
• packages/pricing/test/providers/cachingProxy.provider.spec.ts (1 hunks)
• packages/pricing/test/providers/coingecko.provider.spec.ts (1 hunks)
• packages/processors/test/allo/allo.processor.spec.ts (1 hunks)
• packages/processors/test/alloV1ToV2Migration/allo/alloV1ToV2Migration.processor.spec.ts (1 hunks)
• packages/processors/test/gitcoinAttestationNetwork/gitcoinAttestationNetwork.processor.spec.ts (1 hunks)
• packages/processors/test/gitcoinAttestationNetwork/handlers/onAttested.handler.spec.ts (1 hunks)
• packages/processors/test/registry/handlers/profileCreated.handler.spec.ts (1 hunks)
• packages/processors/test/registry/handlers/profileNameUpdated.handler.spec.ts (1 hunks)
• packages/processors/test/registry/handlers/profileOwnerUpdated.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/common/baseDistributed.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/common/baseDistributionUpdated.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/common/baseFundsDistributed.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/common/baseRecipientStatusUpdated.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/directAllocation/handlers/directAllocated.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/directGrantsLite/directGrantsLite.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/directGrantsLite/handlers/updatedRegistration.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/directGrantsSimple/directGrantsSimple.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/dvmdDirectTransfer.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/updatedRegistration.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/easyRetroFunding/easyRetroFunding.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/easyRetroFunding/handlers/updatedRegistration.handler.spec.ts (1 hunks)
• packages/processors/test/strategy/strategy.processor.spec.ts (1 hunks)
• packages/processors/test/strategy/strategyHandler.factory.spec.ts (1 hunks)
• packages/shared/src/logger/logger.interface.ts (1 hunks)
• packages/shared/src/logger/logger.ts (2 hunks)
• packages/shared/test/notifier/notifier.factory.spec.ts (1 hunks)
• packages/shared/test/notifier/slack.notifier.spec.ts (1 hunks)
• packages/shared/test/retry/retry.spec.ts (1 hunks)
• scripts/bootstrap/src/metadata.script.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

`**/*.ts`:

**/*.ts:

• packages/data-flow/test/registries/cachedEventRegistry.spec.ts
• packages/processors/test/alloV1ToV2Migration/allo/alloV1ToV2Migration.processor.spec.ts
• packages/data-flow/test/registries/dbStrategyRegistry.spec.ts
• packages/shared/test/retry/retry.spec.ts
• packages/processors/test/strategy/common/baseFundsDistributed.handler.spec.ts
• packages/data-flow/test/data-loader/dataLoader.spec.ts
• apps/processing/test/unit/sharedDependencies.service.spec.ts
• packages/shared/test/notifier/slack.notifier.spec.ts
• packages/processors/test/strategy/strategy.processor.spec.ts
• packages/pricing/test/providers/coingecko.provider.spec.ts
• packages/pricing/test/providers/cachingProxy.provider.spec.ts
• packages/shared/src/logger/logger.interface.ts
• packages/processors/test/strategy/strategyHandler.factory.spec.ts
• apps/processing/test/unit/processing.service.spec.ts
• packages/processors/test/strategy/common/baseDistributionUpdated.handler.spec.ts
• packages/processors/test/registry/handlers/profileOwnerUpdated.handler.spec.ts
• packages/metadata/test/providers/publicGateway.provider.spec.ts
• packages/processors/test/allo/allo.processor.spec.ts
• packages/processors/test/strategy/common/baseRecipientStatusUpdated.handler.spec.ts
• packages/data-flow/test/registries/cachedStrategyRegistry.spec.ts
• packages/processors/test/registry/handlers/profileNameUpdated.handler.spec.ts
• scripts/bootstrap/src/metadata.script.ts
• packages/processors/test/strategy/directAllocation/handlers/directAllocated.handler.spec.ts
• packages/metadata/test/providers/cachingProxy.provider.spec.ts
• packages/processors/test/strategy/directGrantsLite/directGrantsLite.handler.spec.ts
• packages/processors/test/strategy/easyRetroFunding/easyRetroFunding.handler.spec.ts
• packages/processors/test/strategy/directGrantsSimple/directGrantsSimple.handler.spec.ts
• packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/updatedRegistration.handler.spec.ts
• packages/processors/test/registry/handlers/profileCreated.handler.spec.ts
• packages/data-flow/test/integration/helpers/setup.ts
• packages/data-flow/test/registries/dbEventRegistry.spec.ts
• packages/data-flow/test/unit/orchestrator.spec.ts
• packages/processors/test/strategy/easyRetroFunding/handlers/updatedRegistration.handler.spec.ts
• packages/processors/test/strategy/directGrantsLite/handlers/updatedRegistration.handler.spec.ts
• packages/processors/test/gitcoinAttestationNetwork/handlers/onAttested.handler.spec.ts
• packages/processors/test/strategy/common/baseDistributed.handler.spec.ts
• packages/data-flow/test/unit/retroactiveProcessor.spec.ts
• packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/dvmdDirectTransfer.handler.spec.ts
• packages/shared/test/notifier/notifier.factory.spec.ts
• packages/processors/test/gitcoinAttestationNetwork/gitcoinAttestationNetwork.processor.spec.ts
• packages/shared/src/logger/logger.ts

`**/*.spec.ts`: Review the unit test files with the following guidelines: - Avoid using the word "should" in test descriptions. - Ensure descriptive test names convey the inten...

**/*.spec.ts: Review the unit test files with the following guidelines:

• Avoid using the word "should" in test descriptions.
• Ensure descriptive test names convey the intent of each test.
• Validate adherence to the Mocha/Chai/Jest test library best practices.
• Be concise and avoid overly nitpicky feedback outside of these best practices.

• packages/data-flow/test/registries/cachedEventRegistry.spec.ts
• packages/processors/test/alloV1ToV2Migration/allo/alloV1ToV2Migration.processor.spec.ts
• packages/data-flow/test/registries/dbStrategyRegistry.spec.ts
• packages/shared/test/retry/retry.spec.ts
• packages/processors/test/strategy/common/baseFundsDistributed.handler.spec.ts
• packages/data-flow/test/data-loader/dataLoader.spec.ts
• apps/processing/test/unit/sharedDependencies.service.spec.ts
• packages/shared/test/notifier/slack.notifier.spec.ts
• packages/processors/test/strategy/strategy.processor.spec.ts
• packages/pricing/test/providers/coingecko.provider.spec.ts
• packages/pricing/test/providers/cachingProxy.provider.spec.ts
• packages/processors/test/strategy/strategyHandler.factory.spec.ts
• apps/processing/test/unit/processing.service.spec.ts
• packages/processors/test/strategy/common/baseDistributionUpdated.handler.spec.ts
• packages/processors/test/registry/handlers/profileOwnerUpdated.handler.spec.ts
• packages/metadata/test/providers/publicGateway.provider.spec.ts
• packages/processors/test/allo/allo.processor.spec.ts
• packages/processors/test/strategy/common/baseRecipientStatusUpdated.handler.spec.ts
• packages/data-flow/test/registries/cachedStrategyRegistry.spec.ts
• packages/processors/test/registry/handlers/profileNameUpdated.handler.spec.ts
• packages/processors/test/strategy/directAllocation/handlers/directAllocated.handler.spec.ts
• packages/metadata/test/providers/cachingProxy.provider.spec.ts
• packages/processors/test/strategy/directGrantsLite/directGrantsLite.handler.spec.ts
• packages/processors/test/strategy/easyRetroFunding/easyRetroFunding.handler.spec.ts
• packages/processors/test/strategy/directGrantsSimple/directGrantsSimple.handler.spec.ts
• packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/updatedRegistration.handler.spec.ts
• packages/processors/test/registry/handlers/profileCreated.handler.spec.ts
• packages/data-flow/test/registries/dbEventRegistry.spec.ts
• packages/data-flow/test/unit/orchestrator.spec.ts
• packages/processors/test/strategy/easyRetroFunding/handlers/updatedRegistration.handler.spec.ts
• packages/processors/test/strategy/directGrantsLite/handlers/updatedRegistration.handler.spec.ts
• packages/processors/test/gitcoinAttestationNetwork/handlers/onAttested.handler.spec.ts
• packages/processors/test/strategy/common/baseDistributed.handler.spec.ts
• packages/data-flow/test/unit/retroactiveProcessor.spec.ts
• packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/dvmdDirectTransfer.handler.spec.ts
• packages/shared/test/notifier/notifier.factory.spec.ts
• packages/processors/test/gitcoinAttestationNetwork/gitcoinAttestationNetwork.processor.spec.ts

`**/providers/**/*.ts`: Review provider files for the following: - Providers should supply narrowly scoped data/resources. - Ensure classes interacting with metadata sources (e...

**/providers/**/*.ts: Review provider files for the following:

• Providers should supply narrowly scoped data/resources.
• Ensure classes interacting with metadata sources (e.g., GitHub, JSON
  files, IPFS) implement the IMetadataProvider interface and follow
  naming conventions (e.g., GithubProvider, JsonFileProvider).
• Be concise and avoid overly nitpicky feedback outside of these best practices.

• packages/pricing/test/providers/coingecko.provider.spec.ts
• packages/pricing/test/providers/cachingProxy.provider.spec.ts
• packages/metadata/test/providers/publicGateway.provider.spec.ts
• packages/metadata/test/providers/cachingProxy.provider.spec.ts

`scripts/**/*.ts`: Ensure scripts: - Use `process.cwd()` for root references. - Follow folder conventions (`infra/` for infra scripts, `utilities/` for utilities). - Are orga...

scripts/**/*.ts: Ensure scripts:

• Use process.cwd() for root references.
• Follow folder conventions (infra/ for infra scripts, utilities/ for utilities).
• Are organized in package.json with script:infra:{name} or script:util:{name}.
• Be concise and avoid overly nitpicky feedback outside of these best practices.

• scripts/bootstrap/src/metadata.script.ts

🔇 Additional comments (42)

packages/shared/src/logger/logger.interface.ts (1)

9-9: LGTM! The verbose log level has been added to the ILogger interface.

This change properly adds the verbose logging method to the interface with a consistent signature matching other log levels.

packages/shared/test/retry/retry.spec.ts (1)

11-11: LGTM! The verbose log level has been added to the mockLogger.

The mockLogger object has been correctly updated to include the new verbose method, ensuring compatibility with the updated interface.

packages/data-flow/test/unit/retroactiveProcessor.spec.ts (1)

129-129: LGTM! The verbose log level has been added to the mockLogger.

The mockLogger implementation has been correctly updated to include the new verbose method, ensuring compatibility with the updated ILogger interface.

packages/processors/test/allo/allo.processor.spec.ts (1)

36-36: LGTM! The verbose log level has been added to the logger.

The logger object has been correctly updated to include the new verbose method, maintaining consistency with the updated ILogger interface.

packages/processors/test/gitcoinAttestationNetwork/handlers/onAttested.handler.spec.ts (1)

61-61: Implementation of verbose log level looks good.

Adding the verbose logging mock method to the mockLogger follows the pattern of the existing log methods and adheres to the PR's objective of introducing verbose logging throughout the codebase.

packages/processors/test/strategy/common/baseFundsDistributed.handler.spec.ts (1)

46-46: Implementation of verbose log level is consistent.

The addition of the verbose mock method to the mockLogger object follows the same pattern as the existing log methods and aligns with the PR's objective.

packages/data-flow/test/registries/dbStrategyRegistry.spec.ts (1)

12-12: Adding verbose logging method looks good.

The implementation of the verbose mock logging method is consistent with the existing logger methods and fulfills the PR objective of adding verbose logging capability.

packages/metadata/test/providers/cachingProxy.provider.spec.ts (1)

22-22: Implementation of verbose log level looks good.

The addition of the verbose logging mock method to the mockLogger aligns with the PR objective and maintains consistency with the existing logger implementation.

packages/processors/test/registry/handlers/profileOwnerUpdated.handler.spec.ts (1)

34-34: LGTM: Added verbose logging mock

The addition of the verbose method to the logger mock aligns with the PR objective of introducing a verbose log level throughout the codebase.

packages/processors/test/strategy/common/baseRecipientStatusUpdated.handler.spec.ts (1)

43-43: LGTM: Added verbose logging mock

The addition of the verbose method to the mockLogger object correctly implements the new logging level for testing purposes, consistent with the PR's objective.

packages/processors/test/strategy/common/baseDistributed.handler.spec.ts (1)

25-25: LGTM: Added verbose logging mock

The verbose method has been properly implemented in the logger interface for this test file. The ordering of methods is inconsistent with other files (typically alphabetical or matching the interface definition), but this is a minor stylistic preference and not worth flagging.

packages/data-flow/test/registries/cachedStrategyRegistry.spec.ts (1)

13-13: LGTM: Added verbose logging mock

The verbose method has been correctly added to the logger interface, consistent with the PR's objective of introducing this new log level.

packages/shared/test/notifier/slack.notifier.spec.ts (1)

24-24: LGTM! Adding the verbose log method.

The addition of the verbose mock method to the logger aligns with the PR objectives to replace "trace" with "verbose" log level.

packages/processors/test/strategy/strategyHandler.factory.spec.ts (1)

29-29: LGTM! Logger mock updated appropriately.

The addition of the verbose mock method to the logger object is consistent with the PR objectives to enhance logging functionality with a verbose level.

packages/processors/test/alloV1ToV2Migration/allo/alloV1ToV2Migration.processor.spec.ts (1)

38-38: LGTM! Logger interface properly updated.

The addition of the verbose mock method to the logger interface keeps the test suite consistent with the updated logger implementation.

packages/processors/test/gitcoinAttestationNetwork/gitcoinAttestationNetwork.processor.spec.ts (1)

43-43: LGTM! Consistent logger update.

The addition of the verbose mock method maintains consistency with the logger interface changes across the codebase.

packages/processors/test/strategy/strategy.processor.spec.ts (1)

24-24: Added verbose logger mock function

The addition of the verbose mock function to the logger object correctly implements the PR objectives by adding support for verbose logging.

packages/processors/test/registry/handlers/profileCreated.handler.spec.ts (1)

31-31: Added verbose logger mock function

The addition of the verbose mock function to the logger object correctly implements the PR objectives by adding support for verbose logging.

packages/data-flow/test/registries/cachedEventRegistry.spec.ts (1)

12-12: Added verbose logger mock function

The addition of the verbose mock function to the logger object correctly implements the PR objectives by adding support for verbose logging.

packages/pricing/test/providers/coingecko.provider.spec.ts (1)

45-45: Added verbose logger mock function

The addition of the verbose mock function to the logger object correctly implements the PR objectives by adding support for verbose logging.

packages/metadata/test/providers/publicGateway.provider.spec.ts (1)

15-17: LGTM. The verbose log level is properly added.

The addition of the verbose mock function aligns with the PR objective to add a verbose log level to replace the trace level.

packages/processors/test/strategy/directAllocation/handlers/directAllocated.handler.spec.ts (1)

53-55: LGTM. The verbose log level is properly implemented.

The addition of the verbose mock function is consistent with the changes across other test files and matches the PR objective.

packages/data-flow/test/registries/dbEventRegistry.spec.ts (1)

14-16: LGTM. The verbose log level is correctly added.

The addition of the verbose mock function to the logger interface is consistent with the PR's goal to enhance logging capabilities.

packages/data-flow/test/data-loader/dataLoader.spec.ts (1)

59-61: LGTM. The verbose log level implementation is consistent.

The addition of the verbose mock function follows the same pattern as in other test files and properly implements the PR's objective to enhance logging capabilities.

apps/processing/test/unit/sharedDependencies.service.spec.ts (1)

17-17: Appropriate addition of the verbose log level.

The addition of the verbose mock function to the logger aligns with the PR objectives to enhance logging functionality by adding the verbose log level across the codebase.

packages/pricing/test/providers/cachingProxy.provider.spec.ts (1)

38-38: LGTM - Added verbose logging mock function.

This change correctly extends the mock logger interface with the new verbose logging capability, maintaining consistency with the logging changes throughout the codebase.

packages/processors/test/strategy/directGrantsSimple/directGrantsSimple.handler.spec.ts (1)

59-59: Appropriate addition of verbose mock function.

The verbose mock function has been added to the logger implementation, which aligns with the PR's goal of enhancing logging capabilities throughout the codebase.

packages/data-flow/test/unit/orchestrator.spec.ts (1)

76-76: Consistent implementation of verbose logging.

The addition of the verbose mock function to the logger object correctly follows the pattern established in other test files, ensuring consistent logging capabilities across the test suite.

packages/data-flow/test/integration/helpers/setup.ts (1)

45-45: Added verbose log level to the mock logger.

The mock logger has been properly updated to include the new verbose logging method, ensuring compatibility with the logger interface changes described in the PR.

packages/processors/test/registry/handlers/profileNameUpdated.handler.spec.ts (1)

33-33: Added verbose logging method to the test logger.

The mock logger correctly implements the new verbose method, maintaining consistency with the updated logger interface.

packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/dvmdDirectTransfer.handler.spec.ts (1)

101-101: Added verbose log level to the ILogger implementation.

The logger object correctly implements the verbose method, ensuring compatibility with the updated ILogger interface.

packages/processors/test/strategy/directGrantsLite/directGrantsLite.handler.spec.ts (1)

72-72: Added verbose logging method to the test logger mock.

The logger implementation now correctly includes the verbose method, maintaining consistency with the updated logger interface.

packages/processors/test/strategy/easyRetroFunding/easyRetroFunding.handler.spec.ts (1)

78-78: LGTM!

The addition of the verbose mock logger method aligns with the PR objective of enhancing logging capabilities.

packages/processors/test/strategy/common/baseDistributionUpdated.handler.spec.ts (1)

37-37: LGTM!

The addition of the verbose mock logger method is consistent with the logging enhancements being implemented across the codebase.

apps/processing/test/unit/processing.service.spec.ts (1)

29-29: LGTM!

Adding the verbose mock function to the logger object in the mocked SharedDependenciesService properly supports the new verbose logging level.

packages/processors/test/strategy/directGrantsLite/handlers/updatedRegistration.handler.spec.ts (1)

57-57: LGTM!

The addition of the verbose mock logger method maintains consistency with the logging enhancements across the codebase.

packages/shared/test/notifier/notifier.factory.spec.ts (1)

12-12: Added new verbose level mock as part of logging enhancement.

The addition of the verbose mock method aligns with the PR objective of enhancing logging functionality across the codebase. This maintains consistency with the Winston logger configuration changes.

packages/processors/test/strategy/donationVotingMerkleDistributionDirectTransfer/handlers/updatedRegistration.handler.spec.ts (1)

57-57: Added new verbose logging mock method.

The addition of the verbose mock method maintains consistency with the updated logger interface across the codebase. This ensures test mocks mirror the actual logger implementation.

packages/processors/test/strategy/easyRetroFunding/handlers/updatedRegistration.handler.spec.ts (1)

57-57: Added verbose mock method to logger.

The addition of the verbose mock method ensures the test logger maintains parity with the updated logger interface. This change implements the PR objective consistently across all test files.

scripts/bootstrap/src/metadata.script.ts (1)

115-116: Updated console handling to map trace to verbose.

The change properly implements the PR objective by replacing the previous logger setup that passed the entire console object. Instead, it now explicitly maps console.trace to the new verbose log level, maintaining backward compatibility while implementing the new logging standard.

packages/shared/src/logger/logger.ts (2)

6-8: LGTM: Clean implementation of the verbose log level.

The addition of the "verbose" log level to both the type definition and valid levels array is well implemented and consistent with the existing code structure.

---

83-85: Implementation follows good practices.

The verbose method follows the same pattern as the existing logging methods, properly delegating to the Winston logger's corresponding method.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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 plan to trigger planning for file edits and PR creation.
• @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.

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.