@soundworks/core 3.1.0-beta.2 → 3.1.0-beta.3

package/common/ParameterBag.js

@@ -12,6 +12,7 @@ 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
@@ -484,6 +499,8 @@ class ParameterBag {
   }
   /**
    * 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);
 
@@ -177,14 +179,37 @@ ${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);
     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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "3.1.0-beta.2",
+  "version": "3.1.0-beta.3",
   "description": "full-stack javascript framework for distributed audio visual experiences on the web",
   "authors": [
     "Benjamin Matuszewski",
@@ -39,7 +39,6 @@
     "fast-deep-equal": "^3.1.3",
     "fast-text-encoding": "^1.0.0",
     "isomorphic-ws": "^4.0.1",
-    "jsdoc-template": "^1.2.0",
     "keyv": "^4.0.3",
     "keyv-file": "^0.2.0",
     "lodash.clonedeep": "^4.5.0",