dcp-worker 3.2.30-1 → 3.2.30-11

package/bin/dcp-worker

@@ -4,25 +4,26 @@
  *              Standalone NodeJS DCP Worker
  *
  *  @author     Ryan Rossiter, ryan@kingsds.network
+ *              Paul, paul@distributive.network
+ *              Wes Garland, wes@distributive.network
+ *
  *  @date       April 2020
+ *              April-May 2023
+ *              May-June 2023
  */
 'use strict';
 
+var worker;
+
 const process = require('process');
 const fs      = require('fs');
+const path    = require('path');
 const crypto  = require('crypto');
 const chalk   = require('chalk');
+const telnetd = require('../lib/remote-console');
+const utils   = require('../lib/utils');
 
 const configName = process.env.DCP_CONFIG || '../etc/dcp-worker-config';
-var worker, dcpConfig, debugging;
-
-const debug = (...args) => {
-  if (!debugging)
-    debugging = require('dcp/internal/debugging').scope('dcp-worker');
-  if (debugging())
-    console.debug('dcp-worker:', ...args);
-};
-
 const EXIT_UNHANDLED = 5;
 
 /* Setup the telnet REPL up early to ensure early-failure log messages are captured */
@@ -34,13 +35,15 @@ const replHelpers = {
   },
   commands: {
     report: printReport,
-    kill:   process.exit,
+    kill:   processExit,
     die:    () => worker && worker.stop()
   },
 };
-require('../lib/remote-console').init(replHelpers);
+telnetd.init(replHelpers);
 
-/* Initialize dcp-client with local config defaults and run the main function. DCP_CONFIG_COOKIE becomes dcpConfig.cookie. */
+/* Initialize dcp-client with local config defaults and run the main function. DCP_CONFIG_COOKIE becomes dcpConfig.cookie.
+ * And dcpConfig is defined as a side effect of initializing dcp-client.
+ */
 process.env.DCP_CONFIG_COOKIE = (Math.random().toString(16)).slice(2) + '-' + process.pid + '-' + Date.now();
 require('dcp-client').init({ configName }).then(main).catch(handleUnhandled);
 
@@ -48,7 +51,6 @@ function parseCliArgs()
 {
   var defaultPidFileName;
   
-  dcpConfig = require('dcp/dcp-config');
   defaultPidFileName = require('../lib/pidfile').getDefaultPidFileName(dcpConfig.worker.pidfile);
   
   const cliArgs = require('dcp/cli')
@@ -67,7 +69,6 @@ function parseCliArgs()
         alias: 'd',
         describe: 'default proportion of CPU,GPU to use when cores not specified',
         type: 'string',
-        default: JSON.stringify(dcpConfig.worker.defaultCoreDensity),
       },
       verbose: {
         alias: 'v',
@@ -98,18 +99,21 @@ function parseCliArgs()
       },
       priorityOnly: {
         alias: 'P',
+        hidden: true,
         describe: 'Set the priority mode [deprecated]',
         type: 'boolean',
         default: false
       },
       'job-id': {
         alias: 'j',
+        hidden: true,
         describe: 'Restrict worker to a specific job (use N times for N jobs)',
         type: 'array',
       },
 
       join: {
         alias: 'g',
+        hidden: true,
         describe: 'Join compute group; the format is "joinKey,joinSecret" or "joinKey,eh1-joinHash"',
         type: 'array'
       },
@@ -120,22 +124,27 @@ function parseCliArgs()
 
       leavePublicGroup: {
         type: 'boolean',
+        hidden: true,
         describe: 'Do not fetch slices from public compute group.',
         default: undefined,
       },
 
       publicGroupFallback: {
+        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,
       },
 
       identityKey: {
+        hidden: true,
         describe: 'Identity key, in hex format',
         type: 'string',
         group: 'Identity options',
       },
       identityKeystore: {
+        hidden: true,
         describe: 'Identity keystore, in json format',
         type: 'string',
         group: 'Identity options',
@@ -147,30 +156,40 @@ function parseCliArgs()
         group: 'Output options',
       },
       eventDebug: {
-        hide: true,
+        hidden: true,
         describe: 'If set, dump all sandbox and worker events',
       },
 
       logfile: {
-        describe: 'Path to log file (if --output=file)',
+        describe: 'Path to log file',
         type: 'string',
         group: 'Log File output options',
+        default: path.resolve('../log/dcp-worker.log'),
       },
       syslogAddress: {
-        describe: 'Address of rsyslog server (if --output=syslog)',
+        describe: 'Address of syslog server',
+        type: 'string',
+        group: 'Syslog output options',
+        default: 'loghost',
+      },
+      syslogFacility: {
+        describe: 'Name of syslog facility',
         type: 'string',
         group: 'Syslog output options',
+        default: 'local7',
       },
       syslogTransport: {
-        describe: 'Transport to connect to rsyslog daemon (if --output=syslog)',
+        describe: 'Transport to connect to use for syslog',
         type: 'string',
-        choices: ['udp','tcp'],
+        choices: ['udp','tcp','unix','tls'],
         group: 'Syslog output options',
+        default: 'udp',
       },
       syslogPort: {
-        describe: 'UDP/TCP port of rsyslog server',
+        describe: 'UDP/TCP port to use for syslog',
         type: 'number',
         group: 'Syslog output options',
+        default: 514,
       },
 
       allowedOrigins: {
@@ -202,8 +221,8 @@ function parseCliArgs()
 
   if (cliArgs.dumpConfig)
   {
-    console.debug(JSON.stringify(require('dcp/dcp-config'), null, 2));
-    process.exit(0);
+    console.log(JSON.stringify(require('dcp/dcp-config'), null, 2));
+    processExit(0);
   }
 
   return cliArgs;
@@ -228,6 +247,20 @@ function addConfig(target, ...objs)
   Object.assign(target, tmp);
 }
 
+/** 
+ * Replacement for process.exit() that tries to increase the probability
+ * that remote log messages will make it out over the network.
+*/
+function processExit()
+{
+  logClosing('debug', 'Exit Code:', process.exitCode || 0);
+  if (console.close)
+    console.close();
+  setImmediate(() => {
+    process.exit.apply(null, arguments);
+  });
+}
+
 /**
  * Main program entry point. Assumes DCP client is already initialized and console logging is ready.
  */
@@ -235,21 +268,22 @@ async function main()
 {
   const wallet = require('dcp/wallet');
   const DCPWorker = require('dcp/worker').Worker;
-  const { startWorkerLogger } = require('../lib/startWorkerLogger');
   const cliArgs = parseCliArgs();
   const sawOptions = {
     hostname: cliArgs.hostname,
     port:     cliArgs.port
   };
 
-  verifyDefaultConfigIntegrity(); /* Bail before TUI & as early as possible if config file is bad */
+  telnetd.setMainEval(function mainEval() { return eval(arguments[0]) }); // eslint-disable-line no-eval
+  require('../lib/startWorkerLogger').init(cliArgs); /* Start remote logger as early as possible */
+  verifyDefaultConfigIntegrity();                    /* Bail before TUI & as early as possible if bad conf */
 
   process.on('SIGINT', handleSigDeath);
   process.on('SIGTERM', handleSigDeath);
   process.on('SIGQUIT', handleSigDeath);
   process.on('unhandledRejection', handleUnhandled);
   process.on('uncaughtException', handleUnhandled);
-
+  
   let paymentAddress = false
       || cliArgs.paymentAddress
       || dcpConfig.worker.paymentAddress
@@ -285,6 +319,7 @@ async function main()
   const dcpWorkerOptions = dcpConfig.worker;
   const forceOptions = {
     paymentAddress,
+    maxWorkingSandboxes: cliArgs.cores,
   };
   const defaultOptions = {
     sandboxOptions: {
@@ -339,26 +374,26 @@ async function main()
     dcpWorkerOptions.watchdogInterval = cliArgs.watchdogInterval;
 
   worker = new DCPWorker(identityKeystore, dcpWorkerOptions);
-  worker.on('error', (...payload) => console.error(...payload));
-  worker.on('warning', (...payload) => console.warn(...payload));
+  worker.on('error',   (...payload) => console.error(...payload));
+  worker.on('warning', (...payload) => console.warn (...payload));
+  worker.on('stop', () => { console.log('Worker is stopping') });
+  worker.on('end',  () => { logClosing('log', 'Worker has stopped') });
+  require('../lib/default-ui-events').hook(worker, cliArgs);
 
+  if (cliArgs.outputMode === 'dashboard')
+    require('../lib/dashboard-tui').init(worker, cliArgs);
+  
   /* Let incorrect event-loop references keep us alive when linked with a debug library, but
    * exit quickly/accurately for production code even when the library isn't perfect.
    */
   if (require('dcp/build').config.build !== 'debug')
-    worker.on('end', process.exit);
+    worker.on('end', processExit);
   else
-    worker.on('end', () => setTimeout(process.exit, getCleanupTimeoutMs()).unref());
+    worker.on('end', () => setTimeout(processExit, getCleanupTimeoutMs()).unref());
 
   if (cliArgs.eventDebug)
     worker.enableDebugEvents = true;
 
-  worker.on('stop', () => { console.log('Worker is stopping') });
-  worker.on('end',  () => { logClosing('log', 'Worker has stopped') });
-  startWorkerLogger(worker, cliArgs);
-
-  require('../lib/remote-console').setMainEval(function mainEval() { return eval(arguments[0]) });
-
   if (dcpWorkerOptions.publicGroupFallback)
   {
     if (dcpWorkerOptions.leavePublicGroup)
@@ -372,23 +407,10 @@ async function main()
 
       function fetchEventHandler(ev)
       {
-        var slicesFetched;
-
         if (ev instanceof Error)
-        {
           console.error('Error fetching task:', ev);
-          return;
-        }
-
-        if (typeof ev === 'string') /* <= June 2023 Worker events: remove ~ Sep 2023 /wg */
-          slicesFetched = ev;
         else
-        {
-          const task = ev;
-          slicesFetched = task.slices?.length;
-        }
-
-        dcpWorkerOptions.leavePublicGroup = Boolean(slicesFetched > 0);
+          dcpWorkerOptions.leavePublicGroup = Boolean(utils.slicesFetched(ev) > 0);
       }
     }
   }
@@ -415,21 +437,23 @@ async function main()
 
   if (dcpWorkerOptions.jobAddresses?.length > 0)
     introBanner += ` * Processing only ${qty(dcpWorkerOptions.jobAddresses, 'job')} ` + dcpWorkerOptions.jobAddresses.join(', ') + '\n';
-  if (dcpWorkerOptions.computeGroups?.length > 0)
+  if (dcpWorkerOptions.computeGroups && Object.keys(dcpWorkerOptions.computeGroups).length > 0)
     introBanner += ` . Joining compute ${qty(dcpWorkerOptions.computeGroups, 'group')} ` + dcpWorkerOptions.computeGroups.map(el => el.joinKey).join(', ') + '\n';
   if (dcpWorkerOptions.publicGroupFallback)
     introBanner += ' . Falling back on public group when preferred groups have no work' + '\n';
   if (dcpWorkerOptions.leavePublicGroup)
     introBanner += ' . Leaving the public compute group' + '\n';
   if (dcpWorkerOptions.cores)
-    introBanner += ` . Target cores: ${JSON.stringify(dcpWorkerOptions.cores)}\n`;
+    introBanner += ` . Configured Cores: ${dcpWorkerOptions.cores.cpu},${dcpWorkerOptions.cores.gpu}\n`
   else
     introBanner += ` . Target core density: ${JSON.stringify(dcpWorkerOptions.defaultCoreDensity)}\n`;
   if (cliArgs.verbose)
     introBanner += ` + Verbosity level: ${cliArgs.verbose}` + '\n';
   if (cliArgs.eventDebug)
     introBanner += ' + Event debug on' + '\n';
-
+  if (telnetd.hasOwnProperty('port'))
+    introBanner += ` ! telnetd listening on port ${telnetd.port}\n`;
+  
   introBanner += ' . Supervisor version: ' + worker.supervisorVersion;
   introBanner += ' . Output mode: ' + cliArgs.outputMode + '\n';
   introBanner += ' * Ready' + '\n';
@@ -442,7 +466,7 @@ async function main()
     if (cliArgs.outputMode !== 'dashboard')
       setInterval(printReport, parseFloat(cliArgs.reportInterval) * 1000).unref();
     else
-      console.log('Ignoring --reportInterval in dashboard output mode');
+      console.warn('Ignoring --reportInterval in dashboard output mode');
   }
 
   /* Start the worker. Normal process exit happens by virtue of the worker<end> event */
@@ -469,21 +493,22 @@ function processCoresAndDensity (dcpWorkerOptions, cliArgs)
 
   const parseArg = (which) => {
     if (!cliArgs[which])
-      return false;
-
-    const [cpu, gpu] = cliArgs[which].split(',');
-    dcpWorkerOptions[which] = { cpu: Number(cpu || defaultTargets[which].cpu),
-                                gpu: Number(gpu || defaultTargets[which].gpu) };
-    return true;
+      dcpWorkerOptions[which] = defaultTargets[which];
+    else
+    {
+      const [cpu, gpu] = cliArgs[which].split(',');
+      dcpWorkerOptions[which] = { cpu: Number(cpu || defaultTargets[which].cpu),
+                                  gpu: Number(gpu || defaultTargets[which].gpu) };
+    }
   };
 
   parseArg('density');
   parseArg('cores');
 
   if (dcpWorkerOptions.cores)
-    debug('cores = ', dcpWorkerOptions.cores);
-  else
-    debug('core density = ', dcpWorkerOptions.defaultCoreDensity);
+    debugging() && console.debug('dcp-worker: cores =', dcpWorkerOptions.cores);
+  if (dcpWorkerOptions.density)
+    debugging() && console.debug('dcp-worker: core density =', dcpWorkerOptions.density);
 }
 
 /**
@@ -494,9 +519,7 @@ function logClosing(facility, ...message)
 {
   var screen = require('../lib/worker-loggers/dashboard').screen;
 
-  if (!screen)
-    console[facility](message);
-  else
+  if (screen)
   {
     /* Turn off fullscreen TUI and resume "normal" console logging.
      * FUTURE: dashboard API should know how to unregister its hook so that we don't have to clobber
@@ -505,10 +528,11 @@ function logClosing(facility, ...message)
     screen.log(...message);
     screen.destroy();
     screen = false;
-    console = new (require('console').Console)(process);
-    require('../lib/remote-console').reintercept();
-    console[facility].call(null, ...message);
+    console = new (require('console').Console)(process); // eslint-disable-line no-global-assign
+    telnetd.reintercept();
   }
+
+  console[facility](...message);
 }
 
 /** 
@@ -517,7 +541,7 @@ function logClosing(facility, ...message)
  * the worker must be restarted. This handler does its best to report the rejection and give the worker a few
  * seconds in which to attempt to return slices to the scheduler before it gives up completely.
  */
-async function handleUnhandled(error)
+function handleUnhandled(error)
 {
   var _worker = worker;
   worker = false;
@@ -526,21 +550,21 @@ async function handleUnhandled(error)
   
   try
   {
-    logClosing(error);
-  } catch(e) {};
+    logClosing('error', error);
+  } catch(e) {} // eslint-disable-line no-empty
 
   if (!_worker)
     console.error('trapped unhandled error:', error)
   else
   {
     console.error('trapped unhandled error -- stopping worker:', error);
-    _worker.on('end', process.exit);
+    _worker.on('end', processExit);
     _worker.stop();
   }
 
   setTimeout(() => {
     logClosing('error', 'handleFatalError timeout - exiting now');
-    process.exit();
+    processExit();
   }, getCleanupTimeoutMs()).unref();
 
   try {
@@ -550,7 +574,7 @@ async function handleUnhandled(error)
       fs.appendFileSync(process.env.DCP_WORKER_UNHANDLED_REJECTION_LOG,
                         `${Date.now()}: ${error.message}\n${error.stack}\n\n`);
     }
-  } catch(e) {};
+  } catch(e) {} // eslint-disable-line no-empty
 }
 
 /** print the slice report via console.log */
@@ -608,14 +632,14 @@ function sliceReport()
 
   report += ('Progress:') + '\n';
   worker.workingSandboxes.forEach(sb => {
-    const jobName = sb.job && sb.job.public && sb.job.public.name || `idek (${sb.jobAddress})`;
+    const jobName = sb.job?.public?.name || `idek (${sb.jobAddress})`;
     let el = Date.now() - sb.sliceStartTime;
     const t = el < 1000000
           ? toInterval(el)
           : 'new';
 
     el = sb.progressReports && sb.progressReports.last
-      ? Date.now() - (sb.sliceStartTime + sb.progressReports.last.timestamp)
+      ? Date.now() - (sb.sliceStartTime + (sb.progressReports.last?.timestamp ?? 0))
       : 0;
     const pct = (typeof sb.progress) === 'number'
           ? `${Number(sb.progress).toFixed(0).padStart(2)}%`
@@ -647,14 +671,14 @@ function handleSigDeath(signalName, signal)
   process.off(signalName, handleSigDeath);
 
   if (!worker)
-    console.error(`trapped ${signalName}, signal ${signal}`);
+    console.warn(`trapped ${signalName}, signal ${signal}`);
   else
   {
-    console.error(`trapped ${signalName}, signal ${signal} -- stopping worker`);
+    console.warn(`trapped ${signalName}, signal ${signal} -- stopping worker`);
     worker.stop(signalName === 'SIGQUIT');
   }
 
-  setTimeout(() => process.exit(signal - 128), getCleanupTimeoutMs()).unref();
+  setTimeout(() => processExit(signal - 128), getCleanupTimeoutMs()).unref();
 }
 
 /**
@@ -674,7 +698,7 @@ function getCleanupTimeoutMs()
     cleanupTimeout = defaultCT;
     if (!getCleanupTimeoutMs.warned)
     {
-      console.warn(`warning: dcpConfig.worker.cleanupTimeout is not a number (${dcpConfig.worker.cleanupTimeout})`);
+      console.error(`warning: dcpConfig.worker.cleanupTimeout is not a number (${dcpConfig.worker.cleanupTimeout})`);
       getCleanupTimeoutMs.warned = true;
     }
   }
@@ -696,7 +720,7 @@ function verifyDefaultConfigIntegrity()
 
   if (!fs.existsSync(md5sumPath))
   {
-    console.log(chalk.bold.red(` ! warning: ${md5sumPath} not found; cannot verify configuration integrity`));
+    console.error(chalk.bold.red(` ! warning: ${md5sumPath} not found; cannot verify configuration integrity`));
     require('dcp/utils').sleep(2);
   }
   else
@@ -718,7 +742,7 @@ function verifyDefaultConfigIntegrity()
       console.warn('    - the Windows Registry');
 
       if (require('dcp/build').config.build !== 'debug')
-        process.exit(1);
+        processExit(1);
 
       console.log(chalk.bold.red.inverse("If this wasn't a debug build, the worker would exit now."));
       require('dcp/utils').sleep(2);
@@ -728,10 +752,18 @@ function verifyDefaultConfigIntegrity()
   if (dcpConfig.cookie !== process.env.DCP_CONFIG_COOKIE || !dcpConfig.cookie)
   {
     console.error(' ! DCP Worker default configuration was not loaded; exiting.');
-    process.exit(1);
+    processExit(1);
   }
 }
 
+/* thunk - ensures global debugging() symbol always available even if called before dcp-client init */
+function debugging()
+{
+  require('dcp-client');
+  debugging = require('dcp/internal/debugging').scope('dcp-worker');
+  return debugging.apply(this, arguments);
+}
+
 /**
  * Cast b to boolean such that 'false' becomes false, falsey things become false, and everything else
  * becomes true.

package/docs/CODEOWNERS

@@ -18,9 +18,11 @@
 /package-lock.json @eroosenmaallen
 
 [Wes]
+/npm-hooks/ @wesgarland
 /README.md @wesgarland
 /docs/ @wesgarland
 /.eslintrc.json @wesgarland
+/.npmrc @wesgarland
 /.tidelift @wesgarland
 /lib/ @wesgarland
 /LICENSE.md @wesgarland

package/etc/dcp-worker-config.js

@@ -49,7 +49,7 @@
       // keystore('~/.dcp/scott'),
     ],
 
-    jobAddresses: [],               /* If specified, restrict the worker to only these jobs */
+    jobAddresses: false,               /* If specified, restrict the worker to only these jobs */
     paymentAddress: undefined,      /* Bank account where earned funds are transfered if not specified on command-line */
   },
 

package/etc/dcp-worker-config.js.md5

@@ -1,2 +1,2 @@
-8edf1c57bee521ed7f151a21b8f3f34d
+4d49057dd014344e4be5a266e9754824
 ### DO NOT MODIFY THIS FILE!!! ###

package/lib/blessed-components/index.js

@@ -1,3 +1,4 @@
+'use strict';
 
 Object.assign(exports, require('./log'));
 Object.assign(exports, require('./sandboxes'));

package/lib/blessed-components/log.js

@@ -7,6 +7,7 @@
  *  log component, but features text wrapping and behaves
  *  closer to the built-in console log methods.
  */
+'use strict';
 
 const { Box } = require('blessed');
 

package/lib/blessed-components/sandboxes.js

@@ -67,11 +67,7 @@ class Sandboxes extends Box {
   update(data=this.data) {
     this.data = data;
     for (let i = 0; i < this.data.length; i++) {
-      if (i < this.progressBars.length) {
-        this.updateProgressBar(i, this.data[i]);
-      } else {
-        this.createProgressBar();
-      }
+      this.updateProgressBar(i, this.data[i]);
     }
 
     if (this.data.length < this.progressBars.length) {
@@ -80,7 +76,15 @@ class Sandboxes extends Box {
       }
     }
 
-    this.setLabel(`${this.options.label} (${this.data.length})`);
+    this.setLabel(`${this.options.label} (${this.progressBars.length})`);
+  }
+
+  // Deletes last progress bar
+  deleteProgressBar() {
+    let i = this.progressBars.length - 1;
+    this.progressBars[i].label.destroy()
+    this.progressBars[i].progressBar.destroy()
+    this.progressBars.pop(i)
   }
 }
 

package/lib/check-scheduler-version.js

@@ -6,6 +6,7 @@
  * @author      Sam Cantor
  * @date        Nov 2020
  */
+'use strict';
 
 exports.check = function checkSchedulerVersion$$check(quiet)
 {