@soundworks/core 3.0.4 → 3.1.0-beta.3

package/README.md

@@ -56,6 +56,7 @@ The simplest way to start a new `soundworks` application is using the applicatio
 
 ## Academic Papers
 
+- Benjamin Matuszewski. A Web-Based Framework for Distributed Music System Research and Creation. AES - Journal of the Audio Engineering Society Audio-Accoustics-Application, Audio Engineering Society Inc, 2020. <[hal-03033143](https://hal.archives-ouvertes.fr/hal-03033143)>
 - Benjamin Matuszewski. Soundworks - A Framework for Networked Music Systems on the Web - State of Affairs and New Developments. Proceedings of the Web Audio Conference (WAC) 2019, Dec 2019, Trondheim, Norway. <[hal-02387783](https://hal.archives-ouvertes.fr/hal-02387783)>
 - Benjamin Matuszewski, Norbert Schnell, Frédéric Bevilacqua. Interaction Topologies in Mobile-Based Situated Networked Music Systems. Wireless Communications and Mobile Computing, Hindawi Publishing Corporation, 2019, 2019, pp.9142490. ⟨10.1155/2019/9142490⟩. <[hal-02086673](https://hal.archives-ouvertes.fr/hal-02086673)>
 - Norbert Schnell, Sébastien Robaszkiewicz. Soundworks – A playground for artists and developers to create collaborative mobile web performances. `Proceedings of the Web Audio Conference (WAC'15), 2015, Paris, France. <[hal-01580797](https://hal.archives-ouvertes.fr/hal-01580797)>

package/client/Client.js

@@ -118,7 +118,7 @@ class Client {
       // url: '',
       path: 'socket' // pingInterval: 5 * 1000,
 
-    }, config.env.websockets); // init communications
+    }, config.env.websockets); // init socket communications (string and binary)
 
     await this.socket.init(this.type, this.config);
     return Promise.resolve();

package/client/PluginManager.js

@@ -141,7 +141,8 @@ class PluginManager {
 
   register(name, factory, options = {}, deps = []) {
     if (this._registeredPlugins[name]) {
-      throw new Error(`Plugin "${name}" already registered`);
+      const ctor = factory(_AbstractPlugin.default);
+      throw new Error(`[soundworks:core] Plugin "${name}" of type "${ctor.name}" already registered`);
     }
 
     const ctor = factory(_AbstractPlugin.default);
@@ -164,7 +165,7 @@ class PluginManager {
 
   get(name, _experienceRequired = false) {
     if (!this._registeredPlugins[name]) {
-      throw new Error(`Cannot get or require plugin "${name}", plugin is not registered
+      throw new Error(`[soundworks:core] Cannot get or require plugin "${name}", plugin is not registered
 > registered plugins are:
 ${Object.keys(this._registeredPlugins).map(n => `> - ${n}\n`).join('')}
 `);
@@ -172,7 +173,7 @@ ${Object.keys(this._registeredPlugins).map(n => `> - ${n}\n`).join('')}
 
 
     if (_experienceRequired && this.signals.start.value === true) {
-      throw new Error(`Plugin "${name}" required after pluginManager start`);
+      throw new Error(`[soundworks:core] Plugin "${name}" required after pluginManager start`);
     }
 
     if (!this._instances[name]) {

package/client/Socket.js

@@ -53,6 +53,13 @@ class Socket {
 
     /** @private */
     this.ws = null;
+    /**
+     * WebSocket instance (binary protocol - binaryType = 'arraybuffer').
+     */
+
+    /** @private */
+
+    this.binaryWs = null;
     this._stringListeners = new Map();
     this._binaryListeners = new Map();
   }
@@ -67,11 +74,11 @@ class Socket {
   /** @private */
 
 
-  init(clientType, config) {
+  async init(clientType, config) {
     // unique key that allows to associate the two sockets to the same client.
     // note: the key is only used to pair to two sockets, so its usage is very
     // limited in time therefore a random number should hopefully be sufficient.
-    const key = (Math.random() + '').replace(/^0./, ''); // open web sockets
+    const key = (Math.random() + '').replace(/^0\./, ''); // open web sockets
 
     let {
       path
@@ -106,47 +113,71 @@ class Socket {
     // ----------------------------------------------------------
 
     const stringSocketUrl = `${url}?binary=0&${queryParams}`;
-    this.ws = new _isomorphicWs.default(stringSocketUrl);
-    log(`string socket initialized - url: ${stringSocketUrl}`);
-    const stringSocketPromise = new Promise((resolve, reject) => {
-      this.ws.addEventListener('open', resolve);
-    }); // parse incoming messages for pubsub
-
-    this.ws.addEventListener('message', e => {
-      const [channel, args] = (0, _socketsEncoderDecoder.unpackStringMessage)(e.data);
-
-      this._emit(false, channel, ...args);
-    }); // broadcast all `WebSocket` native events
-
-    ['open', 'close', 'error', 'upgrade', 'message'].forEach(eventName => {
-      this.ws.addEventListener(eventName, e => {
-        this._emit(false, eventName, e.data);
-      });
-    }); // ----------------------------------------------------------
-    // init binary socket
-    // ----------------------------------------------------------
+    await new Promise((resolve, reject) => {
+      const trySocket = async () => {
+        log(`[string socket] trying connection - url: ${stringSocketUrl}`);
+        const ws = new _isomorphicWs.default(stringSocketUrl);
+        ws.addEventListener('open', connectEvent => {
+          // parse incoming messages for pubsub
+          this.ws = ws;
+          this.ws.addEventListener('message', e => {
+            const [channel, args] = (0, _socketsEncoderDecoder.unpackStringMessage)(e.data);
+
+            this._emit(false, channel, ...args);
+          }); // broadcast all `WebSocket` native events
+
+          ['close', 'error', 'upgrade', 'message'].forEach(eventName => {
+            this.ws.addEventListener(eventName, e => {
+              this._emit(false, eventName, e);
+            });
+          }); // forward open event
+
+          this._emit(false, 'open', connectEvent); // continue with raw socket
+
+
+          resolve();
+        }); // cf. https://github.com/collective-soundworks/soundworks/issues/17
+
+        ws.addEventListener('error', e => {
+          if (e.type === 'error' && e.error.code === 'ECONNREFUSED') {
+            console.log('[socket] connection refused - (retry in 1s)');
+            setTimeout(trySocket, 1000);
+          }
+        });
+      };
+
+      trySocket();
+    }); // // ----------------------------------------------------------
+    // // init binary socket
+    // // ----------------------------------------------------------
 
     const binarySocketUrl = `${url}?binary=1&${queryParams}`;
-    this.binaryWs = new _isomorphicWs.default(binarySocketUrl);
-    this.binaryWs.binaryType = 'arraybuffer';
-    log(`binary socket initialized - url: ${binarySocketUrl}`);
-    const binarySocketPromise = new Promise((resolve, reject) => {
-      this.binaryWs.addEventListener('open', resolve);
-    }); // parse incoming messages for pubsub
-
-    this.binaryWs.addEventListener('message', e => {
-      const [channel, data] = (0, _socketsEncoderDecoder.unpackBinaryMessage)(e.data);
-
-      this._emit(true, channel, data);
-    }); // broadcast all `WebSocket` native events
-
-    ['open', 'close', 'error', 'upgrade', 'message'].forEach(eventName => {
-      this.binaryWs.addEventListener(eventName, e => {
-        this._emit(true, eventName, e.data);
+    await new Promise((resolve, reject) => {
+      log(`[binary socket] trying connection - url: ${binarySocketUrl}`);
+      const ws = new _isomorphicWs.default(binarySocketUrl);
+      ws.binaryType = 'arraybuffer';
+      ws.addEventListener('open', connectEvent => {
+        // parse incoming messages for pubsub
+        this.binaryWs = ws;
+        this.binaryWs.addEventListener('message', e => {
+          const [channel, data] = (0, _socketsEncoderDecoder.unpackBinaryMessage)(e.data);
+
+          this._emit(true, channel, data);
+        }); // broadcast all `WebSocket` native events
+
+        ['close', 'error', 'upgrade', 'message'].forEach(eventName => {
+          this.binaryWs.addEventListener(eventName, e => {
+            this._emit(true, eventName, e);
+          });
+        }); // forward open event
+
+        this._emit(true, 'open', connectEvent);
+
+        resolve();
       });
-    }); // wait for both socket to be opened
+    }); // everyone is connected
 
-    return Promise.all([stringSocketPromise, binarySocketPromise]);
+    return Promise.resolve();
   }
   /** @private */