All files / lib/reflection introspection.ts

83.33% Statements 155/186
79.16% Branches 19/24
90% Functions 9/10
83.33% Lines 155/186

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 2521x   1x   1x 1x   1x 1x 1x   1x                       1x 1x 1x 1x   1x   1x 1x 1x   29x 29x 29x 29x 29x 29x 29x   1x     1x                                   1x   1x 19x 19x 19x   19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x   19x 19x 19x 19x 19x 19x 19x 19x 19x 19x 19x   19x 19x         19x       19x 19x   19x 19x 19x   1x 1x 1x   1x       1x 1x 5x 5x   5x 1x 1x   5x 4x 4x   5x       4x 5x 5x 5x 5x   1x   1x 1x 12x 8x 8x   12x       4x 4x 4x 4x 4x   4x 4x 4x 4x   1x     1x 1x 6x 6x 6x   1x 1x 1x   1x           1x 1x 5x 5x 1x 1x 1x   4x 4x 4x 4x 4x                       1x 6x 6x   1x   1x 1x 1x 1x 1x   1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x   1x 1x 1x 1x 1x 1x 1x   1x 1x 1x 1x   1x 6x 6x  
// lib/reflection/introspection.ts
 
import { subscribe, AwarenessEvent, AwarenessEventPayload } from '@/lib/awareness';
import { SignalType, type Signal } from './types';
import { _pushLatestSignals } from './memory';
import { isReflectionEnabled, isVerbose } from './flags';
 
// ========================================
//   Configuration
// ========================================
 
let INTROSPECTION_INTERVAL = 5000; // 5 seconds (mutable for test overrides)
 
// ========================================
//   Module State
// ========================================
 
type SignalAggregator = {
  windowOpenCount: number;
  windowCloseCount: number;
  focusChangeCount: number;
};
 
let aggregator: SignalAggregator = createEmptyAggregator();
let intervalId: NodeJS.Timeout | null = null;
let isRunning = false;
let unsubscribeFromAwareness: (() => void) | null = null;
 
let onSignalComputed: ((signal: Signal) => void) | null = null;
 
// ========================================
//   Private Logic
// ========================================
 
function createEmptyAggregator(): SignalAggregator {
  return {
    windowOpenCount: 0,
    windowCloseCount: 0,
    focusChangeCount: 0,
  };
}
 
/**
 * Processes a raw awareness event and updates the aggregator.
 * @param event The awareness event.
 */
function processEvent(event: AwarenessEventPayload): void {
  if (!isReflectionEnabled()) return;
 
  switch (event.type) {
    case AwarenessEvent.WINDOW_OPENED:
      aggregator.windowOpenCount++;
      break;
    case AwarenessEvent.WINDOW_CLOSED:
      aggregator.windowCloseCount++;
      break;
    case AwarenessEvent.WINDOW_FOCUSED:
      aggregator.focusChangeCount++;
      break;
    // Other events can be processed here for other signals
  }
}
 
/**
 * Computes signals from the aggregated data and emits them.
 */
function computeAndEmitSignals(): void {
  const now = performance.now();
  const intervalInSeconds = INTROSPECTION_INTERVAL / 1000;
 
  // 1. Window Churn Signal
  const windowChurn =
    (aggregator.windowOpenCount + aggregator.windowCloseCount) / intervalInSeconds;
  const churnSignal: Signal = {
    type: 'WINDOW_CHURN',
    value: windowChurn,
    timestamp: now,
    metadata: {
      opens: aggregator.windowOpenCount,
      closes: aggregator.windowCloseCount,
      interval: INTROSPECTION_INTERVAL,
    },
  };
 
  // 2. Focus Stability Signal
  const focusStability = aggregator.focusChangeCount / intervalInSeconds;
  const focusSignal: Signal = {
    type: 'FOCUS_STABILITY',
    value: focusStability,
    timestamp: now,
    metadata: {
      count: aggregator.focusChangeCount,
      interval: INTROSPECTION_INTERVAL,
    },
  };
 
  // Notify subscribers if present
  if (onSignalComputed) {
    onSignalComputed(churnSignal);
    onSignalComputed(focusSignal);
  }
 
  if (isVerbose()) {
    console.log('[Reflection/Introspection] Computed Signals:', { churnSignal, focusSignal });
  }
 
  // push latest signals to memory buffer for tests and introspection consumers
  _pushLatestSignals([churnSignal, focusSignal]);
 
  // Reset aggregator for the next interval
  aggregator = createEmptyAggregator();
}
 
// ========================================
//   Public API
// ========================================
 
/**
 * Starts the introspection engine.
 * Subscribes to the awareness bus and starts the signal computation interval.
 * @param onComputed Callback function to be invoked when a signal is computed.
 */
export function startIntrospection(
  onComputed?: (signal: Signal) => void,
  intervalMs?: number
): void {
  if (isRunning || !isReflectionEnabled()) {
    return;
  }
 
  if (typeof intervalMs === 'number' && intervalMs > 0) {
    INTROSPECTION_INTERVAL = intervalMs;
  }
 
  if (isVerbose()) {
    console.log('[Reflection/Introspection] Starting engine...');
  }
 
  onSignalComputed = onComputed ?? null;
  unsubscribeFromAwareness = subscribe(processEvent);
  intervalId = setInterval(computeAndEmitSignals, INTROSPECTION_INTERVAL);
  isRunning = true;
}
 
/**
 * Stops the introspection engine.
 */
export function stopIntrospection(): void {
  if (!isRunning || !intervalId) {
    return;
  }
 
  if (isVerbose()) {
    console.log('[Reflection/Introspection] Stopping engine...');
  }
 
  clearInterval(intervalId);
  if (unsubscribeFromAwareness) {
    unsubscribeFromAwareness();
    unsubscribeFromAwareness = null;
  }
 
  intervalId = null;
  isRunning = false;
  onSignalComputed = null;
}
 
/**
 * Resets the engine's state.
 * (For testing purposes)
 */
export function _resetIntrospection(): void {
  stopIntrospection();
  aggregator = createEmptyAggregator();
}
 
// ------------------------------------------------------------------
// Test & compatibility exports
// ------------------------------------------------------------------
 
/**
 * Backwards-compatible name expected by tests.
 * startIntrospectionEngine(intervalOrOnComputed?) supports either
 * - nothing: uses internal interval and no onComputed
 * - a number: interval override
 * - a function: onComputed callback
 */
export function startIntrospectionEngine(arg?: any): void {
  // startIntrospectionEngine()
  if (arg === undefined) {
    startIntrospection();
    return;
  }
 
  // startIntrospectionEngine(interval: number)
  if (typeof arg === 'number') {
    startIntrospection(undefined, arg);
    return;
  }
 
  // startIntrospectionEngine(onComputed: function)
  if (typeof arg === 'function') {
    startIntrospection(arg as (s: Signal) => void);
    return;
  }
 
  // fallback
  startIntrospection();
}
 
export function stopIntrospectionEngine(): void {
  stopIntrospection();
}
 
/**
 * Manual computation helper for tests. Returns the computed signals array.
 */
export function computeSignalsNow(): Signal[] {
  const signals: Signal[] = [];
  const now = performance.now();
  const intervalInSeconds = INTROSPECTION_INTERVAL / 1000;
 
  const windowChurn =
    (aggregator.windowOpenCount + aggregator.windowCloseCount) / intervalInSeconds;
  signals.push({
    type: 'WINDOW_CHURN',
    value: windowChurn,
    timestamp: now,
    metadata: {
      opens: aggregator.windowOpenCount,
      closes: aggregator.windowCloseCount,
      interval: INTROSPECTION_INTERVAL,
    },
  });
 
  const focusStability = aggregator.focusChangeCount / intervalInSeconds;
  signals.push({
    type: 'FOCUS_STABILITY',
    value: focusStability,
    timestamp: now,
    metadata: { count: aggregator.focusChangeCount, interval: INTROSPECTION_INTERVAL },
  });
 
  // reset aggregator since this mimics the interval tick
  aggregator = createEmptyAggregator();
  return signals;
}
 
export function _resetIntrospectionForTests(): void {
  _resetIntrospection();
}