feat(scenarios): add heartbeat-timeout scenario for TIMEOUT_NO_HEARTBEAT (#161)

Adds a `heartbeat-timeout` scenario covering `TIMEOUT_NO_HEARTBEAT`, which had no
scenario exercising it. The station boots with `interval: 300`, so the rule's
threshold lands at twice that, 600s. A single `StatusNotification` at 720s sits
past the threshold and gives the rule the trailing event it needs, and no
`Heartbeat` appears anywhere in the trace. `expectedFailures` is
`['TIMEOUT_NO_HEARTBEAT']`, asserted at `warning` severity and exactly once.

Takes the scenario registry to 19, updating the count in the registry test, the
external fixture test, and both READMEs. The detection-rule count stays 16, since
a scenario is not a rule.

Also picks up a missing `getScenario('refused-authorization')` assertion in
`index.test.ts`, a gap left behind by #156.

Closes #137

Author: MayurK-cmd

.changeset/heartbeat-timeout-scenario.md

@@ -0,0 +1,5 @@
+---
+'@ocpp-debugkit/toolkit': patch
+---
+
+Add `heartbeat-timeout` scenario covering the `TIMEOUT_NO_HEARTBEAT` detection rule. The synthetic trace boots a station with `interval=300`, then sends a `StatusNotification` past the 2× interval threshold (`06:12:00.000Z`) with no `Heartbeat` anywhere in the trace.

README.md

@@ -22,7 +22,7 @@ validate behavior against known scenarios.
   firmware update failures, suspicious session duration, slow CSMS responses,
   heartbeat interval violations, meter value anomalies, unresponsive CSMS, and
   repeated boot notifications.
-- **Scenario Evaluator** — 18 predefined scenarios with expected failure
+- **Scenario Evaluator** — 19 predefined scenarios with expected failure
   outcomes for testing the analysis engine. Supports external scenario files.
 - **Replay Engine** — Deterministic, pure replay engine with step forward/back,
   jump-to-event, and configurable playback speed.

packages/toolkit/README.md

@@ -20,7 +20,7 @@ report generation, React components, and CLI.
   firmware update failures, suspicious session duration, slow CSMS responses,
   heartbeat interval violations, meter value anomalies, unresponsive CSMS, and
   repeated boot notifications.
-- **Scenario Evaluator** — 18 predefined scenarios with expected failure
+- **Scenario Evaluator** — 19 predefined scenarios with expected failure
   outcomes for testing the analysis engine. Supports external scenario files.
 - **Replay Engine** — Deterministic, pure replay engine with step forward/back,
   jump-to-event, and configurable playback speed. No timers or I/O.

packages/toolkit/src/scenarios/__scenarios__/heartbeat-timeout.ts

@@ -0,0 +1,70 @@
+export default {
+  name: 'heartbeat-timeout',
+  description:
+    'Station boots and never sends a Heartbeat. BootNotification response sets interval=300s, threshold at 600s. StatusNotification after threshold triggers TIMEOUT_NO_HEARTBEAT.',
+  trace: {
+    traceId: 'scenario-heartbeat-timeout',
+    metadata: {
+      stationId: 'CS-SYNTHETIC-018',
+      ocppVersion: '1.6',
+      source: 'synthetic-scenario',
+      description: 'Station boots and never sends a Heartbeat — timeout expected.',
+    },
+    events: [
+      {
+        timestamp: '2026-01-15T06:00:00.000Z',
+        direction: 'CS_TO_CSMS',
+        message: [
+          2,
+          'msg-001',
+          'BootNotification',
+          {
+            chargePointVendor: 'SyntheticVendor',
+            chargePointModel: 'SM-100',
+            chargePointSerialNumber: 'CS-SYNTHETIC-018',
+            firmwareVersion: '1.0.0',
+          },
+        ],
+      },
+      {
+        timestamp: '2026-01-15T06:00:00.500Z',
+        direction: 'CSMS_TO_CS',
+        message: [
+          3,
+          'msg-001',
+          {
+            currentTime: '2026-01-15T06:00:00.500Z',
+            interval: 300,
+            status: 'Accepted',
+          },
+        ],
+      },
+      {
+        timestamp: '2026-01-15T06:12:00.000Z',
+        direction: 'CS_TO_CSMS',
+        message: [
+          2,
+          'msg-002',
+          'StatusNotification',
+          { connectorId: 1, status: 'Available', errorCode: 'NoError' },
+        ],
+      },
+      {
+        timestamp: '2026-01-15T06:12:00.500Z',
+        direction: 'CSMS_TO_CS',
+        message: [3, 'msg-002', {}],
+      },
+    ],
+  },
+  expectedFailures: ['TIMEOUT_NO_HEARTBEAT'],
+  assertions: [
+    {
+      type: 'failure_severity',
+      params: { code: 'TIMEOUT_NO_HEARTBEAT', severity: 'warning' },
+    },
+    {
+      type: 'failure_count',
+      params: { code: 'TIMEOUT_NO_HEARTBEAT', min: 1, max: 1 },
+    },
+  ],
+};

packages/toolkit/src/scenarios/index.test.ts

@@ -21,6 +21,7 @@ import {
   firmwareUpdateSuccessScenario,
   firmwareUpdateFailureScenario,
   refusedAuthorizationScenario,
+  heartbeatTimeoutScenario,
 } from './index.js';
 import { parseTrace, buildSessionTimeline, detectFailures } from '../core/index.js';
 
@@ -29,8 +30,8 @@ import { parseTrace, buildSessionTimeline, detectFailures } from '../core/index.
 // ---------------------------------------------------------------------------
 
 describe('scenario registry', () => {
-  it('exports exactly 18 scenarios', () => {
-    expect(scenarios).toHaveLength(18);
+  it('exports exactly 19 scenarios', () => {
+    expect(scenarios).toHaveLength(19);
   });
 
   it('exports scenario names in order', () => {
@@ -53,6 +54,7 @@ describe('scenario registry', () => {
       'firmware-update-success',
       'firmware-update-failure',
       'refused-authorization',
+      'heartbeat-timeout',
     ]);
   });
 
@@ -83,6 +85,8 @@ describe('scenario registry', () => {
     expect(getScenario('unresponsive-csms')).toBe(unresponsiveCsmsScenario);
     expect(getScenario('firmware-update-success')).toBe(firmwareUpdateSuccessScenario);
     expect(getScenario('firmware-update-failure')).toBe(firmwareUpdateFailureScenario);
+    expect(getScenario('refused-authorization')).toBe(refusedAuthorizationScenario);
+    expect(getScenario('heartbeat-timeout')).toBe(heartbeatTimeoutScenario);
   });
 
   it('getScenario returns undefined for unknown name', () => {
@@ -230,6 +234,14 @@ describe('scenario engine integration', () => {
       'ConcurrentTx',
     ]);
   });
+
+  it('heartbeat-timeout: detects TIMEOUT_NO_HEARTBEAT', () => {
+    const trace = JSON.stringify(heartbeatTimeoutScenario.trace);
+    const result = parseTrace(trace);
+    const sessions = buildSessionTimeline(result.events);
+    const failures = detectFailures(result.events, sessions);
+    expect(failures.some((f) => f.code === 'TIMEOUT_NO_HEARTBEAT')).toBe(true);
+  });
 });
 
 // ---------------------------------------------------------------------------

packages/toolkit/src/scenarios/index.ts

@@ -23,6 +23,7 @@ import unresponsiveCsms from './__scenarios__/unresponsive-csms.js';
 import firmwareUpdateSuccess from './__scenarios__/firmware-update-success.js';
 import firmwareUpdateFailure from './__scenarios__/firmware-update-failure.js';
 import refusedAuthorization from './__scenarios__/refused-authorization.js';
+import heartbeatTimeout from './__scenarios__/heartbeat-timeout.js';
 
 // ---------------------------------------------------------------------------
 // Scenarios derived from core fixtures
@@ -72,6 +73,7 @@ const unresponsiveCsmsScenario: Scenario = unresponsiveCsms as unknown as Scenar
 const firmwareUpdateSuccessScenario: Scenario = firmwareUpdateSuccess as unknown as Scenario;
 const firmwareUpdateFailureScenario: Scenario = firmwareUpdateFailure as unknown as Scenario;
 const refusedAuthorizationScenario: Scenario = refusedAuthorization as unknown as Scenario;
+const heartbeatTimeoutScenario: Scenario = heartbeatTimeout as unknown as Scenario;
 
 // ---------------------------------------------------------------------------
 // Registry
@@ -96,6 +98,7 @@ export const scenarios = [
   firmwareUpdateSuccessScenario,
   firmwareUpdateFailureScenario,
   refusedAuthorizationScenario,
+  heartbeatTimeoutScenario,
 ] as const;
 
 export const scenarioNames = [
@@ -117,6 +120,7 @@ export const scenarioNames = [
   'firmware-update-success',
   'firmware-update-failure',
   'refused-authorization',
+  'heartbeat-timeout',
 ] as const;
 
 export {
@@ -138,6 +142,7 @@ export {
   firmwareUpdateSuccessScenario,
   firmwareUpdateFailureScenario,
   refusedAuthorizationScenario,
+  heartbeatTimeoutScenario,
 };
 
 export { compareScenarioReports } from './compare.js';

tests/external-fixture/test.mjs

@@ -158,8 +158,8 @@ const scenarios = await import('@ocpp-debugkit/toolkit/scenarios');
 
 assert(Array.isArray(scenarios.scenarios), 'scenarios is an array');
 assert(
-  scenarios.scenarios.length === 18,
-  `18 scenarios exported (got ${scenarios.scenarios.length})`,
+  scenarios.scenarios.length === 19,
+  `19 scenarios exported (got ${scenarios.scenarios.length})`,
 );
 assert(typeof scenarios.getScenario === 'function', 'getScenario is a function');
 assert(scenarios.getScenario('normal-session') !== undefined, 'normal-session scenario exists');