Fix flaky tests (#144)

* Allow LAN connections in relay tests * Add missing error handler * Don't throw in `holepunch()` on client * Tear down relay servers on test end * Remove faulty relay socket check * Bring back relay check * Formatting
holepunchto · Oct 6, 2023 · 62506a7 · 62506a7
1 parent daecd1e
commit 62506a7
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 83 deletions.
diff --git a/lib/connect.js b/lib/connect.js
@@ -682,6 +682,7 @@ function relayConnection (c, relayThrough, payload, hs) {
       onabort(null)
       return
     }
+
     c.relayPaired = true
 
     const {

diff --git a/lib/server.js b/lib/server.js
@@ -545,11 +545,11 @@ module.exports = class Server extends EventEmitter {
           return
         }
 
+        hs.relayPaired = true
+
         if (hs.prepunching) clearTimeout(hs.prepunching)
         hs.prepunching = null
 
-        hs.relayPaired = true
-
         const {
           remotePort,
           remoteHost,

diff --git a/test/connections.js b/test/connections.js
@@ -413,10 +413,12 @@ test('relayed connection', async function (t) {
     socket.end()
   })
 
-  socket.on('open', () => {
-    t.pass('client connected')
-    socket.end()
-  })
+  socket
+    .on('error', () => {})
+    .on('open', () => {
+      t.pass('client connected')
+      socket.end()
+    })
 })
 
 test('relayed connection on same node', async function (t) {

diff --git a/test/relaying.js b/test/relaying.js
@@ -13,7 +13,7 @@ test('relay connections through node, client side', async function (t) {
   const lc = t.test('socket lifecycle')
   lc.plan(5)
 
-  const aServer = a.createServer({ shareLocalAddress: false }, function (socket) {
+  const aServer = a.createServer(function (socket) {
     lc.pass('server socket opened')
     socket
       .on('data', (data) => {
@@ -33,18 +33,17 @@ test('relay connections through node, client side', async function (t) {
     }
   })
 
-  const bServer = b.createServer({ shareLocalAddress: false }, function (socket) {
+  t.teardown(() => relay.close())
+
+  const bServer = b.createServer(function (socket) {
     const session = relay.accept(socket, { id: socket.remotePublicKey })
     session
       .on('error', (err) => t.comment(err.message))
   })
 
   await bServer.listen()
 
-  const aSocket = c.connect(aServer.publicKey, {
-    localConnection: false,
-    relayThrough: bServer.publicKey
-  })
+  const aSocket = c.connect(aServer.publicKey, { relayThrough: bServer.publicKey })
 
   aSocket
     .on('open', () => {
@@ -72,7 +71,7 @@ test('relay connections through node, client side, client aborts hole punch', as
   const lc = t.test('socket lifecycle')
   lc.plan(5)
 
-  const aServer = a.createServer({ shareLocalAddress: false }, function (socket) {
+  const aServer = a.createServer(function (socket) {
     lc.pass('server socket opened')
     socket
       .on('data', (data) => {
@@ -92,20 +91,17 @@ test('relay connections through node, client side, client aborts hole punch', as
     }
   })
 
-  const bServer = b.createServer({ shareLocalAddress: false }, function (socket) {
+  t.teardown(() => relay.close())
+
+  const bServer = b.createServer(function (socket) {
     const session = relay.accept(socket, { id: socket.remotePublicKey })
     session
       .on('error', (err) => t.comment(err.message))
   })
 
   await bServer.listen()
 
-  const aSocket = c.connect(aServer.publicKey, {
-    fastOpen: false,
-    localConnection: false,
-    holepunch: () => false,
-    relayThrough: bServer.publicKey
-  })
+  const aSocket = c.connect(aServer.publicKey, { holepunch: () => false, relayThrough: bServer.publicKey })
 
   aSocket
     .on('open', () => {
@@ -133,7 +129,7 @@ test('relay connections through node, client side, server aborts hole punch', as
   const lc = t.test('socket lifecycle')
   lc.plan(5)
 
-  const aServer = a.createServer({ shareLocalAddress: false, holepunch: () => false }, function (socket) {
+  const aServer = a.createServer({ holepunch: () => false }, function (socket) {
     lc.pass('server socket opened')
     socket
       .on('data', (data) => {
@@ -153,19 +149,17 @@ test('relay connections through node, client side, server aborts hole punch', as
     }
   })
 
-  const bServer = b.createServer({ shareLocalAddress: false }, function (socket) {
+  t.teardown(() => relay.close())
+
+  const bServer = b.createServer(function (socket) {
     const session = relay.accept(socket, { id: socket.remotePublicKey })
     session
       .on('error', (err) => t.comment(err.message))
   })
 
   await bServer.listen()
 
-  const aSocket = c.connect(aServer.publicKey, {
-    fastOpen: false,
-    localConnection: false,
-    relayThrough: bServer.publicKey
-  })
+  const aSocket = c.connect(aServer.publicKey, { relayThrough: bServer.publicKey })
 
   aSocket
     .on('open', () => {
@@ -199,18 +193,17 @@ test('relay connections through node, server side', async function (t) {
     }
   })
 
-  const aServer = a.createServer({ shareLocalAddress: false }, function (socket) {
+  t.teardown(() => relay.close())
+
+  const aServer = a.createServer(function (socket) {
     const session = relay.accept(socket, { id: socket.remotePublicKey })
     session
       .on('error', (err) => t.comment(err.message))
   })
 
   await aServer.listen()
 
-  const bServer = b.createServer({
-    shareLocalAddress: false,
-    relayThrough: aServer.publicKey
-  }, function (socket) {
+  const bServer = b.createServer({ relayThrough: aServer.publicKey }, function (socket) {
     lc.pass('server socket opened')
     socket
       .on('data', (data) => {
@@ -224,9 +217,7 @@ test('relay connections through node, server side', async function (t) {
 
   await bServer.listen()
 
-  const bSocket = c.connect(bServer.publicKey, {
-    localConnection: false
-  })
+  const bSocket = c.connect(bServer.publicKey)
 
   bSocket
     .on('open', () => {
@@ -260,18 +251,17 @@ test('relay connections through node, server side, client aborts hole punch', as
     }
   })
 
-  const aServer = a.createServer({ shareLocalAddress: false }, function (socket) {
+  t.teardown(() => relay.close())
+
+  const aServer = a.createServer(function (socket) {
     const session = relay.accept(socket, { id: socket.remotePublicKey })
     session
       .on('error', (err) => t.comment(err.message))
   })
 
   await aServer.listen()
 
-  const bServer = b.createServer({
-    shareLocalAddress: false,
-    relayThrough: aServer.publicKey
-  }, function (socket) {
+  const bServer = b.createServer({ relayThrough: aServer.publicKey }, function (socket) {
     lc.pass('server socket opened')
     socket
       .on('data', (data) => {
@@ -285,11 +275,7 @@ test('relay connections through node, server side, client aborts hole punch', as
 
   await bServer.listen()
 
-  const bSocket = c.connect(bServer.publicKey, {
-    fastOpen: false,
-    localConnection: false,
-    holepunch: () => false
-  })
+  const bSocket = c.connect(bServer.publicKey, { holepunch: () => false })
 
   bSocket
     .on('open', () => {
@@ -323,19 +309,17 @@ test('relay connections through node, server side, server aborts hole punch', as
     }
   })
 
-  const aServer = a.createServer({ shareLocalAddress: false }, function (socket) {
+  t.teardown(() => relay.close())
+
+  const aServer = a.createServer(function (socket) {
     const session = relay.accept(socket, { id: socket.remotePublicKey })
     session
       .on('error', (err) => t.comment(err.message))
   })
 
   await aServer.listen()
 
-  const bServer = b.createServer({
-    shareLocalAddress: false,
-    holepunch: () => false,
-    relayThrough: aServer.publicKey
-  }, function (socket) {
+  const bServer = b.createServer({ holepunch: () => false, relayThrough: aServer.publicKey }, function (socket) {
     lc.pass('server socket opened')
     socket
       .on('data', (data) => {
@@ -349,10 +333,7 @@ test('relay connections through node, server side, server aborts hole punch', as
 
   await bServer.listen()
 
-  const bSocket = c.connect(bServer.publicKey, {
-    fastOpen: false,
-    localConnection: false
-  })
+  const bSocket = c.connect(bServer.publicKey)
 
   bSocket
     .on('open', () => {
@@ -386,7 +367,9 @@ test('relay connections through node, client and server side', async function (t
     }
   })
 
-  const aServer = a.createServer({ shareLocalAddress: false }, function (socket) {
+  t.teardown(() => relay.close())
+
+  const aServer = a.createServer(function (socket) {
     const session = relay.accept(socket, { id: socket.remotePublicKey })
     session
       .on('error', (err) => t.comment(err.message))
@@ -395,7 +378,6 @@ test('relay connections through node, client and server side', async function (t
   await aServer.listen()
 
   const bServer = b.createServer({
-    shareLocalAddress: false,
     relayThrough: aServer.publicKey
   }, function (socket) {
     lc.pass('server socket opened')
@@ -411,11 +393,7 @@ test('relay connections through node, client and server side', async function (t
 
   await bServer.listen()
 
-  const bSocket = c.connect(bServer.publicKey, {
-    fastOpen: false,
-    localConnection: false,
-    relayThrough: aServer.publicKey
-  })
+  const bSocket = c.connect(bServer.publicKey, { relayThrough: aServer.publicKey })
 
   bSocket
     .on('open', () => {
@@ -443,7 +421,7 @@ test.skip('relay several connections through node with pool', async function (t)
   const lc = t.test('socket lifecycle')
   lc.plan(10)
 
-  const aServer = a.createServer({ shareLocalAddress: false }, function (socket) {
+  const aServer = a.createServer(function (socket) {
     lc.pass('server socket opened')
     socket
       .on('data', (data) => {
@@ -463,7 +441,9 @@ test.skip('relay several connections through node with pool', async function (t)
     }
   })
 
-  const bServer = b.createServer({ shareLocalAddress: false }, function (socket) {
+  t.teardown(() => relay.close())
+
+  const bServer = b.createServer(function (socket) {
     const session = relay.accept(socket, { id: socket.remotePublicKey })
     session
       .on('error', (err) => t.comment(err.message))
@@ -473,12 +453,7 @@ test.skip('relay several connections through node with pool', async function (t)
 
   const pool = c.pool()
 
-  const aSocket = c.connect(aServer.publicKey, {
-    fastOpen: false,
-    localConnection: false,
-    relayThrough: bServer.publicKey,
-    pool
-  })
+  const aSocket = c.connect(aServer.publicKey, { relayThrough: bServer.publicKey, pool })
 
   aSocket
     .on('open', () => {
@@ -487,12 +462,7 @@ test.skip('relay several connections through node with pool', async function (t)
     .on('close', () => {
       lc.pass('1st client socket closed')
 
-      const aSocket = c.connect(aServer.publicKey, {
-        fastOpen: false,
-        localConnection: false,
-        relayThrough: bServer.publicKey,
-        pool
-      })
+      const aSocket = c.connect(aServer.publicKey, { relayThrough: bServer.publicKey, pool })
 
       aSocket
         .on('open', () => {
@@ -522,13 +492,13 @@ test.skip('server does not support connection relaying', async function (t) {
   const lc = t.test('socket lifecycle')
   lc.plan(4)
 
-  const aServer = a.createServer({ shareLocalAddress: false }, function () {
+  const aServer = a.createServer(function () {
     t.fail()
   })
 
   await aServer.listen()
 
-  const bServer = b.createServer({ shareLocalAddress: false }, function (socket) {
+  const bServer = b.createServer(function (socket) {
     lc.pass('server socket opened')
     socket.on('error', () => {
       lc.pass('server socket timed out')
@@ -537,11 +507,7 @@ test.skip('server does not support connection relaying', async function (t) {
 
   await bServer.listen()
 
-  const aSocket = c.connect(aServer.publicKey, {
-    fastOpen: false,
-    localConnection: false,
-    relayThrough: bServer.publicKey
-  })
+  const aSocket = c.connect(aServer.publicKey, { relayThrough: bServer.publicKey })
 
   aSocket.on('error', () => {
     lc.pass('client socket timed out')
-Original file line number
+Diff line change
@@ Expand Up / @@ -682,6 +682,7 @@ function relayConnection (c, relayThrough, payload, hs) { @@
           onabort(null)
           return
         }
         c.relayPaired = true
         const {
@@ Expand Down @@