fix: (CDK) (CsvParser) - Fix the \\ escaping when passing the delimiter from Builder's UI

[bazarnov]

What

Sometimes there is a case when the csv file is encoded with the \t or other delimiters supported (basically any character) and should be passed with the escape character alongside. This breaks the CsvParser implementation when the input goes from the Builder's UI.

More context here: https://airbytehq-team.slack.com/archives/C02U9R3AF37/p1740003282758399

How

• added pre-parsing for the delimiter to decode the escaping_character and normalize the input before decoding records.

User Impact

No impact is expected, this is not a Breaking change.

Summary by CodeRabbit

• New Features
  • Enhanced CSV file parsing to correctly interpret escaped delimiter characters. This improvement provides a more robust approach to processing CSV files, resulting in better data ingestion and compatibility with varied CSV formats.
• Tests
  • Updated test cases to validate the new delimiter handling and ensure reliable, consistent CSV data processing. Additional validations were added to safeguard integration performance.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new private method, _get_delimiter, in the CsvParser class that processes the CSV delimiter by checking for and decoding escaped characters. The parse method has been updated to use this helper instead of directly using the delimiter attribute. In addition, a test has been modified to initialize CsvParser with an escaped tab character ("\\t") instead of a literal tab, ensuring that the parsing logic correctly interprets escape sequences.

Changes

File Path	Change Summary
airbyte_cdk/.../composite_raw_decoder.py	Added private method _get_delimiter to decode and process delimiters; updated parse to use this method.
unit_tests/.../test_composite_decoder.py	Changes in test_composite_raw_decoder_gzip_csv_parser: the delimiter is now provided as "\\t" to validate escape handling.

Sequence Diagram(s)

sequenceDiagram
    participant C as CsvParser.parse
    participant D as _get_delimiter
    participant R as csv.DictReader

    C->>D: Call _get_delimiter()
    D-->>C: Return processed delimiter
    C->>R: Initialize csv.DictReader with delimiter
    R-->>C: Return parsed records

Loading

Suggested labels

bug, security

Suggested reviewers

• Would you consider involving natikgadzhi? wdyt?
• How about asking maxi297 for their insights? wdyt?
• Maybe aaronsteers could be a good fit for this review? 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 (2)

airbyte_cdk/sources/declarative/decoders/composite_raw_decoder.py (1)

110-118: Consider making the delimiter processing immutable, wdyt?

The method modifies self.delimiter which could lead to unexpected behavior if the method is called multiple times. How about returning a new value instead?

 def _get_delimiter(self) -> Optional[str]:
     """
     Get delimiter from the configuration. Check for the escape character and decode it.
     """
     if self.delimiter is not None:
         if self.delimiter.startswith("\\"):
-            self.delimiter = self.delimiter.encode("utf-8").decode("unicode_escape")
+            return self.delimiter.encode("utf-8").decode("unicode_escape")
+        return self.delimiter
 
-    return self.delimiter
+    return None

unit_tests/sources/declarative/decoders/test_composite_decoder.py (1)

56-72: Consider adding more test cases for delimiter handling, wdyt?

The current test covers the basic case well. Would you like to add tests for:

• Multiple escaped characters (e.g., "\\t")
• Other common escape sequences (e.g., "\n", "\r")
• Empty delimiter

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 978be1b and 99c2633.

📒 Files selected for processing (2)

• airbyte_cdk/sources/declarative/decoders/composite_raw_decoder.py (2 hunks)
• unit_tests/sources/declarative/decoders/test_composite_decoder.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: Check: 'source-pokeapi' (skip=false)
• GitHub Check: Check: 'source-amplitude' (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 (Fast)
• GitHub Check: Pytest (All, Python 3.10, Ubuntu)
• GitHub Check: Analyze (python)

🔇 Additional comments (2)

airbyte_cdk/sources/declarative/decoders/composite_raw_decoder.py (1)

127-128: LGTM! Nice use of the new helper method.

The parse method now correctly handles escaped delimiters through the _get_delimiter helper.

unit_tests/sources/declarative/decoders/test_composite_decoder.py (1)

65-66: LGTM! Great test coverage for the escape handling.

The test now properly verifies that the parser can handle escaped delimiters, and the comment clearly explains the intention.

[artem1205]

Approving as a temporal solution, till we fix encoding of escape characters in UI

[ChristoGrab]

Thanks for the fix @bazarnov!