Skip to main content

Class: StatusUpdateManager

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:110

Manages status update subscriptions and event handling with efficient incremental updates.

Remarks​

Provides a centralized manager for subscribing to and handling real-time status updates from the backend. Handles IPC event management and cleanup automatically. Prioritizes incremental updates over full syncs for better performance.

Example​

const manager = new StatusUpdateManager({
    fullSyncFromBackend: () => syncSites(),
    getSites: () => store.getSites(),
    setSites: (sites) => store.setSites(sites),
});

manager.subscribe();

Constructors​

Constructor​

new StatusUpdateManager(options: StatusUpdateHandlerOptions): StatusUpdateManager

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:274

Constructs a new StatusUpdateManager instance.

Parameters​

options​

StatusUpdateHandlerOptions

Configuration options for the status update manager

Returns​

StatusUpdateManager

Remarks​

Initializes the manager with the required dependencies for status update handling. Does not start listening for events until subscribe() is called.

Properties​

cleanupFunctions​

private cleanupFunctions: () => void[] = []

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:121

Internal

Array of cleanup functions for active event listeners.

Returns​

void

Remarks​

Stores cleanup functions returned by IPC event listeners. These are called during unsubscribe() to properly remove event listeners and prevent memory leaks. Each function removes a specific event listener.

fullSyncFromBackend()​

private readonly fullSyncFromBackend: () => Promise<void>

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:133

Internal

Function to trigger full site data sync from backend.

Returns​

Promise<void>

Remarks​

Callback function provided during construction that performs a complete refresh of site data from the backend. Used as fallback when incremental updates fail or when a full sync is required.

getSites()​

private readonly getSites: () => Site[]

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:145

Internal

Function to get current sites from store.

Returns​

Site[]

Remarks​

Callback function that returns the current array of sites from the store state. Used to access current data when applying incremental status updates.

isListenerAttached​

private isListenerAttached: boolean = false

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:157

Internal

Flag tracking whether event listener is currently attached.

Remarks​

Boolean flag that tracks the subscription state. True when IPC event listeners are active and receiving status updates. Used to prevent duplicate subscriptions and to provide subscription status.

onUpdate​

private readonly onUpdate: undefined | (update: StatusUpdate) => void

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:169

Internal

Optional callback for status update notifications.

Remarks​

Optional callback function that is invoked when a status update is successfully applied. Receives the StatusUpdate object with details about the change. Can be used for logging or triggering side effects.

setSites()​

private readonly setSites: (sites: Site[]) => void

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:181

Internal

Function to update sites in the store.

Parameters​

sites​

Site[]

Returns​

void

Remarks​

Callback function that updates the store with a new array of sites. Used to apply incremental status updates and full sync results to the store state.

Methods​

handleIncrementalStatusUpdate()​

private handleIncrementalStatusUpdate(event: MonitorStatusChangedEvent): Promise<void>

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:196

Internal

Handle incremental status updates efficiently without full sync.

Parameters​

event​

MonitorStatusChangedEvent

Monitor status changed event data

Returns​

Promise<void>

Remarks​

Applies status changes directly to existing site/monitor data in the store. This is much more efficient than triggering a full sync for every status change. Falls back to full sync only if the site/monitor cannot be found.

isSubscribed()​

isSubscribed(): boolean

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:289

Check if currently subscribed to status updates.

Returns​

boolean

True if subscribed and listening for events, false otherwise

Remarks​

Returns true when event listeners are active.

subscribe()​

subscribe(): void

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:309

Subscribe to status updates from the backend with efficient incremental processing.

Returns​

void

Remarks​

Sets up IPC event listeners for monitor status changes and monitoring lifecycle events. Automatically performs an initial full sync when subscribing. Prioritizes incremental updates over full syncs for better performance.

Example​

manager.subscribe();

unsubscribe()​

unsubscribe(): void

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:399

Unsubscribe from all status update events.

Returns​

void

Remarks​

Cleans up all IPC event listeners and resets internal state. Safe to call multiple times - will not throw if already unsubscribed.

Example​

manager.unsubscribe();
console.log(manager.isSubscribed()); // false

applyMonitorStatusUpdate()​

private applyMonitorStatusUpdate(sites: Site[], site: Site, monitor: Monitor, event: MonitorStatusChangedEvent): Site[]

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:422

Internal

Apply monitor status update to sites array.

Parameters​

sites​

Site[]

Current sites array

site​

Site

Site containing the monitor

monitor​

Monitor

Monitor to update

event​

MonitorStatusChangedEvent

Status change event

Returns​

Site[]

Updated sites array

findMonitorInSite()​

private findMonitorInSite(site: Site, monitorId: string): undefined | Monitor

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:456

Internal

Find a monitor in a site by monitor ID.

Parameters​

site​

Site

Site to search for monitor

monitorId​

string

Monitor ID to find

Returns​

undefined | Monitor

Monitor if found, undefined otherwise

findSiteInStore()​

private findSiteInStore(sites: Site[], siteId: string): undefined | Site

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:473

Internal

Find a site in the store by identifier.

Parameters​

sites​

Site[]

Array of sites to search

siteId​

string

Site identifier to find

Returns​

undefined | Site

Site if found, undefined otherwise

isMonitorStatusChangedEvent()​

private isMonitorStatusChangedEvent(data: unknown): data is MonitorStatusChangedEvent

Defined in: src/stores/sites/utils/statusUpdateHandler.ts:491

Internal

Type guard to validate incoming data as MonitorStatusChangedEvent.

Parameters​

data​

unknown

Unknown data from IPC events

Returns​

data is MonitorStatusChangedEvent

True if data conforms to MonitorStatusChangedEvent interface

Remarks​

Performs structural validation to ensure the data has the expected shape for incremental processing. This helps prevent runtime errors from malformed data.