# all files / red/runtime/nodes/ Node.js

95.33% Statements 143/150
84.15% Branches 69/82
84.21% Functions 16/19
95.33% Lines 143/150
2 branches Ignored

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286

    1×
    1×
    1×

    1×
    1×
    1×
    1×

    1×
    150×
    150×
    150×
    150×

    150×
    15×

    150×
    22×

    150×

    1×

    1×

    154×
    154×

    154×
    154×
    71×

    154×
    154×

    88×

    66×
    66×

    60×

    1×

    1×

    1×
    229×
    229×
    104×

    125×

    1×

    106×
    106×
    106×
    97×
    97×
    34×

    34×
    34×
    1×

    34×
    34×

    63×

    106×
    33×
    33×

    73×

    73×

    1×
    25×
    25×

    25×
    1×
    24×
    21×

    18×
    1×

    18×
    18×

    18×
    18×

    18×

    3×

    6×

    6×

    6×

    6×
    9×

    9×
    9×
    9×
    8×
    7×

    8×

    8×
    12×
    12×

    11×
    12×
    12×

    12×
    11×

    12×
    6×
    6×

    6×
    6×

    6×
    5×

    6×

    6×
    12×

    12×
    10×

    12×

    1×
    54×
    2×

    54×
    24×

    54×
    54×
    54×

    1×

    1×
    6×

    6×
    1×

    6×

    1×
    2×

    1×
    1×

    1×
    3×
    3×

    3×
    3×
    2×

    3×
    3×

    1×

    1×

    1×
    81×
    1×

    80×
    80×
    80×
    80×
    80×
    80×
    80×

    1×
    1×

    1×
     /**
     * Copyright JS Foundation and other contributors, http://js.foundation
     *
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     * http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     **/

    var util = require("util");
    var EventEmitter = require("events").EventEmitter;
    var when = require("when");

    var redUtil = require("../util");
    var Log = require("../log");
    var context = require("./context");
    var flows = require("./flows");

    function Node(n) {
        this.id = n.id;
        this.type = n.type;
        this.z = n.z;
        this._closeCallbacks = [];

        if (n.name) {
            this.name = n.name;
        }
        if (n._alias) {
            this._alias = n._alias;
        }
        this.updateWires(n.wires);
    }

    util.inherits(Node, EventEmitter);

    Node.prototype.updateWires = function(wires) {
        //console.log("UPDATE",this.id);
        this.wires = wires || [];
        delete this._wire;

        var wc = 0;
        this.wires.forEach(function(w) {
            wc+=w.length;
        });
        this._wireCount = wc;
        if (wc === 0) {
            // With nothing wired to the node, no-op send
            this.send = function(msg) {}
        } else {
            this.send = Node.prototype.send;
            if (this.wires.length === 1 && this.wires[0].length === 1) {
                // Single wire, so we can shortcut the send when
                // a single message is sent
                this._wire = this.wires[0][0];
            }
        }

    }
    Node.prototype.context = function() {
        if (!this._context) {
            this._context = context.get(this._alias||this.id,this.z);
        }
        return this._context;
    }

    Node.prototype._on = Node.prototype.on;

    Node.prototype.on = function(event, callback) {
        var node = this;
        if (event == "close") {
            this._closeCallbacks.push(callback);
        } else {
            this._on(event, callback);
        }
    };

    Node.prototype.close = function(removed) {
        //console.log(this.type,this.id,removed);
        var promises = [];
        var node = this;
        for (var i=0;i<this._closeCallbacks.length;i++) {
            var callback = this._closeCallbacks[i];
            if (callback.length > 0) {
                promises.push(
                    when.promise(function(resolve) {
                        var args = [];
                        if (callback.length === 2) {
                            args.push(!!removed);
                        }
                        args.push(resolve);
                        callback.apply(node, args);
                    })
                );
            } else {
                callback.call(node);
            }
        }
        if (promises.length > 0) {
            return when.settle(promises).then(function() {
                Iif (this._context) {
                     context.delete(this._alias||this.id,this.z);
                }
            });
        } else {
            Iif (this._context) {
                 context.delete(this._alias||this.id,this.z);
            }
            return;
        }
    };

    Node.prototype.send = function(msg) {
        var msgSent = false;
        var node;

        if (msg === null || typeof msg === "undefined") {
            return;
        } else if (!util.isArray(msg)) {
            if (this._wire) {
                // A single message and a single wire on output 0
                // TODO: pre-load flows.get calls - cannot do in constructor
                //       as not all nodes are defined at that point
                if (!msg._msgid) {
                    msg._msgid = redUtil.generateId();
                }
                this.metric("send",msg);
                node = flows.get(this._wire);
                /* istanbul ignore else */
                Eif (node) {
                    node.receive(msg);
                }
                return;
            } else {
                msg = [msg];
            }
        }

        var numOutputs = this.wires.length;

        // Build a list of send events so that all cloning is done before
        // any calls to node.receive
        var sendEvents = [];

        var sentMessageId = null;

        // for each output of node eg. [msgs to output 0, msgs to output 1, ...]
        for (var i = 0; i < numOutputs; i++) {
            var wires = this.wires[i]; // wires leaving output i
            /* istanbul ignore else */
            Eif (i < msg.length) {
                var msgs = msg[i]; // msgs going to output i
                if (msgs !== null && typeof msgs !== "undefined") {
                    if (!util.isArray(msgs)) {
                        msgs = [msgs];
                    }
                    var k = 0;
                    // for each recipent node of that output
                    for (var j = 0; j < wires.length; j++) {
                        node = flows.get(wires[j]); // node at end of wire j
                        if (node) {
                            // for each msg to send eg. [[m1, m2, ...], ...]
                            for (k = 0; k < msgs.length; k++) {
                                var m = msgs[k];
                                Eif (m !== null && m !== undefined) {
                                    /* istanbul ignore else */
                                    if (!sentMessageId) {
                                        sentMessageId = m._msgid;
                                    }
                                    if (msgSent) {
                                        var clonedmsg = redUtil.cloneMessage(m);
                                        sendEvents.push({n:node,m:clonedmsg});
                                    } else {
                                        sendEvents.push({n:node,m:m});
                                        msgSent = true;
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
        /* istanbul ignore else */
        if (!sentMessageId) {
            sentMessageId = redUtil.generateId();
        }
        this.metric("send",{_msgid:sentMessageId});

        for (i=0;i<sendEvents.length;i++) {
            var ev = sendEvents[i];
            /* istanbul ignore else */
            if (!ev.m._msgid) {
                ev.m._msgid = sentMessageId;
            }
            ev.n.receive(ev.m);
        }
    };

    Node.prototype.receive = function(msg) {
        if (!msg) {
            msg = {};
        }
        if (!msg._msgid) {
            msg._msgid = redUtil.generateId();
        }
        this.metric("receive",msg);
        try {
            this.emit("input", msg);
        } catch(err) {
            this.error(err,msg);
        }
    };

    function log_helper(self, level, msg) {
        var o = {
            level: level,
            id: self.id,
            type: self.type,
            msg: msg
        };
        if (self.name) {
            o.name = self.name;
        }
        Log.log(o);
    }

    Node.prototype.log = function(msg) {
        log_helper(this, Log.INFO, msg);
    };

    Node.prototype.warn = function(msg) {
        log_helper(this, Log.WARN, msg);
    };

    Node.prototype.error = function(logMessage,msg) {
        Eif (typeof logMessage != 'boolean') {
            logMessage = logMessage || "";
        }
        var handled = false;
        if (msg) {
            handled = flows.handleError(this,logMessage,msg);
        }
        Eif (!handled) {
            log_helper(this, Log.ERROR, logMessage);
        }
    };

    Node.prototype.debug = function(msg) {
        log_helper(this, Log.DEBUG, msg);
    }

    Node.prototype.trace = function(msg) {
        log_helper(this, Log.TRACE, msg);
    }

    /**
     * If called with no args, returns whether metric collection is enabled
     */
    Node.prototype.metric = function(eventname, msg, metricValue) {
        if (typeof eventname === "undefined") {
            return Log.metric();
        }
        var metrics = {};
        metrics.level = Log.METRIC;
        metrics.nodeid = this.id;
        metrics.event = "node."+this.type+"."+eventname;
        metrics.msgid = msg._msgid;
        metrics.value = metricValue;
        Log.log(metrics);
    }

    /**
     * status: { fill:"red|green", shape:"dot|ring", text:"blah" }
     */
    Node.prototype.status = function(status) {
        flows.handleStatus(this,status);
    };
    module.exports = Node;