Files
msd-core/tests/context-utilization.property.test.cjs
Jakub Zych a9a7a328e6 refactor: hard-fork GSD -> MSD (Make Software Done)
Mechanical rename produced by scripts/msd-rename.cjs: gsd/Gsd/GSD -> msd/Msd/MSD
across contents and paths, upstream package/repo coordinates -> @golem15/msd-core
and golem15com/msd-core. Deep links into upstream history, sibling upstream
packages, the GSD-2 import feature, CHANGELOG.md and .changeset/ are kept as-is.

Hand edits on top: MSD block-letter banner and logos, LICENSE copyright line,
package/plugin identity, regenerated lockfile, install-tree fixtures, derived
registries and benchmark baseline; migration checksum baseline re-locked
(MSD keeps its own install state, so no install had applied the old sums);
sort-order and regex-escaped expectations in tests adjusted.
2026-10-06 01:47:40 +02:00

336 lines
14 KiB
JavaScript

'use strict';
/**
* Property-based tests for context-utilization.cjs
*
* Module: msd-core/bin/lib/context-utilization.cjs
* Exported: classifyContextUtilization(tokensUsed, contextWindow) -> { percent, state }
*
* Thresholds (from module source):
* ratio < 0.60 → healthy
* 0.60 <= ratio < 0.70 → warning
* ratio >= 0.70 → critical
*
* Properties tested:
* (a) Boundary: across the 60% and 70% thresholds the classify flips correctly
* (b) Robustness: hostile inputs (null/undefined/NaN/Infinity/negative/wrong-type)
* always throw TypeError (documented contract) and never throw non-TypeError
* (c) Return shape: all valid inputs return an object with typed { percent, state }
*/
const { describe, test } = require('node:test');
const assert = require('node:assert/strict');
const fc = require('./helpers/fast-check-setup.cjs');
const { classifyContextUtilization, STATES } = require('../msd-core/bin/lib/context-utilization.cjs');
// ─── Boundary constants ───────────────────────────────────────────────────────
const WARNING_THRESHOLD = 0.60; // ratio < this → healthy
const CRITICAL_THRESHOLD = 0.70; // ratio < this → warning, else critical
const WINDOW = 10000; // A fixed contextWindow that gives us clean ratio math
const W = 50; // boundary exploration width: ±50 tokens around the threshold
describe('context-utilization property tests', () => {
// ─── (a) Boundary property: classify flips at exactly 60% and 70% ────────────
test('property: classify is healthy below 60%, warning in [60%,70%), critical at ≥70%', () => {
// Test across a range of context windows.
// The boundary is at the exact RATIO — not at Math.floor(window * ratio).
// e.g. with window=1001: floor(1001 * 0.60) = 600, but 600/1001 = 0.5994 < 0.60 → healthy.
// So we compute the exact first token count that meets or exceeds the threshold.
fc.assert(
fc.property(
// contextWindow: 1000..200000 to keep ratios well-defined
fc.integer({ min: 1000, max: 200_000 }),
(contextWindow) => {
// First integer where tokensUsed/contextWindow >= WARNING_THRESHOLD
const firstWarning = Math.ceil(contextWindow * WARNING_THRESHOLD);
// First integer where tokensUsed/contextWindow >= CRITICAL_THRESHOLD
const firstCritical = Math.ceil(contextWindow * CRITICAL_THRESHOLD);
// Just below warning threshold → healthy
if (firstWarning > 0) {
const below = firstWarning - 1;
const r = classifyContextUtilization(below, contextWindow);
assert.equal(
r.state,
STATES.HEALTHY,
`tokensUsed=${below} contextWindow=${contextWindow} ratio=${(below / contextWindow).toFixed(6)} expected healthy got ${r.state}`
);
}
// At exact warning boundary → warning (unless critical collapses to same point)
if (firstWarning < firstCritical && firstWarning <= contextWindow) {
const r2 = classifyContextUtilization(firstWarning, contextWindow);
assert.equal(
r2.state,
STATES.WARNING,
`tokensUsed=${firstWarning} ratio=${(firstWarning / contextWindow).toFixed(6)} expected warning got ${r2.state}`
);
}
// At or above critical threshold → critical
if (firstCritical <= contextWindow) {
const r3 = classifyContextUtilization(firstCritical, contextWindow);
assert.equal(
r3.state,
STATES.CRITICAL,
`tokensUsed=${firstCritical} ratio=${(firstCritical / contextWindow).toFixed(6)} expected critical got ${r3.state}`
);
}
}
)
);
});
test('property: near 60% boundary the state is always healthy (never warning/critical)', () => {
// Tokens strictly below ceil(WINDOW * 0.60) must classify as healthy.
// The boundary is the FIRST integer where ratio >= 0.60 (Math.ceil).
// We sample from [firstWarning - W, firstWarning - 1] to probe just below it.
const firstWarning = Math.ceil(WINDOW * WARNING_THRESHOLD); // = 6000
const rangeMin = Math.max(0, firstWarning - W); // = 5950
const rangeMax = firstWarning - 1; // = 5999
fc.assert(
fc.property(
fc.integer({ min: rangeMin, max: rangeMax }),
(tokensUsed) => {
const r = classifyContextUtilization(tokensUsed, WINDOW);
assert.equal(
r.state,
STATES.HEALTHY,
`tokensUsed=${tokensUsed}/${WINDOW}=${(tokensUsed / WINDOW * 100).toFixed(2)}% expected healthy got ${r.state}`
);
}
)
);
});
test('property: near 70% boundary tokens at/above critical threshold must be critical', () => {
const criticalFloor = Math.ceil(WINDOW * CRITICAL_THRESHOLD);
fc.assert(
fc.property(
fc.integer({ min: criticalFloor, max: WINDOW }),
(tokensUsed) => {
const r = classifyContextUtilization(tokensUsed, WINDOW);
assert.equal(
r.state,
STATES.CRITICAL,
`tokensUsed=${tokensUsed}/${WINDOW}=${(tokensUsed / WINDOW * 100).toFixed(2)}% expected critical got ${r.state}`
);
}
)
);
});
// ─── (b) Robustness: hostile inputs always throw TypeError ────────────────────
test('property: non-integer/negative tokensUsed always throws TypeError', () => {
const invalidTokensUsed = fc.oneof(
fc.constant(null),
fc.constant(undefined),
fc.constant(NaN),
fc.constant(Infinity),
fc.constant(-Infinity),
fc.constant(-1),
fc.integer({ min: -10000, max: -1 }),
fc.double({ min: 0.1, max: 0.9 }),
fc.string(),
fc.boolean(),
fc.constant([]),
fc.constant({})
);
fc.assert(
fc.property(invalidTokensUsed, (bad) => {
assert.throws(
() => classifyContextUtilization(bad, 10000),
(err) => {
assert.ok(err instanceof TypeError, `Expected TypeError but got ${err.constructor.name}: ${err.message}`);
return true;
}
);
})
);
});
test('property: non-integer/non-positive contextWindow always throws TypeError', () => {
const invalidWindows = fc.oneof(
fc.constant(null),
fc.constant(undefined),
fc.constant(NaN),
fc.constant(Infinity),
fc.constant(-Infinity),
fc.constant(0),
fc.constant(-1),
fc.integer({ min: -10000, max: 0 }),
fc.double({ min: 0.1, max: 0.9 }),
fc.string(),
fc.boolean()
);
fc.assert(
fc.property(invalidWindows, (bad) => {
assert.throws(
() => classifyContextUtilization(1000, bad),
(err) => {
assert.ok(err instanceof TypeError, `Expected TypeError for contextWindow=${bad} but got ${err.constructor.name}: ${err.message}`);
return true;
}
);
})
);
});
// ─── (c) Return shape: all valid inputs produce typed { percent, state } ──────
//
// Previously used Math.random() inside fc.property which broke reproducibility
// under the pinned seed (seed=42). Fixed: tokensUsed is now a seeded fc.integer
// arbitrary, making both inputs part of the shrinkable, reproducible input tuple.
//
// Split into two sub-properties:
// (c1) shape-only — result is an object with the right field types and ranges
// (c2) value-correctness — percent value matches the expected ratio arithmetic
// at three known representative ratios (0%, 50%, 100%)
test('property: valid inputs always return { percent: number[0..100], state: string }', () => {
fc.assert(
fc.property(
fc.integer({ min: 1, max: 1_000_000 }), // contextWindow
fc.integer({ min: 0, max: 1_000_000 }), // tokensUsed (upper-bound clamped below)
(contextWindow, rawTokens) => {
// Clamp so tokensUsed is always in [0, contextWindow] — same domain as
// the former Math.random() draw but now seeded and shrinkable.
const tokensUsed = rawTokens % (contextWindow + 1);
const r = classifyContextUtilization(tokensUsed, contextWindow);
assert.ok(typeof r === 'object' && r !== null, 'result must be object');
assert.ok(typeof r.percent === 'number', `percent must be number got ${typeof r.percent}`);
assert.ok(typeof r.state === 'string', `state must be string got ${typeof r.state}`);
assert.ok(r.percent >= 0 && r.percent <= 100, `percent ${r.percent} out of [0,100]`);
assert.ok(
[STATES.HEALTHY, STATES.WARNING, STATES.CRITICAL].includes(r.state),
`state must be one of the STATES enum, got ${r.state}`
);
}
)
);
});
test('property: percent value matches ratio arithmetic at known representative ratios', () => {
// Use a fixed contextWindow of 10000 so exact percent values are predictable.
// Three known points: 0% (healthy), 50% (healthy), 100% (critical).
const knownCases = [
{ tokensUsed: 0, expectedPercent: 0, expectedState: STATES.HEALTHY },
{ tokensUsed: 5000, expectedPercent: 50, expectedState: STATES.HEALTHY },
{ tokensUsed: 10000, expectedPercent: 100, expectedState: STATES.CRITICAL },
];
for (const { tokensUsed, expectedPercent, expectedState } of knownCases) {
const r = classifyContextUtilization(tokensUsed, WINDOW);
assert.equal(
r.percent,
expectedPercent,
`tokensUsed=${tokensUsed}/${WINDOW}: expected percent=${expectedPercent} got ${r.percent}`
);
assert.equal(
r.state,
expectedState,
`tokensUsed=${tokensUsed}/${WINDOW}: expected state=${expectedState} got ${r.state}`
);
}
});
test('property: tokensUsed exceeding contextWindow clamps to 100% critical', () => {
fc.assert(
fc.property(
fc.integer({ min: 1, max: 100_000 }),
fc.integer({ min: 1, max: 100_000 }),
(contextWindow, extra) => {
const tokensUsed = contextWindow + extra; // always exceeds window
const r = classifyContextUtilization(tokensUsed, contextWindow);
assert.equal(r.state, STATES.CRITICAL, `overflow ${tokensUsed}/${contextWindow} must be critical`);
assert.equal(r.percent, 100, `overflow percent must clamp to 100, got ${r.percent}`);
}
)
);
});
// ─── STATES string-literal mutation killers ───────────────────────────────
// Stryker survivors: HEALTHY/WARNING/CRITICAL → "" (StringLiteral mutants).
// The property tests above use STATES.HEALTHY etc. which would still pass
// even if all strings were emptied (self-comparison). These tests assert the
// LITERAL string values — the documented public API contract of STATES.
test('STATES.HEALTHY literal value is "healthy"', () => {
assert.strictEqual(
STATES.HEALTHY,
'healthy',
'STATES.HEALTHY must be the string "healthy" (catches StringLiteral mutant → "")'
);
});
test('STATES.WARNING literal value is "warning"', () => {
assert.strictEqual(
STATES.WARNING,
'warning',
'STATES.WARNING must be the string "warning" (catches StringLiteral mutant → "")'
);
});
test('STATES.CRITICAL literal value is "critical"', () => {
assert.strictEqual(
STATES.CRITICAL,
'critical',
'STATES.CRITICAL must be the string "critical" (catches StringLiteral mutant → "")'
);
});
test('classifyContextUtilization state values are the documented string literals', () => {
// Asserts the actual returned state strings — not just STATES membership.
// Kills mutants that swap the STATES object values to empty strings.
const healthy = classifyContextUtilization(0, 10000);
assert.strictEqual(healthy.state, 'healthy', 'zero tokens must produce state "healthy"');
const warning = classifyContextUtilization(6000, 10000);
assert.strictEqual(warning.state, 'warning', '60% tokens must produce state "warning"');
const critical = classifyContextUtilization(7000, 10000);
assert.strictEqual(critical.state, 'critical', '70% tokens must produce state "critical"');
});
// ─── Error message content mutation killers ───────────────────────────────
// Stryker survivors: error message template → "" (StringLiteral mutants).
// Asserting only TypeError type doesn't kill these — need message content.
test('TypeError for bad tokensUsed includes descriptive message mentioning the value', () => {
const badValue = -5;
try {
classifyContextUtilization(badValue, 10000);
assert.fail('Expected TypeError was not thrown');
} catch (err) {
assert.ok(err instanceof TypeError);
assert.ok(
err.message.includes(String(badValue)),
`Error message must include the bad value (${badValue}), got: "${err.message}"`
);
assert.ok(
err.message.length > 0,
'Error message must not be empty (catches StringLiteral → "" mutant)'
);
}
});
test('TypeError for bad contextWindow includes descriptive message mentioning the value', () => {
const badValue = 0;
try {
classifyContextUtilization(100, badValue);
assert.fail('Expected TypeError was not thrown');
} catch (err) {
assert.ok(err instanceof TypeError);
assert.ok(
err.message.includes(String(badValue)),
`Error message must include the bad value (${badValue}), got: "${err.message}"`
);
assert.ok(
err.message.length > 0,
'Error message must not be empty (catches StringLiteral → "" mutant)'
);
}
});
});