fix: pass interface compliance tests (#15)

- Awaits connection close promise so we can close the libp2p version
- Extend AbstractStream to handle the (approx) 3k ways there are to close a stream
- Ensure closed streams are removed from the muxer
- Enable interface compliance tests
- Listen on wildcard addresses properly

Author: achingbrain

.github/workflows/CI.yml

@@ -123,8 +123,7 @@ jobs:
             target: x86_64-pc-windows-msvc
             architecture: x64
         node:
-          - '18'
-          - '22'
+          - 22
     runs-on: ${{ matrix.settings.host }}
     steps:
       - uses: actions/checkout@v4
@@ -157,8 +156,7 @@ jobs:
       fail-fast: false
       matrix:
         node:
-          - '18'
-          - '22'
+          - 22
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -173,12 +171,12 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: bindings-x86_64-unknown-linux-gnu
-          path: src 
+          path: src
       - name: List packages
         run: ls -R .
         shell: bash
       - name: Test bindings
-        run: docker run --rm -v $(pwd):/build -w /build node:${{ matrix.node }}-slim corepack enable && yarn run test
+        run: docker run --rm -v "$(pwd):/build" -w /build node:${{ matrix.node }}-slim corepack enable && yarn run test
   test-linux-x64-musl-binding:
     name: Test bindings on x86_64-unknown-linux-musl - node@${{ matrix.node }}
     needs:
@@ -187,8 +185,7 @@ jobs:
       fail-fast: false
       matrix:
         node:
-          - '18'
-          - '22'
+          - 22
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -223,7 +220,7 @@ jobs:
       fail-fast: false
       matrix:
         node:
-          - '22'
+          - 22
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -260,8 +257,7 @@ jobs:
       fail-fast: false
       matrix:
         node:
-          - '18'
-          - '22'
+          - 22
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -294,7 +290,11 @@ jobs:
     name: Publish
     runs-on: ubuntu-latest
     needs:
-      - build
+      - test-macOS-windows-binding
+      - test-linux-x64-gnu-binding
+      - test-linux-x64-musl-binding
+      - test-linux-aarch64-gnu-binding
+      - test-linux-aarch64-musl-binding
     steps:
       - uses: googleapis/release-please-action@v4
         id: release

package.json

@@ -40,6 +40,13 @@
     "url": "https://github.com/ChainSafe/js-libp2p-quic"
   },
   "homepage": "https://github.com/ChainSafe/js-libp2p-quic",
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "project": true,
+      "sourceType": "module"
+    }
+  },
   "scripts": {
     "artifacts": "napi artifacts",
     "build": "yarn build:ts",
@@ -66,7 +73,8 @@
     "@libp2p/interface-compliance-tests": "^6.3.2",
     "@libp2p/logger": "^5.0.1",
     "@napi-rs/cli": "^3.0.0-alpha.70",
-    "aegir": "^44.1.1"
+    "aegir": "^45.1.3",
+    "sinon-ts": "^2.0.0"
   },
   "packageManager": "[email protected]"
 }

rust/lib.rs

@@ -45,6 +45,11 @@ impl Server {
     Ok(Self { socket, endpoint })
   }
 
+  #[napi]
+  pub fn port(&self) -> u16 {
+    return self.endpoint.local_addr().unwrap().port();
+  }
+
   #[napi]
   pub async fn inbound_connection(&self) -> Result<Connection> {
     let incoming = match self.endpoint.accept().await {

src/connection.ts

@@ -1,20 +1,18 @@
 import { TypedEventEmitter } from '@libp2p/interface'
 import { multiaddr, type Multiaddr } from '@multiformats/multiaddr'
-import { Uint8ArrayList } from 'uint8arraylist'
-
+import { type Uint8ArrayList } from 'uint8arraylist'
+import type * as napi from './napi.js'
 import type { AbortOptions, ComponentLogger, CounterGroup, Direction, Logger, MultiaddrConnection, MultiaddrConnectionTimeline } from '@libp2p/interface'
 import type { Sink } from 'it-stream-types'
 
-import * as napi from './napi.js'
-
-type QuicConnectionInit = {
+interface QuicConnectionInit {
   connection: napi.Connection
   logger: ComponentLogger
   direction: Direction
   metrics?: CounterGroup
 }
 
-type QuicConnectionEvents = {
+interface QuicConnectionEvents {
   'close': CustomEvent
 }
 
@@ -26,35 +24,54 @@ export class QuicConnection extends TypedEventEmitter<QuicConnectionEvents> impl
   readonly metrics?: CounterGroup
 
   timeline: MultiaddrConnectionTimeline = {
-    open: Date.now(),
+    open: Date.now()
   }
-  source: AsyncGenerator<Uint8Array | Uint8ArrayList> = (async function* () {})()
-  sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList>> = async function* () {}
 
-  constructor(init: QuicConnectionInit) {
+  source: AsyncGenerator<Uint8Array | Uint8ArrayList> = (async function * () {})()
+  sink: Sink<AsyncGenerator<Uint8Array | Uint8ArrayList>> = async function * () {}
+
+  constructor (init: QuicConnectionInit) {
     super()
 
     this.#connection = init.connection
-    this.log = init.logger.forComponent('libp2p:quic:connection')
+    this.log = init.logger.forComponent(`libp2p:quic:connection:${this.#connection.id()}:${init.direction}`)
     this.remoteAddr = multiaddr(this.#connection.remoteMultiaddr())
     this.metrics = init.metrics
 
-    this.log('new', init.direction, this.#connection.id())
+    // close maconn when connection is closed by remote
+    this.#connection.closed().then(() => {
+      this.close()
+        .catch(err => {
+          this.abort(err)
+        })
+    }, (err) => {
+      this.abort(err)
+    })
   }
-  async close(options?: AbortOptions): Promise<void> {
+
+  async close (options?: AbortOptions): Promise<void> {
+    if (this.timeline.close != null) {
+      return
+    }
+
     this.#connection.abort()
 
     this.timeline.close = Date.now()
-    this.log('%s closed', this.#connection.id())
-    this.metrics?.increment({close: true})
+    this.log('closed')
+    this.metrics?.increment({ close: true })
     this.safeDispatchEvent('close')
   }
-  abort(err: Error): void {
+
+  abort (err: Error): void {
+    if (this.timeline.close != null) {
+      return
+    }
+
     this.#connection.abort()
 
     this.timeline.close = Date.now()
-    this.log('%s aborted', this.#connection.id())
-    this.metrics?.increment({abort: true})
+    this.log('aborted - %e', err)
+    this.metrics?.increment({ abort: true })
     this.safeDispatchEvent('close')
   }
 }

src/filter.ts

@@ -1,17 +1,17 @@
-import type { Multiaddr } from "@multiformats/multiaddr"
 import { QUICV1 } from '@multiformats/multiaddr-matcher'
+import type { Multiaddr } from '@multiformats/multiaddr'
 
 // p2p multi-address code
 export const CODE_P2P = 421
 export const CODE_CIRCUIT = 290
 export const CODE_UNIX = 400
 
-export function listenFilter(multiaddrs: Multiaddr[]): Multiaddr[] {
+export function listenFilter (multiaddrs: Multiaddr[]): Multiaddr[] {
   return multiaddrs.filter((ma) => {
     return QUICV1.exactMatch(ma)
   })
 }
 
-export function dialFilter(multiaddrs: Multiaddr[]): Multiaddr[] {
+export function dialFilter (multiaddrs: Multiaddr[]): Multiaddr[] {
   return listenFilter(multiaddrs)
 }

src/index.ts

@@ -27,11 +27,11 @@
  * ```
  */
 
-import type { Transport } from '@libp2p/interface'
 import { QuicTransport, type QuicComponents, type QuicOptions } from './transport.js'
+import type { Transport } from '@libp2p/interface'
 
-export function quic(options?: Partial<QuicOptions>): (components: QuicComponents) => Transport {
-  return (components) => new QuicTransport(components, {...defaultOptions, ...options})
+export function quic (options?: Partial<QuicOptions>): (components: QuicComponents) => Transport {
+  return (components) => new QuicTransport(components, { ...defaultOptions, ...options })
 }
 
 export const defaultOptions: QuicOptions = {
@@ -40,5 +40,5 @@ export const defaultOptions: QuicOptions = {
   keepAliveInterval: 5_000,
   maxConcurrentStreamLimit: 256,
   maxStreamData: 10_000_000,
-  maxConnectionData: 15_000_000, 
+  maxConnectionData: 15_000_000
 }