feat: adds config_path to source instantiation for sdm, enabling config migrations

[pnilan]

What

• Updates source-declarative-manifest to inject the config_path to the source, enabling config migrations as part of this epic: https://github.com/airbytehq/airbyte-internal-issues/issues/12530

Summary by CodeRabbit

• New Features
  • Added support for specifying an optional configuration file path when running sources from local YAML files.

[Copilot]

Pull Request Overview

This PR enhances the source instantiation process by injecting a new parameter, config_path, to support configuration migrations. Key changes include passing config_path to both SourceLocalYaml initiations and the declarative source creation.

[coderabbitai]

📝 Walkthrough

Walkthrough

The update introduces an optional config_path keyword argument to the constructors of SourceLocalYaml and ConcurrentDeclarativeSource within the _get_local_yaml_source and create_declarative_source functions. This argument is set based on the presence of a config attribute in the parsed arguments. No other logic or control flow is modified.

Changes

File(s)	Change Summary
airbyte_cdk/cli/source_declarative_manifest/_run.py	Added optional config_path argument to SourceLocalYaml and ConcurrentDeclarativeSource constructor calls, passing parsed_args.config if available.

Sequence Diagram(s)

sequenceDiagram
    participant CLI as CLI User
    participant Parser as Argument Parser
    participant Run as _run.py
    participant Source as SourceLocalYaml / ConcurrentDeclarativeSource

    CLI->>Parser: Parse arguments
    Parser->>Run: Provide parsed_args (may include config)
    Run->>Source: Instantiate with config, catalog, state, config_path (optional)
    Source-->>Run: Instance created

Loading

Would you like to see a more detailed breakdown of how config_path propagates through the constructors, or is this level of detail sufficient for your needs? Wdyt?

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 4b73b46 and 2bab624.

📒 Files selected for processing (1)

• airbyte_cdk/cli/source_declarative_manifest/_run.py (2 hunks)

🔇 Additional comments (2)

airbyte_cdk/cli/source_declarative_manifest/_run.py (2)

98-103: Implementation passes config_path to SourceLocalYaml, enabling config migrations

The addition of the config_path parameter to the SourceLocalYaml constructor is aligned with the PR objectives. This change enables the source to be aware of the location of its configuration file, which is necessary for implementing configuration migrations.

Could we add a brief comment explaining why this parameter is being added? Something like "Pass config_path to enable config migrations" would help future developers understand the purpose, wdyt?

---

212-212: Similar implementation for ConcurrentDeclarativeSource

The consistent approach of passing the config path to ConcurrentDeclarativeSource is good. This ensures both source implementations have access to the configuration file path.

Are there any tests that should be updated to verify this new parameter works correctly? Or is this covered elsewhere?

✨ 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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

[brianjlai]

The change itself seems sane, I didn't realize that we had actually moved SDM directly into the repo vs the original airbyte repo, so that was new to me ✅