feat: port websocket tests to node test runner (nodejs#2553)

* feat: initial websocket convertion

* fix: events tests

* fix: handshake

* fix: ping pong

* feat; receive and send

* fix: websocket init

* fix: close

* fix: borp flag

* fix: diagnostic channel

* fix: lint

* fix: custom headers

* fix: fragments

package.json

@@ -83,7 +83,7 @@
     "test:tap": "tap test/*.js test/diagnostics-channel/*.js",
     "test:tdd": "tap test/*.js test/diagnostics-channel/*.js -w",
     "test:typescript": "tsd && tsc --skipLibCheck test/imports/undici-import.ts",
-    "test:websocket": "tap test/websocket/*.js",
+    "test:websocket": "borp --coverage -p \"test/websocket/*.js\"",
     "test:wpt": "node test/wpt/start-fetch.mjs && node test/wpt/start-FileAPI.mjs && node test/wpt/start-mimesniff.mjs && node test/wpt/start-xhr.mjs && node test/wpt/start-websockets.mjs",
     "coverage": "nyc --reporter=text --reporter=html npm run test",
     "coverage:ci": "nyc --reporter=lcov npm run test",

test/websocket/close.js

@@ -1,130 +1,131 @@
 'use strict'
 
-const { test } = require('tap')
+const { describe, test } = require('node:test')
+const assert = require('node:assert')
 const { WebSocketServer } = require('ws')
 const { WebSocket } = require('../..')
 
-test('Close', (t) => {
-  t.plan(6)
-
-  t.test('Close with code', (t) => {
-    t.plan(1)
-
-    const server = new WebSocketServer({ port: 0 })
-
-    server.on('connection', (ws) => {
-      ws.on('close', (code) => {
-        t.equal(code, 1000)
+describe('Close', () => {
+  test('Close with code', () => {
+    return new Promise((resolve) => {
+      const server = new WebSocketServer({ port: 0 })
+
+      server.on('connection', (ws) => {
+        ws.on('close', (code) => {
+          assert.equal(code, 1000)
+          server.close()
+          resolve()
+        })
       })
-    })
-
-    t.teardown(server.close.bind(server))
 
-    const ws = new WebSocket(`ws://localhost:${server.address().port}`)
-    ws.addEventListener('open', () => ws.close(1000))
+      const ws = new WebSocket(`ws://localhost:${server.address().port}`)
+      ws.addEventListener('open', () => ws.close(1000))
+    })
   })
 
-  t.test('Close with code and reason', (t) => {
-    t.plan(2)
-
-    const server = new WebSocketServer({ port: 0 })
-
-    server.on('connection', (ws) => {
-      ws.on('close', (code, reason) => {
-        t.equal(code, 1000)
-        t.same(reason, Buffer.from('Goodbye'))
+  test('Close with code and reason', () => {
+    return new Promise((resolve) => {
+      const server = new WebSocketServer({ port: 0 })
+
+      server.on('connection', (ws) => {
+        ws.on('close', (code, reason) => {
+          assert.equal(code, 1000)
+          assert.deepStrictEqual(reason, Buffer.from('Goodbye'))
+          server.close()
+          resolve()
+        })
       })
-    })
 
-    t.teardown(server.close.bind(server))
-
-    const ws = new WebSocket(`ws://localhost:${server.address().port}`)
-    ws.addEventListener('open', () => ws.close(1000, 'Goodbye'))
+      const ws = new WebSocket(`ws://localhost:${server.address().port}`)
+      ws.addEventListener('open', () => ws.close(1000, 'Goodbye'))
+    })
   })
 
-  t.test('Close with invalid code', (t) => {
-    t.plan(2)
-
+  test('Close with invalid code', () => {
     const server = new WebSocketServer({ port: 0 })
 
-    t.teardown(server.close.bind(server))
-
     const ws = new WebSocket(`ws://localhost:${server.address().port}`)
-    ws.addEventListener('open', () => {
-      t.throws(
-        () => ws.close(2999),
-        {
-          name: 'InvalidAccessError',
-          constructor: DOMException
-        }
-      )
-
-      t.throws(
-        () => ws.close(5000),
-        {
-          name: 'InvalidAccessError',
-          constructor: DOMException
-        }
-      )
-
-      ws.close()
+
+    return new Promise((resolve) => {
+      ws.addEventListener('open', () => {
+        assert.throws(
+          () => ws.close(2999),
+          {
+            name: 'InvalidAccessError',
+            constructor: DOMException
+          }
+        )
+
+        assert.throws(
+          () => ws.close(5000),
+          {
+            name: 'InvalidAccessError',
+            constructor: DOMException
+          }
+        )
+
+        ws.close()
+        server.close()
+        resolve()
+      })
     })
   })
 
-  t.test('Close with invalid reason', (t) => {
-    t.plan(1)
-
+  test('Close with invalid reason', () => {
     const server = new WebSocketServer({ port: 0 })
 
-    t.teardown(server.close.bind(server))
     const ws = new WebSocket(`ws://localhost:${server.address().port}`)
 
-    ws.addEventListener('open', () => {
-      t.throws(
-        () => ws.close(1000, 'a'.repeat(124)),
-        {
-          name: 'SyntaxError',
-          constructor: DOMException
-        }
-      )
-
-      ws.close(1000)
+    return new Promise((resolve) => {
+      ws.addEventListener('open', () => {
+        assert.throws(
+          () => ws.close(1000, 'a'.repeat(124)),
+          {
+            name: 'SyntaxError',
+            constructor: DOMException
+          }
+        )
+
+        ws.close(1000)
+        server.close()
+        resolve()
+      })
     })
   })
 
-  t.test('Close with no code or reason', (t) => {
-    t.plan(2)
-
+  test('Close with no code or reason', () => {
     const server = new WebSocketServer({ port: 0 })
 
-    server.on('connection', (ws) => {
-      ws.on('close', (code, reason) => {
-        t.equal(code, 1005)
-        t.same(reason, Buffer.alloc(0))
+    return new Promise((resolve) => {
+      server.on('connection', (ws) => {
+        ws.on('close', (code, reason) => {
+          assert.equal(code, 1005)
+          assert.deepStrictEqual(reason, Buffer.alloc(0))
+          server.close()
+          resolve()
+        })
       })
-    })
 
-    t.teardown(server.close.bind(server))
-
-    const ws = new WebSocket(`ws://localhost:${server.address().port}`)
-    ws.addEventListener('open', () => ws.close())
+      const ws = new WebSocket(`ws://localhost:${server.address().port}`)
+      ws.addEventListener('open', () => ws.close())
+    })
   })
 
-  t.test('Close with a 3000 status code', (t) => {
-    t.plan(2)
-
+  test('Close with a 3000 status code', () => {
     const server = new WebSocketServer({ port: 0 })
 
-    server.on('connection', (ws) => {
-      ws.on('close', (code, reason) => {
-        t.equal(code, 3000)
-        t.same(reason, Buffer.alloc(0))
+    return new Promise((resolve) => {
+      server.on('connection', (ws) => {
+        ws.on('close', (code, reason) => {
+          assert.equal(code, 3000)
+          assert.deepStrictEqual(reason, Buffer.alloc(0))
+          server.close()
+          resolve()
+        })
       })
-    })
-
-    t.teardown(server.close.bind(server))
 
-    const ws = new WebSocket(`ws://localhost:${server.address().port}`)
-    ws.addEventListener('open', () => ws.close(3000))
+      const ws = new WebSocket(`ws://localhost:${server.address().port}`)
+      ws.addEventListener('open', () => ws.close(3000))
+    })
   })
 })

test/websocket/constructor.js

@@ -1,48 +1,47 @@
 'use strict'
 
-const { test } = require('tap')
+const { test } = require('node:test')
+const assert = require('node:assert')
 const { WebSocket } = require('../..')
 
-test('Constructor', (t) => {
-  t.throws(
+test('Constructor', () => {
+  assert.throws(
     () => new WebSocket('abc'),
     {
       name: 'SyntaxError',
       constructor: DOMException
     }
   )
 
-  t.throws(
+  assert.throws(
     () => new WebSocket('wss://echo.websocket.events/#a'),
     {
       name: 'SyntaxError',
       constructor: DOMException
     }
   )
 
-  t.throws(
+  assert.throws(
     () => new WebSocket('wss://echo.websocket.events', ''),
     {
       name: 'SyntaxError',
       constructor: DOMException
     }
   )
 
-  t.throws(
+  assert.throws(
     () => new WebSocket('wss://echo.websocket.events', ['chat', 'chat']),
     {
       name: 'SyntaxError',
       constructor: DOMException
     }
   )
 
-  t.throws(
+  assert.throws(
     () => new WebSocket('wss://echo.websocket.events', ['<>@,;:\\"/[]?={}\t']),
     {
       name: 'SyntaxError',
       constructor: DOMException
     }
   )
-
-  t.end()
 })

test/websocket/custom-headers.js

@@ -1,30 +1,30 @@
 'use strict'
 
-const { test } = require('tap')
+const { test } = require('node:test')
 const assert = require('assert')
 const { Agent, WebSocket } = require('../..')
 
 test('Setting custom headers', (t) => {
-  t.plan(1)
-
   const headers = {
     'x-khafra-hello': 'hi',
     Authorization: 'Bearer base64orsomethingitreallydoesntmatter'
   }
 
-  class TestAgent extends Agent {
-    dispatch (options) {
-      t.match(options.headers, headers)
-
-      return false
+  return new Promise((resolve, reject) => {
+    class TestAgent extends Agent {
+      dispatch (options) {
+        assert.deepStrictEqual(options.headers['x-khafra-hello'], headers['x-khafra-hello'])
+        assert.deepStrictEqual(options.headers.Authorization, headers.Authorization)
+        resolve()
+        return false
+      }
     }
-  }
 
-  const ws = new WebSocket('wss://echo.websocket.events', {
-    headers,
-    dispatcher: new TestAgent()
-  })
+    const ws = new WebSocket('wss://echo.websocket.events', {
+      headers,
+      dispatcher: new TestAgent()
+    })
 
-  // We don't want to make a request, just ensure the headers are set.
-  ws.onclose = ws.onerror = ws.onmessage = assert.fail
+    ws.onclose = ws.onerror = ws.onmessage = reject
+  })
 })