supertape 10.2.2 → 10.3.0

package/ChangeLog

@@ -1,3 +1,8 @@
+2024.03.01, v10.3.0
+
+feature:
+- 4aeb021 supertape: add per-test timeout option (#9)
+
 2024.02.29, v10.2.2
 
 fix:

package/README.md

@@ -38,6 +38,24 @@
 
 For a list of all built-in assertions, see [Operators](#operators).
 
+## How 📼**Supertape** test looks like?
+
+You can use both **CommonJS** and **ESM**, here is **ESM** example:
+
+```js
+import {test} from 'supertape';
+
+const sump = (a, b) => a + b;
+
+test('calc: sum', (t) => {
+    const result = sum(1, 2);
+    const expected = 3;
+    
+    t.equal(result, expected);
+    t.end();
+});
+```
+
 ## Install
 
 ```
@@ -61,7 +79,7 @@ Options
 
 ## Environment variables
 
-- `SUPERTAPE_TIMEOUT` - timeout for long running processes;
+- `SUPERTAPE_TIMEOUT` - timeout for long running processes, defaults to `3000` (3 seconds);
 - `SUPERTAPE_CHECK_DUPLICATES` - toggle check duplicates;
 - `SUPERTAPE_CHECK_SCOPES` - check that test message has a scope: `scope: subject`;
 - `SUPERTAPE_CHECK_ASSERTIONS_COUNT` - check that assertion count is no more then 1;
@@ -179,55 +197,30 @@ There is a list of built-int `formatters` to customize output:
 
 ## API
 
-### Methods
-
-The assertion methods in `supertape` are heavily influenced by [tape](https://github.com/substack/tape).
-
-```js
-const test = require('supertape');
-const {sum} = require('./calc.js');
-
-test('calc: sum', (t) => {
-    const result = sum(1, 2);
-    const expected = 3;
-    
-    t.equal(result, expected);
-    t.end();
-});
-```
-
-or in `ESM`:
-
-```js
-import {test} from 'supertape';
-import {sum} from './calc.js';
+### test(message: string, fn: (t: Test) => void, options?: TestOptions)
 
-test('calc: sum', (t) => {
-    const result = sum(1, 2);
-    const expected = 3;
-    
-    t.equal(result, expected);
-    t.end();
-});
-```
+Create a new test with `message` string.
+`fn(t)` fires with the new test object `t` once all preceding tests have
+finished. Tests execute serially.
 
-## test(name, cb)
+Here is Possible `options` similar to [Environment Variables](#environment-variables) but relates to one test:
 
-Create a new test with `name` string.
-`cb(t)` fires with the new test object `t` once all preceding tests have
-finished. Tests execute serially.
+- `checkDuplicates`;
+- `checkScopes`;-
+- `checkAssertionsCount`;
+- `timeout`;
 
-## test.only(name, cb)
+### test.only(message, fn, options?)
 
 Like `test(name, cb)` except if you use `.only` this is the only test case
 that will run for the entire process, all other test cases using `tape` will
 be ignored.
 
-## test.skip(name, cb)
+### test.skip(message, fn, options?)
 
 Generate a new test that will be skipped over.
 
-## test.extend(extensions)
+### test.extend(extensions)
 
 Extend base assertions with more:
 

package/bin/communication.mjs

@@ -1,8 +1,8 @@
+import {EventEmitter} from 'node:events';
 import {
     parentPort,
     workerData,
 } from 'node:worker_threads';
-import {EventEmitter} from 'node:events';
 
 const {assign} = Object;
 

package/lib/run-tests.js

@@ -1,6 +1,5 @@
 'use strict';
 
-const process = require('process');
 const fullstore = require('fullstore');
 const wraptile = require('wraptile');
 const tryToCatch = require('try-to-catch');
@@ -15,10 +14,9 @@ const notSkip = ({skip}) => !skip;
 
 const getInitOperators = async () => await import('./operators.mjs');
 
-const {SUPERTAPE_TIMEOUT = 3000} = process.env;
 const DEBUG_TIME = 3000 * 1000;
 
-const timeout = (time, value) => {
+const doTimeout = (time, value) => {
     let stop;
     
     if (isDebug)
@@ -73,7 +71,7 @@ async function runTests(tests, {formatter, operators, skiped, isStop}) {
         tests,
     });
     
-    for (const {fn, message, extensions, at, validations} of tests) {
+    for (const {fn, message, timeout, extensions, at, validations} of tests) {
         if (wasStop())
             break;
         
@@ -95,6 +93,7 @@ async function runTests(tests, {formatter, operators, skiped, isStop}) {
             incPassed,
             getValidationMessage,
             validations,
+            timeout,
             
             extensions: {
                 ...operators,
@@ -118,7 +117,24 @@ async function runTests(tests, {formatter, operators, skiped, isStop}) {
     };
 }
 
-async function runOneTest({message, at, fn, extensions, formatter, count, total, failed, incCount, incPassed, incFailed, getValidationMessage, validations}) {
+async function runOneTest(options) {
+    const {
+        message,
+        at,
+        fn,
+        extensions,
+        formatter,
+        count,
+        total,
+        failed,
+        incCount,
+        incPassed,
+        incFailed,
+        getValidationMessage,
+        validations,
+        timeout,
+    } = options;
+    
     const isReturn = fullstore(false);
     const assertionsCount = fullstore(0);
     const isEnded = fullstore(false);
@@ -145,7 +161,7 @@ async function runOneTest({message, at, fn, extensions, formatter, count, total,
     });
     
     if (!isReturn()) {
-        const [timer, stopTimer] = timeout(SUPERTAPE_TIMEOUT, ['timeout']);
+        const [timer, stopTimer] = doTimeout(timeout, ['timeout']);
         const [error] = await Promise.race([tryToCatch(fn, t), timer]);
         
         stopTimer();

package/lib/supertape.d.ts

@@ -34,6 +34,7 @@ type TestOptions = {
     checkAssertionsCount?: boolean;
     checkScopes?: boolean;
     checkDuplicates?: boolean;
+    timeout?: number;
 };
 
 declare function test(message: string, fn: (t: Test) => void, options?: TestOptions): void;

package/lib/supertape.js

@@ -20,7 +20,10 @@ const {assign} = Object;
 const {stdout} = process;
 
 // 5ms ought to be enough for anybody
-const {SUPERTAPE_LOAD_LOOP_TIMEOUT = 5} = process.env;
+const {
+    SUPERTAPE_LOAD_LOOP_TIMEOUT = 5,
+    SUPERTAPE_TIMEOUT = 3000,
+} = process.env;
 
 let mainEmitter;
 
@@ -44,13 +47,14 @@ const defaultOptions = {
     checkIfEnded: true,
     checkAssertionsCount: true,
     checkScopes: true,
+    timeout: SUPERTAPE_TIMEOUT,
 };
 
 function _createEmitter({quiet, stream = stdout, format, getOperators, isStop, readyFormatter, workerFormatter}) {
     const tests = [];
     const emitter = new EventEmitter();
     
-    emitter.on('test', (message, fn, {skip, only, extensions, at, validations}) => {
+    emitter.on('test', (message, fn, {skip, only, extensions, at, validations, timeout}) => {
         tests.push({
             message,
             fn,
@@ -59,6 +63,7 @@ function _createEmitter({quiet, stream = stdout, format, getOperators, isStop, r
             extensions,
             at,
             validations,
+            timeout,
         });
     });
     
@@ -154,6 +159,7 @@ function test(message, fn, options = {}) {
         checkAssertionsCount,
         checkIfEnded,
         workerFormatter,
+        timeout,
     } = {
         ...defaultOptions,
         ...initedOptions,
@@ -186,6 +192,7 @@ function test(message, fn, options = {}) {
         extensions,
         at,
         validations,
+        timeout,
     });
     
     if (run)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "supertape",
-  "version": "10.2.2",
+  "version": "10.3.0",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "📼 Supertape simplest high speed test runner with superpowers",
   "homepage": "http://github.com/coderaiser/supertape",