@soundworks/core 4.0.0-alpha.23 → 4.0.0-alpha.25

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v4.0.0-alpha.25 - 24/05/2025
+
+- Fix: better default behavior for websocket connection URL
+
+## v4.0.0-alpha.24 - 24/05/2025
+
+- Fix: unexpected behavior with new `serverAddress` behavior on browser clients and self-signed certificates
+
 ## v4.0.0-alpha.23 - 24/05/2025
 
 - Breaking: remove binary socket

package/package.json

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

package/src/client/Socket.js

@@ -61,16 +61,34 @@ class Socket {
     let webSocketOptions;
 
     if (isBrowser()) {
-      // if a server address is given in config, use it, else fallback to URL hostname
-      if (config.env.serverAddress !== '') {
-        serverAddress = config.env.serverAddress;
+      const hostname = window.location.hostname;
+
+      if (config.env.serverAddress === '') {
+        serverAddress = hostname;
       } else {
+        serverAddress = config.env.serverAddress;
+      }
+
+      // when in https with self-signed certificates, we don't want to use
+      // the serverAddress defined in config as the socket would be blocked, so we
+      // just override serverAddress with hostname in this case
+      const localhosts = ['127.0.0.1', 'localhost'];
+
+      if (config.env.useHttps && localhosts.includes(hostname)) {
         serverAddress = window.location.hostname;
       }
 
+      if (config.env.useHttps && window.location.hostname !== serverAddress) {
+        console.warn(`The WebSocket will try to connect at ${serverAddress} while the page is accessed from ${hostname}. This can lead to socket errors, e.g. If you run the application with self-signed certificates as the certificate may not have been accepted for ${serverAddress}. In such case you should rather access the page from ${serverAddress}.`);
+      }
+
       webSocketOptions = [];
     } else {
-      serverAddress = config.env.serverAddress;
+      if (config.env.serverAddress === '') {
+        serverAddress = '127.0.0.1';
+      } else {
+        serverAddress = config.env.serverAddress;
+      }
 
       webSocketOptions = {
         rejectUnauthorized: false,
@@ -155,6 +173,7 @@ class Socket {
               // we want to log the warning just once
               if (!connectionRefusedLogged) {
                 logger.log('[soundworks.Socket] Connection refused, waiting for the server to start');
+                // console.log(e.error);
                 connectionRefusedLogged = true;
               }
 

package/src/common/version.js

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

package/src/server/Server.js

@@ -75,7 +75,7 @@ const DEFAULT_CONFIG = {
   env: {
     type: 'development',
     port: 8000,
-    serverAddress: null,
+    serverAddress: '',
     subpath: '',
     websockets: {
       path: 'socket',
@@ -163,7 +163,7 @@ class Server {
      *   env: {
      *     type: 'development',
      *     port: 8000,
-     *     serverAddress: null,
+     *     serverAddress: '',
      *     subpath: '',
      *     websockets: {
      *       path: 'socket',
@@ -187,16 +187,12 @@ class Server {
       throw new Error(`[soundworks:Server] Invalid "app.clients" config, at least one client should be declared`);
     }
 
-    // if a node client is defined, serverAddress should be defined
-    let hasNodeClient = false;
-    for (let name in this.config.app.clients) {
-      if (this.config.app.clients[name].target === 'node') {
-        hasNodeClient = true;
-      }
-    }
-
-    if (hasNodeClient && this.config.env.serverAddress === null) {
-      throw new Error(`[soundworks:Server] Invalid "env.serverAddress" config, is mandatory when a node client target is defined`);
+    // @peeka - remove
+    // [2024-05-29] Override default `config.env.serverAddress`` provided from
+    // template `loadConfig` to '' so that browser clients can default to
+    // window.location.hostname and node clients to `127.0.0.1`
+    if (process.env.ENV === undefined && this.config.env.serverAddress === '127.0.0.1') {
+      this.config.env.serverAddress = '';
     }
 
     if (this.config.env.useHttps && this.config.env.httpsInfos !== null) {