@libp2p/webrtc 5.2.24-8484de8a2 → 5.2.24-9a9b11fd4

package/src/stream.ts

@@ -1,11 +1,13 @@
-import { StreamStateError } from '@libp2p/interface'
+import { StreamResetError, StreamStateError } from '@libp2p/interface'
 import { AbstractStream } from '@libp2p/utils'
 import * as lengthPrefixed from 'it-length-prefixed'
 import { pushable } from 'it-pushable'
+import { pEvent } from 'p-event'
 import { raceSignal } from 'race-signal'
 import { Uint8ArrayList } from 'uint8arraylist'
-import { MAX_BUFFERED_AMOUNT, MAX_MESSAGE_SIZE, PROTOBUF_OVERHEAD } from './constants.js'
+import { DEFAULT_FIN_ACK_TIMEOUT, MAX_BUFFERED_AMOUNT, MAX_MESSAGE_SIZE, PROTOBUF_OVERHEAD } from './constants.js'
 import { Message } from './private-to-public/pb/message.js'
+import { isFirefox } from './util.js'
 import type { DataChannelOptions } from './index.js'
 import type { AbortOptions, MessageStreamDirection, Logger } from '@libp2p/interface'
 import type { AbstractStreamInit, SendResult } from '@libp2p/utils'
@@ -35,7 +37,8 @@ export class WebRTCStream extends AbstractStream {
    */
   private readonly incomingData: Pushable<Uint8Array>
   private readonly maxBufferedAmount: number
-  private readonly receivedFinAck: PromiseWithResolvers<void>
+  private receivedFinAck?: PromiseWithResolvers<void>
+  private finAckTimeout: number
 
   constructor (init: WebRTCStreamInit) {
     super({
@@ -47,44 +50,26 @@ export class WebRTCStream extends AbstractStream {
     this.channel.binaryType = 'arraybuffer'
     this.incomingData = pushable<Uint8Array>()
     this.maxBufferedAmount = init.maxBufferedAmount ?? MAX_BUFFERED_AMOUNT
-    this.receivedFinAck = Promise.withResolvers()
-
-    // set up initial state
-    switch (this.channel.readyState) {
-      case 'open':
-        break
-
-      case 'closed':
-      case 'closing':
-        if (this.timeline.close === undefined || this.timeline.close === 0) {
-          this.timeline.close = Date.now()
-        }
-        break
-      case 'connecting':
-        // noop
-        break
-
-      default:
-        this.log.error('unknown datachannel state %s', this.channel.readyState)
-        throw new StreamStateError('Unknown datachannel state')
-    }
+    this.finAckTimeout = init.finAckTimeout ?? DEFAULT_FIN_ACK_TIMEOUT
 
     // handle RTCDataChannel events
-    this.channel.onclose = (_evt) => {
-      this.log.trace('received onclose event')
+    this.channel.onclose = () => {
+      this.log.trace('received datachannel close event')
 
       this.onRemoteCloseWrite()
       this.onTransportClosed()
     }
 
     this.channel.onerror = (evt) => {
-      this.log.trace('received onerror event')
-
       const err = (evt as RTCErrorEvent).error
+
+      this.log.trace('received datachannel error event - %e', err)
+
       this.abort(err)
     }
 
     this.channel.onmessage = async (event: MessageEvent<ArrayBuffer>) => {
+      this.log('incoming message %d bytes', event.data.byteLength)
       const { data } = event
 
       if (data === null || data.byteLength === 0) {
@@ -96,32 +81,49 @@ export class WebRTCStream extends AbstractStream {
 
     // dispatch drain event when the buffered amount drops to zero
     this.channel.bufferedAmountLowThreshold = 0
+
     this.channel.onbufferedamountlow = () => {
-      this.safeDispatchEvent('drain')
+      if (this.writableNeedsDrain) {
+        this.safeDispatchEvent('drain')
+      }
     }
 
-    const self = this
+    if (this.channel.readyState !== 'open') {
+      this.log('channel ready state is "%s" and not "open", waiting for "open" event before sending data', this.channel.readyState)
+      pEvent(this.channel, 'open', {
+        rejectionEvents: [
+          'close',
+          'error'
+        ]
+      })
+        .then(() => {
+          this.log('channel ready state is now "%s", dispatching drain', this.channel.readyState)
+          this.safeDispatchEvent('drain')
+        })
+        .catch(err => {
+          this.abort(err.error ?? err)
+        })
+    }
 
     // pipe framed protobuf messages through a length prefixed decoder, and
     // surface data from the `Message.message` field through a source.
     Promise.resolve().then(async () => {
       for await (const buf of lengthPrefixed.decode(this.incomingData)) {
-        const message = self.processIncomingProtobuf(buf)
-
-        if (message != null) {
-          self.onData(new Uint8ArrayList(message))
-        }
+        this.processIncomingProtobuf(buf)
       }
     })
       .catch(err => {
         this.log.error('error processing incoming data channel messages', err)
       })
 
-    // clean up the datachannel when both ends have sent a FIN
-    const webRTCStreamOnClose = (): void => {
-      this.channel.close()
+    // close when both writable ends are closed or an error occurs
+    const cleanUpDatachannelOnClose = (): void => {
+      if (this.channel.readyState === 'open') {
+        this.log.trace('stream closed, closing underlying datachannel')
+        this.channel.close()
+      }
     }
-    this.addEventListener('close', webRTCStreamOnClose)
+    this.addEventListener('close', cleanUpDatachannelOnClose)
   }
 
   sendNewStream (): void {
@@ -129,27 +131,57 @@ export class WebRTCStream extends AbstractStream {
   }
 
   _sendMessage (data: Uint8ArrayList): void {
-    if (this.channel.readyState === 'closed' || this.channel.readyState === 'closing') {
+    if (this.channel.readyState !== 'open') {
       throw new StreamStateError(`Invalid datachannel state - ${this.channel.readyState}`)
     }
 
-    try {
-      this.log.trace('sending message, channel state "%s"', this.channel.readyState)
-      // send message without copying data
-      for (const buf of data) {
-        this.channel.send(buf)
-      }
-    } catch (err: any) {
-      this.log.error('error while sending message', err)
+    this.log.trace('sending message, channel state "%s"', this.channel.readyState)
+
+    if (isFirefox) {
+      // TODO: firefox can deliver small messages out of order - remove once a
+      // browser with https://bugzilla.mozilla.org/show_bug.cgi?id=1983831 is
+      // available in playwright-test
+      this.channel.send(data.subarray())
+      return
+    }
+
+    // send message without copying data
+    for (const buf of data) {
+      this.channel.send(buf)
     }
   }
 
   sendData (data: Uint8ArrayList): SendResult {
-    const messageBuf = Message.encode({
-      message: data.subarray()
-    })
-    const prefixedBuf = lengthPrefixed.encode.single(messageBuf)
-    this._sendMessage(prefixedBuf)
+    if (this.channel.readyState !== 'open') {
+      return {
+        sentBytes: 0,
+        canSendMore: false
+      }
+    }
+
+    // TODO: firefox can deliver small messages out of order - remove once a
+    // browser with https://bugzilla.mozilla.org/show_bug.cgi?id=1983831 is
+    // available in playwright-test
+    // ----
+    // this is also necessary to work with rust-libp2p 0.54 though 0.53 seems ok
+    this._sendMessage(
+      lengthPrefixed.encode.single(Message.encode({
+        message: data.subarray()
+      }))
+    )
+
+    /*
+    // TODO: enable this when FF and rust-libp2p are not broken
+    // send message without copying data
+      for (const message of data) {
+        this._sendMessage(
+          lengthPrefixed.encode.single(Message.encode({
+            message
+          }))
+        )
+      }
+    }
+    */
 
     return {
       sentBytes: data.byteLength,
@@ -157,69 +189,73 @@ export class WebRTCStream extends AbstractStream {
     }
   }
 
-  sendReset (): void {
-    this.receivedFinAck.resolve()
-
+  sendReset (err: Error): void {
     try {
+      this.log.error('sending reset - %e', err)
       this._sendFlag(Message.Flag.RESET)
+      this.receivedFinAck?.reject(err)
     } catch (err) {
       this.log.error('failed to send reset - %e', err)
-    } finally {
-      this.channel.close()
     }
   }
 
   async sendCloseWrite (options?: AbortOptions): Promise<void> {
-    if (this.channel.readyState === 'open') {
-      this._sendFlag(Message.Flag.FIN)
-    }
-
-    await raceSignal(this.receivedFinAck.promise, options?.signal)
+    this._sendFlag(Message.Flag.FIN)
+    options?.signal?.throwIfAborted()
+    this.receivedFinAck = Promise.withResolvers<void>()
+
+    await Promise.any([
+      raceSignal(this.receivedFinAck.promise, options?.signal),
+      new Promise<void>(resolve => {
+        AbortSignal.timeout(this.finAckTimeout)
+          .addEventListener('abort', () => {
+            resolve()
+          })
+      })
+    ])
   }
 
   async sendCloseRead (options?: AbortOptions): Promise<void> {
-    if (this.channel.readyState === 'open') {
-      this._sendFlag(Message.Flag.STOP_SENDING)
-    }
-
+    this._sendFlag(Message.Flag.STOP_SENDING)
     options?.signal?.throwIfAborted()
   }
 
   /**
    * Handle incoming
    */
-  private processIncomingProtobuf (buffer: Uint8ArrayList): Uint8Array | undefined {
+  private processIncomingProtobuf (buffer: Uint8ArrayList): void {
     const message = Message.decode(buffer)
 
+    // ignore data messages if we've closed the readable end already
+    if (message.message != null && (this.readStatus === 'readable' || this.readStatus === 'paused')) {
+      this.onData(new Uint8ArrayList(message.message))
+    }
+
     if (message.flag !== undefined) {
       this.log.trace('incoming flag %s, write status "%s", read status "%s"', message.flag, this.writeStatus, this.readStatus)
 
       if (message.flag === Message.Flag.FIN) {
-        // We should expect no more data from the remote, stop reading
-        this.onRemoteCloseWrite()
+        // we should expect no more data from the remote, stop reading
         this._sendFlag(Message.Flag.FIN_ACK)
+        this.onRemoteCloseWrite()
       }
 
       if (message.flag === Message.Flag.RESET) {
-        this.receivedFinAck.resolve()
-        // Stop reading and writing to the stream immediately
+        // stop reading and writing to the stream immediately
+        this.receivedFinAck?.reject(new StreamResetError('The stream was reset'))
         this.onRemoteReset()
       }
 
       if (message.flag === Message.Flag.STOP_SENDING) {
-        // The remote has stopped reading
+        // the remote has stopped reading
         this.onRemoteCloseRead()
       }
 
       if (message.flag === Message.Flag.FIN_ACK) {
-        this.receivedFinAck.resolve()
+        // remote received our FIN
+        this.receivedFinAck?.resolve()
       }
     }
-
-    // ignore data messages if we've closed the readable end already
-    if (this.readStatus === 'readable' || this.readStatus === 'paused') {
-      return message.message
-    }
   }
 
   private _sendFlag (flag: Message.Flag): boolean {