Merge pull request #1729 from dynst/socket-test

Modernize child_process import in reconnecting socket test

Author: webmaster128

packages/socket/src/reconnectingsocket.spec.ts

@@ -1,34 +1,16 @@
-import assert from "assert";
-
 import { ReconnectingSocket } from "./reconnectingsocket";
 
 /** @see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback */
-type Exec = (command: string, callback: (error: null | (Error & { readonly code: number })) => void) => void;
-
-let exec: Exec | undefined;
-let childProcessAvailable: boolean;
-
-try {
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  exec = require("child_process").exec;
-  assert.strict(typeof exec === "function");
-  childProcessAvailable = true;
-} catch {
-  childProcessAvailable = false;
-}
+type Exec = (command: string, callback: (error: null | (Error & { readonly code?: number })) => void) => void;
+
+const getExec = async (): Promise<Exec | undefined> => (await import("child_process")).exec;
 
 function pendingWithoutSocketServer(): void {
   if (!process.env.SOCKETSERVER_ENABLED) {
     pending("Set SOCKETSERVER_ENABLED to enable socket tests");
   }
 }
 
-function pendingWithoutChildProcess(): void {
-  if (!childProcessAvailable) {
-    pending("Run test in an environment which supports child processes to enable socket tests");
-  }
-}
-
 describe("ReconnectingSocket", () => {
   const socketServerUrl = "ws://localhost:4444/websocket";
 
@@ -97,13 +79,24 @@ describe("ReconnectingSocket", () => {
     const startServerCmd = `${dirPath}/start.sh`;
     const stopServerCmd = `${dirPath}/stop.sh`;
 
-    it("automatically reconnects if no connection can be established at init", (done) => {
-      pendingWithoutChildProcess();
+    it("automatically reconnects if no connection can be established at init", async () => {
+      let pass!: () => void, fail!: (reason?: any) => void;
+      const ret = new Promise<void>((resolve, reject) => {
+        pass = resolve;
+        fail = reject;
+      });
+
+      const exec = await getExec();
+      if (exec === undefined) {
+        pending("Run test in an environment which supports child processes to enable socket tests");
+        return;
+      }
+
       pendingWithoutSocketServer();
 
-      exec!(stopServerCmd, (stopError) => {
+      exec(stopServerCmd, (stopError) => {
         if (stopError && stopError.code !== codePkillNoProcessesMatched) {
-          done.fail(stopError);
+          fail(stopError);
         }
 
         const socket = new ReconnectingSocket(socketServerUrl);
@@ -119,7 +112,7 @@ describe("ReconnectingSocket", () => {
           complete: () => {
             // Make sure we don't get a completion unexpectedly
             expect(eventsSeen).toEqual(requests.length);
-            done();
+            pass();
           },
         });
 
@@ -128,18 +121,31 @@ describe("ReconnectingSocket", () => {
 
         setTimeout(
           () =>
-            exec!(startServerCmd, (startError) => {
+            exec(startServerCmd, (startError) => {
               if (startError) {
-                done.fail(startError);
+                fail(startError);
               }
             }),
           2000,
         );
       });
+
+      return ret;
     });
 
-    it("automatically reconnects if the connection is broken off", (done) => {
-      pendingWithoutChildProcess();
+    it("automatically reconnects if the connection is broken off", async () => {
+      let pass!: () => void, fail!: (reason?: any) => void;
+      const ret = new Promise<void>((resolve, reject) => {
+        pass = resolve;
+        fail = reject;
+      });
+
+      const exec = await getExec();
+      if (exec === undefined) {
+        pending("Run test in an environment which supports child processes to enable socket tests");
+        return;
+      }
+
       pendingWithoutSocketServer();
 
       const socket = new ReconnectingSocket(socketServerUrl);
@@ -155,7 +161,7 @@ describe("ReconnectingSocket", () => {
         complete: () => {
           // Make sure we don't get a completion unexpectedly
           expect(eventsSeen).toEqual(requests.length);
-          done();
+          pass();
         },
       });
 
@@ -164,9 +170,9 @@ describe("ReconnectingSocket", () => {
 
       setTimeout(
         () =>
-          exec!(stopServerCmd, (stopError) => {
+          exec(stopServerCmd, (stopError) => {
             if (stopError && stopError.code !== codePkillNoProcessesMatched) {
-              done.fail(stopError);
+              fail(stopError);
             }
 
             // TODO: This timeout is here to avoid an edge case where if a request
@@ -179,9 +185,9 @@ describe("ReconnectingSocket", () => {
 
               setTimeout(
                 () =>
-                  exec!(startServerCmd, (startError) => {
+                  exec(startServerCmd, (startError) => {
                     if (startError) {
-                      done.fail(startError);
+                      fail(startError);
                     }
                   }),
                 2000,
@@ -190,6 +196,8 @@ describe("ReconnectingSocket", () => {
           }),
         1000,
       );
+
+      return ret;
     });
   });
 });