outdated done.fail callbacks in async tests

Author: dynst

packages/socket/src/queueingstreamingsocket.spec.ts

@@ -15,7 +15,12 @@ describe("QueueingStreamingSocket", () => {
   });
 
   describe("queueRequest", () => {
-    it("can queue and process requests with a connection", (done) => {
+    it("can queue and process requests with a connection", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const socket = new QueueingStreamingSocket(socketServerUrl);
       const requests = ["request 1", "request 2", "request 3"] as const;
@@ -35,9 +40,16 @@ describe("QueueingStreamingSocket", () => {
       requests.forEach((request) => {
         socket.queueRequest(request);
       });
+
+      return ret;
     });
 
-    it("can queue requests without a connection and process them later", (done) => {
+    it("can queue requests without a connection and process them later", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const socket = new QueueingStreamingSocket(socketServerUrl);
       const requests = ["request 1", "request 2", "request 3"] as const;
@@ -60,11 +72,18 @@ describe("QueueingStreamingSocket", () => {
         expect(socket.getQueueLength()).toEqual(3);
         socket.connect();
       }, 5_000);
+
+      return ret;
     });
   });
 
   describe("reconnect", () => {
-    it("does not emit a completed event when disconnected", (done) => {
+    it("does not emit a completed event when disconnected", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const request = "request";
       const socket = new QueueingStreamingSocket(socketServerUrl);
@@ -84,9 +103,16 @@ describe("QueueingStreamingSocket", () => {
       socket.disconnect();
       socket.reconnect();
       socket.queueRequest(request);
+
+      return ret;
     });
 
-    it("can reconnect and process remaining queue", (done) => {
+    it("can reconnect and process remaining queue", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const socket = new QueueingStreamingSocket(socketServerUrl);
       const requests = ["request 1", "request 2", "request 3"] as const;
@@ -110,18 +136,32 @@ describe("QueueingStreamingSocket", () => {
         },
       });
       socket.reconnect();
+
+      return ret;
     });
 
-    it("notifies on reconnection via a callback", (done) => {
+    it("notifies on reconnection via a callback", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const socket = new QueueingStreamingSocket(socketServerUrl, undefined, done);
 
       socket.reconnect();
+
+      return ret;
     });
   });
 
   describe("connectionStatus", () => {
-    it("exposes connection status", (done) => {
+    it("exposes connection status", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const socket = new QueueingStreamingSocket(socketServerUrl);
       let statusChangesSeen = 0;
@@ -160,6 +200,8 @@ describe("QueueingStreamingSocket", () => {
           socket.disconnect();
         }, 1000);
       }, 1000);
+
+      return ret;
     });
   });
 });

packages/socket/src/reconnectingsocket.spec.ts

@@ -20,7 +20,12 @@ describe("ReconnectingSocket", () => {
   });
 
   describe("connect", () => {
-    it("cannot connect after being connected", (done) => {
+    it("cannot connect after being connected", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const socket = new ReconnectingSocket(socketServerUrl);
       // Necessary otherwise the producer doesn’t start
@@ -34,11 +39,18 @@ describe("ReconnectingSocket", () => {
         }).toThrowError(/cannot connect/i);
         done();
       }, 1000);
+
+      return ret;
     });
   });
 
   describe("disconnect", () => {
-    it("ends the events stream", (done) => {
+    it("ends the events stream", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const socket = new ReconnectingSocket(socketServerUrl);
       socket.events.subscribe({
@@ -50,9 +62,16 @@ describe("ReconnectingSocket", () => {
       setTimeout(() => {
         socket.disconnect();
       }, 1000);
+
+      return ret;
     });
 
-    it("cannot connect after being disconnected", (done) => {
+    it("cannot connect after being disconnected", async () => {
+      let done!: (() => void) & { fail: (e?: any) => void };
+      const ret = new Promise<void>((resolve, reject) => {
+        done = resolve as typeof done;
+        done.fail = reject;
+      });
       pendingWithoutSocketServer();
       const socket = new ReconnectingSocket(socketServerUrl);
       // Necessary otherwise the producer doesn’t start
@@ -67,6 +86,8 @@ describe("ReconnectingSocket", () => {
         }).toThrowError(/cannot connect/i);
         done();
       }, 1000);
+
+      return ret;
     });
 
     it("can disconnect without waiting for open", () => {

packages/socket/src/socketwrapper.spec.ts

@@ -16,7 +16,12 @@ describe("SocketWrapper", () => {
     expect(socket).toBeTruthy();
   });
 
-  it("can connect", (done) => {
+  it("can connect", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     const socket = new SocketWrapper(
@@ -34,9 +39,16 @@ describe("SocketWrapper", () => {
     );
     expect(socket).toBeTruthy();
     socket.connect();
+
+    return ret;
   });
 
-  it("fails to connect to non-existing server", (done) => {
+  it("fails to connect to non-existing server", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     const socket = new SocketWrapper(
@@ -57,9 +69,16 @@ describe("SocketWrapper", () => {
     );
     expect(socket).toBeTruthy();
     socket.connect();
+
+    return ret;
   });
 
-  it("fails to connect to non-existing server but timeout is not triggered", (done) => {
+  it("fails to connect to non-existing server but timeout is not triggered", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
     const timeout = 1200; // ms
 
@@ -82,9 +101,16 @@ describe("SocketWrapper", () => {
     );
     expect(socket).toBeTruthy();
     socket.connect();
+
+    return ret;
   });
 
-  it("can connect to slow server", (done) => {
+  it("can connect to slow server", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     const socket = new SocketWrapper(
@@ -102,6 +128,8 @@ describe("SocketWrapper", () => {
     );
     expect(socket).toBeTruthy();
     socket.connect();
+
+    return ret;
   });
 
   it("times out when establishing connection takes too long", async () => {
@@ -134,7 +162,12 @@ describe("SocketWrapper", () => {
       });
   });
 
-  it("can connect and disconnect", (done) => {
+  it("can connect and disconnect", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     let opened = 0;
@@ -160,9 +193,16 @@ describe("SocketWrapper", () => {
       },
     );
     socket.connect();
+
+    return ret;
   });
 
-  it("can disconnect before waiting for open", (done) => {
+  it("can disconnect before waiting for open", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     const socket = new SocketWrapper(
@@ -184,9 +224,16 @@ describe("SocketWrapper", () => {
     );
     socket.connect();
     socket.disconnect();
+
+    return ret;
   });
 
-  it("can disconnect before waiting for open and timeout will not be triggered", (done) => {
+  it("can disconnect before waiting for open and timeout will not be triggered", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
     const timeout = 500; // ms
 
@@ -212,9 +259,16 @@ describe("SocketWrapper", () => {
     );
     socket.connect();
     socket.disconnect();
+
+    return ret;
   });
 
-  it("can send events when connected", (done) => {
+  it("can send events when connected", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     const responseMessages = new Array<string>();
@@ -243,9 +297,16 @@ describe("SocketWrapper", () => {
       },
     );
     socket.connect();
+
+    return ret;
   });
 
-  it("can send events after timeout period", (done) => {
+  it("can send events after timeout period", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     // The "timeout period" is the period in which a timeout could potentially be triggered
@@ -271,9 +332,16 @@ describe("SocketWrapper", () => {
     socket.connect();
 
     setTimeout(() => socket.send("Hello world"), 2 * timeoutPeriodLength);
+
+    return ret;
   });
 
-  it("cannot send on a disconnect socket (it will never come back)", (done) => {
+  it("cannot send on a disconnect socket (it will never come back)", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     const socket = new SocketWrapper(
@@ -300,5 +368,7 @@ describe("SocketWrapper", () => {
       },
     );
     socket.connect();
+
+    return ret;
   });
 });

packages/socket/src/streamingsocket.spec.ts

@@ -76,7 +76,12 @@ describe("StreamingSocket", () => {
     socket.disconnect();
   });
 
-  it("completes stream when disconnected", (done) => {
+  it("completes stream when disconnected", async () => {
+    let done!: (() => void) & { fail: (e?: any) => void };
+    const ret = new Promise<void>((resolve, reject) => {
+      done = resolve as typeof done;
+      done.fail = reject;
+    });
     pendingWithoutSocketServer();
 
     const socket = new StreamingSocket(socketServerUrl);
@@ -96,5 +101,7 @@ describe("StreamingSocket", () => {
       await socket.send("lalala");
       socket.disconnect();
     })().catch(done.fail);
+
+    return ret;
   });
 });

packages/stargate/src/stargateclient.spec.ts

@@ -98,7 +98,7 @@ describe("StargateClient", () => {
       pendingWithoutSimapp();
       const client = await StargateClient.connect(simapp.tendermintUrlHttp);
       const openedClient = client as unknown as PrivateStargateClient;
-      const getCodeSpy = spyOn(openedClient.cometClient!, "status").and.callThrough();
+      const getCodeSpy = spyOn(openedClient.cometClient, "status").and.callThrough();
 
       expect(await client.getChainId()).toEqual(simapp.chainId); // from network
       expect(await client.getChainId()).toEqual(simapp.chainId); // from cache