fix(low-code): add wrong dynamic stream name type validation

[Serhii Lazebnyi (lazebnyi)]

What

During the dynamic component resolving process, data mapping is not limited by field types. However, during instance creation, the 'name' field is strictly parsed as a string. Therefore, when we perform stream grouping here, we encounter a KeyError because the stream name in the manifest and the stream instance name might be of different types.

How

Add type validation for the stream name during components resolving process.

Summary by CodeRabbit

Summary by CodeRabbit

• Bug Fixes

  • Enhanced validation to ensure stream names are strings, preventing potential runtime errors.

• Tests

  • Added a new test case to verify error handling for invalid stream name types.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a validation mechanism for dynamic stream names in the Airbyte CDK. A new check has been added to ensure that stream names are strings, raising a ValueError if an invalid type is encountered. This modification enhances error handling by preventing processing of streams with incorrectly typed names, with a corresponding unit test added to verify the new validation logic.

Changes

File	Change Summary
airbyte_cdk/sources/declarative/manifest_declarative_source.py	Added type validation for stream names in _dynamic_stream_configs method
unit_tests/sources/declarative/resolvers/test_http_components_resolver.py	Added test_wrong_stream_name_type() to validate stream name type error handling

Possibly Related PRs

• feat(low-code cdk): add component resolver and http component resolver #88: Modifications to the ManifestDeclarativeSource class method
• feat(low-code): add check dynamic stream #223: Introduction of CheckDynamicStream class for stream validation
• feat(low-code): add use check availability flag to dynamic check #293: Enhanced connection check process for dynamic streams

Suggested Labels

enhancement

Suggested Reviewers

• natikgadzhi
• darynaishchenko

Hey there! 👋 I noticed you've added a neat validation check for stream names. Wdyt about potentially expanding this to include more comprehensive type checking or adding a more detailed error message that could help users diagnose the issue more quickly? Just a thought! 🤔

---

📜 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 f237392 and cd4d89d.

📒 Files selected for processing (1)

• unit_tests/sources/declarative/resolvers/test_http_components_resolver.py (2 hunks)

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

• unit_tests/sources/declarative/resolvers/test_http_components_resolver.py

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

• GitHub Check: Check: 'source-pokeapi' (skip=false)
• GitHub Check: Check: 'source-the-guardian-api' (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: Pytest (Fast)
• GitHub Check: Analyze (python)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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. (Beta)
• @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: 1

🧹 Nitpick comments (1)

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

368-370: LGTM! Good defensive programming practice.

Nice addition of type validation for stream names. This will help catch configuration issues early and provide clear error messages.

Hey, would you like to add a docstring to the _dynamic_stream_configs method explaining the expected types for the parameters and return value? This could help future maintainers, wdyt? 🤔

🧰 Tools

🪛 GitHub Actions: Linters

[warning] File needs formatting. Run 'ruff format' to fix formatting issues.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 65e6a0d and 88e36c5.

📒 Files selected for processing (3)

• airbyte_cdk/sources/declarative/auth/jwt.py (1 hunks)
• airbyte_cdk/sources/declarative/manifest_declarative_source.py (1 hunks)
• unit_tests/sources/declarative/resolvers/test_http_components_resolver.py (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• airbyte_cdk/sources/declarative/auth/jwt.py

🧰 Additional context used

🪛 GitHub Actions: Linters

airbyte_cdk/sources/declarative/manifest_declarative_source.py

[warning] File needs formatting. Run 'ruff format' to fix formatting issues.

unit_tests/sources/declarative/resolvers/test_http_components_resolver.py

[warning] File needs formatting. Run 'ruff format' to fix formatting issues.

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

• GitHub Check: Check: 'source-pokeapi' (skip=false)
• GitHub Check: Check: 'source-the-guardian-api' (skip=false)
• GitHub Check: Check: 'source-shopify' (skip=false)
• GitHub Check: Check: 'source-hardcoded-records' (skip=false)
• GitHub Check: Pytest (Fast)
• GitHub Check: Pytest (All, Python 3.11, Ubuntu)
• GitHub Check: Pytest (All, Python 3.10, Ubuntu)

[Serhii Lazebnyi (lazebnyi)]

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

[Serhii Lazebnyi (lazebnyi)]

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

[Artem Inzhyyants (artem1205)]

LGTM!