dcp-worker 3.2.28 → 3.2.30-0

package/.gitlab-ci.yml

@@ -28,4 +28,5 @@ tidelift:
   script:
     - echo "Running alignment and saving to Tidelift"
     - ./tidelift alignment save --wait
+  allow_failure: true
   cache: []

package/bin/dcp-worker

@@ -120,14 +120,15 @@ function parseCliArgs()
 
       leavePublicGroup: {
         type: 'boolean',
-        describe: 'Do not fetch slices from public compute group. Ignored if --publicGroupFallback is set',
-        default: false,
+        describe: 'Do not fetch slices from public compute group.',
+        default: undefined,
       },
+
       publicGroupFallback: {
         describe: 'If set, worker will prefer private groups but fall back on the public group if no preferred work is available',
         type: 'boolean',
-        default: 'false',
-        defaultDescription: false,
+        default: 'undefined',
+        defaultDescription: undefined,
       },
 
       identityKey: {
@@ -242,7 +243,7 @@ async function main()
     port:     cliArgs.port
   };
 
-  verifyDefaultConfigIntegrity();
+  verifyDefaultConfigIntegrity(); /* Bail before TUI & as early as possible if config file is bad */
 
   process.on('SIGINT', handleSigDeath);
   process.on('SIGTERM', handleSigDeath);
@@ -260,7 +261,7 @@ async function main()
   if (cliArgs.pidFile)
     require('../lib/pidfile').write(cliArgs.pidFile);
 
-  /* Figure out of the worker's identity and put that keystore in the wallet */
+  /* Figure out the worker's identity and put that keystore in the wallet */
   let identityKeystore = false;
   if (cliArgs.identityKey)
     identityKeystore = await new wallet.IdKeystore(cliArgs.identityKey, '');
@@ -278,11 +279,13 @@ async function main()
    * which were derived from dcpConfig in the first place. defaultOptions are overrideable by the usual
    * dcpConfig mechanisms, but since they are dynamic (or non-user-facing) they don't come from the
    * etc/dcp-worker-config.js file that ships with the work.
+   *
+   * It is important to never disable leavePublicGroup as a side effect of any other operation, or
+   * slight configuration errors could have large security impacts.
    */
   const dcpWorkerOptions = dcpConfig.worker;
   const forceOptions = {
     paymentAddress,
-    leavePublicGroup: cliArgs.leavePublicGroup || dcpConfig.worker.leavePublicGroup || cliArgs.publicGroupFallback || false,
   };
   const defaultOptions = {
     sandboxOptions: {
@@ -290,9 +293,21 @@ async function main()
     },
   };
 
+  if (cliArgs.leavePublicGroup !== undefined)
+    forceOptions.leavePublicGroup = mkBool(cliArgs.leavePublicGroup);
+  if (cliArgs.publicGroupFallback !== undefined)
+    forceOptions.publicGroupFallback = mkBool(cliArgs.publicGroupFallback);
+
   addConfig(dcpWorkerOptions, defaultOptions, dcpConfig.worker, forceOptions);
   processCoresAndDensity(dcpWorkerOptions, cliArgs);
 
+  /* Support magic value used by Windows screensaver configuration /wg June 2023 */
+  if (dcpWorkerOptions.leavePublicGroup === 'fallback')
+  {
+    dcpWorkerOptions.publicGroupFallback = true;
+    dcpWorkerOptions.leavePublicGroup = undefined;
+  }
+
   /* cliArgs.join is the list of compute groups to join */
   if (cliArgs.join && cliArgs.join.length)
   {
@@ -345,27 +360,37 @@ async function main()
 
   require('../lib/remote-console').setMainEval(function mainEval() { return eval(arguments[0]) });
 
-  // Activate public group fallback
-  // If requested by CLI
-  // OR if requested by dcpConfig and not forbidden by the cli
-  if (cliArgs.publicGroupFallback
-      || (dcpConfig.worker?.leavePublicGroup === 'fallback'
-          && typeof cliArgs.publicGroupFallback !== false))
+  if (dcpWorkerOptions.publicGroupFallback)
   {
-    dcpWorkerOptions.publicGroupFallback = true;
-
-    // If local config blocks the public group, then complain instead of activating fallback
-    if (dcpConfig.worker?.leavePublicGroup === true)
-    {
-      console.warn('* Public Group fallback has been requested, but the public group is blocked by local configuration');
-    }
+    if (dcpWorkerOptions.leavePublicGroup)
+      console.warn(' ! Public Group fallback has been requested, but the public group is blocked by local configuration');
     else
     {
-      worker.on('fetchend', slicesFetched => {
-        // Iff we got work in this fetch, then leave the public group for the
-        // next fetch
-        dcpConfig.worker.leavePublicGroup = Boolean(slicesFetched > 0);
-      });
+      /* Enable public group fallback - this currently works by enabling or disabling the public group
+       * on the next fetch based on whether or not the most recent fetch was an empty task or not.
+       */
+      worker.on('fetch', fetchEventHandler);
+
+      function fetchEventHandler(ev)
+      {
+        var slicesFetched;
+
+        if (ev instanceof Error)
+        {
+          console.error('Error fetching task:', ev);
+          return;
+        }
+
+        if (typeof ev === 'number') /* <= June 2023 Worker events: remove ~ Sep 2023 /wg */
+          slicesFetched = ev;
+        else
+        {
+          const task = ev;
+          slicesFetched = task.slices.length;
+        }
+
+        dcpWorkerOptions.leavePublicGroup = Boolean(slicesFetched > 0);
+      }
     }
   }
 
@@ -395,7 +420,7 @@ async function main()
     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';
-  else if (dcpWorkerOptions.leavePublicGroup)
+  if (dcpWorkerOptions.leavePublicGroup)
     introBanner += ' . Leaving the public compute group' + '\n';
   if (dcpWorkerOptions.cores)
     introBanner += ` . Target cores: ${JSON.stringify(dcpWorkerOptions.cores)}\n`;
@@ -679,7 +704,7 @@ function verifyDefaultConfigIntegrity()
   {
     const originalMd5sum = fs.readFileSync(md5sumPath, 'ascii');
     const actualMd5sum = crypto.createHash('md5')
-          .update(fs.readFileSync(workerConfPath, 'ascii'))
+          .update(fs.readFileSync(workerConfPath))
           .digest('hex');
 
     if (!originalMd5sum.startsWith(actualMd5sum))
@@ -707,3 +732,12 @@ function verifyDefaultConfigIntegrity()
     process.exit(1);
   }
 }
+
+/**
+ * Cast b to boolean such that 'false' becomes false, falsey things become false, and everything else
+ * becomes true.
+ */
+function mkBool(b)
+{
+  return Boolean(b) && (b !== 'false');
+}

package/lib/startWorkerLogger.js

@@ -30,7 +30,10 @@ function getLogger({ outputMode='detect' }) {
   catch (error)
   {
     console.error(`032: Failed to load worker logger "${outputMode}":`, error);
-    throw new Error(`Unknown outputMode "${outputMode}"`);
+
+    if (error.code === 'MODULE_NOT_FOUND')
+      throw new Error(`Unknown outputMode "${outputMode}"`);
+    throw error;
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "3.2.28",
+  "version": "3.2.30-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",
@@ -37,7 +37,7 @@
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",
     "chalk": "^4.1.0",
-    "dcp-client": "4.2.31",
+    "dcp-client": "gitlab:Distributed-Compute-Protocol/dcp-client#develop",
     "semver": "^7.3.8"
   },
   "optionalDependencies": {
@@ -49,6 +49,6 @@
   },
   "engines": {
     "node": ">=16",
-    "npm": ">=6"
+    "npm": ">=7"
   }
 }