bare-ws 1.2.1 → 1.3.1

package/lib/constants.js

@@ -9,7 +9,9 @@ exports.opcode = {
   CONTINUATION: 0x0,
   TEXT: 0x1,
   BINARY: 0x2,
-  CLOSE: 0x8
+  CLOSE: 0x8,
+  PING: 0x9,
+  PONG: 0xa
 }
 
 // https://datatracker.ietf.org/doc/html/rfc6455#section-7.4.1

package/lib/errors.js

@@ -15,6 +15,22 @@ module.exports = class WebSocketError extends Error {
     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)
   }

package/lib/frame.js

@@ -58,7 +58,7 @@ exports.preencode = function preencode (state, f) {
 
   if (length <= 0x7d) i++
   else {
-    if (length < 2 ** 16) i += 3
+    if (length <= 0xffff) i += 3
     else i += 9
   }
 
@@ -91,7 +91,7 @@ exports.encode = function encode (state, f) {
 
   if (length <= 0x7d) b[i++] |= length
   else {
-    if (length < 2 ** 16) {
+    if (length <= 0xffff) {
       b[i++] |= 0x7e
 
       v.setUint16(i, length, false)

package/lib/socket.js

@@ -12,7 +12,7 @@ module.exports = exports = class WebSocket extends Duplex {
   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,6 +21,10 @@ 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 {
@@ -28,7 +32,7 @@ module.exports = exports = class WebSocket extends Duplex {
       socket = null
     } = opts
 
-    super()
+    super({ eagerOpen: true })
 
     this._socket = null
     this._isServer = isServer
@@ -44,6 +48,22 @@ module.exports = exports = class WebSocket extends Duplex {
     else this._connect(opts)
   }
 
+  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())
+  }
+
+  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())
+  }
+
   _attach (socket) {
     this._socket = socket
 
@@ -85,31 +105,46 @@ module.exports = exports = class WebSocket extends Duplex {
     while (this._buffer !== null) {
       const state = { start: 0, end: this._buffer.length, buffer: this._buffer }
 
-      const frame = Frame.decode(state)
+      let frame
+      try {
+        frame = Frame.decode(state)
+      } catch (err) {
+        return this.destroy(err)
+      }
 
       if (frame === null) return
 
       this._buffer = state.start === state.end ? null : this._buffer.subarray(state.start)
 
-      this._onframe(frame)
+      try {
+        this._onframe(frame)
+      } catch (err) {
+        return this.destroy(err)
+      }
     }
   }
 
   _onframe (frame) {
+    if (frame.rsv1) throw errors.UNEXPECTED_RSV1()
+
+    if (frame.rsv2) throw errors.UNEXPECTED_RSV2()
+
+    if (frame.rsv3) throw errors.UNEXPECTED_RSV3()
+
     if (frame.payload.length > 0 && !frame.mask === this._isServer) {
-      return this.destroy(this._isServer ? errors.EXPECTED_MASK() : errors.UNEXPECTED_MASK())
+      throw this._isServer ? errors.EXPECTED_MASK() : errors.UNEXPECTED_MASK()
     }
 
     if (frame.fin === false) {
       if (this._fragments.push(frame) === 1) { // First frame
-        if (frame.opcode === opcode.CONTINUATION) return this.destroy(errors.UNEXPECTED_CONTINUATION())
+        if (frame.opcode === opcode.CONTINUATION) throw errors.UNEXPECTED_CONTINUATION()
 
-        if (frame.opcode >= opcode.CLOSE) return this.destroy(errors.UNEXPECTED_CONTROL())
+        if (frame.opcode >= opcode.CLOSE) throw errors.UNEXPECTED_CONTROL()
 
         return
       }
 
-      if (frame.opcode !== opcode.CONTINUATION) return this.destroy(errors.EXPECTED_CONTINUATION())
+      if (frame.opcode !== opcode.CONTINUATION) throw errors.EXPECTED_CONTINUATION()
 
       return
     }
@@ -120,8 +155,17 @@ module.exports = exports = class WebSocket extends Duplex {
         this.end()
         return
 
+      case opcode.PING:
+        this.pong(frame.payload)
+        this.emit('ping', frame.payload)
+        return
+
+      case opcode.PONG:
+        this.emit('pong', frame.payload)
+        return
+
       case opcode.CONTINUATION: {
-        if (this._fragments.length === 0) return this.destroy(errors.UNEXPECTED_CONTINUATION())
+        if (this._fragments.length === 0) throw errors.UNEXPECTED_CONTINUATION()
 
         frame.opcode = this._fragments[0].opcode
 
@@ -137,7 +181,7 @@ module.exports = exports = class WebSocket extends Duplex {
       }
 
       default:
-        if (this._fragments.length > 0) return this.destroy(errors.EXPECTED_CONTINUATION())
+        if (this._fragments.length > 0) throw errors.EXPECTED_CONTINUATION()
     }
 
     switch (frame.opcode) {
@@ -147,7 +191,7 @@ module.exports = exports = class WebSocket extends Duplex {
         break
 
       default:
-        this.destroy(errors.INVALID_OPCODE())
+        throw errors.INVALID_OPCODE()
     }
   }
 
@@ -230,3 +274,15 @@ function defaultPort (url) {
 
   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.2.1",
+  "version": "1.3.1",
   "description": "WebSocket library for JavaScript",
   "exports": {
     ".": "./index.js",
@@ -28,8 +28,8 @@
   "dependencies": {
     "bare-crypto": "^1.2.0",
     "bare-events": "^2.3.1",
-    "bare-http1": "^3.5.2",
-    "bare-https": "^1.1.0",
+    "bare-http1": "^3.8.0",
+    "bare-https": "^1.3.0",
     "bare-stream": "^2.1.2"
   },
   "devDependencies": {