bare-ws 2.0.2 → 2.0.4

package/lib/errors.d.ts

@@ -1,28 +1,23 @@
 declare class WebSocketError extends Error {
-  constructor(
-    msg: string,
-    code: string,
-    status: number,
-    fn?: WebSocketError,
-    cause?: unknown
-  )
+  constructor(msg: string, code: string, status: number, fn?: WebSocketError, cause?: unknown)
 
   static NETWORK_ERROR(msg: string, cause?: unknown): WebSocketError
-  static NOT_CONNECTED(msg?: string, cause?: unknown): WebSocketError
-  static UNEXPECTED_RSV1(msg?: string, cause?: unknown): WebSocketError
-  static UNEXPECTED_RSV2(msg?: string, cause?: unknown): WebSocketError
-  static UNEXPECTED_RSV3(msg?: string, cause?: unknown): WebSocketError
-  static EXPECTED_MASK(msg?: string, cause?: unknown): WebSocketError
-  static EXPECTED_CONTINUATION(msg?: string, cause?: unknown): WebSocketError
-  static UNEXPECTED_CONTINUATION(msg?: string, cause?: unknown): WebSocketError
-  static UNEXPECTED_CONTROL(msg?: string, cause?: unknown): WebSocketError
-  static INVALID_ENCODING(msg?: string, cause?: unknown): WebSocketError
-  static INVALID_UPGRADE_HEADER(msg?: string, cause?: unknown): WebSocketError
-  static INVALID_VERSION_HEADER(msg?: string, cause?: unknown): WebSocketError
-  static INVALID_KEY_HEADER(msg?: string, cause?: unknown): WebSocketError
-  static INVALID_ACCEPT_HEADER(msg?: string, cause?: unknown): WebSocketError
-  static INVALID_OPCODE(msg?: string, cause?: unknown): WebSocketError
-  static INVALID_PAYLOAD_LENGTH(msg?: string, cause?: unknown): WebSocketError
+  static NOT_CONNECTED(msg?: string): WebSocketError
+  static UNEXPECTED_RSV1(msg?: string): WebSocketError
+  static UNEXPECTED_RSV2(msg?: string): WebSocketError
+  static UNEXPECTED_RSV3(msg?: string): WebSocketError
+  static EXPECTED_MASK(msg?: string): WebSocketError
+  static EXPECTED_CONTINUATION(msg?: string): WebSocketError
+  static UNEXPECTED_CONTINUATION(msg?: string): WebSocketError
+  static UNEXPECTED_CONTROL(msg?: string): WebSocketError
+  static INVALID_ENCODING(msg?: string): WebSocketError
+  static INVALID_UPGRADE_HEADER(msg?: string): WebSocketError
+  static INVALID_VERSION_HEADER(msg?: string): WebSocketError
+  static INVALID_KEY_HEADER(msg?: string): WebSocketError
+  static INVALID_ACCEPT_HEADER(msg?: string): WebSocketError
+  static INVALID_OPCODE(msg?: string): WebSocketError
+  static INVALID_PAYLOAD_LENGTH(msg?: string): WebSocketError
+  static INCOMPLETE_FRAME(msg?: string, length?: number): WebSocketError
 }
 
 export = WebSocketError

package/lib/errors.js

@@ -16,22 +16,11 @@ module.exports = class WebSocketError extends Error {
   }
 
   static NETWORK_ERROR(msg, cause) {
-    return new WebSocketError(
-      msg,
-      'NETWORK_ERROR',
-      0,
-      WebSocketError.NETWORK_ERROR,
-      cause
-    )
+    return new WebSocketError(msg, 'NETWORK_ERROR', 0, WebSocketError.NETWORK_ERROR, cause)
   }
 
   static NOT_CONNECTED(msg = 'Socket is not connected') {
-    return new WebSocketError(
-      msg,
-      'NOT_CONNECTED',
-      0,
-      WebSocketError.NOT_CONNECTED
-    )
+    return new WebSocketError(msg, 'NOT_CONNECTED', 0, WebSocketError.NOT_CONNECTED)
   }
 
   static UNEXPECTED_RSV1(msg = 'RSV1 must be unset') {
@@ -168,4 +157,8 @@ module.exports = class WebSocketError extends Error {
       WebSocketError.INVALID_PAYLOAD_LENGTH
     )
   }
+
+  static INCOMPLETE_FRAME(msg = 'Incomplete frame', length = -1) {
+    return new WebSocketError(msg, 'INCOMPLETE_FRAME', length, WebSocketError.INCOMPLETE_FRAME)
+  }
 }

package/lib/frame.js

@@ -19,13 +19,7 @@ module.exports = exports = class Frame {
       payload = EMPTY
     }
 
-    const {
-      fin = true,
-      rsv1 = false,
-      rsv2 = false,
-      rsv3 = false,
-      mask = null
-    } = opts
+    const { fin = true, rsv1 = false, rsv2 = false, rsv3 = false, mask = null } = opts
 
     this.fin = fin
     this.rsv1 = rsv1
@@ -136,12 +130,13 @@ exports.encode = function encode(state, f) {
 }
 
 exports.decode = function decode(state) {
+  const s = state.start
   const b = state.buffer
 
-  let i = state.start
-  let n = b.length
+  let i = s
+  let n = b.byteLength
 
-  if (n < 2) return null
+  if (n < 2) throw errors.INCOMPLETE_FRAME()
 
   const view = new DataView(b.buffer, b.byteOffset, b.byteLength)
 
@@ -164,14 +159,14 @@ exports.decode = function decode(state) {
   n--
 
   if (length === 0x7e) {
-    if (n < 2) return null
+    if (n < 2) throw errors.INCOMPLETE_FRAME()
 
     length = view.getUint16(i, false)
 
     i += 2
     n -= 2
   } else if (length === 0x7f) {
-    if (n < 8) return null
+    if (n < 8) throw errors.INCOMPLETE_FRAME()
 
     const high = view.getUint32(i, false)
 
@@ -191,7 +186,7 @@ exports.decode = function decode(state) {
   let mask = null
 
   if (masked) {
-    if (n < 4) return null
+    if (n < 4) throw errors.INCOMPLETE_FRAME()
 
     mask = b.subarray(i, i + 4)
 
@@ -199,7 +194,9 @@ exports.decode = function decode(state) {
     n -= 4
   }
 
-  if (n < length) return null
+  if (n < length) {
+    throw errors.INCOMPLETE_FRAME('Incomplete frame', i - s + length)
+  }
 
   const payload = b.subarray(i, i + length)
 

package/lib/server.d.ts

@@ -7,9 +7,7 @@ import Buffer from 'bare-buffer'
 import WebSocket from './socket'
 import WebSocketError from './errors'
 
-interface WebSocketServerOptions
-  extends HTTPServerConnectionOptions,
-    HTTPSServerConnectionOptions {
+interface WebSocketServerOptions extends HTTPServerConnectionOptions, HTTPSServerConnectionOptions {
   secure?: boolean
 }
 
@@ -18,15 +16,14 @@ interface WebSocketServerEvents extends DuplexEvents {
   listening: []
 }
 
-interface WebSocketServer<
-  M extends WebSocketServerEvents = WebSocketServerEvents
-> extends EventEmitter<M> {
+interface WebSocketServer<M extends WebSocketServerEvents = WebSocketServerEvents>
+  extends EventEmitter<M> {
   readonly listening: boolean
 
   address(): TCPSocketAddress
-  close(cb?: (err: WebSocketError | null) => void): void
-  ref(): void
-  unref(): void
+  close(cb?: (err?: Error | null) => void): this
+  ref(): this
+  unref(): this
 }
 
 declare class WebSocketServer {
@@ -41,10 +38,7 @@ declare class WebSocketServer {
 declare namespace WebSocketServer {
   export { type WebSocketServerOptions, type WebSocketServerEvents }
 
-  export function handshake(
-    req: HTTPClientRequest,
-    cb: (err: WebSocketError | null) => void
-  ): void
+  export function handshake(req: HTTPClientRequest, cb: (err: WebSocketError | null) => void): void
 
   export function handshake(
     req: HTTPClientRequest,

package/lib/server.js

@@ -44,15 +44,21 @@ module.exports = exports = class WebSocketServer extends EventEmitter {
   }
 
   close(cb) {
-    return this._server.close(cb)
+    this._server.close(cb)
+
+    return this
   }
 
   ref() {
     this._server.ref()
+
+    return this
   }
 
   unref() {
     this._server.unref()
+
+    return this
   }
 
   _onlistening() {
@@ -80,12 +86,7 @@ module.exports = exports = class WebSocketServer extends EventEmitter {
 }
 
 // https://datatracker.ietf.org/doc/html/rfc6455#section-4.2
-exports.handshake = function handshake(
-  req,
-  socket = req.socket,
-  head = EMPTY,
-  cb
-) {
+exports.handshake = function handshake(req, socket = req.socket, head = EMPTY, cb) {
   if (typeof socket === 'function') {
     cb = socket
     socket = req.socket
@@ -111,11 +112,7 @@ exports.handshake = function handshake(
     return cb(errors.INVALID_KEY_HEADER())
   }
 
-  const digest = crypto
-    .createHash('sha1')
-    .update(key)
-    .update(GUID)
-    .digest('base64')
+  const digest = crypto.createHash('sha1').update(key).update(GUID).digest('base64')
 
   socket.write(
     'HTTP/1.1 101 Web Socket Protocol Handshake' +

package/lib/socket.d.ts

@@ -18,8 +18,7 @@ interface WebSocketEvents extends DuplexEvents {
   pong: [payload: unknown]
 }
 
-interface WebSocket<M extends WebSocketEvents = WebSocketEvents>
-  extends Duplex<M> {
+interface WebSocket<M extends WebSocketEvents = WebSocketEvents> extends Duplex<M> {
   ping(data: unknown): void
   pong(data: unknown): void
 }

package/lib/socket.js

@@ -24,8 +24,7 @@ module.exports = exports = class WebSocket extends Duplex {
 
       // For Node.js compatibility
       opts.host = opts.hostname || opts.host
-      opts.port =
-        typeof opts.port === 'string' ? parseInt(opts.port, 10) : opts.port
+      opts.port = typeof opts.port === 'string' ? parseInt(opts.port, 10) : opts.port
     }
 
     const { isServer = false, socket = null } = opts
@@ -40,7 +39,9 @@ module.exports = exports = class WebSocket extends Duplex {
     this._pendingOpen = null
     this._pendingWrite = null
 
-    this._buffer = null
+    this._buffer = []
+    this._buffered = 0
+    this._frame = -1
 
     if (socket !== null) this._attach(socket)
     else this._connect(opts)
@@ -51,9 +52,7 @@ module.exports = exports = class WebSocket extends Duplex {
 
     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) {
@@ -61,9 +60,7 @@ module.exports = exports = class WebSocket extends Duplex {
 
     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) {
@@ -101,29 +98,27 @@ module.exports = exports = class WebSocket extends Duplex {
   }
 
   _ondata(data) {
-    if (this._buffer === null) this._buffer = data
-    else this._buffer = Buffer.concat([this._buffer, data])
+    this._buffer.push(data)
+    this._buffered += data.byteLength
 
-    while (this._buffer !== null) {
-      const state = { start: 0, end: this._buffer.length, buffer: this._buffer }
+    while (this._frame === -1 || this._frame <= this._buffered) {
+      const buffer = this._buffer.length === 1 ? this._buffer[0] : Buffer.concat(this._buffer)
 
-      let frame
-      try {
-        frame = Frame.decode(state)
-      } catch (err) {
-        return this.destroy(err)
-      }
-
-      if (frame === null) return
+      this._buffer = [buffer]
 
-      this._buffer =
-        state.start === state.end ? null : this._buffer.subarray(state.start)
+      const state = { start: 0, end: buffer.length, buffer }
 
       try {
-        this._onframe(frame)
+        this._onframe(Frame.decode(state))
       } catch (err) {
-        return this.destroy(err)
+        if (err.code === 'INCOMPLETE_FRAME') this._frame = err.status
+        else this.destroy(err)
+        return
       }
+
+      this._buffered -= state.start
+      this._buffer = this._buffered > 0 ? [buffer.subarray(state.start)] : []
+      this._frame = -1
     }
   }
 
@@ -222,11 +217,9 @@ module.exports = exports = class WebSocket extends Duplex {
       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
@@ -260,11 +253,7 @@ exports.handshake = function handshake(req, cb) {
       return cb(errors.INVALID_UPGRADE_HEADER())
     }
 
-    const digest = crypto
-      .createHash('sha1')
-      .update(key)
-      .update(GUID)
-      .digest('base64')
+    const digest = crypto.createHash('sha1').update(key).update(GUID).digest('base64')
 
     if (res.headers['sec-websocket-accept'] !== digest) {
       return cb(errors.INVALID_ACCEPT_HEADER())

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-ws",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "WebSocket library for JavaScript",
   "exports": {
     ".": {
@@ -48,7 +48,7 @@
     "bare-url": "^2.1.3",
     "brittle": "^3.3.0",
     "prettier": "^3.4.1",
-    "prettier-config-standard": "^7.0.0"
+    "prettier-config-holepunch": "^2.0.0"
   },
   "peerDependencies": {
     "bare-buffer": "*",