@soundworks/core 5.0.0 → 5.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soundworks/core",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "Open-source creative coding framework for distributed applications based on Web technologies",
   "collaborators": [
     "Benjamin Matuszewski",
@@ -47,9 +47,10 @@
     "doc": "npm run types && rm -rf docs && jsdoc -c .jsdoc --verbose && cp -R misc/assets docs/",
     "lint": "npx eslint src",
     "test": "npx mocha tests/*/*.spec.js",
+    "test:ci": "npx mocha tests/*/*.spec.js --ci",
     "test:only": "npx mocha",
     "types": "rm -rf types && tsc",
-    "preversion": "node ./misc/scripts/generate-version-file.js $npm_new_version && npm run types",
+    "preversion": "npm run lint && npm run test && node ./misc/scripts/generate-version-file.js $npm_new_version && npm run types",
     "postversion": "node ./misc/scripts/check-changelog.js && git commit -am \"$npm_new_version\" --allow-empty"
   },
   "dependencies": {

package/src/client/ClientPlugin.js

@@ -1,5 +1,7 @@
 import BasePlugin from '../common/BasePlugin.js';
 
+export const kClientPluginName = Symbol.for('soundworks:client-plugin-name');
+
 /**
  * Callback executed when the plugin state is updated.
  *
@@ -31,12 +33,16 @@ import BasePlugin from '../common/BasePlugin.js';
  * @extends BasePlugin
  * @inheritdoc
  */
-class ClientPlugin extends BasePlugin {
+export default class ClientPlugin extends BasePlugin {
+  // Note: we need this workaround in plugin tests, because the test app and
+  // the tested plugin will import different versions of ServerPlugin
+  static [kClientPluginName] = 'ClientPlugin';
+
   #client = null;
+
   /**
    * @param {Client} client - A soundworks client instance.
-   * @param {string} id - User defined id of the plugin as defined in
-   *  {@link ClientPluginManager#register}.
+   * @param {string} id - User defined id of the plugin as defined in {@link ClientPluginManager#register}.
    */
   constructor(client, id) {
     super(id);
@@ -67,5 +73,3 @@ class ClientPlugin extends BasePlugin {
   //  */
   // async deactivate() {}
 }
-
-export default ClientPlugin;

package/src/client/ClientPluginManager.js

@@ -1,6 +1,6 @@
-import BasePluginManager from '../common/BasePluginManager.js';
-import ClientPlugin from './ClientPlugin.js';
 import Client from './Client.js';
+import BasePluginManager from '../common/BasePluginManager.js';
+import { kClientPluginName } from './ClientPlugin.js';
 
 /**
  * The `PluginManager` allows to register and retrieve `soundworks` plugins.
@@ -98,7 +98,7 @@ class ClientPluginManager extends BasePluginManager {
    */
   register(id, ctor, options = {}, deps = []) {
     // Note that other arguments are checked on the BasePluginManager
-    if (!ctor || !(ctor.prototype instanceof ClientPlugin)) {
+    if (!ctor || ctor[kClientPluginName] !== 'ClientPlugin') {
       throw new TypeError(`Cannot execute 'register' on ClientPluginManager: argument 2 must be a class that extends 'ClientPlugin'`);
     }
 

package/src/common/BasePlugin.js

@@ -1,6 +1,7 @@
 import merge from 'lodash/merge.js';
 
-export const kBasePluginStatus = Symbol('soundworks:base-plugin-status');
+// Notes: we use Symbol.for because we need to override this in helpers test
+export const kBasePluginStatus = Symbol.for('soundworks:base-plugin-status');
 
 /**
  * Callback executed when the plugin state is updated.

package/src/common/version.js

@@ -1,2 +1,2 @@
 // [WARNING] This file is generated, do not edit
-export default '5.0.0';
+export default '5.0.2';

package/src/server/ServerPlugin.js

@@ -1,5 +1,7 @@
 import BasePlugin from '../common/BasePlugin.js';
 
+export const kServerPluginName = Symbol.for('soundworks:server-plugin-name');
+
 /**
  * Base class to extend in order to create the server-side counterpart of a
  * `soundworks` plugin.
@@ -18,14 +20,17 @@ import BasePlugin from '../common/BasePlugin.js';
  * @extends {BasePlugin}
  * @inheritdoc
  */
-class ServerPlugin extends BasePlugin {
+export default class ServerPlugin extends BasePlugin {
+  // Note: we need this workaround in plugin tests, because the test app and
+  // the tested plugin will import different versions of ServerPlugin
+  static [kServerPluginName] = 'ServerPlugin';
+
   #server = null;
   #clients = new Set();
 
   /**
    * @param {Server} server - The soundworks server instance.
-   * @param {string} id - User defined id of the plugin as defined in
-   *  {@link ServerPluginManager#register}.
+   * @param {string} id - User defined id of the plugin as defined in {@link ServerPluginManager#register}.
    */
   constructor(server, id) {
     super(id);
@@ -72,5 +77,3 @@ class ServerPlugin extends BasePlugin {
     this.#clients.delete(client);
   }
 }
-
-export default ServerPlugin;

package/src/server/ServerPluginManager.js

@@ -1,8 +1,8 @@
+import Server from './Server.js';
 import BasePluginManager, {
   kPluginManagerInstances,
 } from '../common/BasePluginManager.js';
-import ServerPlugin from './ServerPlugin.js';
-import Server from './Server.js';
+import { kServerPluginName } from './ServerPlugin.js';
 
 export const kServerPluginManagerCheckRegisteredPlugins = Symbol('soundworks:server-plugin-manager-check-registered-plugins');
 export const kServerPluginManagerAddClient = Symbol('soundworks:server-plugin-manager-add-client');
@@ -140,7 +140,7 @@ class ServerPluginManager extends BasePluginManager {
    */
   register(id, ctor, options = {}, deps = []) {
     // Note that other arguments are checked on the BasePluginManager
-    if (!ctor || !(ctor.prototype instanceof ServerPlugin)) {
+    if (!ctor || ctor[kServerPluginName] !== 'ServerPlugin') {
       throw new TypeError(`Cannot execute 'register' on ServerPluginManager (id: ${id}): argument 2 must be a class that extends 'ServerPlugin'`);
     }
 

package/types/client/ClientPlugin.d.ts

@@ -1,8 +1,4 @@
-export default ClientPlugin;
-/**
- * ~onStateChangeCallback
- */
-export type ClientPlugin = (#state: ClientPlugin) => any;
+export const kClientPluginName: unique symbol;
 /**
  * Callback executed when the plugin state is updated.
  *
@@ -32,11 +28,11 @@ export type ClientPlugin = (#state: ClientPlugin) => any;
  * @extends BasePlugin
  * @inheritdoc
  */
-declare class ClientPlugin extends BasePlugin {
+export default class ClientPlugin extends BasePlugin {
+    static [kClientPluginName]: string;
     /**
      * @param {Client} client - A soundworks client instance.
-     * @param {string} id - User defined id of the plugin as defined in
-     *  {@link ClientPluginManager#register}.
+     * @param {string} id - User defined id of the plugin as defined in {@link ClientPluginManager#register}.
      */
     constructor(client: Client, id: string);
     /**
@@ -48,4 +44,8 @@ declare class ClientPlugin extends BasePlugin {
     get client(): Client;
     #private;
 }
+/**
+ * ~onStateChangeCallback
+ */
+export type ClientPlugin = (#state: ClientPlugin) => any;
 import BasePlugin from '../common/BasePlugin.js';

package/types/client/ClientPluginManager.d.ts

@@ -108,5 +108,4 @@ declare class ClientPluginManager<T> extends BasePluginManager {
     get(id: string): Promise<T<ClientPlugin>>;
 }
 import BasePluginManager from '../common/BasePluginManager.js';
-import ClientPlugin from './ClientPlugin.js';
 import Client from './Client.js';

package/types/common/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "5.0.0";
+declare const _default: "5.0.2";
 export default _default;

package/types/server/ServerPlugin.d.ts

@@ -1,4 +1,4 @@
-export default ServerPlugin;
+export const kServerPluginName: unique symbol;
 /**
  * Base class to extend in order to create the server-side counterpart of a
  * `soundworks` plugin.
@@ -17,11 +17,11 @@ export default ServerPlugin;
  * @extends {BasePlugin}
  * @inheritdoc
  */
-declare class ServerPlugin extends BasePlugin {
+export default class ServerPlugin extends BasePlugin {
+    static [kServerPluginName]: string;
     /**
      * @param {Server} server - The soundworks server instance.
-     * @param {string} id - User defined id of the plugin as defined in
-     *  {@link ServerPluginManager#register}.
+     * @param {string} id - User defined id of the plugin as defined in {@link ServerPluginManager#register}.
      */
     constructor(server: Server, id: string);
     /**

package/types/server/ServerPluginManager.d.ts

@@ -112,4 +112,3 @@ declare class ServerPluginManager<T> extends BasePluginManager {
     private [kServerPluginManagerRemoveClient];
 }
 import BasePluginManager from '../common/BasePluginManager.js';
-import ServerPlugin from './ServerPlugin.js';