From abb238b1313d8ef4d3e3a96d204e08329cafbf85 Mon Sep 17 00:00:00 2001
From: John Wesley Walker III <81404201+jww3@users.noreply.github.com>
Date: Mon, 21 Oct 2024 18:41:32 +0200
Subject: [PATCH 1/2] Revise `isGhes` logic (#1148)
* Revise `isGhes` logic
* ran 'npm run format'
* added unit test
---
__tests__/cache-utils.test.ts | 40 ++++++++++++++++++++++++++++++++++-
dist/cache-save/index.js | 6 +++++-
dist/setup/index.js | 6 +++++-
src/cache-utils.ts | 8 ++++++-
4 files changed, 56 insertions(+), 4 deletions(-)
diff --git a/__tests__/cache-utils.test.ts b/__tests__/cache-utils.test.ts
index a8c881e5..f14848de 100644
--- a/__tests__/cache-utils.test.ts
+++ b/__tests__/cache-utils.test.ts
@@ -6,7 +6,7 @@ import {
PackageManagerInfo,
isCacheFeatureAvailable,
supportedPackageManagers,
- getCommandOutput,
+ isGhes,
resetProjectDirectoriesMemoized
} from '../src/cache-utils';
import fs from 'fs';
@@ -361,3 +361,41 @@ describe('cache-utils', () => {
);
});
});
+
+describe('isGhes', () => {
+ const pristineEnv = process.env;
+
+ beforeEach(() => {
+ jest.resetModules();
+ process.env = {...pristineEnv};
+ });
+
+ afterAll(() => {
+ process.env = pristineEnv;
+ });
+
+ it('returns false when the GITHUB_SERVER_URL environment variable is not defined', () => {
+ delete process.env['GITHUB_SERVER_URL'];
+ expect(isGhes()).toBeFalsy();
+ });
+
+ it('returns false when the GITHUB_SERVER_URL environment variable is set to github.com', () => {
+ process.env['GITHUB_SERVER_URL'] = 'https://github.com';
+ expect(isGhes()).toBeFalsy();
+ });
+
+ it('returns false when the GITHUB_SERVER_URL environment variable is set to a GitHub Enterprise Cloud-style URL', () => {
+ process.env['GITHUB_SERVER_URL'] = 'https://contoso.ghe.com';
+ expect(isGhes()).toBeFalsy();
+ });
+
+ it('returns false when the GITHUB_SERVER_URL environment variable has a .localhost suffix', () => {
+ process.env['GITHUB_SERVER_URL'] = 'https://mock-github.localhost';
+ expect(isGhes()).toBeFalsy();
+ });
+
+ it('returns true when the GITHUB_SERVER_URL environment variable is set to some other URL', () => {
+ process.env['GITHUB_SERVER_URL'] = 'https://src.onpremise.fabrikam.com';
+ expect(isGhes()).toBeTruthy();
+ });
+});
diff --git a/dist/cache-save/index.js b/dist/cache-save/index.js
index 8918271a..b3a950ff 100644
--- a/dist/cache-save/index.js
+++ b/dist/cache-save/index.js
@@ -83977,7 +83977,11 @@ const repoHasYarnBerryManagedDependencies = (packageManagerInfo, cacheDependency
exports.repoHasYarnBerryManagedDependencies = repoHasYarnBerryManagedDependencies;
function isGhes() {
const ghUrl = new URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
- return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
+ const hostname = ghUrl.hostname.trimEnd().toUpperCase();
+ const isGitHubHost = hostname === 'GITHUB.COM';
+ const isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM');
+ const isLocalHost = hostname.endsWith('.LOCALHOST');
+ return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
}
exports.isGhes = isGhes;
function isCacheFeatureAvailable() {
diff --git a/dist/setup/index.js b/dist/setup/index.js
index e1b7296f..832d1db3 100644
--- a/dist/setup/index.js
+++ b/dist/setup/index.js
@@ -93598,7 +93598,11 @@ const repoHasYarnBerryManagedDependencies = (packageManagerInfo, cacheDependency
exports.repoHasYarnBerryManagedDependencies = repoHasYarnBerryManagedDependencies;
function isGhes() {
const ghUrl = new URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
- return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
+ const hostname = ghUrl.hostname.trimEnd().toUpperCase();
+ const isGitHubHost = hostname === 'GITHUB.COM';
+ const isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM');
+ const isLocalHost = hostname.endsWith('.LOCALHOST');
+ return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
}
exports.isGhes = isGhes;
function isCacheFeatureAvailable() {
diff --git a/src/cache-utils.ts b/src/cache-utils.ts
index 7066d733..89841bc1 100644
--- a/src/cache-utils.ts
+++ b/src/cache-utils.ts
@@ -295,7 +295,13 @@ export function isGhes(): boolean {
const ghUrl = new URL(
process.env['GITHUB_SERVER_URL'] || 'https://github.com'
);
- return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
+
+ const hostname = ghUrl.hostname.trimEnd().toUpperCase();
+ const isGitHubHost = hostname === 'GITHUB.COM';
+ const isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM');
+ const isLocalHost = hostname.endsWith('.LOCALHOST');
+
+ return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;
}
export function isCacheFeatureAvailable(): boolean {
From 39370e3970a6d050c480ffad4ff0ed4d3fdee5af Mon Sep 17 00:00:00 2001
From: Peng Xiao <pengxiao@outlook.com>
Date: Thu, 24 Oct 2024 11:31:49 +0800
Subject: [PATCH 2/2] fix: add arch to cached path (#843)
* fix: add arch to cached path
* fix: change from using env to os module
* fix: use process.env.RUNNER_OS instead of os.platform()
* fix: remove unused var
---
__tests__/cache-restore.test.ts | 9 ++++++++-
dist/setup/index.js | 4 +++-
src/cache-restore.ts | 4 +++-
3 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/__tests__/cache-restore.test.ts b/__tests__/cache-restore.test.ts
index 90153a40..0bbf2812 100644
--- a/__tests__/cache-restore.test.ts
+++ b/__tests__/cache-restore.test.ts
@@ -2,6 +2,7 @@ import * as core from '@actions/core';
import * as cache from '@actions/cache';
import * as path from 'path';
import * as glob from '@actions/glob';
+import osm from 'os';
import * as utils from '../src/cache-utils';
import {restoreCache} from '../src/cache-restore';
@@ -12,6 +13,7 @@ describe('cache-restore', () => {
process.env.RUNNER_OS = 'Linux';
}
const platform = process.env.RUNNER_OS;
+ const arch = 'arm64';
const commonPath = '/some/random/path';
const npmCachePath = `${commonPath}/npm`;
const pnpmCachePath = `${commonPath}/pnpm`;
@@ -52,6 +54,7 @@ describe('cache-restore', () => {
let getCommandOutputSpy: jest.SpyInstance;
let restoreCacheSpy: jest.SpyInstance;
let hashFilesSpy: jest.SpyInstance;
+ let archSpy: jest.SpyInstance;
beforeEach(() => {
// core
@@ -102,6 +105,10 @@ describe('cache-restore', () => {
// cache-utils
getCommandOutputSpy = jest.spyOn(utils, 'getCommandOutput');
+
+ // os
+ archSpy = jest.spyOn(osm, 'arch');
+ archSpy.mockImplementation(() => arch);
});
describe('Validate provided package manager', () => {
@@ -135,7 +142,7 @@ describe('cache-restore', () => {
await restoreCache(packageManager, '');
expect(hashFilesSpy).toHaveBeenCalled();
expect(infoSpy).toHaveBeenCalledWith(
- `Cache restored from key: node-cache-${platform}-${packageManager}-${fileHash}`
+ `Cache restored from key: node-cache-${platform}-${arch}-${packageManager}-${fileHash}`
);
expect(infoSpy).not.toHaveBeenCalledWith(
`${packageManager} cache is not found`
diff --git a/dist/setup/index.js b/dist/setup/index.js
index 832d1db3..5d7eb1e5 100644
--- a/dist/setup/index.js
+++ b/dist/setup/index.js
@@ -93303,6 +93303,7 @@ const core = __importStar(__nccwpck_require__(2186));
const glob = __importStar(__nccwpck_require__(8090));
const path_1 = __importDefault(__nccwpck_require__(1017));
const fs_1 = __importDefault(__nccwpck_require__(7147));
+const os_1 = __importDefault(__nccwpck_require__(2037));
const constants_1 = __nccwpck_require__(9042);
const cache_utils_1 = __nccwpck_require__(1678);
const restoreCache = (packageManager, cacheDependencyPath) => __awaiter(void 0, void 0, void 0, function* () {
@@ -93311,6 +93312,7 @@ const restoreCache = (packageManager, cacheDependencyPath) => __awaiter(void 0,
throw new Error(`Caching for '${packageManager}' is not supported`);
}
const platform = process.env.RUNNER_OS;
+ const arch = os_1.default.arch();
const cachePaths = yield (0, cache_utils_1.getCacheDirectories)(packageManagerInfo, cacheDependencyPath);
core.saveState(constants_1.State.CachePaths, cachePaths);
const lockFilePath = cacheDependencyPath
@@ -93320,7 +93322,7 @@ const restoreCache = (packageManager, cacheDependencyPath) => __awaiter(void 0,
if (!fileHash) {
throw new Error('Some specified paths were not resolved, unable to cache dependencies.');
}
- const keyPrefix = `node-cache-${platform}-${packageManager}`;
+ const keyPrefix = `node-cache-${platform}-${arch}-${packageManager}`;
const primaryKey = `${keyPrefix}-${fileHash}`;
core.debug(`primary key is ${primaryKey}`);
core.saveState(constants_1.State.CachePrimaryKey, primaryKey);
diff --git a/src/cache-restore.ts b/src/cache-restore.ts
index 3b230970..af12ad83 100644
--- a/src/cache-restore.ts
+++ b/src/cache-restore.ts
@@ -3,6 +3,7 @@ import * as core from '@actions/core';
import * as glob from '@actions/glob';
import path from 'path';
import fs from 'fs';
+import os from 'os';
import {State} from './constants';
import {
@@ -21,6 +22,7 @@ export const restoreCache = async (
throw new Error(`Caching for '${packageManager}' is not supported`);
}
const platform = process.env.RUNNER_OS;
+ const arch = os.arch();
const cachePaths = await getCacheDirectories(
packageManagerInfo,
@@ -38,7 +40,7 @@ export const restoreCache = async (
);
}
- const keyPrefix = `node-cache-${platform}-${packageManager}`;
+ const keyPrefix = `node-cache-${platform}-${arch}-${packageManager}`;
const primaryKey = `${keyPrefix}-${fileHash}`;
core.debug(`primary key is ${primaryKey}`);