implement queueTask

Author: mshima

lib/environment.js

@@ -1025,14 +1025,7 @@ class Environment extends Base {
     };
 
     if (schedule) {
-      this.runLoop.add('environment:run', async (done, stop) => {
-        try {
-          await runGenerator();
-          done();
-        } catch (error) {
-          stop(error);
-        }
-      });
+      this.queueTask('environment:run', () => runGenerator());
     } else {
       await runGenerator();
     }
@@ -1352,38 +1345,26 @@ class Environment extends Base {
   queueConflicter() {
     const queueCommit = () => {
       debug('Queueing conflicts task');
-      this.runLoop.add(
+      this.queueTask(
         'environment:conflicts',
-        (done, stop) => {
+        async () => {
           let customCommitTask = this.findGeneratorCustomCommitTask();
           if (customCommitTask !== undefined && customCommitTask) {
             if (typeof customCommitTask !== 'function') {
-              done();
+              // There is a custom commit task or just disabled
               return;
             }
           } else {
+            // Using default commit task
             customCommitTask = this.commitSharedFs.bind(this);
           }
 
+          await customCommitTask();
+
           if (this.enableConflicterIgnore) {
             debug('Adding queueCommit event listener');
             this.sharedFs.once('change', queueCommit);
           }
-
-          const result = customCommitTask();
-          if (!result || !result.then) {
-            done();
-            return;
-          }
-
-          return result.then(() => {
-            if (!this.enableConflicterIgnore) {
-              debug('Adding queueCommit event listener');
-              this.sharedFs.once('change', queueCommit);
-            }
-
-            done();
-          }, stop);
         },
         {
           once: 'write memory fs to disk',
@@ -1398,7 +1379,35 @@ class Environment extends Base {
    * Queue environment's package manager install task.
    */
   queuePackageManagerInstall() {
-    this.runLoop.add('install', (done, stop) => this.packageManagerInstallTask().then(done, stop), { once: 'package manager install' });
+    this.queueTask('install', () => this.packageManagerInstallTask(), { once: 'package manager install' });
+  }
+
+  /**
+   * Queue tasks
+   * @param {string} priority
+   * @param {(...args: any[]) => void | Promise<void>} task
+   * @param {{ once?: string, startQueue?: boolean }} [options]
+   */
+  queueTask(priority, task, options) {
+    return new Promise((resolve, reject) => {
+      this.runLoop.add(
+        priority,
+        async (done, stop) => {
+          try {
+            const result = await task();
+            done(result);
+            resolve(result);
+          } catch (error) {
+            stop(error);
+            reject(error);
+          }
+        },
+        {
+          once: options.once,
+          run: options.startQueue ?? false,
+        },
+      );
+    });
   }
 }
 Object.assign(Environment.prototype, resolver);

test/environment.js

@@ -244,17 +244,17 @@ describe('Environment', () => {
     });
 
     it('should schedule generator queue', async function () {
-      this.env.runLoop.add = sinon.spy();
+      this.env.queueTask = sinon.spy();
       await this.env.composeWith('stub');
-      assert(this.env.runLoop.add.calledOnce);
-      assert(this.env.runLoop.add.getCall(0).firstArg === 'environment:run');
+      assert(this.env.queueTask.calledOnce);
+      assert(this.env.queueTask.getCall(0).firstArg === 'environment:run');
     });
 
     describe('passing false schedule parameter', () => {
       it('should queue generator tasks', async function () {
-        this.env.runLoop.add = sinon.spy();
+        this.env.queueTask = sinon.spy();
         await this.env.composeWith('stub', [], {}, false);
-        assert(this.env.runLoop.add.getCall(0).firstArg !== 'environment:run');
+        assert(this.env.queueTask.notCalled);
       });
     });