dcp-worker 3.3.2 → 3.3.3-0

package/.eslintrc.js

@@ -28,4 +28,5 @@ module.exports = {
     sourceType: 'script',
   },
   rules: {},
+  ignorePatterns: ['etc/*']
 };

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2020 Kings Distributed Systems, Inc.
+Copyright (c) 2017-2024 Distributive Corp.
 
 Permission is hereby granted, free of charge, to any person obtaining a 
 copy of this software and associated documentation files (the 

package/bin/dcp-worker

@@ -137,7 +137,7 @@ function parseCliArgs()
         hidden: true,
         describe: 'If set, worker will prefer private groups but fall back on the public group if no preferred work is available',
         type: 'boolean',
-        default: 'undefined',
+        default: undefined,
         defaultDescription: undefined,
       },
 

package/lib/blessed-components/index.js

@@ -1,3 +1,9 @@
+/**
+ *  @file       lib/blessed-components/index.js
+ *  @author     Ryan Rossiter <info@kingsds.network>
+ *  @date       April 2020
+ */
+
 'use strict';
 
 Object.assign(exports, require('./log'));

package/lib/blessed-components/log.js

@@ -23,7 +23,7 @@ class Log extends Box {
 
   log(...args) {
     let str = args.reduce(
-      (s, arg) => s += `${typeof arg === 'string'? arg : JSON.stringify(arg, null, 2)} `,
+      (s, arg) => (s += `${typeof arg === 'string'? arg : JSON.stringify(arg, null, 2)} `),
     '');
 
     this.logLines.push(str);

package/lib/check-scheduler-version.js

@@ -8,6 +8,11 @@
  */
 'use strict';
 
+/**
+ *  Poll the scheduler's verion codes and verify this worker is supported
+ *
+ *  @param  {boolean} quiet Truthy to suppress the default log if scheduler is supported
+ */
 exports.check = function checkSchedulerVersion$$check(quiet)
 {
   const dcpConfig = require('dcp/dcp-config');
@@ -32,7 +37,7 @@ exports.check = function checkSchedulerVersion$$check(quiet)
   let currentWorkerType = require('dcp/build').workerType || 'v4';
   let currentWorkerVersion = require('dcp/build').workerVersion || '1.0.0';
   
-  if (parseInt(currentWorkerVersion) !== 1) {
+  if (parseInt(currentWorkerVersion, 10) !== 1) {
     throw new Error('This version of dcp-client is not compatible with the standalone worker implemention in this dcp-worker package');
   }
 

package/lib/dashboard-tui.js

@@ -32,6 +32,9 @@ const screenConf = {
   output: usingDebugger ? new (require('events').EventEmitter) : undefined,
 };
 /** 
+ *  Initialize the blessed dashboard
+ *  @param  {Worker}    worker    Reference to the DCP Worker
+ *  @param {object} options Options which may affect behaviour. Not currently used.
  */
 exports.init = function dashboard$$init(worker, options)
 {

package/lib/default-ui-events.js

@@ -37,6 +37,8 @@ const workerEventHandlers = {};
  */
 
 /**
+ *  Hook a worker's events
+ *  
  * @param    worker    The instance of Worker to hook
  * @param    options   cliArgs from worker
  */

package/lib/remote-console.js

@@ -38,11 +38,12 @@ function daemonEval()
     if (typeof dcpConfig === 'undefined')
       dcpConfig = require('dcp/dcp-config');
   }
-  catch(e){};
+  catch(e)
+  {}
 
   if (mainEval)
     return mainEval(arguments[0]);
-  return eval(arguments[0]);
+  return eval(arguments[0]);  /* eslint-disable-line no-eval */
 }
 
 function callbackTelnet(port, client, registry) {
@@ -59,6 +60,12 @@ exports.setMainEval = function removeConsole$$setMainEval()
   mainEval = arguments[0];
 }
 
+/**
+ *  Initialize the remote console
+ *
+ *  @param  {...object} commands Command definitions. See telnet-console documentation 
+ *                               for details
+ */
 exports.init = function remoteConsole$$init(...commands)
 {
   try
@@ -101,6 +108,9 @@ exports.init = function remoteConsole$$init(...commands)
   }
 }
 
+/**
+ *  Re-intercept log calls. To be used after a logger may have added its own override.
+ */
 exports.reintercept = function remoteConsole$$reintercept()
 {
   if (typeof ci === 'undefined')

package/lib/utils.js

@@ -18,7 +18,8 @@ function slicesFetched (task)
   if (typeof task === 'number') /* <= June 2023 Worker events: remove ~ Sep 2023 /wg */
     return task;
   if (typeof task === 'string') /* <= June 2023 Worker events: remove ~ Sep 2023 /wg */
-    return parseInt(task) || 0;
+    return parseInt(task, 10) || 0;
+  /* eslint-disable-next-line no-shadow */
   let slicesFetched = 0;
   for (const job in task.slices)
     slicesFetched += task.slices[job];

package/lib/worker-loggers/console.js

@@ -8,6 +8,11 @@
 
 const process = require('process');
 
+/**
+ *  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);

package/lib/worker-loggers/dashboard.js

@@ -11,6 +11,11 @@
 const chalk = require('chalk');
 const _console = new (require('console').Console)(process);
 
+/**
+ *  Initialize the Blessed dashboard
+ *
+ *  @param  {object} options Options affecting dasboard behaviour
+ */
 exports.init = function dashboardLogger$$init(options)
 {
   function logWrapperFactory(logLevel)
@@ -34,7 +39,7 @@ exports.init = function dashboardLogger$$init(options)
       for (let i in argv)
       {
         if (argv[i] instanceof Error || (typeof argv[i] === 'object' && argv[i][inspect]))
-          argv[i] = util.inspect(argv[i]);
+          argv[i] = require('node:util').inspect(argv[i]);
         else if (logLevel === 'error' && typeof argv[i] === 'string')
           argv[i] = chalk.red(argv[i]);
       }

package/lib/worker-loggers/event-log.js

@@ -33,6 +33,7 @@ exports.init = function eventLog$$init(options)
 }
 
 /**
+ *  Emit a message to the Windows event-log
  * @param {string}    level    The node log level to log at
  * @param {[string]}  items    An array of strings to log as a single message
  */

package/lib/worker-loggers/syslog.js

@@ -31,7 +31,7 @@ exports.init = function syslog$$init(cliArgs)
       transport: cliArgs.syslogTransport, // tcp, udp, unix, tls
       port:      cliArgs.syslogPort,
       facility: syslog.Facility[cliArgs.syslogFacility[0].toUpperCase() + cliArgs.syslogFacility.slice(1)],
-    }
+    };
 
     syslogClient = syslog.createClient(cliArgs.syslogAddress, syslogOptions);
     processName = require('path').basename(process.mainModule.filename || process.argv0);
@@ -39,6 +39,12 @@ exports.init = function syslog$$init(cliArgs)
   }
 }
 
+/**
+ *  Emit a message to syslog
+ *
+ *  @param  {string}    level Event level (info, debug, log, warning, error)
+ *  @param  {...any[]}  argv  Items to log
+ */
 function log(level, ...argv)
 {
   {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "3.3.2",
+  "version": "3.3.3-0",
   "description": "JavaScript portion of DCP Workers for Node.js",
   "main": "bin/dcp-worker",
   "keywords": [
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:Distributed-Compute-Labs/dcp-worker.git"
+    "url": "git+ssh://git@gitlab.com/Distributed-Compute-Protocol/dcp-worker.git"
   },
   "license": "MIT",
   "author": "Kings Distributed Systems",
@@ -40,7 +40,7 @@
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",
     "chalk": "^4.1.0",
-    "dcp-client": "4.4.2",
+    "dcp-client": "4.4.3-0",
     "kvin": "^1.2.7",
     "posix-getopt": "^1.2.1",
     "semver": "^7.3.8",
@@ -53,7 +53,6 @@
   "devDependencies": {
     "@distributive/eslint-config": "2.1.1",
     "@distributive/eslint-plugin": "1.0.2",
-    "@kingsds/eslint-config": "^1.0.1",
     "@trunkio/launcher": "1.2.7",
     "eslint": "8.56.0"
   },