dcp-worker 4.1.1 → 4.2.0

package/lib/startWorkerLogger.js

@@ -1,138 +0,0 @@
-/**
- *  @file       startWorkerLogger.js
- *              Start the DCP Worker logging subsystem. Sets console.log (etc) redirection, determine
- *              the correct log target (screen, TUI, syslog, windows event log, file) and redirect the
- *              output there.
- *  @author     Ryan Rossiter, ryan@kingsds.network
- *  @date       April 2020
- *  @author     Wes Garland, wes@distributive.network
- */
-'use strict';
-
-const process = require('process');
-const os = require('os');
-const util = require('util');
-
-/**
- * Detects and returns the appropriate logger for the environment
- * @param {object} options - cliArgs from worker
- * @returns {WorkerLogger}
- */
-function getLogger(options)
-{
-  if (options.outputMode === 'detect')
-  {
-    options.outputMode = 'console';
-    /* have TTY - use dashboard when charset supports line drawing */
-    if ((process.env.LANG && process.env.LANG.match(/utf-|latin-|iso-8859-/i)) || os.platform() === 'win32')
-      options.outputMode = 'dashboard';
-  }
-
-  try
-  {
-    const om = require('path').basename(options.outputMode);
-    return require('./worker-loggers/' + om);
-  }
-  catch (error)
-  {
-    if (error.code === 'MODULE_NOT_FOUND')
-    {
-      const errorMessageStart = error.message.replace(/\n.*/g, '');
-      error.message = `Unknown outputMode "${options.outputMode} (${errorMessageStart})`;
-    }
-    throw error;
-  }
-}
-
-/**
- * Start intercepting console.* methods so that log output from the worker goes to the appropriate log
- * target; eg syslog, file, windows event log, etc. Unlike the telnet console log interceptor which is
- * merely a passthrough shim, this is a "dead end" interceptor - we do not pass the log message through
-  * to the original console method.  This implies, for example, that sending console messages to syslogd
- * quiesces the tty output.
- *
- * @param {object} options - cliArgs from worker
- */
-exports.init = function startWorkerLogger$$init(options)
-{
-  const logger = getLogger(options);
-
-  logger.init(options);
-
-  /* The logger module's exports are its API. The following functions are supported, in this order
-   * of severity:
-   * . debug: debug-level message
-   * . info:  informational message
-   * . log:   normal, but significant, condition
-   * . warn:  warning conditions
-   * . error: error conditions
-   *
-   * Additionally, generic functions may be used when one of the above is not defined:
-   * . at:    write a log message at a specific log level; the level is the first argument
-   * . raw:   same as at, but arguments are not formatted
-   * . any:   write a log message without regard to log level
-   *
-   * All of these functions, with the exception of raw, receive only string arguments.
-   */
-
-  for (let level of ['debug', 'error', 'info', 'log', 'warn'])
-  {
-    if (logger[level])
-      console[level] = (...args) => logger[level](          ...format(...args));
-    else if (logger.at)
-      console[level] = (...args) => logger.at(level,        ...format(...args));
-    else if (logger.raw)
-      console[level] = (...args) => logger.raw(level,       ...args);
-    else if (logger.any)
-      console[level] = (...args) => logger.any(`${level}:`, format(...args));
-    else
-    {
-      require('./remote-console').reintercept();
-      throw new Error('logger module missing export for ' + level);
-    }
-  }
-
-  if (logger.throb)
-    console.throb = logger.throb;
-  else
-    console.throb = function throwFallback(facility, ...args) {
-      if (facility && facility !== 'throb')
-        console[facility](...args);
-    };
-
-  require('./remote-console').reintercept();
-}
-
-/**
- * Format console.log arguments for use by a non-native logger, eg syslog.  All non-string arguments are
- * converted into the best human-readable strings we can muster.
- */
-function format(...argv)
-{
-  for (let i in argv)
-  {
-    try
-    {
-      if (typeof argv[i] === 'object' && argv[i] instanceof String)
-        argv[i] = String(argv[i]);
-      if (typeof argv[i] === 'object')
-        argv[i] = util.inspect(argv[i], exports.inspectOptions);
-      if (typeof argv[i] !== 'string')
-        argv[i] = String(argv[i]);
-    }
-    catch(e)
-    {
-      if (e instanceof TypeError)
-        argv[i] = '[encoding error: ' + e.message + ']';
-    }
-  }
-
-  return argv;
-}
-
-/**
- * Options for util.inspect. Loggers which cannot deal with colours should force this false.
- */
-exports.inspectOptions = {
-  colors: process.stdout.isTTY && process.stdout.hasColors() || process.env.FORCE_COLOR,
-};

package/lib/worker-loggers/console.js

@@ -1,74 +0,0 @@
-/**
- * @file        worker-loggers/console.js
- *              Logger interface which just logs to the node console on stdout/stderr.
- * @author      Wes Garland, wes@distributive.network
- * @date        June 2023
- */
-'use strict';
-
-const process = require('process');
-const usingDebugger = require('module')._cache.niim instanceof require('module').Module;
-
-/**
- *  Initialize the console logger
- *
- *  @param  {object} options Any options affecting console behaviour. Not presently used.
- */
-exports.init = function console$$init(options)
-{
-  const myConsole = new (require('console').Console)(process);
-  var lastWasThrobber = false;
-  var i = 0;
-  var throbArgsCache = false;
-
-  delete exports.init; // singleton
-  if (process.env.RAW_CONSOLE)
-  {
-    /* raw mode is used to debug node-inspect problems by dumping raw types directly to console.log */
-    exports.raw = function console$$raw(level, ...args) {
-      myConsole[level](...args);
-    };
-    return;
-  }
-
-  /* Log a single string to the console; conceptually very similar to other loggers */
-  exports.at = function console$$at(level, ...args) {
-    if (lastWasThrobber)
-    {
-      args.unshift(' \n');
-      lastWasThrobber = false;
-    }
-    myConsole[level](args.join(' '));
-  };
-
-  const throbChars = '/-\\|';
-  /**
-   * throb API: calls with arguments set facility and message.  First call without argument emits the
-   *            message. All calls without arguments advance the throbber.
-   */
-  exports.throb = function throb(throbFacility, ...args) {
-    if (throbFacility)
-    {
-      throbArgsCache = { throbFacility, args };
-      return;
-    }
-
-    const stream = throbFacility === 'error' || throbFacility === 'warn' ? process.stderr : process.stdout;
-
-    if (throbArgsCache)
-    {
-      if (stream.isTTY && !usingDebugger)
-        stream.write(throbArgsCache.args.join(' '));
-      else
-        console[throbArgsCache.throbFacility](...throbArgsCache.args);
-      throbArgsCache = false;
-    }
-
-    if (stream.isTTY && !usingDebugger)
-    {
-      i = (i + 1) % throbChars.length;
-      stream.write(throbChars[i] + '\u0008');
-      lastWasThrobber = true;
-    }
-  }
-}

package/lib/worker-loggers/dashboard.js

@@ -1,76 +0,0 @@
-/**
- *  @file       worker-loggers/dashboard.js
- *  @author     Ryan Rossiter, ryan@kingsds.network
- *  @date       April 2020
- *
- *  This worker logger uses the blessed library to create
- *  a monitoring dashboard for the worker.
- */
-'use strict';
-
-const chalk = require('chalk');
-
-/**
- *  Initialize the Blessed dashboard
- *
- *  @param  {object} options Options affecting dasboard behaviour
- */
-exports.init = function dashboardLogger$$init(options)
-{
-  const dashboardTui = require('../dashboard-tui');
-  const inspect = Symbol.for('nodejs.util.inspect.custom');
-  var throbPos = 0;
-  var throbArgsCache = false;
-
-  function logWrapperFactory(logLevel)
-  {
-    return function wrappedLogFun() {
-      if (!dashboardTui.logPane) /* no logPane => TUI not ready - fallback to console */
-      {
-        const consoleLogger = require('./console');
-        if (consoleLogger.init)
-          consoleLogger.init();
-
-        const logAt = consoleLogger.at || consoleLogger.raw;
-        logAt(logLevel, ...arguments);
-        return;
-      }
-
-      const argv = Array.from(arguments);
-      for (let i in argv)
-      {
-        if (argv[i] instanceof Error || (typeof argv[i] === 'object' && argv[i][inspect]))
-          argv[i] = require('node:util').inspect(argv[i]);
-        else if (logLevel === 'error' && typeof argv[i] === 'string')
-          argv[i] = chalk.red(argv[i]);
-      }
-      dashboardTui.logPane.log(...argv);
-    }
-  }
-
-  for (let level of ['log', 'warn', 'debug', 'info', 'error'])
-    exports[level] = logWrapperFactory(level);
-
-  const throbChars = '/-\\|';
-  /**
-   * throb API: calls with arguments set facility and message.  First call without argument emits the
-   *            message. All calls without arguments advance the throbber.
-   */
-  exports.throb = function throb(throbFacility, ...args) {
-    if (throbFacility)
-    {
-      throbArgsCache = { throbFacility, args };
-      return;
-    }
-
-    if (throbArgsCache)
-    {
-      exports[throbArgsCache.throbFacility](...throbArgsCache.args);
-      throbArgsCache = false;
-    }
-
-    throbPos = (throbPos + 1) % throbChars.length;
-    if (dashboardTui.logPane?.advanceThrob)
-      dashboardTui.logPane.advanceThrob(throbChars[throbPos]);
-  }
-}