feat(ingester): make running signature fetcher configurable

[armyhaylenko]

No description provided.

[coderabbitai]

Summary by CodeRabbit

• New Features
  • Introduced a new configuration option and command-line flag that allow users to optionally enable signature fetching during the ingestion process (default remains disabled). This update provides greater control over the execution of signature retrieval, ensuring it runs only when explicitly activated.

Walkthrough

The changes introduce a new configuration option for controlling signature fetching. A new environment variable (RUN_SIGNATURE_FETCHER=false) is added, and a corresponding boolean CLI argument (run_signature_fetcher) is incorporated into the application’s configuration. In the main application logic, the signature fetching process is now executed only if the flag is set to true. Additionally, a minor reorganization of variable declaration (moving metrics_clone) has been performed within the conditional block.

Changes

File(s)	Change Summary
.env.example, nft_ingester/src/config.rs	Added a new boolean configuration option (RUN_SIGNATURE_FETCHER in .env.example and run_signature_fetcher in IngesterClapArgs) with a default value of false.
nft_ingester/src/bin/ingester/main.rs	Wrapped the signature fetching logic in a conditional block based on the run_signature_fetcher flag and moved the declaration of metrics_clone inside this block.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ConfigParser as CLI/Config Parser
    participant MainApp as Application Main
    participant SignatureFetcher as Signature Fetcher

    User->>ConfigParser: Provide CLI arguments (--run_signature_fetcher flag)
    ConfigParser-->>MainApp: Parsed configuration (run_signature_fetcher value)
    MainApp->>MainApp: Check run_signature_fetcher flag
    alt run_signature_fetcher true
        MainApp->>SignatureFetcher: Instantiate & start signature fetching loop
    else run_signature_fetcher false
        MainApp->>MainApp: Skip signature fetching
    end

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 94db274 and ca3bee9.

📒 Files selected for processing (3)

• .env.example (1 hunks)
• nft_ingester/src/bin/ingester/main.rs (1 hunks)
• nft_ingester/src/config.rs (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: build-base-image
• GitHub Check: test

🔇 Additional comments (4)

.env.example (1)

16-16: Well-placed configuration option

The addition of RUN_SIGNATURE_FETCHER=false follows the existing pattern for configurable app parts and is appropriately placed in that section. The default value of false aligns with the approach used for other optional features.

nft_ingester/src/config.rs (2)

278-283: CLI argument implementation looks good

The new run_signature_fetcher field is well-implemented with appropriate Clap attributes and follows the same pattern as other similar configuration options. The help text clearly indicates its purpose and default value.

---

677-677: Test updated correctly

Good job updating the test case to verify the default value of the new field.

nft_ingester/src/bin/ingester/main.rs (1)

620-671: Signature fetcher implementation looks good

The conditional execution of the signature fetcher based on the new configuration flag is well implemented. The code follows existing patterns for task spawning, error handling, and metrics reporting.

I like the approach of making this functionality configurable, as it allows for more flexibility in deployment scenarios.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

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.