From bea5baf987ba7aa777a8a0b4ace377a21c45c381 Mon Sep 17 00:00:00 2001 From: Dmitry Shibanov Date: Thu, 10 Aug 2023 16:32:24 +0200 Subject: [PATCH] change getinput to getstate for cache (#816) --- __tests__/cache-save.test.ts | 83 +++++++++++++++++++++++------------- dist/cache-save/index.js | 3 +- dist/setup/index.js | 3 ++ src/cache-save.ts | 2 +- src/constants.ts | 1 + src/main.ts | 2 + 6 files changed, 62 insertions(+), 32 deletions(-) diff --git a/__tests__/cache-save.test.ts b/__tests__/cache-save.test.ts index 922566d63..17899dfa3 100644 --- a/__tests__/cache-save.test.ts +++ b/__tests__/cache-save.test.ts @@ -92,6 +92,9 @@ describe('run', () => { it('Package manager is not valid, skip caching', async () => { inputs['cache'] = 'yarn3'; + getStateSpy.mockImplementation(key => + key === State.CachePackageManager ? inputs['cache'] : '' + ); await run(); @@ -108,7 +111,9 @@ describe('run', () => { it('should not save cache for yarn1', async () => { inputs['cache'] = 'yarn'; getStateSpy.mockImplementation(key => - key === State.CachePrimaryKey || key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CachePrimaryKey || key === State.CacheMatchedKey ? yarnFileHash : key === State.CachePaths ? '["/foo/bar"]' @@ -117,8 +122,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(infoSpy).toHaveBeenCalledWith( @@ -130,7 +135,9 @@ describe('run', () => { it('should not save cache for yarn2', async () => { inputs['cache'] = 'yarn'; getStateSpy.mockImplementation(key => - key === State.CachePrimaryKey || key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CachePrimaryKey || key === State.CacheMatchedKey ? yarnFileHash : key === State.CachePaths ? '["/foo/bar"]' @@ -139,8 +146,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(infoSpy).toHaveBeenCalledWith( @@ -152,7 +159,9 @@ describe('run', () => { it('should not save cache for npm', async () => { inputs['cache'] = 'npm'; getStateSpy.mockImplementation(key => - key === State.CachePrimaryKey || key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CachePrimaryKey || key === State.CacheMatchedKey ? yarnFileHash : key === State.CachePaths ? '["/foo/bar"]' @@ -162,8 +171,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(setFailedSpy).not.toHaveBeenCalled(); @@ -172,7 +181,9 @@ describe('run', () => { it('should not save cache for pnpm', async () => { inputs['cache'] = 'pnpm'; getStateSpy.mockImplementation(key => - key === State.CachePrimaryKey || key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CachePrimaryKey || key === State.CacheMatchedKey ? yarnFileHash : key === State.CachePaths ? '["/foo/bar"]' @@ -181,8 +192,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(setFailedSpy).not.toHaveBeenCalled(); @@ -193,7 +204,9 @@ describe('run', () => { it('saves cache from yarn 1', async () => { inputs['cache'] = 'yarn'; getStateSpy.mockImplementation((key: string) => - key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CacheMatchedKey ? yarnFileHash : key === State.CachePrimaryKey ? npmFileHash @@ -204,8 +217,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(infoSpy).not.toHaveBeenCalledWith( @@ -221,7 +234,9 @@ describe('run', () => { it('saves cache from yarn 2', async () => { inputs['cache'] = 'yarn'; getStateSpy.mockImplementation((key: string) => - key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CacheMatchedKey ? yarnFileHash : key === State.CachePrimaryKey ? npmFileHash @@ -232,8 +247,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(infoSpy).not.toHaveBeenCalledWith( @@ -249,7 +264,9 @@ describe('run', () => { it('saves cache from npm', async () => { inputs['cache'] = 'npm'; getStateSpy.mockImplementation((key: string) => - key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CacheMatchedKey ? npmFileHash : key === State.CachePrimaryKey ? yarnFileHash @@ -260,8 +277,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(infoSpy).not.toHaveBeenCalledWith( @@ -277,7 +294,9 @@ describe('run', () => { it('saves cache from pnpm', async () => { inputs['cache'] = 'pnpm'; getStateSpy.mockImplementation((key: string) => - key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CacheMatchedKey ? pnpmFileHash : key === State.CachePrimaryKey ? npmFileHash @@ -288,8 +307,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(infoSpy).not.toHaveBeenCalledWith( @@ -305,7 +324,9 @@ describe('run', () => { it('save with -1 cacheId , should not fail workflow', async () => { inputs['cache'] = 'npm'; getStateSpy.mockImplementation((key: string) => - key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CacheMatchedKey ? npmFileHash : key === State.CachePrimaryKey ? yarnFileHash @@ -319,8 +340,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(infoSpy).not.toHaveBeenCalledWith( @@ -336,7 +357,9 @@ describe('run', () => { it('saves with error from toolkit, should fail workflow', async () => { inputs['cache'] = 'npm'; getStateSpy.mockImplementation((key: string) => - key === State.CacheMatchedKey + key === State.CachePackageManager + ? inputs['cache'] + : key === State.CacheMatchedKey ? npmFileHash : key === State.CachePrimaryKey ? yarnFileHash @@ -350,8 +373,8 @@ describe('run', () => { await run(); - expect(getInputSpy).toHaveBeenCalled(); - expect(getStateSpy).toHaveBeenCalledTimes(3); + expect(getInputSpy).not.toHaveBeenCalled(); + expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0); expect(infoSpy).not.toHaveBeenCalledWith( diff --git a/dist/cache-save/index.js b/dist/cache-save/index.js index cfef46353..4173b7238 100644 --- a/dist/cache-save/index.js +++ b/dist/cache-save/index.js @@ -60381,7 +60381,7 @@ process.on('uncaughtException', e => { function run() { return __awaiter(this, void 0, void 0, function* () { try { - const cacheLock = core.getInput('cache'); + const cacheLock = core.getState(constants_1.State.CachePackageManager); yield cachePackages(cacheLock); } catch (error) { @@ -60692,6 +60692,7 @@ var LockType; })(LockType = exports.LockType || (exports.LockType = {})); var State; (function (State) { + State["CachePackageManager"] = "SETUP_NODE_CACHE_PACKAGE_MANAGER"; State["CachePrimaryKey"] = "CACHE_KEY"; State["CacheMatchedKey"] = "CACHE_RESULT"; State["CachePaths"] = "CACHE_PATHS"; diff --git a/dist/setup/index.js b/dist/setup/index.js index 007749714..10313c733 100644 --- a/dist/setup/index.js +++ b/dist/setup/index.js @@ -71479,6 +71479,7 @@ var LockType; })(LockType = exports.LockType || (exports.LockType = {})); var State; (function (State) { + State["CachePackageManager"] = "SETUP_NODE_CACHE_PACKAGE_MANAGER"; State["CachePrimaryKey"] = "CACHE_KEY"; State["CacheMatchedKey"] = "CACHE_RESULT"; State["CachePaths"] = "CACHE_PATHS"; @@ -72209,6 +72210,7 @@ const cache_restore_1 = __nccwpck_require__(9517); const cache_utils_1 = __nccwpck_require__(1678); const installer_factory_1 = __nccwpck_require__(5617); const util_1 = __nccwpck_require__(2629); +const constants_1 = __nccwpck_require__(9042); function run() { return __awaiter(this, void 0, void 0, function* () { try { @@ -72249,6 +72251,7 @@ function run() { auth.configAuthentication(registryUrl, alwaysAuth); } if (cache && cache_utils_1.isCacheFeatureAvailable()) { + core.saveState(constants_1.State.CachePackageManager, cache); const cacheDependencyPath = core.getInput('cache-dependency-path'); yield cache_restore_1.restoreCache(cache, cacheDependencyPath); } diff --git a/src/cache-save.ts b/src/cache-save.ts index 9449fb85c..d584c3e62 100644 --- a/src/cache-save.ts +++ b/src/cache-save.ts @@ -16,7 +16,7 @@ process.on('uncaughtException', e => { export async function run() { try { - const cacheLock = core.getInput('cache'); + const cacheLock = core.getState(State.CachePackageManager); await cachePackages(cacheLock); } catch (error) { core.setFailed(error.message); diff --git a/src/constants.ts b/src/constants.ts index cd017266f..1a318279f 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -5,6 +5,7 @@ export enum LockType { } export enum State { + CachePackageManager = 'SETUP_NODE_CACHE_PACKAGE_MANAGER', CachePrimaryKey = 'CACHE_KEY', CacheMatchedKey = 'CACHE_RESULT', CachePaths = 'CACHE_PATHS' diff --git a/src/main.ts b/src/main.ts index 90cd1d9d9..d914ff1e6 100644 --- a/src/main.ts +++ b/src/main.ts @@ -9,6 +9,7 @@ import {restoreCache} from './cache-restore'; import {isCacheFeatureAvailable} from './cache-utils'; import {getNodejsDistribution} from './distributions/installer-factory'; import {parseNodeVersionFile, printEnvDetailsAndSetOutput} from './util'; +import {State} from './constants'; export async function run() { try { @@ -60,6 +61,7 @@ export async function run() { } if (cache && isCacheFeatureAvailable()) { + core.saveState(State.CachePackageManager, cache); const cacheDependencyPath = core.getInput('cache-dependency-path'); await restoreCache(cache, cacheDependencyPath); }