test: fix flaky interop tests - address already in use (#3396)

Author: dozyio

packages/integration-tests/.aegir.js

@@ -169,11 +169,11 @@ async function createGoLibp2pRelay () {
   const { defaultLogger } = await import('@libp2p/logger')
 
   const log = defaultLogger().forComponent('go-libp2p')
-  const controlPort = Math.floor(Math.random() * (50000 - 10000 + 1)) + 10000
-  const apiAddr = multiaddr(`/ip4/127.0.0.1/tcp/${controlPort}`)
+  const controlAddrUndefinedPort = multiaddr('/ip4/127.0.0.1/tcp/0')
   const deferred = pDefer()
+
   const proc = execa(p2pd(), [
-    `-listen=${apiAddr.toString()}`,
+    `-listen=${controlAddrUndefinedPort.toString()}`,
     // listen on TCP, WebSockets and WebTransport
     '-hostAddrs=/ip4/127.0.0.1/tcp/0,/ip4/127.0.0.1/tcp/0/ws,/ip4/127.0.0.1/udp/0/quic-v1/webtransport',
     '-noise=true',
@@ -185,15 +185,23 @@ async function createGoLibp2pRelay () {
       GOLOG_LOG_LEVEL: 'debug'
     }
   })
+
   proc.catch(() => {
     // go-libp2p daemon throws when killed
   })
 
+  proc.once('exit', code => {
+    deferred.reject(new Error(`go-libp2p daemon exited before startup (code: ${code ?? 'unknown'})`))
+  })
+
+  let controlMultiaddr
+
   proc.stdout?.on('data', (buf) => {
     const str = buf.toString()
 
-    // daemon has started
-    if (str.includes('Control socket:')) {
+    const match = str.match(/Control socket:\s*(.+)/)
+    if (match != null) {
+      controlMultiaddr = multiaddr(match[1].trim())
       deferred.resolve()
     }
   })
@@ -202,13 +210,18 @@ async function createGoLibp2pRelay () {
 
     log(str)
   })
+
   await deferred.promise
 
-  const daemonClient = createClient(apiAddr)
+  if (controlMultiaddr == null) {
+    throw new Error('go-libp2p daemon did not report a control socket')
+  }
+
+  const daemonClient = createClient(controlMultiaddr)
   const id = await daemonClient.identify()
 
   return {
-    apiAddr,
+    apiAddr: controlMultiaddr,
     peerId: id.peerId.toString(),
     multiaddrs: id.addrs.map(ma => ma.toString()).join(','),
     proc

packages/integration-tests/package.json

@@ -57,7 +57,7 @@
     "delay": "^7.0.0",
     "detect-browser": "^5.3.0",
     "execa": "^9.6.0",
-    "go-libp2p": "^1.6.0",
+    "go-libp2p": "^1.7.0",
     "libp2p": "^3.1.5",
     "main-event": "^1.0.1",
     "multiformats": "^13.4.0",

packages/integration-tests/test/interop.ts

@@ -26,6 +26,7 @@ import type { Identify } from '@libp2p/identify'
 import type { ServiceMap, PrivateKey } from '@libp2p/interface'
 import type { SpawnOptions, Daemon, DaemonFactory } from '@libp2p/interop'
 import type { Ping } from '@libp2p/ping'
+import type { Multiaddr } from '@multiformats/multiaddr'
 import type { Libp2pOptions, ServiceFactoryMap } from 'libp2p'
 
 /**
@@ -39,13 +40,12 @@ import type { Libp2pOptions, ServiceFactoryMap } from 'libp2p'
  */
 
 async function createGoPeer (options: SpawnOptions): Promise<Daemon> {
-  const controlPort = Math.floor(Math.random() * (50000 - 10000 + 1)) + 10000
-  const apiAddr = multiaddr(`/ip4/127.0.0.1/tcp/${controlPort}`)
+  const controlAddrUndefinedPort = multiaddr('/ip4/127.0.0.1/tcp/0')
 
-  const log = logger(`go-libp2p:${controlPort}`)
+  const log = logger('go-libp2p')
 
   const opts = [
-    `-listen=${apiAddr.toString()}`
+    `-listen=${controlAddrUndefinedPort.toString()}`
   ]
 
   if (options.noListen === true) {
@@ -92,19 +92,30 @@ async function createGoPeer (options: SpawnOptions): Promise<Daemon> {
     opts.push('-muxer=yamux')
   }
 
-  const deferred = pDefer()
+  const deferred = pDefer<void>()
   const proc = execa(p2pd(), opts, {
     env: {
       GOLOG_LOG_LEVEL: 'debug'
     }
   })
 
+  proc.catch(() => {
+    // go-libp2p daemon throws when killed
+  })
+
+  proc.once('exit', code => {
+    deferred.reject(new Error(`go-libp2p daemon exited before startup (code: ${code ?? 'unknown'})`))
+  })
+
+  let controlMultiaddr: Multiaddr | undefined
+
   proc.stdout?.on('data', (buf: Buffer) => {
     const str = buf.toString()
     log(str)
 
-    // daemon has started
-    if (str.includes('Control socket:')) {
+    const match = str.match(/Control socket:\s*(.+)/)
+    if (match != null) {
+      controlMultiaddr = multiaddr(match[1].trim())
       deferred.resolve()
     }
   })
@@ -115,8 +126,12 @@ async function createGoPeer (options: SpawnOptions): Promise<Daemon> {
 
   await deferred.promise
 
+  if (controlMultiaddr == null) {
+    throw new Error('go-libp2p daemon did not report a control socket')
+  }
+
   return {
-    client: createClient(apiAddr),
+    client: createClient(controlMultiaddr),
     stop: async () => {
       proc.kill()
     }