refactor!: extract ping service into separate module (#2218)

BREAKING CHANGE: imports from `libp2p/ping` must be updated to `@libp2p/ping`

Author: achingbrain

.release-please.json

@@ -22,6 +22,7 @@
     "packages/peer-store": {},
     "packages/protocol-autonat": {},
     "packages/protocol-perf": {},
+    "packages/protocol-ping": {},
     "packages/pubsub": {},
     "packages/pubsub-floodsub": {},
     "packages/stream-multiplexer-mplex": {},

doc/CONFIGURATION.md

@@ -987,14 +987,14 @@ Changing the protocol name prefix can isolate default public network (IPFS) for
 ```js
 import { createLibp2p } from 'libp2p'
 import { identifyService } from 'libp2p/identify'
-import { pingService } from 'libp2p/ping'
+import { ping } from 'libp2p/@ping'
 
 const node = await createLibp2p({
   services: {
     identify: identifyService({
       protocolPrefix: 'ipfs' // default
     }),
-    ping: pingService({
+    ping: ping({
       protocolPrefix: 'ipfs' // default
     })
   }
@@ -1003,7 +1003,7 @@ const node = await createLibp2p({
 protocols: [
   "/ipfs/id/1.0.0", // identify service protocol (if we have multiplexers)
   "/ipfs/id/push/1.0.0", // identify service push protocol (if we have multiplexers)
-  "/ipfs/ping/1.0.0", // built-in ping protocol
+  "/ipfs/ping/1.0.0", // ping protocol
 ]
 */
 ```

doc/migrations/v0.46-v1.0.0.md

@@ -6,6 +6,7 @@ A migration guide for refactoring your application code from libp2p `v0.46` to `
 ## Table of Contents <!-- omit in toc -->
 
 - [AutoNAT](#autonat)
+- [Ping](#ping)
 - [KeyChain](#keychain)
 - [UPnPNat](#upnpnat)
 - [Pnet](#pnet)
@@ -41,6 +42,36 @@ const node = await createLibp2p({
 })
 ```
 
+## Ping
+
+The Ping service is now published in its own package.
+
+**Before**
+
+```ts
+import { createLibp2p } from 'libp2p'
+import { pingService } from 'libp2p/ping'
+
+const node = await createLibp2p({
+  services: {
+    ping: pingService()
+  }
+})
+```
+
+**After**
+
+```ts
+import { createLibp2p } from 'libp2p'
+import { ping } from '@libp2p/ping'
+
+const node = await createLibp2p({
+  services: {
+    ping: ping()
+  }
+})
+```
+
 ## KeyChain
 
 The KeyChain object is no longer included on Libp2p and must be instantiated explicitly if desired.

interop/README.md

@@ -7,7 +7,7 @@
 
 > Multidimensional interop tests
 
-# Install
+# Install <!-- omit in toc -->
 
 ```console
 $ npm i @libp2p/multidim-interop
@@ -57,7 +57,7 @@ $ docker build . -f ./interop/BrowserDockerfile -t js-libp2p-browsers
    $ git clone https://github.com/libp2p/test-plans.git
    ```
 2. (Optional) If you are running an M1 Mac you may need to override the build platform.
-   - Edit `/multidim-interop/dockerBuildWrapper.sh`
+   - Edit `/transport-interop/dockerBuildWrapper.sh`
    - Add `--platform linux/arm64/v8` to the `docker buildx build` command
      ```
      docker buildx build \
@@ -67,7 +67,7 @@ $ docker build . -f ./interop/BrowserDockerfile -t js-libp2p-browsers
      ```
 3. (Optional) Enable some sort of debug output
    - nim-libp2p
-     - edit `/multidim-interop/impl/nim/$VERSION/Dockerfile`
+     - edit `/transport-interop/impl/nim/$VERSION/Dockerfile`
      - Change `-d:chronicles_log_level=WARN` to `-d:chronicles_log_level=DEBUG`
    - rust-libp2p
      - When starting the docker container add `-e RUST_LOG=debug`

interop/package.json

@@ -54,6 +54,7 @@
     "@chainsafe/libp2p-noise": "^13.0.0",
     "@chainsafe/libp2p-yamux": "^5.0.0",
     "@libp2p/mplex": "^9.0.12",
+    "@libp2p/ping": "^0.0.0",
     "@libp2p/tcp": "^8.0.13",
     "@libp2p/webrtc": "^3.2.10",
     "@libp2p/websockets": "^7.0.13",

interop/test/ping.spec.ts

@@ -5,6 +5,7 @@ import { } from 'aegir/chai'
 import { noise } from '@chainsafe/libp2p-noise'
 import { yamux } from '@chainsafe/libp2p-yamux'
 import { mplex } from '@libp2p/mplex'
+import { ping, type PingService } from '@libp2p/ping'
 import { tcp } from '@libp2p/tcp'
 import { webRTC, webRTCDirect } from '@libp2p/webrtc'
 import { webSockets } from '@libp2p/websockets'
@@ -14,7 +15,6 @@ import { type Multiaddr, multiaddr } from '@multiformats/multiaddr'
 import { createLibp2p, type Libp2p, type Libp2pOptions } from 'libp2p'
 import { circuitRelayTransport } from 'libp2p/circuit-relay'
 import { type IdentifyService, identifyService } from 'libp2p/identify'
-import { pingService, type PingService } from 'libp2p/ping'
 
 async function redisProxy (commands: any[]): Promise<any> {
   const res = await fetch(`http://localhost:${process.env.proxyPort ?? ''}/`, { body: JSON.stringify(commands), method: 'POST' })
@@ -49,7 +49,7 @@ describe('ping test', function () {
         denyDialMultiaddr: async () => false
       },
       services: {
-        ping: pingService(),
+        ping: ping(),
         identify: identifyService()
       }
     }

interop/tsconfig.json

@@ -11,6 +11,9 @@
     {
       "path": "../packages/libp2p"
     },
+    {
+      "path": "../packages/protocol-ping"
+    },
     {
       "path": "../packages/stream-multiplexer-mplex"
     },

packages/libp2p/.aegir.js

@@ -18,7 +18,6 @@ export default {
       const { plaintext } = await import('./dist/src/insecure/index.js')
       const { circuitRelayServer, circuitRelayTransport } = await import('./dist/src/circuit-relay/index.js')
       const { identifyService } = await import('./dist/src/identify/index.js')
-      const { pingService } = await import('./dist/src/ping/index.js')
       const { fetchService } = await import('./dist/src/fetch/index.js')
 
       const peerId = await createEd25519PeerId()
@@ -47,7 +46,6 @@ export default {
         ],
         services: {
           identify: identifyService(),
-          ping: pingService(),
           fetch: fetchService(),
           relay: circuitRelayServer({
             reservations: {

packages/libp2p/package.json

@@ -67,10 +67,6 @@
     "./insecure": {
       "types": "./dist/src/insecure/index.d.ts",
       "import": "./dist/src/insecure/index.js"
-    },
-    "./ping": {
-      "types": "./dist/src/ping/index.d.ts",
-      "import": "./dist/src/ping/index.js"
     }
   },
   "eslintConfig": {