feat: browser notifications for scenario runs
- add RunEventsService and emit run.started / run.finished from the scheduler - stream run events over SSE at GET /api/v1/scenarios/runs/events with a heartbeat - add useRunNotifications hook and NotificationToggle (opt-in bell in the side panel footer) - refresh runs lists when a run finishes - document the events stream and notifications Closes #12
This commit is contained in:
18 files changed
+503
-6
No files matched your search
@@ -0,0 +1,124 @@
|
||||
import { useCallback, useEffect, useRef, useState } from 'react';
|
||||
import { useQueryClient } from '@tanstack/react-query';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { RUN_EVENTS_URL } from '../api/client';
|
||||
import type { RunEvent } from '../api/types';
|
||||
import type { NotificationToggleState } from '../ui';
|
||||
|
||||
const STORAGE_KEY = 'liqa-run-notifications';
|
||||
|
||||
function supported(): boolean {
|
||||
return typeof window !== 'undefined' && 'Notification' in window && 'EventSource' in window;
|
||||
}
|
||||
|
||||
function readEnabled(): boolean {
|
||||
try {
|
||||
return localStorage.getItem(STORAGE_KEY) === '1';
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function writeEnabled(enabled: boolean): void {
|
||||
try {
|
||||
localStorage.setItem(STORAGE_KEY, enabled ? '1' : '0');
|
||||
} catch {
|
||||
// storage unavailable: the choice just doesn't persist
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Opt-in browser notifications for run start/finish, driven by the server's
|
||||
* run events stream (so runs started from the API, MCP or the scheduler are
|
||||
* covered too). Returns `null` when the browser lacks Notification/EventSource.
|
||||
*/
|
||||
export function useRunNotifications(): {
|
||||
state: NotificationToggleState;
|
||||
toggle: () => void;
|
||||
} | null {
|
||||
const isSupported = supported();
|
||||
const { t } = useTranslation();
|
||||
const navigate = useNavigate();
|
||||
const queryClient = useQueryClient();
|
||||
const [enabled, setEnabled] = useState(readEnabled);
|
||||
const [permission, setPermission] = useState<NotificationPermission>(() =>
|
||||
isSupported ? Notification.permission : 'denied',
|
||||
);
|
||||
|
||||
// Latest callbacks without reopening the stream when they change
|
||||
const handlers = useRef({ t, navigate });
|
||||
useEffect(() => {
|
||||
handlers.current = { t, navigate };
|
||||
});
|
||||
|
||||
const active = isSupported && enabled && permission === 'granted';
|
||||
|
||||
useEffect(() => {
|
||||
if (!active) return;
|
||||
const source = new EventSource(RUN_EVENTS_URL);
|
||||
|
||||
const onEvent = (message: MessageEvent<string>) => {
|
||||
let event: RunEvent;
|
||||
try {
|
||||
event = JSON.parse(message.data) as RunEvent;
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
if (event.type === 'run.finished') {
|
||||
void queryClient.invalidateQueries({ queryKey: ['runs'] });
|
||||
}
|
||||
const { t: translate, navigate: go } = handlers.current;
|
||||
const key =
|
||||
event.type === 'run.started'
|
||||
? 'run_started'
|
||||
: event.status === 'pass'
|
||||
? 'run_pass'
|
||||
: 'run_fail';
|
||||
const notification = new Notification(
|
||||
translate(`notifications.${key}_title`, { scenario: event.scenarioName }),
|
||||
{
|
||||
body: translate(`notifications.${key}_body`),
|
||||
// finished replaces started for the same run
|
||||
tag: event.runId,
|
||||
},
|
||||
);
|
||||
notification.onclick = () => {
|
||||
window.focus();
|
||||
go(`/scenarios/${event.scenarioId}/runs/${event.runId}`);
|
||||
notification.close();
|
||||
};
|
||||
};
|
||||
|
||||
source.addEventListener('run.started', onEvent as EventListener);
|
||||
source.addEventListener('run.finished', onEvent as EventListener);
|
||||
return () => source.close();
|
||||
}, [active, queryClient]);
|
||||
|
||||
const toggle = useCallback(() => {
|
||||
if (!isSupported) return;
|
||||
if (Notification.permission === 'default') {
|
||||
void Notification.requestPermission().then((result) => {
|
||||
setPermission(result);
|
||||
if (result === 'granted') {
|
||||
setEnabled(true);
|
||||
writeEnabled(true);
|
||||
}
|
||||
});
|
||||
return;
|
||||
}
|
||||
if (Notification.permission !== 'granted') {
|
||||
setPermission(Notification.permission);
|
||||
return;
|
||||
}
|
||||
const next = !enabled;
|
||||
setEnabled(next);
|
||||
writeEnabled(next);
|
||||
}, [isSupported, enabled]);
|
||||
|
||||
if (!isSupported) return null;
|
||||
return {
|
||||
state: permission === 'denied' ? 'blocked' : active ? 'on' : 'off',
|
||||
toggle,
|
||||
};
|
||||
}
|
||||
Reference in new issue
Block a user