dcp-client 4.4.23 → 4.4.25

package/generated/sandbox-definitions.json

@@ -1 +1 @@
-{"browser":["deny-node","kvin/kvin.js","script-load-wrapper","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap"],"node":["kvin/kvin.js","sa-ww-simulation","script-load-wrapper","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap"],"native":["deny-node","kvin/kvin.js","sa-ww-simulation","script-load-wrapper","native-event-loop","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap"],"nodeTesting":["kvin/kvin.js","sa-ww-simulation","script-load-wrapper","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap","testing.js"],"testing":["deny-node","kvin/kvin.js","sa-ww-simulation","script-load-wrapper","native-event-loop","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap","testing.js"]}
+{"browser":["deny-node","kvin/kvin.js","script-load-wrapper","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","url","polyfills","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap"],"node":["kvin/kvin.js","sa-ww-simulation","script-load-wrapper","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","url","polyfills","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap"],"native":["deny-node","kvin/kvin.js","sa-ww-simulation","script-load-wrapper","native-event-loop","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","url","polyfills","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap"],"nodeTesting":["kvin/kvin.js","sa-ww-simulation","script-load-wrapper","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","url","polyfills","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap","testing.js"],"testing":["deny-node","kvin/kvin.js","sa-ww-simulation","script-load-wrapper","native-event-loop","timer-classes","wrap-event-listeners","event-loop-virtualization","lift-webgl","lift-wasm","lift-webgpu","worktimes","url","polyfills","access-lists","bravojs-init","bravojs/bravo.js","bravojs-env","pyodide-core","calculate-capabilities","bootstrap","testing.js"]}

package/index.js

@@ -37,7 +37,7 @@ const debug   = require('debug');
 const moduleSystem = require('module');
 const { spawnSync } = require('child_process');
 const vm = require('vm');
-const protectedDcpConfigKeys = [ 'system', 'bundle', 'worker', 'standaloneWorker' ];
+const protectedDcpConfigKeys = [ 'system', 'bundle', 'worker', 'evaluator' ];
 
 let initInvoked = false; /* flag to help us detect use of Compute API before init */
 let originalDcpConfig = globalThis.dcpConfig || false; /* not false if user set their own dcpConfig global variable before init */
@@ -440,7 +440,7 @@ function checkConfigFileSafePerms(fullPath, statBuf)
  *  failure is desired behaviour.
  */
 function addConfigFile(existing /*, file path components ... */) {
-  let fullPath = '';
+  let fullPath = process.env.DCP_CLIENT_FILESYSTEM_ROOT || '';
 
   for (let i=1; i < arguments.length; i++) {
     if (!arguments[i])
@@ -708,7 +708,7 @@ function initTail(configFrags, options, finalBundleCode, finalBundleURL)
   var finalBundleLabel; /* symbolic label used for logs describing the source of the final bundle */
   var ret;              /* the return value of the current function - usually the `dcp` object but
                            possibly edited by the postInitTailHook function. */
-  var schedConfLocFun = require('dcp/protocol-v4').getSchedulerConfigLocation;
+  var schedConfLocFun = require('dcp/protocol').getSchedulerConfigLocation;
 
   /* 1 */
   bundleSandbox.dcpConfig = configFrags.internalConfig;
@@ -737,7 +737,7 @@ function initTail(configFrags, options, finalBundleCode, finalBundleURL)
    * closes over the wrong variable and returns `undefined` even though fetch has been used.
    */
   if (schedConfLocFun)
-    require('dcp/protocol-v4').getSchedulerConfigLocation = schedConfLocFun;
+    require('dcp/protocol').getSchedulerConfigLocation = schedConfLocFun;
 
   /* Class patch-up is necessary because the KVIN deserialzation and default initializations earlier
    * would have made instances  of classes inside the first bundle instead of the final bundle.
@@ -768,6 +768,7 @@ function initTail(configFrags, options, finalBundleCode, finalBundleURL)
     delete remoteConfig[protectedKey];
 
   addConfig(workingDcpConfig, configFrags.internalConfig);
+  addConfig(workingDcpConfig, configFrags.defaultConfig);
   addConfig(workingDcpConfig, remoteConfig);
   addConfig(workingDcpConfig, configFrags.localConfig);
   addConfig(workingDcpConfig, originalDcpConfig);

package/lib/standaloneWorker.js

@@ -6,32 +6,26 @@
  *  @author     Wes Garland, wes@sparc.network
  *  @date       March 2018
  */
-"use strict";
-const KVIN = require("kvin"); /* Cannot use internal KVIN to talk to evaluators because we need to send them the source code */
+'use strict';
+
 const { setBackoffInterval, clearBackoffInterval } = require('dcp/dcp-timers');
-const { leafMerge } = require('dcp/utils');
-const dcpConfig = require('dcp/dcp-config');
-const defaultConfig = {
-  debug: process.env.DCP_SAW_DEBUG,
-  quiet: false,
-  evaluatorConnectBackoff:
-  {
-    maxInterval:   5 * 60 * 1000, // max: 5 minutes
-    baseInterval:      10 * 1000, // start: 10s
-    backoffFactor: 1.1            // each fail, back off by 10%
-  },
-};
-dcpConfig.standaloneWorker = Object.assign(dcpConfig.standaloneWorker || {},
-                                           leafMerge(defaultConfig, dcpConfig.standaloneWorker));
-var debugging = dcpConfig.standaloneWorker.debug ? () => true : require('dcp/internal/debugging').scope('saw');
-
-/** StandaloneWorker constructor
- *  @param      code            The code to run in the worker to bootstrap it (setup comms with Supervisor)
+const { leafMerge, deepClone } = require('dcp/utils');
+
+var debugging = require('dcp/internal/debugging').scope('saw');
+
+/**
+ * StandaloneWorker constructor
+ * The running configuration is derived by merging:
+ *  - baked-in defaults
+ *  - dcpConfig.evaluator
+ *  - option.hostname/port/location
+ *
  *  @param      options         Options for the Worker constructor.  These can be options per the specification
  *                              for Web Workers (note: not current propagated) or any of these options:
  *
- *                              hostname:     The hostname of the Evaluator server; default to dcpConfig.evaluator.hostname or localhost.
+ *                              hostname:     The hostname of the Evaluator server; default to dcpConfig.eveluator.hostname or localhost.
  *                              port:         The port number of the Evaluator server; default to dcpConfig.evaluator.port or 9000;
+ *                              location:     URL which contains hostname and port
  *                              readStream:   An instance of Stream.readable connected to an Evaluator
  *                              writeStream:  An instance of Stream.writeable connected to the same Evaluator, default=readStream
  *
@@ -48,12 +42,14 @@ var debugging = dcpConfig.standaloneWorker.debug ? () => true : require('dcp/int
  *    . serial                  sequence number
  *    . serialize               current serialization function
  *    . deserialize             current deserialization function
+ *    . config                  derived configuration
  *  - events:
  *    . error
  *    . message
  */
-function StandaloneWorker(options = {}) {
-  var hostname, port;
+function StandaloneWorker(options = {})
+{
+  const that = this;
   var readStream, writeStream;
   var ee = new (require('events').EventEmitter)('StandaloneWorker');
   var readBuf = ''
@@ -62,9 +58,28 @@ function StandaloneWorker(options = {}) {
   var shutdown;
   var connectTimer = false;
 
-  if (typeof options === 'string') {
-    options = { hostname: arguments[1], port: arguments[2] }
-  }
+  const defaultConfig = {
+    tuning: {
+      noDelay: true,
+      connectBackoff:
+      {
+        maxInterval:   5 * 60 * 1000, // max: 5 minutes
+        baseInterval:      10 * 1000, // start: 10s
+        backoffFactor: 1.1            // each fail, back off by 10%
+      },
+    },
+  };
+  this.config = leafMerge(
+    defaultConfig,
+    deepClone(dcpConfig.evaluator),
+  );
+  delete this.config.listen;
+  if (options.location)
+    this.config.location = options.location;
+  if (options.hostname)
+    this.config.location.hostname = options.hostname;
+  if (options.port)
+    this.config.location.port = options.port;
 
   if (typeof options === 'object' && options.readStream) {
     debugging('lifecycle') && console.debug('Connecting via supplied streams');
@@ -77,27 +92,20 @@ function StandaloneWorker(options = {}) {
   if (!readStream) {
     /* No supplied streams - reach out and connect over TCP/IP */
     let socket = readStream = writeStream = new (require('net')).Socket().unref();
-    let hostname = 'hostname' in options ? options.hostname : dcpConfig.evaluator.location.hostname;
-    let port     = 'port'     in options ? options.port     : dcpConfig.evaluator.location.port;
     let connecting = true;
 
-    if (!hostname)
-      throw new Error(`Invalid evaluator hostname '${hostname}'`);
-    if (!Number(port) || port < 1 || port > 65535)
-      throw new Error(`Invalid evaluator port '${port}'`);
-
-    debugging('lifecycle') && console.debug('Connecting to', hostname + ':' + port);
+    debugging() && console.debug('Connecting to evaluator on', this.config.location.hostname + ':' + this.config.location.port);
     connectTimer = setBackoffInterval(function saWorker$$connect$backoff() {
       if (!connecting)
       {
         connecting = true;
-        socket.connect(port, hostname, /* conn callback */ () => { connecting = false; });
+        socket.connect(that.config.location.port, that.config.location.hostname, () => { connecting = false; });
       }
-    }, dcpConfig.standaloneWorker.evaluatorConnectBackoff);
+    }, this.config.tuning.connectBackoff);
     connectTimer.unref();
 
-    socket.setNoDelay(dcpConfig.worker ? dcpConfig.worker.nagle : true);
-    socket.connect(port, hostname);
+    socket.setNoDelay(this.config.tuning.noDelay ?? true);
+    socket.connect(this.config.location.port, this.config.location.hostname);
     socket.on('connect', beginSession.bind(this));
 
     let alreadySignaled = false;
@@ -281,14 +289,13 @@ function StandaloneWorker(options = {}) {
             ee.emit('error', new Error('Unrecognized message type from worker #' + this.serial + ', \'' + lineObj.type + '\''))
         }
       } catch (e) {
-        console.error('Error processing remote response: \'' + line + '\' (' + e.name + ': ' + e.message + e.stack.split('\n')[1].replace(/^  */, ' ') + ')')
-        throw e
+        ee.emit('error', 'Error processing remote response: \'' + line + '\' (' + e.name + ': ' + e.message + e.stack.split('\n')[1].replace(/^  */, ' ') + ')')
       }
     }
   }.bind(this))
 
   ee.on('error', function standaloneWorker$$Worker$recvData$error (e) {
-    console.error("Evaluator threw an error:", e);
+    debugging() && console.error("Evaluator threw an error:", e);
   })
 
   ee.on('message', function standaloneWorker$$Worker$recvData$message (ev) {
@@ -307,13 +314,13 @@ function StandaloneWorker(options = {}) {
       readStream.destroy();
       if (readStream !== writeStream)
         writeStream.destroy();
-    } catch(e) {
-      console.error(`Warning: could not shutdown evaluator connection ${e.code}`, e);
+    } catch(error) {
+      console.error(`Warning: could not shutdown evaluator connection ${e.code}`, error);
     };
     connected = false;
   }
 
-  debugging('lifecycle') && console.debug('Connecting to', hostname + ':' + port);
+  debugging('lifecycle') && console.debug('Connecting to', this.config.location.hostname + ':' + this.config.location.port);
 
   /** Send a message over the network to a standalone worker */
   this.postMessage = function standaloneWorker$$Worker$postMessage (message) {
@@ -345,8 +352,9 @@ function StandaloneWorker(options = {}) {
 }
 
 /**
- * Function to create constructors which behave very much like the WindowOrWorkerGlobalScope
- * Worker constructor, except they instanciate StandaloneWorker in place of a Web Worker.
+ * Function to create constructors which behave very much like the WindowOrWorkerGlobalScope Worker
+ * constructor, except they instanciate StandaloneWorker in place of a Web Worker. This factory
+ * captures the options parameter, so that invocation of the returned constructor does not need to
  *
  * @param       options         options with which to invoke the StandaloneWorker constructor
  *                              when constructing workers.
@@ -355,6 +363,8 @@ exports.workerFactory = function standaloneWorker$$WorkerFactory(options)
 {
   function Worker()
   {
+    if (!new.target)
+      throw new TypeError('Worker constructor: \'new\' is required');
     return new StandaloneWorker(options);
   }