From 206e984b94c0532e57811bc170b0832bc4515975 Mon Sep 17 00:00:00 2001 From: Jongwoo Han Date: Mon, 19 Dec 2022 22:00:46 +0900 Subject: [PATCH] refactor: Use early return pattern to avoid nested conditions (#566) * refactor: Use early return pattern Signed-off-by: jongwooo * fix: Replace throw with warn Signed-off-by: jongwooo Signed-off-by: jongwooo --- __tests__/utils.test.ts | 11 +++++------ dist/setup/index.js | 15 +++++++-------- src/utils.ts | 22 +++++++++++----------- 3 files changed, 23 insertions(+), 25 deletions(-) diff --git a/__tests__/utils.test.ts b/__tests__/utils.test.ts index 04ec7c5..30fc61c 100644 --- a/__tests__/utils.test.ts +++ b/__tests__/utils.test.ts @@ -42,14 +42,13 @@ describe('validateVersion', () => { describe('isCacheFeatureAvailable', () => { it('isCacheFeatureAvailable disabled on GHES', () => { jest.spyOn(cache, 'isFeatureAvailable').mockImplementation(() => false); + const infoMock = jest.spyOn(core, 'warning'); + const message = + 'Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.'; try { process.env['GITHUB_SERVER_URL'] = 'http://example.com'; - isCacheFeatureAvailable(); - } catch (error) { - expect(error).toHaveProperty( - 'message', - 'Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.' - ); + expect(isCacheFeatureAvailable()).toBeFalsy(); + expect(infoMock).toHaveBeenCalledWith(message); } finally { delete process.env['GITHUB_SERVER_URL']; } diff --git a/dist/setup/index.js b/dist/setup/index.js index 6cf4871..2d15571 100644 --- a/dist/setup/index.js +++ b/dist/setup/index.js @@ -67057,16 +67057,15 @@ function isGhes() { } exports.isGhes = isGhes; function isCacheFeatureAvailable() { - if (!cache.isFeatureAvailable()) { - if (isGhes()) { - throw new Error('Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.'); - } - else { - core.warning('The runner was not able to contact the cache service. Caching will be skipped'); - } + if (cache.isFeatureAvailable()) { + return true; + } + if (isGhes()) { + core.warning('Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.'); return false; } - return true; + core.warning('The runner was not able to contact the cache service. Caching will be skipped'); + return false; } exports.isCacheFeatureAvailable = isCacheFeatureAvailable; function logWarning(message) { diff --git a/src/utils.ts b/src/utils.ts index 37059cb..fe32eda 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -105,21 +105,21 @@ export function isGhes(): boolean { } export function isCacheFeatureAvailable(): boolean { - if (!cache.isFeatureAvailable()) { - if (isGhes()) { - throw new Error( - 'Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.' - ); - } else { - core.warning( - 'The runner was not able to contact the cache service. Caching will be skipped' - ); - } + if (cache.isFeatureAvailable()) { + return true; + } + if (isGhes()) { + core.warning( + 'Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.' + ); return false; } - return true; + core.warning( + 'The runner was not able to contact the cache service. Caching will be skipped' + ); + return false; } export function logWarning(message: string): void {