From dee20f0dbffd659b7c35aa14d102e14f8c16ad30 Mon Sep 17 00:00:00 2001
From: Ganesh Pawar <pawarg256@gmail.com>
Date: Wed, 4 Aug 2021 21:49:54 +0530
Subject: [PATCH] node_tests: Run node tests in parallel.

Fixes #9471.
---
 .github/workflows/zulip-ci.yml |  2 +-
 tools/test-js-with-node        | 43 ++++++++++++++++++++++++++++++----
 2 files changed, 40 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/zulip-ci.yml b/.github/workflows/zulip-ci.yml
index 93c853cc15..b8045b7e77 100644
--- a/.github/workflows/zulip-ci.yml
+++ b/.github/workflows/zulip-ci.yml
@@ -171,7 +171,7 @@ jobs:
         run: |
           source tools/ci/activate-venv
           # Run the node tests first, since they're fast and deterministic
-          ./tools/test-js-with-node --coverage
+          ./tools/test-js-with-node --coverage --parallel=1
 
       - name: Check schemas
         if: ${{ matrix.include_frontend_tests }}
diff --git a/tools/test-js-with-node b/tools/test-js-with-node
index 4098500fa5..4f18bb3ed7 100755
--- a/tools/test-js-with-node
+++ b/tools/test-js-with-node
@@ -192,8 +192,27 @@ parser = argparse.ArgumentParser(USAGE)
 parser.add_argument("--coverage", action="store_true", help="Get coverage report")
 add_provision_check_override_param(parser)
 parser.add_argument("args", nargs=argparse.REMAINDER)
+parser.add_argument(
+    "--parallel",
+    dest="parallel",
+    action="store",
+    type=int,
+    # Since process startup time is a significant portion of total
+    # runtime, so rather than doing os.cpu_count, we just do a fixed 4
+    # processes by default.
+    default=4,
+    help="Specify the number of processes to run the "
+    "tests in. Default is the number of logical CPUs",
+)
 options = parser.parse_args()
 individual_files = options.args
+parallel = options.parallel
+
+if options.coverage and parallel > 1:
+    parallel = 1
+    print(
+        BOLDRED + "You cannot use --coverage with parallel tests. Running in serial mode.\n" + ENDC
+    )
 
 assert_provisioning_status_ok(options.skip_provision_check)
 
@@ -253,11 +272,30 @@ def run_tests_via_node_js() -> int:
     # after making sure tests will pass.
     node_tests_cmd = ["node", "--stack-trace-limit=100", INDEX_JS]
     if individual_files:
+        # If we passed a specific set of tests, run in serial mode.
+        global parallel
+        parallel = 1
         files = individual_files
     else:
         files = sorted(glob.glob(os.path.join(ROOT_DIR, "frontend_tests/node_tests/*.js")))
 
-    node_tests_cmd += clean_files(files)
+    test_files = clean_files(files)
+
+    print("Starting node tests...")
+
+    # If we got this far, we can run the tests!
+    ret = 0
+    if parallel > 1:
+        sub_tests = [test_files[i::parallel] for i in range(parallel)]
+        parallel_processes = [subprocess.Popen(node_tests_cmd + sub_test) for sub_test in sub_tests]
+
+        for process in parallel_processes:
+            status_code = process.wait()
+            if status_code != 0:
+                ret = status_code
+        return ret
+
+    node_tests_cmd += test_files
     if options.coverage:
         coverage_dir = os.path.join(ROOT_DIR, "var/node-coverage")
 
@@ -272,9 +310,6 @@ def run_tests_via_node_js() -> int:
         # Run the index.js test runner, which runs all the other tests.
         command = node_tests_cmd
 
-    print("Starting node tests...")
-
-    # If we got this far, we can run the tests!
     try:
         ret = subprocess.check_call(command)
     except OSError: