fix: resolve issue in Cache.create_source_tables

[Aaron ("AJ") Steers (aaronsteers)]

Summary by CodeRabbit

• New Features
  • Automatic registration of new data source configurations has been added. Now, when a data source is set up, its catalog details are promptly recorded, ensuring a smoother and more reliable initialization process.
• Bug Fixes
  • Improved the integrity of source tables by enhancing the cache creation process.
• Tests
  • Added a new integration test for verifying the functionality of cache creation and source tables.
  • Removed an outdated unit test related to the create_source_tables method.

[coderabbitai]

📝 Walkthrough

Walkthrough

The change extends the create_source_tables method in the CacheBase class by adding a new code block that registers an incoming source catalog. This is done immediately after the catalog provider is instantiated, using a call to the register_source method with three parameters: source_name, incoming_source_catalog, and a set of stream_names. The subsequent logic, including ensuring the schema exists and creating tables for streams if needed, remains unchanged.

Changes

File	Change Summary
airbyte/caches/base.py	Added registration of the source catalog in create_source_tables. Calls register_source with source_name, incoming_source_catalog, and stream_names prior to schema validation and table creation.
tests/integration_tests/test_all_cache_types.py	Added test_cache_create_source_tables to verify cache creation and integrity of source tables, requiring credentials and marked as slow.
tests/unit_tests/test_caches.py	Removed test_create_source_tables which tested the create_source_tables method of the DuckDBCache class, eliminating associated mock object checks.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant CB as CacheBase
    participant CP as CatalogProvider
    participant DB as Database

    Caller ->> CB: call create_source_tables(source)
    CB ->> CP: instantiate catalog_provider
    CB ->> CB: call register_source(source_name, incoming_source_catalog, stream_names)
    CB ->> DB: ensure schema exists
    CB ->> DB: create tables for streams if missing

Loading

Would you like any further details or adjustments to the diagram?

---

📜 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 3466914 and ce17889.

📒 Files selected for processing (2)

• tests/integration_tests/test_all_cache_types.py (1 hunks)
• tests/unit_tests/test_caches.py (0 hunks)

💤 Files with no reviewable changes (1)

• tests/unit_tests/test_caches.py

🧰 Additional context used

🧬 Code Definitions (1)

tests/integration_tests/test_all_cache_types.py (4)

tests/integration_tests/test_source_faker_integration.py (1)

• source_faker_seed_a (57-68)

airbyte/sources/base.py (2)

• Source (52-759)
• get_selected_streams (156-161)

tests/integration_tests/conftest.py (1)

• new_generic_cache (181-183)

airbyte/caches/base.py (3)

• CacheBase (41-367)
• create_source_tables (297-331)
• streams (231-239)

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

• GitHub Check: Pytest (All, Python 3.11, Windows)
• GitHub Check: Pytest (All, Python 3.11, Ubuntu)
• GitHub Check: Pytest (All, Python 3.10, Windows)
• GitHub Check: Pytest (All, Python 3.10, Ubuntu)
• GitHub Check: Pytest (No Creds)
• GitHub Check: Pytest (Fast)

🔇 Additional comments (1)

tests/integration_tests/test_all_cache_types.py (1)

203-214: Good addition! Clean test for the create_source_tables fix.

The test clearly verifies that the newly added code in create_source_tables correctly registers the incoming source catalog by checking that the cache's streams match the source's selected streams. This is a solid integration test that helps ensure the fix for issue #642 works as expected.

A small suggestion - would it be worth adding an additional assertion to verify that the tables were actually created in the database? Something like checking if the tables exist in the schema? This would more fully test steps 2 and 3 of the create_source_tables method, wdyt?

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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 plan to trigger planning for file edits and PR creation.
• @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 or @coderabbitai title 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.