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
@@ -36,6 +36,12 @@
|
||||
min-height: 100%;
|
||||
}
|
||||
|
||||
.footerButtons {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-1);
|
||||
}
|
||||
|
||||
.sideFooter {
|
||||
margin-top: auto;
|
||||
padding: var(--space-3) var(--space-2) var(--space-2);
|
||||
|
||||
+9
-2
@@ -4,9 +4,10 @@ import { useTranslation } from 'react-i18next';
|
||||
import { Globe, Monitor, ClipboardList, Activity, KeyRound, Braces, Upload } from 'lucide-react';
|
||||
import type { LucideIcon } from 'lucide-react';
|
||||
import styles from './App.module.css';
|
||||
import { SidePanel, ThemeSwitcher } from './ui';
|
||||
import { NotificationToggle, SidePanel, ThemeSwitcher } from './ui';
|
||||
import liqaLogo from './assets/liqa.svg';
|
||||
import { useManifest } from './hooks/useManifest';
|
||||
import { useRunNotifications } from './hooks/useRunNotifications';
|
||||
|
||||
const EnvironmentsPage = lazy(() =>
|
||||
import('./pages/environment/EnvironmentsPage').then((m) => ({ default: m.EnvironmentsPage })),
|
||||
@@ -109,6 +110,7 @@ const NAV: ({ path: string; labelKey: string; Icon: LucideIcon } | { separator:
|
||||
export default function App() {
|
||||
const { t } = useTranslation();
|
||||
const { version } = useManifest();
|
||||
const notifications = useRunNotifications();
|
||||
|
||||
return (
|
||||
<div className={styles.shell}>
|
||||
@@ -141,7 +143,12 @@ export default function App() {
|
||||
</nav>
|
||||
|
||||
<div className={styles.sideFooter}>
|
||||
<ThemeSwitcher />
|
||||
<div className={styles.footerButtons}>
|
||||
<ThemeSwitcher />
|
||||
{notifications && (
|
||||
<NotificationToggle state={notifications.state} onToggle={notifications.toggle} />
|
||||
)}
|
||||
</div>
|
||||
<div className={styles.version}>
|
||||
<span
|
||||
title={
|
||||
|
||||
@@ -28,6 +28,9 @@ const BASE_URL = ((import.meta.env.VITE_API_URL as string | undefined) ?? '/api/
|
||||
'',
|
||||
);
|
||||
|
||||
/** URL of the server-sent events stream of run lifecycle events. */
|
||||
export const RUN_EVENTS_URL = `${BASE_URL}/scenarios/runs/events`;
|
||||
|
||||
async function request<T>(path: string, init?: RequestInit): Promise<T> {
|
||||
let res: Response;
|
||||
try {
|
||||
|
||||
@@ -234,3 +234,13 @@ export interface ImportedItem {
|
||||
export interface ImportResult {
|
||||
imported: ImportedItem[];
|
||||
}
|
||||
|
||||
/** Run lifecycle event pushed by the server on `GET /scenarios/runs/events`. */
|
||||
export interface RunEvent {
|
||||
type: 'run.started' | 'run.finished';
|
||||
runId: string;
|
||||
scenarioId: string;
|
||||
scenarioName: string;
|
||||
status: ScenarioRunStatus;
|
||||
at: string;
|
||||
}
|
||||
@@ -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,
|
||||
};
|
||||
}
|
||||
@@ -235,6 +235,17 @@
|
||||
"light_mode": "Light mode",
|
||||
"dark_mode": "Dark mode"
|
||||
},
|
||||
"notifications": {
|
||||
"enable": "Enable browser notifications for runs",
|
||||
"disable": "Disable browser notifications for runs",
|
||||
"blocked": "Notifications are blocked in your browser settings",
|
||||
"run_started_title": "Run started: {{scenario}}",
|
||||
"run_started_body": "The scenario run is in progress.",
|
||||
"run_pass_title": "Run passed: {{scenario}}",
|
||||
"run_pass_body": "All steps passed.",
|
||||
"run_fail_title": "Run failed: {{scenario}}",
|
||||
"run_fail_body": "The scenario run failed."
|
||||
},
|
||||
"revealable": {
|
||||
"hidden": "Hidden so secrets aren't exposed on screen.",
|
||||
"reveal": "Reveal",
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
.btn {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 28px;
|
||||
height: 28px;
|
||||
padding: 0;
|
||||
background: none;
|
||||
border: var(--border-width) solid var(--color-border);
|
||||
border-radius: var(--radius-md);
|
||||
color: var(--color-text-muted);
|
||||
cursor: pointer;
|
||||
flex-shrink: 0;
|
||||
transition: background var(--transition), color var(--transition), border-color var(--transition);
|
||||
}
|
||||
|
||||
.btn:hover {
|
||||
background: var(--color-bg-subtle);
|
||||
color: var(--color-text);
|
||||
border-color: var(--color-text-muted);
|
||||
}
|
||||
|
||||
.btn:active {
|
||||
background: var(--color-secondary);
|
||||
color: var(--color-secondary-fg);
|
||||
}
|
||||
|
||||
.btn:disabled {
|
||||
opacity: 0.5;
|
||||
cursor: not-allowed;
|
||||
}
|
||||
|
||||
.btn:disabled:hover {
|
||||
background: none;
|
||||
color: var(--color-text-muted);
|
||||
border-color: var(--color-border);
|
||||
}
|
||||
|
||||
.btn[aria-pressed='true'] {
|
||||
color: var(--color-text);
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
import { Bell, BellOff } from 'lucide-react';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import styles from './NotificationToggle.module.css';
|
||||
|
||||
/**
|
||||
* - `on`: notifications are enabled
|
||||
* - `off`: available, but not enabled (or permission not asked yet)
|
||||
* - `blocked`: the browser denied the permission
|
||||
*/
|
||||
export type NotificationToggleState = 'on' | 'off' | 'blocked';
|
||||
|
||||
export interface NotificationToggleProps {
|
||||
state: NotificationToggleState;
|
||||
onToggle: () => void;
|
||||
}
|
||||
|
||||
export function NotificationToggle({ state, onToggle }: NotificationToggleProps) {
|
||||
const { t } = useTranslation();
|
||||
const label =
|
||||
state === 'on'
|
||||
? t('notifications.disable')
|
||||
: state === 'blocked'
|
||||
? t('notifications.blocked')
|
||||
: t('notifications.enable');
|
||||
|
||||
return (
|
||||
<button
|
||||
type="button"
|
||||
className={styles.btn}
|
||||
onClick={onToggle}
|
||||
disabled={state === 'blocked'}
|
||||
aria-label={label}
|
||||
aria-pressed={state === 'on'}
|
||||
title={label}
|
||||
>
|
||||
{state === 'on' ? <Bell size={16} /> : <BellOff size={16} />}
|
||||
</button>
|
||||
);
|
||||
}
|
||||
@@ -26,6 +26,8 @@ export { Breadcrumbs } from './Breadcrumbs/Breadcrumbs';
|
||||
export type { BreadcrumbsProps, BreadcrumbItem } from './Breadcrumbs/Breadcrumbs';
|
||||
|
||||
export { ThemeSwitcher } from './ThemeSwitcher/ThemeSwitcher';
|
||||
export { NotificationToggle } from './NotificationToggle/NotificationToggle';
|
||||
export type { NotificationToggleState } from './NotificationToggle/NotificationToggle';
|
||||
|
||||
export { ToastProvider } from './Toast/ToastProvider';
|
||||
export type { ToastProviderProps } from './Toast/ToastProvider';
|
||||
|
||||
Reference in new issue
Block a user