feat: add process.exit (#542)

* feat: add process.exit Allows ending and failing run with process.exit(0) or process.exit(233).
hugomrdias · May 12, 2023 · 2685431 · 2685431
1 parent b71bf98
commit 2685431
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 51 deletions.
diff --git a/mocks/test.mocha.js b/mocks/test.mocha.js
@@ -7,6 +7,7 @@ const { good, bad } = require('./lib')
 describe('Array', () => {
   describe('#indexOf()', () => {
     it('should return -1 when the value is not present', () => {
+      console.log(process)
       is([1, 2, 3].indexOf(4), -1)
     })
 

diff --git a/mocks/tinybench2.js b/mocks/tinybench2.js
@@ -2,23 +2,20 @@ import { Bench } from 'tinybench'
 
 const bench = new Bench({ time: 100 })
 
-bench
-  .add('switch 1', () => {
-    let a = 1
-    let b = 2
-    const c = a
-    a = b
-    b = c
-  })
-  .add('switch 2', () => {
-    let a = 1
-    let b = 10
-    a = b + a
-    b = a - b
-    a = b - a
-  })
+async function run() {
+  bench
+    .add('faster task', () => {
+      console.log('I am faster')
+    })
+    .add('slower task', async () => {
+      await new Promise((r) => setTimeout(r, 500)) // we wait 1ms :)
+      console.log('I am slower')
+    })
 
-await bench.run()
+  await bench.run()
+}
+
+await run()
 
 console.table(
   bench.tasks.map(({ name, result }) => ({
@@ -28,10 +25,4 @@ console.table(
   }))
 )
 
-// Output:
-// ┌─────────┬────────────┬────────────────────┬────────────────────┐
-// │ (index) │ Task Name  │ Average Time (ps)  │   Variance (ps)    │
-// ├─────────┼────────────┼────────────────────┼────────────────────┤
-// │    0    │ 'switch 1' │ 1.8458325710527104 │ 1.2113875253341617 │
-// │    1    │ 'switch 2' │ 1.8746935152109603 │ 1.2254725890767446 │
-// └─────────┴────────────┴────────────────────┴────────────────────┘
+process.exit(0)
diff --git a/readme.md b/readme.md
@@ -76,6 +76,17 @@ Description
     $ playwright-test test/** BAD
 ```
 
+## Flow control
+
+All test runners support automatic flow control, which means you don't need to call special function or trigger any event in your tests to stop the run. The `none` runner does not support flow control.
+
+To manually stop the run you can use `process.exit`:
+
+```js
+process.exit(0) // stops the run and exits with success
+process.exit(1) // stops the run and exits with failure
+```
+
 ## Config
 
 > The config file needs to be commonjs for now, so if your package is pure ESM you need to use `.cjs` extension.

diff --git a/src/runner.js b/src/runner.js
@@ -292,35 +292,30 @@ export class Runner {
 
       // run tests
       if (!this.options.debug) {
-        if (this.type === 'none') {
-          // exit
-          await this.stop(false)
-        } else {
-          // wait for the tests
-          await page.waitForFunction(
-            // @ts-ignore
-            () => self.PW_TEST.ended === true,
-            undefined,
-            {
-              timeout: 0,
-              polling: 100, // need to be polling raf doesnt work in extensions
-            }
-          )
-          const testsFailed = await page.evaluate('self.PW_TEST.failed')
-
-          // coverage
-          if (this.options.cov && page.coverage) {
-            await createCov(
-              this,
-              await page.coverage.stopJSCoverage(),
-              outName,
-              this.options.reportDir
-            )
+        // wait for the tests
+        await page.waitForFunction(
+          // @ts-ignore
+          () => self.PW_TEST.ended === true,
+          undefined,
+          {
+            timeout: 0,
+            polling: 100, // need to be polling raf doesnt work in extensions
           }
-
-          // exit
-          await this.stop(testsFailed)
+        )
+        const testsFailed = await page.evaluate('self.PW_TEST.failed')
+
+        // coverage
+        if (this.options.cov && page.coverage) {
+          await createCov(
+            this,
+            await page.coverage.stopJSCoverage(),
+            outName,
+            this.options.reportDir
+          )
         }
+
+        // exit
+        await this.stop(testsFailed)
       }
     } catch (/** @type {any} */ error) {
       spinner.fail('Running tests failed.')

diff --git a/src/utils/inject-process.js b/src/utils/inject-process.js
@@ -1,3 +1,17 @@
 // @ts-nocheck
-export { default as process } from 'process/browser'
+// eslint-disable-next-line unicorn/prefer-module
+const _process = require('process/browser')
+
+const p = {
+  ..._process,
+  exit: (code = 0) => {
+    if (code === 0) {
+      globalThis.PW_TEST.end(false)
+    } else {
+      globalThis.PW_TEST.end(true)
+    }
+  },
+}
+
+export const process = p
 // https://github.com/ionic-team/rollup-plugin-node-polyfills