@soundworks/core 3.7.0 → 4.0.0-alpha.1

package/common/logger.js

@@ -1,162 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _columnify = _interopRequireDefault(require("columnify"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * @private
- */
-const logger = {
-  verbose: true,
-
-  configure(verbose) {
-    this.verbose = verbose;
-  },
-
-  title(msg) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.log(_chalk.default.cyan(`+ ${msg}`));
-  },
-
-  clientConfigAndRouting(routes, config) {
-    if (!this.verbose) {
-      return;
-    }
-
-    const clientsConfig = config.app.clients;
-    const serverIp = config.env.serverIp;
-    const auth = config.env.auth;
-    const table = [];
-
-    for (let clientType in clientsConfig) {
-      const client = clientsConfig[clientType];
-
-      if (client.target === 'node') {
-        const line = {
-          client_type: `> ${clientType}`,
-          target: _chalk.default.red(client.target),
-          path: `server ip: ${_chalk.default.green(serverIp)}`,
-          default: undefined,
-          auth: undefined
-        };
-        table.push(line);
-      } else if (client.target === 'browser') {
-        const line = {
-          client_type: `> ${clientType}`,
-          target: _chalk.default.red(client.target),
-          path: routes.find(r => r.clientType === clientType) ? _chalk.default.green(routes.find(r => r.clientType === clientType).path) : _chalk.default.red('no route defined'),
-          default: client.default ? 'x' : undefined,
-          auth: auth && auth.clients.indexOf(clientType) !== -1 ? 'x' : undefined
-        };
-        table.push(line);
-      } else {
-        console.log(`@warning: no target defined for client ${clientType}`);
-      }
-    }
-
-    console.log(``);
-    console.log((0, _columnify.default)(table, {
-      showHeaders: true,
-      minWidth: 6,
-      columnSplitter: ' | ',
-      config: {
-        default: {
-          align: 'center'
-        },
-        auth: {
-          align: 'center'
-        }
-      }
-    }));
-    console.log(``); // check if a route is defined but not in config
-
-    if (clientsConfig) {
-      const configClientTypes = Object.keys(clientsConfig);
-      routes.forEach(r => {
-        if (configClientTypes.indexOf(r.clientType) === -1) {
-          console.log(`@warning: no client config found for route ${r.clientType}`);
-        }
-      });
-    } else {
-      console.log(`@warning: no config found for clients`);
-    }
-  },
-
-  ip(protocol, address, port) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.log(`    ${protocol}://${address}:${_chalk.default.green(port)}`);
-  },
-
-  pluginStart(name) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.log(`    ${name} ${_chalk.default.yellow('start...')}`);
-  },
-
-  pluginStarted(name) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.log(`    ${name} ${_chalk.default.cyan('started')}`);
-  },
-
-  pluginReady(name) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.log(`    ${name} ${_chalk.default.green('ready')}`);
-  },
-
-  pluginErrored(name) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.log(`    ${name} ${_chalk.default.red('errors')}`);
-  },
-
-  log(msg) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.log(msg);
-  },
-
-  warn(msg) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.warn(_chalk.default.yellow(msg));
-  },
-
-  error(msg) {
-    if (!this.verbose) {
-      return;
-    }
-
-    console.error(_chalk.default.red(msg));
-  }
-
-};
-var _default = logger;
-exports.default = _default;

package/common/shared-state-utils.js

@@ -1,89 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.UPDATE_RESPONSE = exports.UPDATE_REQUEST = exports.UPDATE_NOTIFICATION = exports.UPDATE_ABORT = exports.SERVER_ID = exports.OBSERVE_RESPONSE = exports.OBSERVE_REQUEST = exports.OBSERVE_NOTIFICATION = exports.DETACH_RESPONSE = exports.DETACH_REQUEST = exports.DETACH_ERROR = exports.DELETE_SCHEMA = exports.DELETE_RESPONSE = exports.DELETE_REQUEST = exports.DELETE_NOTIFICATION = exports.DELETE_ERROR = exports.CREATE_RESPONSE = exports.CREATE_REQUEST = exports.CREATE_ERROR = exports.ATTACH_RESPONSE = exports.ATTACH_REQUEST = exports.ATTACH_ERROR = void 0;
-exports.idGenerator = idGenerator;
-exports.rejectRequest = rejectRequest;
-exports.resolveRequest = resolveRequest;
-exports.storeRequestPromise = storeRequestPromise;
-// id of the server when owner of a state
-const SERVER_ID = -1;
-exports.SERVER_ID = SERVER_ID;
-const CREATE_REQUEST = 's:c:req';
-exports.CREATE_REQUEST = CREATE_REQUEST;
-const CREATE_RESPONSE = 's:c:res';
-exports.CREATE_RESPONSE = CREATE_RESPONSE;
-const CREATE_ERROR = 's:c:err';
-exports.CREATE_ERROR = CREATE_ERROR;
-const DELETE_REQUEST = 's:dl:req';
-exports.DELETE_REQUEST = DELETE_REQUEST;
-const DELETE_RESPONSE = 's:dl:res';
-exports.DELETE_RESPONSE = DELETE_RESPONSE;
-const DELETE_ERROR = 's:dl:err';
-exports.DELETE_ERROR = DELETE_ERROR;
-const DELETE_NOTIFICATION = 's:dl:not';
-exports.DELETE_NOTIFICATION = DELETE_NOTIFICATION;
-const ATTACH_REQUEST = 's:a:req';
-exports.ATTACH_REQUEST = ATTACH_REQUEST;
-const ATTACH_RESPONSE = 's:a:res';
-exports.ATTACH_RESPONSE = ATTACH_RESPONSE;
-const ATTACH_ERROR = 's:a:err';
-exports.ATTACH_ERROR = ATTACH_ERROR;
-const DETACH_REQUEST = 's:dt:req';
-exports.DETACH_REQUEST = DETACH_REQUEST;
-const DETACH_RESPONSE = 's:dt:res';
-exports.DETACH_RESPONSE = DETACH_RESPONSE;
-const DETACH_ERROR = 's:dt:err';
-exports.DETACH_ERROR = DETACH_ERROR;
-const OBSERVE_REQUEST = 's:o:req';
-exports.OBSERVE_REQUEST = OBSERVE_REQUEST;
-const OBSERVE_RESPONSE = 's:o:res';
-exports.OBSERVE_RESPONSE = OBSERVE_RESPONSE;
-const OBSERVE_NOTIFICATION = 's:o:not';
-exports.OBSERVE_NOTIFICATION = OBSERVE_NOTIFICATION;
-const UPDATE_REQUEST = 's:u:req';
-exports.UPDATE_REQUEST = UPDATE_REQUEST;
-const UPDATE_RESPONSE = 's:u:res';
-exports.UPDATE_RESPONSE = UPDATE_RESPONSE;
-const UPDATE_ABORT = 's:u:ab';
-exports.UPDATE_ABORT = UPDATE_ABORT;
-const UPDATE_NOTIFICATION = 's:u:not';
-exports.UPDATE_NOTIFICATION = UPDATE_NOTIFICATION;
-const DELETE_SCHEMA = 's:d:s';
-exports.DELETE_SCHEMA = DELETE_SCHEMA;
-
-function* idGenerator() {
-  for (let i = 0; true; i++) {
-    yield i;
-  }
-}
-
-const generateRequestId = idGenerator();
-const requestPromises = new Map();
-
-function storeRequestPromise(resolve, reject) {
-  const reqId = generateRequestId.next().value;
-  requestPromises.set(reqId, {
-    resolve,
-    reject
-  });
-  return reqId;
-}
-
-function resolveRequest(reqId, data) {
-  const {
-    resolve
-  } = requestPromises.get(reqId);
-  requestPromises.delete(reqId);
-  resolve(data);
-}
-
-function rejectRequest(reqId, data) {
-  const {
-    reject
-  } = requestPromises.get(reqId);
-  requestPromises.delete(reqId);
-  reject(data);
-}

package/common/sockets-encoder-decoder.js

@@ -1,73 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.packBinaryMessage = packBinaryMessage;
-exports.packStringMessage = packStringMessage;
-exports.unpackBinaryMessage = unpackBinaryMessage;
-exports.unpackStringMessage = unpackStringMessage;
-
-require("fast-text-encoding");
-
-var _windowOrGlobal = _interopRequireDefault(require("window-or-global"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const encoder = new _windowOrGlobal.default.TextEncoder('utf-8');
-const decoder = new _windowOrGlobal.default.TextDecoder('utf-8');
-const types = ['Int8Array', 'Uint8Array', 'Uint8ClampedArray', 'Int16Array', 'Uint16Array', 'Int32Array', 'Uint32Array', 'Float32Array', 'Float64Array', 'BigInt64Array', 'BigUint64Array']; // @note - probably some room for optimizations
-
-/** @private */
-
-function packBinaryMessage(channel, data) {
-  const channelBuffer = encoder.encode(channel);
-  const channelSize = channelBuffer.byteLength;
-  const startOffset = Math.ceil((channelSize + 3) / data.BYTES_PER_ELEMENT) * data.BYTES_PER_ELEMENT;
-  const bufferSize = startOffset + data.byteLength;
-  const typeName = data.constructor.name;
-  const typeIndex = types.indexOf(typeName);
-
-  if (typeIndex === -1) {
-    throw new Error(`Invalid TypedArray type: ${typeName}`);
-  }
-
-  const view = new Uint8Array(bufferSize);
-  view[0] = channelSize;
-  view[1] = typeIndex;
-  view[2] = startOffset;
-  view.set(channelBuffer, 3, channelSize);
-  view.set(new Uint8Array(data.buffer), startOffset, data.byteLength);
-  return view.buffer;
-}
-/** @private */
-
-
-function unpackBinaryMessage(buffer
-/* arraybuffer */
-) {
-  const infos = new Uint8Array(buffer, 0, 3);
-  const channelSize = infos[0];
-  const typeIndex = infos[1];
-  const startOffset = infos[2]; // need to slice as the library recreates a UInt8Array from the whole buffer
-  // @todo - see if this copy could be avoided (probably needs a pull request)
-
-  const channelBuffer = new Uint8Array(buffer.slice(3, 3 + channelSize));
-  const channel = decoder.decode(channelBuffer);
-  const type = types[typeIndex]; // slice (copy) the underlying ArrayBuffer to create a clean TypedArray
-
-  const data = new _windowOrGlobal.default[type](buffer.slice(startOffset));
-  return [channel, data];
-}
-/** @private */
-
-
-function packStringMessage(channel, ...args) {
-  return JSON.stringify([channel, args]);
-}
-/** @private */
-
-
-function unpackStringMessage(data) {
-  return JSON.parse(data);
-}

package/server/AbstractExperience.js

@@ -1,126 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _debug = _interopRequireDefault(require("debug"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const log = (0, _debug.default)('soundworks:lifecycle');
-/**
- * Base class to extend in order to create the server-side counterpert of
- * a soundworks client.
- *
- * The user defined `Experience`s are the main components of a soundworks application.
- *
- * @memberof server
- */
-
-class AbstractExperience {
-  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`);
-    }
-
-    if (clientTypes === null) {
-      throw new Error('Invalid client types');
-    }
-
-    this.server = server;
-    /**
-     * List of connected clients
-     * @instance
-     * @type {Client[]}
-     */
-
-    this.clients = new Set();
-    /**
-     * List of client types associated with this server-side experience.
-     */
-
-    clientTypes = Array.isArray(clientTypes) ? clientTypes : [clientTypes];
-    this.clientTypes = new Set(clientTypes); // register in the server
-
-    this.server.activities.add(this);
-  }
-  /**
-   * Require a registered plugin, all client types associated to the experience
-   * will also be associated to the required plugin. Requiring a plugin should
-   * always be done between `soundworks.init` and `soundworks.start`.
-   * In most case this method is called in the constructor the Experience.
-   *
-   * @param {String} name - Name of the registered plugin
-   */
-
-
-  require(name) {
-    return this.server.pluginManager.get(name, this);
-  }
-
-  start() {
-    log(`> experience "${this.constructor.name}" start`);
-  }
-  /**
-   * Called when the client connects to the server.
-   * @param {Client} client Connected client.
-   * @private
-   */
-
-
-  connect(client) {
-    const nodeId = client.id;
-    const transport = {
-      emit: client.socket.send.bind(client.socket),
-      addListener: client.socket.addListener.bind(client.socket),
-      // removeListener: client.socket.removeListener.bind(client.socket),
-      removeAllListeners: client.socket.removeAllListeners.bind(client.socket)
-    };
-    this.server.stateManager.addClient(nodeId, transport); // listen for the `'enter' socket message from the client, the message is
-    // sent when the client `enters` the Experience client side, i.e. when all
-    // required plugins are ready
-
-    return new Promise(() => {
-      client.socket.addListener('s:exp:enter', () => {
-        this.clients.add(client);
-        this.enter(client);
-      });
-    });
-  }
-  /**
-   * Called when the client disconnects from the server.
-   * @param {Client} client Disconnected client.
-   * @private
-   */
-
-
-  disconnect(client) {
-    const nodeId = client.id;
-    this.server.stateManager.removeClient(nodeId); // only call exit if the client has fully entered
-    // (i.e. has finished the its initialization phase)
-
-    if (this.clients.has(client)) {
-      this.clients.delete(client);
-      this.exit(client);
-    }
-  }
-  /**
-   * Called when the client started the client
-   */
-
-
-  enter(client) {
-    log(`> [client ${client.id}] enter experience "${this.constructor.name}"`);
-  }
-
-  exit(client) {
-    log(`> [client ${client.id}] exit experience "${this.constructor.name}"`);
-  }
-
-}
-
-var _default = AbstractExperience;
-exports.default = _default;

package/server/AbstractPlugin.js

@@ -1,214 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _debug = _interopRequireDefault(require("debug"));
-
-var _lodash = _interopRequireDefault(require("lodash.merge"));
-
-var _Signal = _interopRequireDefault(require("../common/Signal.js"));
-
-var _SignalAll = _interopRequireDefault(require("../common/SignalAll.js"));
-
-var _logger = _interopRequireDefault(require("../common/logger.js"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const log = (0, _debug.default)('soundworks:lifecycle');
-/**
- * Base class to extend for creating new soundworks plugins.
- *
- * @memberof server
- */
-
-class AbstractPlugin {
-  constructor(server, name) {
-    // should receive soundworks instance as argument
-
-    /**
-     * Instance of soundworks server.
-     * @type {server.Server}
-     * @see {@link server.Server}
-     */
-    this.server = server;
-    /**
-     * Name of the plugin.
-     * @type {String}
-     */
-
-    this.name = name;
-    /**
-     * Options of the plugin.
-     * @type {Object}
-     */
-
-    this.options = {};
-    /**
-     * Signals defining the process state.
-     * @type {Object}
-     */
-
-    this.signals = {
-      start: new _SignalAll.default(),
-      started: new _Signal.default(),
-      ready: new _Signal.default(),
-      errored: new _Signal.default()
-    };
-    /** @private */
-
-    this.clientTypes = new Set(); // register in the server
-
-    this.server.activities.add(this); // start when all required signals are fired
-
-    this.signals.start.addObserver(() => {
-      _logger.default.pluginStart(this.name);
-
-      this.start();
-    }); // log errors if any
-
-    this.signals.errored.addObserver(() => _logger.default.pluginErrored(this.name));
-    this.ready = this.ready.bind(this);
-  }
-  /**
-   * Helper function to merge default options and user-defined options.
-   *
-   * @example
-   * this.options = this.configure(defaults, options);
-   */
-
-
-  configure(defaults, options) {
-    return (0, _lodash.default)({}, defaults, options);
-  }
-  /**
-   * Interface method to override when implementing child class.
-   *
-   * _The child class MUST call {@link server.AbstractPlugin#started} and
-   * {@link server.AbstractPlugin#ready}_
-   *
-   * @example
-   * class MyDelayPlugin extends AbstractPlugin {
-   *   // start() is executed when the `start` signal pass to `true`
-   *   async start() {
-   *     this.state = await this.server.stateManager.create(`s:${this.name}`);
-   *     this.started();
-   *     // do [async] stuff
-   *     setTimeout(() => this.ready(), 3000);
-   *   }
-   * }
-   */
-
-
-  start() {
-    throw new Error(`plugin "${this.name}": "start()" not implemented or "super.start()" called`);
-  }
-  /**
-   * Method to call when the plugin is effectively started, as it may have to
-   * do some asynchonous job at start (e.g. creating a shared state).
-   *
-   * _Must be called between before {@link server.AbstractPlugin#ready}._
-   *
-   * @example
-   * class MyDelayPlugin extends AbstractPlugin {
-   *   // start() is executed when the `start` signal pass to `true`
-   *   async start() {
-   *     this.state = await this.server.stateManager.create(`s:${this.name}`);
-   *     this.started();
-   *     // do [async] stuff
-   *     setTimeout(() => this.ready(), 3000);
-   *   }
-   * }
-   */
-
-
-  started() {
-    // @note - these check are mostly there for development help. Could be
-    // replaced with decorators.
-    if (this.signals.start.value === false) {
-      throw new Error(`plugin "${this.name}" cannot "started" before "start"`);
-    }
-
-    if (this.signals.started.value === true) {
-      throw new Error(`plugin "${this.name}" cannot be "started" twice`);
-    }
-
-    _logger.default.pluginStarted(this.name);
-
-    this.signals.started.value = true;
-  }
-  /**
-   * Method to call in the plugin lifecycle when it should be considered as
-   * ready and thus allow the initialization process to continue or the
-   * application to start safely (cf. {@link server.AbstractExperience#start}).
-   *
-   * @example
-   * class MyDelayPlugin extends AbstractPlugin {
-   *   // start() is executed when the `start` signal pass to `true`
-   *   async start() {
-   *     this.state = await this.server.stateManager.create(`s:${this.name}`);
-   *     this.started();
-   *     // do [async] stuff
-   *     setTimeout(() => this.ready(), 3000);
-   *   }
-   * }
-   */
-
-
-  ready() {
-    // @note - these check are mostly there for development help. Could be
-    // replaced with decorators.
-    if (this.signals.start.value === false) {
-      throw new Error(`plugin "${this.name}" cannot "ready" before "start"`);
-    }
-
-    if (this.signals.started.value === false) {
-      throw new Error(`plugin "${this.name}" cannot "ready" before "started"`);
-    }
-
-    if (this.signals.ready.value === true) {
-      throw new Error(`plugin "${this.name}" cannot be "ready" twice`);
-    }
-
-    _logger.default.pluginReady(this.name);
-
-    this.signals.ready.value = true;
-  }
-
-  error(msg) {
-    _logger.default.pluginError(this.name);
-
-    _logger.default.error(`> Error: ${msg}`);
-
-    this.signals.errored.msg = msg;
-    this.signals.errored.value = true;
-  }
-  /**
-   * Interface method to implement if specific logic should be done when a
-   * {@link server.Client} connects to the plugin.
-   *
-   * @param {server.Client} client
-   */
-
-
-  connect(client) {
-    log(`> [client ${client.id}] connect to plugin "${this.name}"`);
-  }
-  /**
-   * Interface method to implement if specific logic should be done when a
-   * {@link server.Client} disconnects from the plugin.
-   *
-   * @param {server.Client} client
-   */
-
-
-  disconnect(client) {
-    log(`> [client ${client.id}] disconnect from plugin "${this.name}"`);
-  }
-
-}
-
-var _default = AbstractPlugin;
-exports.default = _default;