fix: export ping service capabilities (#3075)

Inform other components that this module can provide ping services.

Author: achingbrain

packages/protocol-ping/src/index.ts

@@ -22,16 +22,21 @@
  * ```
  */
 
-import { PingService as PingServiceClass } from './ping.js'
+import { Ping as PingClass } from './ping.js'
 import type { AbortOptions, ComponentLogger, PeerId } from '@libp2p/interface'
 import type { ConnectionManager, Registrar } from '@libp2p/interface-internal'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
-export interface PingService {
+export interface Ping {
   ping(peer: PeerId | Multiaddr | Multiaddr[], options?: AbortOptions): Promise<number>
 }
 
-export interface PingServiceInit {
+/**
+ * @deprecated Use the `Ping` export instead
+ */
+export type PingService = Ping
+
+export interface PingInit {
   protocolPrefix?: string
   maxInboundStreams?: number
   maxOutboundStreams?: number
@@ -43,14 +48,19 @@ export interface PingServiceInit {
   timeout?: number
 }
 
-export interface PingServiceComponents {
+/**
+ * @deprecated Use the `PingInit` export instead
+ */
+export type PingServiceInit = PingInit
+
+export interface PingComponents {
   registrar: Registrar
   connectionManager: ConnectionManager
   logger: ComponentLogger
 }
 
-export function ping (init: PingServiceInit = {}): (components: PingServiceComponents) => PingService {
-  return (components) => new PingServiceClass(components, init)
+export function ping (init: PingInit = {}): (components: PingComponents) => Ping {
+  return (components) => new PingClass(components, init)
 }
 
 export { PING_PROTOCOL } from './constants.js'

packages/protocol-ping/src/ping.ts

@@ -1,23 +1,23 @@
 import { randomBytes } from '@libp2p/crypto'
-import { ProtocolError, TimeoutError, setMaxListeners } from '@libp2p/interface'
+import { ProtocolError, TimeoutError, serviceCapabilities, setMaxListeners } from '@libp2p/interface'
 import { byteStream } from 'it-byte-stream'
 import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
 import { PROTOCOL_PREFIX, PROTOCOL_NAME, PING_LENGTH, PROTOCOL_VERSION, TIMEOUT, MAX_INBOUND_STREAMS, MAX_OUTBOUND_STREAMS } from './constants.js'
-import type { PingServiceComponents, PingServiceInit, PingService as PingServiceInterface } from './index.js'
+import type { PingComponents, PingInit, Ping as PingInterface } from './index.js'
 import type { AbortOptions, Logger, Stream, PeerId, Startable, IncomingStreamData } from '@libp2p/interface'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
-export class PingService implements Startable, PingServiceInterface {
+export class Ping implements Startable, PingInterface {
   public readonly protocol: string
-  private readonly components: PingServiceComponents
+  private readonly components: PingComponents
   private started: boolean
   private readonly timeout: number
   private readonly maxInboundStreams: number
   private readonly maxOutboundStreams: number
   private readonly runOnLimitedConnection: boolean
   private readonly log: Logger
 
-  constructor (components: PingServiceComponents, init: PingServiceInit = {}) {
+  constructor (components: PingComponents, init: PingInit = {}) {
     this.components = components
     this.log = components.logger.forComponent('libp2p:ping')
     this.started = false
@@ -32,6 +32,10 @@ export class PingService implements Startable, PingServiceInterface {
 
   readonly [Symbol.toStringTag] = '@libp2p/ping'
 
+  readonly [serviceCapabilities]: string[] = [
+    '@libp2p/ping'
+  ]
+
   async start (): Promise<void> {
     await this.components.registrar.handle(this.protocol, this.handleMessage, {
       maxInboundStreams: this.maxInboundStreams,

packages/protocol-ping/test/index.spec.ts

@@ -11,7 +11,7 @@ import { duplexPair } from 'it-pair/duplex'
 import pDefer from 'p-defer'
 import { stubInterface, type StubbedInstance } from 'sinon-ts'
 import { PING_PROTOCOL } from '../src/constants.js'
-import { PingService } from '../src/ping.js'
+import { Ping } from '../src/ping.js'
 import type { ComponentLogger, Stream, Connection } from '@libp2p/interface'
 import type { ConnectionManager, Registrar } from '@libp2p/interface-internal'
 
@@ -34,7 +34,7 @@ function echoStream (): StubbedInstance<Stream> {
 
 describe('ping', () => {
   let components: StubbedPingServiceComponents
-  let ping: PingService
+  let ping: Ping
 
   beforeEach(async () => {
     components = {
@@ -43,7 +43,7 @@ describe('ping', () => {
       logger: defaultLogger()
     }
 
-    ping = new PingService(components, {
+    ping = new Ping(components, {
       timeout: 50
     })