Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(declarative): Pass extra_fields in global_substream_cursor #195

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

szubster
Copy link
Contributor

@szubster szubster commented Jan 2, 2025

per_partition_cursor correctly passes extra_fields to StreamSlice from partition.
global_substream_cursor does not.

I did not have an idea how to test this properly.

Summary by CodeRabbit

  • New Features
    • Enhanced GlobalSubstreamCursor to support additional contextual information in stream slices.
    • Improved data structure for tracking state with extra fields in stream processing.

Copy link
Contributor

coderabbitai bot commented Jan 2, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the GlobalSubstreamCursor class in the Airbyte CDK's declarative incremental source implementation. The primary change involves enhancing the StreamSlice instantiation by adding an extra_fields parameter in two methods: stream_slices and generate_slices_from_partition. This modification allows the StreamSlice to capture additional contextual information from the partition object, potentially improving state tracking and data management.

Changes

File Change Summary
airbyte_cdk/sources/declarative/incremental/global_substream_cursor.py - Updated stream_slices() method to include extra_fields=partition.extra_fields
- Updated generate_slices_from_partition() method to include extra_fields=partition.extra_fields

Sequence Diagram

sequenceDiagram
    participant GS as GlobalSubstreamCursor
    participant SS as StreamSlice
    
    GS->>SS: Create StreamSlice
    SS-->>GS: StreamSlice with extra_fields
Loading

Hey there! 👋 I noticed you're adding extra_fields to the StreamSlice instantiation. Quick question: Are you looking to make the slice more context-aware? Wdyt about potentially documenting what kind of extra information these fields might carry? 🤔 It could help future developers understand the purpose of this enhancement.


📜 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 4dde24f and ff27919.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/incremental/global_substream_cursor.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • airbyte_cdk/sources/declarative/incremental/global_substream_cursor.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
🪧 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
airbyte_cdk/sources/declarative/incremental/global_substream_cursor.py (1)

131-131: Balanced approach for generate_slices_from_partition.
Great to see the same approach for passing extra_fields here. Would you be open to adding a simple test to confirm that extra_fields is successfully set in these generated slices as well? 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 f8cb659 and 4dde24f.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/incremental/global_substream_cursor.py (2 hunks)
🔇 Additional comments (1)
airbyte_cdk/sources/declarative/incremental/global_substream_cursor.py (1)

115-115: Consider verifying the presence of extra_fields in the partition.
Would you like to add a quick check or default behavior in case extra_fields is missing or unexpected in the partition? wdyt?

@szubster szubster changed the title Pass extra_fields in global_substream_cursor fix(declarative): Pass extra_fields in global_substream_cursor Jan 2, 2025
@szubster
Copy link
Contributor Author

szubster commented Jan 3, 2025

/autofix

@szubster
Copy link
Contributor Author

szubster commented Jan 3, 2025

I do not see how the failing test has any connection with the code I am changing....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant