websocket: add websocketinit

lib/websocket/connection.js

@@ -13,7 +13,6 @@ const { fireEvent, failWebsocketConnection } = require('./util')
 const { CloseEvent } = require('./events')
 const { makeRequest } = require('../fetch/request')
 const { fetching } = require('../fetch/index')
-const { getGlobalDispatcher } = require('../global')
 
 const channels = {}
 channels.open = diagnosticsChannel.channel('undici:websocket:open')
@@ -27,7 +26,7 @@ channels.socketError = diagnosticsChannel.channel('undici:websocket:socket_error
  * @param {import('./websocket').WebSocket} ws
  * @param {(response: any) => void} onEstablish
  */
-function establishWebSocketConnection (url, protocols, ws, onEstablish) {
+function establishWebSocketConnection (url, protocols, ws, onEstablish, options) {
   // 1. Let requestURL be a copy of url, with its scheme set to "http", if url’s
   //    scheme is "ws", and to "https" otherwise.
   const requestURL = url
@@ -88,7 +87,7 @@ function establishWebSocketConnection (url, protocols, ws, onEstablish) {
   const controller = fetching({
     request,
     useParallelQueue: true,
-    dispatcher: getGlobalDispatcher(),
+    dispatcher: options.dispatcher,
     processResponse (response) {
       // 1. If response is a network error or its status is not 101,
       //    fail the WebSocket connection.

lib/websocket/websocket.js

@@ -18,6 +18,7 @@ const { establishWebSocketConnection } = require('./connection')
 const { WebsocketFrameSend } = require('./frame')
 const { ByteParser } = require('./receiver')
 const { kEnumerableProperty, isBlobLike } = require('../core/util')
+const { getGlobalDispatcher } = require('../global')
 const { types } = require('util')
 
 let experimentalWarned = false
@@ -39,7 +40,7 @@ class WebSocket extends EventTarget {
    * @param {string} url
    * @param {string|string[]} protocols
    */
-  constructor (url, protocols = []) {
+  constructor (url, protocols = [], options = undefined) {
     super()
 
     webidl.argumentLengthCheck(arguments, 1, { header: 'WebSocket constructor' })
@@ -52,7 +53,19 @@ class WebSocket extends EventTarget {
     }
 
     url = webidl.converters.USVString(url)
-    protocols = webidl.converters['DOMString or sequence<DOMString>'](protocols)
+    protocols = webidl.converters['DOMString or sequence<DOMString> or WebSocketInit'](protocols)
+
+    // user passed a WebSocketInit as 2nd argument
+    if (!Array.isArray(protocols) && typeof protocols === 'object') {
+      options = protocols
+      protocols = protocols.protocols
+    } else {
+      if (options != null && typeof options === 'object') {
+        options = webidl.converters.WebSocketInit(options)
+      } else {
+        options = webidl.converters.WebSocketInit({})
+      }
+    }
 
     // 1. Let urlRecord be the result of applying the URL parser to url.
     let urlRecord
@@ -110,7 +123,8 @@ class WebSocket extends EventTarget {
       urlRecord,
       protocols,
       this,
-      (response) => this.#onConnectionEstablished(response)
+      (response) => this.#onConnectionEstablished(response),
+      options
     )
 
     // Each WebSocket object has an associated ready state, which is a
@@ -577,6 +591,32 @@ webidl.converters['DOMString or sequence<DOMString>'] = function (V) {
   return webidl.converters.DOMString(V)
 }
 
+// This implements the propsal made in https://github.com/whatwg/websockets/issues/42
+webidl.converters.WebSocketInit = webidl.dictionaryConverter([
+  {
+    key: 'protocols',
+    converter: webidl.converters['DOMString or sequence<DOMString>'],
+    get defaultValue () {
+      return []
+    }
+  },
+  {
+    key: 'dispatcher',
+    converter: (V) => V,
+    get defaultValue () {
+      return getGlobalDispatcher()
+    }
+  }
+])
+
+webidl.converters['DOMString or sequence<DOMString> or WebSocketInit'] = function (V) {
+  if (webidl.util.Type(V) === 'Object' && !(Symbol.iterator in V)) {
+    return webidl.converters.WebSocketInit(V)
+  }
+
+  return webidl.converters['DOMString or sequence<DOMString>'](V)
+}
+
 webidl.converters.WebSocketSendData = function (V) {
   if (webidl.util.Type(V) === 'Object') {
     if (isBlobLike(V)) {

test/websocket/websocketinit.js

@@ -0,0 +1,75 @@
+'use strict'
+
+const { test } = require('tap')
+const { WebSocketServer } = require('ws')
+const { WebSocket, Dispatcher, Agent } = require('../..')
+
+test('WebSocketInit', (t) => {
+  t.plan(4)
+
+  class WsDispatcher extends Dispatcher {
+    constructor () {
+      super()
+      this.agent = new Agent()
+    }
+
+    dispatch () {
+      t.pass()
+      return this.agent.dispatch(...arguments)
+    }
+  }
+
+  t.test('WebSocketInit as 2nd param', (t) => {
+    t.plan(1)
+
+    const server = new WebSocketServer({ port: 0 })
+
+    server.on('connection', (ws) => {
+      ws.send(Buffer.from('hello, world'))
+    })
+
+    t.teardown(server.close.bind(server))
+
+    const ws = new WebSocket(`ws://localhost:${server.address().port}`, {
+      dispatcher: new WsDispatcher()
+    })
+
+    ws.onerror = t.fail
+
+    ws.addEventListener('message', async (event) => {
+      t.equal(await event.data.text(), 'hello, world')
+      server.close()
+      ws.close()
+    })
+  })
+
+  t.test('WebSocketInit as 3rd param', (t) => {
+    t.plan(1)
+
+    const server = new WebSocketServer({ port: 0 })
+
+    server.on('connection', (ws) => {
+      ws.send(Buffer.from('hello, world'))
+    })
+
+    t.teardown(server.close.bind(server))
+
+    const ws = new WebSocket(
+      `ws://localhost:${server.address().port}`,
+      undefined,
+      {
+        dispatcher: new WsDispatcher()
+      }
+    )
+
+    console.log(ws)
+
+    ws.onerror = t.fail
+
+    ws.addEventListener('message', async (event) => {
+      t.equal(await event.data.text(), 'hello, world')
+      server.close()
+      ws.close()
+    })
+  })
+})

types/websocket.d.ts

@@ -10,6 +10,7 @@ import {
   AddEventListenerOptions,
   EventListenerOrEventListenerObject
 } from './patch'
+import Dispatcher from './dispatcher'
 
 export type BinaryType = 'blob' | 'arraybuffer'
 
@@ -67,7 +68,7 @@ interface WebSocket extends EventTarget {
 
 export declare const WebSocket: {
   prototype: WebSocket
-  new (url: string | URL, protocols?: string | string[]): WebSocket
+  new (url: string | URL, protocols?: string | string[] | WebSocketInit, options?: WebSocketInit): WebSocket
   readonly CLOSED: number
   readonly CLOSING: number
   readonly CONNECTING: number
@@ -121,3 +122,8 @@ export declare const MessageEvent: {
   prototype: MessageEvent
   new<T>(type: string, eventInitDict?: MessageEventInit<T>): MessageEvent<T>
 }
+
+interface WebSocketInit {
+  protocols?: string | string[],
+  dispatcher?: Dispatcher
+}