Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: github authenticated registry #506

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

mkykadir
Copy link

@mkykadir mkykadir commented Jan 20, 2025

Description

Utilize authToken in GithubRegistry for authenticated Github requests

Backward compatibility

Yes

works as usual when no auth token is configured

Testing

New unit tests Authenticated GithubRegistry

  • Tests authenticated API rate limit and fallbacks to proxy
  • Test wrong token configuration, i.e. unauthorized access

Copy link

changeset-bot bot commented Jan 20, 2025

🦋 Changeset detected

Latest commit: 45ac23d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@hyperlane-xyz/registry Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@@ -72,6 +73,7 @@ export class GithubRegistry extends BaseRegistry implements IRegistry {
this.repoOwner = pathSegments.at(-2)!;
this.repoName = pathSegments.at(-1)!;
this.proxyUrl = options.proxyUrl;
this.authToken = options.authToken;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we assert that proxyUrl and authToken can't be set at the same time?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually proxyUrl can still be set, when authentication limit is reached it will fallback to proxyUrl again as the test here testing it

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh love it

@@ -189,10 +191,14 @@ export class GithubRegistry extends BaseRegistry implements IRegistry {
}

public async getApiRateLimit(): Promise<GithubRateResponse['resources']['core']> {
const baseHeader = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add a private class property like

private readonly baseApiHeaders: Record<string, string> = {
    'X-GitHub-Api-Version': GITHUB_API_VERSION,
  };

and reuse here and in the fetch method below

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor

@paulbalaji paulbalaji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm % mo's comment

@@ -189,10 +191,14 @@ export class GithubRegistry extends BaseRegistry implements IRegistry {
}

public async getApiRateLimit(): Promise<GithubRateResponse['resources']['core']> {
const baseHeader = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants