Skip to content

fix(github-api): restore proxy-server support with undici dispatcher #2846

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.

Sign up for GitHub

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

Open
anishesg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(github-api): restore proxy-server support with undici dispatcher #2846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
"semver": "^7.5.3",
"type-fest": "^3.0.0",
"typescript": "^4.6.4",
"undici": "^7.28.0",
"unist-util-visit": "^2.0.3",
"unist-util-visit-parents": "^3.1.1",
"xpath": "^0.0.34",
Expand Down
26 changes: 13 additions & 13 deletions src/github-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ import {
import {logger as defaultLogger} from './util/logger';

import {graphql} from '@octokit/graphql';
import {HttpsProxyAgent} from 'https-proxy-agent';
import {HttpProxyAgent} from 'http-proxy-agent';
import {ProxyAgent} from 'undici';

export const GH_API_URL = 'https://api.github.com';
export const GH_GRAPHQL_URL = 'https://api.github.com';
Expand Down Expand Up @@ -167,30 +166,32 @@ export class GitHubApi {
this.logger = options.logger ?? defaultLogger;
}

static createDefaultAgent(baseUrl: string, defaultProxy?: ProxyOption) {
static createProxyFetch(defaultProxy?: ProxyOption) {
if (!defaultProxy) {
return undefined;
}

const {host, port} = defaultProxy;
if (new URL(baseUrl).protocol.replace(':', '') === 'http') {
return new HttpProxyAgent(`http://${host}:${port}`);
} else {
return new HttpsProxyAgent(`https://${host}:${port}`);
}
const dispatcher = new ProxyAgent(`http://${host}:${port}`);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
return (url: string, opts?: any) => {
return fetch(url, {...opts, dispatcher});
};
}

static async create(options: GitHubCreateOptions): Promise<GitHubApi> {
const apiUrl = options.apiUrl ?? GH_API_URL;
const graphqlUrl = options.graphqlUrl ?? GH_GRAPHQL_URL;
const releasePleaseVersion = require('../../package.json').version;
const proxyFetch = this.createProxyFetch(options.proxy);
const fetchToUse = options.fetch ?? proxyFetch;
const apis = options.octokitAPIs ?? {
octokit: new Octokit({
baseUrl: apiUrl,
auth: options.token,
request: {
agent: this.createDefaultAgent(apiUrl, options.proxy),
fetch: options.fetch,
fetch: fetchToUse,
},
}),
request: request.defaults({
Expand All @@ -199,13 +200,12 @@ export class GitHubApi {
'user-agent': `release-please/${releasePleaseVersion}`,
Authorization: `token ${options.token}`,
},
fetch: options.fetch,
fetch: fetchToUse,
}),
graphql: graphql.defaults({
baseUrl: graphqlUrl,
request: {
agent: this.createDefaultAgent(graphqlUrl, options.proxy),
fetch: options.fetch,
fetch: fetchToUse,
},
headers: {
'user-agent': `release-please/${releasePleaseVersion}`,
Expand Down
39 changes: 9 additions & 30 deletions test/github.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import * as sinon from 'sinon';
import * as codeSuggester from '../src/util/code-suggester';

import {GitHub, GitHubRelease} from '../src/github';
import {GitHubApi, GH_API_URL} from '../src/github-api';
import {GitHubApi} from '../src/github-api';
import {PullRequest} from '../src/pull-request';
import {TagName} from '../src/util/tag-name';
import {Version} from '../src/version';
Expand All @@ -38,8 +38,6 @@ import {fail} from 'assert';
import {PullRequestBody} from '../src/util/pull-request-body';
import {PullRequestTitle} from '../src/util/pull-request-title';
import {ReleasePleaseManifest} from '../src/updaters/release-please-manifest';
import {HttpsProxyAgent} from 'https-proxy-agent';
import {HttpProxyAgent} from 'http-proxy-agent';
import {Commit} from '../src/commit';
import {mockReleaseData, MockPullRequestOverflowHandler} from './helpers';
const fetch = require('node-fetch');
Expand Down Expand Up @@ -101,35 +99,16 @@ describe('GitHub', () => {
expect(github.repository.defaultBranch).to.eql('some-branch-from-api');
});

it('default agent is undefined when no proxy option passed ', () => {
expect(GitHubApi.createDefaultAgent('test_url')).eq(undefined);
it('proxy fetch is undefined when no proxy option passed', () => {
expect(GitHubApi.createProxyFetch()).eq(undefined);
});

it('should return a https agent', () => {
expect(
GitHubApi.createDefaultAgent(GH_API_URL, {
host: 'http://proxy.com',
port: 3000,
})
).instanceof(HttpsProxyAgent);
});

it('should throw error when baseUrl is an invalid url', () => {
expect(() => {
GitHubApi.createDefaultAgent('invalid_url', {
host: 'http://proxy.com',
port: 3000,
});
}).to.throw('Invalid URL');
});

it('should return a http agent', () => {
expect(
GitHubApi.createDefaultAgent('http://www.github.com', {
host: 'http://proxy.com',
port: 3000,
})
).instanceof(HttpProxyAgent);
it('should return a proxy fetch function', () => {
const proxyFetch = GitHubApi.createProxyFetch({
host: 'proxy.com',
port: 3000,
});
expect(proxyFetch).to.be.a('function');
});
});

Expand Down
Loading