@fails-components/webtransport 1.0.4 → 1.0.8

package/lib/stream.js

@@ -1,6 +1,7 @@
 import { ReadableStream, WritableStream } from './webstreams.js'
 import { logger } from './utils.js'
 import { WebTransportError } from './error.js'
+import { canByteStream } from './features.js'
 
 const pid = typeof process !== 'undefined' ? process.pid : 0
 const log = logger(`webtransport:http3wtstream(${pid})`)
@@ -60,48 +61,54 @@ export class HttpWTStream {
     this.pendingresRead = null
 
     if (this.bidirectional || this.incoming) {
+      const readableopts = {
+        start: (
+          /** @type {import("stream/web").ReadableByteStreamController} */ controller
+        ) => {
+          this.readableController = controller
+          this.objint.startReading()
+        },
+        pull: async (
+          /** @type {import("stream/web").ReadableByteStreamController} */ controller
+        ) => {
+          if (this.readableclosed) {
+            return Promise.resolve()
+          }
+
+          this.pendingoperationRead = new Promise((resolve, reject) => {
+            this.pendingresRead = resolve
+          })
+          this.objint.startReading()
+          await this.pendingoperationRead
+        },
+        cancel: (/** @type {{ code: number; }} */ reason) => {
+          /** @type {Promise<void>} */
+          const promise = new Promise((resolve, reject) => {
+            this.cancelres = resolve
+          })
+          let code = 0
+          if (reason && reason.code) {
+            if (reason.code < 0) code = 0
+            else if (reason.code > 255) code = 255
+            else code = reason.code
+          }
+          this.readableclosed = true
+          this.objint.stopSending(code)
+          return promise
+        },
+        type: 'bytes',
+        autoAllocateChunkSize: 4096 // lets take this as buffer size
+      }
+
+      if (!canByteStream) {
+        // @ts-ignore
+        delete readableopts.type
+      }
       /** @type {WebTransportReceiveStream} */
       // @ts-expect-error `getStats` property is missing from ReadableStream
       this.readable = new ReadableStream(
-        {
-          start: (
-            /** @type {import("stream/web").ReadableByteStreamController} */ controller
-          ) => {
-            this.readableController = controller
-            this.objint.startReading()
-          },
-          pull: async (
-            /** @type {import("stream/web").ReadableByteStreamController} */ controller
-          ) => {
-            if (this.readableclosed) {
-              return Promise.resolve()
-            }
-
-            this.pendingoperationRead = new Promise((resolve, reject) => {
-              this.pendingresRead = resolve
-            })
-            this.objint.startReading()
-            await this.pendingoperationRead
-          },
-          cancel: (/** @type {{ code: number; }} */ reason) => {
-            /** @type {Promise<void>} */
-            const promise = new Promise((resolve, reject) => {
-              this.cancelres = resolve
-            })
-            let code = 0
-            if (reason && reason.code) {
-              if (reason.code < 0) code = 0
-              else if (reason.code > 255) code = 255
-              else code = reason.code
-            }
-            this.readableclosed = true
-            this.objint.stopSending(code)
-            return promise
-          },
-          type: 'bytes',
-          autoAllocateChunkSize: 4096 // lets take this as buffer size
-        }
-        // TODO fix stretegy
+        // @ts-ignore
+        readableopts
       )
       this.readable.getStats = () => {
         return Promise.resolve({

package/lib/webtransport.browser.js

@@ -28,10 +28,16 @@ if (globalThis.WebTransport) {
   try {
     // @ts-ignore
     // eslint-disable-next-line no-undef
-    const transport = new WebTransport('https://example.org/test', {
+    const transport = new WebTransport('https://127.0.0.1:23333/test', {
       serverCertificateHashes: []
     })
-    transport.close()
+    transport.ready
+      .then(() => {
+        try {
+          transport.close()
+        } catch (error) {}
+      })
+      .catch(() => {})
   } catch (error) {
     // @ts-ignore
     if (error?.name === 'NotSupportedError') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fails-components/webtransport",
-  "version": "1.0.4",
+  "version": "1.0.8",
   "description": "A component to add webtransport support (server and client) to node.js using libquiche",
   "exports": {
     ".": {
@@ -15,15 +15,20 @@
   "types": "./dist/lib/index.d.ts",
   "scripts": {
     "start": "node test/echoserver.js",
-    "test": "npm run test:node && npm run test:node:http2 && npm run test:chromium && npm run test:chromium:http2:polyfill && npm run test:chromium:http2:ponyfill",
+    "test": "npm run test:node && npm run test:node:http2 && npm run test:chromium && npm run test:chromium:http2:polyfill && npm run test:chromium:http2:ponyfill && npm run test:firefox:http2:polyfill && npm run test:firefox:http2:ponyfill && npm run test:webkit:http2:polyfill && npm run test:webkit:http2:ponyfill",
     "test:node": "node test/index.js node http3",
     "test:node:http2": "node test/index.js node http2",
     "test:chromium": "node test/index.js chromium http3",
     "test:chromium:http2:polyfill": "node test/index.js chromium http2 polyfill",
     "test:chromium:http2:ponyfill": "node test/index.js chromium http2 ponyfill",
+    "test:firefox": "node test/index.js firefox http3",
+    "test:firefox:http2:polyfill": "node test/index.js firefox http2 polyfill",
+    "test:firefox:http2:ponyfill": "node test/index.js firefox http2 ponyfill",
+    "test:webkit": "node test/index.js webkit http3",
+    "test:webkit:http2:polyfill": "node test/index.js webkit http2 polyfill",
+    "test:webkit:http2:ponyfill": "node test/index.js webkit http2 ponyfill",
     "oldtest": "node old_test/test.js",
     "oldtesthttp2": "node old_test/test.js http2",
-    "types": "tsc",
     "lint": "eslint lib test old_test"
   },
   "repository": {

package/test/bidirectional-streams.spec.js

@@ -18,13 +18,26 @@ import {
  * @template T
  * @typedef {import('../lib/types').Deferred<T>} Deferred<T>
  */
-
 describe('bidirectional streams', function () {
   let forceReliable = false
   if (process.env.USE_HTTP2 === 'true') forceReliable = true
   /** @type {import('../lib/dom').WebTransport | undefined} */
   let client
 
+  const wtOptions = {
+    serverCertificateHashes: [
+      {
+        algorithm: 'sha-256',
+        value: readCertHash(process.env.CERT_HASH)
+      }
+    ],
+    // @ts-ignore
+    forceReliable
+  }
+  if (process.env.NO_CERT_HASHES === 'true')
+    // @ts-ignore
+    delete wtOptions.serverCertificateHashes
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {
@@ -37,16 +50,7 @@ describe('bidirectional streams', function () {
     // client context - connects to the server, opens a bidi stream, sends some data and reads the response
     client = new WebTransport(
       `${process.env.SERVER_URL}/bidirectional_client_initiated_echo`,
-      {
-        serverCertificateHashes: [
-          {
-            algorithm: 'sha-256',
-            value: readCertHash(process.env.CERT_HASH)
-          }
-        ],
-        // @ts-ignore
-        forceReliable
-      }
+      wtOptions
     )
     await client.ready
 
@@ -64,16 +68,7 @@ describe('bidirectional streams', function () {
     // client context - connects to the server, opens a bidi stream, sends some data and reads the response
     client = new WebTransport(
       `${process.env.SERVER_URL}/bidirectional_client_initiated_echo`,
-      {
-        serverCertificateHashes: [
-          {
-            algorithm: 'sha-256',
-            value: readCertHash(process.env.CERT_HASH)
-          }
-        ],
-        // @ts-ignore
-        forceReliable
-      }
+      wtOptions
     )
     await client.ready
 
@@ -101,16 +96,7 @@ describe('bidirectional streams', function () {
     // client context - waits for the server to open a bidi stream then pipes it back to them
     client = new WebTransport(
       `${process.env.SERVER_URL}/bidirectional_server_initiated_echo`,
-      {
-        serverCertificateHashes: [
-          {
-            algorithm: 'sha-256',
-            value: readCertHash(process.env.CERT_HASH)
-          }
-        ],
-        // @ts-ignore
-        forceReliable
-      }
+      wtOptions
     )
     await client.ready
 

package/test/datagrams.spec.js

@@ -17,6 +17,21 @@ describe('datagrams', function () {
   let forceReliable = false
   if (process.env.USE_HTTP2 === 'true') forceReliable = true
 
+  const wtOptions = {
+    serverCertificateHashes: [
+      {
+        algorithm: 'sha-256',
+        value: readCertHash(process.env.CERT_HASH)
+      }
+    ],
+    // @ts-ignore
+    forceReliable
+  }
+
+  if (process.env.NO_CERT_HASHES === 'true')
+    // @ts-ignore
+    delete wtOptions.serverCertificateHashes
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {
@@ -28,16 +43,7 @@ describe('datagrams', function () {
     // client context - connects to the server, sends some datagrams and reads the response
     client = new WebTransport(
       `${process.env.SERVER_URL}/datagrams_client_send`,
-      {
-        serverCertificateHashes: [
-          {
-            algorithm: 'sha-256',
-            value: readCertHash(process.env.CERT_HASH)
-          }
-        ],
-        // @ts-ignore
-        forceReliable
-      }
+      wtOptions
     )
     await client.ready
 
@@ -71,16 +77,7 @@ describe('datagrams', function () {
     // client context - pipes the server's datagrams back to them
     client = new WebTransport(
       `${process.env.SERVER_URL}/datagrams_server_send`,
-      {
-        serverCertificateHashes: [
-          {
-            algorithm: 'sha-256',
-            value: readCertHash(process.env.CERT_HASH)
-          }
-        ],
-        // @ts-ignore
-        forceReliable
-      }
+      wtOptions
     )
     await client.ready
 

package/test/fixtures/webtransport.browser.js

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

package/test/index.js

@@ -70,12 +70,18 @@ async function runTests(certificate, serverAddress) {
     })
 
     await tests
-  } else if (env === 'chromium') {
+  } else if (env === 'chromium' || env === 'firefox' || env === 'webkit') {
     command = 'playwright-test'
     const otheropts = []
-    if (polyfill || ponyfill)
+    if (polyfill || ponyfill || env === 'firefox')
       otheropts.push('--config', './test/pw-no-https-errors.json')
-    args = ['./test/*.spec.js', ...otheropts, ...process.argv.slice(slice)]
+    args = [
+      './test/*.spec.js',
+      '-b',
+      env /* the browser */,
+      ...otheropts,
+      ...process.argv.slice(slice)
+    ]
     const tests = execa(command, args, {
       env: {
         DEBUG_COLORS: process.env.CI ? '' : 'true',
@@ -83,7 +89,10 @@ async function runTests(certificate, serverAddress) {
         SERVER_URL: serverAddress,
         USE_HTTP2: http2 ? 'true' : 'false',
         USE_POLYFILL: polyfill ? 'true' : 'false',
-        USE_PONYFILL: ponyfill ? 'true' : 'false'
+        USE_PONYFILL: ponyfill ? 'true' : 'false',
+        NO_CERT_HASHES:
+          env === 'firefox' && !ponyfill && !polyfill ? 'true' : 'false',
+        BROWSER: env
       },
       stdio: ['inherit', 'inherit', 'inherit']
     })

package/test/session.spec.js

@@ -12,10 +12,32 @@ import { expect } from './fixtures/chai.js'
 describe('session', function () {
   let forceReliable = false
   if (process.env.USE_HTTP2 === 'true') forceReliable = true
+  const browser = process.env.BROWSER
+  const handshakemess =
+    browser !== 'firefox' ||
+    process.env.USE_POLYFILL === 'true' ||
+    process.env.USE_PONYFILL === 'true'
+      ? 'Opening handshake failed.'
+      : 'WebTransport connection rejected'
 
   /** @type {import('../lib/dom').WebTransport | undefined} */
   let client
 
+  const wtOptions = {
+    serverCertificateHashes: [
+      {
+        algorithm: 'sha-256',
+        value: readCertHash(process.env.CERT_HASH)
+      }
+    ],
+    // @ts-ignore
+    forceReliable
+  }
+
+  if (process.env.NO_CERT_HASHES === 'true')
+    // @ts-ignore
+    delete wtOptions.serverCertificateHashes
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {
@@ -25,16 +47,10 @@ describe('session', function () {
   })
 
   it('should detect session closure', async () => {
-    client = new WebTransport(`${process.env.SERVER_URL}/session_close`, {
-      serverCertificateHashes: [
-        {
-          algorithm: 'sha-256',
-          value: readCertHash(process.env.CERT_HASH)
-        }
-      ],
-      // @ts-ignore
-      forceReliable
-    })
+    client = new WebTransport(
+      `${process.env.SERVER_URL}/session_close`,
+      wtOptions
+    )
     await client.ready
 
     const result = await client.closed
@@ -46,16 +62,7 @@ describe('session', function () {
     // client context - connects to the server, sends some datagrams and reads the response
     client = new WebTransport(
       `${process.env.SERVER_URL}/session_close_with_reason`,
-      {
-        serverCertificateHashes: [
-          {
-            algorithm: 'sha-256',
-            value: readCertHash(process.env.CERT_HASH)
-          }
-        ],
-        // @ts-ignore
-        forceReliable
-      }
+      wtOptions
     )
     await client.ready
 
@@ -65,19 +72,12 @@ describe('session', function () {
       // unsupported for http2
       expect(result).to.have.property('reason', 'this is the reason')
   })
-
+  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`, {
-      serverCertificateHashes: [
-        {
-          algorithm: 'sha-256',
-          value: readCertHash(process.env.CERT_HASH)
-        }
-      ],
       quicConnectTimeout: 100,
       webTransportConnectTimeout: 100,
-      // @ts-ignore
-      forceReliable
+      ...wtOptions
     })
 
     const [closedResult, readyResult] = await Promise.all([
@@ -87,23 +87,17 @@ describe('session', function () {
 
     expect(closedResult)
       .to.be.a('WebTransportError')
-      .with.property('message', 'Opening handshake failed.')
+      .with.property('message', handshakemess)
     expect(readyResult)
       .to.be.a('WebTransportError')
-      .with.property('message', 'Opening handshake failed.')
+      .with.property('message', handshakemess)
   })
 
   it('should error when connecting to a path that does not exist', async () => {
-    client = new WebTransport(`${process.env.SERVER_URL}/non_existant`, {
-      serverCertificateHashes: [
-        {
-          algorithm: 'sha-256',
-          value: readCertHash(process.env.CERT_HASH)
-        }
-      ],
-      // @ts-ignore
-      forceReliable
-    })
+    client = new WebTransport(
+      `${process.env.SERVER_URL}/non_existant`,
+      wtOptions
+    )
 
     const [closedResult, readyResult] = await Promise.all([
       client.closed.catch((err) => err),
@@ -112,15 +106,16 @@ describe('session', function () {
 
     expect(closedResult)
       .to.be.a('WebTransportError')
-      .with.property('message', 'Opening handshake failed.')
+      .with.property('message', handshakemess)
     expect(readyResult)
       .to.be.a('WebTransportError')
-      .with.property('message', 'Opening handshake failed.')
+      .with.property('message', handshakemess)
   })
 
   if (
     process.env.USE_POLYFILL !== 'true' &&
-    process.env.USE_PONYFILL !== 'true'
+    process.env.USE_PONYFILL !== 'true' &&
+    wtOptions.serverCertificateHashes
   ) {
     // deactivated in polyfill case, no test necessary
     it('should error when connecting with a bad certificate', async () => {
@@ -142,10 +137,10 @@ describe('session', function () {
 
       expect(closedResult)
         .to.be.a('WebTransportError')
-        .with.property('message', 'Opening handshake failed.')
+        .with.property('message', handshakemess)
       expect(readyResult)
         .to.be.a('WebTransportError')
-        .with.property('message', 'Opening handshake failed.')
+        .with.property('message', handshakemess)
     })
 
     it('should error when connecting with the wrong certificate', async () => {
@@ -169,10 +164,10 @@ describe('session', function () {
 
       expect(closedResult)
         .to.be.a('WebTransportError')
-        .with.property('message', 'Opening handshake failed.')
+        .with.property('message', handshakemess)
       expect(readyResult)
         .to.be.a('WebTransportError')
-        .with.property('message', 'Opening handshake failed.')
+        .with.property('message', handshakemess)
     })
   }
 })

package/test/unidirectional-streams.spec.js

@@ -15,6 +15,20 @@ describe('unidirectional streams', function () {
   let forceReliable = false
   if (process.env.USE_HTTP2 === 'true') forceReliable = true
 
+  const wtOptions = {
+    serverCertificateHashes: [
+      {
+        algorithm: 'sha-256',
+        value: readCertHash(process.env.CERT_HASH)
+      }
+    ],
+    // @ts-ignore
+    forceReliable
+  }
+  if (process.env.NO_CERT_HASHES === 'true')
+    // @ts-ignore
+    delete wtOptions.serverCertificateHashes
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {
@@ -28,16 +42,7 @@ describe('unidirectional streams', function () {
     try {
       client = new WebTransport(
         `${process.env.SERVER_URL}/unidirectional_client_send`,
-        {
-          serverCertificateHashes: [
-            {
-              algorithm: 'sha-256',
-              value: readCertHash(process.env.CERT_HASH)
-            }
-          ],
-          // @ts-ignore
-          forceReliable
-        }
+        wtOptions
       )
       await client.ready
     } catch (error) {
@@ -62,16 +67,7 @@ describe('unidirectional streams', function () {
     // client context - waits for the server to open a bidi stream then pipes it back to them
     client = new WebTransport(
       `${process.env.SERVER_URL}/unidirectional_server_send`,
-      {
-        serverCertificateHashes: [
-          {
-            algorithm: 'sha-256',
-            value: readCertHash(process.env.CERT_HASH)
-          }
-        ],
-        // @ts-ignore
-        forceReliable
-      }
+      wtOptions
     )
     await client.ready
 
@@ -93,16 +89,7 @@ describe('unidirectional streams', function () {
     this.timeout(6000 + addpolyfill)
     client = new WebTransport(
       `${process.env.SERVER_URL}/unidirectional_server_delay_before_read`,
-      {
-        serverCertificateHashes: [
-          {
-            algorithm: 'sha-256',
-            value: readCertHash(process.env.CERT_HASH)
-          }
-        ],
-        // @ts-ignore
-        forceReliable
-      }
+      wtOptions
     )
     await client.ready
 

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "../",
+  },
+  "extends": "../tsconfig.base.json",
+  "include": [
+      "lib",
+      "test",
+      "../transports/http3-quiche/lib"
+  ],
+  "exclude": [
+    "test/testinone.js"
+  ]
+}