@t09tanaka/test-gates 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.3.1
+
+### Changed
+
+- `createStrykerGatesConfig` sets Stryker's `timeoutMS` to 30000 unless the project passes its own (Stryker's default is 5000). With `maxTimeouts` at 0 since 0.3.0, a mutant that would be killed but ran out of time fails the run. That happened on every full run in two projects with mutants that really never end: after each of them Stryker starts a new test runner, and the next mutant timed out while it was starting. A full run takes longer by up to 25 seconds for each mutant that hangs without tripping Stryker's loop counter.
+
 ## 0.3.0
 
 Three defaults move to the strict side. A project that passed with 0.2.0 can fail with 0.3.0 without any change of its own; each case below says what to do.

package/README.md

@@ -280,6 +280,8 @@ How an `expectedTimeouts` entry is judged:
 
 When the run fails on a timeout, first run again with less load (`npm run test:gates:mutation -- --concurrency 1`). Add an entry only for a mutant that can never finish.
 
+`createStrykerGatesConfig` sets Stryker's `timeoutMS` to 30000 (since 0.3.1; Stryker's own default is 5000). After a mutant that really never ends, Stryker starts a new test runner, and with 5000 the mutant that comes next can run out of time while that runner is still starting: in one project with 11 such mutants, 2 to 7 others timed out on every full run, a different set each time, and none in a run with 30000. A longer limit hides nothing, because a timeout that is not listed fails the run anyway. The price is the wait for each mutant that hangs without tripping Stryker's loop counter. Pass `timeoutMS` to the helper to change it.
+
 ### `test-gates selfcheck [--all | --first] [-- <gate command>]`
 
 Negative control. For each gate, runs the gate with that gate's spec left out and requires the run to **fail on the coverage threshold of that very file**. A gate that stays green without its spec measures nothing; a run that fails for another reason (a config that does not load) proves nothing either.
@@ -460,6 +462,7 @@ Why these choices:
 - Jest measures with istanbul (`babel`), because the v8 provider does not count the untaken side of an `if` without `else`.
 - Jest fails on a `coverageThreshold` path key that matches no file, so a typo in `test-gates.json` cannot pass. Vitest does the opposite: a glob or path key in `thresholds` that matches nothing passes. The Vitest helper therefore narrows `coverage.include` to the gates and uses `perFile`.
 - Stryker never fails on its own score (`break: null`). The verdict comes from `test-gates mutation`, which knows the allow list.
+- The Stryker helper also sets defaults that can be overridden: `coverageAnalysis: 'perTest'`, `incremental` with its file under `reports/`, and `timeoutMS: 30000` (see [Timeouts](#timeouts)).
 
 `loadGates(dir)` returns the validated manifest: `gates` (each with its resolved `spec`), `candidates` and the resolved `settings`. It throws when the manifest has any problem.
 

package/dist/stryker.cjs

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/stryker.ts
 var stryker_exports = {};
 __export(stryker_exports, {
+  DEFAULT_TIMEOUT_MS: () => DEFAULT_TIMEOUT_MS,
   createStrykerGatesConfig: () => createStrykerGatesConfig
 });
 module.exports = __toCommonJS(stryker_exports);
@@ -601,6 +602,7 @@ function resolveRootDir(rootDir) {
 
 // src/stryker.ts
 var WEAKENING_OPTIONS = ["ignoreStatic", "ignorers"];
+var DEFAULT_TIMEOUT_MS = 3e4;
 function createStrykerGatesConfig(options = {}) {
   const { rootDir: rootDirOption, ...overrides } = options;
   for (const option of WEAKENING_OPTIONS) {
@@ -625,6 +627,7 @@ function createStrykerGatesConfig(options = {}) {
     incremental: true,
     incrementalFile: "reports/stryker-incremental.json",
     tempDirName: ".stryker-tmp",
+    timeoutMS: DEFAULT_TIMEOUT_MS,
     clearTextReporter: { logTests: false, reportTests: false },
     ...overrides,
     mutate: manifest.gates.map((gate) => gate.path),
@@ -635,5 +638,6 @@ function createStrykerGatesConfig(options = {}) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DEFAULT_TIMEOUT_MS,
   createStrykerGatesConfig
 });

package/dist/stryker.d.cts

@@ -4,6 +4,12 @@ interface StrykerGatesOptions {
     /** Any other Stryker option: testRunner, jest / vitest, concurrency, ignorePatterns, … */
     [option: string]: unknown;
 }
+/**
+ * Stryker's own default is 5000. After a mutant that really never ends, Stryker starts a new
+ * test runner, and the next mutant then pays that start-up inside its time limit: with 5000 a
+ * mutant that would be killed is reported as `Timeout`, which fails the run since 0.3.0.
+ */
+declare const DEFAULT_TIMEOUT_MS = 30000;
 /**
  * Stryker config for the gates: mutate exactly the gates, never fail on the score
  * (`thresholds.break: null`), and write the JSON report that `test-gates mutation` judges.
@@ -13,4 +19,4 @@ interface StrykerGatesOptions {
  */
 declare function createStrykerGatesConfig(options?: StrykerGatesOptions): Record<string, unknown>;
 
-export { type StrykerGatesOptions, createStrykerGatesConfig };
+export { DEFAULT_TIMEOUT_MS, type StrykerGatesOptions, createStrykerGatesConfig };

package/dist/stryker.d.ts

@@ -4,6 +4,12 @@ interface StrykerGatesOptions {
     /** Any other Stryker option: testRunner, jest / vitest, concurrency, ignorePatterns, … */
     [option: string]: unknown;
 }
+/**
+ * Stryker's own default is 5000. After a mutant that really never ends, Stryker starts a new
+ * test runner, and the next mutant then pays that start-up inside its time limit: with 5000 a
+ * mutant that would be killed is reported as `Timeout`, which fails the run since 0.3.0.
+ */
+declare const DEFAULT_TIMEOUT_MS = 30000;
 /**
  * Stryker config for the gates: mutate exactly the gates, never fail on the score
  * (`thresholds.break: null`), and write the JSON report that `test-gates mutation` judges.
@@ -13,4 +19,4 @@ interface StrykerGatesOptions {
  */
 declare function createStrykerGatesConfig(options?: StrykerGatesOptions): Record<string, unknown>;
 
-export { type StrykerGatesOptions, createStrykerGatesConfig };
+export { DEFAULT_TIMEOUT_MS, type StrykerGatesOptions, createStrykerGatesConfig };

package/dist/stryker.js

@@ -7,6 +7,7 @@ import {
 
 // src/stryker.ts
 var WEAKENING_OPTIONS = ["ignoreStatic", "ignorers"];
+var DEFAULT_TIMEOUT_MS = 3e4;
 function createStrykerGatesConfig(options = {}) {
   const { rootDir: rootDirOption, ...overrides } = options;
   for (const option of WEAKENING_OPTIONS) {
@@ -31,6 +32,7 @@ function createStrykerGatesConfig(options = {}) {
     incremental: true,
     incrementalFile: "reports/stryker-incremental.json",
     tempDirName: ".stryker-tmp",
+    timeoutMS: DEFAULT_TIMEOUT_MS,
     clearTextReporter: { logTests: false, reportTests: false },
     ...overrides,
     mutate: manifest.gates.map((gate) => gate.path),
@@ -40,5 +42,6 @@ function createStrykerGatesConfig(options = {}) {
   };
 }
 export {
+  DEFAULT_TIMEOUT_MS,
   createStrykerGatesConfig
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t09tanaka/test-gates",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Test gates for the code that must not be wrong: per-file 100% coverage as the floor, mutation testing with a per-mutant allow list as the real check.",
   "author": "t09tanaka",
   "license": "MIT",