Adding connectionOptions as a plugin option to enable readableObjectMode and other Duplex options

Author: aelnaiem

index.d.ts

@@ -3,7 +3,7 @@ import { IncomingMessage, ServerResponse, Server } from 'http';
 import { FastifyRequest, FastifyPluginCallback, RawServerBase, RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, RequestGenericInterface, ContextConfigDefault, FastifyInstance } from 'fastify';
 import * as fastify from 'fastify';
 import * as WebSocket from 'ws';
-import { Duplex } from 'stream';
+import { Duplex, DuplexOptions } from 'stream';
 import { FastifyReply } from 'fastify/types/reply';
 import { RouteGenericInterface } from 'fastify/types/route';
 
@@ -59,6 +59,7 @@ export interface SocketStream extends Duplex {
 export interface WebsocketPluginOptions {
   errorHandler?: (this: FastifyInstance, error: Error, connection: SocketStream, request: FastifyRequest, reply: FastifyReply) => void;
   options?: WebSocketServerOptions;
+  connectionOptions?: DuplexOptions;
 }
 
 export interface RouteOptions<RawServer extends RawServerBase = RawServerDefault, RawRequest extends RawRequestDefaultExpression<RawServer> = RawRequestDefaultExpression<RawServer>, RawReply extends RawReplyDefaultExpression<RawServer> = RawReplyDefaultExpression<RawServer>, RouteGeneric extends RouteGenericInterface = RouteGenericInterface, ContextConfig = ContextConfigDefault, SchemaCompiler = fastify.FastifySchema> extends fastify.RouteOptions<RawServer, RawRequest, RawReply, RouteGeneric, ContextConfig, SchemaCompiler>, WebsocketRouteOptions<RawServer, RawRequest, RouteGeneric> {}

index.js

@@ -58,7 +58,7 @@ function fastifyWebsocket (fastify, opts, next) {
     wss.handleUpgrade(rawRequest, rawRequest[kWs], rawRequest[kWsHead], (socket) => {
       wss.emit('connection', socket, rawRequest)
 
-      const connection = WebSocket.createWebSocketStream(socket)
+      const connection = WebSocket.createWebSocketStream(socket, opts.connectionOptions)
       connection.socket = socket
 
       connection.socket.on('newListener', event => {

test/base.js

@@ -304,6 +304,41 @@ test('Should be able to pass clientTracking option in false to websocket-stream'
   })
 })
 
+test('Should be able to pass custom connectionOptions to createWebSocketStream', (t) => {
+  t.plan(3)
+
+  const fastify = Fastify()
+  t.teardown(() => fastify.close())
+
+  const connectionOptions = {
+    readableObjectMode: true
+  }
+
+  fastify.register(fastifyWebsocket, { connectionOptions })
+
+  fastify.get('/', { websocket: true }, (connection, request) => {
+    t.equal(connection.readableObjectMode, true)
+    connection.socket.binaryType = 'arraybuffer'
+
+    connection.once('data', (chunk) => {
+      const message = new TextDecoder().decode(chunk)
+      t.equal(message, 'Hello')
+    })
+    t.teardown(() => connection.destroy())
+  })
+
+  fastify.listen(0, (err) => {
+    t.error(err)
+
+    const ws = new WebSocket('ws://localhost:' + fastify.server.address().port)
+    const client = WebSocket.createWebSocketStream(ws, { encoding: 'utf8' })
+    t.teardown(() => client.destroy())
+
+    client.setEncoding('utf8')
+    client.write('Hello')
+  })
+})
+
 test('Should gracefully close with a connected client', (t) => {
   t.plan(6)