initial commit

Author: jkyberneees

demos/ws-proxy.js

@@ -1,14 +1,21 @@
-const http = require('http')
-const WebSocket = require('faye-websocket')
+'use strict'
 
-const server = http.createServer()
+const gateway = require('./../index')
+const PORT = process.env.PORT || 8080
 
-server.on('upgrade', (request, socket, body) => {
-  const client = new WebSocket(request, socket, body)
-  const target = new WebSocket.Client('ws://ws.ifelse.io')
+gateway({
+  routes: [{
+    // ... other HTTP or WebSocket routes
+  }, {
+    proxyType: 'websocket',
+    prefix: '/echo',
+    target: 'ws://ws.ifelse.io',
+    hooks: {
+      onOpen: (ws, searchParams) => {
 
-  client.pipe(target)
-  target.pipe(client)
+      }
+    }
+  }]
+}).start(PORT).then(server => {
+  console.log(`API Gateway listening on ${PORT} port!`)
 })
-
-server.listen(3000)

index.d.ts

@@ -35,12 +35,15 @@ declare namespace fastgateway {
 
   interface WebSocketRoute {
     proxyType: 'websocket';
-    proxyConfig?: {};
-    proxyHandler?: Function;
+    proxyConfig?: {}; // https://github.com/faye/faye-websocket-node#initialization-options
     prefix: string;
-    prefixRewrite?: string;
     target: string;
-    middlewares?: Function[];
+    subProtocols?: []; // https://github.com/faye/faye-websocket-node#subprotocol-negotiation
+    hooks?: WebSocketHooks;
+  }
+
+  interface WebSocketHooks {
+    onOpen?: Function;
   }
 
   interface Hooks {

index.js

@@ -8,6 +8,7 @@ const defaultProxyHandler = (req, res, url, proxy, proxyOpts) => proxy(req, res,
 const DEFAULT_METHODS = require('restana/libs/methods').filter(method => method !== 'all')
 const send = require('@polka/send-type')
 const PROXY_TYPES = ['http', 'lambda']
+const wsProxy = require('./lib/ws-proxy')
 
 const gateway = (opts) => {
   const proxyFactory = opts.proxyFactory || defaultProxyFactory
@@ -17,24 +18,31 @@ const gateway = (opts) => {
     pathRegex: '/*'
   }, opts)
 
-  const server = opts.server || restana(opts.restana)
+  const router = opts.server || restana(opts.restana)
 
   // registering global middlewares
   opts.middlewares.forEach(middleware => {
-    server.use(middleware)
+    router.use(middleware)
   })
 
   // registering services.json
   const services = opts.routes.map(route => ({
     prefix: route.prefix,
     docs: route.docs
   }))
-  server.get('/services.json', (req, res) => {
+  router.get('/services.json', (req, res) => {
     send(res, 200, services)
   })
 
-  // processing routes
-  opts.routes.forEach(route => {
+  // processing websocket routes
+  const wsRoutes = opts.routes.filter(route => route.proxyType === 'websocket')
+  wsProxy({
+    routes: wsRoutes,
+    server: router.getServer()
+  })
+
+  // processing non-websocket routes
+  opts.routes.filter(route => route.proxyType !== 'websocket').forEach(route => {
     if (undefined === route.prefixRewrite) {
       route.prefixRewrite = ''
     }
@@ -82,13 +90,13 @@ const gateway = (opts) => {
 
     methods.forEach(method => {
       method = method.toLowerCase()
-      if (server[method]) {
-        server[method].apply(server, args)
+      if (router[method]) {
+        router[method].apply(router, args)
       }
     })
   })
 
-  return server
+  return router
 }
 
 const handler = (route, proxy, proxyHandler) => async (req, res, next) => {

lib/ws-proxy.js

@@ -0,0 +1,44 @@
+'use strict'
+
+const WebSocket = require('faye-websocket')
+
+function onOpenNoOp () {}
+
+module.exports = (config) => {
+  const { routes, server } = config
+
+  const prefix2route = {}
+  for (const route of routes) {
+    prefix2route[route.prefix] = route
+  }
+
+  server.on('upgrade', async (req, socket, body) => {
+    if (WebSocket.isWebSocket(req)) {
+      const url = new URL('http://dummy' + req.url)
+      const route = prefix2route[url.pathname]
+
+      if (route) {
+        const subProtocols = route.subProtocols || []
+        const client = new WebSocket(req, socket, body, subProtocols)
+        route.hooks = route.hooks || {}
+        const onOpen = route.hooks.onOpen || onOpenNoOp
+
+        try {
+          await onOpen(client, url.searchParams)
+
+          const target = route.target + '?' + url.searchParams.toString()
+          const remote = new WebSocket.Client(target, subProtocols, route.proxyConfig)
+
+          client.pipe(remote)
+          remote.pipe(client)
+        } catch (err) {
+          client.close(err.closeEventCode || 4000, err.message)
+        }
+      } else {
+        socket.destroy()
+      }
+    } else {
+      socket.destroy()
+    }
+  })
+}

package.json

@@ -28,7 +28,7 @@
   "homepage": "https://github.com/jkyberneees/fast-gateway#readme",
   "dependencies": {
     "@polka/send-type": "^0.5.2",
-    "fast-proxy-lite": "^1.0.1",
+    "fast-proxy-lite": "^1.0.2",
     "http-cache-middleware": "^1.3.8",
     "restana": "^4.9.2",
     "stream-to-array": "^2.3.0"
@@ -42,7 +42,7 @@
   ],
   "devDependencies": {
     "@types/express": "^4.17.11",
-    "aws-sdk": "^2.1023.0",
+    "aws-sdk": "^2.1037.0",
     "chai": "^4.3.4",
     "cors": "^2.8.5",
     "express": "^4.17.1",