/** * 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. * @ignore **/ /** * @mixin @node-red/util_util */ const clonedeep = require("lodash.clonedeep"); const jsonata = require("jsonata"); const moment = require("moment-timezone"); const safeJSONStringify = require("json-stringify-safe"); const util = require("util"); /** * Generates a psuedo-unique-random id. * @return {String} a random-ish id * @memberof @node-red/util_util */ function generateId() { return (1+Math.random()*4294967295).toString(16); } /** * Converts the provided argument to a String, using type-dependent * methods. * * @param {any} o - the property to convert to a String * @return {String} the stringified version * @memberof @node-red/util_util */ 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; } /** * Converts the provided argument to a Buffer, using type-dependent * methods. * * @param {any} o - the property to convert to a Buffer * @return {String} the Buffer version * @memberof @node-red/util_util */ 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 Buffer.from(o); } /** * Safely clones a message object. This handles msg.req/msg.res objects that must * not be cloned. * * @param {any} msg - the message object to clone * @return {Object} the cloned message * @memberof @node-red/util_util */ function cloneMessage(msg) { if (typeof msg !== "undefined" && msg !== null) { // 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 = clonedeep(msg); if (req) { m.req = req; msg.req = req; } if (res) { m.res = res; msg.res = res; } return m; } return msg; } /** * Compares two objects, handling various JavaScript types. * * @param {any} obj1 * @param {any} obj2 * @return {boolean} whether the two objects are the same * @memberof @node-red/util_util */ 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 1 && ((typeof obj[key] !== "object" && typeof obj[key] !== "function") || obj[key] === null)) { // Break out early as we cannot create a property beneath // this type of value return false; } obj = obj[key]; } else if (createMissing) { if (typeof msgPropParts[i+1] === 'string') { obj[key] = {}; } else { obj[key] = []; } obj = obj[key]; } else { return false; } } else if (typeof key === 'number') { // obj is an array if (obj[key] === undefined) { if (createMissing) { if (typeof msgPropParts[i+1] === 'string') { obj[key] = {}; } else { obj[key] = []; } obj = obj[key]; } else { return false; } } 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 { if (typeof obj === "object" && obj !== null) { obj[key] = value; } else { // Cannot set a property of a non-object/array return false; } } return true; } /*! * Get value of environment variable. * @param {Node} node - accessing node * @param {String} name - name of variable * @return {String} value of env var */ function getSetting(node, name) { if (node && node._flow) { var flow = node._flow; if (flow) { return flow.getSetting(name); } } return process.env[name]; } /** * Checks if a String contains any Environment Variable specifiers and returns * it with their values substituted in place. * * For example, if the env var `WHO` is set to `Joe`, the string `Hello ${WHO}!` * will return `Hello Joe!`. * @param {String} value - the string to parse * @param {Node} node - the node evaluating the property * @return {String} The parsed string * @memberof @node-red/util_util */ function evaluateEnvProperty(value, node) { var result; if (/^\${[^}]+}$/.test(value)) { // ${ENV_VAR} var name = value.substring(2,value.length-1); result = getSetting(node, name); } else if (!/\${\S+}/.test(value)) { // ENV_VAR result = getSetting(node, value); } else { // FOO${ENV_VAR}BAR return value.replace(/\${([^}]+)}/g, function(match, name) { var val = getSetting(node, name); return (val === undefined)?"":val; }); } return (result === undefined)?"":result; } /** * Parses a context property string, as generated by the TypedInput, to extract * the store name if present. * * For example, `#:(file)::foo` results in ` { store: "file", key: "foo" }`. * * @param {String} key - the context property string to parse * @return {Object} The parsed property * @memberof @node-red/util_util */ function parseContextStore(key) { var parts = {}; var m = /^#:\((\S+?)\)::(.*)$/.exec(key); if (m) { parts.store = m[1]; parts.key = m[2]; } else { parts.key = key; } return parts; } /** * Evaluates a property value according to its type. * * @param {String} value - the raw value * @param {String} type - the type of the value * @param {Node} node - the node evaluating the property * @param {Object} msg - the message object to evaluate against * @param {Function} callback - (optional) called when the property is evaluated * @return {any} The evaluted property, if no `callback` is provided * @memberof @node-red/util_util */ function evaluateNodeProperty(value, type, node, msg, callback) { var result = value; if (type === 'str') { result = ""+value; } else if (type === 'num') { result = Number(value); } else if (type === 'json') { result = JSON.parse(value); } else if (type === 're') { result = new RegExp(value); } else if (type === 'date') { result = Date.now(); } else if (type === 'bin') { var data = JSON.parse(value); result = Buffer.from(data); } else if (type === 'msg' && msg) { try { result = getMessageProperty(msg,value); } catch(err) { if (callback) { callback(err); } else { throw err; } return; } } else if ((type === 'flow' || type === 'global') && node) { var contextKey = parseContextStore(value); result = node.context()[type].get(contextKey.key,contextKey.store,callback); if (callback) { return; } } else if (type === 'bool') { result = /^true$/i.test(value); } else if (type === 'jsonata') { var expr = prepareJSONataExpression(value,node); result = evaluateJSONataExpression(expr,msg); } else if (type === 'env') { result = evaluateEnvProperty(value, node); } if (callback) { callback(null,result); } else { return result; } } /** * Prepares a JSONata expression for evaluation. * This attaches Node-RED specific functions to the expression. * * @param {String} value - the JSONata expression * @param {Node} node - the node evaluating the property * @return {Object} The JSONata expression that can be evaluated * @memberof @node-red/util_util */ function prepareJSONataExpression(value,node) { var expr = jsonata(value); expr.assign('flowContext', function(val, store) { return node.context().flow.get(val, store); }); expr.assign('globalContext', function(val, store) { return node.context().global.get(val, store); }); expr.assign('env', function(name) { var val = getSetting(node, name); if (typeof val !== 'undefined') { return val; } else { return ""; } }); expr.assign('moment', function(arg1, arg2, arg3, arg4) { return moment(arg1, arg2, arg3, arg4); }); expr.registerFunction('clone', cloneMessage, '<(oa)-:o>'); expr._legacyMode = /(^|[^a-zA-Z0-9_'"])msg([^a-zA-Z0-9_'"]|$)/.test(value); expr._node = node; return expr; } /** * Evaluates a JSONata expression. * The expression must have been prepared with {@link @node-red/util-util.prepareJSONataExpression} * before passing to this function. * * @param {Object} expr - the prepared JSONata expression * @param {Object} msg - the message object to evaluate against * @param {Function} callback - (optional) called when the expression is evaluated * @return {any} If no callback was provided, the result of the expression * @memberof @node-red/util_util */ function evaluateJSONataExpression(expr,msg,callback) { var context = msg; if (expr._legacyMode) { context = {msg:msg}; } var bindings = {}; if (callback) { // If callback provided, need to override the pre-assigned sync // context functions to be their async variants bindings.flowContext = function(val, store) { return new Promise((resolve,reject) => { expr._node.context().flow.get(val, store, function(err,value) { if (err) { reject(err); } else { resolve(value); } }) }); } bindings.globalContext = function(val, store) { return new Promise((resolve,reject) => { expr._node.context().global.get(val, store, function(err,value) { if (err) { reject(err); } else { resolve(value); } }) }); } } return expr.evaluate(context, bindings, callback); } /** * Normalise a node type name to camel case. * * For example: `a-random node type` will normalise to `aRandomNodeType` * * @param {String} name - the node type * @return {String} The normalised name * @memberof @node-red/util_util */ 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; } /** * Encode an object to JSON without losing information about non-JSON types * such as Buffer and Function. * * *This function is closely tied to its reverse within the editor* * * @param {Object} msg * @param {Object} opts * @return {Object} the encoded object * @memberof @node-red/util_util */ function encodeObject(msg,opts) { try { var debuglength = 1000; if (opts && opts.hasOwnProperty('maxLength')) { debuglength = opts.maxLength; } var msgType = typeof msg.msg; if (msg.msg instanceof Error) { msg.format = "error"; var errorMsg = {}; if (msg.msg.name) { errorMsg.name = msg.msg.name; } if (msg.msg.hasOwnProperty('message')) { errorMsg.message = msg.msg.message; } else { errorMsg.message = msg.msg.toString(); } msg.msg = JSON.stringify(errorMsg); } else if (msg.msg instanceof Buffer) { msg.format = "buffer["+msg.msg.length+"]"; msg.msg = msg.msg.toString('hex'); if (msg.msg.length > debuglength) { msg.msg = msg.msg.substring(0,debuglength); } } else if (msg.msg && msgType === 'object') { try { msg.format = msg.msg.constructor.name || "Object"; // Handle special case of msg.req/res objects from HTTP In node if (msg.format === "IncomingMessage" || msg.format === "ServerResponse") { msg.format = "Object"; } } catch(err) { msg.format = "Object"; } if (/error/i.test(msg.format)) { msg.msg = JSON.stringify({ name: msg.msg.name, message: msg.msg.message }); } else { var isArray = util.isArray(msg.msg); if (isArray) { msg.format = "array["+msg.msg.length+"]"; if (msg.msg.length > debuglength) { // msg.msg = msg.msg.slice(0,debuglength); msg.msg = { __enc__: true, type: "array", data: msg.msg.slice(0,debuglength), length: msg.msg.length } } } if (isArray || (msg.format === "Object")) { msg.msg = safeJSONStringify(msg.msg, function(key, value) { if (key === '_req' || key === '_res') { value = { __enc__: true, type: "internal" } } else if (value instanceof Error) { value = value.toString() } else if (util.isArray(value) && value.length > debuglength) { value = { __enc__: true, type: "array", data: value.slice(0,debuglength), length: value.length } } else if (typeof value === 'string') { if (value.length > debuglength) { value = value.substring(0,debuglength)+"..."; } } else if (typeof value === 'function') { value = { __enc__: true, type: "function" } } else if (typeof value === 'number') { if (isNaN(value) || value === Infinity || value === -Infinity) { value = { __enc__: true, type: "number", data: value.toString() } } } else if (typeof value === 'bigint') { value = { __enc__: true, type: 'bigint', data: value.toString() } } else if (value && value.constructor) { if (value.type === "Buffer") { value.__enc__ = true; value.length = value.data.length; if (value.length > debuglength) { value.data = value.data.slice(0,debuglength); } } else if (value.constructor.name === "ServerResponse") { value = "[internal]" } else if (value.constructor.name === "Socket") { value = "[internal]" } } else if (value === undefined) { value = { __enc__: true, type: "undefined", } } return value; }," "); } else { try { msg.msg = msg.msg.toString(); } catch(e) { msg.msg = "[Type not printable]" + util.inspect(msg.msg); } } } } else if (msgType === "function") { msg.format = "function"; msg.msg = "[function]" } else if (msgType === "boolean") { msg.format = "boolean"; msg.msg = msg.msg.toString(); } else if (msgType === "number") { msg.format = "number"; msg.msg = msg.msg.toString(); } else if (msgType === "bigint") { msg.format = "bigint"; msg.msg = { __enc__: true, type: 'bigint', data: msg.msg.toString() }; } else if (msg.msg === null || msgType === "undefined") { msg.format = (msg.msg === null)?"null":"undefined"; msg.msg = "(undefined)"; } else { msg.format = "string["+msg.msg.length+"]"; if (msg.msg.length > debuglength) { msg.msg = msg.msg.substring(0,debuglength)+"..."; } } return msg; } catch(e) { msg.format = "error"; var errorMsg = {}; if (e.name) { errorMsg.name = e.name; } if (e.hasOwnProperty('message')) { errorMsg.message = 'encodeObject Error: ['+e.message + '] Value: '+util.inspect(msg.msg); } else { errorMsg.message = 'encodeObject Error: ['+e.toString() + '] Value: '+util.inspect(msg.msg); } if (errorMsg.message.length > debuglength) { errorMsg.message = errorMsg.message.substring(0,debuglength); } msg.msg = JSON.stringify(errorMsg); return msg; } } module.exports = { encodeObject: encodeObject, ensureString: ensureString, ensureBuffer: ensureBuffer, cloneMessage: cloneMessage, compareObjects: compareObjects, generateId: generateId, getMessageProperty: getMessageProperty, setMessageProperty: setMessageProperty, getObjectProperty: getObjectProperty, setObjectProperty: setObjectProperty, evaluateNodeProperty: evaluateNodeProperty, normalisePropertyExpression: normalisePropertyExpression, normaliseNodeTypeName: normaliseNodeTypeName, prepareJSONataExpression: prepareJSONataExpression, evaluateJSONataExpression: evaluateJSONataExpression, parseContextStore: parseContextStore };