Skip to content

New developer option to use local scraper_config.json without having to use the fallback methods indirectly #532

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lynchmv
Copy link
Contributor

@lynchmv lynchmv commented Jul 9, 2025

Add developer option to use the local configuration source when building and testing locally.

Summary by CodeRabbit

  • New Features

    • Added a new configuration option to choose between using a remote or local configuration source.
    • Users can now specify whether to load the scraper configuration from a remote location or a local file.
  • Documentation

    • Updated configuration documentation with details about the new option for selecting the configuration source.

Copy link
Contributor

coderabbitai bot commented Jul 9, 2025

Walkthrough

A new configuration option, use_config_source, was introduced to control whether configuration is loaded from a remote or local source. Documentation was updated to describe this setting. The internal logic for fetching configuration was modified to respect this new option, enabling local file loading when specified.

Changes

File(s) Change Summary
db/config.py Added use_config_source: str = "remote" to the Settings class.
docs/configuration.md Documented the new use_config_source setting in a new "Local Development Settings" section.
utils/config.py Modified _fetch_config to check settings.use_config_source and load local config if set.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Settings
    participant RemoteConfigManager

    User->>RemoteConfigManager: Request configuration
    RemoteConfigManager->>Settings: Check use_config_source
    alt use_config_source == "local"
        RemoteConfigManager->>Settings: Get local_config_path
        RemoteConfigManager->>RemoteConfigManager: Load config from local file
        RemoteConfigManager-->>User: Return local config
    else use_config_source == "remote"
        RemoteConfigManager->>Settings: Get remote_config_source
        RemoteConfigManager->>RemoteConfigManager: Fetch config from remote source
        RemoteConfigManager-->>User: Return remote config
    end
Loading

Poem

A rabbit hops with config delight,
Now choosing remote or local at night.
With a single new setting,
The docs are abetting,
Fetching configs just feels right!
🐇✨

✨ 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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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 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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
db/config.py (1)

121-121: Consider using Literal type for better type safety.

The use_config_source field appears to accept only specific values ("remote" and "local"). Using a Literal type would provide better type safety and IDE support.

+from typing import Literal
-use_config_source: str = "remote"
+use_config_source: Literal["remote", "local"] = "remote"
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 067aac0 and 6fb701f.

📒 Files selected for processing (3)
  • db/config.py (1 hunks)
  • docs/configuration.md (2 hunks)
  • utils/config.py (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/configuration.md

[grammar] ~169-~169: Use correct spacing
Context: ...hedulersetting. ## Local Development Settings - **use_config_source** (default:remote`)...

(QB_NEW_EN_OTHER_ERROR_IDS_5)


[grammar] ~171-~171: Use correct spacing
Context: ...ote scraper configuration file or local source. ### How to Configure You can configure the...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

🔇 Additional comments (2)
utils/config.py (1)

47-48: LGTM! Clean implementation of the local config option.

The conditional check is well-placed and follows the early return pattern. It properly reuses the existing _load_local_config method and maintains the existing fallback behavior.

docs/configuration.md (1)

169-172: LGTM! Clear documentation for the new development setting.

The new section is well-structured and provides clear information about the use_config_source option. The placement in a dedicated "Local Development Settings" section makes it easy for developers to find.

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.

1 participant