@ingissa/navcore-simulator 1.0.8 → 1.0.9

package/src/scenarios/ScenarioInjector.ts

@@ -1,170 +0,0 @@
-/**
- * ScenarioInjector — Registers and fires Scenario objects at geometry indices.
- *
- * Called internally by SimulatorEngine on each tick.
- * Also provides static factory methods for the built-in scenario types.
- */
-
-import type { Scenario } from '../core/types';
-
-export type ScenarioFireCallback = (scenario: Scenario) => void;
-export type ScenarioEndCallback = (scenario: Scenario) => void;
-
-export class ScenarioInjector {
-  /** Map from triggerIndex → Scenario */
-  private readonly scenarios = new Map<number, Scenario>();
-  /** Tracks which scenarios have already fired (by name) to avoid double-fire */
-  private readonly fired = new Set<string>();
-  /** Currently active scenario, if any */
-  private _activeScenario: Scenario | null = null;
-  private _activeEndTimer: ReturnType<typeof setTimeout> | null = null;
-
-  private onStart: ScenarioFireCallback;
-  private onEnd: ScenarioEndCallback;
-
-  constructor(onStart?: ScenarioFireCallback, onEnd?: ScenarioEndCallback) {
-    this.onStart = onStart ?? (() => undefined);
-    this.onEnd = onEnd ?? (() => undefined);
-  }
-
-  // ── Registration ────────────────────────────────────────────────────────────
-
-  register(scenario: Scenario): void {
-    this.scenarios.set(scenario.triggerIndex, scenario);
-  }
-
-  remove(name: string): void {
-    for (const [idx, s] of this.scenarios) {
-      if (s.name === name) {
-        this.scenarios.delete(idx);
-        break;
-      }
-    }
-  }
-
-  clear(): void {
-    this.scenarios.clear();
-    this.fired.clear();
-    this._clearActiveTimer();
-    this._activeScenario = null;
-  }
-
-  // ── Tick ────────────────────────────────────────────────────────────────────
-
-  /**
-   * Check and fire any scenario whose triggerIndex matches (or was passed) by
-   * currentIndex. Called by SimulatorEngine on every tick.
-   *
-   * Returns the name of the active scenario (if any), for metadata injection.
-   */
-  tick(currentIndex: number): string | undefined {
-    const floorIdx = Math.floor(currentIndex);
-
-    for (const [triggerIdx, scenario] of this.scenarios) {
-      if (floorIdx >= triggerIdx && !this.fired.has(scenario.name)) {
-        this.fired.add(scenario.name);
-        this._fire(scenario);
-      }
-    }
-
-    return this._activeScenario?.name;
-  }
-
-  get activeScenario(): Scenario | null {
-    return this._activeScenario;
-  }
-
-  /** Clean up any pending timers */
-  destroy(): void {
-    this._clearActiveTimer();
-  }
-
-  // ── Static factories ────────────────────────────────────────────────────────
-
-  /**
-   * GPS blackout: no position updates for `durationMs`.
-   * Engine handles signal loss; this scenario signals the blackout period.
-   */
-  static gpsBlackout(atIndex: number, durationMs: number): Scenario {
-    return {
-      name: `gps-blackout-@${atIndex}`,
-      triggerIndex: atIndex,
-      type: 'GPS_BLACKOUT',
-      durationMs,
-      params: { durationMs },
-    };
-  }
-
-  /**
-   * Wrong-side road: offset the simulated position by `offsetM` metres
-   * perpendicular to the route to stress-test the parallel road resolver.
-   */
-  static wrongSideRoad(atIndex: number, offsetM: number): Scenario {
-    return {
-      name: `wrong-side-@${atIndex}`,
-      triggerIndex: atIndex,
-      type: 'WRONG_SIDE_ROAD',
-      params: { offsetM },
-    };
-  }
-
-  /** U-turn at the given index — stress-tests U-turn protection. */
-  static uTurn(atIndex: number): Scenario {
-    return {
-      name: `uturn-@${atIndex}`,
-      triggerIndex: atIndex,
-      type: 'UTURN',
-      params: {},
-    };
-  }
-
-  /** Speed spike: briefly report spikeKmh instead of the configured speed. */
-  static speedSpike(atIndex: number, spikeKmh: number, durationMs = 2000): Scenario {
-    return {
-      name: `speed-spike-@${atIndex}`,
-      triggerIndex: atIndex,
-      type: 'SPEED_SPIKE',
-      durationMs,
-      params: { spikeKmh },
-    };
-  }
-
-  /**
-   * Accuracy drop: GPS accuracy degrades to newAccuracyM for durationMs.
-   */
-  static accuracyDrop(atIndex: number, newAccuracyM: number, durationMs: number): Scenario {
-    return {
-      name: `accuracy-drop-@${atIndex}`,
-      triggerIndex: atIndex,
-      type: 'ACCURACY_DROP',
-      durationMs,
-      params: { newAccuracyM },
-    };
-  }
-
-  // ── Private ─────────────────────────────────────────────────────────────────
-
-  private _fire(scenario: Scenario): void {
-    this._activeScenario = scenario;
-    try { this.onStart(scenario); } catch (_) { /* never throw from callback */ }
-
-    if (scenario.durationMs != null && scenario.durationMs > 0) {
-      this._clearActiveTimer();
-      this._activeEndTimer = setTimeout(() => {
-        this._activeScenario = null;
-        try { this.onEnd(scenario); } catch (_) { /* never throw */ }
-      }, scenario.durationMs);
-    } else {
-      // Instantaneous scenario — end immediately
-      this._activeScenario = null;
-      try { this.onEnd(scenario); } catch (_) { /* never throw */ }
-    }
-  }
-
-  private _clearActiveTimer(): void {
-    if (this._activeEndTimer !== null) {
-      clearTimeout(this._activeEndTimer);
-      this._activeEndTimer = null;
-    }
-  }
-}

package/src/scenarios/__tests__/ScenarioInjector.test.ts

@@ -1,171 +0,0 @@
-/**
- * ScenarioInjector unit tests
- */
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { ScenarioInjector } from '@ingissa/navcore-simulator';
-
-describe('ScenarioInjector', () => {
-  describe('register + tick', () => {
-    it('fires callback at the correct index', () => {
-      const onStart = vi.fn();
-      const injector = new ScenarioInjector(onStart);
-      const scenario = ScenarioInjector.gpsBlackout(5, 1000);
-      injector.register(scenario);
-
-      // Not yet
-      injector.tick(3);
-      expect(onStart).not.toHaveBeenCalled();
-
-      // At trigger index
-      injector.tick(5);
-      expect(onStart).toHaveBeenCalledOnce();
-      expect(onStart.mock.calls[0]![0].type).toBe('GPS_BLACKOUT');
-    });
-
-    it('fires when index passes the trigger (skipped frame)', () => {
-      const onStart = vi.fn();
-      const injector = new ScenarioInjector(onStart);
-      injector.register(ScenarioInjector.gpsBlackout(10, 500));
-
-      // Jump from 5 to 15 — trigger at 10 should still fire
-      injector.tick(15);
-      expect(onStart).toHaveBeenCalledOnce();
-    });
-
-    it('does NOT double-fire the same scenario', () => {
-      const onStart = vi.fn();
-      const injector = new ScenarioInjector(onStart);
-      injector.register(ScenarioInjector.gpsBlackout(3, 500));
-
-      injector.tick(3);
-      injector.tick(3);
-      injector.tick(5);
-      expect(onStart).toHaveBeenCalledTimes(1);
-    });
-
-    it('fires onEnd after durationMs (via setTimeout)', () => {
-      vi.useFakeTimers();
-      const onEnd = vi.fn();
-      const injector = new ScenarioInjector(undefined, onEnd);
-      injector.register(ScenarioInjector.gpsBlackout(0, 2000));
-
-      injector.tick(0);
-      expect(onEnd).not.toHaveBeenCalled();
-
-      vi.advanceTimersByTime(2000);
-      expect(onEnd).toHaveBeenCalledOnce();
-      vi.useRealTimers();
-    });
-
-    it('fires onEnd immediately for instantaneous scenario (no durationMs)', () => {
-      const onEnd = vi.fn();
-      const injector = new ScenarioInjector(undefined, onEnd);
-      injector.register(ScenarioInjector.uTurn(5));
-
-      injector.tick(5);
-      expect(onEnd).toHaveBeenCalledOnce();
-    });
-  });
-
-  describe('remove', () => {
-    it('removes a scenario by name before it fires', () => {
-      const onStart = vi.fn();
-      const injector = new ScenarioInjector(onStart);
-      const s = ScenarioInjector.gpsBlackout(4, 1000);
-      injector.register(s);
-      injector.remove(s.name);
-
-      injector.tick(4);
-      expect(onStart).not.toHaveBeenCalled();
-    });
-  });
-
-  describe('clear', () => {
-    it('removes all scenarios', () => {
-      const onStart = vi.fn();
-      const injector = new ScenarioInjector(onStart);
-      injector.register(ScenarioInjector.gpsBlackout(1, 500));
-      injector.register(ScenarioInjector.uTurn(2));
-      injector.clear();
-
-      injector.tick(5);
-      expect(onStart).not.toHaveBeenCalled();
-    });
-  });
-
-  describe('activeScenario', () => {
-    it('is null before firing', () => {
-      const injector = new ScenarioInjector();
-      injector.register(ScenarioInjector.gpsBlackout(5, 5000));
-      expect(injector.activeScenario).toBeNull();
-    });
-
-    it('is set after firing (while durationMs pending)', () => {
-      vi.useFakeTimers();
-      const injector = new ScenarioInjector();
-      injector.register(ScenarioInjector.gpsBlackout(0, 5000));
-      injector.tick(0);
-      expect(injector.activeScenario?.type).toBe('GPS_BLACKOUT');
-      vi.useRealTimers();
-    });
-  });
-
-  describe('tick returns active scenario name', () => {
-    it('returns undefined when no scenario is active', () => {
-      const injector = new ScenarioInjector();
-      injector.register(ScenarioInjector.gpsBlackout(10, 1000));
-      const result = injector.tick(0);
-      expect(result).toBeUndefined();
-    });
-
-    it('returns scenario name after it fires', () => {
-      vi.useFakeTimers();
-      const injector = new ScenarioInjector();
-      const s = ScenarioInjector.gpsBlackout(0, 5000);
-      injector.register(s);
-      injector.tick(0);
-      const name = injector.tick(1);
-      expect(name).toBe(s.name);
-      vi.useRealTimers();
-    });
-  });
-
-  describe('Static factories', () => {
-    it('gpsBlackout returns GPS_BLACKOUT type', () => {
-      const s = ScenarioInjector.gpsBlackout(10, 3000);
-      expect(s.type).toBe('GPS_BLACKOUT');
-      expect(s.triggerIndex).toBe(10);
-      expect(s.durationMs).toBe(3000);
-    });
-
-    it('wrongSideRoad returns WRONG_SIDE_ROAD type', () => {
-      const s = ScenarioInjector.wrongSideRoad(20, 18);
-      expect(s.type).toBe('WRONG_SIDE_ROAD');
-      expect(s.params?.['offsetM']).toBe(18);
-    });
-
-    it('uTurn returns UTURN type', () => {
-      const s = ScenarioInjector.uTurn(15);
-      expect(s.type).toBe('UTURN');
-    });
-
-    it('speedSpike returns SPEED_SPIKE type with spikeKmh', () => {
-      const s = ScenarioInjector.speedSpike(5, 120);
-      expect(s.type).toBe('SPEED_SPIKE');
-      expect(s.params?.['spikeKmh']).toBe(120);
-    });
-
-    it('accuracyDrop returns ACCURACY_DROP type', () => {
-      const s = ScenarioInjector.accuracyDrop(8, 50, 4000);
-      expect(s.type).toBe('ACCURACY_DROP');
-      expect(s.durationMs).toBe(4000);
-      expect(s.params?.['newAccuracyM']).toBe(50);
-    });
-
-    it('all factories produce unique names for different indices', () => {
-      const a = ScenarioInjector.gpsBlackout(1, 1000);
-      const b = ScenarioInjector.gpsBlackout(2, 1000);
-      expect(a.name).not.toBe(b.name);
-    });
-  });
-});