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

set base URL for GHES #449

Merged
merged 1 commit into from
May 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/github/RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @actions/github Releases

### 2.2.0

- [Support GHES: Use GITHUB_API_URL and GITHUB_GRAPHQL_URL to determine baseUrl](https://github.com/actions/toolkit/pull/449)

### 2.1.1

- [Use import {Octokit}](https://github.com/actions/toolkit/pull/332)
Expand Down
2 changes: 1 addition & 1 deletion packages/github/package-lock.json

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

2 changes: 1 addition & 1 deletion packages/github/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@actions/github",
"version": "2.1.1",
"version": "2.2.0",
"description": "Actions github lib",
"keywords": [
"github",
Expand Down
34 changes: 29 additions & 5 deletions packages/github/src/github.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,17 @@ export class GitHub extends Octokit {
const token = args[0]
const options = {...args[1]} // Shallow clone - don't mutate the object provided by the caller

// Base URL - GHES or Dotcom
Copy link
Contributor Author

@ericsciple ericsciple May 6, 2020

Choose a reason for hiding this comment

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

I'll look before merging whether any unit test can be added. Might be able to verify the expected baseUrl is set and whether proxy is set based on the correct URL

Copy link
Contributor Author

Choose a reason for hiding this comment

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

unfortunately doesnt appear to be a way to get the options after it's constructed

options.baseUrl = options.baseUrl || this.getApiBaseUrl()

// Auth
const auth = GitHub.getAuthString(token, options)
if (auth) {
options.auth = auth
}

// Proxy
const agent = GitHub.getProxyAgent(options)
const agent = GitHub.getProxyAgent(options.baseUrl, options)
if (agent) {
// Shallow clone - don't mutate the object provided by the caller
options.request = options.request ? {...options.request} : {}
Expand All @@ -82,6 +85,7 @@ export class GitHub extends Octokit {

private static getGraphQL(args: [string, Octokit.Options]): GraphQL {
const defaults: GraphQLRequestParameters = {}
defaults.baseUrl = this.getGraphQLBaseUrl()
const token = args[0]
const options = args[1]

Expand All @@ -94,7 +98,7 @@ export class GitHub extends Octokit {
}

// Proxy
const agent = GitHub.getProxyAgent(options)
const agent = GitHub.getProxyAgent(defaults.baseUrl, options)
if (agent) {
defaults.request = {agent}
}
Expand All @@ -119,16 +123,36 @@ export class GitHub extends Octokit {
}

private static getProxyAgent(
destinationUrl: string,
options: Octokit.Options
): http.Agent | undefined {
if (!options.request?.agent) {
const serverUrl = 'https://api.github.com'
if (httpClient.getProxyUrl(serverUrl)) {
if (httpClient.getProxyUrl(destinationUrl)) {
const hc = new httpClient.HttpClient()
return hc.getAgent(serverUrl)
return hc.getAgent(destinationUrl)
}
}

return undefined
}

private static getApiBaseUrl(): string {
return process.env['GITHUB_API_URL'] || 'https://api.github.com'
}

private static getGraphQLBaseUrl(): string {
let url =
process.env['GITHUB_GRAPHQL_URL'] || 'https://api.github.com/graphql'

// Shouldn't be a trailing slash, but remove if so
if (url.endsWith('/')) {
url = url.substr(0, url.length - 1)
}

// Remove trailing "/graphql"
if (url.toUpperCase().endsWith('/GRAPHQL')) {
Copy link
Member

Choose a reason for hiding this comment

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

There's no possibility of a trailing slash is there? Alternative https://stackoverflow.com/a/16750711/775184

Copy link
Contributor Author

Choose a reason for hiding this comment

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

shouldnt be a trailing slash, i'll trim on launch side when setting the urls

Copy link
Contributor Author

Choose a reason for hiding this comment

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

also not bad to add resiliency here, i added code to trim trailing slash if detected

url = url.substr(0, url.length - '/graphql'.length)
}
return url
}
}