cli: handle spinning states (#657)

Author: anonrig

lib/cli.js

@@ -26,9 +26,10 @@ function head(text, length = 11) {
 }
 
 export default class CLI {
-  constructor(stream) {
+  constructor(stream, options = {}) {
+    const spinnerOptions = options.spinner ?? {};
     this.stream = stream || process.stderr;
-    this.spinner = ora({ stream: this.stream });
+    this.spinner = ora({ stream: this.stream, ...spinnerOptions });
     this.SPINNER_STATUS = SPINNER_STATUS;
     this.QUESTION_TYPE = QUESTION_TYPE;
     this.figureIndent = '   ';
@@ -67,7 +68,16 @@ export default class CLI {
         'defaultAnswer must be provided for non-confirmation prompts');
     }
 
+    const { isSpinning, text: spinningMessage } = this.spinner;
+
+    if (isSpinning) {
+      this.spinner.stop();
+    }
+
     if (this.assumeYes) {
+      if (isSpinning) {
+        this.spinner.start(spinningMessage);
+      }
       return defaultAnswer;
     }
 
@@ -78,6 +88,10 @@ export default class CLI {
       default: defaultAnswer
     }]);
 
+    if (isSpinning) {
+      this.spinner.start(spinningMessage);
+    }
+
     return answer;
   }
 

package.json

@@ -12,8 +12,8 @@
   },
   "scripts": {
     "test": "npm run test-unit && npm run lint",
-    "test-unit": "mocha --timeout 60000 test/unit/*.test.js",
-    "test-all": "mocha --timeout 60000 test/**/*.test.js",
+    "test-unit": "mocha --timeout 60000 test/unit/*.test.js --exit",
+    "test-all": "mocha --timeout 60000 test/**/*.test.js --exit",
     "coverage": "c8 --reporter=html --reporter=text --reporter=text-summary npm test",
     "coverage-all": "c8 --reporter=lcov --reporter=text --reporter=text-summary npm run test-all",
     "lint": "eslint . --cache",

test/unit/ci_start.test.js

@@ -44,6 +44,7 @@ describe('Jenkins', () => {
   it('should fail if starting node-pull-request throws', async() => {
     const cli = new TestCLI();
     const request = {
+      fetch: sinon.stub().returns(Promise.resolve({ status: 400 })),
       text: sinon.stub().throws(),
       json: sinon.stub().withArgs(CI_CRUMB_URL)
         .returns(Promise.resolve({ crumb }))

test/unit/cli.test.js

@@ -165,6 +165,27 @@ describe('cli', () => {
     });
   });
 
+  describe('prompt cares about spinner', () => {
+    beforeEach(() => {
+      stream = new LogStream();
+      cli = new CLI(stream, {
+        spinner: { isEnabled: true }
+      });
+      cli.setAssumeYes();
+    });
+
+    it('pauses when prompt a question', async() => {
+      cli.startSpinner('foo');
+      assert.deepEqual(cli.spinner.text, 'foo');
+      assert.deepEqual(cli.spinner.isSpinning, true);
+      await cli.prompt('So you think darkness is your ally?', {
+        defaultAnswer: 'Yes, I was born in it. Molded by it.',
+        questionType: cli.QUESTION_TYPE.INPUT
+      });
+      assert.strictEqual(cli.spinner.isSpinning, true);
+    });
+  });
+
   describe('prompt assume yes', () => {
     beforeEach(() => {
       stream = new LogStream();