Haraka 3.1.1 → 3.1.2

package/logger.js

@@ -1,305 +1,287 @@
-'use strict';
+'use strict'
 // Log class
 
-const util      = require('node:util');
-const tty       = require('node:tty');
+const util = require('node:util')
+const tty = require('node:tty')
 
-const config    = require('haraka-config');
-const constants = require('haraka-constants');
+const config = require('haraka-config')
+const constants = require('haraka-constants')
 
-let plugins;
+let plugins
 
-const regex = /(^$|[ ="\\])/;
-const escape_replace_regex = /["\\]/g;
+const regex = /(^$|[ ="\\])/
+const escape_replace_regex = /["\\]/g
 
-function stringify (obj) {
-    let str = '';
-    let key;
+function stringify(obj) {
+    let str = ''
+    let key
     for (key in obj) {
-        let v = obj[key];
+        let v = obj[key]
         if (v == null) {
-            str += `${key}="" `;
-            continue;
+            str += `${key}="" `
+            continue
         }
-        v = v.toString();
+        v = v.toString()
         if (regex.test(v)) {
-            str += `${key}="${v.replace(escape_replace_regex, '\\$&')}" `;
-        }
-        else {
-            str += `${key}=${v} `;
+            str += `${key}="${v.replace(escape_replace_regex, '\\$&')}" `
+        } else {
+            str += `${key}=${v} `
         }
     }
-    return str.trim();
+    return str.trim()
 }
 
-const logger = exports;
+const logger = exports
 
 logger.levels = {
-    DATA:     9,
+    DATA: 9,
     PROTOCOL: 8,
-    DEBUG:    7,
-    INFO:     6,
-    NOTICE:   5,
-    WARN:     4,
-    ERROR:    3,
-    CRIT:     2,
-    ALERT:    1,
-    EMERG:    0,
+    DEBUG: 7,
+    INFO: 6,
+    NOTICE: 5,
+    WARN: 4,
+    ERROR: 3,
+    CRIT: 2,
+    ALERT: 1,
+    EMERG: 0,
 }
 const level_names = Object.keys(logger.levels)
 
 for (const le in logger.levels) {
-    logger.levels[`LOG${le}`] = logger.levels[le];
-    logger[`LOG${le}`] = logger.levels[le];
+    logger.levels[`LOG${le}`] = logger.levels[le]
+    logger[`LOG${le}`] = logger.levels[le]
 }
 
 logger.formats = {
-    DEFAULT: "DEFAULT",
-    LOGFMT: "LOGFMT",
-    JSON: "JSON",
+    DEFAULT: 'DEFAULT',
+    LOGFMT: 'LOGFMT',
+    JSON: 'JSON',
 }
 
-logger.loglevel      = logger.levels.WARN;
-logger.format        = logger.formats.DEFAULT;
-logger.timestamps    = false;
-logger.deferred_logs = [];
-logger.name          = 'logger'
+logger.loglevel = logger.levels.WARN
+logger.format = logger.formats.DEFAULT
+logger.timestamps = false
+logger.deferred_logs = []
+logger.name = 'logger'
 
 logger.colors = {
-    "DATA" : "green",
-    "PROTOCOL" : "green",
-    "DEBUG" : "grey",
-    "INFO" : "cyan",
-    "NOTICE" : "blue",
-    "WARN" : "red",
-    "ERROR" : "red",
-    "CRIT" : "red",
-    "ALERT" : "red",
-    "EMERG" : "red",
+    DATA: 'green',
+    PROTOCOL: 'green',
+    DEBUG: 'grey',
+    INFO: 'cyan',
+    NOTICE: 'blue',
+    WARN: 'red',
+    ERROR: 'red',
+    CRIT: 'red',
+    ALERT: 'red',
+    EMERG: 'red',
 }
 
-const stdout_is_tty = tty.isatty(process.stdout.fd);
+const stdout_is_tty = tty.isatty(process.stdout.fd)
 
 logger._init = function () {
-    this.load_log_ini();
-    this._init_loglevel();
-    this._init_timestamps();
+    this.load_log_ini()
+    this._init_loglevel()
+    this._init_timestamps()
 }
 
 logger.load_log_ini = function () {
-    this.cfg = config.get('log.ini', {
-        booleans: [
-            '+main.timestamps',
-        ]
-    },
-    () => {
-        this.load_log_ini();
-    });
-
-    this.set_loglevel(this.cfg.main.level);
-    this.set_timestamps(this.cfg.main.timestamps);
-    this.set_format(this.cfg.main.format);
+    this.cfg = config.get(
+        'log.ini',
+        {
+            booleans: ['+main.timestamps'],
+        },
+        () => {
+            this.load_log_ini()
+        },
+    )
+
+    this.set_loglevel(this.cfg.main.level)
+    this.set_timestamps(this.cfg.main.timestamps)
+    this.set_format(this.cfg.main.format)
 }
 
 logger.colorize = (color, str) => {
-    if (!util.inspect.colors[color]) { return str; }  // unknown color
-    return `\u001b[${util.inspect.colors[color][0]}m${str}\u001b[${util.inspect.colors[color][1]}m`;
+    if (!util.inspect.colors[color]) {
+        return str
+    } // unknown color
+    return `\u001b[${util.inspect.colors[color][0]}m${str}\u001b[${util.inspect.colors[color][1]}m`
 }
 
-logger.dump_logs = cb => {
+logger.dump_logs = (cb) => {
     while (logger.deferred_logs.length > 0) {
-        const log_item = logger.deferred_logs.shift();
-        plugins.run_hooks('log', logger, log_item);
+        const log_item = logger.deferred_logs.shift()
+        plugins.run_hooks('log', logger, log_item)
     }
     // Run callback after flush
-    if (cb) process.stdout.write('', cb);
-    return true;
+    if (cb) process.stdout.write('', cb)
+    return true
 }
 
 logger.dump_and_exit = function (code) {
     this.dump_logs(() => {
-        if (typeof code === 'function') return code();
-        process.exit(code);
-    });
+        if (typeof code === 'function') return code()
+        process.exit(code)
+    })
 }
 
 logger.log = (level, data, logobj) => {
     if (level === 'PROTOCOL') {
-        data = data.replace(/\n/g, '\\n');
+        data = data.replace(/\n/g, '\\n')
     }
-    data = data.replace(/\r/g, '\\r').replace(/\n$/, '');
+    data = data.replace(/\r/g, '\\r').replace(/\n$/, '')
 
-    const item = { level, data, obj: logobj};
+    const item = { level, data, obj: logobj }
 
     // buffer until plugins are loaded
-    const emptyPluginList = !plugins || Array.isArray(plugins.plugin_list) && !plugins.plugin_list.length;
+    const emptyPluginList = !plugins || (Array.isArray(plugins.plugin_list) && !plugins.plugin_list.length)
     if (emptyPluginList) {
-        logger.deferred_logs.push(item);
-        return true;
+        logger.deferred_logs.push(item)
+        return true
     }
 
     // process buffered logs
     while (logger.deferred_logs.length > 0) {
-        const log_item = logger.deferred_logs.shift();
-        plugins.run_hooks('log', logger, log_item);
+        const log_item = logger.deferred_logs.shift()
+        plugins.run_hooks('log', logger, log_item)
     }
 
-    plugins.run_hooks('log', logger, item);
-    return true;
+    plugins.run_hooks('log', logger, item)
+    return true
 }
 
 logger.log_respond = (retval, msg, data) => {
     // any other return code is irrelevant
-    if (retval !== constants.cont) return false;
+    if (retval !== constants.cont) return false
 
-    let timestamp_string = '';
-    if (logger.timestamps) timestamp_string = `${new Date().toISOString()} `;
+    let timestamp_string = ''
+    if (logger.timestamps) timestamp_string = `${new Date().toISOString()} `
 
-    const color = logger.colors[data.level];
+    const color = logger.colors[data.level]
     if (color && stdout_is_tty) {
-        process.stdout.write(`${timestamp_string}${logger.colorize(color,data.data)}\n`);
-    }
-    else {
-        process.stdout.write(`${timestamp_string}${data.data}\n`);
+        process.stdout.write(`${timestamp_string}${logger.colorize(color, data.data)}\n`)
+    } else {
+        process.stdout.write(`${timestamp_string}${data.data}\n`)
     }
 
-    return true;
+    return true
 }
 
 logger.set_loglevel = function (level) {
-    if (level === undefined || level === null) return;
+    if (level === undefined || level === null) return
 
-    const loglevel_num = parseInt(level);
+    const loglevel_num = parseInt(level)
     if (typeof level === 'string') {
-        this.log('INFO', `loglevel: ${level.toUpperCase()}`);
-        logger.loglevel = logger.levels[level.toUpperCase()];
-    }
-    else {
-        logger.loglevel = loglevel_num;
+        this.log('INFO', `loglevel: ${level.toUpperCase()}`)
+        logger.loglevel = logger.levels[level.toUpperCase()]
+    } else {
+        logger.loglevel = loglevel_num
     }
 
     if (!Number.isInteger(logger.loglevel)) {
-        this.log('WARN', `invalid loglevel: ${level} defaulting to LOGWARN`);
-        logger.loglevel = logger.levels.WARN;
+        this.log('WARN', `invalid loglevel: ${level} defaulting to LOGWARN`)
+        logger.loglevel = logger.levels.WARN
     }
 }
 
 logger.set_format = function (format) {
     if (format) {
-        logger.format = logger.formats[format.toUpperCase()];
-        this.log('INFO', `log format: ${format.toUpperCase()}`);
-    }
-    else {
-        logger.format = null;
+        logger.format = logger.formats[format.toUpperCase()]
+        this.log('INFO', `log format: ${format.toUpperCase()}`)
+    } else {
+        logger.format = null
     }
     if (!logger.format) {
-        this.log('WARN', `invalid log format: ${format} defaulting to DEFAULT`);
-        logger.format = logger.formats.DEFAULT;
+        this.log('WARN', `invalid log format: ${format} defaulting to DEFAULT`)
+        logger.format = logger.formats.DEFAULT
     }
 }
 
 logger._init_loglevel = function () {
-
     const _loglevel = config.get('loglevel', 'value', () => {
-        this._init_loglevel();
-    });
+        this._init_loglevel()
+    })
 
-    this.set_loglevel(_loglevel);
+    this.set_loglevel(_loglevel)
 }
 
-logger.would_log = level => {
-    if (logger.loglevel < level) return false;
-    return true;
+logger.would_log = (level) => {
+    if (logger.loglevel < level) return false
+    return true
 }
 
-logger.set_timestamps = value => {
-    logger.timestamps = !!value;
+logger.set_timestamps = (value) => {
+    logger.timestamps = !!value
 }
 
 logger._init_timestamps = function () {
-
     const _timestamps = config.get('log_timestamps', 'value', () => {
-        this._init_timestamps();
-    });
+        this._init_timestamps()
+    })
 
     // If we've already been toggled to true by the cfg, we should respect this.
-    this.set_timestamps(logger.timestamps || _timestamps);
+    this.set_timestamps(logger.timestamps || _timestamps)
 }
 
-logger._init();
-
-logger.log_if_level = (level, key, origin) => function () {
-    if (logger.loglevel < logger[key]) return;
+logger._init()
 
-    let logobj = {
-        level,
-        uuid: '-',
-        origin: (origin || 'core'),
-        message: ''
-    };
+logger.log_if_level = (level, key, origin) =>
+    function () {
+        if (logger.loglevel < logger[key]) return
 
-    for (const data of arguments) {
-        if (typeof data !== 'object') {
-            logobj.message += (data);
-            continue;
+        let logobj = {
+            level,
+            uuid: '-',
+            origin: origin || 'core',
+            message: '',
         }
-        if (!data) continue;
 
-        // if the object is a connection, add the connection id
-        if (data.constructor?.name === 'Connection') {
-            logobj.uuid = data.uuid;
-            if (data.tran_count > 0) logobj.uuid += `.${data.tran_count}`;
-        }
-        else if (data instanceof plugins.Plugin) {
-            logobj.origin = data.name;
-        }
-        else if (Object.hasOwn(data, 'name')) { // outbound
-            logobj.origin = data.name;
-            if (Object.hasOwn(data, 'uuid')) logobj.uuid = data.uuid;
-            if (data.todo?.uuid) logobj.uuid = data.todo.uuid; // outbound/hmail
-        }
-        else if (
-            logger.format === logger.formats.LOGFMT && data.constructor === Object) {
-            logobj = Object.assign(logobj, data);
-        }
-        else if (
-            logger.format === logger.formats.JSON && data.constructor === Object) {
-            logobj = Object.assign(logobj, data);
-        }
-        else if (Object.hasOwn(data, 'uuid')) { // outbound/client_pool
-            logobj.uuid = data.uuid;
-        }
-        else if (data.constructor === Object) {
-            if (!logobj.message.endsWith(' ')) logobj.message += ' ';
-            logobj.message += (stringify(data));
-        }
-        else {
-            logobj.message += (util.inspect(data));
+        for (const data of arguments) {
+            if (typeof data !== 'object') {
+                logobj.message += data
+                continue
+            }
+            if (!data) continue
+
+            // if the object is a connection, add the connection id
+            if (data.constructor?.name === 'Connection') {
+                logobj.uuid = data.uuid
+                if (data.tran_count > 0) logobj.uuid += `.${data.tran_count}`
+            } else if (data instanceof plugins.Plugin) {
+                logobj.origin = data.name
+            } else if (Object.hasOwn(data, 'name')) {
+                // outbound
+                logobj.origin = data.name
+                if (Object.hasOwn(data, 'uuid')) logobj.uuid = data.uuid
+                if (data.todo?.uuid) logobj.uuid = data.todo.uuid // outbound/hmail
+            } else if (logger.format === logger.formats.LOGFMT && data.constructor === Object) {
+                logobj = Object.assign(logobj, data)
+            } else if (logger.format === logger.formats.JSON && data.constructor === Object) {
+                logobj = Object.assign(logobj, data)
+            } else if (Object.hasOwn(data, 'uuid')) {
+                // outbound/client_pool
+                logobj.uuid = data.uuid
+            } else if (data.constructor === Object) {
+                if (!logobj.message.endsWith(' ')) logobj.message += ' '
+                logobj.message += stringify(data)
+            } else {
+                logobj.message += util.inspect(data)
+            }
         }
-    }
 
-    switch (logger.format) {
-        case logger.formats.LOGFMT:
-            logger.log(
-                level,
-                stringify(logobj)
-            );
-            break
-        case logger.formats.JSON:
-            logger.log(
-                level,
-                JSON.stringify(logobj)
-            );
-            break
-        case logger.formats.DEFAULT:
-        default:
-            logger.log(
-                level,
-                `[${logobj.level}] [${logobj.uuid}] [${logobj.origin}] ${logobj.message}`
-            );
+        switch (logger.format) {
+            case logger.formats.LOGFMT:
+                logger.log(level, stringify(logobj))
+                break
+            case logger.formats.JSON:
+                logger.log(level, JSON.stringify(logobj))
+                break
+            case logger.formats.DEFAULT:
+            default:
+                logger.log(level, `[${logobj.level}] [${logobj.uuid}] [${logobj.origin}] ${logobj.message}`)
+        }
+        return true
     }
-    return true;
-}
 
 logger.add_log_methods = (object, logName) => {
     if (!object) return
@@ -307,15 +289,14 @@ logger.add_log_methods = (object, logName) => {
     if (typeof object === 'function') {
         // add logging methods to class prototypes (Connection, Plugin, etc.)
 
-        for (const level of level_names.map(l => l.toLowerCase())) {
+        for (const level of level_names.map((l) => l.toLowerCase())) {
             object.prototype[`log${level}`] = (function (level) {
                 return function () {
-                    logger[level].apply(logger, [ this, ...arguments ]);
-                };
-            })(`log${level}`);
+                    logger[level].apply(logger, [this, ...arguments])
+                }
+            })(`log${level}`)
         }
-    }
-    else if (typeof object === 'object') {
+    } else if (typeof object === 'object') {
         // add logging methods to objects
 
         for (const level of level_names) {
@@ -328,14 +309,14 @@ logger.add_log_methods = (object, logName) => {
             }
 
             for (const fnName of fnNames) {
-                if (Object.hasOwn(object, fnName)) continue; // already added
-                object[fnName] = logger.log_if_level(level, `LOG${level}`, logName);
+                if (Object.hasOwn(object, fnName)) continue // already added
+                object[fnName] = logger.log_if_level(level, `LOG${level}`, logName)
             }
         }
     }
 }
 
-logger.add_log_methods(logger);
+logger.add_log_methods(logger)
 
 // load these down here so it sees all the logger methods compiled above
-plugins = require('./plugins');
+plugins = require('./plugins')

package/outbound/client_pool.js

@@ -1,59 +1,59 @@
-'use strict';
+'use strict'
 
-const util = require('node:util');
+const util = require('node:util')
 
-const utils = require('haraka-utils');
+const utils = require('haraka-utils')
 const net_utils = require('haraka-net-utils')
 
-const tls_socket = require('../tls_socket');
-const logger = require('../logger');
-const obc  = require('./config');
+const tls_socket = require('../tls_socket')
+const logger = require('../logger')
+const obc = require('./config')
 
 exports.name = 'outbound'
 
 // Get a socket for the given attributes.
 exports.get_client = function (mx, callback) {
-    const socketArgs = mx.path ? { path: mx.path } : { port: mx.port, host: mx.exchange, localAddress: mx.bind };
+    const socketArgs = mx.path ? { path: mx.path } : { port: mx.port, host: mx.exchange, localAddress: mx.bind }
 
-    const socket = tls_socket.connect(socketArgs);
-    net_utils.add_line_processor(socket);
+    const socket = tls_socket.connect(socketArgs)
+    net_utils.add_line_processor(socket)
 
-    socket.name = `outbound::${JSON.stringify(socketArgs)}`;
-    socket.__uuid = utils.uuid();
-    socket.setTimeout(obc.cfg.connect_timeout * 1000);
+    socket.name = `outbound::${JSON.stringify(socketArgs)}`
+    socket.__uuid = utils.uuid()
+    socket.setTimeout(obc.cfg.connect_timeout * 1000)
 
-    logger.debug(exports, `created ${socket.name}`, { uuid: socket.__uuid });
+    logger.debug(exports, `created ${socket.name}`, { uuid: socket.__uuid })
 
     socket.once('connect', () => {
-        socket.removeAllListeners('error'); // these get added after callback
-        socket.removeAllListeners('timeout');
-        callback(null, socket);
+        socket.removeAllListeners('error') // these get added after callback
+        socket.removeAllListeners('timeout')
+        callback(null, socket)
     })
 
-    socket.once('error', err => {
-        socket.end();
-        socket.removeAllListeners();
-        socket.destroy();
-        const errMsg = err.message ?
-            err.message :
-            err instanceof AggregateError ?
-                err.map(e => e.message).join(', ') :
-                util.inspect(err, { depth: 3 });
-        callback(errMsg, null);
+    socket.once('error', (err) => {
+        socket.end()
+        socket.removeAllListeners()
+        socket.destroy()
+        const errMsg = err.message
+            ? err.message
+            : err instanceof AggregateError
+              ? err.map((e) => e.message).join(', ')
+              : util.inspect(err, { depth: 3 })
+        callback(errMsg, null)
     })
 
     socket.once('timeout', () => {
-        socket.end();
-        socket.removeAllListeners();
-        socket.destroy();
-        callback(`connection timed out to ${socket.name}`, null);
+        socket.end()
+        socket.removeAllListeners()
+        socket.destroy()
+        callback(`connection timed out to ${socket.name}`, null)
     })
 }
 
 exports.release_client = (socket, mx) => {
     let logMsg = `release_client: ${socket.name}`
     if (mx.bind) logMsg += ` from ${mx.bind}`
-    logger.debug(exports, logMsg);
-    socket.removeAllListeners();
-    socket.destroy();
+    logger.debug(exports, logMsg)
+    socket.removeAllListeners()
+    socket.destroy()
 }