Feat: Use GCS public bucket to get manifest yaml for connectors; adds support for pinning versions and getting prior versions by aaronsteers · Pull Request #394 · airbytehq/PyAirbyte

Aaron ("AJ") Steers (aaronsteers) · 2024-09-23T16:21:29Z

Summary by CodeRabbit

New Features
- Enhanced manifest URL construction with optional version handling for improved flexibility.
- Introduced a default manifest URL format for easier access.
Bug Fixes
- Streamlined error handling to ensure source_name is always required, preventing potential errors.
Refactor
- Simplified logic for obtaining the manifest URL, removing unnecessary complexity.
Chores
- Updated User-Agent header in HTTP requests for improved identification to the server.

…ersions and getting prior versions

coderabbitai · 2024-09-23T16:21:42Z

Warning

Rate limit exceeded

Aaron ("AJ") Steers (@aaronsteers) has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 17 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 593f5c2 and 9e0d885.

Walkthrough

The changes involve the _try_get_source_manifest function in the airbyte/_executors/util.py file. The function's signature has been updated to include an optional version parameter for enhanced flexibility in manifest URL construction. A new constant, DEFAULT_MANIFEST_URL, has been introduced for formatting the URL. The logic for constructing the manifest URL has been simplified, removing the previous multiple URL attempts. The function now directly raises an error if source_name is None, ensuring its necessity. Additionally, the User-Agent header in the _get_registry_cache function in airbyte/sources/registry.py has been updated.

Changes

File Path	Change Summary
airbyte/_executors/util.py	Updated `_try_get_source_manifest` function signature to include an optional `version` parameter. Introduced `VERSION_LATEST` and `DEFAULT_MANIFEST_URL` constants. Simplified URL construction logic, removing multiple URL attempts and enforcing `source_name` requirement.
airbyte/sources/registry.py	Modified User-Agent header in `_get_registry_cache` function from `"airbyte-lib-{get_version()}"` to `"PyAirbyte/{get_version()}"`.

Possibly related PRs

Feat: Improve log file handling for connector failures #333: The changes in this PR involve modifications to logging functionality and the introduction of the AIRBYTE_LOGGING_ROOT variable, which is relevant as the main PR also deals with changes in the airbyte/_executors/util.py file, specifically regarding the handling of parameters and URLs that may interact with logging mechanisms.

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

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 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.

Aaron ("AJ") Steers (aaronsteers) · 2024-09-23T16:24:28Z

/fix-pr

Auto-Fix Job Info

This job attempts to auto-fix any linting or formating issues. If any fixes are made,
those changes will be automatically committed and pushed back to the PR.
(This job requires that the PR author has "Allow edits from maintainers" enabled.)

PR auto-fix job started... Check job output.

✅ Changes applied successfully.

coderabbitai

Actionable comments posted: 1

Outside diff range and nitpick comments (2)

airbyte/_executors/util.py (2)
28-32: LGTM! Consider adding type hints for constants?

The new constants look good and their purpose is clear. Nice job on structuring the URL for versioned manifests!

Quick thought: wdyt about adding type hints to these constants? It might make the code a tad more self-documenting. Something like:
VERSION_LATEST: str = "latest"
DEFAULT_MANIFEST_URL: str = (
    "https://storage.googleapis.com/prod-airbyte-cloud-connector-metadata-service/"
    "metadata/airbyte/{source_name}/{version}/manifest.yaml"
)
35-39: Loving the new version support! How about enhancing the docstring?

The updated function signature with the optional version parameter is spot on! It aligns perfectly with the new URL structure.

Quick suggestion: wdyt about adding a bit more detail to the docstring? Maybe something like:
def _try_get_source_manifest(
    source_name: str,
    manifest_url: str | None,
    version: str | None = None,
) -> dict:
    """Try to get a source manifest from a URL.

    If the URL is not provided, we'll try the default URL in the public GCS bucket.
    If version is not provided, it defaults to 'latest'.

    Args:
        source_name: The name of the source.
        manifest_url: Optional custom URL for the manifest.
        version: Optional version string. Defaults to 'latest' if not provided.

    Returns:
        dict: The parsed manifest as a dictionary.

    Raises:
        PyAirbyteInputError: If `source_name` is `None`.
        HTTPError: If fetching the URL was unsuccessful.
        AirbyteConnectorInstallationError: If parsing the YAML fails.
    """
This gives a bit more context on the parameters and return value. What do you think?

Also applies to: 44-46

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2fae5a3 and 3333ddb.

Files selected for processing (1)

airbyte/_executors/util.py (1 hunks)

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 105b49a and 593f5c2.

Files selected for processing (2)

airbyte/_executors/util.py (1 hunks)
airbyte/sources/registry.py (1 hunks)

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

airbyte/_executors/util.py

use GCS public bucket to get manifest yaml; add support for pinning v…

3333ddb

…ersions and getting prior versions

Aaron ("AJ") Steers (aaronsteers) requested review from Ben Church (bnchrch) and Maxime Carbonneau-Leclerc (maxi297) September 23, 2024 16:21

Aaron ("AJ") Steers (aaronsteers) commented Sep 23, 2024

View reviewed changes

Comment thread airbyte/_executors/util.py

Auto-fix lint and format issues

105b49a

coderabbitai Bot requested changes Sep 23, 2024

View reviewed changes

Comment thread airbyte/_executors/util.py

Aaron ("AJ") Steers (aaronsteers) added 4 commits September 23, 2024 09:37

use Airbyte-managed path

b978d48

declare addl exception

f32b24e

improve version handling, update User-Agent string

593f5c2

update comment text

9e0d885

coderabbitai Bot requested changes Sep 23, 2024

View reviewed changes

Comment thread airbyte/sources/registry.py

coderabbitai Bot mentioned this pull request Sep 23, 2024

Replace 'airbyte-lib' references with 'PyAirbyte' throughout the codebase #395

Closed

coderabbitai Bot approved these changes Sep 23, 2024

View reviewed changes

Aaron ("AJ") Steers (aaronsteers) enabled auto-merge (squash) September 23, 2024 16:59

Aaron ("AJ") Steers (aaronsteers) merged commit 9f6f8f3 into main Sep 23, 2024

Aaron ("AJ") Steers (aaronsteers) deleted the aj/feat/improved-manifest-get branch September 23, 2024 21:13

coderabbitai Bot mentioned this pull request Aug 6, 2025

feat: add manifest_url to get_connector_info tool #742

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feat: Use GCS public bucket to get manifest yaml for connectors; adds support for pinning versions and getting prior versions#394

Feat: Use GCS public bucket to get manifest yaml for connectors; adds support for pinning versions and getting prior versions#394
Aaron ("AJ") Steers (aaronsteers) merged 6 commits into
mainfrom
aj/feat/improved-manifest-get

Aaron ("AJ") Steers (aaronsteers) commented Sep 23, 2024 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Sep 23, 2024 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Aaron ("AJ") Steers (aaronsteers) commented Sep 23, 2024 •

edited by github-actions Bot

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Aaron ("AJ") Steers (aaronsteers) commented Sep 23, 2024 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Sep 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Aaron ("AJ") Steers (aaronsteers) commented Sep 23, 2024 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Aaron ("AJ") Steers (aaronsteers) commented Sep 23, 2024 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Sep 23, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

Aaron ("AJ") Steers (aaronsteers) commented Sep 23, 2024 •

edited by github-actions Bot

Loading