Skip to content

url-helper.ts now leverages well-known environment variables. #1941

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

Merged
jww3 merged 11 commits into from
Oct 18, 2024
+141 −23
Merged

url-helper.ts now leverages well-known environment variables. #1941

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e8e8219
`utl-helper.ts` now leverages well-known environment variables.
jww3 Oct 11, 2024
df4b58c
second attempt
jww3 Oct 16, 2024
2f42443
restore passing `baseUrl` where appropriate
jww3 Oct 16, 2024
7fcbcdc
ran `npm run format`
jww3 Oct 16, 2024
19060a1
ran `npm run build`
jww3 Oct 16, 2024
813c3f2
Apply suggestions from @easyt
jww3 Oct 17, 2024
041723a
updated unit tests
jww3 Oct 17, 2024
914445f
Responded to PR feedback.
jww3 Oct 17, 2024
7695871
ran `npm run build`
jww3 Oct 17, 2024
7fd13ec
Address `hasContent` readability
jww3 Oct 17, 2024
55f79d9
Use concise `WhitespaceMode` names
jww3 Oct 17, 2024
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
23 changes: 23 additions & 0 deletions __test__/url-helper.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as urlHelper from '../src/url-helper'

describe('isGhes tests', () => {
it('basics', async () => {
expect(urlHelper.isGhes()).toBeFalsy()
expect(urlHelper.isGhes('https://github.com')).toBeFalsy()
//expect(urlHelper.isGhes('https://api.github.com')).toBeFalsy()
expect(urlHelper.isGhes('https://europe.ghe.com')).toBeFalsy()
expect(urlHelper.isGhes('https://test.github.localhost')).toBeFalsy()
expect(urlHelper.isGhes('https://src.onpremise.customer.com')).toBeTruthy()
})
})

describe('getServerApiUrl tests', () => {
it('basics', async () => {
expect(urlHelper.getServerApiUrl()).toBe('https://api.github.com')
expect(urlHelper.getServerApiUrl('https://github.com')).toBe('https://api.github.com')
expect(urlHelper.getServerApiUrl('https://GitHub.com')).toBe('https://api.github.com')
expect(urlHelper.getServerApiUrl('https://europe.ghe.com')).toBe('https://api.europe.ghe.com')
expect(urlHelper.getServerApiUrl('https://australia.GHE.COM')).toBe('https://api.australia.ghe.com')
expect(urlHelper.getServerApiUrl('https://src.onpremise.customer.com')).toBe('https://src.onpremise.customer.com/api/v3')
})
})
45 changes: 34 additions & 11 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2454,22 +2454,45 @@ function getFetchUrl(settings) {
return `${serviceUrl.origin}/${encodedOwner}/${encodedName}`;
}
function getServerUrl(url) {
let urlValue = url && url.trim().length > 0
? url
: process.env['GITHUB_SERVER_URL'] || 'https://github.com';
return new url_1.URL(urlValue);
let resolvedUrl = process.env['GITHUB_SERVER_URL'] || 'https://github.com';
if (hasContent(url, false)) {
resolvedUrl = url;
}
return new url_1.URL(resolvedUrl);
}
function getServerApiUrl(url) {
let apiUrl = 'https://api.github.com';
if (isGhes(url)) {
const serverUrl = getServerUrl(url);
apiUrl = new url_1.URL(`${serverUrl.origin}/api/v3`).toString();
if (hasContent(url, false)) {
let serverUrl = getServerUrl(url);
if (isGhes(url)) {
serverUrl.pathname = "api/v3";
}
else {
serverUrl.hostname = "api." + serverUrl.hostname;
}
return pruneSuffix(serverUrl.toString(), '/');
}
return apiUrl;
return process.env['GITHUB_API_URL'] || 'https://api.github.com';
}
function isGhes(url) {
const ghUrl = getServerUrl(url);
return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
const ghUrl = new url_1.URL(url || process.env['GITHUB_SERVER_URL'] || 'https://github.com');
const hostname = ghUrl.hostname.trimEnd().toUpperCase();
const isGitHubHost = hostname === 'GITHUB.COM';
const isGheHost = hostname.endsWith('.GHE.COM');
const isLocalHost = hostname.endsWith('.LOCALHOST');
return !isGitHubHost && !isGheHost && !isLocalHost;
}
function pruneSuffix(text, suffix) {
if (hasContent(suffix, true) && (text === null || text === void 0 ? void 0 : text.endsWith(suffix))) {
return text.substring(0, text.length - suffix.length);
}
return text;
}
function hasContent(text, allowPureWhitespace) {
let refinedText = text !== null && text !== void 0 ? text : "";
if (!allowPureWhitespace) {
refinedText = refinedText.trim();
}
return refinedText.length > 0;
}


Expand Down
53 changes: 41 additions & 12 deletions src/url-helper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,55 @@ export function getFetchUrl(settings: IGitSourceSettings): string {
}

export function getServerUrl(url?: string): URL {
let urlValue =
url && url.trim().length > 0
? url
: process.env['GITHUB_SERVER_URL'] || 'https://github.com'
return new URL(urlValue)
let resolvedUrl = process.env['GITHUB_SERVER_URL'] || 'https://github.com'
if (hasContent(url, false)) {
resolvedUrl = url!
}

return new URL(resolvedUrl)
}

export function getServerApiUrl(url?: string): string {
let apiUrl = 'https://api.github.com'
if (hasContent(url, false)) {
let serverUrl = getServerUrl(url)
if (isGhes(url)) {
serverUrl.pathname = "api/v3"
} else {
serverUrl.hostname = "api." + serverUrl.hostname
}

if (isGhes(url)) {
const serverUrl = getServerUrl(url)
apiUrl = new URL(`${serverUrl.origin}/api/v3`).toString()
return pruneSuffix(serverUrl.toString(), '/')
}

return apiUrl
return process.env['GITHUB_API_URL'] || 'https://api.github.com'
}

export function isGhes(url?: string): boolean {
const ghUrl = getServerUrl(url)
const ghUrl = new URL(
url || process.env['GITHUB_SERVER_URL'] || 'https://github.com'
)

const hostname = ghUrl.hostname.trimEnd().toUpperCase()
const isGitHubHost = hostname === 'GITHUB.COM'
const isGheHost = hostname.endsWith('.GHE.COM')
const isLocalHost = hostname.endsWith('.LOCALHOST')

return !isGitHubHost && !isGheHost && !isLocalHost
}

return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM'

function pruneSuffix(text: string, suffix: string) {
if (hasContent(suffix, true) && text?.endsWith(suffix)) {
return text.substring(0, text.length - suffix.length)
}
return text
}

function hasContent(text: string | undefined, allowPureWhitespace: boolean): boolean {
let refinedText = text ?? ""
if (!allowPureWhitespace) {
refinedText = refinedText.trim()
}
return refinedText.length > 0
}