abstractor/lib/nodes/queue.js

Node.js abstraction layer and automation framework.

/***********************************************************************************

    Abstractor | Queue | MIT License | ©2016 Hexagon <github.com/hexagon>

    Synchronous message queue. 

    Passes next message by emitting "item" when the previous has
    returned. Emits "drained" whenever queue becomes empty.

    The default is to process the queue synchronously, is is however possible to 
    allow concurrency by increasing "concurrency" option above the default of 1.

    ----------------------------------------------------------------------------


    Options

    ---------------------+-----------------+----------------------+-----------------
    Option               |  Type           |  Default             |  Mandatory
    ---------------------+-----------------+----------------------+-----------------
    concurrency          |  integer        |  1                   |  no
    ----------------------------------------------------------------------------


    I/O

    -------------------------------+----------------------+---------------------
    Incoming property              |  Possible triggers   |  Sets property
    -------------------------------+----------------------+---------------------
                                   |  started             |  payload
                                   |  item                |  payload
    payload: <array>               |  drained             |  <none>
                                   +----------------------+---------------------
                                   |  error               |  error
    -------------------------------+----------------------+---------------------


***********************************************************************************/
"use strict";

const
    Node = require("../node.js");

class Queue extends Node {

    constructor(parameters) {

        var defaults = {
            concurrency: 1
        };

        super(parameters, defaults);

        this.queue = [];
        this.concurrent = 0;
        this.started = false;

    }

    shift() {

        let self = this;

        // If there is work left to do, and not too many concurrent jobs
        // Start another
        if( this.queue && this.queue.length > 0 && this.concurrent < this.config.concurrency ) {

            // Immediately indicate that a new job is about to run
            this.concurrent++;

            // This seem to be the first message in this batch
            if (!this.started) {
                this.started = true;
                self.trigger( "started" ,  this.originalMsg );    
            }

            // ... and/but trigger the new job at the end of current event loop
            self.trigger( "item" , self.queue.shift() );

            // Indicate that we shifted a new job from the queue
            return true;

        } else {

            // Is the queue drained?
            if ( this.concurrent === 0 ) {
                this.started = false;
                self.trigger( "drained" , this.originalMsg );

            // Is the queue in a state of vacuum?
            } else if ( this.concurrent < 0 ) {
                self.log.warning(this.constructor.name,"Queue got callback while drained, a callback has probably been called twice.");
            }

            // Indicate that we couldn't shift a new job
            return false;

        }

    }

    push(msg) {

        var self = this;

        // Push message onto queue
        this.queue.push(msg);

        // Shift any enqueued messages
        setImmediate(function () { self.shift(); });

    }

    invoke(msg) {

        var self = this;

        // Has the message been here before? If so, this call is a callback from a done job
        if ( this.traceback( msg ) ) {
            
            // Start another job, if there is any
            setImmediate(function () { 

                // Reduce concurrency counter
                self.concurrent--;
                self.shift(); 

            });

        // Fresh message
        } else {

            // Put the job on queue
            this.push(msg);

        }
    }
}

module.exports = Queue;