# all files / red/runtime/ util.js

94.54% Statements 225/238
93.82% Branches 167/178
100% Functions 16/16
94.54% Lines 225/238
1 branch 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
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383

    1×
    1×

    1×
    56×

    1×
    4×
    1×
    3×
    1×
    2×
    1×

    1×

    1×
    4×
    1×
    3×
    1×
    2×
    1×

    3×

    1×

    16×
    16×
    16×
    16×
    16×
    16×
    2×
    2×

    16×
    2×
    2×

    16×

    1×
    587×
    587×
    369×

    218×
    5×

    213×
    213×
    213×
    2×

    211×
    160×
    10×

    150×
    92×
    12×

    138×

    51×
    51×
    51×
    1×

    50×
    2×

    2×

    48×
    17×

    31×
    31×
    31×
    1×

    30×

    61×
    61×
    6×

    24×

    1×

    101×
    101×
    1×

    100×
    100×
    100×
    100×
    100×
    100×
    100×
    463×
    463×
    418×
    17×
    2×

    15×
    15×
    15×
    401×
    50×
    1×

    49×
    38×
    38×
    1×

    37×

    49×
    1×

    48×
    3×

    45×
    351×
    36×
    1×

    35×
    28×

    35×
    1×

    34×
    1×

    33×
    33×
    315×
    28×
    1×

    27×
    20×
    20×
    19×

    1×

    26×
    26×
    287×
    1×

    45×
    13×
    1×

    12×

    12×
    1×
    11×
    1×

    10×
    10×

    84×
    3×

    81×
    70×

    81×

    1×
    38×
    38×
    4×

    38×
    38×
    38×
    50×
    49×

    37×

    1×
    28×
    26×

    28×
    12×

    28×
    28×
    28×
    28×
    28×
    28×
    31×
    31×
    28×
    18×
    10×
    7×
    5×

    2×

    7×

    3×

    3×

    3×
    2×
    2×
    1×

    1×

    2×

    1×

    25×
    25×
    5×
    1×

    4×

    20×

    1×
    12×
    1×
    11×
    1×
    10×
    1×
    9×
    1×
    8×
    1×
    7×

    7×
    1×
    6×
    1×
    5×
    1×
    4×
    4×

    1×
    7×
    7×
    2×

    7×
    1×

    7×
    7×

    1×
    5×
    5×
    1×

    5×

    1×
    26×
    26×
    26×
    26×

    13×

    26×
    26×

    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 clone = require("clone");
    var jsonata = require("jsonata");

    function generateId() {
        return (1+Math.random()*4294967295).toString(16);
    }

    function ensureString(o) {
        if (Buffer.isBuffer(o)) {
            return o.toString();
        } else if (typeof o === "object") {
            return JSON.stringify(o);
        } else if (typeof o === "string") {
            return o;
        }
        return ""+o;
    }

    function ensureBuffer(o) {
        if (Buffer.isBuffer(o)) {
            return o;
        } else if (typeof o === "object") {
            o = JSON.stringify(o);
        } else if (typeof o !== "string") {
            o = ""+o;
        }
        return new Buffer(o);
    }

    function cloneMessage(msg) {
        // Temporary fix for #97
        // TODO: remove this http-node-specific fix somehow
        var req = msg.req;
        var res = msg.res;
        delete msg.req;
        delete msg.res;
        var m = clone(msg);
        if (req) {
            m.req = req;
            msg.req = req;
        }
        if (res) {
            m.res = res;
            msg.res = res;
        }
        return m;
    }

    function compareObjects(obj1,obj2) {
        var i;
        if (obj1 === obj2) {
            return true;
        }
        if (obj1 == null || obj2 == null) {
            return false;
        }

        var isArray1 = Array.isArray(obj1);
        var isArray2 = Array.isArray(obj2);
        if (isArray1 != isArray2) {
            return false;
        }
        if (isArray1 && isArray2) {
            if (obj1.length !== obj2.length) {
                return false;
            }
            for (i=0;i<obj1.length;i++) {
                if (!compareObjects(obj1[i],obj2[i])) {
                    return false;
                }
            }
            return true;
        }
        var isBuffer1 = Buffer.isBuffer(obj1);
        var isBuffer2 = Buffer.isBuffer(obj2);
        if (isBuffer1 != isBuffer2) {
            return false;
        }
        if (isBuffer1 && isBuffer2) {
            Eif (obj1.equals) {
                // For node 0.12+ - use the native equals
                return obj1.equals(obj2);
            } else {
                if (obj1.length !== obj2.length) {
                    return false;
                }
                for (i=0;i<obj1.length;i++) {
                    if (obj1.readUInt8(i) !== obj2.readUInt8(i)) {
                        return false;
                    }
                }
                return true;
            }
        }

        if (typeof obj1 !== 'object' || typeof obj2 !== 'object') {
            return false;
        }
        var keys1 = Object.keys(obj1);
        var keys2 = Object.keys(obj2);
        if (keys1.length != keys2.length) {
            return false;
        }
        for (var k in obj1) {
            /* istanbul ignore else */
            Eif (obj1.hasOwnProperty(k)) {
                if (!compareObjects(obj1[k],obj2[k])) {
                    return false;
                }
            }
        }
        return true;
    }

    function normalisePropertyExpression(str) {
        // This must be kept in sync with validatePropertyExpression
        // in editor/js/ui/utils.js

        var length = str.length;
        if (length === 0) {
            throw new Error("Invalid property expression: zero-length");
        }
        var parts = [];
        var start = 0;
        var inString = false;
        var inBox = false;
        var quoteChar;
        var v;
        for (var i=0;i<length;i++) {
            var c = str[i];
            if (!inString) {
                if (c === "'" || c === '"') {
                    if (i != start) {
                        throw new Error("Invalid property expression: unexpected "+c+" at position "+i);
                    }
                    inString = true;
                    quoteChar = c;
                    start = i+1;
                } else if (c === '.') {
                    if (i===0) {
                        throw new Error("Invalid property expression: unexpected . at position 0");
                    }
                    if (start != i) {
                        v = str.substring(start,i);
                        if (/^\d+$/.test(v)) {
                            parts.push(parseInt(v));
                        } else {
                            parts.push(v);
                        }
                    }
                    if (i===length-1) {
                        throw new Error("Invalid property expression: unterminated expression");
                    }
                    // Next char is first char of an identifier: a-z 0-9 $ _
                    if (!/[a-z0-9\$\_]/i.test(str[i+1])) {
                        throw new Error("Invalid property expression: unexpected "+str[i+1]+" at position "+(i+1));
                    }
                    start = i+1;
                } else if (c === '[') {
                    if (i === 0) {
                        throw new Error("Invalid property expression: unexpected "+c+" at position "+i);
                    }
                    if (start != i) {
                        parts.push(str.substring(start,i));
                    }
                    if (i===length-1) {
                        throw new Error("Invalid property expression: unterminated expression");
                    }
                    // Next char is either a quote or a number
                    if (!/["'\d]/.test(str[i+1])) {
                        throw new Error("Invalid property expression: unexpected "+str[i+1]+" at position "+(i+1));
                    }
                    start = i+1;
                    inBox = true;
                } else if (c === ']') {
                    if (!inBox) {
                        throw new Error("Invalid property expression: unexpected "+c+" at position "+i);
                    }
                    if (start != i) {
                        v = str.substring(start,i);
                        if (/^\d+$/.test(v)) {
                            parts.push(parseInt(v));
                        } else {
                            throw new Error("Invalid property expression: unexpected array expression at position "+start);
                        }
                    }
                    start = i+1;
                    inBox = false;
                } else if (c === ' ') {
                    throw new Error("Invalid property expression: unexpected ' ' at position "+i);
                }
            } else {
                if (c === quoteChar) {
                    if (i-start === 0) {
                        throw new Error("Invalid property expression: zero-length string at position "+start);
                    }
                    parts.push(str.substring(start,i));
                    // If inBox, next char must be a ]. Otherwise it may be [ or .
                    if (inBox && !/\]/.test(str[i+1])) {
                        throw new Error("Invalid property expression: unexpected array expression at position "+start);
                    } else if (!inBox && i+1!==length && !/[\[\.]/.test(str[i+1])) {
                        throw new Error("Invalid property expression: unexpected "+str[i+1]+" expression at position "+(i+1));
                    }
                    start = i+1;
                    inString = false;
                }
            }

        }
        if (inBox || inString) {
            throw new Error("Invalid property expression: unterminated expression");
        }
        if (start < length) {
            parts.push(str.substring(start));
        }
        return parts;
    }

    function getMessageProperty(msg,expr) {
        var result = null;
        if (expr.indexOf('msg.')===0) {
            expr = expr.substring(4);
        }
        var msgPropParts = normalisePropertyExpression(expr);
        var m;
        msgPropParts.reduce(function(obj, key) {
            result = (typeof obj[key] !== "undefined" ? obj[key] : undefined);
            return result;
        }, msg);
        return result;
    }

    function setMessageProperty(msg,prop,value,createMissing) {
        if (typeof createMissing === 'undefined') {
            createMissing = (typeof value !== 'undefined');
        }
        if (prop.indexOf('msg.')===0) {
            prop = prop.substring(4);
        }
        var msgPropParts = normalisePropertyExpression(prop);
        var depth = 0;
        var length = msgPropParts.length;
        var obj = msg;
        var key;
        for (var i=0;i<length-1;i++) {
            key = msgPropParts[i];
            if (typeof key === 'string' || (typeof key === 'number' && !Array.isArray(obj))) {
                if (obj.hasOwnProperty(key)) {
                    obj = obj[key];
                } else if (createMissing) {
                    if (typeof msgPropParts[i+1] === 'string') {
                        obj[key] = {};
                    } else {
                        obj[key] = [];
                    }
                    obj = obj[key];
                } else {
                    return null;
                }
            } else Eif (typeof key === 'number') {
                // obj is an array
                if (obj[key] === undefined) {
                    Eif (createMissing) {
                        if (typeof msgPropParts[i+1] === 'string') {
                            obj[key] = {};
                        } else {
                            obj[key] = [];
                        }
                        obj = obj[key];
                    } else {
                        return null
                    }
                } else {
                    obj = obj[key];
                }
            }
        }
        key = msgPropParts[length-1];
        if (typeof value === "undefined") {
            if (typeof key === 'number' && Array.isArray(obj)) {
                obj.splice(key,1);
            } else {
                delete obj[key]
            }
        } else {
            obj[key] = value;
        }
    }

    function evaluateNodeProperty(value, type, node, msg) {
        if (type === 'str') {
            return ""+value;
        } else if (type === 'num') {
            return Number(value);
        } else if (type === 'json') {
            return JSON.parse(value);
        } else if (type === 're') {
            return new RegExp(value);
        } else if (type === 'date') {
            return Date.now();
        } else Iif (type === 'bin') {
            var data = JSON.parse(value);
            return Buffer.from(data);
        } else if (type === 'msg' && msg) {
            return getMessageProperty(msg,value);
        } else if (type === 'flow' && node) {
            return node.context().flow.get(value);
        } else if (type === 'global' && node) {
            return node.context().global.get(value);
        } else Eif (type === 'bool') {
            return /^true$/i.test(value);
        } else if (type === 'jsonata') {
            var expr = prepareJSONataExpression(value,node);
            return evaluateJSONataExpression(expr,msg);
        }
        return value;
    }

    function prepareJSONataExpression(value,node) {
        var expr = jsonata(value);
        expr.assign('flowContext',function(val) {
            return node.context().flow.get(val);
        });
        expr.assign('globalContext',function(val) {
            return node.context().global.get(val);
        });
        expr._legacyMode = /(^|[^a-zA-Z0-9_'"])msg([^a-zA-Z0-9_'"]|$)/.test(value);
        return expr;
    }

    function evaluateJSONataExpression(expr,msg) {
        var context = msg;
        if (expr._legacyMode) {
            context = {msg:msg};
        }
        return expr.evaluate(context);
    }

    function normaliseNodeTypeName(name) {
        var result = name.replace(/[^a-zA-Z0-9]/g, " ");
        result = result.trim();
        result = result.replace(/ +/g, " ");
        result = result.replace(/ ./g,
            function(s) {
                return s.charAt(1).toUpperCase();
            }
        );
        result = result.charAt(0).toLowerCase() + result.slice(1);
        return result;
    }

    module.exports = {
        ensureString: ensureString,
        ensureBuffer: ensureBuffer,
        cloneMessage: cloneMessage,
        compareObjects: compareObjects,
        generateId: generateId,
        getMessageProperty: getMessageProperty,
        setMessageProperty: setMessageProperty,
        evaluateNodeProperty: evaluateNodeProperty,
        normalisePropertyExpression: normalisePropertyExpression,
        normaliseNodeTypeName: normaliseNodeTypeName,
        prepareJSONataExpression: prepareJSONataExpression,
        evaluateJSONataExpression: evaluateJSONataExpression
    };