Prepare 4.2.2 Release (#1953)

* Prepare 4.2.2 Release

---------

Co-authored-by: Josh Gross <joshmgross@github.com>

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v4.2.2
+* `url-helper.ts` now leverages well-known environment variables by @jww3 in https://github.com/actions/checkout/pull/1941
+* Expand unit test coverage for `isGhes` by @jww3 in https://github.com/actions/checkout/pull/1946
+
 ## v4.2.1
 * Check out other refs/* by commit if provided, fall back to ref by @orhantoy in https://github.com/actions/checkout/pull/1924
 

__test__/url-helper.test.ts

@@ -1,13 +1,72 @@
 import * as urlHelper from '../src/url-helper'
 
-describe('isGhes tests', () => {
+describe('getServerUrl tests', () => {
   it('basics', async () => {
+    // Note that URL::toString will append a trailing / when passed just a domain name ...
+    expect(urlHelper.getServerUrl().toString()).toBe('https://github.com/')
+    expect(urlHelper.getServerUrl(' ').toString()).toBe('https://github.com/')
+    expect(urlHelper.getServerUrl('   ').toString()).toBe('https://github.com/')
+    expect(urlHelper.getServerUrl('http://contoso.com').toString()).toBe(
+      'http://contoso.com/'
+    )
+    expect(urlHelper.getServerUrl('https://contoso.com').toString()).toBe(
+      'https://contoso.com/'
+    )
+    expect(urlHelper.getServerUrl('https://contoso.com/').toString()).toBe(
+      'https://contoso.com/'
+    )
+
+    // ... but can't make that same assumption when passed an URL that includes some deeper path.
+    expect(urlHelper.getServerUrl('https://contoso.com/a/b').toString()).toBe(
+      'https://contoso.com/a/b'
+    )
+  })
+})
+
+describe('isGhes tests', () => {
+  const pristineEnv = process.env
+
+  beforeEach(() => {
+    jest.resetModules()
+    process.env = {...pristineEnv}
+  })
+
+  afterAll(() => {
+    process.env = pristineEnv
+  })
+
+  it('basics', async () => {
+    delete process.env['GITHUB_SERVER_URL']
     expect(urlHelper.isGhes()).toBeFalsy()
     expect(urlHelper.isGhes('https://github.com')).toBeFalsy()
-    //expect(urlHelper.isGhes('https://api.github.com')).toBeFalsy()
+    expect(urlHelper.isGhes('https://contoso.ghe.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()
+    expect(urlHelper.isGhes('https://src.onpremise.fabrikam.com')).toBeTruthy()
+  })
+
+  it('returns false when the GITHUB_SERVER_URL environment variable is not defined', async () => {
+    delete process.env['GITHUB_SERVER_URL']
+    expect(urlHelper.isGhes()).toBeFalsy()
+  })
+
+  it('returns false when the GITHUB_SERVER_URL environment variable is set to github.com', async () => {
+    process.env['GITHUB_SERVER_URL'] = 'https://github.com'
+    expect(urlHelper.isGhes()).toBeFalsy()
+  })
+
+  it('returns false when the GITHUB_SERVER_URL environment variable is set to a GitHub Enterprise Cloud-style URL', async () => {
+    process.env['GITHUB_SERVER_URL'] = 'https://contoso.ghe.com'
+    expect(urlHelper.isGhes()).toBeFalsy()
+  })
+
+  it('returns false when the GITHUB_SERVER_URL environment variable has a .localhost suffix', async () => {
+    process.env['GITHUB_SERVER_URL'] = 'https://mock-github.localhost'
+    expect(urlHelper.isGhes()).toBeFalsy()
+  })
+
+  it('returns true when the GITHUB_SERVER_URL environment variable is set to some other URL', async () => {
+    process.env['GITHUB_SERVER_URL'] = 'https://src.onpremise.fabrikam.com'
+    expect(urlHelper.isGhes()).toBeTruthy()
   })
 })
 
@@ -20,14 +79,14 @@ describe('getServerApiUrl tests', () => {
     expect(urlHelper.getServerApiUrl('https://GitHub.com')).toBe(
       'https://api.github.com'
     )
-    expect(urlHelper.getServerApiUrl('https://europe.ghe.com')).toBe(
+    expect(urlHelper.getServerApiUrl('https://contoso.ghe.com')).toBe(
-      'https://api.europe.ghe.com'
+      'https://api.contoso.ghe.com'
     )
-    expect(urlHelper.getServerApiUrl('https://australia.GHE.COM')).toBe(
+    expect(urlHelper.getServerApiUrl('https://fabrikam.GHE.COM')).toBe(
-      'https://api.australia.ghe.com'
+      'https://api.fabrikam.ghe.com'
     )
     expect(
-      urlHelper.getServerApiUrl('https://src.onpremise.customer.com')
+      urlHelper.getServerApiUrl('https://src.onpremise.fabrikam.com')
-    ).toBe('https://src.onpremise.customer.com/api/v3')
+    ).toBe('https://src.onpremise.fabrikam.com/api/v3')
   })
 })

dist/index.js

@@ -2455,13 +2455,13 @@ function getFetchUrl(settings) {
 }
 function getServerUrl(url) {
     let resolvedUrl = process.env['GITHUB_SERVER_URL'] || 'https://github.com';
-    if (hasContent(url, false)) {
+    if (hasContent(url, WhitespaceMode.Trim)) {
         resolvedUrl = url;
     }
     return new url_1.URL(resolvedUrl);
 }
 function getServerApiUrl(url) {
-    if (hasContent(url, false)) {
+    if (hasContent(url, WhitespaceMode.Trim)) {
         let serverUrl = getServerUrl(url);
         if (isGhes(url)) {
             serverUrl.pathname = 'api/v3';
@@ -2477,19 +2477,24 @@ function isGhes(url) {
     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 isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM');
     const isLocalHost = hostname.endsWith('.LOCALHOST');
-    return !isGitHubHost && !isGheHost && !isLocalHost;
+    return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
 }
 function pruneSuffix(text, suffix) {
-    if (hasContent(suffix, true) && (text === null || text === void 0 ? void 0 : text.endsWith(suffix))) {
+    if (hasContent(suffix, WhitespaceMode.Preserve) && (text === null || text === void 0 ? void 0 : text.endsWith(suffix))) {
         return text.substring(0, text.length - suffix.length);
     }
     return text;
 }
-function hasContent(text, allowPureWhitespace) {
+var WhitespaceMode;
+(function (WhitespaceMode) {
+    WhitespaceMode[WhitespaceMode["Trim"] = 0] = "Trim";
+    WhitespaceMode[WhitespaceMode["Preserve"] = 1] = "Preserve";
+})(WhitespaceMode || (WhitespaceMode = {}));
+function hasContent(text, whitespaceMode) {
     let refinedText = text !== null && text !== void 0 ? text : '';
-    if (!allowPureWhitespace) {
+    if (whitespaceMode == WhitespaceMode.Trim) {
         refinedText = refinedText.trim();
     }
     return refinedText.length > 0;

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "checkout",
-  "version": "4.2.1",
+  "version": "4.2.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "checkout",
-      "version": "4.2.1",
+      "version": "4.2.2",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.10.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "checkout",
-  "version": "4.2.1",
+  "version": "4.2.2",
   "description": "checkout action",
   "main": "lib/main.js",
   "scripts": {

src/url-helper.ts

@@ -22,7 +22,7 @@ export function getFetchUrl(settings: IGitSourceSettings): string {
 
 export function getServerUrl(url?: string): URL {
   let resolvedUrl = process.env['GITHUB_SERVER_URL'] || 'https://github.com'
-  if (hasContent(url, false)) {
+  if (hasContent(url, WhitespaceMode.Trim)) {
     resolvedUrl = url!
   }
 
@@ -30,7 +30,7 @@ export function getServerUrl(url?: string): URL {
 }
 
 export function getServerApiUrl(url?: string): string {
-  if (hasContent(url, false)) {
+  if (hasContent(url, WhitespaceMode.Trim)) {
     let serverUrl = getServerUrl(url)
     if (isGhes(url)) {
       serverUrl.pathname = 'api/v3'
@@ -51,25 +51,30 @@ export function isGhes(url?: string): boolean {
 
   const hostname = ghUrl.hostname.trimEnd().toUpperCase()
   const isGitHubHost = hostname === 'GITHUB.COM'
-  const isGheHost = hostname.endsWith('.GHE.COM')
+  const isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM')
   const isLocalHost = hostname.endsWith('.LOCALHOST')
 
-  return !isGitHubHost && !isGheHost && !isLocalHost
+  return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost
 }
 
 function pruneSuffix(text: string, suffix: string) {
-  if (hasContent(suffix, true) && text?.endsWith(suffix)) {
+  if (hasContent(suffix, WhitespaceMode.Preserve) && text?.endsWith(suffix)) {
     return text.substring(0, text.length - suffix.length)
   }
   return text
 }
 
+enum WhitespaceMode {
+  Trim,
+  Preserve
+}
+
 function hasContent(
   text: string | undefined,
-  allowPureWhitespace: boolean
+  whitespaceMode: WhitespaceMode
 ): boolean {
   let refinedText = text ?? ''
-  if (!allowPureWhitespace) {
+  if (whitespaceMode == WhitespaceMode.Trim) {
     refinedText = refinedText.trim()
   }
   return refinedText.length > 0