@fails-components/webtransport 1.0.11 → 1.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fails-components/webtransport",
-  "version": "1.0.11",
+  "version": "1.1.2",
   "description": "A component to add webtransport support (server and client) to node.js using libquiche",
   "exports": {
     ".": {
@@ -60,19 +60,19 @@
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "dirty-chai": "^2.0.1",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^7.2.0",
+    "eslint": "^9.3.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard": "^16.0.2",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "eslint-plugin-promise": "^4.3.1",
     "eslint-plugin-standard": "^4.1.0",
     "execa": "^6.1.0",
     "mocha": "^10.1.0",
     "node-forge": "^1.3.1",
     "playwright-test": "^12.3.4",
-    "prettier": "^2.4.1",
+    "prettier": "^3.2.5",
     "typescript": "^4.8.4",
     "uint8arrays": "^4.0.2"
   },

package/test/datagrams.spec.js

@@ -65,7 +65,6 @@ describe('datagrams', function () {
     // write datagrams until the server receives one and closes the connection
     // eslint-disable-next-line promise/catch-or-return
     Promise.resolve().then(async () => {
-      // eslint-disable-next-line no-unmodified-loop-condition
       while (!closed) {
         try {
           await writer.ready

package/test/fixtures/read-stream.js

@@ -1,15 +1,10 @@
-/**
- * @template T
- * @typedef {import('../../lib/webstreams').ReadableStream<T>} ReadableStream<T>
- */
-
 /**
  * Read a stream contents to the end and return it
  *
  * @template T
  * @param {ReadableStream<T>} readable
  * @param {number} [expected]
- * @returns
+ * @returns {T[]}
  */
 export async function readStream(readable, expected) {
   const reader = readable.getReader()
@@ -27,7 +22,6 @@ export async function readStream(readable, expected) {
       }
 
       if (value != null) {
-        // @ts-ignore
         outputlength += value.length
         output.push(value)
       }
@@ -42,3 +36,22 @@ export async function readStream(readable, expected) {
     reader.releaseLock()
   }
 }
+
+/**
+ * @param {ReadableStream<Uint8Array>} stream
+ * @returns {string}
+ */
+export async function readStringFromStream(stream) {
+  const decoder = new TextDecoder()
+  let output = ''
+
+  for (const buf of await readStream(stream)) {
+    output += decoder.decode(buf, {
+      stream: true
+    })
+  }
+
+  output += decoder.decode()
+
+  return output
+}

package/test/fixtures/reader-value.js

@@ -1,8 +1,3 @@
-/**
- * @template T
- * @typedef {import('../../lib/webstreams').ReadableStream<T>} ReadableStream<T>
- */
-
 /**
  * @template T
  * @param {ReadableStream<T>} readableStream

package/test/fixtures/server.js

@@ -55,6 +55,32 @@ export async function createServer() {
 
   server.ready
     .then(async () => {
+      server.setRequestCallback(async (args) => {
+        const url = args.header[':path']
+        const [path] = url.split('?')
+
+        if (server.sessionController[path] == null) {
+          return {
+            ...args,
+            path,
+            status: 404
+          }
+        }
+
+        return {
+          ...args,
+          path,
+          userData: {
+            search: url.substring(path.length)
+          },
+          header: {
+            ...args.header,
+            ':path': path
+          },
+          status: 200
+        }
+      })
+
       // set up listeners for the different server paths used by the tests
       console.log('server ready')
       await Promise.all(
@@ -174,7 +200,6 @@ export async function createServer() {
               // write datagrams until the client receives one and closes the connection
               // eslint-disable-next-line promise/catch-or-return
               Promise.resolve().then(async () => {
-                // eslint-disable-next-line no-unmodified-loop-condition
                 while (!closed) {
                   try {
                     await writer.ready
@@ -217,6 +242,7 @@ export async function createServer() {
                 }
                 await getReaderValue(session.incomingUnidirectionalStreams)
                 await session.close()
+                // eslint-disable-next-line no-unused-vars
               } catch (error) {
                 // do not crash server, if a problem occurs...
               }
@@ -236,6 +262,7 @@ export async function createServer() {
                   )
                 }
                 await session.close()
+                // eslint-disable-next-line no-unused-vars
               } catch (error) {
                 // do not crash server, if a problem occurs...
               }
@@ -265,6 +292,7 @@ export async function createServer() {
                 }
                 await getReaderValue(session.incomingBidirectionalStreams)
                 await session.close()
+                // eslint-disable-next-line no-unused-vars
               } catch (error) {
                 // do not crash server, if a problem occurs...
               }
@@ -284,6 +312,7 @@ export async function createServer() {
                   )
                 }
                 await session.close()
+                // eslint-disable-next-line no-unused-vars
               } catch (error) {
                 // do not crash server, if a problem occurs...
               }
@@ -310,6 +339,26 @@ export async function createServer() {
             }
           },
 
+          // support user data
+          async () => {
+            for await (const session of getReaderStream(
+              server.sessionStream('/session_with_userdata')
+            )) {
+              try {
+                const stream = await session.createUnidirectionalStream()
+                await writeStream(stream, [
+                  new TextEncoder().encode(JSON.stringify(session.userData))
+                ])
+                // session.close() // do not close it here, the stream is closed before a reader is attached on client side
+              } catch (err) {
+                session.close({
+                  closeCode: 1,
+                  reason: err.stack
+                })
+              }
+            }
+          },
+
           // send data over unidirectional stream, initiated by remote
           async () => {
             for await (const session of getReaderStream(
@@ -332,6 +381,7 @@ export async function createServer() {
                 } else {
                   session.close()
                 }
+                // eslint-disable-next-line no-unused-vars
               } catch (error) {
                 // in some tests the client closes the stream
               }

package/test/fixtures/webtransport.browser.js

@@ -5,7 +5,6 @@ import {
 
 /** @type {import('../../lib/dom').WebTransport} */
 // @ts-ignore
-// eslint-disable-next-line no-undef
 let webtransport = globalThis.WebTransport
 if (process.env.USE_POLYFILL === 'true') {
   // @ts-ignore
@@ -17,4 +16,4 @@ if (process.env.USE_PONYFILL === 'true') {
   webtransport = WebTransportPonyfill
 }
 
-export default webtransport // eslint-disable-line no-undef
+export default webtransport

package/test/index.js

@@ -7,6 +7,7 @@ import { execa } from 'execa'
 async function startServer() {
   let http2 = false
   if (process.argv[3] === 'http2') http2 = true
+  // eslint-disable-next-line no-unused-vars
   return new Promise((resolve, reject) => {
     let foundAddress = false
 

package/test/session.spec.js

@@ -4,6 +4,8 @@ import { readCertHash } from './fixtures/read-cert-hash.js'
 import WebTransport from './fixtures/webtransport.js'
 import { expect } from './fixtures/chai.js'
 import { quicheLoaded } from './fixtures/quiche.js'
+import { getReaderValue } from './fixtures/reader-value.js'
+import { readStringFromStream } from './fixtures/read-stream.js'
 
 /**
  * @template T
@@ -82,6 +84,20 @@ describe('session', function () {
     expect(result).to.have.property('closeCode', 7)
     expect(result).to.have.property('reason', 'this is the reason')
   })
+
+  it('should parse user data', async () => {
+    client = new WebTransport(
+      `${process.env.SERVER_URL}/session_with_userdata?foo=bar`,
+      wtOptions
+    )
+    await client.ready
+
+    const stream = await getReaderValue(client.incomingUnidirectionalStreams)
+    const string = await readStringFromStream(stream)
+    const userData = JSON.parse(string)
+    expect(userData).to.have.property('search', '?foo=bar')
+  })
+
   if (browser === 'firefox') this.timeout(31000) // really firefox?
   it('should error when connecting to a server that does not exist', async () => {
     client = new WebTransport(`https://127.0.0.1:39821`, {