@libp2p/devtools-metrics 0.2.0 → 0.2.1-151bc46fb

package/src/rpc/codecs/multiaddr.ts

@@ -0,0 +1,10 @@
+import { isMultiaddr, multiaddr } from '@multiformats/multiaddr'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import type { ValueCodec } from 'it-rpc'
+
+export const multiaddrCodec: ValueCodec<Multiaddr> = {
+  type: 4097,
+  canEncode: (val) => isMultiaddr(val),
+  encode: (val) => val.bytes,
+  decode: (buf) => multiaddr(buf)
+}

package/src/rpc/codecs/peer-id.ts

@@ -0,0 +1,11 @@
+import { isPeerId } from '@libp2p/interface'
+import { peerIdFromBytes } from '@libp2p/peer-id'
+import type { PeerId } from '@libp2p/interface'
+import type { ValueCodec } from 'it-rpc'
+
+export const peerIdCodec: ValueCodec<PeerId> = {
+  type: 4098,
+  canEncode: (val) => isPeerId(val),
+  encode: (val) => val.toBytes(),
+  decode: (buf) => peerIdFromBytes(buf)
+}

package/src/rpc/index.ts

@@ -0,0 +1,122 @@
+import { cidCodec } from './codecs/cid.js'
+import { customProgressEventCodec } from './codecs/custom-progress-event.js'
+import { multiaddrCodec } from './codecs/multiaddr.js'
+import { peerIdCodec } from './codecs/peer-id.js'
+import type { ContentRouting, PeerId, PeerRouting, AbortOptions } from '@libp2p/interface'
+import type { OpenConnectionOptions } from '@libp2p/interface-internal'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import type { ValueCodec } from 'it-rpc'
+
+export const valueCodecs: Array<ValueCodec<any>> = [
+  cidCodec,
+  multiaddrCodec,
+  peerIdCodec,
+  customProgressEventCodec
+]
+
+export interface NodeAddress {
+  multiaddr: Multiaddr
+  listen?: boolean
+  announce?: boolean
+  observed?: boolean
+  default?: boolean
+}
+
+export interface NodeStatus {
+  peerId: PeerId
+  agent?: string
+  addresses: NodeAddress[]
+  protocols: string[]
+}
+
+export interface PeerAddress {
+  multiaddr: Multiaddr
+  isConnected?: boolean
+  isCertified?: boolean
+}
+
+export interface Peer {
+  /**
+   * The identifier of the remote peer
+   */
+  id: PeerId
+
+  /**
+   * The list of addresses the peer has that we know about
+   */
+  addresses: PeerAddress[]
+
+  /**
+   * Any peer store tags the peer has
+   */
+  tags: Record<string, number>
+
+  /**
+   * Any peer store metadata the peer has
+   */
+  metadata: Record<string, string>
+
+  /**
+   * The protocols the peer supports, if known
+   */
+  protocols: string[]
+}
+
+/**
+ * RPC operations exposed by the metrics
+ */
+export interface MetricsRPC {
+  /**
+   * Called by DevTools on initial connect
+   */
+  init(options?: AbortOptions): Promise<{ self: Peer, peers: Peer[], debug: string }>
+
+  /**
+   * Update the currently active debugging namespaces
+   */
+  setDebug(namespace?: string): Promise<void>
+
+  /**
+   * Open a connection to the passed peer or multiaddr
+   */
+  openConnection(peerIdOrMultiaddr: string, options?: OpenConnectionOptions): Promise<void>
+
+  /**
+   * Close connections open to the specified peer
+   */
+  closeConnection(peerId: PeerId, options?: AbortOptions): Promise<void>
+
+  /**
+   * Make content routing queries
+   */
+  contentRouting: ContentRouting
+
+  /**
+   * Make peer routing queries
+   */
+  peerRouting: PeerRouting
+}
+
+export interface DevToolsEvents {
+  /**
+   * Node metrics have been updated
+   */
+  'metrics': CustomEvent<Record<string, any>>
+
+  /**
+   * The node's status has changed - new addresses and/or protocols, etc
+   */
+  'self': CustomEvent<Peer>
+
+  /**
+   * The node's connected peers have changed
+   */
+  'peers': CustomEvent<Peer[]>
+}
+
+/**
+ * RPC operations exposed by the DevTools
+ */
+export interface DevToolsRPC {
+  safeDispatchEvent<Detail>(type: keyof DevToolsEvents, detail?: CustomEventInit<Detail>): Promise<void>
+}

package/src/rpc/rpc.ts

@@ -0,0 +1,59 @@
+import { enable, disable } from '@libp2p/logger'
+import { peerIdFromString } from '@libp2p/peer-id'
+import { multiaddr } from '@multiformats/multiaddr'
+import { getPeers } from '../utils/get-peers.js'
+import { getSelf } from '../utils/get-self.js'
+import type { MetricsRPC } from './index.js'
+import type { DevToolsMetricsComponents } from '../index.js'
+import type { PeerId } from '@libp2p/interface'
+import type { OpenConnectionOptions } from '@libp2p/interface-internal'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import type { AbortOptions } from 'it-pushable'
+
+export function metricsRpc (components: DevToolsMetricsComponents): MetricsRPC {
+  const log = components.logger.forComponent('libp2p:devtools-metrics:metrics-rpc')
+
+  return {
+    init: async () => {
+      return {
+        self: await getSelf(components),
+        peers: await getPeers(components, log),
+        debug: localStorage.getItem('debug') ?? ''
+      }
+    },
+    setDebug: async (namespace?: string) => {
+      if (namespace?.length != null && namespace?.length > 0) {
+        enable(namespace)
+        localStorage.setItem('debug', namespace)
+      } else {
+        disable()
+        localStorage.removeItem('debug')
+      }
+    },
+    openConnection: async (peerIdOrMultiaddr: string, options?: OpenConnectionOptions) => {
+      let peer: PeerId | Multiaddr
+
+      try {
+        peer = peerIdFromString(peerIdOrMultiaddr)
+      } catch {
+        peer = multiaddr(peerIdOrMultiaddr)
+      }
+
+      await components.connectionManager.openConnection(peer, options)
+    },
+    closeConnection: async (peerId: PeerId, options?: AbortOptions) => {
+      await Promise.all(
+        components.connectionManager.getConnections(peerId)
+          .map(async connection => {
+            try {
+              await connection.close(options)
+            } catch (err: any) {
+              connection.abort(err)
+            }
+          })
+      )
+    },
+    contentRouting: components.contentRouting,
+    peerRouting: components.peerRouting
+  }
+}

package/src/utils/debounce.ts

@@ -0,0 +1,23 @@
+export function debounce (callback: () => void, wait: number = 100): () => void {
+  let timeout: ReturnType<typeof setTimeout>
+  let start: number | undefined
+
+  return (): void => {
+    if (start == null) {
+      start = Date.now()
+    }
+
+    if (timeout != null && Date.now() - start > wait) {
+      clearTimeout(timeout)
+      start = undefined
+      callback()
+      return
+    }
+
+    clearTimeout(timeout)
+    timeout = setTimeout(() => {
+      start = undefined
+      callback()
+    }, wait)
+  }
+}

package/src/utils/get-peers.ts

@@ -0,0 +1,53 @@
+import { base64 } from 'multiformats/bases/base64'
+import { toObject } from './to-object.js'
+import type { Peer } from '../rpc/index.js'
+import type { Logger, PeerStore } from '@libp2p/interface'
+import type { ConnectionManager } from '@libp2p/interface-internal'
+
+export interface Components {
+  connectionManager: ConnectionManager
+  peerStore: PeerStore
+}
+
+export async function getPeers (components: Components, log: Logger): Promise<Peer[]> {
+  const peers: Peer[] = []
+  const connections = components.connectionManager.getConnectionsMap()
+  const connectedAddresses = [...connections.values()].flatMap(conn => conn).map(conn => conn.remoteAddr.toString())
+
+  for (const [peerId, conns] of connections.entries()) {
+    try {
+      const peer = await components.peerStore.get(peerId)
+
+      peers.push({
+        id: peerId,
+        addresses: peer.addresses.map(({ isCertified, multiaddr }) => {
+          return {
+            multiaddr,
+            isCertified,
+            isConnected: connectedAddresses.includes(multiaddr.toString())
+          }
+        }),
+        protocols: [...peer.protocols],
+        tags: toObject(peer.tags, (t) => t.value),
+        metadata: toObject(peer.metadata, (buf) => base64.encode(buf))
+      })
+    } catch (err) {
+      log.error('could not load peer data from peer store', err)
+
+      peers.push({
+        id: peerId,
+        addresses: conns.map(conn => {
+          return {
+            multiaddr: conn.remoteAddr,
+            isConnected: connectedAddresses.includes(conn.remoteAddr.toString())
+          }
+        }),
+        protocols: [],
+        tags: {},
+        metadata: {}
+      })
+    }
+  }
+
+  return peers
+}

package/src/utils/get-self.ts

@@ -0,0 +1,21 @@
+import { base64 } from 'multiformats/bases/base64'
+import { toObject } from './to-object.js'
+import type { Peer } from '../rpc/index.js'
+import type { PeerId, PeerStore } from '@libp2p/interface'
+
+export interface Components {
+  peerId: PeerId
+  peerStore: PeerStore
+}
+
+export async function getSelf (components: Components): Promise<Peer> {
+  const peer = await components.peerStore.get(components.peerId)
+
+  return {
+    id: peer.id,
+    addresses: peer.addresses,
+    protocols: [...peer.protocols],
+    tags: toObject(peer.tags, (t) => t.value),
+    metadata: toObject(peer.metadata, (buf) => base64.encode(buf))
+  }
+}

package/src/utils/to-object.ts

@@ -0,0 +1,9 @@
+export function toObject <T, R> (map: Map<string, T>, transform: (value: T) => R): Record<string, R> {
+  const output: Record<string, any> = {}
+
+  for (const [key, value] of map.entries()) {
+    output[key] = transform(value)
+  }
+
+  return output
+}

package/dist/typedoc-urls.json

@@ -1,46 +0,0 @@
-{
-  "Address": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.Address.html",
-  ".:Address": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.Address.html",
-  "CopyToClipboardMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.CopyToClipboardMessage.html",
-  ".:CopyToClipboardMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.CopyToClipboardMessage.html",
-  "DevToolsMetricsComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.DevToolsMetricsComponents.html",
-  ".:DevToolsMetricsComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.DevToolsMetricsComponents.html",
-  "DevToolsMetricsInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.DevToolsMetricsInit.html",
-  ".:DevToolsMetricsInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.DevToolsMetricsInit.html",
-  "EnableDebugMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.EnableDebugMessage.html",
-  ".:EnableDebugMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.EnableDebugMessage.html",
-  "IdentifyMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.IdentifyMessage.html",
-  ".:IdentifyMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.IdentifyMessage.html",
-  "MetricsMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.MetricsMessage.html",
-  ".:MetricsMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.MetricsMessage.html",
-  "PageLoadedMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.PageLoadedMessage.html",
-  ".:PageLoadedMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.PageLoadedMessage.html",
-  "Peer": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.Peer.html",
-  ".:Peer": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.Peer.html",
-  "PeersMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.PeersMessage.html",
-  ".:PeersMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.PeersMessage.html",
-  "PermissionsErrorMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.PermissionsErrorMessage.html",
-  ".:PermissionsErrorMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.PermissionsErrorMessage.html",
-  "SelfMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.SelfMessage.html",
-  ".:SelfMessage": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.SelfMessage.html",
-  "SelfPeer": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.SelfPeer.html",
-  ".:SelfPeer": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_devtools_metrics.SelfPeer.html",
-  "ApplicationMessage": "https://libp2p.github.io/js-libp2p/types/_libp2p_devtools_metrics.ApplicationMessage.html",
-  ".:ApplicationMessage": "https://libp2p.github.io/js-libp2p/types/_libp2p_devtools_metrics.ApplicationMessage.html",
-  "DevToolsMessage": "https://libp2p.github.io/js-libp2p/types/_libp2p_devtools_metrics.DevToolsMessage.html",
-  ".:DevToolsMessage": "https://libp2p.github.io/js-libp2p/types/_libp2p_devtools_metrics.DevToolsMessage.html",
-  "WorkerMessage": "https://libp2p.github.io/js-libp2p/types/_libp2p_devtools_metrics.WorkerMessage.html",
-  ".:WorkerMessage": "https://libp2p.github.io/js-libp2p/types/_libp2p_devtools_metrics.WorkerMessage.html",
-  "LIBP2P_DEVTOOLS_METRICS_KEY": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.LIBP2P_DEVTOOLS_METRICS_KEY.html",
-  ".:LIBP2P_DEVTOOLS_METRICS_KEY": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.LIBP2P_DEVTOOLS_METRICS_KEY.html",
-  "SOURCE_CONTENT_SCRIPT": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.SOURCE_CONTENT_SCRIPT.html",
-  ".:SOURCE_CONTENT_SCRIPT": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.SOURCE_CONTENT_SCRIPT.html",
-  "SOURCE_DEVTOOLS": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.SOURCE_DEVTOOLS.html",
-  ".:SOURCE_DEVTOOLS": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.SOURCE_DEVTOOLS.html",
-  "SOURCE_METRICS": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.SOURCE_METRICS.html",
-  ".:SOURCE_METRICS": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.SOURCE_METRICS.html",
-  "SOURCE_SERVICE_WORKER": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.SOURCE_SERVICE_WORKER.html",
-  ".:SOURCE_SERVICE_WORKER": "https://libp2p.github.io/js-libp2p/variables/_libp2p_devtools_metrics.SOURCE_SERVICE_WORKER.html",
-  "devToolsMetrics": "https://libp2p.github.io/js-libp2p/functions/_libp2p_devtools_metrics.devToolsMetrics.html",
-  ".:devToolsMetrics": "https://libp2p.github.io/js-libp2p/functions/_libp2p_devtools_metrics.devToolsMetrics.html"
-}