@libp2p/tcp 10.0.5 → 10.0.6-24fa1d5af

package/src/socket-to-conn.ts

@@ -1,11 +1,14 @@
-import { AbortError, InvalidParametersError, TimeoutError } from '@libp2p/interface'
+import { InvalidParametersError, TimeoutError } from '@libp2p/interface'
 import { ipPortToMultiaddr as toMultiaddr } from '@libp2p/utils/ip-port-to-multiaddr'
+import pDefer from 'p-defer'
+import { raceEvent } from 'race-event'
 import { duplex } from 'stream-to-it'
 import { CLOSE_TIMEOUT, SOCKET_TIMEOUT } from './constants.js'
 import { multiaddrToNetConfig } from './utils.js'
 import type { ComponentLogger, MultiaddrConnection, CounterGroup } from '@libp2p/interface'
 import type { AbortOptions, Multiaddr } from '@multiformats/multiaddr'
 import type { Socket } from 'net'
+import type { DeferredPromise } from 'p-defer'
 
 interface ToConnectionOptions {
   listeningAddr?: Multiaddr
@@ -16,6 +19,7 @@ interface ToConnectionOptions {
   metrics?: CounterGroup
   metricPrefix?: string
   logger: ComponentLogger
+  direction: 'inbound' | 'outbound'
 }
 
 /**
@@ -23,12 +27,15 @@ interface ToConnectionOptions {
  * https://github.com/libp2p/interface-transport#multiaddrconnection
  */
 export const toMultiaddrConnection = (socket: Socket, options: ToConnectionOptions): MultiaddrConnection => {
-  let closePromise: Promise<void> | null = null
+  let closePromise: DeferredPromise<void>
   const log = options.logger.forComponent('libp2p:tcp:socket')
+  const direction = options.direction
   const metrics = options.metrics
   const metricPrefix = options.metricPrefix ?? ''
   const inactivityTimeout = options.socketInactivityTimeout ?? SOCKET_TIMEOUT
   const closeTimeout = options.socketCloseTimeout ?? CLOSE_TIMEOUT
+  let timedout = false
+  let errored = false
 
   // Check if we are connected on a unix path
   if (options.listeningAddr?.getPath() != null) {
@@ -39,6 +46,19 @@ export const toMultiaddrConnection = (socket: Socket, options: ToConnectionOptio
     options.localAddr = options.remoteAddr
   }
 
+  // handle socket errors
+  socket.on('error', err => {
+    errored = true
+
+    if (!timedout) {
+      log.error('%s socket error - %e', direction, err)
+      metrics?.increment({ [`${metricPrefix}error`]: true })
+    }
+
+    socket.destroy()
+    maConn.timeline.close = Date.now()
+  })
+
   let remoteAddr: Multiaddr
 
   if (options.remoteAddr != null) {
@@ -59,37 +79,37 @@ export const toMultiaddrConnection = (socket: Socket, options: ToConnectionOptio
 
   // by default there is no timeout
   // https://nodejs.org/dist/latest-v16.x/docs/api/net.html#socketsettimeouttimeout-callback
-  socket.setTimeout(inactivityTimeout, () => {
-    log('%s socket read timeout', lOptsStr)
-    metrics?.increment({ [`${metricPrefix}timeout`]: true })
+  socket.setTimeout(inactivityTimeout)
 
-    // only destroy with an error if the remote has not sent the FIN message
-    let err: Error | undefined
-    if (socket.readable) {
-      err = new TimeoutError('Socket read timeout')
-    }
+  socket.once('timeout', () => {
+    timedout = true
+    log('%s %s socket read timeout', direction, lOptsStr)
+    metrics?.increment({ [`${metricPrefix}timeout`]: true })
 
     // if the socket times out due to inactivity we must manually close the connection
     // https://nodejs.org/dist/latest-v16.x/docs/api/net.html#event-timeout
-    socket.destroy(err)
+    socket.destroy(new TimeoutError())
+    maConn.timeline.close = Date.now()
   })
 
   socket.once('close', () => {
-    log('%s socket close', lOptsStr)
-    metrics?.increment({ [`${metricPrefix}close`]: true })
+    // record metric for clean exit
+    if (!timedout && !errored) {
+      log('%s %s socket close', direction, lOptsStr)
+      metrics?.increment({ [`${metricPrefix}close`]: true })
+    }
 
     // In instances where `close` was not explicitly called,
     // such as an iterable stream ending, ensure we have set the close
     // timeline
-    if (maConn.timeline.close == null) {
-      maConn.timeline.close = Date.now()
-    }
+    socket.destroy()
+    maConn.timeline.close = Date.now()
   })
 
   socket.once('end', () => {
     // the remote sent a FIN packet which means no more data will be sent
     // https://nodejs.org/dist/latest-v16.x/docs/api/net.html#event-end
-    log('%s socket end', lOptsStr)
+    log('%s %s socket end', direction, lOptsStr)
     metrics?.increment({ [`${metricPrefix}end`]: true })
   })
 
@@ -111,7 +131,7 @@ export const toMultiaddrConnection = (socket: Socket, options: ToConnectionOptio
           // If the source errored the socket will already have been destroyed by
           // duplex(). If the socket errored it will already be
           // destroyed. There's nothing to do here except log the error & return.
-          log.error('%s error in sink', lOptsStr, err)
+          log.error('%s %s error in sink - %e', direction, lOptsStr, err)
         }
       }
 
@@ -127,92 +147,67 @@ export const toMultiaddrConnection = (socket: Socket, options: ToConnectionOptio
     timeline: { open: Date.now() },
 
     async close (options: AbortOptions = {}) {
-      if (socket.destroyed) {
-        log('The %s socket is destroyed', lOptsStr)
+      if (socket.closed) {
+        log('the %s %s socket is already closed', direction, lOptsStr)
         return
       }
 
-      if (closePromise != null) {
-        log('The %s socket is closed or closing', lOptsStr)
-        return closePromise
-      }
-
-      if (options.signal == null) {
-        const signal = AbortSignal.timeout(closeTimeout)
-
-        options = {
-          ...options,
-          signal
-        }
+      if (socket.destroyed) {
+        log('the %s %s socket is already destroyed', direction, lOptsStr)
+        return
       }
 
-      const abortSignalListener = (): void => {
-        socket.destroy(new AbortError('Destroying socket after timeout'))
+      if (closePromise != null) {
+        return closePromise.promise
       }
 
-      options.signal?.addEventListener('abort', abortSignalListener)
-
       try {
-        log('%s closing socket', lOptsStr)
-        closePromise = new Promise<void>((resolve, reject) => {
-          socket.once('close', () => {
-            // socket completely closed
-            log('%s socket closed', lOptsStr)
+        closePromise = pDefer()
 
-            resolve()
-          })
-          socket.once('error', (err: Error) => {
-            log('%s socket error', lOptsStr, err)
-
-            // error closing socket
-            if (maConn.timeline.close == null) {
-              maConn.timeline.close = Date.now()
-            }
-            if (!socket.destroyed) {
-              reject(err)
-            }
-            // if socket is destroyed, 'closed' event will be emitted later to resolve the promise
-          })
+        // close writable end of socket
+        socket.end()
 
-          // shorten inactivity timeout
-          socket.setTimeout(closeTimeout)
+        // convert EventEmitter to EventTarget
+        const eventTarget = socketToEventTarget(socket)
 
-          // close writable end of the socket
-          socket.end()
+        // don't wait forever to close
+        const signal = options.signal ?? AbortSignal.timeout(closeTimeout)
 
-          if (socket.writableLength > 0) {
-            // there are outgoing bytes waiting to be sent
-            socket.once('drain', () => {
-              log('%s socket drained', lOptsStr)
+        // wait for any unsent data to be sent
+        if (socket.writableLength > 0) {
+          log('%s %s draining socket', direction, lOptsStr)
+          await raceEvent(eventTarget, 'drain', signal, {
+            errorEvent: 'error'
+          })
+          log('%s %s socket drained', direction, lOptsStr)
+        }
 
-              // all bytes have been sent we can destroy the socket (maybe) before the timeout
-              socket.destroy()
-            })
-          } else {
-            // nothing to send, destroy immediately, no need for the timeout
-            socket.destroy()
-          }
-        })
+        await Promise.all([
+          raceEvent(eventTarget, 'close', signal, {
+            errorEvent: 'error'
+          }),
 
-        await closePromise
+          // all bytes have been sent we can destroy the socket
+          socket.destroy()
+        ])
       } catch (err: any) {
         this.abort(err)
       } finally {
-        options.signal?.removeEventListener('abort', abortSignalListener)
+        closePromise.resolve()
       }
     },
 
     abort: (err: Error) => {
-      log('%s socket abort due to error', lOptsStr, err)
+      log('%s %s socket abort due to error - %e', direction, lOptsStr, err)
 
       // the abortSignalListener may already destroyed the socket with an error
-      if (!socket.destroyed) {
-        socket.destroy(err)
-      }
+      socket.destroy()
 
-      if (maConn.timeline.close == null) {
-        maConn.timeline.close = Date.now()
-      }
+      // closing a socket is always asynchronous (must wait for "close" event)
+      // but the tests expect this to be a synchronous operation so we have to
+      // set the close time here. the tests should be refactored to reflect
+      // reality.
+      maConn.timeline.close = Date.now()
     },
 
     log
@@ -220,3 +215,17 @@ export const toMultiaddrConnection = (socket: Socket, options: ToConnectionOptio
 
   return maConn
 }
+
+function socketToEventTarget (obj?: any): EventTarget {
+  const eventTarget = {
+    addEventListener: (type: any, cb: any) => {
+      obj.addListener(type, cb)
+    },
+    removeEventListener: (type: any, cb: any) => {
+      obj.removeListener(type, cb)
+    }
+  }
+
+  // @ts-expect-error partial implementation
+  return eventTarget
+}

package/src/tcp.ts

@@ -36,7 +36,7 @@ import { TCPListener } from './listener.js'
 import { toMultiaddrConnection } from './socket-to-conn.js'
 import { multiaddrToNetConfig } from './utils.js'
 import type { TCPComponents, TCPCreateListenerOptions, TCPDialEvents, TCPDialOptions, TCPMetrics, TCPOptions } from './index.js'
-import type { Logger, Connection, Transport, Listener } from '@libp2p/interface'
+import type { Logger, Connection, Transport, Listener, MultiaddrConnection } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
 import type { Socket, IpcSocketConnectOpts, TcpSocketConnectOpts } from 'net'
 
@@ -53,7 +53,11 @@ export class TCP implements Transport<TCPDialEvents> {
 
     if (components.metrics != null) {
       this.metrics = {
-        dialerEvents: components.metrics.registerCounterGroup('libp2p_tcp_dialer_events_total', {
+        events: components.metrics.registerCounterGroup('libp2p_tcp_dialer_events_total', {
+          label: 'event',
+          help: 'Total count of TCP dialer events by type'
+        }),
+        errors: components.metrics.registerCounterGroup('libp2p_tcp_dialer_errors_total', {
           label: 'event',
           help: 'Total count of TCP dialer events by type'
         })
@@ -76,23 +80,28 @@ export class TCP implements Transport<TCPDialEvents> {
     // options.signal destroys the socket before 'connect' event
     const socket = await this._connect(ma, options)
 
-    // Avoid uncaught errors caused by unstable connections
-    socket.on('error', err => {
-      this.log('socket error', err)
-    })
+    let maConn: MultiaddrConnection
 
-    const maConn = toMultiaddrConnection(socket, {
-      remoteAddr: ma,
-      socketInactivityTimeout: this.opts.outboundSocketInactivityTimeout,
-      socketCloseTimeout: this.opts.socketCloseTimeout,
-      metrics: this.metrics?.dialerEvents,
-      logger: this.components.logger
-    })
+    try {
+      maConn = toMultiaddrConnection(socket, {
+        remoteAddr: ma,
+        socketInactivityTimeout: this.opts.outboundSocketInactivityTimeout,
+        socketCloseTimeout: this.opts.socketCloseTimeout,
+        metrics: this.metrics?.events,
+        logger: this.components.logger,
+        direction: 'outbound'
+      })
+    } catch (err: any) {
+      this.metrics?.errors.increment({ outbound_to_connection: true })
+      socket.destroy(err)
+      throw err
+    }
 
     try {
       this.log('new outbound connection %s', maConn.remoteAddr)
       return await options.upgrader.upgradeOutbound(maConn, options)
     } catch (err: any) {
+      this.metrics?.errors.increment({ outbound_upgrade: true })
       this.log.error('error upgrading outbound connection', err)
       maConn.abort(err)
       throw err
@@ -103,6 +112,8 @@ export class TCP implements Transport<TCPDialEvents> {
     options.signal?.throwIfAborted()
     options.onProgress?.(new CustomProgressEvent('tcp:open-connection'))
 
+    let rawSocket: Socket
+
     return new Promise<Socket>((resolve, reject) => {
       const start = Date.now()
       const cOpts = multiaddrToNetConfig(ma, {
@@ -111,35 +122,34 @@ export class TCP implements Transport<TCPDialEvents> {
       }) as (IpcSocketConnectOpts & TcpSocketConnectOpts)
 
       this.log('dialing %a', ma)
-      const rawSocket = net.connect(cOpts)
+      rawSocket = net.connect(cOpts)
 
       const onError = (err: Error): void => {
+        this.log.error('dial to %a errored - %e', ma, err)
         const cOptsStr = cOpts.path ?? `${cOpts.host ?? ''}:${cOpts.port}`
         err.message = `connection error ${cOptsStr}: ${err.message}`
-        this.metrics?.dialerEvents.increment({ error: true })
-
+        this.metrics?.events.increment({ error: true })
         done(err)
       }
 
       const onTimeout = (): void => {
         this.log('connection timeout %a', ma)
-        this.metrics?.dialerEvents.increment({ timeout: true })
+        this.metrics?.events.increment({ timeout: true })
 
-        const err = new TimeoutError(`connection timeout after ${Date.now() - start}ms`)
+        const err = new TimeoutError(`Connection timeout after ${Date.now() - start}ms`)
         // Note: this will result in onError() being called
         rawSocket.emit('error', err)
       }
 
       const onConnect = (): void => {
         this.log('connection opened %a', ma)
-        this.metrics?.dialerEvents.increment({ connect: true })
+        this.metrics?.events.increment({ connect: true })
         done()
       }
 
       const onAbort = (): void => {
         this.log('connection aborted %a', ma)
-        this.metrics?.dialerEvents.increment({ abort: true })
-        rawSocket.destroy()
+        this.metrics?.events.increment({ abort: true })
         done(new AbortError())
       }
 
@@ -167,6 +177,10 @@ export class TCP implements Transport<TCPDialEvents> {
         options.signal.addEventListener('abort', onAbort)
       }
     })
+      .catch(err => {
+        rawSocket?.destroy()
+        throw err
+      })
   }
 
   /**

package/dist/typedoc-urls.json

@@ -1,19 +0,0 @@
-{
-  "CloseServerOnMaxConnectionsOpts": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.CloseServerOnMaxConnectionsOpts.html",
-  "TCPComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPComponents.html",
-  ".:TCPComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPComponents.html",
-  "TCPCreateListenerOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html",
-  ".:TCPCreateListenerOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPCreateListenerOptions.html",
-  "TCPDialOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPDialOptions.html",
-  ".:TCPDialOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPDialOptions.html",
-  "TCPMetrics": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPMetrics.html",
-  ".:TCPMetrics": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPMetrics.html",
-  "TCPOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPOptions.html",
-  ".:TCPOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPOptions.html",
-  "TCPSocketOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPSocketOptions.html",
-  ".:TCPSocketOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_tcp.TCPSocketOptions.html",
-  "TCPDialEvents": "https://libp2p.github.io/js-libp2p/types/_libp2p_tcp.TCPDialEvents.html",
-  ".:TCPDialEvents": "https://libp2p.github.io/js-libp2p/types/_libp2p_tcp.TCPDialEvents.html",
-  "tcp": "https://libp2p.github.io/js-libp2p/functions/_libp2p_tcp.tcp.html",
-  ".:tcp": "https://libp2p.github.io/js-libp2p/functions/_libp2p_tcp.tcp.html"
-}