@soundworks/core 5.3.0 → 5.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "5.3.0",
+  "version": "5.4.1",
   "description": "Open-source creative coding framework for distributed applications based on Web technologies",
   "collaborators": [
     "Benjamin Matuszewski",

package/src/common/BaseStateManager.js

@@ -230,6 +230,17 @@ class BaseStateManager {
     this.#status = 'inited';
   }
 
+  /**
+   * Validates the given class description.
+   *
+   * @throws Throws if the class description is invalid
+   * @param {*} classDescription
+   * @returns undefined
+   */
+  validateClassDescription(classDescription) {
+    return ParameterBag.validateDescription(classDescription);
+  }
+
   /**
    * Return a class description from a given class name
    *

package/src/common/ParameterBag.js

@@ -430,6 +430,19 @@ class ParameterBag {
 
     return defaults;
   }
+
+  // @todo - should cache result
+  getParamListByDescriptor(descriptorName, descriptorValue) {
+    const result = [];
+
+    for (let [name, def] of Object.entries(this.#description)) {
+      if (def[descriptorName] === descriptorValue) {
+        result.push(name);
+      }
+    }
+
+    return result;
+  }
 }
 
 export default ParameterBag;

package/src/common/SharedState.js

@@ -214,11 +214,19 @@ class SharedState {
         this.#clearTransport();
 
         for (let callback of this.#onDetachCallbacks) {
-          await callback();
+          try {
+            await callback();
+          } catch (err) {
+            console.log(err.message);
+          }
         }
 
         for (let callback of this.#onDeleteCallbacks) {
-          await callback();
+          try {
+            await callback();
+          } catch (err) {
+            console.log(err.message);
+          }
         }
 
         this.#onDetachCallbacks.clear();
@@ -240,7 +248,11 @@ class SharedState {
         this.#clearTransport();
 
         for (let callback of this.#onDetachCallbacks) {
-          await callback();
+          try {
+            await callback();
+          } catch (err) {
+            console.log(err.message);
+          }
         }
 
         this.#onDetachCallbacks.clear();

package/src/common/version.js

@@ -1,2 +1,2 @@
 // [WARNING] This file is generated, do not edit
-export default '5.3.0';
+export default '5.4.1';

package/src/server/SharedStatePrivate.js

@@ -127,6 +127,9 @@ class SharedStatePrivate {
       // apply registered hooks
       const hooks = this.#manager[kServerStateManagerGetUpdateHooks](this.className);
       const values = this.#parameters.getValues();
+      // make sur we don't propagate back to requester param that are marked as `acknowledge=false`
+      const acknowledgeFilter = this.#parameters.getParamListByDescriptor('acknowledge', false);
+
       let hookAborted = false;
 
       // cf. https://github.com/collective-soundworks/soundworks/issues/45
@@ -145,13 +148,12 @@ class SharedStatePrivate {
 
       if (hookAborted === false) {
         let acknowledgedUpdates = {};
-        let acknowledgeFilter = [];
 
         for (let name in updates) {
           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, acknowledge } = this.#parameters.getDescription(name);
+          const { event, filterChange } = this.#parameters.getDescription(name);
 
           // if event type reset internal value to null
           if (event) {
@@ -160,10 +162,6 @@ class SharedStatePrivate {
 
           if ((filterChange && changed) || !filterChange) {
             acknowledgedUpdates[name] = newValue;
-
-            if (acknowledge === false) {
-              acknowledgeFilter.push(name);
-            }
           }
         }
 
@@ -247,18 +245,27 @@ class SharedStatePrivate {
             }
           }
         } else {
-          // propagate back to the requester that the update has been aborted, ignore all peers
-          client.transport.emit(`${UPDATE_ABORT}-${this.id}-${instanceId}`, reqId, updates);
+          // @note - abort messages are only sent back to requester
+          const requesterFilteredUpdates = blackListFilterUpdates(updates, acknowledgeFilter);
+
+          if (Object.keys(requesterFilteredUpdates).length > 0) {
+            // propagate back to the requester that the update has been aborted, ignore all peers
+            client.transport.emit(`${UPDATE_ABORT}-${this.id}-${instanceId}`, reqId, requesterFilteredUpdates);
+          }
         }
       } else {
-        // retrieve values from inner state (also handle immediate appropriately)
-        const oldValues = {};
+        // @note - abort messages are only sent back to requester
+        // explicitly aborted by hook (return `null`), send back current values to requester
+        const currentValues = {};
 
         for (let name in updates) {
-          oldValues[name] = this.#parameters.get(name);
+          currentValues[name] = this.#parameters.get(name);
+        }
+
+        const requesterFilteredUpdates = blackListFilterUpdates(currentValues, acknowledgeFilter);
+        if (Object.keys(requesterFilteredUpdates).length > 0) {
+          client.transport.emit(`${UPDATE_ABORT}-${this.id}-${instanceId}`, reqId, requesterFilteredUpdates);
         }
-        // aborted by hook (updates have been overridden to {})
-        client.transport.emit(`${UPDATE_ABORT}-${this.id}-${instanceId}`, reqId, oldValues);
       }
     });
 

package/types/common/BaseStateManager.d.ts

@@ -28,6 +28,14 @@ export type stateManagerDeleteObserveCallback = () => any;
  */
 /** @private */
 declare class BaseStateManager {
+    /**
+     * Validates the given class description.
+     *
+     * @throws Throws if the class description is invalid
+     * @param {*} classDescription
+     * @returns undefined
+     */
+    validateClassDescription(classDescription: any): void;
     /**
      * Return a class description from a given class name
      *

package/types/common/ParameterBag.d.ts

@@ -138,5 +138,6 @@ declare class ParameterBag {
     getDescription(name?: any): object;
     getInitValues(): {};
     getDefaults(): {};
+    getParamListByDescriptor(descriptorName: any, descriptorValue: any): string[];
     #private;
 }

package/types/common/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "5.3.0";
+declare const _default: "5.4.1";
 export default _default;