@soundworks/core 4.0.0-alpha.21 → 4.0.0-alpha.22

package/CHANGELOG.md

@@ -1,4 +1,9 @@
-## v4.0.0-alpha.21 - 19/02/2025
+## v4.0.0-alpha.22 - 16/05/2025
+
+- Feat: allow configuring socket endpoint on browser clients
+- Check and warn if version inconsistency between server and client
+
+## v4.0.0-alpha.21 - 6/05/2025
 
 - Fix: prevent multiple 'close' events
 - Fix: disable heartbeat check on client-side, was unstable

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "4.0.0-alpha.21",
+  "version": "4.0.0-alpha.22",
   "description": "Open-source creative coding framework for distributed applications based on Web technologies",
   "authors": [
     "Benjamin Matuszewski",
@@ -48,7 +48,8 @@
     "test": "npx mocha",
     "test:all": "npx mocha tests/*/*.spec.js",
     "types": "rm -Rf types && tsc",
-    "postversion": "node ./misc/scripts/check-changelog.js"
+    "preversion": "node ./misc/scripts/generate-version-file.js $npm_new_version",
+    "postversion": "node ./misc/scripts/check-changelog.js && git commit -am \"$npm_new_version\" --allow-empty"
   },
   "dependencies": {
     "@ircam/sc-utils": "^1.3.2",

package/src/client/Client.js

@@ -11,11 +11,12 @@ import {
   AUDIT_STATE_NAME,
 } from '../common/constants.js';
 import logger from '../common/logger.js';
+import version from '../common/version.js';
 
 /**
  * Configuration object for a client running in a browser runtime.
  *
- * @typedef BrowserClientConfig
+ * @typedef ClientConfig
  * @memberof client
  * @type {object}
  * @property {string} role - Role of the client in the application (e.g. 'player', 'controller').
@@ -23,24 +24,10 @@ import logger from '../common/logger.js';
  * @property {string} [app.name=''] - Name of the application.
  * @property {string} [app.author=''] - Name of the author.
  * @property {object} [env] - Environment configration object.
- * @property {string} [env.websockets={}] - Configuration options for websockets.
- * @property {string} [env.subpath=''] - If running behind a proxy, path to the application.
- */
-
-/**
- * Configuration object for a client running in a node runtime.
- *
- * @typedef NodeClientConfig
- * @memberof client
- * @type {object}
- * @property {string} role - Role of the client in the application (e.g. 'player', 'controller').
- * @property {object} [app] - Application configration object.
- * @property {string} [app.name=''] - Name of the application.
- * @property {string} [app.author=''] - Name of the author.
- * @property {object} env - Environment configration object.
- * @property {boolean} env.serverAddress - Domain name or IP of the server.
- * @property {boolean} env.useHttps - Define is the server run in http or in https.
- * @property {boolean} env.port - Port on which the server is listening.
+ * @property {boolean} env.useHttps - Define if the websocket should use secure connection.
+ * @property {boolean} [env.serverAddress=''] - Address the socket server. Mandatory for
+ *  node clients. For browser clients, use `window.location.domain` as fallback if empty.
+ * @property {boolean} env.port - Port of the socket server.
  * @property {string} [env.websockets={}] - Configuration options for websockets.
  * @property {string} [env.subpath=''] - If running behind a proxy, path to the application.
  */
@@ -66,8 +53,7 @@ import logger from '../common/logger.js';
  */
 class Client {
   /**
-   * @param {client.BrowserClientConfig|client.NodeClientConfig} config -
-   *  Configuration of the soundworks client.
+   * @param {client.ClientConfig} config - Configuration of the soundworks client.
    * @throws Will throw if the given config object is invalid.
    */
   constructor(config) {
@@ -104,6 +90,13 @@ class Client {
       }
     }
 
+    /**
+     * package version
+     * @type string
+     * @readonly
+     */
+    this.version = version;
+
     /**
      * Role of the client in the application.
      *
@@ -114,7 +107,7 @@ class Client {
     /**
      * Configuration object.
      *
-     * @type {client.BrowserClientConfig|client.NodeClientConfig}
+     * @type {client.ClientConfig}
      */
     this.config = config;
 
@@ -246,11 +239,26 @@ class Client {
     try {
       await new Promise((resolve, reject) => {
         // wait for handshake response before starting stateManager and pluginManager
-        this.socket.addListener(CLIENT_HANDSHAKE_RESPONSE, async ({ id, uuid, token }) => {
+        this.socket.addListener(CLIENT_HANDSHAKE_RESPONSE, async ({ id, uuid, token, version }) => {
           this.id = id;
           this.uuid = uuid;
           this.token = token;
 
+          if (version !== this.version) {
+            console.warn(`
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+WARNING
+
+Version discrepancies between server and "${this.role}" client:
++ server: ${version} | client: ${this.version}
+
+This might lead to unexpected behavior, you should consider to update your
+dependancies on both your server and clients.
+
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!`);
+          }
+
           resolve();
         });
 
@@ -276,6 +284,7 @@ class Client {
         // send handshake request
         const payload = {
           role: this.role,
+          version: this.version,
           registeredPlugins: this.pluginManager.getRegisteredPlugins(),
         };
 

package/src/client/Socket.js

@@ -99,25 +99,29 @@ class Socket {
       path = `${config.env.subpath}/${path}`;
     }
 
-    let url;
+    const protocol = config.env.useHttps ? 'wss:' : 'ws:';
+    const port = config.env.port;
+    let serverAddress;
     let webSocketOptions;
 
     if (isBrowser()) {
-      const protocol = window.location.protocol.replace(/^http?/, 'ws');
-      const { hostname, port } = window.location;
+      // if a server address is given in config, use it, else fallback to URL hostname
+      if (config.env.serverAddress !== '') {
+        serverAddress = config.env.serverAddress;
+      } else {
+        serverAddress = window.location.hostname;
+      }
 
-      url = `${protocol}//${hostname}:${port}/${path}`;
       webSocketOptions = [];
     } else {
-      const protocol = config.env.useHttps ? 'wss:' : 'ws:';
-      const { serverAddress, port } = config.env;
+      serverAddress = config.env.serverAddress;
 
-      url = `${protocol}//${serverAddress}:${port}/${path}`;
       webSocketOptions = {
         rejectUnauthorized: false,
       };
     }
 
+    const url = `${protocol}//${serverAddress}:${port}/${path}`;
     let queryParams = `role=${role}&key=${key}`;
 
     if (config.token) {

package/src/client/index.js

@@ -1,3 +1,9 @@
+/**
+ * @license
+ * Copyright (c) 2014-present IRCAM – Centre Pompidou (France, Paris)
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
 /**
  * Client-side part of the `soundworks` framework.
  *

package/src/common/version.js

@@ -0,0 +1,2 @@
+// [WARNING] This file is generated, do not edit
+export default '4.0.0-alpha.22';

package/src/server/Server.js

@@ -32,7 +32,7 @@ import {
   CLIENT_HANDSHAKE_ERROR,
   AUDIT_STATE_NAME,
 } from '../common/constants.js';
-
+import version from '../common/version.js';
 
 let _dbNamespaces = new Set();
 
@@ -162,6 +162,7 @@ class Server {
     if (!isPlainObject(config)) {
       throw new Error(`[soundworks:Server] Invalid argument for Server constructor, config should be an object`);
     }
+
     /**
      * @description Given config object merged with the following defaults:
      * @example
@@ -225,6 +226,8 @@ class Server {
       }
     }
 
+    this.version = version;
+
     /**
      * Instance of the express router.
      *
@@ -908,7 +911,8 @@ Invalid certificate files, please check your:
     });
 
     socket.addListener(CLIENT_HANDSHAKE_REQUEST, async payload => {
-      const { role, registeredPlugins } = payload;
+      const { role, version, registeredPlugins } = payload;
+
 
       if (!roles.includes(role)) {
         console.error(`[soundworks.Server] A client with invalid role ("${role}") attempted to connect`);
@@ -920,6 +924,21 @@ Invalid certificate files, please check your:
         return;
       }
 
+      if (version !== this.version) {
+        console.warn(`
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+WARNING
+
+Version discrepancies between server and "${role}" client:
++ server: ${this.version} | client: ${version}
+
+This might lead to unexpected behavior, you should consider to update your
+dependancies on both your server and clients.
+
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!`);
+      }
+
       try {
         this.pluginManager.checkRegisteredPlugins(registeredPlugins);
       } catch (err) {
@@ -950,7 +969,7 @@ Invalid certificate files, please check your:
       this._onClientConnectCallbacks.forEach(callback => callback(client));
 
       const { id, uuid, token } = client;
-      socket.send(CLIENT_HANDSHAKE_RESPONSE, { id, uuid, token });
+      socket.send(CLIENT_HANDSHAKE_RESPONSE, { id, uuid, token, version: this.version });
     });
   }
 
@@ -1060,6 +1079,12 @@ Invalid certificate files, please check your:
           },
           env: {
             type: config.env.type,
+            // use to configure the socket if the server is running on a different
+            // location than the one the client was served from (cf. #90)
+            useHttps: config.env.useHttps,
+            serverAddress: config.env.serverAddress,
+            port: config.env.port,
+            // other config, to review
             websockets: config.env.websockets,
             subpath: config.env.subpath,
             useMinifiedFile: useMinifiedFile[role],

package/src/server/index.js

@@ -1,3 +1,9 @@
+/**
+ * @license
+ * Copyright (c) 2014-present IRCAM – Centre Pompidou (France, Paris)
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
 /**
  * Server-side part of the *soundworks* framework.
  *