fix(low code): Fix missing cursor for ClientSideIncrementalRecordFilterDecorator

[tolik0]

Resolves: #330

Summary by CodeRabbit

• New Features

  • Introduced a configurable option in the record processing workflow that lets users choose whether records are transformed before or after filtering, enhancing data handling flexibility.

• Tests

  • Added comprehensive tests to verify both processing orders, ensuring the new functionality performs as expected across different scenarios.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces a new boolean flag, transform_before_filtering, in the RecordSelector class. The flag alters the control flow in the filter_and_transform method to perform record transformation either before or after filtering, based on its value. The factory method in ModelToComponentFactory is updated to set this attribute conditionally when client_side_incremental_sync is provided. Additionally, new tests have been added to verify the behavior under both processing orders.

Changes

File(s)	Change Summary
airbyte_cdk/sources/declarative/extractors/record_selector.py, airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py	Introduced the transform_before_filtering attribute in RecordSelector. Updated control flow in filter_and_transform and the factory method to conditionally apply transformation before filtering based on the flag and client-side incremental sync.
unit_tests/sources/declarative/extractors/test_record_selector.py, unit_tests/sources/declarative/parsers/test_model_to_component_factory.py	Added tests to validate record processing order, including a new test function for both transformation-first and filtering-first scenarios, and assertions to ensure the attribute is set correctly.

Sequence Diagram(s)

sequenceDiagram
    participant RS as RecordSelector
    participant TR as Transformer
    participant FL as Filter
    alt Transformation Before Filtering (flag True)
        RS ->> TR: Transform records
        TR -->> RS: Return transformed records
        RS ->> FL: Filter transformed records
        FL -->> RS: Return filtered records
    else Filtering Before Transformation (flag False)
        RS ->> FL: Filter records
        FL -->> RS: Return filtered records
        RS ->> TR: Transform filtered records
        TR -->> RS: Return transformed records
    end

Loading

Possibly related PRs

• fix: Async Retriever change url path for download retriever #192: Modifications in the RecordSelector class around the handling of transform_before_filtering are similar to the changes introduced here.
• feat: add download_decoder + download_extractor #50: Updates pertaining to the RecordSelector class that involve the new attribute for reordering transformation and filtering procedures.
• feat(low-code cdk): add transformation to dynamic schema loader #176: Involves enhancements in the ModelToComponentFactory related to transformation handling, aligning with the new behavior added in this PR.

Suggested labels

bug

Suggested reviewers

• Would you consider adding maxi297 as a reviewer, wdyt?
• Would you consider adding brianjlai as a reviewer, wdyt?
• Would you consider adding darynaishchenko as a reviewer, wdyt?

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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)

airbyte_cdk/sources/declarative/extractors/record_selector.py (1)

108-118: Consider adding docstring to explain the transformation order behavior.

The conditional logic is clear, but adding a docstring would help users understand the impact of transform_before_filtering on the processing order.

 def filter_and_transform(
     self,
     all_data: Iterable[Mapping[str, Any]],
     stream_state: StreamState,
     records_schema: Mapping[str, Any],
     stream_slice: Optional[StreamSlice] = None,
     next_page_token: Optional[Mapping[str, Any]] = None,
 ) -> Iterable[Record]:
+    """
+    Process records by applying transformations and filtering.
+    
+    When transform_before_filtering is True, records are transformed before being filtered.
+    This is useful when the filter depends on transformed values.
+    Otherwise, records are filtered first and only matching records are transformed.
+    """

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fdcded3 and 613481d.

📒 Files selected for processing (4)

• airbyte_cdk/sources/declarative/extractors/record_selector.py (2 hunks)
• airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py (3 hunks)
• unit_tests/sources/declarative/extractors/test_record_selector.py (2 hunks)
• unit_tests/sources/declarative/parsers/test_model_to_component_factory.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 (All, Python 3.10, Ubuntu)
• GitHub Check: Pytest (Fast)
• GitHub Check: Analyze (python)

🔇 Additional comments (5)

airbyte_cdk/sources/declarative/extractors/record_selector.py (1)

44-44: LGTM! Good default value choice.

The transform_before_filtering flag is initialized to False which maintains backward compatibility with existing behavior.

unit_tests/sources/declarative/extractors/test_record_selector.py (1)

225-311: LGTM! Comprehensive test coverage.

The test is well-structured with:

• Clear test cases for both transformation orders
• Good documentation explaining the test scenarios
• Thorough assertions verifying the behavior

airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py (2)

2419-2430: LGTM! Clean integration with client-side incremental sync.

The changes correctly set transform_before_filtering to True when client-side incremental sync is enabled, ensuring transformed values are available for filtering.

---

2445-2445: LGTM! Proper inclusion in RecordSelector initialization.

The transform_before_filtering flag is correctly passed to the RecordSelector constructor.

unit_tests/sources/declarative/parsers/test_model_to_component_factory.py (1)

1197-1197: LGTM! The new assertions validate the transform_before_filtering behavior.

The added assertions verify that transformations are applied before filtering when using client-side incremental sync, which is the expected behavior. This helps ensure data consistency and proper record processing order.

Also applies to: 1279-1279

[artem1205]

LGTM!