gate-executor 3.0.0 → 3.2.1

package/gate-executor.d.ts

@@ -0,0 +1,2 @@
+declare function MakeGateExecutor(options?: any): any;
+export default MakeGateExecutor;

package/gate-executor.js

@@ -1,12 +1,6 @@
-/* Copyright (c) 2014-2020 Richard Rodger, MIT License */
-/* $lab:coverage:off$ */
-'use strict'
-
-// Core modules.
-var Assert = require('assert')
-Assert = 'function' === typeof Assert ? Assert : function () {}
-/* $lab:coverage:on$ */
-
+"use strict";
+/* Copyright (c) 2014-2021 Richard Rodger, MIT License */
+Object.defineProperty(exports, "__esModule", { value: true });
 // Create root instance. Exported as module.
 //   * `options` (object): instance options as key-value pairs.
 //
@@ -14,351 +8,287 @@ Assert = 'function' === typeof Assert ? Assert : function () {}
 //   * `interval` (integer): millisecond interval for timeout checks. Default: 111.
 //   * `timeout` (integer): common millisecond timeout.
 //      Can be overridden by work item options. Default: 2222.
-function make_GateExecutor(options) {
-  options = options || {}
-  options.interval = null == options.interval ? 111 : options.interval
-  options.timeout = null == options.timeout ? 2222 : options.timeout
-
-  Assert('object' === typeof options)
-  Assert('number' === typeof options.interval)
-  Assert('number' === typeof options.timeout)
-  Assert(0 < options.interval)
-  Assert(0 < options.timeout)
-
-  return new GateExecutor(options, 0)
+function MakeGateExecutor(options) {
+    options = options || {};
+    options.interval = null == options.interval ? 111 : options.interval;
+    options.timeout = null == options.timeout ? 2222 : options.timeout;
+    return GateExecutor(options, 0);
 }
-
 // Create a new instance.
 //   * `options` (object): instance options as key-value pairs.
 //   * `instance_counter` (integer): count number of instances created;
 //     used as identifier.
 function GateExecutor(options, instance_counter) {
-  var self = this
-
-  Assert('object' === typeof options)
-  Assert('number' === typeof instance_counter)
-
-  self.id = ++instance_counter
-  self.options = options
-
-  // Work queue.
-  var q = []
-
-  // Work-in-progress set.
-  var progress = {
-    // Lookup work by id.
-    lookup: {},
-
-    // Work history - a list of work items in the order executed.
-    history: [],
-  }
-
-  // List of work items to check for timeouts.
-  var timeout_checklist = []
-
-  // Internal state.
-  var s = {
-    // Count of work items added to this instance. Used as generated work identifier.
-    work_counter: 0,
-
-    // When `true`, the instance is in a gated state, and work cannot proceed
-    // until the gated in-progress work item is completed.
-    gate: false,
-
-    // When `true`, the instance processes work items as they arrive.
-    // When `false`, no processing happens, and the instance must be started by
-    // calling the `start` method.
-    running: false,
-
-    // A function called when the work queue and work-in-progress set
-    // are empty.  Set by calling the `clear` method. Will be called
-    // each time the instance empty.
-    clear: null,
-
-    // A function called once only when the work queue and
-    // work-in-progress set are first emptied after each start. Set as
-    // an optional argument to the `start` method.
-    firstclear: null,
-
-    // Timeout interval reference value returned by `setInterval`.
-    // Timeouts are not checked using `setTimeout`, as it is more
-    // efficient, and more than sufficient, to check timeouts periodically.
-    tm_in: null,
-  }
-
-  // Process the next work item.
-  function processor() {
-    // If not running, don't process any work items.
-    if (!s.running) {
-      return
-    }
-
-    // The timeout interval check is stopped and started only as needed.
-    if (!self.isclear() && !s.tm_in) {
-      s.tm_in = setInterval(timeout_check, options.interval)
-    }
-
-    // Process the next work item, returning `true` if there was one.
-    do {
-      var next = false
-      var work = null
-
-      // Remove next work item from the front of the work queue.
-      if (!s.gate) {
-        work = q.shift()
-      }
-
-      if (work) {
-        Assert('object' === typeof work)
-        Assert('string' === typeof work.id)
-        Assert('function' === typeof work.fn)
-
-        // Add work item to the work-in-progress set.
-        progress.lookup[work.id] = work
-        progress.history.push(work)
-
-        // If work item is a gate, set the state of the instance as
-        // gated.  This work item will need to complete before later
-        // work items in the queue can be processed.
-        s.gate = work.gate
-
-        // Call the work item function (which does the real work),
-        // passing a callback. This callback has no arguments
-        // (including no error!).  It is called only to indicate
-        // completion of the work item.  Work items must handle their
-        // own errors and results.
-        work.start = Date.now()
-        work.callback = make_work_fn_callback(work)
-
-        timeout_checklist.push(work)
-        work.fn(work.callback)
-
-        next = true
-      }
-    } while (next)
-    // Keep processing work items until none are left or a gate is reached.
-  }
-
-  // Create the callback for the work function
-  function make_work_fn_callback(work) {
-    return function work_fn_callback() {
-      if (work.done) {
-        return
-      }
-
-      // Remove the work item from the work-in-progress set.  As
-      // work items may complete out of order, prune the history
-      // from the front until the first incomplete work
-      // item. Later complete work items will eventually be
-      // reached on another processing round.
-      work.done = true
-      delete progress.lookup[work.id]
-
-      while (progress.history[0] && progress.history[0].done) {
-        progress.history.shift()
-      }
-
-      while (timeout_checklist[0] && timeout_checklist[0].done) {
-        timeout_checklist.shift()
-      }
-
-      // If the work item was a gate, it is now complete, and the
-      // instance can be ungated, allowing later work items in the
-      // queue to be processed.
-      if (work.gate) {
-        s.gate = false
-      }
-
-      // If work queue and work-in-progress set are empty, then
-      // call the registered clear functions.
-      if (0 === q.length && 0 === progress.history.length) {
-        clearInterval(s.tm_in)
-        s.tm_in = null
-
-        if (s.firstclear) {
-          var fc = s.firstclear
-          s.firstclear = null
-          fc()
-        }
-
-        if (s.clear) {
-          s.clear()
+    let self = {};
+    self.id = ++instance_counter;
+    self.options = options;
+    // Work queue.
+    let q = [];
+    // Work-in-progress set.
+    let progress = {
+        // Lookup work by id.
+        lookup: {},
+        // Work history - a list of work items in the order executed.
+        history: [],
+    };
+    // List of work items to check for timeouts.
+    let timeout_checklist = [];
+    // Internal state.
+    let s = {
+        // Count of work items added to this instance. Used as generated work identifier.
+        work_counter: 0,
+        // When `true`, the instance is in a gated state, and work cannot proceed
+        // until the gated in-progress work item is completed.
+        gate: false,
+        // When `true`, the instance processes work items as they arrive.
+        // When `false`, no processing happens, and the instance must be started by
+        // calling the `start` method.
+        running: false,
+        // A function called when the work queue and work-in-progress set
+        // are empty.  Set by calling the `clear` method. Will be called
+        // each time the instance empty.
+        clear: null,
+        // A function called once only when the work queue and
+        // work-in-progress set are first emptied after each start. Set as
+        // an optional argument to the `start` method.
+        firstclear: null,
+        // Timeout interval reference value returned by `setInterval`.
+        // Timeouts are not checked using `setTimeout`, as it is more
+        // efficient, and more than sufficient, to check timeouts periodically.
+        tm_in: null,
+        hw_tmc: 0,
+        hw_hst: 0,
+    };
+    // Process the next work item.
+    function processor() {
+        // If not running, don't process any work items.
+        if (!s.running) {
+            return;
         }
-      }
-
-      // Process each work item on next tick to avoid lockups.
-      setImmediate(processor)
-    }
-  }
-
-  // To be run periodically via setInterval. For timed out work items,
-  // calls the done callback to allow work queue to proceed, and marks
-  // the work item as finished. Work items can receive notification of
-  // timeouts by providing an `ontm` callback property in the
-  // work definition object. Work items must handle timeout errors
-  // themselves, gate-executor cares only for the fact that a timeout
-  // happened, so it can continue processing.
-  function timeout_check() {
-    var now = Date.now()
-    var work = null
-
-    for (var i = 0; i < timeout_checklist.length; ++i) {
-      work = timeout_checklist[i]
-
-      if (!work.gate && !work.done && work.tm < now - work.start) {
-        if (work.ontm) {
-          work.ontm(work.tm, work.start, now)
+        // The timeout interval check is stopped and started only as needed.
+        if (!self.isclear() && !s.tm_in) {
+            s.tm_in = setInterval(timeout_check, options.interval);
         }
-
-        work.callback()
-      }
-    }
-  }
-
-  // Start processing work items. Must be called to start processing.
-  // Can be called at anytime, interspersed with calls to other
-  // methods, including `add`. Takes a function as argument, which is
-  // called only once on the next time the queues are clear.
-  self.start = function (firstclear) {
-    Assert(null == firstclear || 'function' === typeof firstclear)
-
-    // Allow API chaining by not starting in current execution path.
-    setImmediate(function () {
-      s.running = true
-
-      if (firstclear) {
-        s.firstclear = firstclear
-      }
-
-      processor()
-    })
-
-    return self
-  }
-
-  // Pause the processing of work items. Newly added items, and items
-  // not yet started, will not proceed, but items already in progress
-  // will complete, and the clear function will be called once all in
-  // progress items finish.
-  self.pause = function () {
-    s.running = false
-  }
-
-  // Submit a function that will be called each time there are no more
-  // work items to process. Multiple calls to this method will replace
-  // the previously registered clear function.
-  self.clear = function (done) {
-    Assert('function' === typeof done)
-    s.clear = done
-    return self
-  }
-
-  // Returns `true` when there are no more work items to process.
-  self.isclear = function () {
-    return 0 === q.length && 0 === progress.history.length
-  }
-
-  // Add a work item. This is an object with fields:
-  //   * `fn` (function): the function that performs the work. Takes a
-  //     single argument, the callback function to call when the work is
-  //     complete. THis callback does **not** accept errors or
-  //     results. It's only purpose is to indicate that the work is
-  //     complete (whether failed or not). The work function itself must
-  //     handle callbacks to the application. Required.
-  //   * `id` (string): identifier for the work item. Optional.
-  //   * `tm` (integer): millisecond timeout specific to this work item,
-  //     overrides general timeout. Optional.
-  //   * `ontm` (function): callback to indicate work item timeout. Optional.
-  //   * `dn` (string): description of the work item, used in the
-  //     state description. Optional.
-  self.add = function (work) {
-    Assert('object' === typeof work)
-    Assert('function' === typeof work.fn)
-    Assert(null == work.id || 'string' === typeof work.id)
-    Assert(null == work.tm || 'number' === typeof work.tm)
-    Assert(null == work.dn || 'string' === typeof work.dn)
-
-    s.work_counter += 1
-    work.id = work.id || '' + s.work_counter
-    work.ge = self.id
-    work.tm = null == work.tm ? options.timeout : work.tm
-
-    work.dn = work.dn || work.fn.name || '' + Date.now()
-
-    // Used by calling code to store additional context.
-    work.ctxt = {}
-
-    q.push(work)
-
-    if (s.running) {
-      // Work items are **not** processed in the current execution path!
-      // This prevents lockup, and avoids false positives in unit tests.
-      // Work items are assumed to be inherently asynchronous.
-      setImmediate(processor)
-    }
-
-    return self
-  }
-
-  // Create a new gate. Returns a new `GateExecutor` instance.  All
-  // work items added to the new instance must complete before the
-  // gate is cleared, and work items in the queue can be processed.  A
-  // gate is cleared when the new instance is **first** cleared. Work
-  // items subsequently added to the new instance are not considered
-  // part of the gate. Gates can extend to any depth and form a tree
-  // structure that requires breadth-first traversal in terms of the
-  // work item queue. Gates do not have timeouts, and can only be
-  // cleared when all added work items complete.
-  self.gate = function () {
-    var ge = new GateExecutor(options, instance_counter)
-
-    var fn = function gate(done) {
-      // This is the work function of the gate, which starts the new
-      // instance, and considers the gate work item complete when the
-      // work queue clears for the first time.
-      ge.start(done)
+        // Process the next work item, returning `true` if there was one.
+        let next = false;
+        do {
+            next = false;
+            let work = null;
+            // Remove next work item from the front of the work queue.
+            if (!s.gate) {
+                work = q.shift();
+            }
+            if (work) {
+                // Add work item to the work-in-progress set.
+                progress.lookup[work.id] = work;
+                progress.history.push(work);
+                s.hw_hst =
+                    progress.history.length > s.hw_hst ? progress.history.length : s.hw_hst;
+                // If work item is a gate, set the state of the instance as
+                // gated.  This work item will need to complete before later
+                // work items in the queue can be processed.
+                s.gate = work.gate;
+                // Call the work item function (which does the real work),
+                // passing a callback. This callback has no arguments
+                // (including no error!).  It is called only to indicate
+                // completion of the work item.  Work items must handle their
+                // own errors and results.
+                work.start = Date.now();
+                work.callback = make_work_fn_callback(work);
+                timeout_checklist.push(work);
+                s.hw_tmc =
+                    timeout_checklist.length > s.hw_tmc ? timeout_checklist.length : s.hw_tmc;
+                work.fn(work.callback);
+                next = true;
+            }
+        } while (next);
+        // Keep processing work items until none are left or a gate is reached.
     }
-
-    self.add({ gate: ge, fn: fn })
-
-    return ge
-  }
-
-  // Return a data structure describing the current state of the work
-  // queues, and organised as a tree structure indicating the gating
-  // relationships.
-  self.state = function () {
-    var out = []
-
-    // First list any in-progress work items.
-    for (var hI = 0; hI < progress.history.length; ++hI) {
-      var pe = progress.history[hI]
-      if (!pe.done) {
-        out.push({ s: 'a', ge: pe.ge, dn: pe.dn, id: pe.id })
-      }
+    // Create the callback for the work function
+    function make_work_fn_callback(work) {
+        return function work_fn_callback() {
+            if (work.done) {
+                return;
+            }
+            work.end = Date.now();
+            // Remove the work item from the work-in-progress set.  As
+            // work items may complete out of order, prune the history
+            // from the front until the first incomplete work
+            // item. Later complete work items will eventually be
+            // reached on another processing round.
+            work.done = true;
+            delete progress.lookup[work.id];
+            while (progress.history[0] && progress.history[0].done) {
+                progress.history.shift();
+            }
+            while (timeout_checklist[0] && timeout_checklist[0].done) {
+                timeout_checklist.shift();
+            }
+            // If the work item was a gate, it is now complete, and the
+            // instance can be ungated, allowing later work items in the
+            // queue to be processed.
+            if (work.gate) {
+                s.gate = false;
+            }
+            // If work queue and work-in-progress set are empty, then
+            // call the registered clear functions.
+            if (0 === q.length && 0 === progress.history.length) {
+                clearInterval(s.tm_in);
+                s.tm_in = null;
+                if (s.firstclear) {
+                    let fc = s.firstclear;
+                    s.firstclear = null;
+                    fc();
+                }
+                if (s.clear) {
+                    s.clear();
+                }
+            }
+            // Process each work item on next tick to avoid lockups.
+            setImmediate(processor);
+        };
     }
-
-    // Then list any waiting work items.
-    for (var qI = 0; qI < q.length; ++qI) {
-      var qe = q[qI]
-      if (qe.gate) {
-        // Go down a level when there's a gate.
-        out.push(qe.gate.state())
-      } else {
-        out.push({ s: 'w', ge: qe.ge, dn: qe.dn, id: qe.id })
-      }
-    }
-
-    out.internal = {
-      qlen: q.length,
-      hlen: progress.history.length,
-      klen: Object.keys(progress.lookup).length,
-      tlen: timeout_check.length,
+    // To be run periodically via setInterval. For timed out work items,
+    // calls the done callback to allow work queue to proceed, and marks
+    // the work item as finished. Work items can receive notification of
+    // timeouts by providing an `ontm` callback property in the
+    // work definition object. Work items must handle timeout errors
+    // themselves, gate-executor cares only for the fact that a timeout
+    // happened, so it can continue processing.
+    function timeout_check() {
+        let now = Date.now();
+        let work = null;
+        for (let i = 0; i < timeout_checklist.length; ++i) {
+            work = timeout_checklist[i];
+            if (!work.gate && !work.done && work.tm < now - work.start) {
+                if (work.ontm) {
+                    work.ontm(work.tm, work.start, now);
+                }
+                work.callback();
+            }
+        }
     }
-
-    return out
-  }
+    // Start processing work items. Must be called to start processing.
+    // Can be called at anytime, interspersed with calls to other
+    // methods, including `add`. Takes a function as argument, which is
+    // called only once on the next time the queues are clear.
+    self.start = function (firstclear) {
+        // Allow API chaining by not starting in current execution path.
+        setImmediate(function () {
+            s.running = true;
+            if (firstclear) {
+                s.firstclear = firstclear;
+            }
+            processor();
+        });
+        return self;
+    };
+    // Pause the processing of work items. Newly added items, and items
+    // not yet started, will not proceed, but items already in progress
+    // will complete, and the clear function will be called once all in
+    // progress items finish.
+    self.pause = function () {
+        s.running = false;
+    };
+    // Submit a function that will be called each time there are no more
+    // work items to process. Multiple calls to this method will replace
+    // the previously registered clear function.
+    self.clear = function (done) {
+        s.clear = done;
+        return self;
+    };
+    // Returns `true` when there are no more work items to process.
+    self.isclear = function () {
+        return 0 === q.length && 0 === progress.history.length;
+    };
+    // Add a work item. This is an object with fields:
+    //   * `fn` (function): the function that performs the work. Takes a
+    //     single argument, the callback function to call when the work is
+    //     complete. THis callback does **not** accept errors or
+    //     results. It's only purpose is to indicate that the work is
+    //     complete (whether failed or not). The work function itself must
+    //     handle callbacks to the application. Required.
+    //   * `id` (string): identifier for the work item. Optional.
+    //   * `tm` (integer): millisecond timeout specific to this work item,
+    //     overrides general timeout. Optional.
+    //   * `ontm` (function): callback to indicate work item timeout. Optional.
+    //   * `dn` (string): description of the work item, used in the
+    //     state description. Optional.
+    self.add = function (work) {
+        s.work_counter += 1;
+        work.id = work.id || '' + s.work_counter;
+        work.ge = self.id;
+        work.tm = null == work.tm ? options.timeout : work.tm;
+        work.dn = work.dn || work.fn.name || '' + Date.now();
+        // Used by calling code to store additional context.
+        work.ctxt = {};
+        q.push(work);
+        if (s.running) {
+            // Work items are **not** processed in the current execution path!
+            // This prevents lockup, and avoids false positives in unit tests.
+            // Work items are assumed to be inherently asynchronous.
+            setImmediate(processor);
+        }
+        return self;
+    };
+    // Create a new gate. Returns a new `GateExecutor` instance.  All
+    // work items added to the new instance must complete before the
+    // gate is cleared, and work items in the queue can be processed.  A
+    // gate is cleared when the new instance is **first** cleared. Work
+    // items subsequently added to the new instance are not considered
+    // part of the gate. Gates can extend to any depth and form a tree
+    // structure that requires breadth-first traversal in terms of the
+    // work item queue. Gates do not have timeouts, and can only be
+    // cleared when all added work items complete.
+    self.gate = function () {
+        let ge = GateExecutor(options, instance_counter);
+        let fn = function gate(done) {
+            // This is the work function of the gate, which starts the new
+            // instance, and considers the gate work item complete when the
+            // work queue clears for the first time.
+            ge.start(done);
+        };
+        self.add({ gate: ge, fn: fn });
+        return ge;
+    };
+    // Return a data structure describing the current state of the work
+    // queues, and organised as a tree structure indicating the gating
+    // relationships.
+    self.state = function () {
+        let out = [];
+        // First list any in-progress work items.
+        for (let hI = 0; hI < progress.history.length; ++hI) {
+            let pe = progress.history[hI];
+            if (!pe.done) {
+                out.push({ s: 'a', ge: pe.ge, dn: pe.dn, id: pe.id });
+            }
+        }
+        // Then list any waiting work items.
+        for (let qI = 0; qI < q.length; ++qI) {
+            let qe = q[qI];
+            if (qe.gate) {
+                // Go down a level when there's a gate.
+                out.push(qe.gate.state());
+            }
+            else {
+                out.push({ s: 'w', ge: qe.ge, dn: qe.dn, id: qe.id });
+            }
+        }
+        out.internal = {
+            qlen: q.length,
+            hlen: progress.history.length,
+            klen: Object.keys(progress.lookup).length,
+            tlen: timeout_check.length,
+            hw_hst: s.hw_hst,
+            hw_tmc: s.hw_tmc,
+        };
+        return out;
+    };
+    return self;
 }
-
 // The module function
-module.exports = make_GateExecutor
+exports.default = MakeGateExecutor;
+if (undefined != typeof (module.exports)) {
+    module.exports = MakeGateExecutor;
+}
+//# sourceMappingURL=gate-executor.js.map

package/gate-executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gate-executor.js","sourceRoot":"","sources":["gate-executor.ts"],"names":[],"mappings":";AAAA,yDAAyD;;AAkBzD,4CAA4C;AAC5C,+DAA+D;AAC/D,EAAE;AACF,mBAAmB;AACnB,mFAAmF;AACnF,uDAAuD;AACvD,8DAA8D;AAC9D,SAAS,gBAAgB,CAAC,OAAa;IACrC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;IACvB,OAAO,CAAC,QAAQ,GAAG,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAA;IACpE,OAAO,CAAC,OAAO,GAAG,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAA;IAElE,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;AACjC,CAAC;AAED,yBAAyB;AACzB,+DAA+D;AAC/D,uEAAuE;AACvE,0BAA0B;AAC1B,SAAS,YAAY,CAAY,OAAY,EAAE,gBAAwB;IACrE,IAAI,IAAI,GAAQ,EAAE,CAAA;IAElB,IAAI,CAAC,EAAE,GAAG,EAAE,gBAAgB,CAAA;IAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IAEtB,cAAc;IACd,IAAI,CAAC,GAAW,EAAE,CAAA;IAElB,wBAAwB;IACxB,IAAI,QAAQ,GAAQ;QAClB,qBAAqB;QACrB,MAAM,EAAE,EAAE;QAEV,6DAA6D;QAC7D,OAAO,EAAE,EAAE;KACZ,CAAA;IAED,4CAA4C;IAC5C,IAAI,iBAAiB,GAAU,EAAE,CAAA;IAEjC,kBAAkB;IAClB,IAAI,CAAC,GAAQ;QACX,iFAAiF;QACjF,YAAY,EAAE,CAAC;QAEf,yEAAyE;QACzE,sDAAsD;QACtD,IAAI,EAAE,KAAK;QAEX,iEAAiE;QACjE,2EAA2E;QAC3E,8BAA8B;QAC9B,OAAO,EAAE,KAAK;QAEd,iEAAiE;QACjE,gEAAgE;QAChE,gCAAgC;QAChC,KAAK,EAAE,IAAI;QAEX,sDAAsD;QACtD,kEAAkE;QAClE,8CAA8C;QAC9C,UAAU,EAAE,IAAI;QAEhB,8DAA8D;QAC9D,6DAA6D;QAC7D,uEAAuE;QACvE,KAAK,EAAE,IAAI;QAEX,MAAM,EAAE,CAAC;QACT,MAAM,EAAE,CAAC;KAEV,CAAA;IAID,8BAA8B;IAC9B,SAAS,SAAS;QAChB,gDAAgD;QAChD,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YACf,OAAM;QACR,CAAC;QAED,oEAAoE;QACpE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAChC,CAAC,CAAC,KAAK,GAAG,WAAW,CAAC,aAAa,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;QACxD,CAAC;QAED,iEAAiE;QACjE,IAAI,IAAI,GAAG,KAAK,CAAA;QAChB,GAAG,CAAC;YACF,IAAI,GAAG,KAAK,CAAA;YACZ,IAAI,IAAI,GAAG,IAAI,CAAA;YAEf,0DAA0D;YAC1D,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBACZ,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA;YAClB,CAAC;YAED,IAAI,IAAI,EAAE,CAAC;gBACT,6CAA6C;gBAC7C,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAA;gBAC/B,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAE3B,CAAC,CAAC,MAAM;oBACN,QAAQ,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;gBAEzE,2DAA2D;gBAC3D,4DAA4D;gBAC5D,4CAA4C;gBAC5C,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;gBAElB,0DAA0D;gBAC1D,qDAAqD;gBACrD,wDAAwD;gBACxD,6DAA6D;gBAC7D,0BAA0B;gBAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;gBACvB,IAAI,CAAC,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAA;gBAE3C,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAC5B,CAAC,CAAC,MAAM;oBACN,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;gBAE3E,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;gBAEtB,IAAI,GAAG,IAAI,CAAA;YACb,CAAC;QACH,CAAC,QAAQ,IAAI,EAAC;QACd,uEAAuE;IACzE,CAAC;IAED,4CAA4C;IAC5C,SAAS,qBAAqB,CAAC,IAAS;QACtC,OAAO,SAAS,gBAAgB;YAC9B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,OAAM;YACR,CAAC;YAED,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAErB,0DAA0D;YAC1D,0DAA0D;YAC1D,iDAAiD;YACjD,qDAAqD;YACrD,uCAAuC;YACvC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAE/B,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBACvD,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;YAC1B,CAAC;YAED,OAAO,iBAAiB,CAAC,CAAC,CAAC,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBACzD,iBAAiB,CAAC,KAAK,EAAE,CAAA;YAC3B,CAAC;YAED,2DAA2D;YAC3D,4DAA4D;YAC5D,yBAAyB;YACzB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,CAAC,CAAC,IAAI,GAAG,KAAK,CAAA;YAChB,CAAC;YAED,yDAAyD;YACzD,uCAAuC;YACvC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;gBACpD,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;gBACtB,CAAC,CAAC,KAAK,GAAG,IAAI,CAAA;gBAEd,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;oBACjB,IAAI,EAAE,GAAG,CAAC,CAAC,UAAU,CAAA;oBACrB,CAAC,CAAC,UAAU,GAAG,IAAI,CAAA;oBACnB,EAAE,EAAE,CAAA;gBACN,CAAC;gBAED,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;oBACZ,CAAC,CAAC,KAAK,EAAE,CAAA;gBACX,CAAC;YACH,CAAC;YAED,wDAAwD;YACxD,YAAY,CAAC,SAAS,CAAC,CAAA;QACzB,CAAC,CAAA;IACH,CAAC;IAED,oEAAoE;IACpE,oEAAoE;IACpE,oEAAoE;IACpE,2DAA2D;IAC3D,gEAAgE;IAChE,mEAAmE;IACnE,2CAA2C;IAC3C,SAAS,aAAa;QACpB,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACpB,IAAI,IAAI,GAAG,IAAI,CAAA;QAEf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAClD,IAAI,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;YAE3B,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC3D,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACd,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;gBACrC,CAAC;gBAED,IAAI,CAAC,QAAQ,EAAE,CAAA;YACjB,CAAC;QACH,CAAC;IACH,CAAC;IAED,mEAAmE;IACnE,6DAA6D;IAC7D,mEAAmE;IACnE,0DAA0D;IAC1D,IAAI,CAAC,KAAK,GAAG,UAAS,UAAe;QACnC,gEAAgE;QAChE,YAAY,CAAC;YACX,CAAC,CAAC,OAAO,GAAG,IAAI,CAAA;YAEhB,IAAI,UAAU,EAAE,CAAC;gBACf,CAAC,CAAC,UAAU,GAAG,UAAU,CAAA;YAC3B,CAAC;YAED,SAAS,EAAE,CAAA;QACb,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED,mEAAmE;IACnE,mEAAmE;IACnE,mEAAmE;IACnE,yBAAyB;IACzB,IAAI,CAAC,KAAK,GAAG;QACX,CAAC,CAAC,OAAO,GAAG,KAAK,CAAA;IACnB,CAAC,CAAA;IAED,oEAAoE;IACpE,oEAAoE;IACpE,4CAA4C;IAC5C,IAAI,CAAC,KAAK,GAAG,UAAS,IAAS;QAC7B,CAAC,CAAC,KAAK,GAAG,IAAI,CAAA;QACd,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED,+DAA+D;IAC/D,IAAI,CAAC,OAAO,GAAG;QACb,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAA;IACxD,CAAC,CAAA;IAED,kDAAkD;IAClD,oEAAoE;IACpE,sEAAsE;IACtE,4DAA4D;IAC5D,iEAAiE;IACjE,sEAAsE;IACtE,qDAAqD;IACrD,6DAA6D;IAC7D,sEAAsE;IACtE,2CAA2C;IAC3C,2EAA2E;IAC3E,+DAA+D;IAC/D,mCAAmC;IACnC,IAAI,CAAC,GAAG,GAAG,UAAS,IAAU;QAC5B,CAAC,CAAC,YAAY,IAAI,CAAC,CAAA;QACnB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,YAAY,CAAA;QACxC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;QACjB,IAAI,CAAC,EAAE,GAAG,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAA;QAErD,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAEpD,oDAAoD;QACpD,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QAEd,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEZ,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;YACd,kEAAkE;YAClE,kEAAkE;YAClE,wDAAwD;YACxD,YAAY,CAAC,SAAS,CAAC,CAAA;QACzB,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED,iEAAiE;IACjE,gEAAgE;IAChE,oEAAoE;IACpE,mEAAmE;IACnE,kEAAkE;IAClE,kEAAkE;IAClE,kEAAkE;IAClE,+DAA+D;IAC/D,8CAA8C;IAC9C,IAAI,CAAC,IAAI,GAAG;QACV,IAAI,EAAE,GAAQ,YAAY,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;QAErD,IAAI,EAAE,GAAG,SAAS,IAAI,CAAC,IAAS;YAC9B,8DAA8D;YAC9D,+DAA+D;YAC/D,wCAAwC;YACxC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAChB,CAAC,CAAA;QAED,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;QAE9B,OAAO,EAAE,CAAA;IACX,CAAC,CAAA;IAED,mEAAmE;IACnE,kEAAkE;IAClE,iBAAiB;IACjB,IAAI,CAAC,KAAK,GAAG;QACX,IAAI,GAAG,GAAQ,EAAE,CAAA;QAEjB,yCAAyC;QACzC,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC;YACpD,IAAI,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAC7B,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;gBACb,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;YACvD,CAAC;QACH,CAAC;QAED,oCAAoC;QACpC,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC;YACrC,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAA;YACd,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;gBACZ,uCAAuC;gBACvC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;YAC3B,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;YACvD,CAAC;QACH,CAAC;QAED,GAAG,CAAC,QAAQ,GAAG;YACb,IAAI,EAAE,CAAC,CAAC,MAAM;YACd,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM;YAC7B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM;YACzC,IAAI,EAAE,aAAa,CAAC,MAAM;YAC1B,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,MAAM,EAAE,CAAC,CAAC,MAAM;SACjB,CAAA;QAED,OAAO,GAAG,CAAA;IACZ,CAAC,CAAA;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,sBAAsB;AACtB,kBAAe,gBAAgB,CAAA;AAE/B,IAAI,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACzC,MAAM,CAAC,OAAO,GAAG,gBAAgB,CAAA;AACnC,CAAC"}

package/gate-executor.min.js

@@ -0,0 +1 @@
+!function(t){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=t();else if("function"==typeof define&&define.amd)define([],t);else{("undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this).GateExecutor=t()}}((function(){var t,e,n,r,i=(t=function(t,e){(function(t,n){(function(){var r=o.nextTick,i=(Function.prototype.apply,Array.prototype.slice),l={},u=0;function c(t,e){this._id=t,this._clearFn=e}c.prototype.unref=c.prototype.ref=function(){},c.prototype.close=function(){this._clearFn.call(window,this._id)},e.setImmediate="function"==typeof t?t:function(t){var n=u++,o=!(arguments.length<2)&&i.call(arguments,1);return l[n]=!0,r((function(){l[n]&&(o?t.apply(null,o):t.call(null),e.clearImmediate(n))})),n},e.clearImmediate="function"==typeof n?n:function(t){delete l[t]}}).call(this)}).call(this,i({}).setImmediate,i({}).clearImmediate)},function(n){return e||t(e={exports:{},parent:n},e.exports),e.exports}),o={},l=o={};function u(){throw new Error("setTimeout has not been defined")}function c(){throw new Error("clearTimeout has not been defined")}function a(t){if(n===setTimeout)return setTimeout(t,0);if((n===u||!n)&&setTimeout)return n=setTimeout,setTimeout(t,0);try{return n(t,0)}catch(e){try{return n.call(null,t,0)}catch(e){return n.call(this,t,0)}}}!function(){try{n="function"==typeof setTimeout?setTimeout:u}catch(e){n=u}try{r="function"==typeof clearTimeout?clearTimeout:c}catch(e){r=c}}();var s,f=[],h=!1,d=-1;function p(){h&&s&&(h=!1,s.length?f=s.concat(f):d=-1,f.length&&m())}function m(){if(!h){var t=a(p);h=!0;for(var n=f.length;n;){for(s=f,f=[];++d<n;)s&&s[d].run();d=-1,n=f.length}s=null,h=!1,function(t){if(r===clearTimeout)return clearTimeout(t);if((r===c||!r)&&clearTimeout)return r=clearTimeout,clearTimeout(t);try{r(t)}catch(e){try{return r.call(null,t)}catch(e){return r.call(this,t)}}}(t)}}function g(t,e){this.fun=t,this.array=e}function y(){}l.nextTick=function(t){var e=new Array(arguments.length-1);if(arguments.length>1)for(var n=1;n<arguments.length;n++)e[n-1]=arguments[n];f.push(new g(t,e)),1!==f.length||h||a(m)},g.prototype.run=function(){this.fun.apply(null,this.array)},l.title="browser",l.browser=!0,l.env={},l.argv=[],l.version="",l.versions={},l.on=y,l.addListener=y,l.once=y,l.off=y,l.removeListener=y,l.removeAllListeners=y,l.emit=y,l.prependListener=y,l.prependOnceListener=y,l.listeners=function(t){return[]},l.binding=function(t){throw new Error("process.binding is not supported")},l.cwd=function(){return"/"},l.chdir=function(t){throw new Error("process.chdir is not supported")},l.umask=function(){return 0};var w={};return function(t){(function(){"use strict";function e(e){return(e=e||{}).interval=null==e.interval?111:e.interval,e.timeout=null==e.timeout?2222:e.timeout,function e(n,r){let i={};i.id=++r,i.options=n;let o=[],l={lookup:{},history:[]},u=[],c={work_counter:0,gate:!1,running:!1,clear:null,firstclear:null,tm_in:null,hw_tmc:0,hw_hst:0};function a(){if(!c.running)return;i.isclear()||c.tm_in||(c.tm_in=setInterval(f,n.interval));let t=!1;do{t=!1;let e=null;c.gate||(e=o.shift()),e&&(l.lookup[e.id]=e,l.history.push(e),c.hw_hst=l.history.length>c.hw_hst?l.history.length:c.hw_hst,c.gate=e.gate,e.start=Date.now(),e.callback=s(e),u.push(e),c.hw_tmc=u.length>c.hw_tmc?u.length:c.hw_tmc,e.fn(e.callback),t=!0)}while(t)}function s(e){return function(){if(!e.done){for(e.end=Date.now(),e.done=!0,delete l.lookup[e.id];l.history[0]&&l.history[0].done;)l.history.shift();for(;u[0]&&u[0].done;)u.shift();if(e.gate&&(c.gate=!1),0===o.length&&0===l.history.length){if(clearInterval(c.tm_in),c.tm_in=null,c.firstclear){let t=c.firstclear;c.firstclear=null,t()}c.clear&&c.clear()}t(a)}}}function f(){let t=Date.now(),e=null;for(let n=0;n<u.length;++n)e=u[n],!e.gate&&!e.done&&e.tm<t-e.start&&(e.ontm&&e.ontm(e.tm,e.start,t),e.callback())}return i.start=function(e){return t((function(){c.running=!0,e&&(c.firstclear=e),a()})),i},i.pause=function(){c.running=!1},i.clear=function(t){return c.clear=t,i},i.isclear=function(){return 0===o.length&&0===l.history.length},i.add=function(e){return c.work_counter+=1,e.id=e.id||""+c.work_counter,e.ge=i.id,e.tm=null==e.tm?n.timeout:e.tm,e.dn=e.dn||e.fn.name||""+Date.now(),e.ctxt={},o.push(e),c.running&&t(a),i},i.gate=function(){let t=e(n,r);return i.add({gate:t,fn:function(e){t.start(e)}}),t},i.state=function(){let t=[];for(let e=0;e<l.history.length;++e){let n=l.history[e];n.done||t.push({s:"a",ge:n.ge,dn:n.dn,id:n.id})}for(let e=0;e<o.length;++e){let n=o[e];n.gate?t.push(n.gate.state()):t.push({s:"w",ge:n.ge,dn:n.dn,id:n.id})}return t.internal={qlen:o.length,hlen:l.history.length,klen:Object.keys(l.lookup).length,tlen:f.length,hw_hst:c.hw_hst,hw_tmc:c.hw_tmc},t},i}(e,0)}Object.defineProperty(w,"__esModule",{value:!0}),w.default=e,null!=typeof w&&(w=e)}).call(this)}.call(this,i({}).setImmediate),w}));

package/gate-executor.ts

@@ -0,0 +1,374 @@
+/* Copyright (c) 2014-2021 Richard Rodger, MIT License */
+
+
+type Work = {
+  id: string // Identifier
+  ge: string // GateExecutor identifier
+  tm: number // Timeout
+  dn: string // Description
+  fn: (callback: () => void) => void
+  start: number
+  end: number
+  gate?: any
+  callback: () => void
+  ctxt: { [key: string]: any }
+}
+
+
+
+// Create root instance. Exported as module.
+//   * `options` (object): instance options as key-value pairs.
+//
+// The options are:
+//   * `interval` (integer): millisecond interval for timeout checks. Default: 111.
+//   * `timeout` (integer): common millisecond timeout.
+//      Can be overridden by work item options. Default: 2222.
+function MakeGateExecutor(options?: any) {
+  options = options || {}
+  options.interval = null == options.interval ? 111 : options.interval
+  options.timeout = null == options.timeout ? 2222 : options.timeout
+
+  return GateExecutor(options, 0)
+}
+
+// Create a new instance.
+//   * `options` (object): instance options as key-value pairs.
+//   * `instance_counter` (integer): count number of instances created;
+//     used as identifier.
+function GateExecutor(this: any, options: any, instance_counter: number) {
+  let self: any = {}
+
+  self.id = ++instance_counter
+  self.options = options
+
+  // Work queue.
+  let q: Work[] = []
+
+  // Work-in-progress set.
+  let progress: any = {
+    // Lookup work by id.
+    lookup: {},
+
+    // Work history - a list of work items in the order executed.
+    history: [],
+  }
+
+  // List of work items to check for timeouts.
+  let timeout_checklist: any[] = []
+
+  // Internal state.
+  let s: any = {
+    // Count of work items added to this instance. Used as generated work identifier.
+    work_counter: 0,
+
+    // When `true`, the instance is in a gated state, and work cannot proceed
+    // until the gated in-progress work item is completed.
+    gate: false,
+
+    // When `true`, the instance processes work items as they arrive.
+    // When `false`, no processing happens, and the instance must be started by
+    // calling the `start` method.
+    running: false,
+
+    // A function called when the work queue and work-in-progress set
+    // are empty.  Set by calling the `clear` method. Will be called
+    // each time the instance empty.
+    clear: null,
+
+    // A function called once only when the work queue and
+    // work-in-progress set are first emptied after each start. Set as
+    // an optional argument to the `start` method.
+    firstclear: null,
+
+    // Timeout interval reference value returned by `setInterval`.
+    // Timeouts are not checked using `setTimeout`, as it is more
+    // efficient, and more than sufficient, to check timeouts periodically.
+    tm_in: null,
+
+    hw_tmc: 0,
+    hw_hst: 0,
+
+  }
+
+
+
+  // Process the next work item.
+  function processor() {
+    // If not running, don't process any work items.
+    if (!s.running) {
+      return
+    }
+
+    // The timeout interval check is stopped and started only as needed.
+    if (!self.isclear() && !s.tm_in) {
+      s.tm_in = setInterval(timeout_check, options.interval)
+    }
+
+    // Process the next work item, returning `true` if there was one.
+    let next = false
+    do {
+      next = false
+      let work = null
+
+      // Remove next work item from the front of the work queue.
+      if (!s.gate) {
+        work = q.shift()
+      }
+
+      if (work) {
+        // Add work item to the work-in-progress set.
+        progress.lookup[work.id] = work
+        progress.history.push(work)
+
+        s.hw_hst =
+          progress.history.length > s.hw_hst ? progress.history.length : s.hw_hst
+
+        // If work item is a gate, set the state of the instance as
+        // gated.  This work item will need to complete before later
+        // work items in the queue can be processed.
+        s.gate = work.gate
+
+        // Call the work item function (which does the real work),
+        // passing a callback. This callback has no arguments
+        // (including no error!).  It is called only to indicate
+        // completion of the work item.  Work items must handle their
+        // own errors and results.
+        work.start = Date.now()
+        work.callback = make_work_fn_callback(work)
+
+        timeout_checklist.push(work)
+        s.hw_tmc =
+          timeout_checklist.length > s.hw_tmc ? timeout_checklist.length : s.hw_tmc
+
+        work.fn(work.callback)
+
+        next = true
+      }
+    } while (next)
+    // Keep processing work items until none are left or a gate is reached.
+  }
+
+  // Create the callback for the work function
+  function make_work_fn_callback(work: any) {
+    return function work_fn_callback() {
+      if (work.done) {
+        return
+      }
+
+      work.end = Date.now()
+
+      // Remove the work item from the work-in-progress set.  As
+      // work items may complete out of order, prune the history
+      // from the front until the first incomplete work
+      // item. Later complete work items will eventually be
+      // reached on another processing round.
+      work.done = true
+      delete progress.lookup[work.id]
+
+      while (progress.history[0] && progress.history[0].done) {
+        progress.history.shift()
+      }
+
+      while (timeout_checklist[0] && timeout_checklist[0].done) {
+        timeout_checklist.shift()
+      }
+
+      // If the work item was a gate, it is now complete, and the
+      // instance can be ungated, allowing later work items in the
+      // queue to be processed.
+      if (work.gate) {
+        s.gate = false
+      }
+
+      // If work queue and work-in-progress set are empty, then
+      // call the registered clear functions.
+      if (0 === q.length && 0 === progress.history.length) {
+        clearInterval(s.tm_in)
+        s.tm_in = null
+
+        if (s.firstclear) {
+          let fc = s.firstclear
+          s.firstclear = null
+          fc()
+        }
+
+        if (s.clear) {
+          s.clear()
+        }
+      }
+
+      // Process each work item on next tick to avoid lockups.
+      setImmediate(processor)
+    }
+  }
+
+  // To be run periodically via setInterval. For timed out work items,
+  // calls the done callback to allow work queue to proceed, and marks
+  // the work item as finished. Work items can receive notification of
+  // timeouts by providing an `ontm` callback property in the
+  // work definition object. Work items must handle timeout errors
+  // themselves, gate-executor cares only for the fact that a timeout
+  // happened, so it can continue processing.
+  function timeout_check() {
+    let now = Date.now()
+    let work = null
+
+    for (let i = 0; i < timeout_checklist.length; ++i) {
+      work = timeout_checklist[i]
+
+      if (!work.gate && !work.done && work.tm < now - work.start) {
+        if (work.ontm) {
+          work.ontm(work.tm, work.start, now)
+        }
+
+        work.callback()
+      }
+    }
+  }
+
+  // Start processing work items. Must be called to start processing.
+  // Can be called at anytime, interspersed with calls to other
+  // methods, including `add`. Takes a function as argument, which is
+  // called only once on the next time the queues are clear.
+  self.start = function(firstclear: any) {
+    // Allow API chaining by not starting in current execution path.
+    setImmediate(function() {
+      s.running = true
+
+      if (firstclear) {
+        s.firstclear = firstclear
+      }
+
+      processor()
+    })
+
+    return self
+  }
+
+  // Pause the processing of work items. Newly added items, and items
+  // not yet started, will not proceed, but items already in progress
+  // will complete, and the clear function will be called once all in
+  // progress items finish.
+  self.pause = function() {
+    s.running = false
+  }
+
+  // Submit a function that will be called each time there are no more
+  // work items to process. Multiple calls to this method will replace
+  // the previously registered clear function.
+  self.clear = function(done: any) {
+    s.clear = done
+    return self
+  }
+
+  // Returns `true` when there are no more work items to process.
+  self.isclear = function() {
+    return 0 === q.length && 0 === progress.history.length
+  }
+
+  // Add a work item. This is an object with fields:
+  //   * `fn` (function): the function that performs the work. Takes a
+  //     single argument, the callback function to call when the work is
+  //     complete. THis callback does **not** accept errors or
+  //     results. It's only purpose is to indicate that the work is
+  //     complete (whether failed or not). The work function itself must
+  //     handle callbacks to the application. Required.
+  //   * `id` (string): identifier for the work item. Optional.
+  //   * `tm` (integer): millisecond timeout specific to this work item,
+  //     overrides general timeout. Optional.
+  //   * `ontm` (function): callback to indicate work item timeout. Optional.
+  //   * `dn` (string): description of the work item, used in the
+  //     state description. Optional.
+  self.add = function(work: Work) {
+    s.work_counter += 1
+    work.id = work.id || '' + s.work_counter
+    work.ge = self.id
+    work.tm = null == work.tm ? options.timeout : work.tm
+
+    work.dn = work.dn || work.fn.name || '' + Date.now()
+
+    // Used by calling code to store additional context.
+    work.ctxt = {}
+
+    q.push(work)
+
+    if (s.running) {
+      // Work items are **not** processed in the current execution path!
+      // This prevents lockup, and avoids false positives in unit tests.
+      // Work items are assumed to be inherently asynchronous.
+      setImmediate(processor)
+    }
+
+    return self
+  }
+
+  // Create a new gate. Returns a new `GateExecutor` instance.  All
+  // work items added to the new instance must complete before the
+  // gate is cleared, and work items in the queue can be processed.  A
+  // gate is cleared when the new instance is **first** cleared. Work
+  // items subsequently added to the new instance are not considered
+  // part of the gate. Gates can extend to any depth and form a tree
+  // structure that requires breadth-first traversal in terms of the
+  // work item queue. Gates do not have timeouts, and can only be
+  // cleared when all added work items complete.
+  self.gate = function() {
+    let ge: any = GateExecutor(options, instance_counter)
+
+    let fn = function gate(done: any) {
+      // This is the work function of the gate, which starts the new
+      // instance, and considers the gate work item complete when the
+      // work queue clears for the first time.
+      ge.start(done)
+    }
+
+    self.add({ gate: ge, fn: fn })
+
+    return ge
+  }
+
+  // Return a data structure describing the current state of the work
+  // queues, and organised as a tree structure indicating the gating
+  // relationships.
+  self.state = function() {
+    let out: any = []
+
+    // First list any in-progress work items.
+    for (let hI = 0; hI < progress.history.length; ++hI) {
+      let pe = progress.history[hI]
+      if (!pe.done) {
+        out.push({ s: 'a', ge: pe.ge, dn: pe.dn, id: pe.id })
+      }
+    }
+
+    // Then list any waiting work items.
+    for (let qI = 0; qI < q.length; ++qI) {
+      let qe = q[qI]
+      if (qe.gate) {
+        // Go down a level when there's a gate.
+        out.push(qe.gate.state())
+      } else {
+        out.push({ s: 'w', ge: qe.ge, dn: qe.dn, id: qe.id })
+      }
+    }
+
+    out.internal = {
+      qlen: q.length,
+      hlen: progress.history.length,
+      klen: Object.keys(progress.lookup).length,
+      tlen: timeout_check.length,
+      hw_hst: s.hw_hst,
+      hw_tmc: s.hw_tmc,
+    }
+
+    return out
+  }
+
+  return self
+}
+
+// The module function
+export default MakeGateExecutor
+
+if (undefined != typeof (module.exports)) {
+  module.exports = MakeGateExecutor
+}

package/package.json

@@ -1,18 +1,22 @@
 {
   "name": "gate-executor",
-  "version": "3.0.0",
+  "version": "3.2.1",
   "description": "A work queue that can be gated, stopping to wait for sub-queues to complete.",
   "main": "gate-executor.js",
-  "browser": "dist/gate-executor.min.js",
+  "browser": "gate-executor.min.js",
+  "type": "commonjs",
+  "types": "gate-executor.d.ts",
   "scripts": {
-    "test": "lab -v -P test -t 100 --shuffle -L -I document -r console -o stdout -r html -o test/coverage.html",
-    "test-web": "browserify -o test-web/get.js -e test/gate-executor.test.js -s GateExecutor -im -i assert -i @hapi/lab && open test-web/index.html",
-    "build": "browserify -o dist/gate-executor.min.js -e gate-executor.js -s GateExecutor -im -i assert -i @hapi/lab -p tinyify",
-    "prettier": "prettier --write gate-executor.js",
-    "coveralls": "lab -s -P test -r lcov | coveralls",
-    "clean-npm": "rm -rf node_modules package-lock.json",
-    "repo-tag": "REPO_VERSION=`node -e \"console.log(require('./package').version)\"` && echo TAG: v$REPO_VERSION && git commit -a -m v$REPO_VERSION && git push && git tag v$REPO_VERSION && git push --tags",
-    "repo-publish": "npm run clean-npm && npm i --registry http://registry.npmjs.org && npm run prettier && npm test && npm run build && npm run test-web && npm run repo-tag && npm publish --access public --registry http://registry.npmjs.org"
+    "test": "jest --coverage --no-cache",
+    "test-some": "jest --no-cache -t",
+    "test-watch": "jest --coverage --watchAll",
+    "watch": "tsc -w -d",
+    "build": "tsc -d && cp gate-executor.js gate-executor.min.js && browserify -o gate-executor.min.js -e gate-executor.js -s @GateExecutor -im -i assert -p tinyify",
+    "reset": "npm run clean && npm i && npm run build && npm test",
+    "clean": "rm -rf node_modules yarn.lock package-lock.json",
+    "repo-tag": "REPO_VERSION=`node -e \"console.log(require('./package').version)\"` && echo TAG: v$REPO_VERSION && git commit -a -m v$REPO_VERSION && git push && git tag v$REPO_VERSION && git push --tags;",
+    "repo-publish": "npm run clean && npm i && npm run repo-publish-quick",
+    "repo-publish-quick": "npm run build && npm run test && npm run repo-tag && npm publish --access public --registry https://registry.npmjs.org "
   },
   "repository": {
     "type": "git",
@@ -26,13 +30,12 @@
   "files": [
     "LICENSE",
     "README.md",
-    "gate-executor.js",
-    "dist"
+    "gate-executor.*"
   ],
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=12.0.0"
   },
-  "author": "Richard Rodger (http://richardrodger.com)",
+  "author": "Richard Rodger (https://richardrodger.com)",
   "contributors": [
     "Jacob Pruitt (http://javascriptjake.com)",
     "Wyatt Preul (http://jsgeek.com)"
@@ -44,13 +47,14 @@
   "homepage": "https://github.com/senecajs/gate-executor",
   "dependencies": {},
   "devDependencies": {
-    "@hapi/code": "^8.0.2",
-    "@hapi/lab": "^23.0.0",
-    "browserify": "^16.5.2",
-    "coveralls": "^3.1.0",
-    "detective": "^5.2.0",
-    "prettier": "^2.1.0",
-    "tinyify": "^3.0.0",
-    "util.promisify": "^1.0.1"
+    "@types/jest": "^30.0.0",
+    "browserify": "^17.0.1",
+    "esbuild": "^0.27.1",
+    "esbuild-jest": "^0.5.0",
+    "jest": "^30.2.0",
+    "tinyify": "^4.0.0",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.9.3",
+    "util.promisify": "^1.1.3"
   }
 }

package/dist/gate-executor.min.js

@@ -1 +0,0 @@
-!function(t){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=t();else if("function"==typeof define&&define.amd)define([],t);else{("undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this).GateExecutor=t()}}((function(){var t={exports:{}};return function(e){!function(n){"object"==typeof t.exports?t.exports=n():("undefined"!=typeof window?window:void 0!==e?e:"undefined"!=typeof self?self:this).GateExecutor=n()}((function(){var t={exports:{}};return function(e){!function(n){"object"==typeof t.exports?t.exports=n():("undefined"!=typeof window?window:void 0!==e?e:"undefined"!=typeof self?self:this).GateExecutor=n()}((function(){var t={exports:{}};return function(e){!function(n){"object"==typeof t.exports?t.exports=n():("undefined"!=typeof window?window:void 0!==e?e:"undefined"!=typeof self?self:this).GateExecutor=n()}((function(){var t,e,n,o,i=(t=function(t,e){(function(t,n){var o=u.nextTick,i=(Function.prototype.apply,Array.prototype.slice),r={},f=0;function l(t,e){this._id=t,this._clearFn=e}l.prototype.unref=l.prototype.ref=function(){},l.prototype.close=function(){this._clearFn.call(window,this._id)},e.setImmediate="function"==typeof t?t:function(t){var n=f++,u=!(arguments.length<2)&&i.call(arguments,1);return r[n]=!0,o((function(){r[n]&&(u?t.apply(null,u):t.call(null),e.clearImmediate(n))})),n},e.clearImmediate="function"==typeof n?n:function(t){delete r[t]}}).call(this,i({}).setImmediate,i({}).clearImmediate)},function(n){return e||t(e={exports:{},parent:n},e.exports),e.exports}),r={},u={},f=u={};function l(){throw new Error("setTimeout has not been defined")}function c(){throw new Error("clearTimeout has not been defined")}function a(t){if(n===setTimeout)return setTimeout(t,0);if((n===l||!n)&&setTimeout)return n=setTimeout,setTimeout(t,0);try{return n(t,0)}catch(e){try{return n.call(null,t,0)}catch(e){return n.call(this,t,0)}}}!function(){try{n="function"==typeof setTimeout?setTimeout:l}catch(e){n=l}try{o="function"==typeof clearTimeout?clearTimeout:c}catch(e){o=c}}();var s,d=[],p=!1,h=-1;function y(){p&&s&&(p=!1,s.length?d=s.concat(d):h=-1,d.length&&m())}function m(){if(!p){var t=a(y);p=!0;for(var n=d.length;n;){for(s=d,d=[];++h<n;)s&&s[h].run();h=-1,n=d.length}s=null,p=!1,function(t){if(o===clearTimeout)return clearTimeout(t);if((o===c||!o)&&clearTimeout)return o=clearTimeout,clearTimeout(t);try{o(t)}catch(e){try{return o.call(null,t)}catch(e){return o.call(this,t)}}}(t)}}function w(t,e){this.fun=t,this.array=e}function g(){}f.nextTick=function(t){var e=new Array(arguments.length-1);if(arguments.length>1)for(var n=1;n<arguments.length;n++)e[n-1]=arguments[n];d.push(new w(t,e)),1!==d.length||p||a(m)},w.prototype.run=function(){this.fun.apply(null,this.array)},f.title="browser",f.browser=!0,f.env={},f.argv=[],f.version="",f.versions={},f.on=g,f.addListener=g,f.once=g,f.off=g,f.removeListener=g,f.removeAllListeners=g,f.emit=g,f.prependListener=g,f.prependOnceListener=g,f.listeners=function(t){return[]},f.binding=function(t){throw new Error("process.binding is not supported")},f.cwd=function(){return"/"},f.chdir=function(t){throw new Error("process.chdir is not supported")},f.umask=function(){return 0};var v={};return function(t){"use strict";function e(n,o){var i=this;r("object"==typeof n),r("number"==typeof o),i.id=++o,i.options=n;var u=[],f={lookup:{},history:[]},l=[],c={work_counter:0,gate:!1,running:!1,clear:null,firstclear:null,tm_in:null};function a(){if(c.running){i.isclear()||c.tm_in||(c.tm_in=setInterval(d,n.interval));do{var t=!1,e=null;c.gate||(e=u.shift()),e&&(r("object"==typeof e),r("string"==typeof e.id),r("function"==typeof e.fn),f.lookup[e.id]=e,f.history.push(e),c.gate=e.gate,e.start=Date.now(),e.callback=s(e),l.push(e),e.fn(e.callback),t=!0)}while(t)}}function s(e){return function(){if(!e.done){for(e.done=!0,delete f.lookup[e.id];f.history[0]&&f.history[0].done;)f.history.shift();for(;l[0]&&l[0].done;)l.shift();if(e.gate&&(c.gate=!1),0===u.length&&0===f.history.length){if(clearInterval(c.tm_in),c.tm_in=null,c.firstclear){var n=c.firstclear;c.firstclear=null,n()}c.clear&&c.clear()}t(a)}}}function d(){for(var t=Date.now(),e=null,n=0;n<l.length;++n)!(e=l[n]).gate&&!e.done&&e.tm<t-e.start&&(e.ontm&&e.ontm(e.tm,e.start,t),e.callback())}i.start=function(e){return r(null==e||"function"==typeof e),t((function(){c.running=!0,e&&(c.firstclear=e),a()})),i},i.pause=function(){c.running=!1},i.clear=function(t){return r("function"==typeof t),c.clear=t,i},i.isclear=function(){return 0===u.length&&0===f.history.length},i.add=function(e){return r("object"==typeof e),r("function"==typeof e.fn),r(null==e.id||"string"==typeof e.id),r(null==e.tm||"number"==typeof e.tm),r(null==e.dn||"string"==typeof e.dn),c.work_counter+=1,e.id=e.id||""+c.work_counter,e.ge=i.id,e.tm=null==e.tm?n.timeout:e.tm,e.dn=e.dn||e.fn.name||""+Date.now(),e.ctxt={},u.push(e),c.running&&t(a),i},i.gate=function(){var t=new e(n,o);return i.add({gate:t,fn:function(e){t.start(e)}}),t},i.state=function(){for(var t=[],e=0;e<f.history.length;++e){var n=f.history[e];n.done||t.push({s:"a",ge:n.ge,dn:n.dn,id:n.id})}for(var o=0;o<u.length;++o){var i=u[o];i.gate?t.push(i.gate.state()):t.push({s:"w",ge:i.ge,dn:i.dn,id:i.id})}return t.internal={qlen:u.length,hlen:f.history.length,klen:Object.keys(f.lookup).length,tlen:d.length},t}}r="function"==typeof r?r:function(){},v=function(t){return(t=t||{}).interval=null==t.interval?111:t.interval,t.timeout=null==t.timeout?2222:t.timeout,r("object"==typeof t),r("number"==typeof t.interval),r("number"==typeof t.timeout),r(0<t.interval),r(0<t.timeout),new e(t,0)}}.call(this,i({}).setImmediate),v}))}.call(this,void 0!==e?e:"undefined"!=typeof self?self:"undefined"!=typeof window?window:{}),t=t.exports}))}.call(this,void 0!==e?e:"undefined"!=typeof self?self:"undefined"!=typeof window?window:{}),t=t.exports}))}.call(this,"undefined"!=typeof global?global:"undefined"!=typeof self?self:"undefined"!=typeof window?window:{}),t=t.exports}));