fix(file): Support column named type

[Maxime Carbonneau-Leclerc (maxi297)]

Addresses https://airbytehq-team.slack.com/archives/C03GD9SV36E/p1741359423619149

Basically, a user is having issue when the column name is the reserved word type. We can support that if we check the type of the value when we see the key type during the schema inference.

Discovered catalog before:

Discovered catalog after:

Summary by CodeRabbit

• Refactor
  • Enhanced data processing to more robustly handle missing values within various data configurations, including improvements for nested data structures. This update ensures improved data normalization and compatibility for file-based integrations.

[Aldo Gonzalez (aldogonzalez8)]

APPROVED

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the _fill_nulls method in the DefaultFileBasedStream class. The method now checks the type of each schema value: if the value is a string or list, it sets it to ["null", v]; otherwise, it recursively invokes _fill_nulls on the value. This modification enhances the handling of nested schema structures without changing the overall control flow.

Changes

File	Change Summary
airbyte_cdk/.../default_file_based_stream.py	Modified _fill_nulls to include a conditional: for string or list values, assign ["null", v]; for other types, process recursively to handle nested schemas.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Client
    participant DFS as DefaultFileBasedStream
    
    Caller->>DFS: _fill_nulls(schema)
    alt Value is string or list
        DFS-->>DFS: Set schema[k] = ["null", v]
    else Value is other type
        DFS->>DFS: _fill_nulls(v) (recursive call)
    end
    DFS-->>Caller: Return modified schema

Loading

Suggested labels

declarative-component-schema, airbyte-python-cdk

Suggested reviewers

• bnchrch (wdyt?)
• lmossman (wdyt?)

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 450a845 and e3d3828.

📒 Files selected for processing (1)

• airbyte_cdk/sources/file_based/stream/default_file_based_stream.py (1 hunks)

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

• 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)

🔇 Additional comments (1)

airbyte_cdk/sources/file_based/stream/default_file_based_stream.py (1)

359-362: The fix properly handles nested "type" schema values.

This change adds more granular handling of the "type" key within schemas. Now, it checks if the value is a string or list (common for type definitions) before adding "null" to it, or recursively processes nested objects if needed. This solves the issue with columns named "type" in the data, which was causing schema inference problems.

Nice approach to distinguish between different value types while maintaining backward compatibility. Recursively handling nested structures ensures the schema is properly nullable throughout.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @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.