@fails-components/webtransport 0.2.1 → 0.3.0

package/dist/test/fixtures/known-bytes.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Bytes send by tests
+ */
+export const KNOWN_BYTES: Uint8Array[];
+export const KNOWN_BYTES_LENGTH: number;
+//# sourceMappingURL=known-bytes.d.ts.map

package/dist/test/fixtures/known-bytes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"known-bytes.d.ts","sourceRoot":"","sources":["../../../test/fixtures/known-bytes.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,uCAMC;AAED,wCAGC"}

package/dist/test/fixtures/read-cert-hash.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @param {string} [certHash]
+ * @returns {Uint8Array}
+ */
+export function readCertHash(certHash?: string | undefined): Uint8Array;
+//# sourceMappingURL=read-cert-hash.d.ts.map

package/dist/test/fixtures/read-cert-hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-cert-hash.d.ts","sourceRoot":"","sources":["../../../test/fixtures/read-cert-hash.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH,6DAFa,UAAU,CAItB"}

package/dist/test/fixtures/read-stream.d.ts

@@ -1,3 +1,8 @@
+/// <reference types="node" />
+/**
+ * @template T
+ * @typedef {import('node:stream/web').ReadableStream<T>} ReadableStream<T>
+ */
 /**
  * Read a stream contents to the end and return it
  *
@@ -6,5 +11,9 @@
  * @param {number} [expected]
  * @returns
  */
-export function readStream<T>(readable: ReadableStream<T>, expected?: number | undefined): Promise<T[]>;
+export function readStream<T>(readable: import("stream/web").ReadableStream<T>, expected?: number | undefined): Promise<T[]>;
+/**
+ * <T>
+ */
+export type ReadableStream<T> = import('node:stream/web').ReadableStream<T>;
 //# sourceMappingURL=read-stream.d.ts.map

package/dist/test/fixtures/read-stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"read-stream.d.ts","sourceRoot":"","sources":["../../../test/fixtures/read-stream.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wGA8BC"}
+{"version":3,"file":"read-stream.d.ts","sourceRoot":"","sources":["../../../test/fixtures/read-stream.js"],"names":[],"mappings":";AAAA;;;GAGG;AAEH;;;;;;;GAOG;AACH,6HA8BC;;;;gCAzCY,OAAO,iBAAiB,EAAE,cAAc,CAAC,CAAC,CAAC"}

package/dist/test/fixtures/reader-value.d.ts

@@ -1,7 +1,22 @@
+/// <reference types="node" />
+/**
+ * @template T
+ * @typedef {import('node:stream/web').ReadableStream<T>} ReadableStream<T>
+ */
 /**
  * @template T
  * @param {ReadableStream<T>} readableStream
  * @returns {Promise<T>}
  */
-export function getReaderValue<T>(readableStream: ReadableStream<T>): Promise<T>;
+export function getReaderValue<T>(readableStream: import("stream/web").ReadableStream<T>): Promise<T>;
+/**
+ * @template T
+ * @param {ReadableStream<T>} readableStream
+ * @returns {AsyncGenerator<T>}
+ */
+export function getReaderStream<T>(readableStream: import("stream/web").ReadableStream<T>): AsyncGenerator<T, any, any>;
+/**
+ * <T>
+ */
+export type ReadableStream<T> = import('node:stream/web').ReadableStream<T>;
 //# sourceMappingURL=reader-value.d.ts.map

package/dist/test/fixtures/reader-value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reader-value.d.ts","sourceRoot":"","sources":["../../../test/fixtures/reader-value.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,iFAkBC"}
+{"version":3,"file":"reader-value.d.ts","sourceRoot":"","sources":["../../../test/fixtures/reader-value.js"],"names":[],"mappings":";AAAA;;;GAGG;AAEH;;;;GAIG;AACH,sGAkBC;AAED;;;;GAIG;AACH,wHAoBC;;;;gCArDY,OAAO,iBAAiB,EAAE,cAAc,CAAC,CAAC,CAAC"}

package/dist/test/fixtures/server.d.ts

@@ -2,9 +2,4 @@ export function createServer(): Promise<{
     server: Http3Server;
     certificate: import("./certificate.js").Certificate;
 }>;
-/**
- * @param {import('../../lib/server.js').Http3Server} server
- * @param {string} path
- */
-export function getServerSession(server: import('../../lib/server.js').Http3Server, path: string): Promise<import("../../lib/types.js").WebTransportSession>;
 //# sourceMappingURL=server.d.ts.map

package/dist/test/fixtures/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../test/fixtures/server.js"],"names":[],"mappings":"AAGA;;;GA6BC;AAED;;;GAGG;AACH,yCAHW,OAAO,qBAAqB,EAAE,WAAW,QACzC,MAAM,6DAqBhB"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../test/fixtures/server.js"],"names":[],"mappings":"AASA;;;GAkPC"}

package/dist/test/fixtures/webtransport.browser.d.ts

@@ -0,0 +1,3 @@
+declare const WebTransport: any;
+export default WebTransport;
+//# sourceMappingURL=webtransport.browser.d.ts.map

package/dist/test/fixtures/webtransport.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webtransport.browser.d.ts","sourceRoot":"","sources":["../../../test/fixtures/webtransport.browser.js"],"names":[],"mappings":""}

package/dist/test/fixtures/webtransport.d.ts

@@ -0,0 +1,3 @@
+export default WebTransport;
+import { WebTransport } from "../../lib/index.js";
+//# sourceMappingURL=webtransport.d.ts.map

package/dist/test/fixtures/webtransport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webtransport.d.ts","sourceRoot":"","sources":["../../../test/fixtures/webtransport.js"],"names":[],"mappings":""}

package/dist/test/fixtures/write-stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"write-stream.d.ts","sourceRoot":"","sources":["../../../test/fixtures/write-stream.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,uFAQC"}
+{"version":3,"file":"write-stream.d.ts","sourceRoot":"","sources":["../../../test/fixtures/write-stream.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,uFAeC"}

package/dist/test/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/test/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../test/index.js"],"names":[],"mappings":""}

package/dist/test/session.spec.d.ts

@@ -0,0 +1,5 @@
+/**
+ * <T>
+ */
+export type Deferred<T> = import('../lib/types').Deferred<T>;
+//# sourceMappingURL=session.spec.d.ts.map

package/dist/test/session.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.spec.d.ts","sourceRoot":"","sources":["../../test/session.spec.js"],"names":[],"mappings":";;;0BAQa,OAAO,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC"}

package/dist/test/unidirectional-streams.spec.d.ts

@@ -1,5 +1,2 @@
-/**
- * <T>
- */
-export type Deferred<T> = import('../lib/types').Deferred<T>;
+export {};
 //# sourceMappingURL=unidirectional-streams.spec.d.ts.map

package/dist/test/unidirectional-streams.spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unidirectional-streams.spec.d.ts","sourceRoot":"","sources":["../../test/unidirectional-streams.spec.js"],"names":[],"mappings":";;;0BAaa,OAAO,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"unidirectional-streams.spec.d.ts","sourceRoot":"","sources":["../../test/unidirectional-streams.spec.js"],"names":[],"mappings":""}

package/lib/client.js

@@ -1,7 +1,12 @@
 import { Http3WebTransport } from './transport.js'
+import { WebTransportError } from './error.js'
+import { logger } from './utils.js'
+
+const log = logger(`webtransport:http3client(${process.pid})`)
 
 /**
  * @typedef {import('./session').Http3WTSession} Http3WTSession
+ * @typedef {import('./types').Http3ClientInit} Http3ClientInit
  *
  * Http3Client events
  * @typedef {import('./types').Http3ClientEventHandler} Http3ClientEventHandler
@@ -15,7 +20,7 @@ import { Http3WebTransport } from './transport.js'
  */
 export class Http3Client extends Http3WebTransport {
   /**
-   * @param {*} args
+   * @param {Http3ClientInit} args
    */
   constructor(args) {
     super(args, 'client')
@@ -35,9 +40,14 @@ export class Http3Client extends Http3WebTransport {
     this.webtransportProm = null
     /** @type {{ resolve: (value?: any) => void, reject: (err?: Error) => void} | null | undefined} */
     this.quicconnectedProm = null
+
+    this._quicConnectTimeout = args.quicConnectTimeout ?? 8000
+    this._webTransportConnectTimeout = args.webTransportConnectTimeout ?? 2000
   }
 
   async handleConnection() {
+    this.createTransportInt()
+
     this.quicconnected = new Promise((resolve, reject) => {
       this.quicconnectedProm = { resolve, reject }
     })
@@ -45,26 +55,18 @@ export class Http3Client extends Http3WebTransport {
       this.webtransportProm = { resolve, reject }
     })
 
-    try {
-      setTimeout(() => {
-        if (this.quicconnectedProm) {
-          this.quicconnectedProm.reject(new Error('Timeout client connection'))
-          delete this.quicconnectedProm
-        }
-      }, 8000)
-      await this.quicconnected
-      // now create Webtransport session
-      setTimeout(() => {
-        if (this.webtransportProm) {
-          this.webtransportProm.reject(
-            new Error('Timeout webtransport support')
-          )
-          delete this.webtransportProm
-        }
-      }, 2000)
-    } catch (error) {
-      throw new Error('Cl:' + error)
-    }
+    const timeout = setTimeout(() => {
+      if (this.quicconnectedProm) {
+        log.error('quic connection timeout')
+        this.quicconnectedProm.reject(
+          new WebTransportError('Opening handshake failed.')
+        )
+        delete this.quicconnectedProm
+      }
+    }, this._quicConnectTimeout)
+
+    await this.quicconnected
+    clearTimeout(timeout)
   }
 
   /**
@@ -73,26 +75,36 @@ export class Http3Client extends Http3WebTransport {
    * @returns
    */
   async createWTSession(sessionobj, path) {
-    // TODO
-    try {
-      await this.webtransport // wait for webtransport support
-      // ok now we open the session
-      this.sessionobjint = sessionobj
-      this.transportInt.openWTSession(path)
-      console.log('wait for session')
-      // we wait for a new session
-      const sessobj = await this.sessionobj
-
-      delete this.sessionobj
-
-      return sessobj
-    } catch (error) {
-      throw new Error('createWTSession failed ' + error)
-    }
+    // now create Webtransport session
+    const timeout = setTimeout(() => {
+      if (this.webtransportProm) {
+        log.error('webtransport connection timeout')
+        this.webtransportProm.reject(
+          new WebTransportError('Opening handshake failed.')
+        )
+        delete this.webtransportProm
+      }
+    }, this._webTransportConnectTimeout)
+    await this.webtransport // wait for webtransport support
+    clearTimeout(timeout)
+
+    // ok now we open the session
+    this.sessionobjint = sessionobj
+    this.transportInt.openWTSession(path)
+
+    // we wait for a new session
+    const sessobj = await this.sessionobj
+
+    delete this.sessionobj
+
+    return sessobj
   }
 
   closeHookSession() {
-    this.transportInt.closeClient()
+    if (this.transportInt != null) {
+      this.transportInt.closeClient()
+    }
+
     this.stopped = true
   }
 
@@ -104,10 +116,11 @@ export class Http3Client extends Http3WebTransport {
       if (args.success) this.quicconnectedProm.resolve()
       else
         this.quicconnectedProm.reject(
-          new Error('Connecting quic client failed')
+          new WebTransportError('Opening handshake failed.')
         )
       delete this.quicconnectedProm
-    } else throw new Error('Client connected with no pending promise')
+    } else
+      throw new WebTransportError('Client connected with no pending promise')
   }
 
   /**
@@ -132,7 +145,7 @@ export class Http3Client extends Http3WebTransport {
       this.sessionProm.resolve(args.session)
       delete this.sessionProm
     } else {
-      throw new Error(
+      throw new WebTransportError(
         'Http3WTSessionVisitor no object session or nor sessionprom'
       )
     }
@@ -142,7 +155,8 @@ export class Http3Client extends Http3WebTransport {
    * @param {ClientConnectedEvent | ClientWebtransportSupportEvent | Http3WTSessionVisitorEvent} args
    */
   customCallback(args) {
-    // console.log('incoming callback custom client', args)
+    log('callback', args?.purpose)
+    log.trace(args)
     if (args.purpose) {
       switch (args.purpose) {
         case 'ClientConnected':
@@ -155,7 +169,7 @@ export class Http3Client extends Http3WebTransport {
           this.onHttp3WTSessionVisitor(args)
           break
         default: {
-          throw new Error('unknown purpose')
+          throw new WebTransportError('unknown purpose')
         }
       }
     }

package/lib/dom.ts

@@ -1,3 +1,5 @@
+import type { ReadableStream } from 'node:stream/web'
+
 // Types taken from https://www.w3.org/TR/webtransport
 // These can be removed when they are added to the default typescript types
 
@@ -20,6 +22,7 @@ export interface WebTransportStats {
   smoothedRtt: number
   rttVariation: number
   minRtt: number
+  estimatedSendRate: bigint
   datagrams: WebTransportDatagramStats
 }
 
@@ -38,10 +41,6 @@ export interface WebTransportDatagramDuplexStream {
   // outgoingHighWaterMark: number
 }
 
-export interface WebTransportBidirectionalStream {
-  readonly readable: WebTransportReceiveStream
-  readonly writable: WebTransportSendStream
-}
 
 export interface  WebTransportSendStreamStats {
   timestamp: number
@@ -64,6 +63,11 @@ export interface WebTransportReceiveStream extends ReadableStream<Uint8Array> {
   getStats: () => Promise<WebTransportReceiveStreamStats>
 }
 
+export interface WebTransportBidirectionalStream {
+  readonly readable: WebTransportReceiveStream
+  readonly writable: WebTransportSendStream
+}
+
 export interface WebTransportHash {
   algorithm: string
   value: BufferSource
@@ -73,6 +77,16 @@ export interface WebTransportOptions {
   allowPooling?: boolean
   requireUnreliable?: boolean
   serverCertificateHashes?: WebTransportHash[]
+
+  /**
+   * Nonstandard option - when a new connection is opened, how long to wait for the quic handshake to complete in ms before rejecting
+   */
+  quicConnectTimeout?: number
+
+   /**
+    * Nonstandard option - when a new connection is opened, how long to wait for the webtransport handshake to complete in ms before rejecting
+    */
+  webTransportConnectTimeout?: number
   congestionControl?: WebTransportCongestionControl
 }
 

package/lib/error.js

@@ -0,0 +1,10 @@
+export class WebTransportError extends Error {
+  /**
+   * @param {string} message
+   */
+  constructor(message) {
+    super(message)
+
+    this.name = this[Symbol.toStringTag] = 'WebTransportError'
+  }
+}

package/lib/event-loop.js

@@ -2,13 +2,16 @@ import { Http3WebTransport } from './transport.js'
 import { Http3WTStream } from './stream.js'
 import { Http3WTSession } from './session.js'
 import { wtrouter } from './native.js'
+import { logger } from './utils.js'
+
+const log = logger(`webtransport:event-loop(${process.pid})`)
 
 export class Http3EventLoop {
   /** @type {Http3EventLoop | null} */
   static globalLoop = null
 
   /**
-   * @param {*} [args]
+   * @param {{ quicheLogVerbose: any; } | undefined} [args]
    */
   constructor(args) {
     this.eventloopInt = new wtrouter.Http3EventLoop({
@@ -28,13 +31,13 @@ export class Http3EventLoop {
    * @param {*} [args]
    */
   startEventLoop(args) {
-    console.log('start GlobalEventLoop')
+    log('start GlobalEventLoop')
     this.eventloopInt.startEventLoop(args)
     this.loopGuardianTimer = setInterval(this.loopGuardian, 5000)
   }
 
   shutdownEventLoop() {
-    console.log('shutdown GlobalEventLoop')
+    log('shutdown GlobalEventLoop')
     Http3EventLoop.globalLoop = null
     clearInterval(this.loopGuardianTimer)
     this.eventloopInt.shutDownEventLoop()
@@ -54,7 +57,7 @@ export class Http3EventLoop {
   }
 
   static callback() {
-    console.log('final eventloop callback called')
+    log('final eventloop callback called')
   }
 
   /**
@@ -65,7 +68,7 @@ export class Http3EventLoop {
     if (!Http3EventLoop.globalLoop) {
       Http3EventLoop.globalLoop = new Http3EventLoop()
       Http3EventLoop.globalLoop.startEventLoop(args)
-      console.log('createGlobalEventLoop')
+      log('createGlobalEventLoop')
     }
     return Http3EventLoop.globalLoop
   }

package/lib/native.js

@@ -3,6 +3,9 @@ import { createRequire } from 'module'
 import * as path from 'path'
 import * as url from 'url'
 import { arch, platform } from 'node:process'
+import { logger } from './utils.js'
+
+const log = logger(`webtransport:native(${process.pid})`)
 
 const binplatform = platform + '_' + arch
 const require = createRequire(import.meta.url)
@@ -20,6 +23,6 @@ if (
   wtpath = buildpath + '/Debug/webtransport.node'
 }
 
-console.log('load webtransport binary:', wtpath)
+log('load webtransport binary:', wtpath)
 
 export const wtrouter = require(wtpath)

package/lib/server.js

@@ -2,8 +2,9 @@ import { Http3WebTransport } from './transport.js'
 import { ReadableStream } from 'node:stream/web'
 import { Http3WTSession } from './session.js'
 import { isIPv4 } from 'net'
-// @ts-ignore
-import { defer } from './utils.js'
+import { defer, logger } from './utils.js'
+
+const log = logger(`webtransport:http3server(${process.pid})`)
 
 /**
  * @typedef {import('./types').WebTransportSession} WebTransportSession
@@ -47,6 +48,7 @@ export class Http3Server extends Http3WebTransport {
   }
 
   startServer() {
+    this.createTransportInt()
     this.transportInt.startServer()
   }
 
@@ -86,7 +88,8 @@ export class Http3Server extends Http3WebTransport {
 
   /**
    * @param {string} path
-   * @param {any | undefined} [args=undefined]
+   * @param {object} [args]
+   * @param {boolean} [args.noAutoPaths]
    * @returns {ReadableStream<WebTransportSession>}
    */
   sessionStream(path, args) {
@@ -98,7 +101,9 @@ export class Http3Server extends Http3WebTransport {
         this.sessionController[path] = controller
       }
     })
-    if (!args || !args.noAutoPaths) this.transportInt.addPath(path)
+    if (!args || !args.noAutoPaths) {
+      this.transportInt.addPath(path)
+    }
     return this.sessionStreams[path]
   }
 
@@ -108,17 +113,19 @@ export class Http3Server extends Http3WebTransport {
   onSessionRequest(args) {
     if (args.promise && args.header) {
       if (!this.requestHandler) throw new Error('Request handler not set')
-      this.requestHandler({ header: args.header }).then(
-        (/** @type {any} */ result) => {
-          console.log('oSR', result)
+      this.requestHandler({ header: args.header })
+        .then((/** @type {any} */ result) => {
+          log('oSR', result)
           this.transportInt.finishSessionRequest({
             promise: args.promise,
             header: args.header,
             session: args.session,
             ...result
           })
-        }
-      )
+        })
+        .catch((/** @type {any} */ err) => {
+          log.error(err)
+        })
     } else throw new Error('onSessionRequest')
   }
 
@@ -183,7 +190,8 @@ export class Http3Server extends Http3WebTransport {
    * @param {Http3WTServerSessionVisitorEvent | ServerStatusEvent | ServerSessionRequestEvent} args
    */
   customCallback(args) {
-    // console.log('incoming callback server', args)
+    log('callback', args?.purpose)
+    log.trace(args)
     if (args.purpose) {
       switch (args.purpose) {
         case 'SessionRequest':