feat: allowing typescript inheritance for deepstream.io

src/config/config-initialiser.ts

@@ -1,5 +1,3 @@
-'use strict'
-
 import * as fs from 'fs'
 import FileAuthenticationHandler from '../authentication/file-based-authentication-handler'
 import OpenAuthenticationHandler from '../authentication/open-authentication-handler'
@@ -17,6 +15,16 @@ import * as fileUtils from './file-utils'
 
 let commandLineArguments
 
+const customPlugins = new Map()
+
+/**
+ * Registers plugins by name. Useful when wanting to include
+ * custom plugins in a binary
+ */
+export const registerPlugin = function (name: string, construct: Function) {
+  customPlugins.set(name, construct)
+}
+
 /**
  * Takes a configuration object and instantiates functional properties.
  * CLI arguments will be considered.
@@ -196,6 +204,10 @@ function handleConnectionEndpoints (config: DeepstreamConfig, services: any): Ar
  * CLI arguments will be considered.
  */
 function resolvePluginClass (plugin: PluginConfig, type: string): any {
+  if (customPlugins.has(plugin.name)) {
+    return customPlugins.get(plugin.name)
+  }
+
   // nexe needs *global.require* for __dynamic__ modules
   // but browserify and proxyquire can't handle *global.require*
   const req = global && global.require ? global.require : require

src/deepstream.io.ts

@@ -34,8 +34,8 @@ process.title = 'deepstream server'
 export class Deepstream extends EventEmitter {
   public constants: any
 
-  private config: DeepstreamConfig
-  private services: DeepstreamServices
+  protected config: DeepstreamConfig
+  protected services: DeepstreamServices
 
   private messageProcessor: any
   private messageDistributor: any
@@ -193,7 +193,7 @@ export class Deepstream extends EventEmitter {
 /**
  * Invoked once the logger is initialised. Initialises any built-in or custom Deepstream plugins.
  */
-  private pluginInit (): void {
+  protected pluginInit (): void {
     this.services.message = new MessageConnector(this.config, this.services, 'deepstream')
 
     const infoLogger = message => this.services.logger.info(EVENT.INFO, message)
@@ -239,7 +239,7 @@ export class Deepstream extends EventEmitter {
  * Invoked once all plugins are initialised. Instantiates the messaging pipeline and
  * the various handlers.
  */
-  private serviceInit (): void {
+  protected serviceInit (): void {
     this.messageProcessor = new MessageProcessor(this.config, this.services)
     this.messageDistributor = new MessageDistributor(this.config, this.services)
 

test-e2e/tools/cluster.js

@@ -1,5 +1,3 @@
-'use strict'
-
 const { Deepstream } = require('../../dist/src/deepstream.io')
 const LocalCache = require('../../dist/src/default-plugins/local-cache').default
 const localCache = new LocalCache()