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

package/CHANGELOG.md

@@ -1,6 +1,10 @@
+## v4.0.0-alpha.17 - 16/12/2023
+
+- Support bundling the server to cjs for Max externals
+
 ## v4.0.0-alpha.16 - 15/12/2023
 
-- improve StateCollection performances
+- Improve StateCollection performances
 
 ## v4.0.0-alpha.15 - 13/12/2023
 

package/package.json

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

package/src/client/Context.js

@@ -9,6 +9,9 @@ import {
   CONTEXT_EXIT_ERROR,
 } from '../common/constants.js';
 
+// share between all context, as channels are common to all contexts
+const promiseStore = new PromiseStore('Context');
+
 /**
  * Base class to extend in order to implement a new Context.
  *
@@ -77,15 +80,12 @@ class Context {
      */
     this.status = 'idle';
 
-    /** @private */
-    this._promiseStore = new PromiseStore(this.constructor.name);
-
     this.client.socket.addListener(CONTEXT_ENTER_RESPONSE, (reqId, contextName) => {
       if (contextName !== this.name) {
         return;
       }
 
-      this._promiseStore.resolve(reqId);
+      promiseStore.resolve(reqId);
     });
 
     this.client.socket.addListener(CONTEXT_ENTER_ERROR, (reqId, contextName, msg) => {
@@ -93,7 +93,7 @@ class Context {
         return;
       }
 
-      this._promiseStore.reject(reqId, msg);
+      promiseStore.reject(reqId, msg);
     });
 
     this.client.socket.addListener(CONTEXT_EXIT_RESPONSE, (reqId, contextName) => {
@@ -101,7 +101,7 @@ class Context {
         return;
       }
 
-      this._promiseStore.resolve(reqId);
+      promiseStore.resolve(reqId);
     });
 
     this.client.socket.addListener(CONTEXT_EXIT_ERROR, (reqId, contextName, msg) => {
@@ -109,7 +109,7 @@ class Context {
         return;
       }
 
-      this._promiseStore.reject(reqId, msg);
+      promiseStore.reject(reqId, msg);
     });
 
     this.client.contextManager.register(this);
@@ -205,7 +205,7 @@ class Context {
     // we need the try/catch block to change the promise rejection into proper error
     try {
       await new Promise((resolve, reject) => {
-        const reqId = this._promiseStore.add(resolve, reject, 'enter-context');
+        const reqId = promiseStore.add(resolve, reject, 'enter-context');
         this.client.socket.send(CONTEXT_ENTER_REQUEST, reqId, this.name);
       });
     } catch (err) {
@@ -239,7 +239,7 @@ class Context {
     // we need the try/catch block to change the promise rejection into proper error
     try {
       await new Promise((resolve, reject) => {
-        const reqId = this._promiseStore.add(resolve, reject, 'exit-context');
+        const reqId = promiseStore.add(resolve, reject, 'exit-context');
         this.client.socket.send(CONTEXT_EXIT_REQUEST, reqId, this.name);
       });
     } catch (err) {

package/src/common/BaseSharedState.js

@@ -320,6 +320,10 @@ ${JSON.stringify(initValues, null, 2)}`);
    * const updates = await state.set({ myParam: Math.random() });
    */
   async set(updates, context = null) {
+    if (this._detached) {
+      return;
+    }
+
     if (!isPlainObject(updates)) {
       throw new ReferenceError(`[SharedState] State "${this.schemaName}": state.set(updates[, context]) should receive an object as first parameter`);
     }

package/src/common/BaseSharedStateCollection.js

@@ -3,9 +3,7 @@ import {
   kAttachInCollection,
 } from './BaseStateManager.js';
 
-/**
- * @private
- */
+/** @private */
 class BaseSharedStateCollection {
   constructor(stateManager, schemaName, options = {}) {
     this._stateManager = stateManager;
@@ -21,6 +19,7 @@ class BaseSharedStateCollection {
     this._unobserve = null;
   }
 
+  /** @private */
   async _init() {
     this._controller = await this._stateManager[kCreateCollectionController](this._schemaName);
     this._controller.onUpdate(async (updates, context) => {

package/src/common/PromiseStore.js

@@ -1,32 +1,39 @@
 import { idGenerator } from '@ircam/sc-utils';
 
-const generateRequestId = idGenerator();
-
 export default class PromiseStore {
   constructor(name) {
     this.name = name;
     this.store = new Map();
+    this.generateRequestId = idGenerator();
   }
 
   add(resolve, reject, type) {
-    const reqId = generateRequestId.next().value;
+    const reqId = this.generateRequestId.next().value;
     this.store.set(reqId, { resolve, reject, type });
 
     return reqId;
   }
 
   resolve(reqId, data) {
-    const { resolve } = this.store.get(reqId);
-    this.store.delete(reqId);
+    if (this.store.has(reqId)) {
+      const { resolve } = this.store.get(reqId);
+      this.store.delete(reqId);
 
-    resolve(data);
+      resolve(data);
+    } else {
+      throw new Error(`[${this.name}] cannot resolve request id (${reqId}), id does not exist`);
+    }
   }
 
   reject(reqId, msg) {
-    const { reject } = this.store.get(reqId);
-    this.store.delete(reqId);
+    if (this.store.has(reqId)) {
+      const { reject } = this.store.get(reqId);
+      this.store.delete(reqId);
 
-    reject(new Error(msg));
+      reject(new Error(msg));
+    } else {
+      throw new Error(`[${this.name}] cannot reject request id (${reqId}), id does not exist`);
+    }
   }
 
   // reject all pendeing request

package/src/server/Sockets.js

@@ -1,14 +1,17 @@
 import { Worker } from 'node:worker_threads';
 import path from 'node:path';
-import { fileURLToPath } from 'node:url';
+// import { fileURLToPath } from 'node:url';
 
 import querystring from 'querystring';
 import { WebSocketServer } from 'ws';
 import WebSocket from 'ws';
 
 import Socket from './Socket.js';
+import networkLatencyWorker from './audit-network-latency.worker.js';
 
-const __dirname = fileURLToPath(new URL('.', import.meta.url));
+// this crashes when bundling server to cjs module for Max, fallback to
+// string worker for now
+// const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 /**
  * Manager all {@link server.Socket} instances.
@@ -45,8 +48,9 @@ class Sockets {
    */
   async start(server, config, onConnectionCallback) {
     // init audit stuff for network latency estimation
-    const workerPathname = path.join(__dirname, 'audit-network-latency.worker.js');
-    this._latencyStatsWorker = new Worker(workerPathname);
+    // @see note about __dirname
+    // const workerPathname = path.join(__dirname, 'audit-network-latency.worker.js');
+    this._latencyStatsWorker = new Worker(networkLatencyWorker, { eval: true });
     this._auditState = await server.getAuditState();
 
     this._auditState.onUpdate(updates => {

package/src/server/audit-network-latency.worker.js

@@ -1,6 +1,8 @@
-import { parentPort } from 'node:worker_threads';
-
-import { getTime } from '@ircam/sc-utils';
+// NOTICE: we use this syntax so that the server can be bundled to cjs
+// with esbuild, so we can ship a cjs server bundle into Max.
+// Should move back to regular esm module once Max has fixed its loader
+export default `
+const { parentPort } = require('node:worker_threads');
 
 let stack = [];
 let averageLatencyWindow = 5;
@@ -9,12 +11,21 @@ let averageLatencyPeriod = 2;
 let intervalId = null;
 let meanLatency = 0;
 
-parentPort.on('message', msg => {
+let getTime;
+let inited = new Promise(async (resolve) => {
+  module = await import('@ircam/sc-utils');
+  getTime = module.getTime;
+  resolve(true);
+});
+
+parentPort.on('message', async msg => {
   switch (msg.type) {
     case 'config': {
       averageLatencyWindow = msg.value.averageLatencyWindow;
       averageLatencyPeriod = msg.value.averageLatencyPeriod;
 
+      await inited;
+
       // launch compute in its own loop so that the number of computation is
       // decoupled from the number of connected clients
       clearInterval(intervalId);
@@ -55,3 +66,4 @@ function computeAverageLatency() {
     });
   }
 }
+`;