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(concurrent-partition-cursor): update cursor comparison to leverage ab_datetime #297

Closed

Conversation

pnilan
Copy link
Contributor

@pnilan pnilan commented Jan 30, 2025

What

Summary by CodeRabbit

  • Bug Fixes
    • Improved datetime parsing and comparison logic for cursor state management to enhance precision and reliability of incremental data synchronization.

Copy link
Contributor

coderabbitai bot commented Jan 30, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a modification to the ConcurrentPerPartitionCursor class in the Airbyte CDK's declarative source implementation. The change focuses on improving datetime comparison logic by importing ab_datetime_parse and AirbyteDateTime from the datetime helpers module. The primary enhancement involves more precise cursor state comparisons by converting values to epoch milliseconds, potentially resolving issues with different datetime formats or types.

Changes

File Change Summary
airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py - Added import for ab_datetime_parse and AirbyteDateTime
- Modified close_partition method to use ab_datetime_parse for more precise datetime comparisons

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • darynaishchenko
  • maxi297

Hey there! I noticed you've made some interesting changes to the datetime comparison logic. Would you mind sharing a bit more context about what specific datetime parsing challenges you encountered that led to this modification? Wdyt about adding a quick comment explaining the rationale? This could help future maintainers understand the reasoning behind the change. Cheers! 👍


📜 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 96e8b0c and 7c7a340.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py (2 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: Analyze (python)
  • GitHub Check: Pytest (Fast)
  • GitHub Check: Pytest (All, Python 3.10, Ubuntu)

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/concurrent_partition_cursor.py (1)

150-155: Consider adding error handling for datetime parsing.

The cursor comparison enhancement looks good! Using ab_datetime_parse to convert to epoch milliseconds will handle different datetime formats consistently. However, what do you think about adding error handling for cases where the cursor values might not be valid datetime strings? 🤔

Example approach:

     if (
         self._new_global_cursor is None
-        or ab_datetime_parse(
-            self._new_global_cursor[self.cursor_field.cursor_field_key]
-        ).to_epoch_millis()
-        < ab_datetime_parse(
-            cursor.state[self.cursor_field.cursor_field_key]
-        ).to_epoch_millis()
+        or self._compare_cursor_values(
+            self._new_global_cursor[self.cursor_field.cursor_field_key],
+            cursor.state[self.cursor_field.cursor_field_key]
+        )
     ):
         self._new_global_cursor = copy.deepcopy(cursor.state)

+def _compare_cursor_values(self, value1: str, value2: str) -> bool:
+    try:
+        return (ab_datetime_parse(value1).to_epoch_millis() <
+                ab_datetime_parse(value2).to_epoch_millis())
+    except ValueError as e:
+        logger.error(f"Failed to parse cursor values: {e}")
+        # Fall back to string comparison or raise based on your preference
+        return value1 < value2

wdyt? This would make the code more robust against invalid datetime formats. 🛡️

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3af96dc and ef0449a.

📒 Files selected for processing (1)
  • airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py (2 hunks)
🧰 Additional context used
🪛 GitHub Actions: Linters
airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py

[error] 5-28: Import block is un-sorted or un-formatted. This can be fixed automatically using the --fix option with ruff.

⏰ Context from checks skipped due to timeout of 90000ms (9)
  • 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.12, Ubuntu)
  • 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 (1)
airbyte_cdk/sources/declarative/incremental/concurrent_partition_cursor.py (1)

26-26: Fix import block sorting.

The import block needs to be sorted. This can be fixed automatically using the --fix option with ruff.

Would you like me to generate a script to fix the import sorting? 🔧

@natikgadzhi natikgadzhi changed the title fix(concurrent-partition-cursor) - update cursor comparison to leverage ab_datetime fix(concurrent-partition-cursor): update cursor comparison to leverage ab_datetime Jan 30, 2025
Copy link
Contributor

@maxi297 maxi297 left a comment

Choose a reason for hiding this comment

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

Can we add a unit test to document the issue?

@github-actions github-actions bot added the bug Something isn't working label Jan 30, 2025
@pnilan
Copy link
Contributor Author

pnilan commented Jan 30, 2025

Closing as alternative PR merged: #298

@pnilan pnilan closed this Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants