Feat: Added use_host_network param to get_destination()

[Niyas Hameed (niyasrad)]

Description

• PR to implement use_host_network, a Docker based connectors option for destinations. This enables locally testable destinations, for example, a local Postgres DB instance.
• Reference PR for get_source() Feat: Added use_host_network param to get_source(), for Docker containers to use host's network #277
• Due to this feature being in experiment mode for long, the destinations (new feature) did not persist these changes.
• Hence, including the use_host_network is necessary for destinations, if someone tried to use PyAirbyte locally.

Fixes/Implements #363

Summary by CodeRabbit

• New Features
  • Introduced a new parameter, use_host_network, for enhanced network access in connectors, allowing execution using the host network for specified Docker images.
• Documentation
  • Updated function documentation to clarify the purpose and usage of the new use_host_network parameter.

[coderabbitai]

Walkthrough

Walkthrough

The pull request introduces a new boolean parameter, use_host_network, to the get_destination function in the airbyte/destinations/util.py file. This parameter enables the use of the host network when executing a connector with a specified docker_image, addressing issues related to accessing local resources. The function's documentation has been updated to reflect this change, enhancing its configurability without altering the existing logic.

Changes

File	Change Summary
airbyte/destinations/util.py	Added use_host_network: bool = False to get_destination function.

Assessment against linked issues

Objective	Addressed	Explanation
Add use_host_network param to get_destination() (Issue #363)	✅

Possibly related PRs

• Feat: Added use_host_network param to get_source(), for Docker containers to use host's network #277: Introduced the use_host_network parameter in get_source() and get_destination() functions, enhancing Docker container network access.

Suggested labels

enable-ai-review

---

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 generate interesting stats about this repository and render them as a table.
  -- @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 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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

airbyte/destinations/util.py (1)

72-72: Nicely done! The use_host_network parameter is correctly passed to the executor.

Just a minor suggestion: What do you think about adding a comment to clarify that use_host_network is only effective when docker_image is set? This could help future maintainers understand the behavior at a glance. Wdyt?

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2f27c87 and 233d46d.

Files selected for processing (1)

• airbyte/destinations/util.py (3 hunks)

Additional comments not posted (2)

airbyte/destinations/util.py (2)

27-27: LGTM! The new use_host_network parameter looks good. The name is clear and the default value ensures backward compatibility. 👍

---

51-54: Looks great! The docstring update for the use_host_network parameter is clear and aligns with the implementation. Nice work on documenting the behavior and conditions. 🙌

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

Looks great! Thanks as always for contributing! 🙌

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

/test-pr