@soundworks/core 3.2.2 → 3.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "3.2.2",
+  "version": "3.3.1",
   "description": "full-stack javascript framework for distributed audio visual experiences on the web",
   "authors": [
     "Benjamin Matuszewski",
@@ -29,7 +29,8 @@
     "dev:client": "chokidar src/client/ -c \"npm run build:client\"",
     "dev:server": "chokidar src/server/ -c \"npm run build:server\"",
     "dev:common": "chokidar src/common/ -c \"npm run build:common\"",
-    "dev": "npm run build && (npm run dev:client & npm run dev:server & npm run dev:common)"
+    "dev": "npm run build && (npm run dev:client & npm run dev:server & npm run dev:common)",
+    "test": "mocha"
   },
   "dependencies": {
     "chalk": "^4.1.2",
@@ -38,6 +39,7 @@
     "debug": "^4.3.4",
     "fast-deep-equal": "^3.1.3",
     "fast-text-encoding": "^1.0.0",
+    "http-terminator": "^3.2.0",
     "isomorphic-ws": "^4.0.1",
     "keyv": "^4.2.2",
     "keyv-file": "^0.2.0",

package/server/AbstractExperience.js

@@ -20,7 +20,7 @@ const log = (0, _debug.default)('soundworks:lifecycle');
  */
 
 class AbstractExperience {
-  constructor(server, clientTypes = null) {
+  constructor(server, clientTypes = []) {
     // @todo - check that it's a soundworks instance
     if (!server) {
       throw new Error(`${this.constructor.name} should receive the "Server" instance as first argument`);

package/server/Server.js

@@ -41,6 +41,8 @@ var _keyv = _interopRequireDefault(require("keyv"));
 
 var _keyvFile = _interopRequireDefault(require("keyv-file"));
 
+var _httpTerminator = require("http-terminator");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 let _dbNamespaces = new Set();
@@ -401,12 +403,23 @@ class Server {
         this.router.server = httpServer;
         return Promise.resolve();
       }).then(() => {
-        if (this.templateEngine === null) {
-          throw new Error('Undefined "server.templateEngine": please provide a valid template engine');
+        let nodeOnly = true; // do not throw if no browser clients are defined, very usefull for
+        // cleaning tests in particular
+
+        for (let clientType in this.config.app.clients) {
+          if (this.config.app.clients[clientType].target === 'browser') {
+            nodeOnly = false;
+          }
         }
 
-        if (this.templateDirectory === null) {
-          throw new Error('Undefined "server.templateDirectory": please provide a valid template directory');
+        if (!nodeOnly) {
+          if (this.templateEngine === null) {
+            throw new Error('Undefined "server.templateEngine": please provide a valid template engine');
+          }
+
+          if (this.templateDirectory === null) {
+            throw new Error('Undefined "server.templateDirectory": please provide a valid template directory');
+          }
         } // ------------------------------------------------------------
         // INIT ROUTING
         // ------------------------------------------------------------
@@ -425,8 +438,15 @@ class Server {
 
 
         for (let clientType in this._clientTypeActivitiesMap) {
+          // do nothing if client type is not registered in config
+          if (!(clientType in this.config.app.clients)) {
+            continue;
+          }
+
           if (clientType !== defaultClientType) {
-            const path = this._openClientRoute(clientType, this.router);
+            const clientTarget = this.config.app.clients[clientType].target;
+
+            const path = this._openClientRoute(clientType, target, this.router);
 
             routes.push({
               clientType,
@@ -437,8 +457,15 @@ class Server {
 
 
         for (let clientType in this._clientTypeActivitiesMap) {
+          // do nothing if client type is not registered in config
+          if (!(clientType in this.config.app.clients)) {
+            continue;
+          }
+
           if (clientType === defaultClientType) {
-            const path = this._openClientRoute(clientType, this.router, true);
+            const clientTarget = this.config.app.clients[clientType].target;
+
+            const path = this._openClientRoute(clientType, target, this.router, true);
 
             routes.unshift({
               clientType,
@@ -492,18 +519,31 @@ class Server {
       console.error(err);
     }
   }
+
+  async stop() {
+    const httpTerminator = (0, _httpTerminator.createHttpTerminator)({
+      server: this.httpServer
+    });
+    await httpTerminator.terminate();
+  }
   /**
    * Open the route for the given client.
    * @private
    */
 
 
-  _openClientRoute(clientType, router, isDefault = false) {
+  _openClientRoute(clientType, target, router, isDefault = false) {
+    // only browser targets need a route
+    if (target === 'node') {
+      return;
+    }
+
     let route = '/';
 
     if (!isDefault) {
       route += `${clientType}`;
-    }
+    } // @todo - define what is this... looks completely not used and not usable...
+
 
     if (this._routes[clientType]) {
       route += this._routes[clientType];