-
Notifications
You must be signed in to change notification settings - Fork 7
/
server.js
513 lines (447 loc) · 16.9 KB
/
server.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
import Client from './Client';
import compression from 'compression';
import ejs from 'ejs';
import express from 'express';
import fs from 'fs';
import http from 'http';
import https from 'https';
import logger from '../utils/logger';
import path from 'path';
import pem from 'pem';
import serviceManager from './serviceManager';
import sockets from './sockets';
import cache from '../utils/cache';
/**
* @typedef {Object} module:soundworks/server.server~serverConfig
* @memberof module:soundworks/server.server
*
* @property {String} appName - Name of the application, used in the `.ejs`
* template and by default in the `platform` service to populate its view.
* @property {String} env - Name of the environnement ('production' enable
* cache in express application).
* @property {String} version - Version of application, can be used to force
* reload css and js files from server (cf. `html/default.ejs`)
* @property {String} defaultClient - Name of the default client type,
* i.e. the client that can access the application at its root URL
* @property {String} assetsDomain - Define from where the assets (static files)
* should be loaded, this value can refer to a separate server for scalability.
* The value should be used client-side to configure the `audio-buffer-manager`
* service.
* @property {Number} port - Port used to open the http server, in production
* this value is typically 80
*
* @property {Object} setup - Describe the location where the experience takes
* places, theses values are used by the `placer`, `checkin` and `locator`
* services. If one of these service is required, this entry mandatory.
* @property {Object} setup.area - Description of the area.
* @property {Number} setup.area.width - Width of the area.
* @property {Number} setup.area.height - Height of the area.
* @property {String} setup.area.background - Path to an image to be used in
* the area representation.
* @property {Array} setup.labels - Optionnal list of predefined labels.
* @property {Array} setup.coordinates - Optionnal list of predefined coordinates.
* @property {Array} setup.maxClientsPerPosition - Maximum number of clients
* allowed in a position.
* @property {Number} setup.capacity - Maximum number of positions (may limit
* or be limited by the number of labels and/or coordinates).
*
* @property {Object} websockets - Websockets configuration (socket.io)
* @property {String} websockets.url - Optionnal url where the socket should
* connect.
* @property {Array} websockets.transports - List of the transport mecanims that
* should be used to open or emulate the socket.
*
* @property {Boolean} useHttps - Define if the HTTP server should be launched
* using secure connections. For development purposes when set to `true` and no
* certificates are given (cf. `httpsInfos`), a self-signed certificate is
* created.
* @property {Object} httpsInfos - Paths to the key and certificate to be used
* in order to launch the https server. Both entries are required otherwise a
* self-signed certificate is generated.
* @property {String} httpsInfos.cert - Path to the certificate.
* @property {String} httpsInfos.key - Path to the key.
*
* @property {String} password - Password to be used by the `auth` service.
*
* @property {Object} osc - Configuration of the `osc` service.
* @property {String} osc.receiveAddress - IP of the currently running server.
* @property {Number} osc.receivePort - Port listening for incomming messages.
* @property {String} osc.sendAddress - IP of the remote application.
* @property {Number} osc.sendPort - Port where the remote application is
* listening for messages
*
* @property {Boolean} enableGZipCompression - Define if the server should use
* gzip compression for static files.
* @property {String} publicDirectory - Location of the public directory
* (accessible through http(s) requests).
* @property {Object} serveStaticOptions - Options for the serve static middleware
* cf. [https://github.com/expressjs/serve-static](https://github.com/expressjs/serve-static)
* @property {String} templateDirectory - Directory where the server templating
* system looks for the `ejs` templates.
* @property {Object} logger - Configuration of the logger service, cf. Bunyan
* documentation.
* @property {String} errorReporterDirectory - Directory where error reported
* from the clients are written.
*/
/**
* Server side entry point for a `soundworks` application.
*
* This object hosts configuration informations, as well as methods to
* initialize and start the application. It is also responsible for creating
* the static file (http) server as well as the socket server.
*
* @memberof module:soundworks/server
* @namespace
*
* @example
* import * as soundworks from 'soundworks/server';
* import MyExperience from './MyExperience';
*
* soundworks.server.init(config);
* const myExperience = new MyExperience();
* soundworks.server.start();
*/
const server = {
/**
* Configuration informations, all config objects passed to the
* [`server.init`]{@link module:soundworks/server.server.init} are merged
* into this object.
* @type {module:soundworks/server.server~serverConfig}
*/
config: {},
/**
* Constructor used to instanciate `Client` instances.
* @type {module:soundworks/server.Client}
* @default module:soundworks/server.Client
*/
clientCtor: Client,
/**
* The url of the node server on the current machine.
* @private
*/
_address: '',
/**
* Mapping between a `clientType` and its related activities.
* @private
*/
_clientTypeActivitiesMap: {},
/**
* express instance, can allow to expose additionnal routes (e.g. REST API).
* @unstable
*/
router: null,
/**
* HTTP(S) server instance.
* @unstable
*/
httpServer: null,
/**
* Required activities that must be started.
* @private
*/
_activities: new Set(),
/**
* Optionnal routing defined for each client.
* @private
* @type {Object}
*/
_routes: {},
get clientTypes() {
return Object.keys(this._clientTypeActivitiesMap);
},
/**
* Return a service configured with the given options.
* @param {String} id - Identifier of the service.
* @param {Object} options - Options to configure the service.
*/
require(id, options) {
return serviceManager.require(id, options);
},
/**
* Default for the module:soundworks/server.server~clientConfigDefinition
* @private
*/
_clientConfigDefinition: (clientType, serverConfig, httpRequest) => {
return { clientType };
},
/**
* @callback module:soundworks/server.server~clientConfigDefinition
* @param {String} clientType - Type of the client.
* @param {Object} serverConfig - Configuration of the server.
* @param {Object} httpRequest - Http request for the `index.html`
* @return {Object}
*/
/**
* Set the {@link module:soundworks/server.server~clientConfigDefinition} with
* a user defined function.
* @param {module:soundworks/server.server~clientConfigDefinition} func - A
* function that returns the data that will be used to populate the `index.html`
* template. The function could (and should) be used to pass configuration
* to the soundworks client.
* @see {@link module:soundworks/client.client~init}
*/
setClientConfigDefinition(func) {
this._clientConfigDefinition = func;
},
/**
* Register a route for a given `clientType`, allow to define a more complex
* routing (additionnal route parameters) for a given type of client.
* @param {String} clientType - Type of the client.
* @param {String|RegExp} route - Template of the route that should be append.
* to the client type
*
* @example
* ```
* // allow `conductor` clients to connect to `http://site.com/conductor/1`
* server.registerRoute('conductor', '/:param')
* ```
*/
defineRoute(clientType, route) {
this._routes[clientType] = route;
},
/**
* Function used by activities to register themselves as active activities
* @param {Activity} activity - Activity to be registered.
* @private
*/
setActivity(activity) {
this._activities.add(activity);
},
/**
* Initialize the server with the given configuration.
* At the end of the init step the express router is available.
*
* @param {module:soundworks/server.server~serverConfig} config -
* Configuration of the application.
*/
init(config) {
this.config = config;
this._populateDefaultConfig();
serviceManager.init();
if (this.config.logger !== undefined)
logger.init(this.config.logger);
// instanciate and configure express
// this allows to hook middleware and routes (e.g. cors) in the express
// instance between `server.init` and `server.start`
this.router = new express();
this.router.set('port', process.env.PORT || this.config.port);
this.router.set('view engine', 'ejs');
// allow promise based syntax for server initialization
return Promise.resolve();
},
/**
* Start the application:
* - launch the http(s) server.
* - launch the socket server.
* - start all registered activities.
* - define routes and activities mapping for all client types.
*/
start() {
// compression
if (this.config.enableGZipCompression)
this.router.use(compression());
// public folder
const { publicDirectory, serveStaticOptions } = this.config;
const staticMiddleware = express.static(publicDirectory, serveStaticOptions);
this.router.use(staticMiddleware);
this._initActivities();
this._initRouting(this.router);
// expose router to allow adding some routes (e.g. REST API)
const useHttps = this.config.useHttps || false;
return new Promise((resolve, reject) => {
// launch http(s) server
if (!useHttps) {
const httpServer = http.createServer(this.router);
resolve(httpServer);
} else {
const httpsInfos = this.config.httpsInfos;
// use given certificate
if (httpsInfos.key && httpsInfos.cert) {
const key = fs.readFileSync(httpsInfos.key);
const cert = fs.readFileSync(httpsInfos.cert);
const httpsServer = https.createServer({ key, cert }, this.router);
this.httpsInfos = { key, cert };
resolve(httpsServer);
// generate certificate on the fly (for development purposes)
} else {
// if some cert already in cache
this.httpsInfos = cache.read('server', 'httpsInfos');
if (this.httpsInfos) {
const httpsServer = https.createServer(this.httpsInfos, this.router);
resolve(httpsServer);
} else {
pem.createCertificate({ days: 1, selfSigned: true }, (err, keys) => {
this.httpsInfos = {
key: keys.serviceKey,
cert: keys.certificate,
};
const httpsServer = https.createServer(this.httpsInfos, this.router);
cache.write('server', 'httpsInfos', this.httpsInfos);
resolve(httpsServer);
});
}
}
}
}).then((httpServer) => {
this._initSockets(httpServer);
this.httpServer = httpServer;
const promise = new Promise((resolve, reject) => {
serviceManager.signals.ready.addObserver(() => {
httpServer.listen(this.router.get('port'), () => {
const protocol = useHttps ? 'https' : 'http';
this._address = `${protocol}://127.0.0.1:${this.router.get('port')}`;
console.log(`[${protocol.toUpperCase()} SERVER] Server listening on`, this._address);
resolve();
});
});
});
serviceManager.start();
return promise;
}).catch((err) => console.error(err.stack));
},
/**
* Map activities to their respective client type(s) and start them all.
* @private
*/
_initActivities() {
this._activities.forEach((activity) => {
this._mapClientTypesToActivity(activity.clientTypes, activity);
});
},
/**
* Init routing for each client. The default client route must be created last.
* @private
*/
_initRouting(router) {
for (let clientType in this._clientTypeActivitiesMap) {
if (clientType !== this.config.defaultClient)
this._openClientRoute(clientType, router);
}
for (let clientType in this._clientTypeActivitiesMap) {
if (clientType === this.config.defaultClient)
this._openClientRoute(clientType, router);
}
},
/**
* Init websocket server.
* @private
*/
_initSockets(httpServer) {
sockets.init(httpServer, this.config.websockets);
// socket connnection
sockets.onConnection(this.clientTypes, (clientType, socket) => {
this._onSocketConnection(clientType, socket);
});
},
/**
* Populate mandatory configuration options
* @private
*/
_populateDefaultConfig() {
if (this.config.port === undefined)
this.config.port = 8000;
if (this.config.enableGZipCompression === undefined)
this.config.enableGZipCompression = true;
if (this.config.publicDirectory === undefined)
this.config.publicDirectory = path.join(process.cwd(), 'public');
if (this.config.serveStaticOptions === undefined)
this.config.serveStaticOptions = {};
if (this.config.templateDirectory === undefined)
this.config.templateDirectory = path.join(process.cwd(), 'html');
if (this.config.defaultClient === undefined)
this.config.defaultClient = 'player';
if (this.config.websockets === undefined)
this.config.websockets = {};
},
/**
* Map client types with an activity.
* @param {Array<String>} clientTypes - List of client type.
* @param {Activity} activity - Activity concerned with the given `clientTypes`.
* @private
*/
_mapClientTypesToActivity(clientTypes, activity) {
clientTypes.forEach((clientType) => {
if (!this._clientTypeActivitiesMap[clientType])
this._clientTypeActivitiesMap[clientType] = new Set();
this._clientTypeActivitiesMap[clientType].add(activity);
});
},
/**
* Open the route for the given client.
* @private
*/
_openClientRoute(clientType, router) {
let route = '';
if (this._routes[clientType])
route += this._routes[clientType];
if (clientType !== this.config.defaultClient)
route = `/${clientType}${route}`;
// define template filename: `${clientType}.ejs` or `default.ejs`
const templateDirectory = this.config.templateDirectory;
const clientTmpl = path.join(templateDirectory, `${clientType}.ejs`);
const defaultTmpl = path.join(templateDirectory, `default.ejs`);
fs.stat(clientTmpl, (err, stats) => {
let template;
if (err || !stats.isFile())
template = defaultTmpl;
else
template = clientTmpl;
const tmplString = fs.readFileSync(template, { encoding: 'utf8' });
const tmpl = ejs.compile(tmplString);
// http request
router.get(route, (req, res) => {
const data = this._clientConfigDefinition(clientType, this.config, req);
const appIndex = tmpl({ data });
res.send(appIndex);
});
});
},
/**
* Socket connection callback.
* @private
*/
_onSocketConnection(clientType, socket) {
const client = new this.clientCtor(clientType, socket);
const activities = this._clientTypeActivitiesMap[clientType];
// global lifecycle of the client
sockets.receive(client, 'disconnect', () => {
activities.forEach((activity) => activity.disconnect(client));
client.destroy();
if (logger.info)
logger.info({ socket, clientType }, 'disconnect');
});
// check coherence between client-side and server-side service requirements
const serverRequiredServices = serviceManager.getRequiredServices(clientType);
const serverServicesList = serviceManager.getServiceList();
sockets.receive(client, 'handshake', (data) => {
// in development, if service required client-side but not server-side,
// complain properly client-side.
if (this.config.env !== 'production') {
const clientRequiredServices = data.requiredServices || [];
const missingServices = [];
clientRequiredServices.forEach((serviceId) => {
if (
serverServicesList.indexOf(serviceId) !== -1 &&
serverRequiredServices.indexOf(serviceId) === -1
) {
missingServices.push(serviceId);
}
});
if (missingServices.length > 0) {
sockets.send(client, 'client:error', {
type: 'services',
data: missingServices,
});
return;
}
}
client.urlParams = data.urlParams;
// @todo - handle reconnection (ex: `data` contains an `uuid`)
activities.forEach((activity) => activity.connect(client));
sockets.send(client, 'client:start', client.uuid);
if (logger.info)
logger.info({ socket, clientType }, 'handshake');
});
},
};
export default server;