@soundworks/core 3.0.4 → 3.1.0-beta.3

package/common/SharedStatePrivate.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _parameters = _interopRequireDefault(require("@ircam/parameters"));
+var _ParameterBag = _interopRequireDefault(require("./ParameterBag.js"));
 
 var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
 
@@ -22,92 +22,133 @@ class SharedStatePrivate {
   constructor(id, schemaName, schema, manager, initValues = {}) {
     this.id = id;
     this.schemaName = schemaName;
-    this._schema = (0, _lodash.default)(schema);
     this._manager = manager;
-    this._parameters = (0, _parameters.default)(schema, initValues);
+    this._parameters = new _ParameterBag.default(schema, initValues);
     this._attachedClients = new Map(); // other peers interested in watching / controlling the state
 
     this._creatorRemoteId = null;
     this._creatorId = null;
   }
 
-  _attachClient(remoteId, client, isCreator = false) {
+  _attachClient(remoteId, client, isOwner = false) {
     this._attachedClients.set(remoteId, client);
 
-    if (isCreator) {
+    if (isOwner) {
       this._creatorRemoteId = remoteId;
       this._creatorId = client.id;
     } // attach client listeners
 
 
-    client.transport.addListener(`${_sharedStateUtils.UPDATE_REQUEST}-${this.id}-${remoteId}`, (reqId, updates) => {
-      const updated = {};
-      let dirty = false;
+    client.transport.addListener(`${_sharedStateUtils.UPDATE_REQUEST}-${this.id}-${remoteId}`, async (reqId, updates, context) => {
+      // apply registered hooks
+      const hooks = this._manager._hooksBySchemaName.get(this.schemaName);
 
-      for (let name in updates) {
-        const currentValue = this._parameters.get(name); // get new value this way to store events return values
+      const values = this._parameters.getValues();
 
+      let hookAborted = false; // cf. https://github.com/collective-soundworks/soundworks/issues/45
 
-        const newValue = this._parameters.set(name, updates[name]); // we check the `schema[name].type === 'any'`, to always consider
-        // objects as dirty, because if the state is attached locally, we
-        // compare the Object instances instead of their values.
-        // @todo - this should be made more robust but how?
+      for (let hook of hooks.values()) {
+        const result = await hook(updates, values, context);
 
-
-        if (newValue !== currentValue || this._schema[name].type === 'any') {
-          updated[name] = newValue;
-          dirty = true;
+        if (result === null) {
+          // explicit abort if hook returns null
+          hookAborted = true;
+          break;
+        } else if (result === undefined) {
+          // implicit continue if hook returns undefined
+          continue;
+        } else {
+          // the hook returned an updates object
+          updates = result;
         }
       }
 
-      if (dirty) {
-        // send response to requester
-        // client.transport.emit(`${UPDATE_RESPONSE}-${this.id}-${remoteId}`, reqId, updated);
-        // @note: we propagate server-side last, because as the server transport
-        // is synchronous it can break ordering if a subscription function makes
-        // itself an update in reaction to an update, therefore network messages
-        // order would be broken,
-        // we need to handle cases where:
-        // client state (client.id: 2) sends a request
-        // server attached state (client.id: -1) spot a problem and overrides the value
-        // we want the remote client (id: 2) to receive in the right order:
-        // * 1. the value it requested,
-        // * 2. the value overriden by the server-side attached state (id: -1)
-        // this problem could be solved properly with a reducer system:
-        // if (dirty) {
-        //   -> call (async) reducer
-        //   -> get values from reducer
-        //.  -> dispatch to everybody
-        // }
-        for (let [peerRemoteId, peer] of this._attachedClients.entries()) {
-          // propagate notification to all other attached clients except server
-          if (remoteId !== peerRemoteId && peer.id !== -1) {
-            peer.transport.emit(`${_sharedStateUtils.UPDATE_NOTIFICATION}-${this.id}-${peerRemoteId}`, updated);
+      if (hookAborted === false) {
+        const filteredUpdates = {};
+        let hasUpdates = false;
+
+        for (let name in updates) {
+          // from v3.1.0 - the `filteredUpdates` check is made using 'fast-deep-equal'
+          //    cf. https://github.com/epoberezkin/fast-deep-equal
+          //    therefore unchanged objects are not considered changed
+          //    nor propagated anymore.
+          // until v3.0.4 - we checked the `schema[name].type === 'any'`, to always consider
+          //    objects as dirty, because if the state is attached locally, we
+          //    compare the Object instances instead of their values.
+          //    @note - this should be made more robust but how?
+          const [newValue, changed] = this._parameters.set(name, updates[name]); // if `filterChange` is set to `false` we don't check if the value
+          // has been changed or not, it is always propagated to client states
+
+
+          const {
+            filterChange
+          } = this._parameters.getSchema(name);
+
+          if (filterChange && changed || !filterChange) {
+            filteredUpdates[name] = newValue;
+            hasUpdates = true;
           }
         }
 
-        if (client.id !== -1) {
-          client.transport.emit(`${_sharedStateUtils.UPDATE_RESPONSE}-${this.id}-${remoteId}`, reqId, updated);
-        }
+        if (hasUpdates) {
+          // send response to requester
+          // client.transport.emit(`${UPDATE_RESPONSE}-${this.id}-${remoteId}`, reqId, filteredUpdates);
+          // @note: we propagate server-side last, because as the server transport
+          // is synchronous it can break ordering if a subscription function makes
+          // itself an update in reaction to an update, therefore network messages
+          // order would be broken,
+          // we need to handle cases where:
+          // client state (client.id: 2) sends a request
+          // server attached state (client.id: -1) spot a problem and overrides the value
+          // we want the remote client (id: 2) to receive in the right order:
+          // * 1. the value it requested,
+          // * 2. the value overriden by the server-side attached state (id: -1)
+          // this problem could be solved properly with a reducer system:
+          // if (dirty) {
+          //   -> call (async) reducer
+          //   -> get values from reducer
+          //.  -> dispatch to everybody
+          // }
+          for (let [peerRemoteId, peer] of this._attachedClients.entries()) {
+            // propagate notification to all other attached clients except server
+            if (remoteId !== peerRemoteId && peer.id !== -1) {
+              peer.transport.emit(`${_sharedStateUtils.UPDATE_NOTIFICATION}-${this.id}-${peerRemoteId}`, filteredUpdates, context);
+            }
+          }
 
-        for (let [peerRemoteId, peer] of this._attachedClients.entries()) {
-          // propagate notification to server
-          if (remoteId !== peerRemoteId && peer.id === -1) {
-            peer.transport.emit(`${_sharedStateUtils.UPDATE_NOTIFICATION}-${this.id}-${peerRemoteId}`, updated);
+          if (client.id !== -1) {
+            client.transport.emit(`${_sharedStateUtils.UPDATE_RESPONSE}-${this.id}-${remoteId}`, reqId, filteredUpdates, context);
+          }
+
+          for (let [peerRemoteId, peer] of this._attachedClients.entries()) {
+            // propagate notification to server
+            if (remoteId !== peerRemoteId && peer.id === -1) {
+              peer.transport.emit(`${_sharedStateUtils.UPDATE_NOTIFICATION}-${this.id}-${peerRemoteId}`, filteredUpdates, context);
+            }
           }
-        }
 
-        if (client.id === -1) {
-          client.transport.emit(`${_sharedStateUtils.UPDATE_RESPONSE}-${this.id}-${remoteId}`, reqId, updated);
+          if (client.id === -1) {
+            client.transport.emit(`${_sharedStateUtils.UPDATE_RESPONSE}-${this.id}-${remoteId}`, reqId, filteredUpdates, context);
+          }
+        } else {
+          // propagate back to the requester that the update has been aborted
+          // ignore all other attached clients.
+          client.transport.emit(`${_sharedStateUtils.UPDATE_ABORT}-${this.id}-${remoteId}`, reqId, updates, context);
         }
       } else {
-        // propagate back to the requester that the update has been aborted
-        // ignore all other attached clients.
-        client.transport.emit(`${_sharedStateUtils.UPDATE_ABORT}-${this.id}-${remoteId}`, reqId, updates);
+        // retrieve values from inner state (also handle immediate approriately)
+        const oldValues = {};
+
+        for (let name in updates) {
+          oldValues[name] = this._parameters.get(name);
+        } // aborted by hook (updates have been overriden to {})
+
+
+        client.transport.emit(`${_sharedStateUtils.UPDATE_ABORT}-${this.id}-${remoteId}`, reqId, oldValues, context);
       }
     });
 
-    if (isCreator) {
+    if (isOwner) {
       // delete only if creator
       client.transport.addListener(`${_sharedStateUtils.DELETE_REQUEST}-${this.id}-${remoteId}`, reqId => {
         this._manager._serverStatesById.delete(this.id); // --------------------------------------------------------------------

package/common/shared-state-utils.js

@@ -3,11 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.UPDATE_RESPONSE = exports.UPDATE_REQUEST = exports.UPDATE_NOTIFICATION = exports.UPDATE_ABORT = exports.SERVER_ID = exports.OBSERVE_RESPONSE = exports.OBSERVE_REQUEST = exports.OBSERVE_NOTIFICATION = exports.DETACH_RESPONSE = exports.DETACH_REQUEST = exports.DETACH_ERROR = exports.DELETE_SCHEMA = exports.DELETE_RESPONSE = exports.DELETE_REQUEST = exports.DELETE_NOTIFICATION = exports.DELETE_ERROR = exports.CREATE_RESPONSE = exports.CREATE_REQUEST = exports.CREATE_ERROR = exports.ATTACH_RESPONSE = exports.ATTACH_REQUEST = exports.ATTACH_ERROR = void 0;
 exports.idGenerator = idGenerator;
-exports.storeRequestPromise = storeRequestPromise;
-exports.resolveRequest = resolveRequest;
 exports.rejectRequest = rejectRequest;
-exports.UPDATE_NOTIFICATION = exports.UPDATE_ABORT = exports.UPDATE_RESPONSE = exports.UPDATE_REQUEST = exports.OBSERVE_NOTIFICATION = exports.OBSERVE_RESPONSE = exports.OBSERVE_REQUEST = exports.DETACH_ERROR = exports.DETACH_RESPONSE = exports.DETACH_REQUEST = exports.ATTACH_ERROR = exports.ATTACH_RESPONSE = exports.ATTACH_REQUEST = exports.DELETE_NOTIFICATION = exports.DELETE_ERROR = exports.DELETE_RESPONSE = exports.DELETE_REQUEST = exports.CREATE_ERROR = exports.CREATE_RESPONSE = exports.CREATE_REQUEST = exports.SERVER_ID = void 0;
+exports.resolveRequest = resolveRequest;
+exports.storeRequestPromise = storeRequestPromise;
 // id of the server when owner of a state
 const SERVER_ID = -1;
 exports.SERVER_ID = SERVER_ID;
@@ -35,8 +35,7 @@ const DETACH_REQUEST = 's:dt:req';
 exports.DETACH_REQUEST = DETACH_REQUEST;
 const DETACH_RESPONSE = 's:dt:res';
 exports.DETACH_RESPONSE = DETACH_RESPONSE;
-const DETACH_ERROR = 's:dt:err'; // usefull
-
+const DETACH_ERROR = 's:dt:err';
 exports.DETACH_ERROR = DETACH_ERROR;
 const OBSERVE_REQUEST = 's:o:req';
 exports.OBSERVE_REQUEST = OBSERVE_REQUEST;
@@ -52,6 +51,8 @@ const UPDATE_ABORT = 's:u:ab';
 exports.UPDATE_ABORT = UPDATE_ABORT;
 const UPDATE_NOTIFICATION = 's:u:not';
 exports.UPDATE_NOTIFICATION = UPDATE_NOTIFICATION;
+const DELETE_SCHEMA = 's:d:s';
+exports.DELETE_SCHEMA = DELETE_SCHEMA;
 
 function* idGenerator() {
   for (let i = 0; true; i++) {

package/common/sockets-encoder-decoder.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.packBinaryMessage = packBinaryMessage;
-exports.unpackBinaryMessage = unpackBinaryMessage;
 exports.packStringMessage = packStringMessage;
+exports.unpackBinaryMessage = unpackBinaryMessage;
 exports.unpackStringMessage = unpackStringMessage;
 
 require("fast-text-encoding");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "3.0.4",
+  "version": "3.1.0-beta.3",
   "description": "full-stack javascript framework for distributed audio visual experiences on the web",
   "authors": [
     "Benjamin Matuszewski",
@@ -18,10 +18,10 @@
   "main": "",
   "scripts": {
     "clean": "rm -Rf client && rm -Rf server && rm -Rf common",
-    "docs": "rm -Rf docs && jsdoc -c .jsdoc.json --verbose && cp -R assets docs/",
+    "doc": "rm -Rf docs && jsdoc -c .jsdoc.json --verbose && cp -R assets docs/",
     "prepublishOnly": "npm run build",
     "toc": "markdown-toc -i README.md",
-    "version": "npm run toc && npm run docs && git add docs",
+    "version": "npm run toc && npm run doc && git add docs",
     "build:client": "babel src/client --out-dir client",
     "build:server": "babel src/server --out-dir server",
     "build:common": "babel src/common --out-dir common",
@@ -32,37 +32,38 @@
     "dev": "npm run build && (npm run dev:client & npm run dev:server & npm run dev:common)"
   },
   "dependencies": {
-    "@ircam/parameters": "^1.2.2",
-    "braintree-jsdoc-template": "^3.3.0",
-    "chalk": "^2.4.2",
+    "chalk": "^4.1.2",
     "columnify": "^1.5.4",
     "compression": "^1.7.1",
     "debug": "^4.1.1",
+    "fast-deep-equal": "^3.1.3",
     "fast-text-encoding": "^1.0.0",
     "isomorphic-ws": "^4.0.1",
-    "jsdoc-template": "^1.2.0",
-    "keyv": "^3.1.0",
-    "keyv-file": "^0.1.13",
+    "keyv": "^4.0.3",
+    "keyv-file": "^0.2.0",
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
     "pem": "^1.12.5",
     "polka": "^0.5.2",
     "serve-static": "^1.13.2",
-    "uuidv4": "^4.0.0",
+    "uuid": "^8.3.2",
     "window-or-global": "^1.0.1",
-    "ws": "^7.0.0"
+    "ws": "^8.2.3"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
     "@babel/core": "^7.4.5",
-    "@babel/plugin-proposal-export-default-from": "^7.5.2",
     "@babel/preset-env": "^7.4.5",
     "chai": "^4.2.0",
     "chokidar": "^3.0.1",
-    "chokidar-cli": "^1.2.2",
+    "chokidar-cli": "^3.0.0",
     "docdash": "^1.2.0",
     "jsdoc": "^3.6.2",
     "markdown-toc": "^1.2.0",
-    "mocha": "^8.1.3"
+    "mocha": "^9.1.3"
+  },
+  "optionalDependencies": {
+    "bufferutil": "^4.0.5",
+    "utf-8-validate": "^5.0.7"
   }
 }

package/server/Client.js

@@ -5,9 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _uuidv = _interopRequireDefault(require("uuidv4"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _uuid = require("uuid");
 
 function* idGenerator() {
   for (let i = 0; true; i++) {
@@ -47,7 +45,7 @@ class Client {
        * @type {String}
      */
 
-    this.uuid = (0, _uuidv.default)();
+    this.uuid = (0, _uuid.v4)();
     /**
      * Socket connection with the remote {@link client.Client}.
      * @type {server.Socket}

package/server/PluginManager.js

@@ -86,7 +86,8 @@ class PluginManager {
 
   register(name, factory = null, options = {}, deps = []) {
     if (this._registeredPlugins[name]) {
-      throw new Error(`Plugin "${name}" already registered`);
+      const ctor = factory(_AbstractPlugin.default);
+      throw new Error(`[soundworks:core] Plugin "${name}" of type "${ctor.name}" already registered`);
     }
 
     const ctor = factory(_AbstractPlugin.default);
@@ -105,7 +106,7 @@ class PluginManager {
 
   get(name, _experience = null) {
     if (!this._registeredPlugins[name]) {
-      throw new Error(`Cannot get or require plugin "${name}", plugin is not registered
+      throw new Error(`[soundworks:core] Cannot get or require plugin "${name}", plugin is not registered
 > registered plugins are:
 ${Object.keys(this._registeredPlugins).map(n => `> - ${n}\n`).join('')}
 `);
@@ -113,7 +114,7 @@ ${Object.keys(this._registeredPlugins).map(n => `> - ${n}\n`).join('')}
 
 
     if (_experience && this.signals.start.value === true) {
-      throw new Error(`Plugin "${name}" required after pluginManager start`);
+      throw new Error(`[soundworks:core] Plugin "${name}" required after pluginManager start`);
     }
 
     if (!this._instances[name]) {

package/server/Server.js

@@ -35,12 +35,17 @@ var _Sockets = _interopRequireDefault(require("./Sockets.js"));
 
 var _SharedStateManagerServer = _interopRequireDefault(require("../common/SharedStateManagerServer.js"));
 
-var _Db = _interopRequireDefault(require("./utils/Db.js"));
-
 var _logger = _interopRequireDefault(require("./utils/logger.js"));
 
+var _keyv = _interopRequireDefault(require("keyv"));
+
+var _keyvFile = _interopRequireDefault(require("keyv-file"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+let _dbNamespaces = new Set();
+
+let _dbStore = null;
 /**
  * Server side entry point for a `soundworks` application.
  *
@@ -58,6 +63,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * const myExperience = new MyExperience();
  * soundworks.server.start();
  */
+
 class Server {
   constructor() {
     /**
@@ -98,7 +104,7 @@ class Server {
      * @private
      */
 
-    this.db = new _Db.default();
+    this.db = this.createNamespacedDb('core');
     /**
      * The {@link server.Sockets} instance. A small wrapper around
      * [`ws`](https://github.com/websockets/ws) server.
@@ -320,8 +326,8 @@ class Server {
             }
           } else {
             return new Promise(async (resolve, reject) => {
-              const key = await this.db.get('server:httpsKey');
-              const cert = await this.db.get('server:httpsCert');
+              const key = await this.db.get('httpsKey');
+              const cert = await this.db.get('httpsCert');
 
               if (key && cert) {
                 this._httpsInfos = {
@@ -346,8 +352,8 @@ class Server {
                     key: keys.serviceKey,
                     cert: keys.certificate
                   };
-                  await this.db.set('server:httpsKey', this._httpsInfos.key);
-                  await this.db.set('server:httpsCert', this._httpsInfos.cert);
+                  await this.db.set('httpsKey', this._httpsInfos.key);
+                  await this.db.set('httpsCert', this._httpsInfos.cert);
 
                   const httpsServer = _https.default.createServer(this._httpsInfos);
 
@@ -566,6 +572,44 @@ class Server {
       });
     });
   }
+  /**
+   * Create namespaced databases for core and plugins
+   * (kind of experiemental API do not expose in doc for now)
+   *
+   * @note - introduced in v3.1.0-beta.1
+   * @note - used by core and plugin-audio-streams
+   * @private
+   */
+
+
+  createNamespacedDb(namespace = null) {
+    if (namespace === null || !(typeof namespace === 'string')) {
+      throw new Error(`[soundworks:core] Invalid namespace for ".createNamespacedDb(namespace)", namespace is mandatory and should be a string`);
+    }
+
+    if (_dbNamespaces.has(namespace)) {
+      throw new Error(`[soundworks:core] Invalid namespace for ".createNamespacedDb(namespace)", namespace "${namespace}" already exists`);
+    }
+
+    const dbDirectory = _path.default.join(process.cwd(), '.data');
+
+    if (!_fs.default.existsSync(dbDirectory)) {
+      _fs.default.mkdirSync(dbDirectory);
+    }
+
+    const filename = _path.default.join(dbDirectory, `soundworks-${namespace}.db`); // at note keyv-file doesn't seems to works
+
+
+    const store = new _keyvFile.default({
+      filename
+    });
+    const db = new _keyv.default({
+      namespace,
+      store
+    });
+    db.on('error', err => console.log(chalk.red('[soundworks:core] db ${namespace} error:'), err));
+    return db;
+  }
 
 }
 

package/server/utils/Db.js

@@ -1,67 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _keyv = _interopRequireDefault(require("keyv"));
-
-var _keyvFile = _interopRequireDefault(require("keyv-file"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _fs = _interopRequireDefault(require("fs"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Simple in file key / value database.
- * Do not expose for now, may not be the right way to go...
- *
- * @todo - implement options to change storage solution.
- * cf. https://github.com/lukechilds/keyv
- *
- * @memberof server
- * @private
- */
-class Db {
-  constructor(options = {}) {
-    const dbDirectory = _path.default.join(process.cwd(), '.data');
-
-    if (!_fs.default.existsSync(dbDirectory)) {
-      _fs.default.mkdirSync(dbDirectory);
-    }
-
-    const filename = _path.default.join(dbDirectory, 'soundworks.db');
-
-    this.keyv = new _keyv.default({
-      namespace: 'soundworks',
-      store: new _keyvFile.default({
-        filename
-      })
-    });
-    this.keyv.on('error', err => console.log('Connection Error', err));
-  }
-
-  async get(key) {
-    const value = await this.keyv.get(key);
-    return value;
-  }
-
-  async set(key, value, expireDelayMs = undefined) {
-    await this.keyv.set(key, value, expireDelayMs);
-  }
-
-  async delete(key) {
-    await this.keyv.delete(key);
-  }
-
-  async clear() {
-    await this.keyv.clear();
-  }
-
-}
-
-var _default = Db;
-exports.default = _default;