feat: add ASK_SKIP_NEW_VERSION_REMINDER to enable skipping version ch…

…eck at the beginning of each command (#160)
alexa · May 4, 2020 · 59544e3 · 59544e3
1 parent 768d56f
commit 59544e3
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 7 deletions.
diff --git a/lib/commands/abstract-command.js b/lib/commands/abstract-command.js
@@ -81,7 +81,7 @@ class AbstractCommand {
             metricClient.startAction(commandInstance._name, 'command');
 
             // Check if a new CLI version is released
-            this._remindsIfNewVersion(commandInstance.debug, () => {
+            this._remindsIfNewVersion(commandInstance.debug, process.env.ASK_SKIP_NEW_VERSION_REMINDER, () => {
                 try {
                     this._validateOptions(commandInstance);
 
@@ -179,7 +179,9 @@ class AbstractCommand {
         }
     }
 
-    _remindsIfNewVersion(doDebug, callback) {
+    _remindsIfNewVersion(doDebug, skip, callback) {
+        if (skip) return callback();
+
         httpClient.request({
             url: `${CONSTANTS.NPM_REGISTRY_URL_BASE}/${CONSTANTS.APPLICATION_NAME}/latest`,
             method: CONSTANTS.HTTP_REQUEST.VERB.GET

diff --git a/test/unit/commands/abstract-command-test.js b/test/unit/commands/abstract-command-test.js
@@ -60,7 +60,7 @@ describe('Command test - AbstractCommand class', () => {
             mockProcessExit = sinon.stub(process, 'exit');
             mockConsoleError = sinon.stub(console, 'error');
             sinon.stub(metricClient, 'sendData').resolves();
-            sinon.stub(AbstractCommand.prototype, '_remindsIfNewVersion').callsArgWith(1);
+            sinon.stub(AbstractCommand.prototype, '_remindsIfNewVersion').callsArgWith(2);
         });
 
         it('| should be able to register command', async () => {
@@ -311,11 +311,22 @@ describe('Command test - AbstractCommand class', () => {
             sinon.restore();
         });
 
+        it('| skip is set, should skip version check', (done) => {
+            // setup
+            const skip = true;
+            // call
+            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, skip, () => {
+                // verify
+                expect(httpClient.request.called).equal(false);
+                done();
+            });
+        });
+
         it('| http client request error, should warn it out and pass the process', (done) => {
             // setup
             httpClient.request.callsArgWith(3, TEST_HTTP_ERROR);
             // call
-            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, (err) => {
+            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, undefined, (err) => {
                 // verify
                 expect(httpClient.request.args[0][0].url).equal(
                     `${CONSTANTS.NPM_REGISTRY_URL_BASE}/${CONSTANTS.APPLICATION_NAME}/latest`
@@ -334,7 +345,7 @@ describe('Command test - AbstractCommand class', () => {
             const latestVersion = `${currentMajor + 1}.0.0`;
             httpClient.request.callsArgWith(3, null, TEST_NPM_REGISTRY_DATA(latestVersion));
             // call
-            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, (err) => {
+            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, undefined, (err) => {
                 // verify
                 expect(httpClient.request.args[0][0].url).equal(
                     `${CONSTANTS.NPM_REGISTRY_URL_BASE}/${CONSTANTS.APPLICATION_NAME}/latest`
@@ -355,7 +366,7 @@ It is recommended to use the latest version. Please update using "npm upgrade -g
             const latestVersion = `${currentMajor}.${currentMinor + 1}.0`;
             httpClient.request.callsArgWith(3, null, TEST_NPM_REGISTRY_DATA(latestVersion));
             // call
-            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, (err) => {
+            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, undefined, (err) => {
                 // verify
                 expect(httpClient.request.args[0][0].url).equal(
                     `${CONSTANTS.NPM_REGISTRY_URL_BASE}/${CONSTANTS.APPLICATION_NAME}/latest`
@@ -375,7 +386,7 @@ It is recommended to use the latest version. Please update using "npm upgrade -g
             // setup
             httpClient.request.callsArgWith(3, null, TEST_NPM_REGISTRY_DATA(`${currentMajor}.${currentMinor}.0`));
             // call
-            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, (err) => {
+            AbstractCommand.prototype._remindsIfNewVersion(TEST_DO_DEBUG_FALSE, undefined, (err) => {
                 // verify
                 expect(httpClient.request.args[0][0].url).equal(
                     `${CONSTANTS.NPM_REGISTRY_URL_BASE}/${CONSTANTS.APPLICATION_NAME}/latest`