fix: substreampartitionrouter state migration from child when it is empty

[maxi297]

Context

We had this alert after doing the low-code migration of source-zendesk-support. The series of event seems to be that:

• We sync has post_comment_votes but it is empty. Therefore, state is {} (as shown by this)
• We run once, the migration will create the following state:

{
      "states": [],
      "parent_state": {
        "post_comments": {
          "state": {},
          "states": [],
          "parent_state": {
            "posts": {}
          },
          "lookback_window": 1,
          "use_global_cursor": false
        }
      },
      "lookback_window": 1,
      "use_global_cursor": false
    }
}

• When running the next sync, we think we need to run _migrate_child_state_to_parent_state because the parent state is empty but we call list(stream_state["state"].values())[0] on {} which leads to a index error

Proposed solution

If the child state is empty, we should fallback on {} for the parent

Summary by CodeRabbit

• Bug Fixes
  • Improved state update handling to ensure that only valid, non-empty state data is processed.
• Tests
  • Expanded test coverage with a new case to verify proper state initialization when both child and parent states are empty.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR modifies the _migrate_child_state_to_parent_state method in the partition router to include an additional condition that checks if the state dictionary is not empty before proceeding with state migration. It also introduces a new test case in the set_initial_state method to validate the behavior when the child state is empty. There are no changes to public entity declarations.

Changes

File(s)	Summary
airbyte_cdk/.../substream_partition_router.py	Updated _migrate_child_state_to_parent_state method to add a condition that checks stream_state["state"] is not an empty dictionary.
unit_tests/.../test_substream_partition_router.py	Added a new test case (Case 7) with the identifier "initial_state_no_parent_and_no_child" to verify that no parent state is set when child state is empty.

Possibly related PRs

• fix(low-code): Add parent state migration from global state #322: This PR also modifies the _migrate_child_state_to_parent_state method, indicating a close code-level connection. wdyt?
• fix(low-code): Fix declarative low-code state migration in SubstreamPartitionRouter #267: This PR introduced the migration logic in the same method, which relates directly to the updates in this diff. wdyt?

Suggested reviewers

• darynaishchenko – Would you like to take a look at these changes? wdyt?
• aldogonzalez8 – Would you be interested in reviewing this as well? wdyt?

---

📜 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 af400e5 and 26095cb.

📒 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 (2 hunks)

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

• airbyte_cdk/sources/declarative/partition_routers/substream_partition_router.py
• unit_tests/sources/declarative/partition_routers/test_substream_partition_router.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 (Fast)
• GitHub Check: Pytest (All, Python 3.11, Ubuntu)
• GitHub Check: SDM Docker Image Build
• GitHub Check: Pytest (All, Python 3.10, Ubuntu)
• 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 plan to trigger planning for file edits and PR creation.
• @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.

[maxi297]

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