bare-ws 1.3.0 → 2.0.0

package/lib/constants.js

@@ -1,4 +1,4 @@
-const EOL = exports.EOL = '\r\n'
+const EOL = (exports.EOL = '\r\n')
 
 exports.EOF = EOL.repeat(2)
 

package/lib/errors.js

@@ -1,7 +1,7 @@
 const { status } = require('./constants')
 
 module.exports = class WebSocketError extends Error {
-  constructor (msg, code, status, fn = WebSocketError) {
+  constructor(msg, code, status, fn = WebSocketError) {
     super(`${code}: ${msg}`)
     this.code = code
     this.status = status
@@ -11,71 +11,151 @@ module.exports = class WebSocketError extends Error {
     }
   }
 
-  get name () {
+  get name() {
     return 'WebSocketError'
   }
 
-  static NOT_CONNECTED (msg = 'Socket is not connected') {
-    return new WebSocketError(msg, 'NOT_CONNECTED', 0, WebSocketError.NOT_CONNECTED)
-  }
-
-  static UNEXPECTED_RSV1 (msg = 'RSV1 must be unset') {
-    return new WebSocketError(msg, 'UNEXPECTED_RSV1', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_RSV1)
-  }
-
-  static UNEXPECTED_RSV2 (msg = 'RSV2 must be unset') {
-    return new WebSocketError(msg, 'UNEXPECTED_RSV2', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_RSV2)
-  }
-
-  static UNEXPECTED_RSV3 (msg = 'RSV3 must be unset') {
-    return new WebSocketError(msg, 'UNEXPECTED_RSV3', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_RSV3)
-  }
-
-  static EXPECTED_MASK (msg = 'MASK must be set') {
-    return new WebSocketError(msg, 'EXPECTED_MASK', status.PROTOCOL_ERROR, WebSocketError.EXPECTED_MASK)
-  }
-
-  static UNEXPECTED_MASK (msg = 'MASK must be unset') {
-    return new WebSocketError(msg, 'UNEXPECTED_MASK', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_MASK)
-  }
-
-  static EXPECTED_CONTINUATION (msg = 'Expected a continuation frame') {
-    return new WebSocketError(msg, 'EXPECTED_CONTINUATION', status.PROTOCOL_ERROR, WebSocketError.EXPECTED_CONTINUATION)
-  }
-
-  static UNEXPECTED_CONTINUATION (msg = 'Unexpected continuation frame') {
-    return new WebSocketError(msg, 'UNEXPECTED_CONTINUATION', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_CONTINUATION)
-  }
-
-  static UNEXPECTED_CONTROL (msg = 'Unexpected control frame') {
-    return new WebSocketError(msg, 'UNEXPECTED_CONTROL', status.PROTOCOL_ERROR, WebSocketError.UNEXPECTED_CONTROL)
-  }
-
-  static INVALID_ENCODING (msg = 'Invalid encoding') {
-    return new WebSocketError(msg, 'INVALID_ENCODING', status.PROTOCOL_ERROR, WebSocketError.INVALID_ENCODING)
-  }
-
-  static INVALID_UPGRADE_HEADER (msg = 'Invalid Upgrade header') {
-    return new WebSocketError(msg, 'INVALID_UPGRADE_HEADER', status.PROTOCOL_ERROR, WebSocketError.INVALID_UPGRADE_HEADER)
-  }
-
-  static INVALID_VERSION_HEADER (msg = 'Invalid Sec-WebSocket-Version header') {
-    return new WebSocketError(msg, 'INVALID_VERSION_HEADER', status.PROTOCOL_ERROR, WebSocketError.INVALID_VERSION_HEADER)
-  }
-
-  static INVALID_KEY_HEADER (msg = 'Invalid Sec-WebSocket-Key header') {
-    return new WebSocketError(msg, 'INVALID_KEY_HEADER', status.PROTOCOL_ERROR, WebSocketError.INVALID_KEY_HEADER)
-  }
-
-  static INVALID_ACCEPT_HEADER (msg = 'Invalid Sec-WebSocket-Accept header') {
-    return new WebSocketError(msg, 'INVALID_ACCEPT_HEADER', status.PROTOCOL_ERROR, WebSocketError.INVALID_ACCEPT_HEADER)
-  }
-
-  static INVALID_OPCODE (msg = 'Invalid opcode') {
-    return new WebSocketError(msg, 'INVALID_OPCODE', status.PROTOCOL_ERROR, WebSocketError.INVALID_OPCODE)
-  }
-
-  static INVALID_PAYLOAD_LENGTH (msg = 'Invalid payload length') {
-    return new WebSocketError(msg, 'INVALID_PAYLOAD_LENGTH', status.MESSAGE_TOO_LARGE, WebSocketError.INVALID_PAYLOAD_LENGTH)
+  static NOT_CONNECTED(msg = 'Socket is not connected') {
+    return new WebSocketError(
+      msg,
+      'NOT_CONNECTED',
+      0,
+      WebSocketError.NOT_CONNECTED
+    )
+  }
+
+  static UNEXPECTED_RSV1(msg = 'RSV1 must be unset') {
+    return new WebSocketError(
+      msg,
+      'UNEXPECTED_RSV1',
+      status.PROTOCOL_ERROR,
+      WebSocketError.UNEXPECTED_RSV1
+    )
+  }
+
+  static UNEXPECTED_RSV2(msg = 'RSV2 must be unset') {
+    return new WebSocketError(
+      msg,
+      'UNEXPECTED_RSV2',
+      status.PROTOCOL_ERROR,
+      WebSocketError.UNEXPECTED_RSV2
+    )
+  }
+
+  static UNEXPECTED_RSV3(msg = 'RSV3 must be unset') {
+    return new WebSocketError(
+      msg,
+      'UNEXPECTED_RSV3',
+      status.PROTOCOL_ERROR,
+      WebSocketError.UNEXPECTED_RSV3
+    )
+  }
+
+  static EXPECTED_MASK(msg = 'MASK must be set') {
+    return new WebSocketError(
+      msg,
+      'EXPECTED_MASK',
+      status.PROTOCOL_ERROR,
+      WebSocketError.EXPECTED_MASK
+    )
+  }
+
+  static UNEXPECTED_MASK(msg = 'MASK must be unset') {
+    return new WebSocketError(
+      msg,
+      'UNEXPECTED_MASK',
+      status.PROTOCOL_ERROR,
+      WebSocketError.UNEXPECTED_MASK
+    )
+  }
+
+  static EXPECTED_CONTINUATION(msg = 'Expected a continuation frame') {
+    return new WebSocketError(
+      msg,
+      'EXPECTED_CONTINUATION',
+      status.PROTOCOL_ERROR,
+      WebSocketError.EXPECTED_CONTINUATION
+    )
+  }
+
+  static UNEXPECTED_CONTINUATION(msg = 'Unexpected continuation frame') {
+    return new WebSocketError(
+      msg,
+      'UNEXPECTED_CONTINUATION',
+      status.PROTOCOL_ERROR,
+      WebSocketError.UNEXPECTED_CONTINUATION
+    )
+  }
+
+  static UNEXPECTED_CONTROL(msg = 'Unexpected control frame') {
+    return new WebSocketError(
+      msg,
+      'UNEXPECTED_CONTROL',
+      status.PROTOCOL_ERROR,
+      WebSocketError.UNEXPECTED_CONTROL
+    )
+  }
+
+  static INVALID_ENCODING(msg = 'Invalid encoding') {
+    return new WebSocketError(
+      msg,
+      'INVALID_ENCODING',
+      status.PROTOCOL_ERROR,
+      WebSocketError.INVALID_ENCODING
+    )
+  }
+
+  static INVALID_UPGRADE_HEADER(msg = 'Invalid Upgrade header') {
+    return new WebSocketError(
+      msg,
+      'INVALID_UPGRADE_HEADER',
+      status.PROTOCOL_ERROR,
+      WebSocketError.INVALID_UPGRADE_HEADER
+    )
+  }
+
+  static INVALID_VERSION_HEADER(msg = 'Invalid Sec-WebSocket-Version header') {
+    return new WebSocketError(
+      msg,
+      'INVALID_VERSION_HEADER',
+      status.PROTOCOL_ERROR,
+      WebSocketError.INVALID_VERSION_HEADER
+    )
+  }
+
+  static INVALID_KEY_HEADER(msg = 'Invalid Sec-WebSocket-Key header') {
+    return new WebSocketError(
+      msg,
+      'INVALID_KEY_HEADER',
+      status.PROTOCOL_ERROR,
+      WebSocketError.INVALID_KEY_HEADER
+    )
+  }
+
+  static INVALID_ACCEPT_HEADER(msg = 'Invalid Sec-WebSocket-Accept header') {
+    return new WebSocketError(
+      msg,
+      'INVALID_ACCEPT_HEADER',
+      status.PROTOCOL_ERROR,
+      WebSocketError.INVALID_ACCEPT_HEADER
+    )
+  }
+
+  static INVALID_OPCODE(msg = 'Invalid opcode') {
+    return new WebSocketError(
+      msg,
+      'INVALID_OPCODE',
+      status.PROTOCOL_ERROR,
+      WebSocketError.INVALID_OPCODE
+    )
+  }
+
+  static INVALID_PAYLOAD_LENGTH(msg = 'Invalid payload length') {
+    return new WebSocketError(
+      msg,
+      'INVALID_PAYLOAD_LENGTH',
+      status.MESSAGE_TOO_LARGE,
+      WebSocketError.INVALID_PAYLOAD_LENGTH
+    )
   }
 }

package/lib/frame.js

@@ -12,8 +12,8 @@ const MASK = 0b10000000
 const LENGTH = 0b01111111
 
 // https://datatracker.ietf.org/doc/html/rfc6455#section-5
-const Frame = module.exports = exports = class Frame {
-  constructor (opcode, payload = EMPTY, opts = {}) {
+module.exports = exports = class Frame {
+  constructor(opcode, payload = EMPTY, opts = {}) {
     if (payload && !Buffer.isBuffer(payload)) {
       opts = payload
       payload = EMPTY
@@ -36,7 +36,7 @@ const Frame = module.exports = exports = class Frame {
     this.payload = payload
   }
 
-  toBuffer () {
+  toBuffer() {
     const state = { start: 0, end: 0, buffer: null }
 
     Frame.preencode(state, this)
@@ -49,7 +49,9 @@ const Frame = module.exports = exports = class Frame {
   }
 }
 
-exports.preencode = function preencode (state, f) {
+const Frame = exports
+
+exports.preencode = function preencode(state, f) {
   let i = state.end
 
   i++
@@ -69,7 +71,7 @@ exports.preencode = function preencode (state, f) {
   state.end = i
 }
 
-exports.encode = function encode (state, f) {
+exports.encode = function encode(state, f) {
   const b = state.buffer
 
   let i = state.start
@@ -133,7 +135,7 @@ exports.encode = function encode (state, f) {
   state.start = i
 }
 
-exports.decode = function decode (state) {
+exports.decode = function decode(state) {
   const b = state.buffer
 
   let i = state.start

package/lib/server.js

@@ -11,7 +11,7 @@ const EMPTY = Buffer.alloc(0)
 const KEY = /^[+/0-9A-Za-z]{22}==$/
 
 module.exports = exports = class WebSocketServer extends EventEmitter {
-  constructor (opts = {}, onconnection) {
+  constructor(opts = {}, onconnection) {
     if (typeof opts === 'function') {
       onconnection = opts
       opts = {}
@@ -22,7 +22,10 @@ module.exports = exports = class WebSocketServer extends EventEmitter {
     const createServer = opts.secure ? https.createServer : http.createServer
 
     const {
-      server = createServer(opts, this._onrequest.bind(this)).listen(opts, this._onlistening.bind(this))
+      server = createServer(opts, this._onrequest.bind(this)).listen(
+        opts,
+        this._onlistening.bind(this)
+      )
     } = opts
 
     this._server = server
@@ -32,31 +35,31 @@ module.exports = exports = class WebSocketServer extends EventEmitter {
     if (onconnection) this.on('connection', onconnection)
   }
 
-  get listening () {
+  get listening() {
     return this._server.listening
   }
 
-  address () {
+  address() {
     return this._server.address()
   }
 
-  close (cb) {
+  close(cb) {
     return this._server.close(cb)
   }
 
-  ref () {
+  ref() {
     this._server.ref()
   }
 
-  unref () {
+  unref() {
     this._server.unref()
   }
 
-  _onlistening () {
+  _onlistening() {
     this.emit('listening')
   }
 
-  _onrequest (req, res) {
+  _onrequest(req, res) {
     const body = http.constants.status[426]
 
     res.writeHead(426, {
@@ -67,7 +70,7 @@ module.exports = exports = class WebSocketServer extends EventEmitter {
     res.end(body)
   }
 
-  _onupgrade (req, socket, head) {
+  _onupgrade(req, socket, head) {
     handshake(req, socket, head, (err) => {
       if (err) return socket.destroy(err)
 
@@ -77,7 +80,12 @@ module.exports = exports = class WebSocketServer extends EventEmitter {
 }
 
 // https://datatracker.ietf.org/doc/html/rfc6455#section-4.2
-const handshake = exports.handshake = function handshake (req, socket = req.socket, head = EMPTY, cb) {
+const handshake = (exports.handshake = function handshake(
+  req,
+  socket = req.socket,
+  head = EMPTY,
+  cb
+) {
   if (typeof socket === 'function') {
     cb = socket
     socket = req.socket
@@ -103,19 +111,24 @@ const handshake = exports.handshake = function handshake (req, socket = req.sock
     return cb(errors.INVALID_KEY_HEADER())
   }
 
-  const digest = crypto.createHash('sha1')
+  const digest = crypto
+    .createHash('sha1')
     .update(key)
     .update(GUID)
     .digest('base64')
 
   socket.write(
-    'HTTP/1.1 101 Web Socket Protocol Handshake' + EOL +
-    'Upgrade: WebSocket' + EOL +
-    'Connection: Upgrade' + EOL +
-    `Sec-WebSocket-Accept: ${digest}` + EOF
+    'HTTP/1.1 101 Web Socket Protocol Handshake' +
+      EOL +
+      'Upgrade: WebSocket' +
+      EOL +
+      'Connection: Upgrade' +
+      EOL +
+      `Sec-WebSocket-Accept: ${digest}` +
+      EOF
   )
 
   if (head.byteLength) socket.unshift(head)
 
   cb(null)
-}
+})

package/lib/socket.js

@@ -9,10 +9,10 @@ const Frame = require('./frame')
 const CLOSE = new Frame(opcode.CLOSE).toBuffer()
 
 module.exports = exports = class WebSocket extends Duplex {
-  constructor (url, opts = {}) {
+  constructor(url, opts = {}) {
     if (typeof url === 'string') url = new URL(url)
 
-    if (URL.isURL(url)) {
+    if (isURL(url)) {
       opts = opts ? { ...opts } : {}
 
       opts.host = url.hostname
@@ -21,12 +21,14 @@ module.exports = exports = class WebSocket extends Duplex {
       opts.secure = url.protocol === 'https:' || url.protocol === 'wss:'
     } else {
       opts = url ? { ...url } : {}
+
+      // For Node.js compatibility
+      opts.host = opts.hostname || opts.host
+      opts.port =
+        typeof opts.port === 'string' ? parseInt(opts.port, 10) : opts.port
     }
 
-    const {
-      isServer = false,
-      socket = null
-    } = opts
+    const { isServer = false, socket = null } = opts
 
     super({ eagerOpen: true })
 
@@ -44,23 +46,27 @@ module.exports = exports = class WebSocket extends Duplex {
     else this._connect(opts)
   }
 
-  ping (data) {
+  ping(data) {
     if (this._socket === null) throw errors.NOT_CONNECTED()
 
     if (typeof data === 'string') data = Buffer.from(data)
 
-    this._socket.write(new Frame(opcode.PING, data, { mask: this._mask }).toBuffer())
+    this._socket.write(
+      new Frame(opcode.PING, data, { mask: this._mask }).toBuffer()
+    )
   }
 
-  pong (data) {
+  pong(data) {
     if (this._socket === null) throw errors.NOT_CONNECTED()
 
     if (typeof data === 'string') data = Buffer.from(data)
 
-    this._socket.write(new Frame(opcode.PONG, data, { mask: this._mask }).toBuffer())
+    this._socket.write(
+      new Frame(opcode.PONG, data, { mask: this._mask }).toBuffer()
+    )
   }
 
-  _attach (socket) {
+  _attach(socket) {
     this._socket = socket
 
     this._socket
@@ -70,7 +76,7 @@ module.exports = exports = class WebSocket extends Duplex {
       .on('drain', this._ondrain.bind(this))
   }
 
-  _connect (opts) {
+  _connect(opts) {
     const request = opts.secure ? https.request : http.request
 
     const req = request(opts)
@@ -86,15 +92,15 @@ module.exports = exports = class WebSocket extends Duplex {
     })
   }
 
-  _onerror (err) {
+  _onerror(err) {
     this.destroy(err)
   }
 
-  _onclose () {
+  _onclose() {
     this.destroy()
   }
 
-  _ondata (data) {
+  _ondata(data) {
     if (this._buffer === null) this._buffer = data
     else this._buffer = Buffer.concat([this._buffer, data])
 
@@ -110,7 +116,8 @@ module.exports = exports = class WebSocket extends Duplex {
 
       if (frame === null) return
 
-      this._buffer = state.start === state.end ? null : this._buffer.subarray(state.start)
+      this._buffer =
+        state.start === state.end ? null : this._buffer.subarray(state.start)
 
       try {
         this._onframe(frame)
@@ -120,7 +127,7 @@ module.exports = exports = class WebSocket extends Duplex {
     }
   }
 
-  _onframe (frame) {
+  _onframe(frame) {
     if (frame.rsv1) throw errors.UNEXPECTED_RSV1()
 
     if (frame.rsv2) throw errors.UNEXPECTED_RSV2()
@@ -132,15 +139,18 @@ module.exports = exports = class WebSocket extends Duplex {
     }
 
     if (frame.fin === false) {
-      if (this._fragments.push(frame) === 1) { // First frame
-        if (frame.opcode === opcode.CONTINUATION) throw errors.UNEXPECTED_CONTINUATION()
+      if (this._fragments.push(frame) === 1) {
+        // First frame
+        if (frame.opcode === opcode.CONTINUATION)
+          throw errors.UNEXPECTED_CONTINUATION()
 
         if (frame.opcode >= opcode.CLOSE) throw errors.UNEXPECTED_CONTROL()
 
         return
       }
 
-      if (frame.opcode !== opcode.CONTINUATION) throw errors.EXPECTED_CONTINUATION()
+      if (frame.opcode !== opcode.CONTINUATION)
+        throw errors.EXPECTED_CONTINUATION()
 
       return
     }
@@ -165,7 +175,7 @@ module.exports = exports = class WebSocket extends Duplex {
 
         frame.opcode = this._fragments[0].opcode
 
-        const payloads = this._fragments.map(frame => frame.payload)
+        const payloads = this._fragments.map((frame) => frame.payload)
 
         payloads.push(frame.payload)
 
@@ -191,41 +201,45 @@ module.exports = exports = class WebSocket extends Duplex {
     }
   }
 
-  _ondrain () {
+  _ondrain() {
     if (this._pendingWrite === null) return
     const cb = this._pendingWrite
     this._pendingWrite = null
     cb(null)
   }
 
-  _open (cb) {
+  _open(cb) {
     if (this._socket === null) this._pendingOpen = cb
     else cb(null)
   }
 
-  _write (data, encoding, cb) {
+  _write(data, encoding, cb) {
     if (encoding !== 'buffer' && encoding !== 'utf8') {
       return cb(errors.INVALID_ENCODING())
     }
 
-    const frame = new Frame(encoding === 'buffer' ? opcode.BINARY : opcode.TEXT, data, { mask: this._mask })
+    const frame = new Frame(
+      encoding === 'buffer' ? opcode.BINARY : opcode.TEXT,
+      data,
+      { mask: this._mask }
+    )
 
     if (this._socket.write(frame.toBuffer())) cb(null)
     else this._pendingWrite = cb
   }
 
-  _final (cb) {
+  _final(cb) {
     this._socket.end(CLOSE)
     cb(null)
   }
 
-  _predestroy () {
+  _predestroy() {
     this._socket.destroy()
   }
 }
 
 // https://datatracker.ietf.org/doc/html/rfc6455#section-4.1
-const handshake = exports.handshake = function handshake (req, cb) {
+const handshake = (exports.handshake = function handshake(req, cb) {
   const key = crypto.randomBytes(16).toString('base64')
 
   req.headers = {
@@ -241,7 +255,8 @@ const handshake = exports.handshake = function handshake (req, cb) {
       return cb(errors.INVALID_UPGRADE_HEADER())
     }
 
-    const digest = crypto.createHash('sha1')
+    const digest = crypto
+      .createHash('sha1')
       .update(key)
       .update(GUID)
       .digest('base64')
@@ -256,17 +271,32 @@ const handshake = exports.handshake = function handshake (req, cb) {
   })
 
   req.end()
-}
+})
 
 // https://url.spec.whatwg.org/#default-port
-function defaultPort (url) {
+function defaultPort(url) {
   switch (url.protocol) {
-    case 'ftp:': return 21
+    case 'ftp:':
+      return 21
     case 'http:':
-    case 'ws:': return 80
+    case 'ws:':
+      return 80
     case 'https:':
-    case 'wss:': return 443
+    case 'wss:':
+      return 443
   }
 
   return null
 }
+
+// https://url.spec.whatwg.org/#api
+function isURL(url) {
+  return (
+    url !== null &&
+    typeof url === 'object' &&
+    typeof url.protocol === 'string' &&
+    typeof url.hostname === 'string' &&
+    typeof url.pathname === 'string' &&
+    typeof url.search === 'string'
+  )
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-ws",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "WebSocket library for JavaScript",
   "exports": {
     ".": "./index.js",
@@ -13,7 +13,7 @@
     "lib"
   ],
   "scripts": {
-    "test": "standard && bare test.js"
+    "test": "prettier . --check && bare test.js"
   },
   "repository": {
     "type": "git",
@@ -28,13 +28,14 @@
   "dependencies": {
     "bare-crypto": "^1.2.0",
     "bare-events": "^2.3.1",
-    "bare-http1": "^3.5.2",
-    "bare-https": "^1.1.0",
+    "bare-http1": "^4.0.0",
+    "bare-https": "^2.0.0",
     "bare-stream": "^2.1.2"
   },
   "devDependencies": {
-    "bare-fs": "^2.3.1",
+    "bare-fs": "^4.0.0",
     "brittle": "^3.3.0",
-    "standard": "^17.0.0"
+    "prettier": "^3.4.1",
+    "prettier-config-standard": "^7.0.0"
   }
 }