chore: add rate limiting to CI (#755)

.github/workflows/workflow.yml

@@ -41,6 +41,8 @@ jobs:
         if: "${{ matrix.node-version == '*' }}"
       - name: Tests
         run: npm run test:ci
+        env:
+          ZISI_TEST_RATE_LIMIT: 3
       - name: Get test coverage flags
         id: test-coverage-flags
         run: |-

package.json

@@ -111,6 +111,7 @@
     "nyc": "^15.0.0",
     "sinon": "^11.1.1",
     "sort-on": "^4.1.1",
+    "throat": "^6.0.1",
     "typescript": "^4.4.3"
   },
   "engines": {

tests/helpers/test_many.js

@@ -1,4 +1,16 @@
-const { env, platform } = require('process')
+const { env } = require('process')
+
+const throat = require('throat')
+
+const getRateLimitedTestFunction = (originalTestFunction) => {
+  const rateLimit = Number.parseInt(env.ZISI_TEST_RATE_LIMIT)
+
+  if (Number.isNaN(rateLimit)) {
+    return originalTestFunction
+  }
+
+  return throat(rateLimit, originalTestFunction)
+}
 
 /**
  * @template M, O
@@ -18,12 +30,10 @@ const makeTestMany = (test, matrix) => {
 
       // Weird workaround to avoid running too many tests in parallel on
       // Windows, which causes problems in the CI.
-      const isSerial = variationNames.length >= 3 && platform === 'win32'
-      const testFunction = isSerial ? testFn.serial : testFn
       const testTitle = `${title} [${name}]`
 
       if (name.startsWith('todo:')) {
-        testFunction.todo(testTitle)
+        testFn.todo(testTitle)
 
         return
       }
@@ -34,7 +44,9 @@ const makeTestMany = (test, matrix) => {
         throw new Error(`Unknown variation in test: ${name}`)
       }
 
-      testFunction(testTitle, assertions.bind(null, variation))
+      const rateLimitedTestFn = getRateLimitedTestFunction(testFn)
+
+      rateLimitedTestFn(testTitle, assertions.bind(null, variation))
     })
   }