@fails-components/webtransport 1.1.2 → 1.1.4

package/old_test/echoserver.js

@@ -5,7 +5,7 @@
 import { Http3Server } from '../lib/index.js'
 import { runEchoServer } from './testsuite.js'
 import { existsSync, readFileSync, writeFile } from 'node:fs'
-import { generateWebTransportCertificate } from '../test/fixtures/certificate.js'
+import { generateWebTransportCertificate } from '../../test/fixtures/certificate.js'
 
 let certificate = null
 

package/old_test/test.js

@@ -4,7 +4,7 @@
 
 // this file runs various tests
 
-import { generateWebTransportCertificate } from '../test/fixtures/certificate.js'
+import { generateWebTransportCertificate } from '../../test/fixtures/certificate.js'
 import {
   Http3Server,
   Http2Server,

package/package.json

@@ -1,11 +1,17 @@
 {
   "name": "@fails-components/webtransport",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "A component to add webtransport support (server and client) to node.js using libquiche",
   "exports": {
     ".": {
-      "node": "./lib/index.node.js",
-      "browser": "./lib/index.browser.js"
+      "node": {
+        "types": "./dist/lib/index.node.d.ts",
+        "import": "./lib/index.node.js"
+      },
+      "browser": {
+        "types": "./dist/lib/index.browser.d.ts",
+        "import": "./lib/index.browser.js"
+      }
     }
   },
   "engines": {
@@ -15,21 +21,9 @@
   "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",
-    "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",
-    "lint": "eslint lib test old_test"
+    "lint": "eslint lib old_test"
   },
   "repository": {
     "type": "git",
@@ -57,9 +51,6 @@
     "@types/dirty-chai": "^2.0.2",
     "@types/mocha": "^10.0.0",
     "@types/node": "^18.15.3",
-    "chai": "^4.3.6",
-    "chai-as-promised": "^7.1.1",
-    "dirty-chai": "^2.0.1",
     "eslint": "^9.3.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard": "^16.0.2",
@@ -68,10 +59,6 @@
     "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": "^3.2.5",
     "typescript": "^4.8.4",
     "uint8arrays": "^4.0.2"
@@ -82,8 +69,6 @@
     ]
   },
   "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

@@ -72,8 +72,8 @@ The package `webtransport-transport-http3-quiche` provides prebuild binaries for
 Other platforms may be possible via cross-compiling in the GitHub actions, if someone needs this, PRs are welcome.
 
 Of course, you can also build the binary on your system.
-If you are running the compiling install as root, you need to use `--`unsafe-perm` as a flag.
-Installing the package without prebuild requires a full building environment including clang-9, perl6, python, golang,  `ninja-build, `and `icu``.` See the `Dockerfile` or `Dockerfile.development` for required Debian packages.
+If you are running the compiling install as root, you need to use `--unsafe-perm` as a flag.
+Installing the package without prebuild requires a full building environment including `clang-9`, `perl6`, `python`, `golang`,  `ninja-build`, and `icu`. See the `Dockerfile` or `Dockerfile.development` for required Debian packages.
 This should work for Windows, Linux and Mac OS X.
 (You may want to check out the building dependencies (especially for Windows) for BoringSSl, zlib, abseil on their respective websites).
 

package/test/bidirectional-streams.spec.js

@@ -1,150 +0,0 @@
-/* eslint-env mocha */
-
-import { getReaderValue } from './fixtures/reader-value.js'
-import { expect } from './fixtures/chai.js'
-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,
-  KNOWN_BYTES_LENGTH,
-  KNOWN_BYTES_LONG,
-  KNOWN_BYTES_LONG_LENGTH
-} from './fixtures/known-bytes.js'
-
-/**
- * @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
-  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) {
-      client.close()
-      client = undefined
-    }
-  })
-
-  it('sends and receives data over an outgoing bidirectional stream', async () => {
-    // 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`,
-      wtOptions
-    )
-    await client.ready
-
-    const stream = await client.createBidirectionalStream()
-    await writeStream(stream.writable, KNOWN_BYTES)
-
-    const output = await readStream(stream.readable, KNOWN_BYTES_LENGTH)
-    expect(ui8.concat(KNOWN_BYTES)).to.deep.equal(
-      ui8.concat(output),
-      'Did not receive the same bytes we sent'
-    )
-  })
-
-  it('sends and receives data over an outgoing bidirectional stream with big buffers', async () => {
-    // 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`,
-      wtOptions
-    )
-    await client.ready
-
-    const stream = await client.createBidirectionalStream()
-    await writeStream(stream.writable, KNOWN_BYTES_LONG)
-
-    const output = await readStream(stream.readable, KNOWN_BYTES_LONG_LENGTH)
-    const send = ui8.concat(KNOWN_BYTES_LONG)
-    const received = ui8.concat(output)
-    let failure = 0
-    for (let i = 0; i < Math.max(send.byteLength, received.byteLength); i++) {
-      if (send[i] !== received[i] && failure < 100) {
-        console.log('d: ', i, ' ,', send[i], ', ', received[i])
-        failure++
-      }
-    }
-
-    expect(ui8.concat(KNOWN_BYTES_LONG)).to.deep.equal(
-      ui8.concat(output),
-      'Did not receive the same bytes we sent'
-    )
-  })
-
-  it('sends and receives data over an incoming bidirectional stream', 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_initiated_echo`,
-      wtOptions
-    )
-    await client.ready
-
-    const bidiStream = await getReaderValue(client.incomingBidirectionalStreams)
-
-    // redirect input to output
-    try {
-      await bidiStream.readable.pipeTo(bidiStream.writable)
-    } catch (error) {
-      console.log('Pipe to error (ignore)', error) // Actually all you can get is, that the fin is catched
-    }
-
-    // the remote will close the session
-    const result = await client.closed
-
-    // should receive the default close info
-    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

@@ -1,104 +0,0 @@
-/* eslint-env mocha */
-
-import WebTransport from './fixtures/webtransport.js'
-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
- * @typedef {import('../lib/types').Deferred<T>} Deferred<T>
- */
-
-describe('datagrams', function () {
-  /** @type {import('../lib/dom').WebTransport | undefined} */
-  let client
-  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
-  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) {
-      client.close()
-      client = undefined
-    }
-  })
-  it('client sends datagrams to the server', async () => {
-    // client context - connects to the server, sends some datagrams and reads the response
-    client = new WebTransport(
-      `${process.env.SERVER_URL}/datagrams_client_send`,
-      wtOptions
-    )
-    await client.ready
-
-    const writer = client.datagrams.writable.getWriter()
-    let closed = false
-
-    // write datagrams until the server receives one and closes the connection
-    // eslint-disable-next-line promise/catch-or-return
-    Promise.resolve().then(async () => {
-      while (!closed) {
-        try {
-          await writer.ready
-          await writer.write(Uint8Array.from([0, 1, 2, 3, 4]))
-          await new Promise((resolve) => setTimeout(resolve, 100))
-        } catch {
-          // the session can be closed while we are writing
-        }
-      }
-    })
-
-    const result = await client.closed
-    closed = true
-
-    // should receive the default close info
-    expect(result).to.have.property('reason', '')
-    expect(result).to.have.property('closeCode', 0)
-  })
-
-  it('receives datagrams from the server', async () => {
-    // client context - pipes the server's datagrams back to them
-    client = new WebTransport(
-      `${process.env.SERVER_URL}/datagrams_server_send`,
-      wtOptions
-    )
-    await client.ready
-
-    // datagram transport is unreliable, at least one message should make it through
-    const expected = 1
-
-    const received = await pTimeout(
-      readStream(client.datagrams.readable, expected),
-      1000
-    )
-    expect(received).to.have.lengthOf(expected)
-  })
-})