dcp-worker 3.2.30-7 → 3.2.30-9

package/lib/worker-loggers/logfile.js

@@ -4,96 +4,122 @@
  *  @date       August 2022
  *
  *  This logger module maintains a log file, writing all console logs to it.
+ *  Most worker events are passed through to the console logger.
  */
-'use strict';
+
+require('./common-types');
+const consoleLogger = require('./console');
 
 // Copy the original global console object's properties onto a backup
 const _console = Object.assign({}, console);
 
-/**
- *  Initialize the logfile worker logger
- *
- *  @param  {object}  options          Options for logger behaviour
- *  @param  {string}  options.filepath Path to worker file; default: ./dcp-worker.log
- *  @param  {boolean} options.truncate If true, logfile will be cleared at worker startup
- */
-exports.init = function init(options)
-{
-  delete exports.init; // singleton   
-  options.verbose >= 3 && _console.debug('050: constructing LogfileConsole', options.logfile, options);
-  getLogFile(options);
-  require('../startWorkerLogger').inspectOptions.colors = Boolean(process.env.FORCE_COLOR);
-  
-  // on SIGHUP, close the output stream and open a new one
-  process.on('SIGHUP', () => {
-    getLogFile(options);
-  });
-  
-  exports.at = log;
-}
+const logfileLogger = {
+  /**
+   *  Initialize the logfile worker logger
+   *
+   *  @param  {Worker}  worker           DCP Worker object to log
+   *  @param  {object}  options          Options for logger behaviour
+   *  @param  {string}  options.filepath Path to worker file; default: ./dcp-worker.log
+   *  @param  {boolean} options.truncate If true, logfile will be cleared at worker startup
+   */
+  init(worker, options) {
+    consoleLogger.init(worker, options);
+    
+    this._filepath = options.filepath || './dcp-worker.log';
+    this.options = options;
+    
+    options.verbose >= 3 && console.debug('050: constructing LogfileConsole', this._filepath, options);
+    
+    this._getLogFile();
+    
+    // on SIGHUP, close the output stream and open a new one
+    process.on('SIGHUP', () => {
+      this._getLogFile(true);
+    });
 
-/**
- *  Return a handle to the WritableStream for this logger, creating one if
- *  necessary.
- *
- *  @return {fs.WriteStream}
- */
-function getLogFile(options)
-{
-  {
+    ['debug','error','info','log','warn'].forEach(level => {
+      console[level] = (...args) => this._log(level, ...args);
+    });
+  },
+
+  /**
+   *  Return a handle to the WritableStream for this logger, creating one if
+   *  necessary.
+   *
+   *  @param  {boolean} forceNew If truthy, close any existing stream and open
+   *                             a new one
+   *  @return {fs.WriteStream}
+   */
+  _getLogFile(forceNew = false) {
     const fs = require('fs');
     
-    if (getLogFile._file)
+    if (this._file)
     {
+      if (!forceNew)
+        return this._file;
+
       try
       {
-        getLogFile._file.end();
+        this._file.end();
       }
       catch (err)
       {
         console.error('061: failed to close old log file:', err);
       }
-      getLogFile._file = false;
+      this._file = false;
     }
     
-    const fileOptions = {
-      flags: options.truncate ? 'w' : 'a',  // NYI: cli --truncate 
+    const options = {
+      flags: this.options.truncate ? 'w' : 'a',  // NYI: cli --truncate 
     }
     
-    const file = getLogFile._file = fs.createWriteStream(options.logfile, fileOptions);
+    const file = this._file = fs.createWriteStream(this._filepath, options);
     
     // On error, close & recreate the log file
     file.on('error', err => {
       _console.error('082: console-patch::LogFileConsole write error:', err);
       
-      getLogFile(options);
+      this._getLogFile(true);
     });
     
     return file;
-  }
-}
-
-/** Write a log line to the output file. 
- *  
- *  current outputStream.
- *  @param {string} level Log level.
- *  @param {any} ...items Items to log.
- */
-function log(level, ...items)
-{
-  {
-    const logPrefix = [
+  },
+  
+  /** Write a log line to the output file. Items will be converted to strings as
+   *  possible and concatenated after the log-level and timestamp, then written to the
+   *  current outputStream.
+   *  @param {string} level Log level.
+   *  @param {any} ...items Items to log.
+   */
+  _log(level = 'none', ...items) {
+    const strBuilder = [
       (new Date()).toISOString(),
       level,
     ];
-
-    const logElements = logPrefix.concat(items);
-
+    
+    items.forEach(i => {
+      try {
+        switch (typeof i) {
+          case 'object':
+            strBuilder.push(JSON.stringify(i));
+          default:
+            strBuilder.push(String(i));
+        }
+      }
+      catch (e) {
+        if (e instanceof TypeError) {
+          strBuilder.push('[encoding error: ' + e.message + ']');
+        }
+      }
+    });
+    
     try {
-      getLogFile._file.write(logElements.join(' ') + '\n');
+      this._file.write(strBuilder.join(' ') + '\n');
     }
     catch (error) {
       _console.error('131: Unexpected error writing to log file:', error);
     }
-  }
-}
+  },
+};
+
+Object.assign(exports, consoleLogger, logfileLogger);

package/lib/worker-loggers/syslog.js

@@ -4,45 +4,66 @@
  *  @date       August 2022
  *
  *  This logger module emits log lines to a remote syslogd, writing all
- *  console logs to it.
+ *  console logs to it. Most worker events are passed through to be handled
+ *  by the console logger.
+ *
+ *  @TODO: This could likely be improved by handling worker events directly
+ *  and emitting events to the event log more deliberately than just
+ *  redirecting the base console output. ~ER20220831
  */
-'use strict';
 
-const os      = require('os');
-const syslog  = require('syslog-client');
-const process = require('process');
+require('./common-types');
+const consoleLogger = require('./console');
+
+const syslog = require('syslog-client');
 
 // Copy the original global console object's properties onto a backup
 const _console = Object.assign({}, console);
-var syslogClient;
-var processName;
 
-/**
- *  Initialize the syslog worker logger
- *
- *  @param  {object} cliArgs          Options for logger behaviour (passed
- *                                    through to consoleLogger)
- */
-exports.init = function syslog$$init(cliArgs)
-{
-  {
+
+const eventlogLogger = {
+  /**
+   *  Initialize the syslog worker logger
+   *
+   *  @param  {Worker} worker           DCP Worker object to log
+   *  @param  {object} options          Options for logger behaviour (passed
+   *    through to consoleLogger)
+   */
+  init(worker, options) {
+    consoleLogger.init(worker, options);
+
+    this.options = Object.assign({}, options);
     const syslogOptions = {
-      syslogHostname: os.hostname(),
-      transport: cliArgs.syslogTransport || 'udp', // tcp, udp, unix, tls
-      port:      cliArgs.syslogPort,
-      facility: syslog.Facility[cliArgs.syslogFacility[0].toUpperCase() + cliArgs.syslogFacility.slice(1)],
+      transport: options.syslogTransport || 'udp', // tcp, udp, unix, tls
+      port: options.syslogPort || 514,
     }
 
-    syslogClient = syslog.createClient(cliArgs.syslogAddress || '127.0.0.1', syslogOptions);
-    processName = require('path').basename(process.mainModule.filename || process.argv0);
-    exports.close = () => syslogClient.close();
-  }
-}
+    this._syslog = syslog.createClient(options.syslogAddress || '127.0.0.1', options);
+    this._processName = require('path').basename(process.mainModule.filename || process.argv0);
 
-function log(level, ...argv)
-{
-  {
-    const logPrefix = `${processName}[${process.pid}]: `;
+    ['debug','error','info','log','warn'].forEach(level => {
+      console[level] = (...args) => this._log(level, ...args);
+    });
+  },
+
+  _log(level, ...items) {
+    const strBuilder = [`${this._processName}[${process.pid}]:`];
+    
+    items.forEach(i => {
+      try {
+        switch (typeof i) {
+          case 'object':
+            strBuilder.push(JSON.stringify(i));
+          default:
+            strBuilder.push(String(i));
+        }
+      }
+      catch (e) {
+        if (e instanceof TypeError) {
+          strBuilder.push('[encoding error: ' + e.message + ']');
+        }
+      }
+    });
     
     // Use the string log-level to look up the severity number:
     let severity = {
@@ -53,17 +74,18 @@ function log(level, ...argv)
       debug: syslog.Severity.Debug,
     }[level];
 
-    const logMessages = argv.join(' ').split('\n');
-
-    for (let logMessage of logMessages)
-    {
-      logMessage = logPrefix + logMessage;
-      syslogClient.log(logMessage, { severity }, error => {
-        if (error)
-          _console.error('168: Unexpected error writing to syslog:');
-      });
-    }
+    this._syslog.log(strBuilder.join(' '), {
+      severity,
+    }, error => {
+      if (error)
+        _console.error('168: Unexpected error writing to syslog:', error);
+    });
   }
-}
+};
 
-exports.at = log;
+for (const [prop, value] of Object.entries(consoleLogger))
+{
+  if (typeof value === 'function')
+    exports[prop] = value.bind(consoleLogger);
+}
+Object.assign(exports, eventlogLogger);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "3.2.30-7",
+  "version": "3.2.30-9",
   "description": "JavaScript portion of DCP Workers for Node.js",
   "main": "bin/dcp-worker",
   "keywords": [
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/Distributed-Compute-Protocol/dcp-worker.git"
+    "url": "git@github.com:Distributed-Compute-Labs/dcp-worker.git"
   },
   "license": "MIT",
   "author": "Kings Distributed Systems",
@@ -37,9 +37,8 @@
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",
     "chalk": "^4.1.0",
-    "dcp-client": "4.2.32",
-    "semver": "^7.3.8",
-    "syslog-client": "1.1.1"
+    "dcp-client": "4.3.0-4",
+    "semver": "^7.3.8"
   },
   "optionalDependencies": {
     "telnet-console": "^1.0.4"
@@ -50,6 +49,6 @@
   },
   "engines": {
     "node": ">=16",
-    "npm": ">=7"
+    "npm": ">=6"
   }
 }

package/lib/dashboard-tui.js

@@ -1,184 +0,0 @@
-/**
- *  @file       worker-loggers/dashboard.js
- *  @author     Ryan Rossiter, ryan@kingsds.network
- *  @date       April 2020
- *  @author     Wes Garland, wes@distributive.network
- *  @date       June 2023
- *
- *  This module uses the blessed library to create a monitoring dashboard for the worker.
- *  A corresponding worker-logger, dashboard.js, knows how to log to this dashboard.
- */
-'use strict';
-
-const dcpConfig  = require('dcp/dcp-config');
-const chalk      = require('chalk');
-const blessed    = require('blessed');
-const contrib    = require('blessed-contrib');
-const components = require('./blessed-components');
-
-const { replaceWorkerEvent, replaceSandboxEvent }  = require('./default-ui-events');
-
-const SLICE_FETCH_STATUS = {
-  IDLE: chalk.yellow('Idle'),
-  FETCHING: chalk.blue('Fetching Work...'),
-  WORKING: chalk.green('Working'),
-  NO_WORK: chalk.red('No Work Available'),
-}
-
-const usingDebugger = require('module')._cache.niim instanceof require('module').Module;
-const screenConf = {
-  input:  usingDebugger ? new (require('events').EventEmitter) : undefined,
-  output: usingDebugger ? new (require('events').EventEmitter) : undefined,
-};
-/** 
- */
-exports.init = function dashboard$$init(worker, options)
-{
-  var sliceFetchStatus = SLICE_FETCH_STATUS.IDLE;
-  var totalDCCs = 0;
-  const screen = blessed.screen(screenConf);
-  const grid = new contrib.grid({rows: 3, cols: 5, screen});
-  const workerInfoPane = grid.set(2, 0, 1, 5, blessed.text);
-  
-  const logPane = grid.set(0, 2, 2, 3, components.log, {
-    label: 'Worker Log',
-    scrollable: true,
-    alwaysScroll: true,
-    mouse: true,
-    scrollbar: {
-      bg: 'blue',
-    },
-  });
-
-  const sandboxPane = grid.set(0, 0, 2, 2, components.sandboxes, {
-    label: 'Sandboxes',
-    defaultProgressBars: Math.floor(worker.workerOptions.cores.cpu) || 1,
-    scrollable: true,
-    alwaysScroll: true,
-    mouse: true,
-    scrollbar: {
-      bg: 'blue',
-    },
-  });
-
-  delete exports.init; /* singleton */
-
-  if (!usingDebugger)
-    exports.logPane = logPane; /* now dashboard log can find the pane */
-  setInterval(() => screen.render(), 50).unref(); /* 50ms = 20 fps */
-  updateWorkerInfo();
-  screen.render();
-  
-  /* Apply key bindings which mimic canonical input mode */
-  screen.key(['C-c'], ()    => raise('SIGINT'));
-  screen.key(['C-z'], ()    => raise('SIGTSTP'));
-  screen.key(['\u001c'], () => raise('SIGQUIT')); /* C-\ */
-  
-  screen.key(['escape'], () => {
-    console.log('Stopping worker...');
-    worker.stop();
-  });
-
-  function updateWorkerInfo()
-  {
-    const workerOptions = worker.workerOptions;
-    
-    workerInfoPane.setLabel(`Worker Status [${sliceFetchStatus}]`);
-    workerInfoPane.setContent([
-      chalk.green(` DCCs Earned: ${chalk.bold(totalDCCs.toFixed(3))}`),
-      '',
-      `   Scheduler: ${chalk.yellow(dcpConfig.scheduler.location.href)}`,
-      `        Bank: ${chalk.yellow(dcpConfig.bank.location.href)}`,
-      `Bank Account: ${chalk.yellow(worker.paymentAddress || 'Starting...')}`,
-      `    Identity: ${chalk.yellow(worker.identityKeystore? worker.identityKeystore.address : 'Starting...')}`,
-      `        Jobs: ${workerOptions.jobAddresses?.length ? workerOptions.jobAddresses.join(', ') : '<any>'}`,
-      ` Priv Groups: ${Object.keys(workerOptions.computeGroups).length}`,
-      `   Pub Group: ${workerOptions.leavePublicGroup ? 'no' : 'yes'}`,
-    ].join('\n'));
-  }
-
-  /* Override default event behaviour to work better with the Dashboard. */
-
-  replaceSandboxEvent('start', function dashboard$$sliceStart(sandbox, sandboxData, ev) {
-    sandboxData.progressData = {
-      indeterminate: true,
-      progress: 0,
-      label: sandbox.public.name,
-    };
-
-    sandboxPane.data.push(sandboxData.progressData);
-    sandboxPane.update();
-  });
-
-  replaceSandboxEvent('sliceProgress', function dashboard$$sliceProgress(sandbox, sandboxData, ev) {
-    if (ev.indeterminate)
-    {
-      sandboxData.progressData.progress = 100;
-      setTimeout(() => {
-        if (sandboxData.progressData.indeterminate) {
-          sandboxData.progressData.progress = 0;
-          sandboxPane.update();
-        }
-      }, 500).unref();
-    }
-    else
-    {
-      sandboxData.progressData.progress = ev.progress;
-      sandboxData.progressData.indeterminate = false;
-    }
-
-    sandboxPane.update();
-  });
-  
-  replaceSandboxEvent('sliceFinish', function dashboard$$sliceFinish(sandbox, sandboxData, ev) {
-    sandboxPane.data = sandboxPane.data.filter(d => d != sandboxData.progressData);
-    sandboxPane.update();
-  });
-
-  worker.on('payment', updateWorkerInfo);
-
-  replaceWorkerEvent('fetchStart', function dashboard$$fetchStart(ev) {
-    sliceFetchStatus = SLICE_FETCH_STATUS.FETCHING;
-    updateWorkerInfo();
-  });
-  
-  replaceWorkerEvent('fetch', function dashboard$$fetch(ev) {
-    var slicesFetched;
-
-    if (ev instanceof Error)
-    {
-      console.error('Error fetching slices:', ev);
-      return;
-    }
-
-    if (typeof ev === 'number' || typeof ev === 'string') /* <= June 2023 Worker events: remove ~ Sep 2023 /wg */
-      slicesFetched = ev;
-    else
-    {
-      const task = ev;
-      slicesFetched = task.slices.length;
-    }
-
-    if (slicesFetched === 0 && sandboxPane.data.length === 0) {
-      sliceFetchStatus = SLICE_FETCH_STATUS.NO_WORK;
-    } else {
-      sliceFetchStatus = SLICE_FETCH_STATUS.WORKING;
-    }
-
-    updateWorkerInfo();
-  });
-
-  replaceWorkerEvent('fetchError', function dashabord$$fetchError() {
-    sliceFetchStatus = SLICE_FETCH_STATUS.NO_WORK;
-    updateWorkerInfo();
-  });
-};
-
-/**
- * Send a signal to the caller
- * @param {number|string} sig    the signal to raise
- */
-function raise(sig)
-{
-  process.kill(process.pid, sig);
-}