@soundworks/core 3.1.0-beta.0 → 3.1.0-beta.4

package/README.md

@@ -56,6 +56,7 @@ The simplest way to start a new `soundworks` application is using the applicatio
 
 ## Academic Papers
 
+- Benjamin Matuszewski. A Web-Based Framework for Distributed Music System Research and Creation. AES - Journal of the Audio Engineering Society Audio-Accoustics-Application, Audio Engineering Society Inc, 2020. <[hal-03033143](https://hal.archives-ouvertes.fr/hal-03033143)>
 - Benjamin Matuszewski. Soundworks - A Framework for Networked Music Systems on the Web - State of Affairs and New Developments. Proceedings of the Web Audio Conference (WAC) 2019, Dec 2019, Trondheim, Norway. <[hal-02387783](https://hal.archives-ouvertes.fr/hal-02387783)>
 - Benjamin Matuszewski, Norbert Schnell, Frédéric Bevilacqua. Interaction Topologies in Mobile-Based Situated Networked Music Systems. Wireless Communications and Mobile Computing, Hindawi Publishing Corporation, 2019, 2019, pp.9142490. ⟨10.1155/2019/9142490⟩. <[hal-02086673](https://hal.archives-ouvertes.fr/hal-02086673)>
 - Norbert Schnell, Sébastien Robaszkiewicz. Soundworks – A playground for artists and developers to create collaborative mobile web performances. `Proceedings of the Web Audio Conference (WAC'15), 2015, Paris, France. <[hal-01580797](https://hal.archives-ouvertes.fr/hal-01580797)>

package/client/Client.js

@@ -118,7 +118,7 @@ class Client {
       // url: '',
       path: 'socket' // pingInterval: 5 * 1000,
 
-    }, config.env.websockets); // init communications
+    }, config.env.websockets); // init socket communications (string and binary)
 
     await this.socket.init(this.type, this.config);
     return Promise.resolve();

package/client/PluginManager.js

@@ -141,7 +141,8 @@ class PluginManager {
 
   register(name, factory, 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);
@@ -164,7 +165,7 @@ class PluginManager {
 
   get(name, _experienceRequired = false) {
     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('')}
 `);
@@ -172,7 +173,7 @@ ${Object.keys(this._registeredPlugins).map(n => `> - ${n}\n`).join('')}
 
 
     if (_experienceRequired && 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/client/Socket.js

@@ -53,6 +53,13 @@ class Socket {
 
     /** @private */
     this.ws = null;
+    /**
+     * WebSocket instance (binary protocol - binaryType = 'arraybuffer').
+     */
+
+    /** @private */
+
+    this.binaryWs = null;
     this._stringListeners = new Map();
     this._binaryListeners = new Map();
   }
@@ -67,11 +74,11 @@ class Socket {
   /** @private */
 
 
-  init(clientType, config) {
+  async init(clientType, config) {
     // unique key that allows to associate the two sockets to the same client.
     // note: the key is only used to pair to two sockets, so its usage is very
     // limited in time therefore a random number should hopefully be sufficient.
-    const key = (Math.random() + '').replace(/^0./, ''); // open web sockets
+    const key = (Math.random() + '').replace(/^0\./, ''); // open web sockets
 
     let {
       path
@@ -106,47 +113,71 @@ class Socket {
     // ----------------------------------------------------------
 
     const stringSocketUrl = `${url}?binary=0&${queryParams}`;
-    this.ws = new _isomorphicWs.default(stringSocketUrl);
-    log(`string socket initialized - url: ${stringSocketUrl}`);
-    const stringSocketPromise = new Promise((resolve, reject) => {
-      this.ws.addEventListener('open', resolve);
-    }); // parse incoming messages for pubsub
-
-    this.ws.addEventListener('message', e => {
-      const [channel, args] = (0, _socketsEncoderDecoder.unpackStringMessage)(e.data);
-
-      this._emit(false, channel, ...args);
-    }); // broadcast all `WebSocket` native events
-
-    ['open', 'close', 'error', 'upgrade', 'message'].forEach(eventName => {
-      this.ws.addEventListener(eventName, e => {
-        this._emit(false, eventName, e.data);
-      });
-    }); // ----------------------------------------------------------
-    // init binary socket
-    // ----------------------------------------------------------
+    await new Promise((resolve, reject) => {
+      const trySocket = async () => {
+        log(`[string socket] trying connection - url: ${stringSocketUrl}`);
+        const ws = new _isomorphicWs.default(stringSocketUrl);
+        ws.addEventListener('open', connectEvent => {
+          // parse incoming messages for pubsub
+          this.ws = ws;
+          this.ws.addEventListener('message', e => {
+            const [channel, args] = (0, _socketsEncoderDecoder.unpackStringMessage)(e.data);
+
+            this._emit(false, channel, ...args);
+          }); // broadcast all `WebSocket` native events
+
+          ['close', 'error', 'upgrade', 'message'].forEach(eventName => {
+            this.ws.addEventListener(eventName, e => {
+              this._emit(false, eventName, e);
+            });
+          }); // forward open event
+
+          this._emit(false, 'open', connectEvent); // continue with raw socket
+
+
+          resolve();
+        }); // cf. https://github.com/collective-soundworks/soundworks/issues/17
+
+        ws.addEventListener('error', e => {
+          if (e.type === 'error' && e.error.code === 'ECONNREFUSED') {
+            console.log('[socket] connection refused - (retry in 1s)');
+            setTimeout(trySocket, 1000);
+          }
+        });
+      };
+
+      trySocket();
+    }); // // ----------------------------------------------------------
+    // // init binary socket
+    // // ----------------------------------------------------------
 
     const binarySocketUrl = `${url}?binary=1&${queryParams}`;
-    this.binaryWs = new _isomorphicWs.default(binarySocketUrl);
-    this.binaryWs.binaryType = 'arraybuffer';
-    log(`binary socket initialized - url: ${binarySocketUrl}`);
-    const binarySocketPromise = new Promise((resolve, reject) => {
-      this.binaryWs.addEventListener('open', resolve);
-    }); // parse incoming messages for pubsub
-
-    this.binaryWs.addEventListener('message', e => {
-      const [channel, data] = (0, _socketsEncoderDecoder.unpackBinaryMessage)(e.data);
-
-      this._emit(true, channel, data);
-    }); // broadcast all `WebSocket` native events
-
-    ['open', 'close', 'error', 'upgrade', 'message'].forEach(eventName => {
-      this.binaryWs.addEventListener(eventName, e => {
-        this._emit(true, eventName, e.data);
+    await new Promise((resolve, reject) => {
+      log(`[binary socket] trying connection - url: ${binarySocketUrl}`);
+      const ws = new _isomorphicWs.default(binarySocketUrl);
+      ws.binaryType = 'arraybuffer';
+      ws.addEventListener('open', connectEvent => {
+        // parse incoming messages for pubsub
+        this.binaryWs = ws;
+        this.binaryWs.addEventListener('message', e => {
+          const [channel, data] = (0, _socketsEncoderDecoder.unpackBinaryMessage)(e.data);
+
+          this._emit(true, channel, data);
+        }); // broadcast all `WebSocket` native events
+
+        ['close', 'error', 'upgrade', 'message'].forEach(eventName => {
+          this.binaryWs.addEventListener(eventName, e => {
+            this._emit(true, eventName, e);
+          });
+        }); // forward open event
+
+        this._emit(true, 'open', connectEvent);
+
+        resolve();
       });
-    }); // wait for both socket to be opened
+    }); // everyone is connected
 
-    return Promise.all([stringSocketPromise, binarySocketPromise]);
+    return Promise.resolve();
   }
   /** @private */
 

package/common/ParameterBag.js

@@ -3,15 +3,16 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.types = exports.sharedOptions = void 0;
+exports.types = exports.sharedOptions = exports.default = void 0;
 
-var _lodash = _interopRequireDefault(require("lodash.cloneDeep"));
+var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
 
 var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // import types from './types';
+// import shallowClone from 'shallow-clone';
 
 /**
  * @typedef {Object} server.SharedStateManagerServer~schema
@@ -182,6 +183,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * @typedef {Object} server.SharedStateManagerServer~schemaAnyDef
  *
+ * Note that the `any` type always return a shallow copy of the state internal
+ * value. Mutating the returned value will not modify the internal state.
+ *
  * @property {String} [type='any'] - Parameter of any type.
  * @property {Mixed} default - Default value of the parameter.
  * @property {Boolean} [nullable=false] - Define if the parameter is nullable. If
@@ -209,8 +213,8 @@ const sharedOptions = {
   event: false,
   // if event=true, nullable=true
   metas: {},
-  filterChange: true // immediate: false,
-
+  filterChange: true,
+  immediate: false
 };
 exports.sharedOptions = sharedOptions;
 const types = {
@@ -423,10 +427,17 @@ class ParameterBag {
 
 
   getValues() {
-    return Object.assign({}, this._values);
+    let values = {};
+
+    for (let name in this._values) {
+      values[name] = this.get(name);
+    }
+
+    return values;
   }
   /**
-   * Return the value of the given parameter.
+   * Return the value of the given parameter. If the parameter is of `any` type,
+   * a deep copy is returned.
    *
    * @param {String} name - Name of the parameter.
    * @return {Mixed} - Value of the parameter.
@@ -438,7 +449,11 @@ class ParameterBag {
       throw new ReferenceError(`[stateManager] Cannot get value of undefined parameter "${name}"`);
     }
 
-    return this._values[name];
+    if (this._schema[name].type === 'any') {
+      return (0, _lodash.default)(this._values[name]);
+    } else {
+      return this._values[name];
+    }
   }
   /**
    * Set the value of a parameter. If the value of the parameter is updated
@@ -473,17 +488,14 @@ class ParameterBag {
 
     const currentValue = this._values[name];
     const updated = !(0, _fastDeepEqual.default)(currentValue, value);
-    this._values[name] = value;
-
-    if (def.event === true) {
-      this._values[name] = null;
-    } // return tuple so that the state manager can handle the `filterChange` option
-
+    this._values[name] = value; // return tuple so that the state manager can handle the `filterChange` option
 
     return [value, updated];
   }
   /**
    * Reset a parameter to its initialization values. Reset all parameters if no argument.
+   * @note - prefer `state.set(state.getInitValues())`
+   *         or     `state.set(state.getDefaultValues())`
    *
    * @param {String} [name=null] - Name of the parameter to reset.
    */

package/common/SharedState.js

@@ -46,20 +46,18 @@ ${JSON.stringify(initValues, null, 2)}`);
     this._onDetachCallbacks = new Set();
     this._onDeleteCallbacks = new Set(); // add listener for state updates
 
-    client.transport.addListener(`${_sharedStateUtils.UPDATE_RESPONSE}-${id}-${this.remoteId}`, (reqId, updates, context) => {
-      const updated = this._commit(updates, context, true, true);
-
+    client.transport.addListener(`${_sharedStateUtils.UPDATE_RESPONSE}-${id}-${this.remoteId}`, async (reqId, updates, context) => {
+      const updated = await this._commit(updates, context, true, true);
       (0, _sharedStateUtils.resolveRequest)(reqId, updated);
     }); // retrieve values but do not propagate to subscriptions
 
-    client.transport.addListener(`${_sharedStateUtils.UPDATE_ABORT}-${id}-${this.remoteId}`, (reqId, updates, context) => {
-      const updated = this._commit(updates, context, false, true);
-
+    client.transport.addListener(`${_sharedStateUtils.UPDATE_ABORT}-${id}-${this.remoteId}`, async (reqId, updates, context) => {
+      const updated = await this._commit(updates, context, false, true);
       (0, _sharedStateUtils.resolveRequest)(reqId, updated);
     });
-    client.transport.addListener(`${_sharedStateUtils.UPDATE_NOTIFICATION}-${id}-${this.remoteId}`, (updates, context) => {
+    client.transport.addListener(`${_sharedStateUtils.UPDATE_NOTIFICATION}-${id}-${this.remoteId}`, async (updates, context) => {
       // cf. https://github.com/collective-soundworks/soundworks/issues/18
-      this._commit(updates, context, true, false);
+      await this._commit(updates, context, true, false);
     }); // ---------------------------------------------
     // DELETE initiated by creator, or schema deleted
     // ---------------------------------------------
@@ -145,7 +143,7 @@ ${JSON.stringify(initValues, null, 2)}`);
   /** @private */
 
 
-  _commit(updates, context, propagate = true, initiator = false) {
+  async _commit(updates, context, propagate = true, initiator = false) {
     const newValues = {};
     const oldValues = {};
 
@@ -154,7 +152,11 @@ ${JSON.stringify(initValues, null, 2)}`);
         immediate,
         filterChange,
         event
-      } = this._parameters.getSchema(name);
+      } = this._parameters.getSchema(name); // @note 20211209 - we have an issue here server-side, because if the value
+      // is an object or an array, the reference is shared by everybody, therefore
+      // `changed` is always false and the new value is never propagated...
+      // FIXED - `state.get` now returns a deep copy when `type` is `any`
+
 
       const oldValue = this._parameters.get(name);
 
@@ -165,7 +167,7 @@ ${JSON.stringify(initValues, null, 2)}`);
         // @note - we don't need to check filterChange here because the value
         // has been updated in parameters on the `set` side so can rely on `changed`
         // to avoid retrigger listeners.
-        // If the value has overriden by the server, `changed` will true
+        // If the value has been overriden by the server, `changed` will true
         // anyway so it should behave correctly.
         if (!changed || event) {
           continue;
@@ -177,14 +179,48 @@ ${JSON.stringify(initValues, null, 2)}`);
     } // if the `UPDATE_REQUEST` as been aborted by the server, do not propagate
 
 
+    let promises = [];
+
     if (propagate && Object.keys(newValues).length > 0) {
-      this._subscriptions.forEach(listener => listener(newValues, oldValues, context));
+      this._subscriptions.forEach(listener => {
+        promises.push(listener(newValues, oldValues, context));
+      });
+    }
+
+    await Promise.all(promises); // reset events to null after propagation of all listeners
+
+    for (let name in newValues) {
+      const {
+        event
+      } = this._parameters.getSchema(name);
+
+      if (event) {
+        this._parameters.set(name, null);
+      }
     }
 
     return newValues;
   }
   /**
-   * Updates values of the state.
+   * Updates values of the state. Wait for all subscriptions to be resolved
+   * before resolving itself, i.e.:
+   *
+   * ```js
+   * const a = await server.stateManager.create('a');
+   * let asyncCallbackCalled = false;
+   *
+   * a.subscribe(updates => {
+   *   return new Promise(resolve => {
+   *     setTimeout(() => {
+   *       asyncCallbackCalled = true;
+   *       resolve();
+   *     }, 100);
+   *   });
+   * });
+   *
+   * await a.set({ bool: true });
+   * assert.equal(asyncCallbackCalled, true);
+   * ```
    *
    * @async
    * @param {Object} updates - key / value pairs of updates to apply to the state.
@@ -230,7 +266,7 @@ ${JSON.stringify(initValues, null, 2)}`);
 
         const [newValue, changed] = this._parameters.set(name, updates[name]);
 
-        if (changed || filterChange === false) {
+        if (changed || filterChange === false || event) {
           immediateOldValues[name] = oldValue;
           immediateNewValues[name] = newValue;
           propagateNow = true;
@@ -318,7 +354,7 @@ ${JSON.stringify(initValues, null, 2)}`);
    *        // do something
    *      }
    *   }
-   * }
+   * });
    *
    * @see {common.SharedState#set}
    * @see {common.SharedState#subscribe}
@@ -329,6 +365,8 @@ ${JSON.stringify(initValues, null, 2)}`);
    *
    * @param {common.SharedState~subscribeCallback} callback - callback to execute
    *   when an update is applied on the state.
+   * @param {Boolean} [executeListener=false] - execute the given listener with
+   *   current state values. (`oldValues` will be set to `{}`, and `context` to `null`)
    *
    * @example
    * state.subscribe(async (newValues, oldValues) =>  {
@@ -337,13 +375,20 @@ ${JSON.stringify(initValues, null, 2)}`);
    *        // do something
    *      }
    *   }
-   * }
+   * });
    */
 
 
-  subscribe(listener) {
+  subscribe(listener, executeListener = false) {
     this._subscriptions.add(listener);
 
+    if (executeListener === true) {
+      const currentValues = this.getValues();
+      const oldValues = {};
+      const context = null;
+      listener(currentValues, oldValues, context);
+    }
+
     return () => {
       this._subscriptions.delete(listener);
     };

package/common/SharedStateManagerClient.js

@@ -99,6 +99,12 @@ class SharedStateManagerClient {
       list.forEach(([schemaName, stateId, nodeId]) => {
         this._observeListeners.forEach(callback => callback(schemaName, stateId, nodeId));
       });
+    }); // ---------------------------------------------
+    // Clear cache when schema is deleted
+    // ---------------------------------------------
+
+    this.client.transport.addListener(_sharedStateUtils.DELETE_SCHEMA, schemaName => {
+      this._cachedSchemas.delete(schemaName);
     });
   }
   /**

package/common/SharedStateManagerServer.js

@@ -273,6 +273,7 @@ class SharedStateManagerServer extends _SharedStateManagerClient.default {
 
 
   deleteSchema(schemaName) {
+    // @note: deleting schema
     for (let [id, state] of this._serverStatesById.entries()) {
       if (state.schemaName === schemaName) {
         for (let [remoteId, attached] of state._attachedClients.entries()) {
@@ -283,6 +284,11 @@ class SharedStateManagerServer extends _SharedStateManagerClient.default {
 
         this._serverStatesById.delete(this.id);
       }
+    } // clear schema cache of all connected clients
+
+
+    for (let client of this._clientByNodeId.values()) {
+      client.transport.emit(`${_sharedStateUtils.DELETE_SCHEMA}`, schemaName);
     }
 
     this._schemas.delete(schemaName); // delete registered hooks

package/common/SharedStatePrivate.js

@@ -7,6 +7,8 @@ exports.default = void 0;
 
 var _ParameterBag = _interopRequireDefault(require("./ParameterBag.js"));
 
+var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
+
 var _sharedStateUtils = require("./shared-state-utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -41,83 +43,114 @@ class SharedStatePrivate {
       // apply registered hooks
       const hooks = this._manager._hooksBySchemaName.get(this.schemaName);
 
-      const values = this._parameters.getValues(); // @note: we may need a proper update queue to avoid race conditions
+      const values = this._parameters.getValues();
 
+      let hookAborted = false; // cf. https://github.com/collective-soundworks/soundworks/issues/45
 
       for (let hook of hooks.values()) {
-        updates = await hook(updates, values, context);
-      }
-
-      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;
+        const result = await hook(updates, values, context);
+
+        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 (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);
+      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 {
+            event,
+            filterChange
+          } = this._parameters.getSchema(name); // if event type reset internal value to null
+
+
+          if (event) {
+            this._parameters.set(name, null);
           }
-        }
 
-        if (client.id !== -1) {
-          client.transport.emit(`${_sharedStateUtils.UPDATE_RESPONSE}-${this.id}-${remoteId}`, reqId, filteredUpdates, context);
+          if (filterChange && changed || !filterChange) {
+            filteredUpdates[name] = newValue;
+            hasUpdates = true;
+          }
         }
 
-        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 (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);
+            }
+          }
+
+          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, filteredUpdates, context);
+          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, context);
+        // 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);
       }
     });
 

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;
@@ -51,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.1.0-beta.0",
+  "version": "3.1.0-beta.4",
   "description": "full-stack javascript framework for distributed audio visual experiences on the web",
   "authors": [
     "Benjamin Matuszewski",
@@ -32,36 +32,38 @@
     "dev": "npm run build && (npm run dev:client & npm run dev:server & npm run dev:common)"
   },
   "dependencies": {
-    "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/preset-env": "^7.4.5",
-    "braintree-jsdoc-template": "^3.3.0",
     "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;