dcp-worker 4.5.3 → 4.6.0

package/.gitlab-ci.yml

@@ -8,6 +8,11 @@ variables:
   npm_config_cache: '.cache/npm/'
   npm_config_prefer_offline: 'true'
   npm_config_fund: 'false'
+  # DCP_BUILD variables only apply when using a gitlab-hosted dcp-client
+  DCP_BUILD: debug
+  DCP_BUILD_BRANCH: develop
+  DCP_BUILD_HOST: 'http://dcp-client-srv.office.distributive.network'
+  DCP_CLIENT_GITLAB: 'gitlab:Distributed-Compute-Protocol/dcp-client#'
 
 default:
   # Use in-house GitLab runners.
@@ -28,6 +33,8 @@ workflow:
     # Only run branch pipelines for `develop`, or merge request pipelines.
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
     - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    # Allow manually running a branch pipeline without opening an MR first.
+    - if: $CI_PIPELINE_SOURCE == "web" || $CI_PIPELINE_SOURCE == "api"
 
 stages:
   - build
@@ -40,6 +47,12 @@ build:
   stage: build
   script:
     - npm clean-install
+    - DCP_CLIENT_VERSION=`node -p "require('./package.json').dependencies['dcp-client']"`
+    - DCP_CLIENT_ORIGIN=`printf "${DCP_CLIENT_GITLAB}"`
+    - |
+      [[ "${DCP_CLIENT_VERSION}" == "gitlab:"* ]] &&
+      wget "${DCP_BUILD_HOST}/?dcpClient=${DCP_CLIENT_VERSION//$DCP_CLIENT_ORIGIN/}&build=${DCP_BUILD}" -O node_modules/dcp-client/dist/dcp-client-bundle.js
+    - echo "Done" # Because CI will error if the last command returns with a non-zero exit code... and the above will be unless a specific dcp-client version is required
   cache:
     - key:
         prefix: $CI_JOB_NAME_SLUG

package/README.md

@@ -156,7 +156,7 @@ A Node.js daemon which
 A Node.js daemon which
 * manages a ledger for DCC. This is not a blockchain currency.
 * enables the movement of DCC between entities requesting work and entities performing work
-* enables the movement of DCC between the ledger and the blockchain
+* enables the movement of DCC between the ledger and Paypal
 * enables the placement of DCC in escrow on behalf of the Scheduler for work which is anticipated to be done
 
 #### Compute Group
@@ -167,7 +167,7 @@ A user-facing web application which allows or enables
 * creation and management of user accounts
 * management of bank accounts (ledgers)
 * transfer of DCC between bank accounts
-* transfer of DCC to and from the blockchain
+* transfer of DCC to and from USD
 * execution of the browser-based Worker
 
 #### Worker
@@ -209,7 +209,7 @@ A group of related modules
 A parallel supercomputer consisting of one or more schedulers and workers.  When used as a proper noun, the distributed computer being discussed is the one hosted at https://portal.distributed.computer/
 
 #### Bank Account
-A ledger which acts a repository for DCC which is not on the block chain.  The Bank can move DCC between Bank Accounts much more quickly than it can move DCC between Addresses on the Ethereum block chain network.  Meta data attached to bank accounts can restrict certain operations, such as ear-marking funds for use only by job deployment.
+A ledger which acts a repository for DCC which is not on the block chain. Meta data attached to bank accounts can restrict certain operations, such as ear-marking funds for use only by job deployment.
 
 #### Address
 A unique identifier in DCP which can be used to identity a bank account, user, compute group, etc.

package/bin/dcp-worker

@@ -644,6 +644,9 @@ async function main()
   if (loggingOptions.verbose)
     console.info(` + Verbosity level: ${loggingOptions.verbose}`);
 
+  if (worker.config.pidfile && require('../lib/pidfile').write(worker.config.pidfile) !== true)
+    await cleanupThenExit(exitCodes.pidConflict);
+
   /* Poll the evaluator forever until it accepts a connection */
   let evaluatorInfo = false;
   let p$throbSleep;
@@ -665,7 +668,7 @@ async function main()
       utils.noteWorkerStart(worker);
     if (performance.now() - ts > 100)
       console.throb();
-    p$throbSleep = a$sleep(Math.max(i + 1, 10) / 4);
+    p$throbSleep = a$sleep(Math.min(i + 1, 30) / 4);
     await p$throbSleep;
     console.throb();
   }
@@ -807,9 +810,6 @@ async function main()
     }
   });
 
-  if (worker.config.pidfile && require('../lib/pidfile').write(worker.config.pidfile) !== true)
-    await cleanupThenExit(exitCodes.pidConflict);
-
   if (worker.config.claimEarnings === false && !worker.config.unmanaged)
   {
     const amount = await DistributiveWorker.checkUnclaimedEarnings();
@@ -934,7 +934,7 @@ async function cleanupThenExit(exitCode)
     worker.stop(true); /* toggle internal worker state so it won't surprise us by starting sandboxes */
   }
 
-  console.warn(' ! begin shutdown, exit code =', exitCode);
+  console.warn(' ! shutdown, exit code =', exitCode);
   const p$workerShutdownTasks = Promise.all([
     require('../lib/p2p-shared').shutdown(),
     utils.noteWorkerShutdown(worker),

package/lib/p2p-shared.js

@@ -16,8 +16,9 @@ const debug  = require('debug');
 const assert = require('assert');
 const wallet = require('dcp/wallet');
 
-const { a$sleep } = require('dcp/utils');
-const { DcpURL }  = require('dcp/dcp-url');
+const { DistributiveWorker } = require('dcp/worker');
+const { a$sleep }            = require('dcp/utils');
+const { DcpURL }             = require('dcp/dcp-url');
 
 const version = '1.0.0';
 var worker;     /* singleton instance of DistributiveWorker - held even after stop */
@@ -80,6 +81,11 @@ exports.shutdown = async function shutdown()
   await p2p.cleanupForExit();
 }
 
+/**
+ * Send an announcement to the worker. This carries ad-hoc information about changes in the internal
+ * worker state. Many elements in the UI are affected by the announcement via worker-announce-*
+ * attributes.
+ */
 function announce(announcement, details)
 {
   debug('dcp-worker:p2p')('sending anouncement', announcement);
@@ -94,7 +100,7 @@ function announce(announcement, details)
   }
 
   if (!exports.disabled)
-    p2p.sendMessage(`worker-${workerId}-announce`, { announce: announcement, version }, owner);
+    p2p.sendMessage(`worker-${workerId}-announce`, { announce: announcement, version, details }, owner);
 }
 
 function enqRespond(message, details)
@@ -182,6 +188,72 @@ function pauseWorker()
   return p$pause;
 }
 
+/**
+ * Replace an existing configuration value, coercing value as necessary.
+ * @param {string} path        path within worker.config to the current value, eg utilization.cpu
+ * @param {string} value       the new value
+ */
+function replaceConfigValue(path, value)
+{
+  var node = worker.config;
+  var components = path.split('.');
+  var component;
+
+  if (!/^([a-z][A-Za-z0-9_.]+)+$/.test(path))
+    throw new Error(`invalid config path: ${path}`);
+
+  while((component = components.shift()))
+  {
+    if (components.length === 0)
+      break;
+    if (!node[component])
+    {
+      console.error(`Invalid property ${component} in ${path}`);
+      return;
+    }
+    node = node[component];
+  }
+
+  switch(typeof node[component])
+  {
+    case 'object':
+      if (node[component] === null)
+      {
+        console.error(`cannot replace null value at ${path}`);
+        break;
+      }
+      /* fallthrough */
+    default:
+      console.error(`cannot replace ${typeof node[component]} at ${path}`);
+      break;
+    case 'number':
+      value = value.trim();
+      if (value.endsWith('%'))
+        value = parseInt(value, 10) / 100;
+      replaceWith(Number(value));
+      break;
+    case 'boolean':
+      switch(value)
+      {
+        case 'true':  replaceWith(true);  break;
+        case 'false': replaceWith(false); break;
+        default:
+          console.error(`cannot replace boolean component at ${path} with ${value}`);
+          break;
+      }
+      break;
+    case 'string':
+      replaceWith(value)
+      break;
+  }
+
+  function replaceWith(newValue)
+  {
+    console.info(`worker.config.${path}: ${node[component]} => ${newValue}`);
+    node[component] = newValue;
+  }
+}
+
 /**
  * Handle a control message, eg from the portal.  Control messages are sent on channel worker-ID and
  * tell the worker what to do, eg enable logs, reboot, change configuration, etc.  These are always
@@ -222,18 +294,13 @@ function handleControlMessage(message, channel, sender, originator)
       console.info(' . Unpausing worker');
       break;
     case 'stop':
+      console.info(' . Remote peer requested worker stop');
       worker.stop(message.arguments?.[0]); /* announcement comes from worker<stop> */
       break;
     case 'halt':
       throw new Error(`halt (p2p ${message.sender})`);
-    case 'set-cores':
-      Object.assign(worker.config.cores, message.arguments[0]);
-      worker.dropSandboxes();
-      console.info(' . Set cores:',  worker.config.cores);
-      break;
-    case 'set-max-sandboxes':
-      worker.config.maxSandboxes = Number(message.arguments[0]);
-      console.info(' . Set max sandboxes:',  worker.config.maxSandboxes);
+    case 'replace-config-value':
+      replaceConfigValue.apply(null, message.arguments);
       break;
     case 'update-runinfo':
       worker.updateRunInfo();
@@ -264,6 +331,26 @@ function handleControlMessage(message, channel, sender, originator)
       }).finally(() => worker.stop(true));
       break;
     }
+    case 'claim':
+    {
+      const earningsAccount = new wallet.Address(message.arguments[0]);
+      DistributiveWorker.transferUnclaimedEarnings(earningsAccount).then(res => {
+        if (res.payload)
+        {
+          console.log(` ! Claimed ${res.payload} ⊇ for ${earningsAccount}`);
+          announce('alert', `Moved ${res.payload} ⊇ into account ${earningsAccount.toShortString()}`);
+        }
+      });
+    }
+    /* fallthrough */
+    case 'set-earnings-account':
+    {
+      const newAccount = new wallet.Address(message.arguments[0]);
+      worker.config.paymentAddress = newAccount;
+      console.info(` . Set earnings account: ${worker.config.paymentAddress}`);
+      announce('earnings-account', String(worker.config.paymentAddress));
+      break;
+    }
     case 'enq':
       handleEnquireMessage(message, channel, sender, originator);
       break;

package/lib/show.js

@@ -36,7 +36,7 @@ async function show(worker, mode)
     case 'identity':
       return identity.get().address;
     case 'owner':
-      return await require('./utils').getOwner(worker) || 'worker is not registered';
+      return String(await require('./utils').getOwner(worker)) || 'worker is not registered';
     case 'earnings-account':
       return false
       || (worker.config.paymentAddress && String(worker.config.paymentAddress))

package/lib/worker-info.js

@@ -72,18 +72,15 @@ async function eval$$getInfo()
  */
 function getEvaluatorInformation(evaluatorConfig)
 {
+  if (!getEvaluatorInformation.seq)
+    getEvaluatorInformation.seq = 0;
+  const seq = ++getEvaluatorInformation.seq;
   const StandaloneWorker = require('dcp-client/lib/standaloneWorker').workerFactory(evaluatorConfig);
-  const evaluatorHandle = new StandaloneWorker({ name: 'DCP Sandbox #1', });
-  var resolve, reject;
-  const p$workerInfo = new Promise((res, rej) => {
-    resolve = res;
-    reject = rej;
-  }).finally(() => {
-    evaluatorHandle.terminate();
-    evaluatorHandle.removeAllListeners();
-  });
-  evaluatorHandle.addEventListener('end', () => resolve(false));
-  evaluatorHandle.addEventListener('error', reject);
+  const evaluatorHandle = new StandaloneWorker({ name: `DCP Probe Sandbox #${seq}` });
+  const pr$workerInfo = Promise.withResolvers();
+
+  evaluatorHandle.addEventListener('end', () => pr$workerInfo.resolve(false));
+  evaluatorHandle.addEventListener('error', pr$workerInfo.reject);
   evaluatorHandle.ref();
 
   evaluatorHandle.onmessage = function onmessage(__event)
@@ -94,18 +91,29 @@ function getEvaluatorInformation(evaluatorConfig)
     {
       const workerInfo = reply.data;
       if (typeof workerInfo !== 'object' || !workerInfo.worktimes || !workerInfo.webgpu)
-        throw new Error(`malformed response from evaluator`);
-      resolve(workerInfo);
+        throw new Error('malformed response from evaluator');
+      pr$workerInfo.resolve(workerInfo);
     }
   }
 
+  const timerId = setTimeout(() => {
+    pr$workerInfo.resolve(false);
+  }, 5000); /* 5000ms is about 4800ms more than this should take even on a busy machine. */
+
   const message = {
     request: 'eval',
     data: '(' + eval$$getInfo.toString() + ')()',
     msgId: evaluatorId,
   }
+
+  pr$workerInfo.promise.finally(() => {
+    evaluatorHandle.terminate();
+    evaluatorHandle.removeAllListeners();
+    clearTimeout(timerId);
+  });
+
   evaluatorHandle.postMessage(StandaloneWorker.encodeMessage(message));
-  return p$workerInfo;
+  return pr$workerInfo.promise;
 }
 
 exports.getEvaluatorInformation = getEvaluatorInformation;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "4.5.3",
+  "version": "4.6.0",
   "description": "Node.js Worker for Distributive Compute Platform",
   "main": "bin/dcp-worker",
   "keywords": [
@@ -39,7 +39,7 @@
     "blessed": "0.1.81",
     "blessed-contrib": "4.11.0",
     "chalk": "4.1.2",
-    "dcp-client": "^5.7.5",
+    "dcp-client": "gitlab:Distributed-Compute-Protocol/dcp-client#feature/worker-management3",
     "kvin": "9.1.0",
     "mux-net": "github:wesgarland/mux-net#e7f81800db4a84ec880026596f7ee68549a6d0f5",
     "posix-getopt": "1.2.1",

package/www/hud/small-dark.html

@@ -191,6 +191,9 @@ async function init()
     logger(`[worker.warning] ${JSON.stringify(warn, null, 2)}`);
   });
 
+  worker.on("connect", () => {
+    logger('Connected to worker, listening for events');
+  });
 }
 
 const logLines = [];