airbytehq / airbyte-python-cdk

The Python CDK empowers hundreds of Airbyte connectors, including low-code and no-code connectors.
https://airbytehq.github.io/airbyte-python-cdk/
MIT License
0 stars 0 forks source link

chore(refactor): Remove Partition.close #32

Closed maxi297 closed 4 minutes ago

maxi297 commented 2 days ago

What

Work as part of https://github.com/airbytehq/airbyte-internal-issues/issues/10552

Following this conversation, we have moved part of the state management to the concurrent read processor. However, the close is still done as part of the partition. The reason this is annoying is that it adds a dependency between the partitions and the cursor and now every time there is a change in the cursor, it might affect the partitions.

How

We can remove this dependency by calling stream.cursor.close_partition(...) instead of partition.close as part of the concurrent read processor.

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 days ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes in this pull request involve multiple modifications across several classes, primarily focusing on the handling of partition management and cursor functionality. Key alterations include the removal of cursor parameters from various constructors, the introduction of enhanced error handling, and a shift in how partitions are closed—transitioning from direct calls on partitions to utilizing the stream's cursor. These adjustments aim to streamline the code and improve the encapsulation of partition management logic. ## Changes | File Path | Change Summary | |--------------------------------------------------------|--------------------------------------------------------------------------------------------------------| | `airbyte_cdk/sources/concurrent_source/concurrent_read_processor.py` | Updated `on_partition_complete_sentinel` method to close partitions via stream's cursor instead of directly. Error handling structure remains unchanged. | | `airbyte_cdk/sources/file_based/stream/concurrent/adapters.py` | Modified `FileBasedStreamFacade`, `FileBasedStreamPartition`, and `FileBasedStreamPartitionGenerator` classes. Removed cursor management attributes and methods, added error handling in `read_records`. | | `airbyte_cdk/sources/streams/concurrent/adapters.py` | Altered `StreamFacade`, `StreamPartition`, and `StreamPartitionGenerator` classes by removing cursor parameters and methods. Improved error logging in `read_records`. | | `airbyte_cdk/sources/streams/concurrent/partitions/partition.py` | Removed abstract methods `close` and `is_closed` from `Partition` class, altering its interface. | | `unit_tests/sources/file_based/stream/concurrent/test_adapters.py` | Updated tests for `FileBasedStreamPartition` to remove cursor parameter from instantiation while preserving functionality. | | `unit_tests/sources/file_based/stream/concurrent/test_file_based_concurrent_cursor.py` | Enhanced tests for `FileBasedConcurrentCursor` with new cases and adjustments to validate cursor behavior and synchronization conditions. | | `unit_tests/sources/streams/concurrent/test_adapters.py` | Modified tests for `StreamPartitionGenerator` and `StreamPartition` to remove cursor parameter from instantiation, ensuring existing functionality remains intact. | | `unit_tests/sources/streams/concurrent/test_concurrent_read_processor.py` | Adjusted tests in `TestConcurrentReadProcessor` to close partitions via the stream's cursor instead of directly, updating error handling accordingly. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Stream participant Cursor participant Partition User->>Stream: Request to complete partition Stream->>Cursor: close_partition(partition) Cursor->>Partition: Close partition logic Partition-->>Stream: Acknowledgment of closure Stream-->>User: Confirmation of partition completion ```

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 4aaf1e78383f63edfd374bd4d0f7bad242e819f8 and c28d1c1d51eab458937f006e2422903797a31dd8.
📒 Files selected for processing (2) * `unit_tests/sources/file_based/stream/concurrent/test_adapters.py` (2 hunks) * `unit_tests/sources/streams/concurrent/test_adapters.py` (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * unit_tests/sources/file_based/stream/concurrent/test_adapters.py * unit_tests/sources/streams/concurrent/test_adapters.py

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
aaronsteers commented 1 day ago

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