fix: react native adjustments (#2229)

- export typed event emitter separately from setMaxListeners - update react-native overrides in module package.json files - add react-native-webrtc implementation to WebRTC transport --------- Co-authored-by: achingbrain <alex@achingbrain.net>
libp2p · Dec 10, 2023 · 3415811 · 3415811
1 parent 6d11e82
commit 3415811
Show file tree

Hide file tree

Showing 16 changed files with 142 additions and 132 deletions.
diff --git a/packages/interface/package.json b/packages/interface/package.json
@@ -74,5 +74,8 @@
   },
   "browser": {
     "events": "./dist/src/events.browser.js"
+  },
+  "react-native": {
+    "./dist/src/events.js": "./dist/src/events.browser.js"
   }
 }
diff --git a/packages/interface/src/event-target.ts b/packages/interface/src/event-target.ts
@@ -0,0 +1,116 @@
+export interface EventCallback<EventType> { (evt: EventType): void }
+export interface EventObject<EventType> { handleEvent: EventCallback<EventType> }
+export type EventHandler<EventType> = EventCallback<EventType> | EventObject<EventType>
+
+interface Listener {
+  once: boolean
+  callback: any
+}
+
+/**
+ * Adds types to the EventTarget class. Hopefully this won't be necessary forever.
+ *
+ * https://github.com/microsoft/TypeScript/issues/28357
+ * https://github.com/microsoft/TypeScript/issues/43477
+ * https://github.com/microsoft/TypeScript/issues/299
+ * etc
+ */
+export interface TypedEventTarget <EventMap extends Record<string, any>> extends EventTarget {
+  addEventListener<K extends keyof EventMap>(type: K, listener: EventHandler<EventMap[K]> | null, options?: boolean | AddEventListenerOptions): void
+
+  listenerCount (type: string): number
+
+  removeEventListener<K extends keyof EventMap>(type: K, listener?: EventHandler<EventMap[K]> | null, options?: boolean | EventListenerOptions): void
+
+  removeEventListener (type: string, listener?: EventHandler<Event>, options?: boolean | EventListenerOptions): void
+
+  safeDispatchEvent<Detail>(type: keyof EventMap, detail: CustomEventInit<Detail>): boolean
+}
+
+/**
+ * An implementation of a typed event target
+ * etc
+ */
+export class TypedEventEmitter<EventMap extends Record<string, any>> extends EventTarget implements TypedEventTarget<EventMap> {
+  #listeners = new Map<any, Listener[]>()
+
+  listenerCount (type: string): number {
+    const listeners = this.#listeners.get(type)
+
+    if (listeners == null) {
+      return 0
+    }
+
+    return listeners.length
+  }
+
+  addEventListener<K extends keyof EventMap>(type: K, listener: EventHandler<EventMap[K]> | null, options?: boolean | AddEventListenerOptions): void
+  addEventListener (type: string, listener: EventHandler<Event>, options?: boolean | AddEventListenerOptions): void {
+    super.addEventListener(type, listener, options)
+
+    let list = this.#listeners.get(type)
+
+    if (list == null) {
+      list = []
+      this.#listeners.set(type, list)
+    }
+
+    list.push({
+      callback: listener,
+      once: (options !== true && options !== false && options?.once) ?? false
+    })
+  }
+
+  removeEventListener<K extends keyof EventMap>(type: K, listener?: EventHandler<EventMap[K]> | null, options?: boolean | EventListenerOptions): void
+  removeEventListener (type: string, listener?: EventHandler<Event>, options?: boolean | EventListenerOptions): void {
+    super.removeEventListener(type.toString(), listener ?? null, options)
+
+    let list = this.#listeners.get(type)
+
+    if (list == null) {
+      return
+    }
+
+    list = list.filter(({ callback }) => callback !== listener)
+    this.#listeners.set(type, list)
+  }
+
+  dispatchEvent (event: Event): boolean {
+    const result = super.dispatchEvent(event)
+
+    let list = this.#listeners.get(event.type)
+
+    if (list == null) {
+      return result
+    }
+
+    list = list.filter(({ once }) => !once)
+    this.#listeners.set(event.type, list)
+
+    return result
+  }
+
+  safeDispatchEvent<Detail>(type: keyof EventMap, detail: CustomEventInit<Detail>): boolean {
+    return this.dispatchEvent(new CustomEvent<Detail>(type as string, detail))
+  }
+}
+
+/**
+ * CustomEvent is a standard event but it's not supported by node.
+ *
+ * Remove this when https://github.com/nodejs/node/issues/40678 is closed.
+ *
+ * Ref: https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent
+ */
+class CustomEventPolyfill<T = any> extends Event {
+  /** Returns any custom data event was created with. Typically used for synthetic events. */
+  public detail: T
+
+  constructor (message: string, data?: EventInit & { detail: T }) {
+    super(message, data)
+    // @ts-expect-error could be undefined
+    this.detail = data?.detail
+  }
+}
+
+export const CustomEvent = globalThis.CustomEvent ?? CustomEventPolyfill
diff --git a/packages/interface/src/events.ts b/packages/interface/src/events.ts
@@ -1,122 +1,5 @@
 import { setMaxListeners as nodeSetMaxListeners } from 'events'
 
-export interface EventCallback<EventType> { (evt: EventType): void }
-export interface EventObject<EventType> { handleEvent: EventCallback<EventType> }
-export type EventHandler<EventType> = EventCallback<EventType> | EventObject<EventType>
-
-interface Listener {
-  once: boolean
-  callback: any
-}
-
-/**
- * Adds types to the EventTarget class. Hopefully this won't be necessary forever.
- *
- * https://github.com/microsoft/TypeScript/issues/28357
- * https://github.com/microsoft/TypeScript/issues/43477
- * https://github.com/microsoft/TypeScript/issues/299
- * etc
- */
-export interface TypedEventTarget <EventMap extends Record<string, any>> extends EventTarget {
-  addEventListener<K extends keyof EventMap>(type: K, listener: EventHandler<EventMap[K]> | null, options?: boolean | AddEventListenerOptions): void
-
-  listenerCount (type: string): number
-
-  removeEventListener<K extends keyof EventMap>(type: K, listener?: EventHandler<EventMap[K]> | null, options?: boolean | EventListenerOptions): void
-
-  removeEventListener (type: string, listener?: EventHandler<Event>, options?: boolean | EventListenerOptions): void
-
-  safeDispatchEvent<Detail>(type: keyof EventMap, detail: CustomEventInit<Detail>): boolean
-}
-
-/**
- * An implementation of a typed event target
- * etc
- */
-export class TypedEventEmitter<EventMap extends Record<string, any>> extends EventTarget implements TypedEventTarget<EventMap> {
-  #listeners = new Map<any, Listener[]>()
-
-  listenerCount (type: string): number {
-    const listeners = this.#listeners.get(type)
-
-    if (listeners == null) {
-      return 0
-    }
-
-    return listeners.length
-  }
-
-  addEventListener<K extends keyof EventMap>(type: K, listener: EventHandler<EventMap[K]> | null, options?: boolean | AddEventListenerOptions): void
-  addEventListener (type: string, listener: EventHandler<Event>, options?: boolean | AddEventListenerOptions): void {
-    super.addEventListener(type, listener, options)
-
-    let list = this.#listeners.get(type)
-
-    if (list == null) {
-      list = []
-      this.#listeners.set(type, list)
-    }
-
-    list.push({
-      callback: listener,
-      once: (options !== true && options !== false && options?.once) ?? false
-    })
-  }
-
-  removeEventListener<K extends keyof EventMap>(type: K, listener?: EventHandler<EventMap[K]> | null, options?: boolean | EventListenerOptions): void
-  removeEventListener (type: string, listener?: EventHandler<Event>, options?: boolean | EventListenerOptions): void {
-    super.removeEventListener(type.toString(), listener ?? null, options)
-
-    let list = this.#listeners.get(type)
-
-    if (list == null) {
-      return
-    }
-
-    list = list.filter(({ callback }) => callback !== listener)
-    this.#listeners.set(type, list)
-  }
-
-  dispatchEvent (event: Event): boolean {
-    const result = super.dispatchEvent(event)
-
-    let list = this.#listeners.get(event.type)
-
-    if (list == null) {
-      return result
-    }
-
-    list = list.filter(({ once }) => !once)
-    this.#listeners.set(event.type, list)
-
-    return result
-  }
-
-  safeDispatchEvent<Detail>(type: keyof EventMap, detail: CustomEventInit<Detail>): boolean {
-    return this.dispatchEvent(new CustomEvent<Detail>(type as string, detail))
-  }
-}
-
-/**
- * CustomEvent is a standard event but it's not supported by node.
- *
- * Remove this when https://github.com/nodejs/node/issues/40678 is closed.
- *
- * Ref: https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent
- */
-class CustomEventPolyfill<T = any> extends Event {
-  /** Returns any custom data event was created with. Typically used for synthetic events. */
-  public detail: T
-
-  constructor (message: string, data?: EventInit & { detail: T }) {
-    super(message, data)
-    // @ts-expect-error could be undefined
-    this.detail = data?.detail
-  }
-}
-
-export const CustomEvent = globalThis.CustomEvent ?? CustomEventPolyfill
-
 // create a setMaxListeners that doesn't break browser usage
 export const setMaxListeners: typeof nodeSetMaxListeners = (n, ...eventTargets) => {
   try {

diff --git a/packages/interface/src/index.ts b/packages/interface/src/index.ts
@@ -16,7 +16,7 @@
 
 import type { Connection, NewStreamOptions, Stream } from './connection/index.js'
 import type { ContentRouting } from './content-routing/index.js'
-import type { TypedEventTarget } from './events.js'
+import type { TypedEventTarget } from './event-target.js'
 import type { Metrics } from './metrics/index.js'
 import type { PeerId } from './peer-id/index.js'
 import type { PeerInfo } from './peer-info/index.js'
@@ -690,5 +690,6 @@ export * from './stream-muxer/index.js'
 export * from './topology/index.js'
 export * from './transport/index.js'
 export * from './errors.js'
+export * from './event-target.js'
 export * from './events.js'
 export * from './startable.js'
diff --git a/packages/interface/src/peer-discovery/index.ts b/packages/interface/src/peer-discovery/index.ts
@@ -1,4 +1,4 @@
-import type { TypedEventTarget } from '../events.js'
+import type { TypedEventTarget } from '../event-target.js'
 import type { PeerInfo } from '../peer-info/index.js'
 
 /**

diff --git a/packages/interface/src/pubsub/index.ts b/packages/interface/src/pubsub/index.ts
@@ -1,5 +1,5 @@
 import type { Stream } from '../connection/index.js'
-import type { TypedEventTarget } from '../events.js'
+import type { TypedEventTarget } from '../event-target.js'
 import type { PeerId } from '../peer-id/index.js'
 import type { Pushable } from 'it-pushable'
 import type { Uint8ArrayList } from 'uint8arraylist'

diff --git a/packages/interface/src/transport/index.ts b/packages/interface/src/transport/index.ts
@@ -1,5 +1,5 @@
 import type { Connection, MultiaddrConnection } from '../connection/index.js'
-import type { TypedEventTarget } from '../events.js'
+import type { TypedEventTarget } from '../event-target.js'
 import type { AbortOptions } from '../index.js'
 import type { StreamMuxerFactory } from '../stream-muxer/index.js'
 import type { Multiaddr } from '@multiformats/multiaddr'

diff --git a/packages/libp2p/package.json b/packages/libp2p/package.json
@@ -142,5 +142,9 @@
   "browser": {
     "./dist/src/connection-manager/constants.js": "./dist/src/connection-manager/constants.browser.js",
     "./dist/src/config/connection-gater.js": "./dist/src/config/connection-gater.browser.js"
+  },
+  "react-native": {
+    "./dist/src/connection-manager/constants.js": "./dist/src/connection-manager/constants.browser.js",
+    "./dist/src/config/connection-gater.js": "./dist/src/config/connection-gater.browser.js"
   }
 }
diff --git a/packages/stream-multiplexer-mplex/package.json b/packages/stream-multiplexer-mplex/package.json
@@ -86,8 +86,5 @@
     "it-pipe": "^3.0.1",
     "p-defer": "^4.0.0",
     "random-int": "^3.0.0"
-  },
-  "browser": {
-    "./dist/src/alloc-unsafe.js": "./dist/src/alloc-unsafe-browser.js"
   }
 }
diff --git a/packages/stream-multiplexer-mplex/src/alloc-unsafe-browser.ts b/packages/stream-multiplexer-mplex/src/alloc-unsafe-browser.ts
diff --git a/packages/stream-multiplexer-mplex/src/alloc-unsafe.ts b/packages/stream-multiplexer-mplex/src/alloc-unsafe.ts
diff --git a/packages/stream-multiplexer-mplex/src/encode.ts b/packages/stream-multiplexer-mplex/src/encode.ts
@@ -1,6 +1,6 @@
 import * as varint from 'uint8-varint'
 import { Uint8ArrayList } from 'uint8arraylist'
-import { allocUnsafe } from './alloc-unsafe.js'
+import { allocUnsafe } from 'uint8arrays/alloc'
 import { type Message, MessageTypes } from './message-types.js'
 import type { Source } from 'it-stream-types'
 

diff --git a/packages/transport-webrtc/package.json b/packages/transport-webrtc/package.json
@@ -73,6 +73,7 @@
     "p-timeout": "^6.1.2",
     "protons-runtime": "^5.0.0",
     "race-signal": "^1.0.0",
+    "react-native-webrtc": "^118.0.0",
     "uint8arraylist": "^2.4.3",
     "uint8arrays": "^5.0.0"
   },
@@ -97,5 +98,8 @@
   },
   "browser": {
     "./dist/src/webrtc/index.js": "./dist/src/webrtc/index.browser.js"
+  },
+  "react-native": {
+    "./dist/src/webrtc/index.js": "./dist/src/webrtc/index.react-native.js"
   }
 }
diff --git a/packages/transport-webrtc/src/webrtc/index.react-native.ts b/packages/transport-webrtc/src/webrtc/index.react-native.ts
@@ -0,0 +1,5 @@
+export {
+  RTCIceCandidate,
+  RTCPeerConnection,
+  RTCSessionDescription
+} from 'react-native-webrtc'
diff --git a/packages/transport-websockets/package.json b/packages/transport-websockets/package.json
@@ -79,7 +79,7 @@
     "@multiformats/multiaddr": "^12.1.10",
     "@multiformats/multiaddr-to-uri": "^9.0.2",
     "@types/ws": "^8.5.4",
-    "it-ws": "^6.0.0",
+    "it-ws": "^6.1.0",
     "p-defer": "^4.0.0",
     "wherearewe": "^2.0.1",
     "ws": "^8.12.1"

diff --git a/packages/transport-webtransport/package.json b/packages/transport-webtransport/package.json
@@ -68,5 +68,8 @@
   },
   "browser": {
     "./dist/src/listener.js": "./dist/src/listener.browser.js"
+  },
+  "react-native": {
+    "./dist/src/listener.js": "./dist/src/listener.browser.js"
   }
 }