Back to Worldmonitor

State Management

docs/Docs_To_Review/STATE_MANAGEMENT.md

2.5.2323.8 KB
Original Source

State Management

World Monitor is an AI-powered real-time global intelligence dashboard built with vanilla TypeScript — no framework, no reactive stores. All state is managed manually through class properties, localStorage, IndexedDB, and URL query parameters.

This document is the canonical reference for how state is stored, updated, and persisted across the application.


Table of Contents

  1. Application State Flow
  2. App.ts State Properties & Lifecycle
  3. Panel State Persistence
  4. Theme State Management
  5. IndexedDB Storage Schema
  6. URL State Encoding/Decoding
  7. Runtime Config State (Desktop)
  8. Activity Tracking & Idle Detection
  9. All localStorage Keys

1. Application State Flow

There is no framework — the entire app is a single App class in src/App.ts (~4,300 lines) that orchestrates every service, component, and piece of state. State changes flow through direct method calls and property writes. Components extend a Panel base class defined in src/components/Panel.ts.

Initialization Sequence

mermaid
flowchart TD
    A["new App(containerId)"] --> B["constructor()"]
    B --> B1["Variant detection"]
    B --> B2["Panel order migration"]
    B --> B3["URL state parsing"]
    B --> B4["Mobile detection"]
    B --> B5["Disabled sources loading"]

    B --> C["init()"]
    C --> C1["initDB()"]
    C1 --> C2["initI18n()"]
    C2 --> C3["mlWorker.init()"]
    C3 --> C4["AIS config check"]
    C4 --> C5["renderLayout()"]
    C5 --> C6["Setup handlers"]
    C6 --> C7["preloadCountryGeometry()"]
    C7 --> C8["loadAllData()"]

    C8 --> D["Post-load"]
    D --> D1["startLearning()"]
    D --> D2["setupRefreshIntervals()"]
    D --> D3["setupSnapshotSaving()"]
    D --> D4["cleanOldSnapshots()"]
    D --> D5["handleDeepLinks()"]
    D --> D6["checkForUpdate() (desktop)"]

Data Flow Pattern

Every state update follows the same pattern:

mermaid
flowchart LR
    Fetch["Service fetch"] --> Process["App method processes response"]
    Process --> State["Update private properties"]
    State --> Component["Call component update methods"]
    Component --> DOM["DOM updates"]
  1. A service function fetches data from an API endpoint.
  2. An App method receives the response and stores it in a private property (e.g. this.allNews).
  3. The method calls update methods on the relevant components (e.g. newsPanel.updateItems(items)).
  4. The component manipulates the DOM directly.

There are no observables, signals, or virtual DOM — every update is an explicit imperative call.


2. App.ts State Properties & Lifecycle

All state lives as private properties on the App class. Grouped by purpose:

Data State

typescript
private allNews: NewsItem[] = [];
private newsByCategory: Record<string, NewsItem[]> = {};
private latestPredictions: PredictionMarket[] = [];
private latestMarkets: MarketData[] = [];
private latestClusters: ClusteredEvent[] = [];
private currentTimeRange: TimeRange = '7d';
private monitors: Monitor[];
private panelSettings: Record<string, PanelConfig>;
private mapLayers: MapLayers;
private cyberThreatsCache: CyberThreat[] | null = null;

Component References

typescript
private map: MapContainer | null = null;
private panels: Record<string, Panel> = {};
private newsPanels: Record<string, NewsPanel> = {};
private signalModal: SignalModal | null = null;
private playbackControl: PlaybackControl | null = null;
private statusPanel: StatusPanel | null = null;
private exportPanel: ExportPanel | null = null;
private languageSelector: LanguageSelector | null = null;
private searchModal: SearchModal | null = null;
private mobileWarningModal: MobileWarningModal | null = null;
private pizzintIndicator: PizzIntIndicator | null = null;
private countryBriefPage: CountryBriefPage | null = null;
private countryTimeline: CountryTimeline | null = null;
private findingsBadge: IntelligenceGapBadge | null = null;
private criticalBannerEl: HTMLElement | null = null;

UI State

typescript
private isPlaybackMode = false;          // playback / historical mode toggle
private isMobile: boolean;               // detected at construction
private initialLoadComplete = false;     // first data load complete flag
private isIdle = false;                  // idle detection state
private isDestroyed = false;             // cleanup flag
private readonly isDesktopApp: boolean;  // Tauri runtime detection

Infrastructure State

typescript
private initialUrlState: ParsedMapUrlState | null = null;
private inFlight: Set<string> = new Set();             // currently-running fetch keys
private seenGeoAlerts: Set<string> = new Set();         // deduplicate geo alerts
private disabledSources: Set<string> = new Set();       // user-disabled news sources
private mapFlashCache: Map<string, number> = new Map(); // cooldown for map flash animations
private pendingDeepLinkCountry: string | null = null;   // URL deep-link target
private briefRequestToken = 0;                          // cancellation token for async ops

Timer / Interval IDs

typescript
private snapshotIntervalId: ReturnType<typeof setInterval> | null = null;
private refreshTimeoutIds: Map<string, ReturnType<typeof setTimeout>> = new Map();
private idleTimeoutId: ReturnType<typeof setTimeout> | null = null;

Event Handler Refs (for cleanup)

typescript
private boundKeydownHandler: ((e: KeyboardEvent) => void) | null = null;
private boundFullscreenHandler: (() => void) | null = null;
private boundResizeHandler: (() => void) | null = null;
private boundVisibilityHandler: (() => void) | null = null;
private boundIdleResetHandler: (() => void) | null = null;

Constants

typescript
private readonly PANEL_ORDER_KEY = 'panel-order';
private readonly IDLE_PAUSE_MS = 2 * 60 * 1000;          // 2 minutes
private readonly MAP_FLASH_COOLDOWN_MS = 10 * 60 * 1000;  // 10 minutes

Static Properties

typescript
private static COUNTRY_BOUNDS: Record<string, { n: number; s: number; e: number; w: number }>;
private static COUNTRY_ALIASES: Record<string, string[]>;
private static otherCountryTermsCache: Map<string, string[]> = new Map();

Lifecycle Diagram

mermaid
stateDiagram-v2
    [*] --> Construct: new App()
    Construct --> Init: init()
    Init --> Loading: loadAllData()
    Loading --> Running: data loaded
    Running --> Idle: 2 min no interaction
    Idle --> Running: user interaction
    Running --> Destroyed: destroy()
    Idle --> Destroyed: destroy()
    Destroyed --> [*]

    state Running {
        [*] --> Refreshing
        Refreshing --> Waiting: fetch complete
        Waiting --> Refreshing: interval fires
    }

Destroy tears down everything: clears all intervals/timeouts, removes event listeners, calls destroy() on all components, nullifies references.


3. Panel State Persistence

Panels use localStorage for persistence. Defined in src/components/Panel.ts:

Panel Spans

typescript
const PANEL_SPANS_KEY = 'worldmonitor-panel-spans';

// Stored as Record<string, number> — panel ID → grid span (1–4)
function loadPanelSpans(): Record<string, number> {
  const stored = localStorage.getItem(PANEL_SPANS_KEY);
  return stored ? JSON.parse(stored) : {};
}

function savePanelSpan(panelId: string, span: number): void {
  const spans = loadPanelSpans();
  spans[panelId] = span;
  localStorage.setItem(PANEL_SPANS_KEY, JSON.stringify(spans));
}

Height-to-Span Conversion

typescript
function heightToSpan(height: number): number {
  if (height >= 500) return 4;
  if (height >= 350) return 3;
  if (height >= 250) return 2;
  return 1;
}

Users drag-resize panels; the pixel height is converted to a span (1–4), which is persisted and applied as a CSS class (span-1 through span-4).

Panel Order

Stored in localStorage under panel-order as a JSON string[] of panel IDs. The App constructor reads the saved order and applies it to the grid layout. Migrations reorder panels for new versions (e.g. the v1.9 migration promotes insights, strategic-posture, cii, strategic-risk to the top).

Panel Settings

Stored in localStorage under worldmonitor-panels as Record<string, PanelConfig>. Includes per-panel enabled state, name, and priority. Controlled by the variant config and user overrides.

STORAGE_KEYS

Defined in src/config/variants/base.ts (and mirrored in src/config/panels.ts):

typescript
export const STORAGE_KEYS = {
  panels:        'worldmonitor-panels',
  monitors:      'worldmonitor-monitors',
  mapLayers:     'worldmonitor-layers',
  disabledFeeds: 'worldmonitor-disabled-feeds',
} as const;
KeyTypePurpose
worldmonitor-panelsRecord<string, PanelConfig>Per-panel enabled/name/priority
worldmonitor-monitorsMonitor[]Color/label configs for monitors
worldmonitor-layersMapLayersEnabled/disabled map layer toggles
worldmonitor-disabled-feedsstring[]User-disabled news feed sources

4. Theme State Management

Defined in src/utils/theme-manager.ts. Supported themes: 'dark' | 'light'.

Storage

  • Key: worldmonitor-theme
  • Default: 'dark'

API

typescript
// Read stored preference (falls back to 'dark')
getStoredTheme(): Theme

// Read current DOM theme (from data-theme attribute)
getCurrentTheme(): Theme

// Full theme switch: DOM + cache invalidation + persist + meta + event
setTheme(theme: Theme): void

// Early bootstrap: sets data-theme + meta only (no events)
applyStoredTheme(): void

Theme Application Flow

mermaid
sequenceDiagram
    participant User
    participant setTheme
    participant DOM
    participant ColorCache
    participant localStorage
    participant Window

    User->>setTheme: setTheme('light')
    setTheme->>DOM: data-theme = 'light'
    setTheme->>ColorCache: invalidateColorCache()
    setTheme->>localStorage: setItem('worldmonitor-theme', 'light')
    setTheme->>DOM: meta[theme-color].content = '#f8f9fa'
    setTheme->>Window: dispatchEvent('theme-changed')

Color Cache

src/utils/theme-colors.ts provides getCSSColor(varName) which reads computed CSS custom properties and caches them. The cache auto-invalidates when the data-theme attribute changes:

typescript
const colorCache = new Map<string, string>();
let cacheTheme = '';

export function getCSSColor(varName: string): string {
  const currentTheme = document.documentElement.dataset.theme || 'dark';
  if (currentTheme !== cacheTheme) {
    colorCache.clear();
    cacheTheme = currentTheme;
  }
  // ...read from cache or compute
}

export function invalidateColorCache(): void {
  colorCache.clear();
  cacheTheme = '';
}

CSS Integration

All colors are driven by CSS custom properties under [data-theme] selectors. Components never hardcode colors — they read from the CSS variable system. Meta theme-color values:

Theme#meta[theme-color]
dark#0a0f0a
light#f8f9fa

5. IndexedDB Storage Schema

Defined in src/services/storage.ts.

  • Database name: worldmonitor_db
  • Version: 1
  • Stores: baselines, snapshots

Store: baselines

Tracks statistical baselines for anomaly detection.

FieldTypeDescription
keystring (keyPath)Metric identifier
countsnumber[]Rolling 30-day count observations
timestampsnumber[]Corresponding observation timestamps
avg7dnumberRolling 7-day average
avg30dnumberRolling 30-day average
lastUpdatednumberLast update timestamp

Key operations:

typescript
// Push new observation, trim to 30-day window, recalculate averages
updateBaseline(key: string, currentCount: number): Promise<BaselineEntry>

// Calculate z-score deviation level
calculateDeviation(current: number, baseline: BaselineEntry): {
  zScore: number;
  percentChange: number;
  level: 'normal' | 'elevated' | 'spike' | 'quiet';
}

Deviation thresholds:

  • zScore > 2.5'spike'
  • zScore > 1.5'elevated'
  • zScore < -2'quiet'
  • Otherwise → 'normal'

Store: snapshots

Periodic dashboard state captures for historical playback.

FieldTypeDescription
timestampnumber (keyPath)Snapshot creation time
eventsunknown[]Event state at time of capture
marketPricesRecord<string, number>Market prices at capture
predictionsArray<{title, yesPrice}>Prediction market state
hotspotLevelsRecord<string, string>Hotspot intensity levels

Index: by_time on timestamp.

Key operations:

typescript
saveSnapshot(snapshot: DashboardSnapshot): Promise<void>
getSnapshots(fromTime?, toTime?): Promise<DashboardSnapshot[]>
getSnapshotAt(timestamp: number): Promise<DashboardSnapshot | null>  // nearest ±15 min
cleanOldSnapshots(): Promise<void>  // removes entries older than 7 days
getSnapshotTimestamps(): Promise<number[]>

Retention: SNAPSHOT_RETENTION_DAYS = 7.

Initialization

typescript
export async function initDB(): Promise<IDBDatabase> {
  // Opens or creates worldmonitor_db v1
  // Creates 'baselines' store (keyPath: 'key')
  // Creates 'snapshots' store (keyPath: 'timestamp', index: 'by_time')
}

All store operations use a retry-aware withTransaction() helper that re-opens the database on InvalidStateError (connection closing).

Data Flow Through IndexedDB

mermaid
flowchart TD
    subgraph Write Path
        A["Service fetches data"] --> B["App.updateBaseline()"]
        B --> C["storage.updateBaseline()"]
        C --> D["IDB baselines store"]

        E["Snapshot interval fires"] --> F["App.saveSnapshot()"]
        F --> G["storage.saveSnapshot()"]
        G --> H["IDB snapshots store"]
    end

    subgraph Read Path
        I["Anomaly check"] --> J["storage.calculateDeviation()"]
        J --> K["Read from baselines"]

        L["Playback mode"] --> M["storage.getSnapshotAt()"]
        M --> N["Read from snapshots"]
    end

6. URL State Encoding/Decoding

Defined in src/utils/urlState.ts. Used for sharing dashboard state via links and for deep-linking.

ParsedMapUrlState Interface

typescript
export interface ParsedMapUrlState {
  view?: MapView;
  zoom?: number;
  lat?: number;
  lon?: number;
  timeRange?: TimeRange;
  layers?: MapLayers;
  country?: string;
}

Supported Query Parameters

ParamTypeRange/ValuesExample
viewMapViewglobal, america, mena, eu, asia, latam, africa, oceania?view=mena
zoomnumber1–10 (clamped)?zoom=5
latnumber-90–90 (clamped)?lat=33.2
lonnumber-180–180 (clamped)?lon=44.1
timeRangeTimeRange1h, 6h, 24h, 48h, 7d, all?t=24h
layersstringComma-separated layer keys or none?layers=earthquakes,flights
countrystringISO 3166-1 alpha-2 code?country=UA

Layer Keys (29 supported)

typescript
const LAYER_KEYS: (keyof MapLayers)[] = [
  'conflicts', 'bases', 'cables', 'pipelines', 'hotspots', 'ais',
  'nuclear', 'irradiators', 'sanctions', 'weather', 'economic',
  'waterways', 'outages', 'cyberThreats', 'datacenters', 'protests',
  'flights', 'military', 'natural', 'spaceports', 'minerals', 'fires',
  'ucdpEvents', 'displacement', 'climate', 'startupHubs', 'cloudRegions',
  'accelerators', 'techHQs', 'techEvents',
];

URL Application Flow

mermaid
sequenceDiagram
    participant URL
    participant Constructor
    participant Init
    participant Map

    URL->>Constructor: window.location.search
    Constructor->>Constructor: parseMapUrlState(search, fallbackLayers)
    Constructor->>Constructor: Store as initialUrlState
    Note over Constructor: Apply layers override if present

    Constructor->>Init: init()
    Init->>Init: parseMapUrlState() again for pendingDeepLinkCountry
    Init->>Init: setupUrlStateSync()
    Init->>Map: Apply view, zoom, center from initialUrlState

Building Shareable URLs

typescript
buildMapUrl(baseUrl: string, state: {
  view: MapView;
  zoom: number;
  center?: { lat: number; lon: number } | null;
  timeRange: TimeRange;
  layers: MapLayers;
  country?: string;
}): string

Produces a full URL with all active state encoded in query parameters.


7. Runtime Config State (Desktop)

Defined in src/services/runtime-config.ts. Manages API keys and feature toggles for the desktop (Tauri) app.

Secret Keys

typescript
export type RuntimeSecretKey =
  | 'GROQ_API_KEY'
  | 'OPENROUTER_API_KEY'
  | 'FRED_API_KEY'
  | 'EIA_API_KEY'
  | 'CLOUDFLARE_API_TOKEN'
  | 'ACLED_ACCESS_TOKEN'
  | 'URLHAUS_AUTH_KEY'
  | 'OTX_API_KEY'
  | 'ABUSEIPDB_API_KEY'
  | 'WINGBITS_API_KEY'
  | 'WS_RELAY_URL'
  | 'VITE_OPENSKY_RELAY_URL'
  | 'OPENSKY_CLIENT_ID'
  | 'OPENSKY_CLIENT_SECRET'
  | 'AISSTREAM_API_KEY'
  | 'FINNHUB_API_KEY'
  | 'NASA_FIRMS_API_KEY'
  | 'UC_DP_KEY';

Feature Toggles

typescript
export type RuntimeFeatureId =
  | 'aiGroq'          | 'aiOpenRouter'
  | 'economicFred'    | 'energyEia'
  | 'internetOutages' | 'acledConflicts'
  | 'abuseChThreatIntel' | 'alienvaultOtxThreatIntel'
  | 'abuseIpdbThreatIntel' | 'wingbitsEnrichment'
  | 'aisRelay'        | 'openskyRelay'
  | 'finnhubMarkets'  | 'nasaFirms';

All toggles default to true.

Storage Model

mermaid
flowchart TD
    subgraph Desktop
        A["OS Keychain (Tauri IPC)"] -->|secrets| B["RuntimeConfig"]
        C["localStorage"] -->|feature toggles| B
    end

    subgraph Web
        D["Environment vars / Vercel"] -->|secrets| E["RuntimeConfig"]
        F["Not applicable"] -.->|feature toggles| E
    end
  • Toggles key: worldmonitor-runtime-feature-toggles in localStorage
  • Toggles format: Record<RuntimeFeatureId, boolean> (JSON)
  • Secrets (desktop): stored in the OS keychain via Tauri IPC commands (read_secret, write_secret)
  • Secrets (web): sourced from environment variables at build time

RuntimeFeatureDefinition

typescript
export interface RuntimeFeatureDefinition {
  id: RuntimeFeatureId;
  name: string;
  description: string;
  requiredSecrets: RuntimeSecretKey[];
  desktopRequiredSecrets?: RuntimeSecretKey[];
  fallback: string;
}

Each feature definition specifies which secrets it requires. The settings UI validates that all required secrets are present before allowing a feature to be enabled.


8. Activity Tracking & Idle Detection

Activity Tracker

Defined in src/services/activity-tracker.ts. Tracks item freshness across panels.

typescript
export interface ActivityState {
  seenIds: Set<string>;                    // Items user has "seen"
  firstSeenTime: Map<string, number>;      // When items first appeared
  newCount: number;                        // Unseen items count
  lastInteraction: number;                 // Last user interaction timestamp
}

Timing constants:

ConstantValuePurpose
NEW_TAG_DURATION_MS2 * 60 * 1000 (2 min)Duration to show "NEW" badge
HIGHLIGHT_DURATION_MS30 * 1000 (30 sec)Duration for highlight glow effect

Key operations:

typescript
// Initialize tracking for a panel
register(panelId: string): void

// Update items and compute new count — returns array of new item IDs
updateItems(panelId: string, itemIds: string[]): string[]

// Mark all items as seen (user interacted with panel)
markAsSeen(panelId: string): void

Items are "new" (show badge) for 2 minutes after first appearance, and "highlighted" (glow effect) for 30 seconds.

Activity Item Lifecycle

mermaid
stateDiagram-v2
    [*] --> New: First observed
    New --> Highlighted: 0–30 sec
    Highlighted --> Tagged: 30 sec–2 min
    Tagged --> Seen: markAsSeen() or 2 min elapsed
    Seen --> [*]: Item removed from feed

    note right of Highlighted: Glow effect active
    note right of Tagged: "NEW" badge visible

Idle Detection

Implemented directly in App.ts:

typescript
private readonly IDLE_PAUSE_MS = 2 * 60 * 1000; // 2 minutes
private isIdle = false;
private idleTimeoutId: ReturnType<typeof setTimeout> | null = null;
private boundIdleResetHandler: (() => void) | null = null;

Behavior when idle:

  • Animations are paused
  • Refresh frequency is reduced
  • The isIdle flag is checked by refresh methods

Reset triggers: any user interaction event (mouse move, click, keydown, scroll, touch).

mermaid
stateDiagram-v2
    [*] --> Active: App starts
    Active --> Idle: No interaction for 2 min
    Idle --> Active: User interaction detected

    note right of Active: Full refresh rate, animations on
    note right of Idle: Reduced refresh, animations paused

9. All localStorage Keys

Complete reference of every localStorage key used by World Monitor:

KeyPurposeFormatSource
worldmonitor-variantActive variant override'full' | 'tech' | 'finance'src/config/variant.ts, App.ts
worldmonitor-themeTheme preference'dark' | 'light'src/utils/theme-manager.ts
panel-orderPanel arrangement orderstring[] (JSON)App.ts
worldmonitor-panel-spansPanel grid sizesRecord<string, number> (JSON)src/components/Panel.ts
worldmonitor-panelsPanel enabled/config stateRecord<string, PanelConfig> (JSON)STORAGE_KEYS.panels
worldmonitor-monitorsMonitor color/label configsMonitor[] (JSON)STORAGE_KEYS.monitors
worldmonitor-layersMap layer togglesMapLayers (JSON)STORAGE_KEYS.mapLayers
worldmonitor-disabled-feedsUser-disabled news sourcesstring[] (JSON)STORAGE_KEYS.disabledFeeds
worldmonitor-runtime-feature-togglesDesktop feature togglesRecord<RuntimeFeatureId, boolean> (JSON)src/services/runtime-config.ts
worldmonitor-persistent-cache:{key}Persistent data cache entriesCacheEnvelope<T> (JSON)src/services/persistent-cache.ts
wm-update-dismissed-{version}Dismissed update notifications'1'App.ts
worldmonitor-panel-order-v1.9Panel order migration flag'done'App.ts (one-time migration)
worldmonitor-tech-insights-top-v1Tech variant migration flag'done'App.ts (one-time migration)

CacheEnvelope Format

Used by the persistent cache system (src/services/persistent-cache.ts):

typescript
type CacheEnvelope<T> = {
  key: string;
  updatedAt: number;
  data: T;
};

On desktop (Tauri), the persistent cache prefers the Tauri IPC bridge (read_cache_entry / write_cache_entry) and falls back to localStorage on failure. On web, localStorage is always used.


Summary

mermaid
flowchart TB
    subgraph "Persistent Storage"
        LS["localStorage"]
        IDB["IndexedDB (worldmonitor_db)"]
        KC["OS Keychain (desktop only)"]
    end

    subgraph "Volatile State"
        APP["App.ts private properties"]
        COMP["Component instances"]
        TRACK["ActivityTracker"]
    end

    subgraph "Entry Points"
        URL["URL query params"]
        ENV["Environment variables"]
    end

    URL -->|"parseMapUrlState()"| APP
    ENV -->|"runtime-config"| APP
    LS -->|"loadFromStorage()"| APP
    IDB -->|"initDB() / getBaseline()"| APP
    KC -->|"Tauri IPC"| APP

    APP -->|"saveToStorage()"| LS
    APP -->|"updateBaseline() / saveSnapshot()"| IDB
    APP --> COMP
    APP --> TRACK

    COMP -->|"savePanelSpan()"| LS

All state management is explicit and imperative. There is no reactivity system — when data changes, the code that changed it is responsible for propagating the update to every consumer.