@fails-components/webtransport 1.0.9 → 1.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fails-components/webtransport",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "A component to add webtransport support (server and client) to node.js using libquiche",
   "exports": {
     ".": {
@@ -12,7 +12,7 @@
     "node": ">=16.5"
   },
   "type": "module",
-  "types": "./dist/lib/index.d.ts",
+  "types": "./dist/lib/index.types.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 && npm run test:firefox:http2:polyfill && npm run test:firefox:http2:ponyfill && npm run test:webkit:http2:polyfill && npm run test:webkit:http2:ponyfill",
@@ -43,7 +43,7 @@
   "bugs": {
     "url": "https://github.com/fails-components/webtransport/issues"
   },
-  "homepage": "https://github.com/fails-components/webtransport/main/#readme",
+  "homepage": "https://github.com/fails-components/webtransport/tree/master/main#readme",
   "dependencies": {
     "@types/debug": "^4.1.7",
     "bindings": "^1.5.0",
@@ -83,6 +83,7 @@
   },
   "browser": {
     "./test/fixtures/webtransport.js": "./test/fixtures/webtransport.browser.js",
+    "./test/fixtures/quiche.js": "./test/fixtures/quiche.browser.js",
     "./lib/webstreams.js": "./lib/webstreams.browser.js"
   }
 }

package/readme.md

@@ -35,7 +35,7 @@ Note, that it is only partially implemented and also some http2 features require
 Use for the server side either `HttpServer` for http/2 and http/3 support (including WebTransport over WebSocket), Http3Server for http/3 only and Http2Server for http/2 only.
 For the client side pass the options `forceReliable`, `requireUnreliable` etc. to force/select a type of transport.
 
- **Note, that the http/2 webtransport protocol (not supported by any browser yet), is implemented without the support of receiving initial settings, which can cause a problem with the initial flow control of the WebTransport streams. This is a current limitation in node.js, but a patch to add support will soon be part of new node versions. Note, that for sending the required initial setting you need a very recent version (>=21.6.1) of node.js.** This limitation does not apply to the polyfill/ponyfill and the webtransport over websocket protocol.
+ **Note, that the http/2 webtransport protocol (not supported by any browser yet), requires support for sending and receiving initial a node version with support for receiving customSettings. Versions without support can cause a problem with the initial flow control of the WebTransport streams.  Note, that for sending and receiving the required initial setting you need a very recent version (>=21.6.1 sending >= 21.7.0 receiving) of node.js.** This limitation does not apply to the polyfill/ponyfill and the webtransport over websocket protocol.
 
  The current proposal for the WebTransport over WebSocket protocol can be found [here] (https://datatracker.ietf.org/doc/draft-richter-webtransport-websocket/).
 
@@ -126,6 +126,9 @@ The `WebTransportSession` should behave most like a WebTransport object on the b
 ### Using a client
 The `WebTransport` object for node or the `WebTransportPonyfill`,  `WebTransportPolyfill` objects for the browser, behave like the `WebTransport` client object for the browser with few additions and some missing features.
 
+As the http/3 package is loaded dynamically and the WebTransport object is created synchronously, you may want to make sure, that the modules are already loaded. You can do so, by waiting for the promise `quicheLoaded` exported by the package.
+
+
 ## Specification divergence
 
 This module implements parts of the [WebTransport spec](https://datatracker.ietf.org/doc/html/draft-vvv-webtransport-quic-00) but not all of it.

package/test/bidirectional-streams.spec.js

@@ -6,6 +6,7 @@ import { readStream } from './fixtures/read-stream.js'
 import { writeStream } from './fixtures/write-stream.js'
 import { readCertHash } from './fixtures/read-cert-hash.js'
 import WebTransport from './fixtures/webtransport.js'
+import { quicheLoaded } from './fixtures/quiche.js'
 import * as ui8 from 'uint8arrays'
 import {
   KNOWN_BYTES,
@@ -38,6 +39,17 @@ describe('bidirectional streams', function () {
     // @ts-ignore
     delete wtOptions.serverCertificateHashes
 
+  // @ts-ignore
+  beforeEach(async () => {
+    if (
+      process.env.USE_HTTP2 !== 'true' &&
+      process.env.USE_PONYFILL !== 'true' &&
+      process.env.USE_POLYFILL !== 'true'
+    ) {
+      await quicheLoaded
+    }
+  })
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {
@@ -116,4 +128,23 @@ describe('bidirectional streams', function () {
     expect(result).to.have.property('reason', '')
     expect(result).to.have.property('closeCode', 0)
   })
+
+  it('receives data from server and checks receiving stream fin', async () => {
+    // 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_fin_send`,
+      wtOptions
+    )
+    await client.ready
+
+    const bidiStream = await getReaderValue(client.incomingBidirectionalStreams)
+    const reader = bidiStream.readable.getReader()
+
+    while (true) {
+      const res = await reader.read()
+      if (res.done) {
+        break
+      }
+    }
+  })
 })

package/test/datagrams.spec.js

@@ -5,6 +5,7 @@ import { expect } from './fixtures/chai.js'
 import { readStream } from './fixtures/read-stream.js'
 import { readCertHash } from './fixtures/read-cert-hash.js'
 import { pTimeout } from './fixtures/p-timeout.js'
+import { quicheLoaded } from './fixtures/quiche.js'
 
 /**
  * @template T
@@ -32,6 +33,17 @@ describe('datagrams', function () {
     // @ts-ignore
     delete wtOptions.serverCertificateHashes
 
+  // @ts-ignore
+  beforeEach(async () => {
+    if (
+      process.env.USE_HTTP2 !== 'true' &&
+      process.env.USE_PONYFILL !== 'true' &&
+      process.env.USE_POLYFILL !== 'true'
+    ) {
+      await quicheLoaded
+    }
+  })
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {

package/test/fixtures/quiche.browser.js

@@ -0,0 +1,2 @@
+const quicheLoaded = Promise.resolve()
+export { quicheLoaded }

package/test/fixtures/quiche.js

@@ -0,0 +1 @@
+export { quicheLoaded } from '../../lib/index.node.js'

package/test/fixtures/server.js

@@ -110,6 +110,30 @@ export async function createServer() {
             }
           },
 
+          // echo server, initiated by local
+          async () => {
+            for await (const session of getReaderStream(
+              server.sessionStream('/bidirectional_server_fin_send')
+            )) {
+              try {
+                // adapted from issue of achingbrain
+                const stream = await session.createBidirectionalStream()
+
+                const writer = stream.writable.getWriter()
+
+                await writer.ready
+
+                writer.write(Uint8Array.from([0, 1, 2, 3])).catch((err) => {
+                  console.info('error writing to stream', err)
+                })
+
+                await writer.close()
+              } catch {
+                // in some tests the client closes the stream
+              }
+            }
+          },
+
           // echo datagrams, initiated by remote
           async () => {
             for await (const session of getReaderStream(

package/test/session.spec.js

@@ -3,6 +3,7 @@
 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'
 
 /**
  * @template T
@@ -38,6 +39,17 @@ describe('session', function () {
     // @ts-ignore
     delete wtOptions.serverCertificateHashes
 
+  // @ts-ignore
+  beforeEach(async () => {
+    if (
+      process.env.USE_HTTP2 !== 'true' &&
+      process.env.USE_PONYFILL !== 'true' &&
+      process.env.USE_POLYFILL !== 'true'
+    ) {
+      await quicheLoaded
+    }
+  })
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {
@@ -68,9 +80,7 @@ describe('session', function () {
 
     const result = await client.closed
     expect(result).to.have.property('closeCode', 7)
-    if (process.env.USE_HTTP2 !== 'true')
-      // unsupported for http2
-      expect(result).to.have.property('reason', 'this is the reason')
+    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 () => {

package/test/stream-limits.spec.js

@@ -3,6 +3,7 @@
 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'
 
 /**
  * @template T
@@ -44,6 +45,17 @@ describe('streamlimits', function () {
     // @ts-ignore
     delete wtOptions.serverCertificateHashes
 
+  // @ts-ignore
+  beforeEach(async () => {
+    if (
+      process.env.USE_HTTP2 !== 'true' &&
+      process.env.USE_PONYFILL !== 'true' &&
+      process.env.USE_POLYFILL !== 'true'
+    ) {
+      await quicheLoaded
+    }
+  })
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {

package/test/unidirectional-streams.spec.js

@@ -8,6 +8,7 @@ import { writeStream } from './fixtures/write-stream.js'
 import { readCertHash } from './fixtures/read-cert-hash.js'
 import * as ui8 from 'uint8arrays'
 import { KNOWN_BYTES, KNOWN_BYTES_LENGTH } from './fixtures/known-bytes.js'
+import { quicheLoaded } from './fixtures/quiche.js'
 
 describe('unidirectional streams', function () {
   /** @type {import('../lib/dom').WebTransport | undefined} */
@@ -29,6 +30,17 @@ describe('unidirectional streams', function () {
     // @ts-ignore
     delete wtOptions.serverCertificateHashes
 
+  // @ts-ignore
+  beforeEach(async () => {
+    if (
+      process.env.USE_HTTP2 !== 'true' &&
+      process.env.USE_PONYFILL !== 'true' &&
+      process.env.USE_POLYFILL !== 'true'
+    ) {
+      await quicheLoaded
+    }
+  })
+
   // @ts-ignore
   afterEach(async () => {
     if (client != null) {