@soundworks/core 5.1.2 → 5.2.0

package/package.json

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

package/src/common/BaseStateManager.js

@@ -18,7 +18,7 @@ import {
   OBSERVE_ERROR,
   OBSERVE_NOTIFICATION,
   UNOBSERVE_NOTIFICATION,
-  DELETE_SHARED_STATE_CLASS,
+  // DELETE_SHARED_STATE_CLASS,
   GET_CLASS_DESCRIPTION_REQUEST,
   GET_CLASS_DESCRIPTION_RESPONSE,
   GET_CLASS_DESCRIPTION_ERROR,
@@ -49,7 +49,6 @@ export const kStateManagerClient = Symbol('soundworks:state-manager-client');
 /** @private */
 class BaseStateManager {
   #statesById = new Map();
-  #cachedClasses = new Map(); // <className, definition>
   #observeListeners = new Set(); // Set <[observedClassName, callback, options]>
   #observeRequestCallbacks = new Map(); // Map <reqId, [observedClassName, callback, options]>
   #promiseStore = null;
@@ -100,15 +99,6 @@ class BaseStateManager {
     this[kStateManagerClient].transport.addListener(
       CREATE_RESPONSE,
       (reqId, stateId, instanceId, className, classDescription, initValues) => {
-        // cache class description to save some bandwidth
-        // @note: when we make the class dynamic, we will need some mechanism to
-        // invalidate the cached description
-        if (!this.#cachedClasses.has(className)) {
-          this.#cachedClasses.set(className, classDescription);
-        }
-
-        classDescription = this.#cachedClasses.get(className);
-
         const state = new SharedState({
           manager: this,
           className,
@@ -136,15 +126,6 @@ class BaseStateManager {
     this[kStateManagerClient].transport.addListener(
       ATTACH_RESPONSE,
       (reqId, stateId, instanceId, className, classDescription, currentValues, filter) => {
-        // cache class description to save some bandwidth
-        // @note: when we make the class dynamic, we will need some mechanism to
-        // invalidate the cached description
-        if (!this.#cachedClasses.has(className)) {
-          this.#cachedClasses.set(className, classDescription);
-        }
-
-        classDescription = this.#cachedClasses.get(className);
-
         const state = new SharedState({
           manager: this,
           className,
@@ -224,24 +205,19 @@ class BaseStateManager {
     );
 
     // ---------------------------------------------
-    // Clear cache when a shared state class is deleted
+    // note 2025-05-05: caching of class descriptions has been removed because it
+    // could create concurrency issues
+    // cf. `should be able to recreate a class with the same name` unit test
     // ---------------------------------------------
-    this[kStateManagerClient].transport.addListener(DELETE_SHARED_STATE_CLASS, className => {
-      this.#cachedClasses.delete(className);
-    });
+    // this[kStateManagerClient].transport.addListener(DELETE_SHARED_STATE_CLASS, _className => {});
 
     // ---------------------------------------------
     // Get class description
     // ---------------------------------------------
     this[kStateManagerClient].transport.addListener(
       GET_CLASS_DESCRIPTION_RESPONSE,
-      (reqId, className, classDescription) => {
+      (reqId, _className, classDescription) => {
         const fullDescription = ParameterBag.getFullDescription(classDescription);
-
-        if (!this.#cachedClasses.has(className)) {
-          this.#cachedClasses.set(className, fullDescription);
-        }
-
         this.#promiseStore.resolve(reqId, fullDescription);
       },
     );
@@ -268,10 +244,6 @@ class BaseStateManager {
       throw new DOMException(`Cannot execute 'getClassDescription' on BaseStateManager: BaseStateManager is not inited`, 'InvalidStateError');
     }
 
-    if (this.#cachedClasses.has(className)) {
-      return this.#cachedClasses.get(className);
-    }
-
     return new Promise((resolve, reject) => {
       const reqId = this.#promiseStore.add(resolve, reject, 'BaseStateManager#getClassDescription');
       this[kStateManagerClient].transport.emit(GET_CLASS_DESCRIPTION_REQUEST, reqId, className);
@@ -302,8 +274,7 @@ class BaseStateManager {
 
     return new Promise((resolve, reject) => {
       const reqId = this.#promiseStore.add(resolve, reject, 'BaseStateManager#create');
-      const requireDescription = this.#cachedClasses.has(className) ? false : true;
-      this[kStateManagerClient].transport.emit(CREATE_REQUEST, reqId, className, requireDescription, initValues);
+      this[kStateManagerClient].transport.emit(CREATE_REQUEST, reqId, className, initValues);
     });
   }
 
@@ -411,8 +382,7 @@ class BaseStateManager {
 
     return new Promise((resolve, reject) => {
       const reqId = this.#promiseStore.add(resolve, reject, 'BaseStateManager#attach');
-      const requireDescription = this.#cachedClasses.has(className) ? false : true;
-      this[kStateManagerClient].transport.emit(ATTACH_REQUEST, reqId, className, stateId, requireDescription, filter);
+      this[kStateManagerClient].transport.emit(ATTACH_REQUEST, reqId, className, stateId, filter);
     });
   }
 

package/src/common/version.js

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

package/src/server/ServerStateManager.js

@@ -19,7 +19,7 @@ import {
   OBSERVE_ERROR,
   OBSERVE_NOTIFICATION,
   UNOBSERVE_NOTIFICATION,
-  DELETE_SHARED_STATE_CLASS,
+  // DELETE_SHARED_STATE_CLASS,
   GET_CLASS_DESCRIPTION_REQUEST,
   GET_CLASS_DESCRIPTION_RESPONSE,
   GET_CLASS_DESCRIPTION_ERROR,
@@ -206,7 +206,7 @@ class ServerStateManager extends BaseStateManager {
     // ---------------------------------------------
     client.transport.addListener(
       CREATE_REQUEST,
-      async (reqId, className, requireDescription, initValues = {}) => {
+      async (reqId, className, initValues = {}) => {
         if (this.#classes.has(className)) {
           try {
             const classDescription = this.#classes.get(className);
@@ -243,7 +243,6 @@ class ServerStateManager extends BaseStateManager {
             this.#sharedStatePrivateById.set(stateId, state);
 
             const currentValues = state.parameters.getValues();
-            const classDescriptionOption = requireDescription ? classDescription : null;
 
             client.transport.emit(
               CREATE_RESPONSE,
@@ -251,7 +250,7 @@ class ServerStateManager extends BaseStateManager {
               stateId,
               instanceId,
               className,
-              classDescriptionOption,
+              classDescription,
               currentValues,
             );
 
@@ -278,7 +277,7 @@ class ServerStateManager extends BaseStateManager {
     // ---------------------------------------------
     client.transport.addListener(
       ATTACH_REQUEST,
-      (reqId, className, stateId = null, requireDescription = true, filter = null) => {
+      (reqId, className, stateId = null, filter = null) => {
         if (this.#classes.has(className)) {
           let state = null;
 
@@ -305,7 +304,6 @@ class ServerStateManager extends BaseStateManager {
             const isOwner = false;
             const currentValues = state.parameters.getValues();
             const classDescription = this.#classes.get(className);
-            const classDescriptionOption = requireDescription ? classDescription : null;
 
             // if filter given, check that all filter entries are valid class keys
             // @todo - improve error reporting: report invalid filters
@@ -327,7 +325,7 @@ class ServerStateManager extends BaseStateManager {
               state.id,
               instanceId,
               className,
-              classDescriptionOption,
+              classDescription,
               currentValues,
               filter,
             );
@@ -525,10 +523,14 @@ class ServerStateManager extends BaseStateManager {
       }
     }
 
-    // clear class cache of all connected clients
-    for (let client of this[kStateManagerClientsByNodeId].values()) {
-      client.transport.emit(`${DELETE_SHARED_STATE_CLASS}`, className);
-    }
+    // ---------------------------------------------
+    // note 2025-05-05: client-side caching of class descriptions has been removed
+    // because it could create concurrency issues
+    // cf. `should be able to recreate a class with the same name` unit test
+    // ---------------------------------------------
+    // for (let client of this[kStateManagerClientsByNodeId].values()) {
+    //   client.transport.emit(`${DELETE_SHARED_STATE_CLASS}`, className);
+    // }
 
     this.#classes.delete(className);
     // delete registered hooks
@@ -545,6 +547,16 @@ class ServerStateManager extends BaseStateManager {
     this.deleteClass(className);
   }
 
+  /**
+   * Check wether a {@link SharedState} is defined or not, given its {@link SharedStateClassName}
+   *
+   * @param {SharedStateClassName} className - Name of the shared state class to delete.
+   * @returns {boolean}
+   */
+  isClassDefined(className) {
+    return this.#classes.has(className);
+  }
+
   /**
    * Register a function for a given class of shared state class to be executed
    * when a state is created.

package/types/common/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "5.1.2";
+declare const _default: "5.2.0";
 export default _default;

package/types/server/ServerStateManager.d.ts

@@ -130,6 +130,13 @@ declare class ServerStateManager extends BaseStateManager {
      * @deprecated Use {@link ServerStateManager#defineClass} instead.
      */
     deleteSchema(className: any): void;
+    /**
+     * Check wether a {@link SharedState} is defined or not, given its {@link SharedStateClassName}
+     *
+     * @param {SharedStateClassName} className - Name of the shared state class to delete.
+     * @returns {boolean}
+     */
+    isClassDefined(className: SharedStateClassName): boolean;
     /**
      * Register a function for a given class of shared state class to be executed
      * when a state is created.