fix(low-code): Fix declarative low-code state migration in SubstreamPartitionRouter

[tolik0]

Summary by CodeRabbit

• Refactor

  • Improved state migration logic in the SubstreamPartitionRouter class.
  • Added a new private method to handle stream state conversion.
  • Enhanced state initialization logic in the ConcurrentPerPartitionCursor class.

• Tests

  • Added a new test case for handling global cursor state scenarios.
  • Extended test coverage for state migration and incremental dependencies.
  • Simplified parameter structure in existing tests for clarity.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a refactor of the SubstreamPartitionRouter class, focusing on the set_initial_state method. A new private method, _migrate_child_state_to_parent_state, has been created to handle the migration of child state to the parent state format. This change simplifies the logic in set_initial_state, improves code readability, and enhances modularity by separating concerns. Additionally, modifications were made to the ConcurrentPerPartitionCursor class to refine state initialization logic, ensuring robustness against missing state keys.

Changes

File	Change Summary
airbyte_cdk/sources/declarative/partition_routers/substream_partition_router.py	- Added new private method _migrate_child_state_to_parent_state - Refactored set_initial_state method to utilize the new migration method - Updated get_stream_state method logic
unit_tests/sources/declarative/partition_routers/test_substream_partition_router.py	- Added new test case (Case 6) for handling global cursor state - Updated parameterization for tests
airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py	- Updated _set_initial_state method logic for cursor state initialization - Modified logic in _ensure_partition_limit method for partition management - Adjusted indentation in close_partition method
unit_tests/sources/declarative/incremental/test_concurrent_perpartitioncursor.py	- Updated parameterized test cases for test_incremental_parent_state and test_incremental_parent_state_migration - Adjusted expected state outputs for various tests

Possibly related PRs

• chore(refactor): Remove Partition.close #32: The changes in the SubstreamPartitionRouter class's set_initial_state method may relate to the refactoring of partition closure processes in the ConcurrentReadProcessor, as both involve state management and handling of partitions.
• chore(refactor): refactor partition generator to take any stream slicer #39: The refactor of the ConcurrentDeclarativeSource to improve stream handling may connect with the changes in SubstreamPartitionRouter, particularly in how streams and their states are managed.
• fix(low-code): Fix legacy state migration in SubstreamPartitionRouter #261: The modifications to the set_initial_state method in the SubstreamPartitionRouter directly relate to this PR, as it focuses on fixing legacy state migration issues within the same class.

Suggested reviewers

• maxi297
• pnilan

Hey there! 👋 I noticed you've done a nice refactoring of the state migration logic. A couple of quick thoughts:

1. The new _migrate_child_state_to_parent_state method looks clean - great job on extracting that logic! Wdyt about adding some type hints to make it even more explicit?

2. The new test case for global cursor state seems like a solid addition to the test coverage. Did you consider adding a comment explaining the specific scenario it's testing?

Would love to hear your thoughts on these suggestions! 🚀

---

📜 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 d2b0917 and 8bbb828.

📒 Files selected for processing (1)

• airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py (5 hunks)

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

• airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.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: 0

🧹 Nitpick comments (1)

unit_tests/sources/declarative/partition_routers/test_substream_partition_router.py (1)

467-475: Possible typo in 'looback_window'?

It appears "looback_window" might be a misspelling of "loopback_window". Would you confirm it's intentional or rename it for clarity? 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 b1824c6 and c1eea6a.

📒 Files selected for processing (2)

• airbyte_cdk/sources/declarative/partition_routers/substream_partition_router.py (1 hunks)
• unit_tests/sources/declarative/partition_routers/test_substream_partition_router.py (1 hunks)

⏰ 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 (Fast)
• GitHub Check: Pytest (All, Python 3.10, Ubuntu)
• GitHub Check: Analyze (python)

🔇 Additional comments (3)

airbyte_cdk/sources/declarative/partition_routers/substream_partition_router.py (2)

298-299: Consider partial parent_state merges?

Currently, if parent_state exists, the migration is skipped entirely. Would you consider merging child state into existing parent_state in some scenarios, or is this all-or-nothing approach intentional? wdyt?

---

306-349: Heads-up about handling multiple cursor_fields.

If cursor_field is a list, the logic storing substream_state in parent_config.stream.cursor_field might behave unexpectedly. Would you consider validating the field to ensure it's a single string or otherwise handle lists? wdyt?

unit_tests/sources/declarative/partition_routers/test_substream_partition_router.py (1)

483-483: New test ID looks good.

Thanks for adding a clear and descriptive test ID. No changes needed.

[coderabbitai]

Actionable comments posted: 0

🔭 Outside diff range comments (1)

airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py (1)

Line range hint 279-285: Safeguard potential missing keys in the per-partition state dictionary?
Right now, the code assumes "partition" and "cursor" keys exist in state. If these are absent, a KeyError could occur. Would you consider adding a quick check to ensure these keys exist or handle it gracefully, perhaps raising a user-friendly error if the keys are missing? wdyt?

🧹 Nitpick comments (1)

airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py (1)

267-270: Add a clarifying log for global-state assumption?
Currently, if both _PERPARTITION_STATE_KEY and _GLOBAL_STATE_KEY are absent, the entire stream_state is assumed to be global. Would you consider adding a brief log or comment here to clarify that assumption for future maintainers? For instance, logging something like: “No known partition keys present; interpreting stream_state as global.” 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 c1eea6a and 2b0a999.

📒 Files selected for processing (1)

• airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py (2 hunks)

⏰ 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 (Fast)
• GitHub Check: Pytest (All, Python 3.10, Ubuntu)
• GitHub Check: Analyze (python)

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

unit_tests/sources/declarative/incremental/test_concurrent_perpartitioncursor.py (1)

1385-1403: Unused test_name parameter (nitpick)
In your second @pytest.mark.parametrize definition, the function signature includes test_name, but it doesn’t appear to be used. Perhaps removing the test_name parameter or using it for descriptive logs might make the tests cleaner, 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 2b0a999 and d2b0917.

📒 Files selected for processing (1)

• unit_tests/sources/declarative/incremental/test_concurrent_perpartitioncursor.py (2 hunks)

⏰ 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 (Fast)
• GitHub Check: Pytest (All, Python 3.10, Ubuntu)
• GitHub Check: Analyze (python)

[tolik0]

Regression tests for Jira: https://github.com/airbytehq/airbyte/actions/runs/12955458269/job/36139617550