@lenne.tech/nest-server 11.27.3 → 11.27.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/FRAMEWORK-API.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @lenne.tech/nest-server — Framework API Reference
2
2
 
3
- > Auto-generated from source code on 2026-07-03 (v11.27.3)
3
+ > Auto-generated from source code on 2026-07-04 (v11.27.4)
4
4
  > File: `FRAMEWORK-API.md` — compact, machine-readable API surface for Claude Code
5
5
 
6
6
  ## CoreModule.forRoot()
@@ -0,0 +1,236 @@
1
+ # Migration Guide: 11.27.3 → 11.27.4
2
+
3
+ ## Overview
4
+
5
+ | Category | Details |
6
+ |----------|---------|
7
+ | **Breaking Changes** | None |
8
+ | **New Features** | Opt-in `CHECK_LOW_RESOURCE` e2e mode (keeps parallel test runs stable under load); `check.mjs` now labels signal-killed steps (`SIGTERM`/`SIGKILL`) instead of showing a bare exit code. |
9
+ | **Bugfixes** | Idle watchdog no longer false-kills output-buffering steps (build / typecheck / audit); a stray `SIGKILL` after PID reuse is prevented; an invalid `--idle-timeout` value now falls back to the default instead of silently disabling the watchdog. |
10
+ | **Migration Effort** | 0 minutes for npm consumers (`pnpm update` is enough). Optional: projects that copied `scripts/check.mjs` / `vitest-e2e.config.ts` from the starter can adopt the updated files. |
11
+
12
+ This is a **repo-internal tooling & test-infrastructure release**. It touches
13
+ **no framework source** (`src/` is unchanged) — only `scripts/check.mjs` and
14
+ `vitest-e2e.config.ts`. The npm package (`dist/`) is functionally identical to
15
+ 11.27.3; consuming projects need no code or config changes.
16
+
17
+ ---
18
+
19
+ ## Quick Migration
20
+
21
+ No code changes required.
22
+
23
+ ```bash
24
+ # Update package
25
+ pnpm add @lenne.tech/nest-server@11.27.4
26
+
27
+ # Verify build
28
+ pnpm run build
29
+
30
+ # Run tests
31
+ pnpm test
32
+ ```
33
+
34
+ > These files ship in the git repository / starter, **not** in the npm package.
35
+ > An npm-mode consumer is unaffected. A project that copied `scripts/check.mjs`
36
+ > and/or `vitest-e2e.config.ts` from the starter (11.27.1+) can copy the updated
37
+ > versions to get the improvements below — see **Compatibility Notes**.
38
+
39
+ ---
40
+
41
+ ## What's New in 11.27.4
42
+
43
+ ### 1. Opt-in low-resource e2e mode (`CHECK_LOW_RESOURCE`)
44
+
45
+ Running several full e2e suites at the same time on one machine (e.g. multiple
46
+ parallel `lt dev` / `lt ticket` environments, or a second terminal) can saturate
47
+ CPU and the shared MongoDB. Under that load individual requests exceed the 30s
48
+ `testTimeout` and auth queries fail — surfacing as intermittent `401`s or
49
+ per-file timeouts. Data isolation was never the cause (every run already gets a
50
+ unique database); the cause is **physical resource contention**.
51
+
52
+ `vitest-e2e.config.ts` now supports an **opt-in** throttle. It changes nothing
53
+ by default — solo and moderately parallel runs stay at full speed:
54
+
55
+ ```bash
56
+ # Full speed (default) — nothing changes
57
+ pnpm test
58
+
59
+ # Opt in when you deliberately run MANY suites in parallel
60
+ CHECK_LOW_RESOURCE=1 pnpm test
61
+
62
+ # Pin the fork cap explicitly (otherwise ~1/3 of CPU cores)
63
+ CHECK_LOW_RESOURCE=1 CHECK_LOW_RESOURCE_FORKS=2 pnpm test
64
+ ```
65
+
66
+ | `CHECK_LOW_RESOURCE` | Effect |
67
+ |----------------------|--------|
68
+ | unset / `0` / `false` (default) | No cap, no timeout change — full speed |
69
+ | `1` / `true` | `poolOptions.forks.maxForks` capped (`~cores/3`, min 2), `testTimeout` 30s → 60s, `hookTimeout` 120s → 240s |
70
+ | any value + `CHECK_LOW_RESOURCE_FORKS=<n>` | Fork cap pinned to `<n>` |
71
+
72
+ When active it prints a one-line notice at startup:
73
+ `[e2e] low-resource mode active: maxForks=…, timeouts raised`.
74
+
75
+ ### 2. Signal-exit labelling in `scripts/check.mjs`
76
+
77
+ When a step's process is killed by a signal, the package manager surfaces it as
78
+ a numeric `Command failed with exit code 143` (SIGTERM) / `137` (SIGKILL) line,
79
+ while the outer shell reports only a generic exit `1`. The `check` report now
80
+ detects that and appends a clear reason so it isn't mistaken for a test-assertion
81
+ failure:
82
+
83
+ ```
84
+ [check] step ended via SIGTERM (exit 143) — the process was killed, not an
85
+ assertion failure. Usual cause: resource pressure (parallel checks/builds
86
+ swapping) or an external kill. Re-run this project's check alone to confirm.
87
+ ```
88
+
89
+ The hint is suppressed when the step was killed by the check's own idle
90
+ watchdog (that path already carries its own `[watchdog]` note), and it only
91
+ matches the package manager's own failure line — never an `exit code 143` a test
92
+ happens to log — so real assertion failures are never mislabeled.
93
+
94
+ ---
95
+
96
+ ## What's Fixed in 11.27.4
97
+
98
+ All fixes are in `scripts/check.mjs`, refining the idle watchdog introduced in
99
+ 11.27.x.
100
+
101
+ ### Watchdog now applies to test steps only
102
+
103
+ The idle watchdog kills a step whose child produces no output for the timeout
104
+ window (default 300s). It previously watched **every** step. But `build`,
105
+ `typecheck` and `audit` legitimately buffer all their output to the end (and go
106
+ silent under a non-TTY pipe) — watching them risked false-killing a slow but
107
+ progressing run. The watchdog is now armed **only for test steps**, whose
108
+ runners stream progress continuously, so prolonged silence genuinely means
109
+ deadlocked workers. The run header reflects this: `watchdog: 5m 0s (tests)`.
110
+
111
+ ### No stray `SIGKILL` after PID reuse
112
+
113
+ When the watchdog fires it sends `SIGTERM`, then escalates to `SIGKILL` after a
114
+ 5s grace window. That escalation timer is now tracked and cancelled once the
115
+ child exits within the grace window — previously the stray timer could fire
116
+ later and `SIGKILL` an **unrelated** process that had reused the freed PID.
117
+
118
+ ### Invalid `--idle-timeout` falls back to the default
119
+
120
+ An unparseable, negative, or unit-suffixed value (e.g. `--idle-timeout=30s`)
121
+ now keeps the watchdog at its default (300s) and prints a notice, instead of
122
+ silently evaluating to `0` and disabling the protection. Only an explicit `0`
123
+ disables the watchdog.
124
+
125
+ ```bash
126
+ --idle-timeout=120 # 120s
127
+ --idle-timeout=0 # explicitly disabled
128
+ --idle-timeout=30s # invalid → default 300s + "[check] ignoring invalid idle-timeout" notice
129
+ CHECK_IDLE_TIMEOUT=90 # env equivalent
130
+ ```
131
+
132
+ ### Clearer watchdog reason
133
+
134
+ The `[watchdog]` note now suggests re-running the **actual** failing command
135
+ (`Re-run the step directly to debug: <cmd>`) instead of a hard-coded
136
+ `pnpm run vitest`.
137
+
138
+ ---
139
+
140
+ ## Breaking Changes
141
+
142
+ None.
143
+
144
+ ---
145
+
146
+ ## Compatibility Notes
147
+
148
+ - **npm-mode consumers:** unaffected. `scripts/check.mjs` and
149
+ `vitest-e2e.config.ts` are not part of the npm package (`dist/`); no runtime
150
+ or API behavior changed. `pnpm update` is sufficient.
151
+ - **`IServerOptions` / `CoreModule.forRoot()` / all Core classes:** unchanged.
152
+ No source, export, or method signature changed in this release.
153
+ - **Starter-derived projects** (copied `scripts/check.mjs` / `vitest-e2e.config.ts`
154
+ from nest-server-starter 11.27.1+): copy the updated files to adopt the
155
+ test-only watchdog, the PID-reuse fix, the signal-exit hint, and the opt-in
156
+ `CHECK_LOW_RESOURCE` mode. All changes are backward compatible — the default
157
+ behavior (no env vars set) is unchanged, so an updated `check.mjs` /
158
+ `vitest-e2e.config.ts` is a drop-in replacement.
159
+ - **Vendor-mode consumers:** not applicable — `scripts/` and
160
+ `vitest-e2e.config.ts` are repo/starter tooling, not part of the vendored
161
+ `src/core/` file set. Nothing to sync.
162
+ - **`lt dev` / `lt ticket` parallel workflows:** the throttle is **manual**
163
+ (`CHECK_LOW_RESOURCE=1`). To have it apply automatically inside isolated
164
+ environments, the lt CLI can export it into the test env (the same way it
165
+ exports `LT_DEV_TEST_SHARDS` for the Playwright config). That is a CLI change,
166
+ not a framework change.
167
+ - **Nuxt / Playwright side:** no equivalent needed. The Playwright config
168
+ already uses `workers: 1` plus a `LT_DEV_TEST_SHARDS`-driven relaxed mode for
169
+ load, so the same class of contention is already handled there.
170
+
171
+ ---
172
+
173
+ ## Troubleshooting
174
+
175
+ ### My `build` / `typecheck` / `audit` step is no longer killed after 300s
176
+
177
+ Intended. Only **test** steps are watched now (they stream progress). Buffering
178
+ steps that legitimately go silent are no longer at risk of a false watchdog
179
+ kill. If such a step genuinely hangs, it still fails via its own tool timeout or
180
+ the overall run.
181
+
182
+ ### The check aborted with "step ended via SIGTERM (exit 143)"
183
+
184
+ That step's process was killed by a signal, not by a failed assertion. The usual
185
+ cause is resource pressure (several heavy checks/builds/test suites running at
186
+ once and swapping the machine) or an external kill. Re-run that project's check
187
+ alone to confirm — it will typically pass.
188
+
189
+ ### e2e tests flake (401 / timeouts) only when I run many suites in parallel
190
+
191
+ This is physical CPU/MongoDB contention, not a data-isolation bug (each run has
192
+ its own database). Opt into the throttle for those sessions:
193
+ `CHECK_LOW_RESOURCE=1 pnpm test`. It caps parallel forks and raises timeouts so
194
+ the suites share the machine without starving each other.
195
+
196
+ ### `CHECK_LOW_RESOURCE` seems to have no effect
197
+
198
+ Confirm the value is truthy (`1` / `true`) and not `0` / `false` / empty. When
199
+ active, the run prints `[e2e] low-resource mode active: maxForks=…` at startup.
200
+
201
+ ---
202
+
203
+ ## Repo-Internal Tooling Changes (no consumer action)
204
+
205
+ Summary of everything in this release, for projects that track the tooling
206
+ (all listed above in detail):
207
+
208
+ - `scripts/check.mjs`: idle watchdog restricted to test steps; stray-`SIGKILL`
209
+ (PID-reuse) fix; invalid `--idle-timeout` falls back to default instead of
210
+ disabling; watchdog reason shows the actual command; new `signalExitHint`
211
+ labelling `SIGTERM`/`SIGKILL` step exits.
212
+ - `vitest-e2e.config.ts`: opt-in `CHECK_LOW_RESOURCE` mode (fork cap + raised
213
+ timeouts) for stable parallel e2e runs; default behavior unchanged.
214
+
215
+ These carry forward the tooling introduced in
216
+ [11.27.1 → 11.27.2](./11.27.1-to-11.27.2.md) (chain-faithful audit) and
217
+ [11.27.2 → 11.27.3](./11.27.2-to-11.27.3.md) (idle watchdog + per-run test
218
+ databases).
219
+
220
+ ---
221
+
222
+ ## Module Documentation
223
+
224
+ No core module changed in this release. Relevant testing documentation:
225
+
226
+ - **Testing rules:** [.claude/rules/testing.md](../.claude/rules/testing.md) —
227
+ test framework, per-run database lifecycle, parallel execution
228
+ - **Reference implementation:** [nest-server-starter](https://github.com/lenneTech/nest-server-starter)
229
+ — carries the same `scripts/check.mjs` + `vitest-e2e.config.ts`
230
+
231
+ ---
232
+
233
+ ## References
234
+
235
+ - [Migration Guide 11.27.2 → 11.27.3](./11.27.2-to-11.27.3.md) — Previous release (verification-email crash fix + idle watchdog + per-run test DBs)
236
+ - [nest-server-starter](https://github.com/lenneTech/nest-server-starter) — reference implementation
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lenne.tech/nest-server",
3
- "version": "11.27.3",
3
+ "version": "11.27.4",
4
4
  "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
5
5
  "keywords": [
6
6
  "node",