@soundworks/core 4.0.0-alpha.17 → 4.0.0-alpha.19

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v4.0.0-alpha.19 - 17/01/2024
+
+- Hotfix for #85
+
+## v4.0.0-alpha.18 - 15/01/2024
+
+- Batch network message for SharedStates
+
 ## v4.0.0-alpha.17 - 16/12/2023
 
 - Support bundling the server to cjs for Max externals

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "4.0.0-alpha.17",
+  "version": "4.0.0-alpha.19",
   "description": "Open-source creative coding framework for distributed applications based on Web technologies",
   "authors": [
     "Benjamin Matuszewski",

package/src/common/BaseSharedState.js

@@ -223,9 +223,16 @@ ${JSON.stringify(initValues, null, 2)}`);
     // remove listeners
     this._client.transport.removeAllListeners(`${UPDATE_RESPONSE}-${this.id}-${this.remoteId}`);
     this._client.transport.removeAllListeners(`${UPDATE_NOTIFICATION}-${this.id}-${this.remoteId}`);
-    this._client.transport.removeAllListeners(`${DELETE_RESPONSE}-${this.id}-${this.remoteId}`);
+    this._client.transport.removeAllListeners(`${UPDATE_ABORT}-${this.id}-${this.remoteId}`);
     this._client.transport.removeAllListeners(`${DELETE_NOTIFICATION}-${this.id}-${this.remoteId}`);
-    this._client.transport.removeAllListeners(`${DETACH_RESPONSE}-${this.id}-${this.remoteId}`);
+
+    if (this._isOwner) {
+      this._client.transport.removeAllListeners(`${DELETE_RESPONSE}-${this.id}-${this.remoteId}`);
+      this._client.transport.removeAllListeners(`${DELETE_ERROR}-${this.id}-${this.remoteId}`);
+    } else {
+      this._client.transport.removeAllListeners(`${DETACH_RESPONSE}-${this.id}-${this.remoteId}`);
+      this._client.transport.removeAllListeners(`${DETACH_ERROR}-${this.id}-${this.remoteId}`);
+    }
   }
 
   /** @private */

package/src/common/BaseSharedStateCollection.js

@@ -126,7 +126,11 @@ class BaseSharedStateCollection {
    *   current call and will be passed as third argument to all update listeners.
    */
   async set(updates, context = null) {
-    return await this._controller.set(updates, context);
+    // hot fix for https://github.com/collective-soundworks/soundworks/issues/85
+    // to be cleaned soon
+    const promises = this._states.map(state => state.set(updates, context));
+    return Promise.all(promises);
+    // return await this._controller.set(updates, context);
   }
 
   /**

package/src/common/BaseStateManager.js

@@ -1,6 +1,7 @@
 import { isString, isFunction, isPlainObject } from '@ircam/sc-utils';
 import SharedState from './BaseSharedState.js';
 import SharedStateCollection from './BaseSharedStateCollection.js';
+import BatchedTransport from './BatchedTransport.js';
 import PromiseStore from './PromiseStore.js';
 import {
   CREATE_REQUEST,
@@ -30,7 +31,8 @@ class BaseStateManager {
    *  Must implement a basic EventEmitter API.
    */
   constructor(id, transport) {
-    this.client = { id, transport };
+    // proxy transport with BatchedTransport;
+    this.client = { id, transport: new BatchedTransport(transport) };
 
     this._statesById = new Map(); // <id, state>
     this._cachedSchemas = new Map(); // <shemaName, definition>
@@ -388,7 +390,7 @@ class BaseStateManager {
     try {
       await collection._init();
     } catch (err) {
-      console.log(err.message)
+      console.log(err.message);
       throw new Error(`Cannot create collection, schema "${schemaName}" does not exists`);
     }
 

package/src/common/BatchedTransport.js

@@ -0,0 +1,66 @@
+import { BATCHED_TRANSPORT_CHANNEL } from './constants.js';
+
+/**
+ * This class proxies transports given the SharedStateManager to batch messages
+ * @private
+ */
+class BatchedTransport {
+  constructor(transport) {
+    this._transport = transport;
+    this._stack = [];
+    this._listeners = new Map();
+    this._sending = false;
+
+    this._transport.addListener(BATCHED_TRANSPORT_CHANNEL, stack => {
+      stack.forEach(entry => {
+        const [channel, args] = entry;
+        // server side the transport is the same EventEmitter instance
+        // for both state manager server and client, so channel might not exist
+        // one side or the other.
+        if (this._listeners.has(channel)) {
+          const callbacks = this._listeners.get(channel);
+          callbacks.forEach(callback => callback(...args));
+        }
+      });
+    });
+  }
+
+  addListener(channel, callback) {
+    if (!this._listeners.has(channel)) {
+      this._listeners.set(channel, new Set());
+    }
+
+    const callbacks = this._listeners.get(channel);
+    callbacks.add(callback);
+  }
+
+  async emit(channel, ...args) {
+    this._stack.push([channel, args]);
+
+    if (!this._sending) {
+      this._sending = true;
+      this._sending = await false;
+      const stack = this._stack;
+      this._stack = [];
+      this._transport.emit(BATCHED_TRANSPORT_CHANNEL, stack);
+    }
+  }
+
+  removeListener(channel, callback) {
+    if (!this._listeners.has(channel)) {
+      const callbacks = this._listeners.get(channel);
+      callbacks.delete(callback);
+    }
+  }
+
+  removeAllListeners(channel = null) {
+    if (channel === null) {
+      this._listeners.clear();
+    } else if (this._listeners.has(channel)) {
+      const callbacks = this._listeners.get(channel);
+      callbacks.clear();
+    }
+  }
+}
+
+export default BatchedTransport;

package/src/common/SharedStatePrivate.js

@@ -70,16 +70,7 @@ class SharedStatePrivate {
         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);
@@ -96,25 +87,23 @@ class SharedStatePrivate {
         }
 
         if (hasUpdates) {
-          // Collection Controller logic
+
+          // Collection controller logic
           if (isOwner && inCollection) {
-            // notify the requester back
-            // no need to check for attached clients as it is not observable
+            // notify the collection controller back
             client.transport.emit(
               `${UPDATE_RESPONSE}-${this.id}-${remoteId}`,
-              reqId, filteredUpdates, context
+              reqId, filteredUpdates, context,
             );
 
             // loop through all private states
-            for (let [stateId, state] of this._manager._sharedStatePrivateById) {
+            for (let [_stateId, state] of this._manager._sharedStatePrivateById) {
               // pick all states with same schema name and not this
               if (state !== this && this.schemaName === state.schemaName) {
                 // notify all attached clients except those who belong to a collection
                 // i.e. !isOwner && inCollection, they will be notified by their own
                 // collection controller
                 for (let [remoteId, clientInfos] of state._attachedClients) {
-                  const { client, isOwner, inCollection } = clientInfos;
-
                   if (!clientInfos.isOwner && clientInfos.inCollection) {
                     continue;
                   } else {
@@ -122,7 +111,7 @@ class SharedStatePrivate {
 
                     peer.transport.emit(
                       `${UPDATE_NOTIFICATION}-${state.id}-${remoteId}`,
-                      filteredUpdates, context
+                      filteredUpdates, context,
                     );
                   }
                 }
@@ -131,7 +120,7 @@ class SharedStatePrivate {
           } else {
 
             // Normal case
-
+            //
             // 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
@@ -146,14 +135,14 @@ class SharedStatePrivate {
             // is synchronous it can break ordering if a subscription function makes
             // itself an update in reaction to an update. Propagating to server last
             // alllows to maintain network messages order consistent.
-
+            //
             // @note - remoteId correspond to unique remote state id
 
             // propagate RESPONSE to the client that originates the request if not the server
             if (client.id !== -1) {
               client.transport.emit(
                 `${UPDATE_RESPONSE}-${this.id}-${remoteId}`,
-                reqId, filteredUpdates, context
+                reqId, filteredUpdates, context,
               );
             }
 
@@ -164,7 +153,7 @@ class SharedStatePrivate {
               if (remoteId !== peerRemoteId && peer.id !== -1) {
                 peer.transport.emit(
                   `${UPDATE_NOTIFICATION}-${this.id}-${peerRemoteId}`,
-                  filteredUpdates, context
+                  filteredUpdates, context,
                 );
               }
             }
@@ -173,7 +162,7 @@ class SharedStatePrivate {
             if (client.id === -1) {
               client.transport.emit(
                 `${UPDATE_RESPONSE}-${this.id}-${remoteId}`,
-                reqId, filteredUpdates, context
+                reqId, filteredUpdates, context,
               );
             }
 
@@ -184,7 +173,7 @@ class SharedStatePrivate {
               if (remoteId !== peerRemoteId && peer.id === -1) {
                 peer.transport.emit(
                   `${UPDATE_NOTIFICATION}-${this.id}-${peerRemoteId}`,
-                  filteredUpdates, context
+                  filteredUpdates, context,
                 );
               }
             }

package/src/common/constants.js

@@ -1,6 +1,9 @@
 // id of the server when owner of a state
 export const SERVER_ID = -1;
 
+// batched transport channel
+export const BATCHED_TRANSPORT_CHANNEL = 'b:t';
+
 // shared states channels
 export const CREATE_REQUEST = 's:c:req';
 export const CREATE_RESPONSE = 's:c:res';

package/src/server/Sockets.js

@@ -1,16 +1,11 @@
 import { Worker } from 'node:worker_threads';
-import path from 'node:path';
-// import { fileURLToPath } from 'node:url';
-
 import querystring from 'querystring';
-import { WebSocketServer } from 'ws';
-import WebSocket from 'ws';
+import { default as WebSocket, WebSocketServer } from 'ws';
 
 import Socket from './Socket.js';
 import networkLatencyWorker from './audit-network-latency.worker.js';
 
-// this crashes when bundling server to cjs module for Max, fallback to
-// string worker for now
+// this crashes when bundling server to cjs module for Max, fallback to cjs worker
 // const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 /**

package/src/server/StateManager.js

@@ -4,6 +4,7 @@ import { idGenerator, isString, isPlainObject } from '@ircam/sc-utils';
 import clonedeep from 'lodash/cloneDeep.js';
 
 import BaseStateManager from '../common/BaseStateManager.js';
+import BatchedTransport from '../common/BatchedTransport.js';
 import ParameterBag from '../common/ParameterBag.js';
 import SharedStatePrivate from '../common/SharedStatePrivate.js';
 import {
@@ -344,6 +345,8 @@ class StateManager extends BaseStateManager {
    * @private
    */
   addClient(nodeId, transport) {
+    transport = new BatchedTransport(transport);
+
     const client = { id: nodeId, transport };
     this._clientByNodeId.set(nodeId, client);
 
@@ -360,7 +363,7 @@ class StateManager extends BaseStateManager {
             const remoteId = generateRemoteId.next().value;
             const state = new SharedStatePrivate(stateId, schemaName, schema, this, initValues);
 
-             // attach client to the state as owner
+            // attach client to the state as owner
             const isOwner = true;
             state._attachClient(remoteId, client, isOwner, inCollection);
 
@@ -371,7 +374,7 @@ class StateManager extends BaseStateManager {
 
             client.transport.emit(
               CREATE_RESPONSE,
-              reqId, stateId, remoteId, schemaName, schemaOption, currentValues
+              reqId, stateId, remoteId, schemaName, schemaOption, currentValues,
             );
 
             const isObservable = this[kIsObservableState](state);
@@ -393,7 +396,7 @@ class StateManager extends BaseStateManager {
 
           client.transport.emit(CREATE_ERROR, reqId, msg);
         }
-      }
+      },
     );
 
     // ---------------------------------------------
@@ -434,7 +437,7 @@ class StateManager extends BaseStateManager {
 
             client.transport.emit(
               ATTACH_RESPONSE,
-              reqId, state.id, remoteId, schemaName, schemaOption, currentValues
+              reqId, state.id, remoteId, schemaName, schemaOption, currentValues,
             );
 
           } else {
@@ -449,7 +452,7 @@ class StateManager extends BaseStateManager {
 
           client.transport.emit(ATTACH_ERROR, reqId, msg);
         }
-      }
+      },
     );
 
     // ---------------------------------------------