dcp-worker 3.2.30-2 → 3.2.30-4

package/lib/worker-loggers/syslog.js

@@ -4,66 +4,45 @@
  *  @date       August 2022
  *
  *  This logger module emits log lines to a remote syslogd, writing all
- *  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
+ *  console logs to it.
  */
+'use strict';
 
-require('./common-types');
-const consoleLogger = require('./console');
-
-const syslog = require('syslog-client');
+const os      = require('os');
+const syslog  = require('syslog-client');
+const process = require('process');
 
 // Copy the original global console object's properties onto a backup
 const _console = Object.assign({}, console);
+var syslogClient;
+var processName;
 
-
-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);
+/**
+ *  Initialize the syslog worker logger
+ *
+ *  @param  {object} cliArgs          Options for logger behaviour (passed
+ *                                    through to consoleLogger)
+ */
+exports.init = function syslog$$init(cliArgs)
+{
+  {
     const syslogOptions = {
-      transport: options.syslogTransport || 'udp', // tcp, udp, unix, tls
-      port: options.syslogPort || 514,
+      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)],
     }
 
-    this._syslog = syslog.createClient(options.syslogAddress || '127.0.0.1', options);
-    this._processName = require('path').basename(process.mainModule.filename || process.argv0);
-
-    ['debug','error','info','log','warn'].forEach(level => {
-      console[level] = (...args) => this._log(level, ...args);
-    });
-  },
+    syslogClient = syslog.createClient(cliArgs.syslogAddress || '127.0.0.1', syslogOptions);
+    processName = require('path').basename(process.mainModule.filename || process.argv0);
+    exports.close = () => syslogClient.close();
+  }
+}
 
-  _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 + ']');
-        }
-      }
-    });
+function log(level, ...argv)
+{
+  {
+    const logPrefix = `${processName}[${process.pid}]: `;
     
     // Use the string log-level to look up the severity number:
     let severity = {
@@ -74,18 +53,17 @@ const eventlogLogger = {
       debug: syslog.Severity.Debug,
     }[level];
 
-    this._syslog.log(strBuilder.join(' '), {
-      severity,
-    }, error => {
-      if (error)
-        _console.error('168: Unexpected error writing to syslog:', error);
-    });
-  }
-};
+    const logMessages = argv.join(' ').split('\n');
 
-for (const [prop, value] of Object.entries(consoleLogger))
-{
-  if (typeof value === 'function')
-    exports[prop] = value.bind(consoleLogger);
+    for (let logMessage of logMessages)
+    {
+      logMessage = logPrefix + logMessage;
+      syslogClient.log(logMessage, { severity }, error => {
+        if (error)
+          _console.error('168: Unexpected error writing to syslog:');
+      });
+    }
+  }
 }
-Object.assign(exports, eventlogLogger);
+
+exports.at = log;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "3.2.30-2",
+  "version": "3.2.30-4",
   "description": "JavaScript portion of DCP Workers for Node.js",
   "main": "bin/dcp-worker",
   "keywords": [
@@ -37,8 +37,9 @@
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",
     "chalk": "^4.1.0",
-    "dcp-client": "4.2.32",
-    "semver": "^7.3.8"
+    "dcp-client": "gitlab:Distributed-Compute-Protocol/dcp-client#develop",
+    "semver": "^7.3.8",
+    "syslog-client": "1.1.1"
   },
   "optionalDependencies": {
     "telnet-console": "^1.0.4"
@@ -47,6 +48,14 @@
     "@kingsds/eslint-config": "^1.0.1",
     "eslint": "7.30.0"
   },
+  "peerDependencies": {
+    "node-eventlog": "https://gitpkg.now.sh/Distributive-Network/node-eventlog/package?dcp/0.0.1"
+  },
+  "peerDependenciesMeta": {
+    "node-eventlog": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=16",
     "npm": ">=7"

package/lib/worker-loggers/common-types.js

@@ -1,24 +0,0 @@
-/**
- * @typedef WorkerLogger
- * @property {onSandboxReady} onSandboxReady
- * @property {function} onPayment
- * @property {function} onFetchingSlices
- * @property {function} onFetchedSlices
- * @property {function} onFetchSlicesFailed
- * @property {SandboxCallback} sandbox$onSliceStart
- * @property {SandboxCallback} sandbox$onSliceProgress
- * @property {SandboxCallback} sandbox$onSliceFinish
- * @property {SandboxCallback} sandbox$onWorkerStop
- */
-
-/**
- * @typedef {function} onSandboxReady
- * @param {Sandbox} sandbox
- * @returns {object} workerData
- */
-
-/**
- * @typedef {function} SandboxCallback
- * @param {Sandbox} sandbox
- * @param {object} workerData
- */