Skip to content

Commit bacd6b4

Browse files
dmitry-shibanovdmitry-shibanov
authoredMar 31, 2022
Caching on GHES (#452)
* add support for ghes caching * fix licesnses * work on resolving comments * change internal error to warning * fix warning for internal errors * update version
·
v4.3.0v3
1 parent bed538b commit bacd6b4

File tree

9 files changed

+192
-67
lines changed

9 files changed

+192
-67
lines changed
 

‎.licenses/npm/@actions/cache.dep.yml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎__tests__/cache-utils.test.ts

+35-19
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,28 @@
11
import * as core from '@actions/core';
2+
import * as cache from '@actions/cache';
23
import path from 'path';
34
import * as utils from '../src/cache-utils';
4-
import {PackageManagerInfo} from '../src/cache-utils';
5+
import {PackageManagerInfo, isCacheFeatureAvailable} from '../src/cache-utils';
56

67
describe('cache-utils', () => {
7-
const commonPath = '/some/random/path';
88
const versionYarn1 = '1.2.3';
9-
const versionYarn2 = '2.3.4';
109

1110
let debugSpy: jest.SpyInstance;
1211
let getCommandOutputSpy: jest.SpyInstance;
13-
14-
function getPackagePath(name: string) {
15-
if (name === utils.supportedPackageManagers.npm.getCacheFolderCommand) {
16-
return `${commonPath}/npm`;
17-
} else if (
18-
name === utils.supportedPackageManagers.pnpm.getCacheFolderCommand
19-
) {
20-
return `${commonPath}/pnpm`;
21-
} else {
22-
if (name === utils.supportedPackageManagers.yarn1.getCacheFolderCommand) {
23-
return `${commonPath}/yarn1`;
24-
} else {
25-
return `${commonPath}/yarn2`;
26-
}
27-
}
28-
}
12+
let isFeatureAvailable: jest.SpyInstance;
13+
let info: jest.SpyInstance;
14+
let warningSpy: jest.SpyInstance;
2915

3016
beforeEach(() => {
3117
process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data');
3218
debugSpy = jest.spyOn(core, 'debug');
3319
debugSpy.mockImplementation(msg => {});
3420

21+
info = jest.spyOn(core, 'info');
22+
warningSpy = jest.spyOn(core, 'warning');
23+
24+
isFeatureAvailable = jest.spyOn(cache, 'isFeatureAvailable');
25+
3526
getCommandOutputSpy = jest.spyOn(utils, 'getCommandOutput');
3627
});
3728

@@ -51,7 +42,32 @@ describe('cache-utils', () => {
5142
});
5243
});
5344

45+
it('isCacheFeatureAvailable for GHES is false', () => {
46+
isFeatureAvailable.mockImplementation(() => false);
47+
process.env['GITHUB_SERVER_URL'] = 'https://www.test.com';
48+
49+
expect(() => isCacheFeatureAvailable()).toThrowError(
50+
'Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.'
51+
);
52+
});
53+
54+
it('isCacheFeatureAvailable for GHES has an interhal error', () => {
55+
isFeatureAvailable.mockImplementation(() => false);
56+
process.env['GITHUB_SERVER_URL'] = '';
57+
isCacheFeatureAvailable();
58+
expect(warningSpy).toHaveBeenCalledWith(
59+
'The runner was not able to contact the cache service. Caching will be skipped'
60+
);
61+
});
62+
63+
it('isCacheFeatureAvailable for GHES is available', () => {
64+
isFeatureAvailable.mockImplementation(() => true);
65+
66+
expect(isCacheFeatureAvailable()).toStrictEqual(true);
67+
});
68+
5469
afterEach(() => {
70+
process.env['GITHUB_SERVER_URL'] = '';
5571
jest.resetAllMocks();
5672
jest.clearAllMocks();
5773
});

‎__tests__/installer.test.ts

+48
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import * as core from '@actions/core';
22
import * as io from '@actions/io';
33
import * as tc from '@actions/tool-cache';
44
import * as im from '../src/installer';
5+
import * as cache from '@actions/cache';
56
import fs from 'fs';
67
import cp from 'child_process';
78
import osm = require('os');
@@ -36,6 +37,7 @@ describe('setup-node', () => {
3637
let execSpy: jest.SpyInstance;
3738
let authSpy: jest.SpyInstance;
3839
let parseNodeVersionSpy: jest.SpyInstance;
40+
let isCacheActionAvailable: jest.SpyInstance;
3941

4042
beforeEach(() => {
4143
// @actions/core
@@ -67,6 +69,9 @@ describe('setup-node', () => {
6769
existsSpy = jest.spyOn(fs, 'existsSync');
6870
mkdirpSpy = jest.spyOn(io, 'mkdirP');
6971

72+
// @actions/tool-cache
73+
isCacheActionAvailable = jest.spyOn(cache, 'isFeatureAvailable');
74+
7075
// disable authentication portion for installer tests
7176
authSpy = jest.spyOn(auth, 'configAuthentication');
7277
authSpy.mockImplementation(() => {});
@@ -644,6 +649,49 @@ describe('setup-node', () => {
644649
);
645650
});
646651
});
652+
653+
describe('cache on GHES', () => {
654+
it('Should throw an error, because cache is not supported', async () => {
655+
inputs['node-version'] = '12';
656+
inputs['cache'] = 'npm';
657+
658+
inSpy.mockImplementation(name => inputs[name]);
659+
660+
let toolPath = path.normalize('/cache/node/12.16.1/x64');
661+
findSpy.mockImplementation(() => toolPath);
662+
663+
// expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
664+
process.env['GITHUB_SERVER_URL'] = 'https://www.test.com';
665+
isCacheActionAvailable.mockImplementation(() => false);
666+
667+
await main.run();
668+
669+
expect(cnSpy).toHaveBeenCalledWith(
670+
`::error::Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.${osm.EOL}`
671+
);
672+
});
673+
674+
it('Should throw an internal error', async () => {
675+
inputs['node-version'] = '12';
676+
inputs['cache'] = 'npm';
677+
678+
inSpy.mockImplementation(name => inputs[name]);
679+
680+
let toolPath = path.normalize('/cache/node/12.16.1/x64');
681+
findSpy.mockImplementation(() => toolPath);
682+
683+
// expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
684+
process.env['GITHUB_SERVER_URL'] = '';
685+
isCacheActionAvailable.mockImplementation(() => false);
686+
687+
await main.run();
688+
689+
expect(warningSpy).toHaveBeenCalledWith(
690+
'The runner was not able to contact the cache service. Caching will be skipped'
691+
);
692+
});
693+
});
694+
647695
describe('LTS version', () => {
648696
beforeEach(() => {
649697
os.platform = 'linux';

‎dist/cache-save/index.js

+31-5
Original file line numberDiff line numberDiff line change
@@ -3139,10 +3139,7 @@ const options_1 = __webpack_require__(248);
31393139
const requestUtils_1 = __webpack_require__(826);
31403140
const versionSalt = '1.0';
31413141
function getCacheApiUrl(resource) {
3142-
// Ideally we just use ACTIONS_CACHE_URL
3143-
const baseUrl = (process.env['ACTIONS_CACHE_URL'] ||
3144-
process.env['ACTIONS_RUNTIME_URL'] ||
3145-
'').replace('pipelines', 'artifactcache');
3142+
const baseUrl = process.env['ACTIONS_CACHE_URL'] || '';
31463143
if (!baseUrl) {
31473144
throw new Error('Cache Service Url not found, unable to restore cache.');
31483145
}
@@ -3811,6 +3808,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
38113808
Object.defineProperty(exports, "__esModule", { value: true });
38123809
const core = __importStar(__webpack_require__(470));
38133810
const exec = __importStar(__webpack_require__(986));
3811+
const cache = __importStar(__webpack_require__(692));
38143812
exports.supportedPackageManagers = {
38153813
npm: {
38163814
lockFilePatterns: ['package-lock.json', 'yarn.lock'],
@@ -3875,6 +3873,24 @@ exports.getCacheDirectoryPath = (packageManagerInfo, packageManager) => __awaite
38753873
core.debug(`${packageManager} path is ${stdOut}`);
38763874
return stdOut;
38773875
});
3876+
function isGhes() {
3877+
const ghUrl = new URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
3878+
return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
3879+
}
3880+
exports.isGhes = isGhes;
3881+
function isCacheFeatureAvailable() {
3882+
if (!cache.isFeatureAvailable()) {
3883+
if (isGhes()) {
3884+
throw new Error('Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.');
3885+
}
3886+
else {
3887+
core.warning('The runner was not able to contact the cache service. Caching will be skipped');
3888+
}
3889+
return false;
3890+
}
3891+
return true;
3892+
}
3893+
exports.isCacheFeatureAvailable = isCacheFeatureAvailable;
38783894

38793895

38803896
/***/ }),
@@ -5703,7 +5719,8 @@ function downloadCacheStorageSDK(archiveLocation, archivePath, options) {
57035719
//
57045720
// If the file exceeds the buffer maximum length (~1 GB on 32-bit systems and ~2 GB
57055721
// on 64-bit systems), split the download into multiple segments
5706-
const maxSegmentSize = buffer.constants.MAX_LENGTH;
5722+
// ~2 GB = 2147483647, beyond this, we start getting out of range error. So, capping it accordingly.
5723+
const maxSegmentSize = Math.min(2147483647, buffer.constants.MAX_LENGTH);
57075724
const downloadProgress = new DownloadProgress(contentLength);
57085725
const fd = fs.openSync(archivePath, 'w');
57095726
try {
@@ -43258,6 +43275,15 @@ function checkKey(key) {
4325843275
throw new ValidationError(`Key Validation Error: ${key} cannot contain commas.`);
4325943276
}
4326043277
}
43278+
/**
43279+
* isFeatureAvailable to check the presence of Actions cache service
43280+
*
43281+
* @returns boolean return true if Actions cache service feature is available, otherwise false
43282+
*/
43283+
function isFeatureAvailable() {
43284+
return !!process.env['ACTIONS_CACHE_URL'];
43285+
}
43286+
exports.isFeatureAvailable = isFeatureAvailable;
4326143287
/**
4326243288
* Restores cache from keys
4326343289
*

‎dist/setup/index.js

+34-15
Original file line numberDiff line numberDiff line change
@@ -5410,10 +5410,7 @@ const options_1 = __webpack_require__(161);
54105410
const requestUtils_1 = __webpack_require__(246);
54115411
const versionSalt = '1.0';
54125412
function getCacheApiUrl(resource) {
5413-
// Ideally we just use ACTIONS_CACHE_URL
5414-
const baseUrl = (process.env['ACTIONS_CACHE_URL'] ||
5415-
process.env['ACTIONS_RUNTIME_URL'] ||
5416-
'').replace('pipelines', 'artifactcache');
5413+
const baseUrl = process.env['ACTIONS_CACHE_URL'] || '';
54175414
if (!baseUrl) {
54185415
throw new Error('Cache Service Url not found, unable to restore cache.');
54195416
}
@@ -6588,7 +6585,7 @@ const fs_1 = __importDefault(__webpack_require__(747));
65886585
const auth = __importStar(__webpack_require__(749));
65896586
const path = __importStar(__webpack_require__(622));
65906587
const cache_restore_1 = __webpack_require__(409);
6591-
const url_1 = __webpack_require__(835);
6588+
const cache_utils_1 = __webpack_require__(570);
65926589
const os = __webpack_require__(87);
65936590
function run() {
65946591
return __awaiter(this, void 0, void 0, function* () {
@@ -6610,7 +6607,7 @@ function run() {
66106607
}
66116608
if (version) {
66126609
let token = core.getInput('token');
6613-
let auth = !token || isGhes() ? undefined : `token ${token}`;
6610+
let auth = !token || cache_utils_1.isGhes() ? undefined : `token ${token}`;
66146611
let stable = (core.getInput('stable') || 'true').toUpperCase() === 'TRUE';
66156612
const checkLatest = (core.getInput('check-latest') || 'false').toUpperCase() === 'TRUE';
66166613
yield installer.getNode(version, stable, checkLatest, auth, arch);
@@ -6620,10 +6617,7 @@ function run() {
66206617
if (registryUrl) {
66216618
auth.configAuthentication(registryUrl, alwaysAuth);
66226619
}
6623-
if (cache) {
6624-
if (isGhes()) {
6625-
throw new Error('Caching is not supported on GHES');
6626-
}
6620+
if (cache && cache_utils_1.isCacheFeatureAvailable()) {
66276621
const cacheDependencyPath = core.getInput('cache-dependency-path');
66286622
yield cache_restore_1.restoreCache(cache, cacheDependencyPath);
66296623
}
@@ -6638,10 +6632,6 @@ function run() {
66386632
});
66396633
}
66406634
exports.run = run;
6641-
function isGhes() {
6642-
const ghUrl = new url_1.URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
6643-
return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
6644-
}
66456635
function resolveVersionInput() {
66466636
let version = core.getInput('node-version');
66476637
const versionFileInput = core.getInput('node-version-file');
@@ -9525,7 +9515,8 @@ function downloadCacheStorageSDK(archiveLocation, archivePath, options) {
95259515
//
95269516
// If the file exceeds the buffer maximum length (~1 GB on 32-bit systems and ~2 GB
95279517
// on 64-bit systems), split the download into multiple segments
9528-
const maxSegmentSize = buffer.constants.MAX_LENGTH;
9518+
// ~2 GB = 2147483647, beyond this, we start getting out of range error. So, capping it accordingly.
9519+
const maxSegmentSize = Math.min(2147483647, buffer.constants.MAX_LENGTH);
95299520
const downloadProgress = new DownloadProgress(contentLength);
95309521
const fd = fs.openSync(archivePath, 'w');
95319522
try {
@@ -46070,6 +46061,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
4607046061
Object.defineProperty(exports, "__esModule", { value: true });
4607146062
const core = __importStar(__webpack_require__(470));
4607246063
const exec = __importStar(__webpack_require__(986));
46064+
const cache = __importStar(__webpack_require__(638));
4607346065
exports.supportedPackageManagers = {
4607446066
npm: {
4607546067
lockFilePatterns: ['package-lock.json', 'yarn.lock'],
@@ -46134,6 +46126,24 @@ exports.getCacheDirectoryPath = (packageManagerInfo, packageManager) => __awaite
4613446126
core.debug(`${packageManager} path is ${stdOut}`);
4613546127
return stdOut;
4613646128
});
46129+
function isGhes() {
46130+
const ghUrl = new URL(process.env['GITHUB_SERVER_URL'] || 'https://github.com');
46131+
return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
46132+
}
46133+
exports.isGhes = isGhes;
46134+
function isCacheFeatureAvailable() {
46135+
if (!cache.isFeatureAvailable()) {
46136+
if (isGhes()) {
46137+
throw new Error('Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.');
46138+
}
46139+
else {
46140+
core.warning('The runner was not able to contact the cache service. Caching will be skipped');
46141+
}
46142+
return false;
46143+
}
46144+
return true;
46145+
}
46146+
exports.isCacheFeatureAvailable = isCacheFeatureAvailable;
4613746147

4613846148

4613946149
/***/ }),
@@ -47526,6 +47536,15 @@ function checkKey(key) {
4752647536
throw new ValidationError(`Key Validation Error: ${key} cannot contain commas.`);
4752747537
}
4752847538
}
47539+
/**
47540+
* isFeatureAvailable to check the presence of Actions cache service
47541+
*
47542+
* @returns boolean return true if Actions cache service feature is available, otherwise false
47543+
*/
47544+
function isFeatureAvailable() {
47545+
return !!process.env['ACTIONS_CACHE_URL'];
47546+
}
47547+
exports.isFeatureAvailable = isFeatureAvailable;
4752947548
/**
4753047549
* Restores cache from keys
4753147550
*

0 commit comments

Comments
 (0)
Please sign in to comment.