fix: gracefully continue on tempfile cleanup failure

[aaronsteers]

Resolves: airbytehq/PyAirbyte#424

Replaces:

• Fix(python-cdk): Don't fail on temp folder cleanup airbyte#47220

Summary by CodeRabbit

• New Features

  • Improved error handling for message validation in the AirbyteEntrypoint class.
  • Enhanced temporary directory management to handle Windows file lock errors.

• Bug Fixes

  • Adjusted cleanup process to ignore errors related to temporary files on Windows.

• Tests

  • Updated test cases to reflect changes in temporary directory management without altering test logic.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the AirbyteEntrypoint class and the enable_cache_fixture function in the test suite. The run method now includes the ignore_cleanup_errors=True parameter in the tempfile.TemporaryDirectory context manager, improving temporary directory management on Windows. Additionally, the handle_record_counts method has enhanced error handling by validating the presence of record and state attributes in AirbyteMessage. In the test file, the same parameter is added for consistency in error handling during testing. Overall, these changes focus on improving error management and robustness in both the application and its tests.

Changes

File	Change Summary
airbyte_cdk/entrypoint.py	Modified run method to include ignore_cleanup_errors=True in TemporaryDirectory. Enhanced error handling in handle_record_counts method for message validation.
unit_tests/sources/streams/test_call_rate.py	Added ignore_cleanup_errors=True to TemporaryDirectory in enable_cache_fixture function for consistent error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AirbyteEntrypoint
    participant TemporaryDirectory
    participant MessageValidator

    User->>AirbyteEntrypoint: Execute command (spec/check/discover/read)
    AirbyteEntrypoint->>TemporaryDirectory: Create temporary directory (ignore_cleanup_errors=True)
    TemporaryDirectory-->>AirbyteEntrypoint: Directory created
    AirbyteEntrypoint->>MessageValidator: Validate message attributes
    alt Missing Attributes
        MessageValidator-->>AirbyteEntrypoint: Raise ValueError
    else Valid Attributes
        MessageValidator-->>AirbyteEntrypoint: Process message
    end
    AirbyteEntrypoint->>User: Return result

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fbf007a and a251049.

📒 Files selected for processing (1)

• airbyte_cdk/entrypoint.py (3 hunks)

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

• airbyte_cdk/entrypoint.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
• 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 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

🧹 Outside diff range and nitpick comments (2)

airbyte_cdk/entrypoint.py (2)

132-136: LGTM! Consider adding debug logging for cleanup failures?

The change to ignore cleanup errors is a good defensive programming approach. What do you think about adding debug logging when cleanup fails? This could help with debugging if needed, wdyt?

 with tempfile.TemporaryDirectory(
     # Cleanup can fail on Windows due to file locks. Ignore if so,
     # rather than failing the whole process.
-    ignore_cleanup_errors=True,
+    ignore_cleanup_errors=True,
+    # Using a lambda to avoid string formatting overhead when debug logging is disabled
+    onerror=lambda func, path, exc_info: logger.debug(f"Ignored cleanup error for {path}: {exc_info[1]}")
 ) as temp_dir:

---

133-134: Would you mind expanding the comment about Windows file locks?

The comment is helpful but could be more specific about which Windows scenarios can cause file locks (e.g., open file handles, antivirus scanning). This would help future maintainers understand the exact use cases this handles, wdyt?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9587d4e and fbf007a.

📒 Files selected for processing (2)

• airbyte_cdk/entrypoint.py (1 hunks)
• unit_tests/sources/streams/test_call_rate.py (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• unit_tests/sources/streams/test_call_rate.py