Merge pull request #670 from open-rpc/feat/custom-transport

feat: this adds support for adding custom transports

src/index.ts

@@ -1,6 +1,7 @@
 import Server, { ServerOptions } from "./server";
 import { Router } from "./router";
 import { JSONRPCError } from "./error";
+export * as transports from "./transports"
 
 export {
   Server,

src/server.ts

@@ -1,6 +1,6 @@
 import { Router, MethodMapping } from "./router";
 import { OpenrpcDocument as OpenRPC } from "@open-rpc/meta-schema";
-import Transports, { TransportOptions, TransportClasses, TransportNames } from "./transports";
+import Transports, {ServerTransport, TransportOptions, TransportClasses, TransportNames } from "./transports";
 
 interface TransportConfig {
   type: TransportNames;
@@ -31,12 +31,20 @@ export default class Server {
 
     if (options.transportConfigs) {
       options.transportConfigs.forEach((transportConfig) => {
-        this.addTransport(transportConfig.type, transportConfig.options);
+        this.addDefaultTransport(transportConfig.type, transportConfig.options);
       });
     }
   }
 
-  public addTransport(transportType: TransportNames, transportOptions: TransportOptions) {
+  public addTransport(transport: ServerTransport): void{
+    this.routers.forEach((router) => {
+      transport.addRouter(router);
+    });
+
+    this.transports.push(transport);
+  }
+
+  public addDefaultTransport(transportType: TransportNames, transportOptions: TransportOptions) {
     const TransportClass = Transports[transportType];
 
     console.log(`Adding Transport of the type ${transportType} on port ${transportOptions.port}`);
@@ -46,12 +54,7 @@ export default class Server {
     }
 
     const transport = new TransportClass(transportOptions);
-
-    this.routers.forEach((router) => {
-      transport.addRouter(router);
-    });
-
-    this.transports.push(transport);
+    this.addTransport(transport);
   }
 
   public addRouter(openrpcDocument: OpenRPC, methodMapping: MethodMapping | MockModeOptions) {

src/transports/index.ts

@@ -2,13 +2,15 @@ import WebSocketTransport, { WebSocketServerTransportOptions } from "./websocket
 import HTTPTransport, { HTTPServerTransportOptions } from "./http";
 import HTTPSTransport, { HTTPSServerTransportOptions } from "./https";
 import IPCTransport, { IPCServerTransportOptions } from "./ipc";
+import { ServerTransport } from "./server-transport";
+export {HTTPSTransport, HTTPTransport, WebSocketTransport, IPCTransport, ServerTransport}
 
 export type TransportNames = "IPCTransport" | "HTTPTransport" | "HTTPSTransport" | "WebSocketTransport";
 
 export type TransportClasses = WebSocketTransport |
   HTTPTransport |
   HTTPSTransport |
-  IPCTransport;
+  IPCTransport | ServerTransport;
 
 export type TransportOptions = WebSocketServerTransportOptions |
   HTTPServerTransportOptions |

src/transports/server-transport.test.ts

@@ -0,0 +1,13 @@
+import ServerTransport from "./server-transport";
+
+describe("Server transport test", () => {
+
+  class DummyTransport extends ServerTransport {
+
+  }
+
+  it("transport implementation throws without start", async () => {
+    expect(()=>new DummyTransport().start()).toThrowError()
+  });
+
+});

src/transports/server-transport.ts

@@ -20,7 +20,7 @@ export interface JSONRPCResponse {
   error?: JSONRPCErrorObject;
 }
 
-export default abstract class ServerTransport {
+export abstract class ServerTransport {
   public routers: Router[] = [];
 
   public addRouter(router: Router): void {
@@ -31,6 +31,11 @@ export default abstract class ServerTransport {
     this.routers = this.routers.filter((r) => r !== router);
   }
 
+  public start(): void {
+    console.warn("Transport must implement start()"); // tslint:disable-line
+    throw new Error("Transport missing start implementation");
+  }
+
   protected async routerHandler({ id, method, params }: JSONRPCRequest): Promise<JSONRPCResponse> {
     if (this.routers.length === 0) {
       console.warn("transport method called without a router configured."); // tslint:disable-line
@@ -60,3 +65,4 @@ export default abstract class ServerTransport {
     return res;
   }
 }
+export default ServerTransport;