fix: exit after async handler done (#2313)

PengBoUESTC · web-flow · commit e326cde53173 · 2023-04-28T13:55:33.000-04:00
diff --git a/lib/yargs-factory.ts b/lib/yargs-factory.ts
@@ -2162,8 +2162,10 @@ export class YargsInstance {
         if (helpOptSet) {
           if (this.#exitProcess) setBlocking(true);
           skipValidation = true;
-          this.showHelp('log');
-          this.exit(0);
+          this.showHelp(message => {
+            this.#logger.log(message);
+            this.exit(0);
+          });
         } else if (versionOptSet) {
           if (this.#exitProcess) setBlocking(true);
           skipValidation = true;
diff --git a/test/usage.cjs b/test/usage.cjs
@@ -7,6 +7,7 @@ const chalk = require('chalk');
 const yargs = require('../index.cjs');
 const expect = require('chai').expect;
 const {YError} = require('../build/index.cjs');
+const assert = require('assert');
 
 const should = require('chai').should();
 
@@ -4877,6 +4878,33 @@ describe('usage tests', () => {
         help.split('\n').should.deep.equal(expected);
       });
     });
+
+    it('help is displayed before exit is called with async default command', async () => {
+      // https://github.com/yargs/yargs/issues/2312
+      const _exit = process.exit;
+      const _log = console.log;
+      let callCount = 0;
+      let logCall = 0;
+      let exitCall = 0;
+      process.exit = () => {
+        exitCall = ++callCount;
+      };
+      console.log = () => {
+        logCall = ++callCount;
+      };
+      await yargs(['--help'])
+        .command('$0', 'a test command', async yargs => {
+          await wait();
+        })
+        .parseAsync();
+      // The async help is dangling, so wait for it to fire!
+      await wait();
+      assert.ok(exitCall > 0, 'exit never called'); // sanity check
+      assert.ok(logCall > 0, 'log never called'); // sanity check
+      assert.ok(exitCall > logCall, 'exit called before help displayed');
+      console.log = _log;
+      process.exit = _exit;
+    });
   });
 
   // Refs: https://github.com/yargs/yargs/issues/1820
