fix: When grouping streams, ensure stream is declarative before checking in the manifest #425

maxi297 · 2025-03-14T13:34:56Z

What

If a stream returned by streams is not declarative, we would get a key error as such:

  File "/Users/maxime/devel/code/airbyte-python-cdk/airbyte_cdk/sources/declarative/concurrent_declarative_source.py", line 209, in _group_streams
    if name_to_stream_mapping[declarative_stream.name]["type"] == "StateDelegatingStream":
KeyError: 'articles'

How

Checking if the stream is declarative before checking in the manifest

Summary by CodeRabbit

Bug Fixes
- Improved validation of data streams to prevent potential processing errors and enhance overall reliability.

maxi297 · 2025-03-14T13:36:56Z

/autofix

Auto-Fix Job Info

This job attempts to auto-fix any linting or formating issues. If any fixes are made,
those changes will be automatically committed and pushed back to the PR.

Note: This job can only be run by maintainers. On PRs from forks, this command requires
that the PR author has enabled the Allow edits from maintainers option.

PR auto-fix job started... Check job output.

✅ Changes applied successfully.

coderabbitai · 2025-03-14T13:37:09Z

📝 Walkthrough

Walkthrough

The modification enhances type checking in the _group_streams method of the declarative source module. An isinstance check was added to ensure that declarative_stream is an instance of DeclarativeStream prior to evaluating its type against "StateDelegatingStream". This change refines the control flow by requiring both conditions to be met for the subsequent logic to execute, thus preventing potential errors with non-conforming streams.

Changes

File(s)	Change Summary
`airbyte_cdk/.../concurrent_declarative_source.py`	Added an `isinstance` check in the `_group_streams` method to ensure `declarative_stream` is a `DeclarativeStream` before checking its type.

Sequence Diagram(s)

sequenceDiagram
    participant GS as _group_streams
    participant DS as DeclarativeStream
    participant OS as OtherStream

    GS->>GS: Evaluate declarative_stream type
    alt Is DeclarativeStream
        GS->>DS: Process with StateDelegatingStream logic
    else Not DeclarativeStream
        GS->>GS: Skip specialized state processing
    end

Possibly related PRs

chore: fix typing issues #135: Enhances type checking in the _group_streams method alongside improvements to stream configuration handling.

Suggested labels

declarative-component-schema

Suggested reviewers

darynaishchenko
natikgadzhi

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
- To enable this feature, set early_access to true under in the settings.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bb559b6 and 8653014.

📒 Files selected for processing (1)

airbyte_cdk/sources/declarative/concurrent_declarative_source.py (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

airbyte_cdk/sources/declarative/concurrent_declarative_source.py

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

GitHub Check: Check: 'source-pokeapi' (skip=false)
GitHub Check: Check: 'source-amplitude' (skip=false)
GitHub Check: Check: 'source-shopify' (skip=false)
GitHub Check: Check: 'source-hardcoded-records' (skip=false)
GitHub Check: Pytest (All, Python 3.11, Ubuntu)
GitHub Check: Pytest (All, Python 3.10, Ubuntu)
GitHub Check: SDM Docker Image Build
GitHub Check: Pytest (Fast)
GitHub Check: Analyze (python)

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

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

airbyte_cdk/sources/declarative/concurrent_declarative_source.py (1)

209-209: Good type check to prevent KeyError, but suggest minor formatting adjustment

The added check to verify if the stream is an instance of DeclarativeStream before accessing its properties in the manifest is a proper defensive programming approach. This prevents the KeyError mentioned in the PR description when processing non-declarative streams.

The Ruff linter reports a formatting issue in the pipeline failure. Could we fix that by running ruff format on this file, wdyt?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e9f23a0 and bb559b6.

📒 Files selected for processing (1)

airbyte_cdk/sources/declarative/concurrent_declarative_source.py (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Linters

airbyte_cdk/sources/declarative/concurrent_declarative_source.py

[error] 1-1: Ruff formatting check failed. 1 file would be reformatted. Run 'ruff format' to fix code style issues in this file.

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

GitHub Check: Check: 'source-pokeapi' (skip=false)
GitHub Check: Check: 'source-amplitude' (skip=false)
GitHub Check: Check: 'source-shopify' (skip=false)
GitHub Check: Check: 'source-hardcoded-records' (skip=false)
GitHub Check: Pytest (All, Python 3.11, Ubuntu)
GitHub Check: Pytest (All, Python 3.10, Ubuntu)
GitHub Check: SDM Docker Image Build
GitHub Check: Pytest (Fast)
GitHub Check: Analyze (python)

Ensure stream is declarative

bb559b6

github-actions bot added bug Something isn't working security labels Mar 14, 2025

maxi297 requested review from lazebnyi and pnilan March 14, 2025 13:35

lazebnyi approved these changes Mar 14, 2025

View reviewed changes

coderabbitai bot reviewed Mar 14, 2025

View reviewed changes

coderabbitai bot approved these changes Mar 14, 2025

View reviewed changes

Auto-fix lint and format issues

8653014

maxi297 merged commit df5c8cb into main Mar 14, 2025
25 of 26 checks passed

maxi297 deleted the maxi297/ensure-stream-is-declarative branch March 14, 2025 14:00

coderabbitai bot mentioned this pull request Apr 22, 2025

fix: only check for file upload if stream is declarative #501

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: When grouping streams, ensure stream is declarative before checking in the manifest #425

fix: When grouping streams, ensure stream is declarative before checking in the manifest #425

Uh oh!

maxi297 commented Mar 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

maxi297 commented Mar 14, 2025 •

edited by github-actions bot

Loading

Uh oh!

coderabbitai bot commented Mar 14, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

fix: When grouping streams, ensure stream is declarative before checking in the manifest #425

fix: When grouping streams, ensure stream is declarative before checking in the manifest #425

Uh oh!

Conversation

maxi297 commented Mar 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

How

Summary by CodeRabbit

Uh oh!

maxi297 commented Mar 14, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

maxi297 commented Mar 14, 2025 •

edited by coderabbitai bot

Loading

maxi297 commented Mar 14, 2025 •

edited by github-actions bot

Loading

coderabbitai bot commented Mar 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)