Better error handling

packages/inquirer-autocomplete-prompt/example.js

@@ -94,6 +94,10 @@ function searchFood(answers, input = '') {
 
 inquirer
   .prompt([
+    {
+      type: 'input',
+      name: 'first_name',
+    },
     {
       type: 'autocomplete',
       name: 'fruit',
@@ -161,4 +165,7 @@ inquirer
   ])
   .then((answers) => {
     console.log(JSON.stringify(answers, null, 2));
+  })
+  .catch((err) => {
+    console.log(err);
   });

packages/inquirer-autocomplete-prompt/index.js

@@ -18,6 +18,15 @@ import { takeWhile } from 'rxjs/operators';
 const isSelectable = (choice) =>
   choice.type !== 'separator' && !choice.disabled;
 
+const tryCallPromiseFail = (fn, ...args) => {
+  try {
+    const result = fn(...args);
+    return Promise.resolve(result);
+  } catch (error) {
+    return Promise.reject(error);
+  }
+};
+
 class AutocompletePrompt extends Base {
   constructor(
     questions /*: Array<any> */,
@@ -52,8 +61,9 @@ class AutocompletePrompt extends Base {
    * @param  {Function} cb      Callback when prompt is done
    * @return {this}
    */
-  _run(cb /*: Function */) /*: this*/ {
+  _run(cb /*: Function */, errCb /*: Function */) /*: this*/ {
     this.done = cb;
+    this.errCb = errCb;
 
     if (Array.isArray(this.rl.history)) {
       this.rl.history = [];
@@ -155,17 +165,21 @@ class AutocompletePrompt extends Base {
 
       let validationResult;
       if (this.opt.suggestOnly) {
-        validationResult = this.opt.validate(lineOrRl, this.answers);
+        validationResult = tryCallPromiseFail(
+          this.opt.validate,
+          lineOrRl,
+          this.answers
+        );
       } else {
         const choice = this.currentChoices.getChoice(this.selected);
-        validationResult = this.opt.validate(choice, this.answers);
+        validationResult = tryCallPromiseFail(
+          this.opt.validate,
+          choice,
+          this.answers
+        );
       }
 
-      if (isPromise(validationResult)) {
-        validationResult.then(checkValidationResult);
-      } else {
-        checkValidationResult(validationResult);
-      }
+      validationResult.then(checkValidationResult, this.errCb);
     } else {
       this.onSubmitAfterValidation(lineOrRl);
     }
@@ -226,38 +240,38 @@ class AutocompletePrompt extends Base {
 
     this.lastSearchTerm = searchTerm;
 
-    let thisPromise;
-    try {
-      const result = this.opt.source(this.answers, searchTerm);
-      thisPromise = Promise.resolve(result);
-    } catch (error) {
-      thisPromise = Promise.reject(error);
-    }
+    const thisPromise = tryCallPromiseFail(
+      this.opt.source,
+      this.answers,
+      searchTerm
+    );
 
     // Store this promise for check in the callback
     this.lastPromise = thisPromise;
 
-    return thisPromise.then((choices) => {
-      // If another search is triggered before the current search finishes, don't set results
-      if (thisPromise !== this.lastPromise) return;
+    return thisPromise
+      .then((choices) => {
+        // If another search is triggered before the current search finishes, don't set results
+        if (thisPromise !== this.lastPromise) return;
 
-      this.currentChoices = new Choices(choices);
+        this.currentChoices = new Choices(choices);
 
-      const realChoices = choices.filter((choice) => isSelectable(choice));
-      this.nbChoices = realChoices.length;
+        const realChoices = choices.filter((choice) => isSelectable(choice));
+        this.nbChoices = realChoices.length;
 
-      const selectedIndex = realChoices.findIndex(
-        (choice) =>
-          choice === this.initialValue || choice.value === this.initialValue
-      );
+        const selectedIndex = realChoices.findIndex(
+          (choice) =>
+            choice === this.initialValue || choice.value === this.initialValue
+        );
 
-      if (selectedIndex >= 0) {
-        this.selected = selectedIndex;
-      }
+        if (selectedIndex >= 0) {
+          this.selected = selectedIndex;
+        }
 
-      this.searching = false;
-      this.render();
-    });
+        this.searching = false;
+        this.render();
+      })
+      .catch(this.errCb);
   }
 
   ensureSelectedInRange() {
@@ -269,7 +283,9 @@ class AutocompletePrompt extends Base {
    * When user type
    */
 
-  onKeypress(e /* : {key: { name: string, ctrl: boolean }, value: string } */) {
+  async onKeypress(
+    e /* : {key: { name: string, ctrl: boolean }, value: string } */
+  ) {
     let len;
     const keyName = (e.key && e.key.name) || undefined;
 
@@ -344,8 +360,4 @@ function listRender(choices, pointer /*: string */) /*: string */ {
   return output.replace(/\n$/, '');
 }
 
-function isPromise(value) {
-  return typeof value === 'object' && typeof value.then === 'function';
-}
-
 export default AutocompletePrompt;

packages/inquirer-autocomplete-prompt/package.json

@@ -84,7 +84,7 @@
     "flow": "flow",
     "pretest": "npm run lint && npm run flow",
     "test": "vitest run test --coverage",
-    "develop": "vitest watch test --coverage --reporter=basic"
+    "develop": "vitest watch test -c ../../vitest.develop.config.mjs"
   },
   "type": "module"
 }

packages/inquirer-autocomplete-prompt/test/spec/indexSpec.spec.js

@@ -382,7 +382,99 @@ describe('inquirer-autocomplete-prompt', () => {
       );
     });
 
-    describe('default behaviour', () => {
+    describe('error handling', () => {
+      it('handles async error in source function', async () => {
+        const error = new Error('Something went wrong!');
+        source.returns(Promise.reject(error));
+
+        promiseForAnswer = getPromiseForAnswer();
+
+        const successSpy = sinon.spy();
+        const errorSpy = sinon.spy();
+
+        await promiseForAnswer.then(successSpy).catch(errorSpy);
+
+        sinon.assert.notCalled(successSpy);
+        sinon.assert.calledOnce(errorSpy);
+        sinon.assert.calledWithExactly(errorSpy, error);
+      });
+
+      it('handles sync error in source function', async () => {
+        const error = new Error('Something went wrong!');
+        source.throws(error);
+
+        promiseForAnswer = getPromiseForAnswer();
+
+        const successSpy = sinon.spy();
+        const errorSpy = sinon.spy();
+
+        await promiseForAnswer.then(successSpy).catch(errorSpy);
+
+        sinon.assert.notCalled(successSpy);
+        sinon.assert.calledOnce(errorSpy);
+        sinon.assert.calledWithExactly(errorSpy, error);
+      });
+
+      it('renders sync error in validate function as validation error', async () => {
+        const error = new Error('Something went wrong2!');
+        source.returns(['foo', 'bar']);
+
+        const validate = sinon.stub();
+
+        prompt = new Prompt(
+          {
+            message: 'test',
+            name: 'name',
+            validate,
+            source,
+          },
+          rl
+        );
+
+        promiseForAnswer = getPromiseForAnswer();
+        validate.throws(error);
+        enter();
+
+        const successSpy = sinon.spy();
+        const errorSpy = sinon.spy();
+
+        await promiseForAnswer.then(successSpy).catch(errorSpy);
+
+        sinon.assert.notCalled(successSpy);
+        sinon.assert.calledOnce(errorSpy);
+      });
+
+      it('renders async error in validate function', async () => {
+        const error = new Error('Something went wrong in validation!');
+        source.returns(['foo', 'bar']);
+
+        const validate = sinon.stub();
+
+        prompt = new Prompt(
+          {
+            message: 'test',
+            name: 'name',
+            validate,
+            source,
+          },
+          rl
+        );
+
+        promiseForAnswer = getPromiseForAnswer();
+        validate.rejects(error);
+        enter();
+
+        const successSpy = sinon.spy();
+        const errorSpy = sinon.spy();
+
+        await promiseForAnswer.then(successSpy).catch(errorSpy);
+
+        sinon.assert.notCalled(successSpy);
+        sinon.assert.calledOnce(errorSpy);
+      });
+    });
+
+    describe('default behavior', () => {
       it('sets the first to selected when no default', () => {
         prompt = new Prompt(
           {
@@ -502,7 +594,7 @@ describe('inquirer-autocomplete-prompt', () => {
       });
     });
 
-    it('applies filter async with done calback', () => {
+    it('applies filter async with done callback', () => {
       prompt = new Prompt(
         {
           message: 'test',
@@ -801,7 +893,7 @@ describe('inquirer-autocomplete-prompt', () => {
         sinon.assert.callCount(source, 4);
       });
 
-      it('does not search again if same searchterm (not input added)', () => {
+      it('does not search again if same search term (not input added)', () => {
         type('ice');
         sinon.assert.calledThrice(source);
         source.reset();
@@ -975,8 +1067,10 @@ describe('inquirer-autocomplete-prompt', () => {
     });
 
     describe('submit', () => {
+      let validate;
       describe('without choices in result', () => {
         beforeEach(() => {
+          validate = sinon.stub().returns(true);
           rl = new ReadlineStub();
           prompt = new Prompt(
             {
@@ -992,9 +1086,15 @@ describe('inquirer-autocomplete-prompt', () => {
           return promise;
         });
 
-        it('searches again, since not possible to select something that does not exist', () => {
+        it('searches again, since not possible to select something that does not exist', async () => {
+          // called once at start
           sinon.assert.calledOnce(source);
+
+          // try to select and await validation result (even sync validation is async)
           enter();
+          await validate;
+
+          // Now search again
           sinon.assert.calledTwice(source);
         });
       });

packages/inquirer-autocomplete-standalone/package.json

@@ -82,6 +82,6 @@
     "clean": "rm -rf dist",
     "build": "yarn run clean && yarn run tsc",
     "tsc": "tsc -p ./tsconfig.json",
-    "develop": "vitest watch test --coverage --reporter=basic"
+    "develop": "vitest watch test -c ../../vitest.develop.config.mjs"
   }
 }

vitest.develop.config.mjs

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    reporter: ['basic'],
+    coverage: {
+      reporter: ['lcov'],
+    },
+  },
+});