Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
747400ea25 | ||
|
|
6ae0087213 | ||
|
|
d6548c56fd | ||
|
|
23f059d9a4 | ||
|
|
9b9f33b270 | ||
|
|
7d7a379ce0 | ||
|
|
91f82d60e3 |
+12
-1
@@ -12,5 +12,16 @@
|
|||||||
"enabled": false,
|
"enabled": false,
|
||||||
"basename": "/"
|
"basename": "/"
|
||||||
},
|
},
|
||||||
"gifApiKey": ""
|
"gifApiKey": "",
|
||||||
|
"statusPages": {
|
||||||
|
"matrix.lotusguild.org": {
|
||||||
|
"url": "https://isitup.lotusguild.org",
|
||||||
|
"slug": "matrix",
|
||||||
|
"groups": {
|
||||||
|
"homeserver": "Homeserver",
|
||||||
|
"calls": "Voice calls",
|
||||||
|
"login": "Login"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,162 @@
|
|||||||
|
import { test, expect, Page } from '@playwright/test';
|
||||||
|
import {
|
||||||
|
HS,
|
||||||
|
createRoom,
|
||||||
|
ensureUser,
|
||||||
|
hsReachable,
|
||||||
|
loginUI,
|
||||||
|
openRoom,
|
||||||
|
uniq,
|
||||||
|
TestUser,
|
||||||
|
} from './localHs';
|
||||||
|
|
||||||
|
// [Gitea #124] Status banner from the homeserver's Uptime Kuma page. Kuma is
|
||||||
|
// answered by fixtures here; nothing contacts a real Kuma.
|
||||||
|
const KUMA = 'https://isitup.lotusguild.org';
|
||||||
|
const PAGE_CFG = { url: KUMA, slug: 'matrix' };
|
||||||
|
const UP = 1;
|
||||||
|
const DOWN = 0;
|
||||||
|
|
||||||
|
type Fixture = { hs?: number; calls?: number; staleMinutes?: number; fail?: boolean };
|
||||||
|
|
||||||
|
const kumaTime = (ms: number) => new Date(ms).toISOString().replace('T', ' ').slice(0, 23);
|
||||||
|
|
||||||
|
/** Serve config.json with a status page for `serverName` and answer Kuma from `fx()`. */
|
||||||
|
async function mockKuma(page: Page, serverName: string | null, fx: () => Fixture) {
|
||||||
|
const kumaRequests: string[] = [];
|
||||||
|
await page.route(/\/config\.json(\?.*)?$/, async (route) => {
|
||||||
|
const res = await route.fetch();
|
||||||
|
const cfg = await res.json();
|
||||||
|
cfg.statusPages = serverName ? { [serverName]: PAGE_CFG } : {};
|
||||||
|
await route.fulfill({ response: res, json: cfg });
|
||||||
|
});
|
||||||
|
await page.route(/isitup\.lotusguild\.org\/api\/status-page\//, async (route) => {
|
||||||
|
const url = route.request().url();
|
||||||
|
kumaRequests.push(url);
|
||||||
|
const f = fx();
|
||||||
|
if (f.fail) {
|
||||||
|
await route.fulfill({ status: 500, body: 'oops' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const cors = { 'access-control-allow-origin': '*' };
|
||||||
|
if (url.includes('/heartbeat/')) {
|
||||||
|
// Two checks, the latest `staleMinutes` ago (0 = just now).
|
||||||
|
const last = Date.now() - (f.staleMinutes ?? 0) * 60_000;
|
||||||
|
const beats = (s: number) => [
|
||||||
|
{ status: s, time: kumaTime(last - 60_000) },
|
||||||
|
{ status: s, time: kumaTime(last) },
|
||||||
|
];
|
||||||
|
await route.fulfill({
|
||||||
|
headers: cors,
|
||||||
|
json: { heartbeatList: { 1: beats(f.hs ?? UP), 2: beats(f.calls ?? UP) }, uptimeList: {} },
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await route.fulfill({
|
||||||
|
headers: cors,
|
||||||
|
json: {
|
||||||
|
config: { slug: 'matrix' },
|
||||||
|
incidents: [],
|
||||||
|
maintenanceList: [],
|
||||||
|
publicGroupList: [
|
||||||
|
{ name: 'Homeserver', monitorList: [{ id: 1 }] },
|
||||||
|
{ name: 'Voice calls', monitorList: [{ id: 2 }] },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
return kumaRequests;
|
||||||
|
}
|
||||||
|
|
||||||
|
const serverOf = (u: TestUser) => u.userId.split(':').slice(1).join(':');
|
||||||
|
const strip = (page: Page, text: RegExp) =>
|
||||||
|
page.locator('[role="status"], [role="alert"]').filter({ hasText: text });
|
||||||
|
const cutSync = (page: Page) =>
|
||||||
|
page.route(/\/_matrix\/client\/v3\/sync/, (route) => route.abort('connectionfailed'));
|
||||||
|
|
||||||
|
test.describe('server status banner (#124)', () => {
|
||||||
|
let alice: TestUser;
|
||||||
|
let room: string;
|
||||||
|
|
||||||
|
test.beforeAll(async () => {
|
||||||
|
test.skip(!(await hsReachable()), `no local homeserver at ${HS} (set E2E_LOCAL_HS)`);
|
||||||
|
alice = await ensureUser(uniq('e2e_status_'));
|
||||||
|
room = await createRoom(alice, 'Status Room');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('calls down: amber strip, dismiss sticks across a reload', async ({ page }) => {
|
||||||
|
await mockKuma(page, serverOf(alice), () => ({ calls: DOWN }));
|
||||||
|
await loginUI(page, alice);
|
||||||
|
await openRoom(page, room);
|
||||||
|
const calls = strip(page, /Voice calls are down right now\. Messages still work\./);
|
||||||
|
await expect(calls).toBeVisible();
|
||||||
|
await calls.getByRole('button', { name: 'Dismiss' }).click();
|
||||||
|
await expect(calls).toHaveCount(0);
|
||||||
|
await page.reload();
|
||||||
|
await openRoom(page, room);
|
||||||
|
await page.waitForTimeout(2000);
|
||||||
|
await expect(calls).toHaveCount(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('other homeservers never contact Kuma', async ({ page }) => {
|
||||||
|
const requests = await mockKuma(page, 'some.other.server', () => ({ hs: DOWN }));
|
||||||
|
await loginUI(page, alice);
|
||||||
|
await openRoom(page, room);
|
||||||
|
await page.waitForTimeout(3000);
|
||||||
|
expect(requests).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('Kuma failing shows nothing (fail quiet)', async ({ page }) => {
|
||||||
|
const requests = await mockKuma(page, serverOf(alice), () => ({ fail: true }));
|
||||||
|
await loginUI(page, alice);
|
||||||
|
await openRoom(page, room);
|
||||||
|
await expect.poll(() => requests.length).toBeGreaterThan(0);
|
||||||
|
await page.waitForTimeout(1500);
|
||||||
|
await expect(strip(page, /server|Voice calls|Maintenance/i)).toHaveCount(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('connection lost + Kuma says the server is down: critical strip, not "Connection Lost"', async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
test.setTimeout(150_000);
|
||||||
|
await mockKuma(page, serverOf(alice), () => ({ hs: DOWN }));
|
||||||
|
await loginUI(page, alice);
|
||||||
|
await openRoom(page, room);
|
||||||
|
// Connected: the server is "having problems" for others, not for us.
|
||||||
|
await expect(strip(page, /server is having problems/)).toBeVisible();
|
||||||
|
await cutSync(page);
|
||||||
|
const down = page.getByRole('alert').filter({ hasText: /server is down\. We're on it/ });
|
||||||
|
await expect(down).toBeVisible({ timeout: 120_000 });
|
||||||
|
await expect(page.getByText('Connection Lost! Reconnecting...')).toHaveCount(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('connection lost + Kuma checked since and the server is up: "may be your connection"', async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
test.setTimeout(150_000);
|
||||||
|
await mockKuma(page, serverOf(alice), () => ({ hs: UP }));
|
||||||
|
await loginUI(page, alice);
|
||||||
|
await openRoom(page, room);
|
||||||
|
await cutSync(page);
|
||||||
|
await expect(page.getByText(/server is up, so it may be your internet connection/)).toBeVisible(
|
||||||
|
{
|
||||||
|
timeout: 120_000,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('connection lost + only a stale "up" from Kuma: plain "Connection Lost"', async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
test.setTimeout(150_000);
|
||||||
|
await mockKuma(page, serverOf(alice), () => ({ hs: UP, staleMinutes: 10 }));
|
||||||
|
await loginUI(page, alice);
|
||||||
|
await openRoom(page, room);
|
||||||
|
await cutSync(page);
|
||||||
|
await expect(page.getByText('Connection Lost! Reconnecting...')).toBeVisible({
|
||||||
|
timeout: 120_000,
|
||||||
|
});
|
||||||
|
await page.waitForTimeout(3000);
|
||||||
|
await expect(page.getByText(/may be your internet connection/)).toHaveCount(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -8,6 +8,7 @@ import { useCallEmbed, useCallJoined, useCallStart } from '../../hooks/useCallEm
|
|||||||
import { useCallPreferences } from '../../state/hooks/callPreferences';
|
import { useCallPreferences } from '../../state/hooks/callPreferences';
|
||||||
import { useSetting } from '../../state/hooks/settings';
|
import { useSetting } from '../../state/hooks/settings';
|
||||||
import { settingsAtom } from '../../state/settings';
|
import { settingsAtom } from '../../state/settings';
|
||||||
|
import { useCallsDown } from '../server-status/ServerStatusBanner';
|
||||||
|
|
||||||
type MediaPermState = 'granted' | 'denied' | 'prompt' | 'unknown';
|
type MediaPermState = 'granted' | 'denied' | 'prompt' | 'unknown';
|
||||||
|
|
||||||
@@ -61,6 +62,7 @@ export function PrescreenControls({ canJoin }: PrescreenControlsProps) {
|
|||||||
|
|
||||||
const micPermission = useMediaPermissions();
|
const micPermission = useMediaPermissions();
|
||||||
const micDenied = micPermission === 'denied';
|
const micDenied = micPermission === 'denied';
|
||||||
|
const callsDown = useCallsDown();
|
||||||
|
|
||||||
const disabled = inOtherCall || !canJoin || micDenied;
|
const disabled = inOtherCall || !canJoin || micDenied;
|
||||||
|
|
||||||
@@ -91,6 +93,11 @@ export function PrescreenControls({ canJoin }: PrescreenControlsProps) {
|
|||||||
<ChatButton />
|
<ChatButton />
|
||||||
</Box>
|
</Box>
|
||||||
<Box grow="Yes" direction="Column" gap="200">
|
<Box grow="Yes" direction="Column" gap="200">
|
||||||
|
{callsDown && (
|
||||||
|
<Text size="T200" style={{ color: color.Warning.Main, textAlign: 'center' }}>
|
||||||
|
Voice calls are down right now, so joining may fail.
|
||||||
|
</Text>
|
||||||
|
)}
|
||||||
{micDenied && (
|
{micDenied && (
|
||||||
<Text size="T200" style={{ color: color.Critical.Main, textAlign: 'center' }}>
|
<Text size="T200" style={{ color: color.Critical.Main, textAlign: 'center' }}>
|
||||||
Microphone access is blocked. Enable it in your browser settings to join.
|
Microphone access is blocked. Enable it in your browser settings to join.
|
||||||
|
|||||||
@@ -0,0 +1,168 @@
|
|||||||
|
import React, { useCallback, useEffect, useMemo, useState } from 'react';
|
||||||
|
import { useAtomValue, useSetAtom } from 'jotai';
|
||||||
|
import { MatrixClient, SyncState } from 'matrix-js-sdk';
|
||||||
|
import { Box, Button, config, Icon, IconButton, Icons, IconSrc, Line, Text } from 'folds';
|
||||||
|
import { ContainerColor } from '../../styles/ContainerColor.css';
|
||||||
|
import { useClientConfig } from '../../hooks/useClientConfig';
|
||||||
|
import { useSyncState } from '../../hooks/useSyncState';
|
||||||
|
import { useServerStatus } from '../../hooks/useServerStatus';
|
||||||
|
import { ScreenSize, useScreenSizeContext } from '../../hooks/useScreenSize';
|
||||||
|
import { serverStatusAtom } from '../../state/serverStatus';
|
||||||
|
import { pickBanner, resolveStatusPage, StatusBanner } from '../../utils/kumaStatus';
|
||||||
|
|
||||||
|
const DISMISS_KEY = 'lotus-status-banner-dismissed';
|
||||||
|
const DISMISS_MAX = 50;
|
||||||
|
|
||||||
|
const readDismissed = (): string[] => {
|
||||||
|
try {
|
||||||
|
const v = JSON.parse(localStorage.getItem(DISMISS_KEY) ?? '[]');
|
||||||
|
return Array.isArray(v) ? v.filter((k): k is string => typeof k === 'string') : [];
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const bannerIcon = (b: StatusBanner): IconSrc => {
|
||||||
|
if (b.kind === 'maintenance') return Icons.Setting;
|
||||||
|
if (b.tone === 'Primary') return Icons.Info;
|
||||||
|
return Icons.Warning;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #124] One status strip, in the same slot and style as the sync and
|
||||||
|
* clock banners. Presentational: the caller picks the banner.
|
||||||
|
*/
|
||||||
|
export function StatusStrip({
|
||||||
|
banner,
|
||||||
|
onDismiss,
|
||||||
|
}: {
|
||||||
|
banner: StatusBanner;
|
||||||
|
onDismiss?: () => void;
|
||||||
|
}) {
|
||||||
|
const [open, setOpen] = useState(false);
|
||||||
|
const mobile = useScreenSizeContext() === ScreenSize.Mobile;
|
||||||
|
useEffect(() => setOpen(false), [banner.key]);
|
||||||
|
const critical = banner.tone === 'Critical';
|
||||||
|
return (
|
||||||
|
<Box direction="Column" shrink="No">
|
||||||
|
<Box
|
||||||
|
className={ContainerColor({ variant: banner.tone })}
|
||||||
|
style={{ padding: `${config.space.S100} ${config.space.S300}` }}
|
||||||
|
direction="Column"
|
||||||
|
gap="100"
|
||||||
|
role={critical ? 'alert' : 'status'}
|
||||||
|
aria-live={critical ? 'assertive' : 'polite'}
|
||||||
|
>
|
||||||
|
<Box
|
||||||
|
alignItems="Center"
|
||||||
|
justifyContent={mobile ? 'Start' : 'Center'}
|
||||||
|
gap="200"
|
||||||
|
style={{ minHeight: config.size.X300 }}
|
||||||
|
>
|
||||||
|
<Icon size="100" src={bannerIcon(banner)} />
|
||||||
|
<Text size="L400" truncate={mobile && !open} style={{ minWidth: 0 }}>
|
||||||
|
{banner.text}
|
||||||
|
</Text>
|
||||||
|
{banner.detail && (
|
||||||
|
<Button
|
||||||
|
size="300"
|
||||||
|
variant={banner.tone}
|
||||||
|
fill="None"
|
||||||
|
radii="300"
|
||||||
|
aria-expanded={open}
|
||||||
|
onClick={() => setOpen((v) => !v)}
|
||||||
|
style={{ flexShrink: 0 }}
|
||||||
|
>
|
||||||
|
<Text size="B300" style={{ textDecoration: 'underline' }}>
|
||||||
|
{open ? 'Hide' : 'Details'}
|
||||||
|
</Text>
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
{banner.dismissable && onDismiss && (
|
||||||
|
<IconButton
|
||||||
|
size="300"
|
||||||
|
variant={banner.tone}
|
||||||
|
fill="None"
|
||||||
|
radii="300"
|
||||||
|
aria-label="Dismiss"
|
||||||
|
onClick={onDismiss}
|
||||||
|
style={{ flexShrink: 0 }}
|
||||||
|
>
|
||||||
|
<Icon size="100" src={Icons.Cross} />
|
||||||
|
</IconButton>
|
||||||
|
)}
|
||||||
|
</Box>
|
||||||
|
{banner.detail && open && (
|
||||||
|
<Box justifyContent={mobile ? 'Start' : 'Center'}>
|
||||||
|
<Text size="T200" style={{ maxWidth: 680, whiteSpace: 'pre-line' }}>
|
||||||
|
{banner.detail}
|
||||||
|
</Text>
|
||||||
|
</Box>
|
||||||
|
)}
|
||||||
|
</Box>
|
||||||
|
<Line variant={banner.tone} size="300" />
|
||||||
|
</Box>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Runs the Kuma poller for the logged-in homeserver and publishes it. */
|
||||||
|
export function ServerStatusFeature({ mx }: { mx: MatrixClient }) {
|
||||||
|
const { statusPages } = useClientConfig();
|
||||||
|
const page = useMemo(
|
||||||
|
() => resolveStatusPage(statusPages, mx.getDomain() ?? undefined),
|
||||||
|
[statusPages, mx],
|
||||||
|
);
|
||||||
|
const [lostAt, setLostAt] = useState<number | null>(null);
|
||||||
|
useSyncState(
|
||||||
|
mx,
|
||||||
|
useCallback((state: SyncState | null) => {
|
||||||
|
const lost = state === SyncState.Reconnecting || state === SyncState.Error;
|
||||||
|
setLostAt((prev) => {
|
||||||
|
if (!lost) return null;
|
||||||
|
return prev ?? Date.now();
|
||||||
|
});
|
||||||
|
}, []),
|
||||||
|
);
|
||||||
|
const syncLost = lostAt !== null;
|
||||||
|
const status = useServerStatus(page, syncLost);
|
||||||
|
const setAtom = useSetAtom(serverStatusAtom);
|
||||||
|
useEffect(() => setAtom({ status, syncLost, lostAt }), [setAtom, status, syncLost, lostAt]);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The logged-in app's status strip. */
|
||||||
|
export function ServerStatusBanner() {
|
||||||
|
const { status, syncLost } = useAtomValue(serverStatusAtom);
|
||||||
|
const [dismissed, setDismissed] = useState(readDismissed);
|
||||||
|
const banner = pickBanner(status, {
|
||||||
|
syncLost,
|
||||||
|
where: 'client',
|
||||||
|
dismissed: new Set(dismissed),
|
||||||
|
});
|
||||||
|
if (!banner) return null;
|
||||||
|
const dismiss = () => {
|
||||||
|
const next = [...dismissed.filter((k) => k !== banner.key), banner.key].slice(-DISMISS_MAX);
|
||||||
|
try {
|
||||||
|
localStorage.setItem(DISMISS_KEY, JSON.stringify(next));
|
||||||
|
} catch {
|
||||||
|
// storage unavailable — dismissed for this session only
|
||||||
|
}
|
||||||
|
setDismissed(next);
|
||||||
|
};
|
||||||
|
return <StatusStrip banner={banner} onDismiss={dismiss} />;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The sign-in screen's strip, for the homeserver being signed in to. */
|
||||||
|
export function LoginStatusBanner({ serverName }: { serverName: string }) {
|
||||||
|
const { statusPages } = useClientConfig();
|
||||||
|
const page = useMemo(() => resolveStatusPage(statusPages, serverName), [statusPages, serverName]);
|
||||||
|
const status = useServerStatus(page);
|
||||||
|
const banner = pickBanner(status, { syncLost: false, where: 'login' });
|
||||||
|
return banner ? <StatusStrip banner={banner} /> : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Calls-down note for the call Join controls (null when calls are fine). */
|
||||||
|
export function useCallsDown(): boolean {
|
||||||
|
const { status } = useAtomValue(serverStatusAtom);
|
||||||
|
return status?.calls === 'down' && status.homeserver !== 'down';
|
||||||
|
}
|
||||||
@@ -114,6 +114,7 @@ import { SequenceCardStyle } from '../styles.css';
|
|||||||
import { UpdateProgress, useTauriUpdater } from '../../../hooks/useTauriUpdater';
|
import { UpdateProgress, useTauriUpdater } from '../../../hooks/useTauriUpdater';
|
||||||
import { describeUpdateError, manualDownloadUrl } from '../../../utils/updateErrors';
|
import { describeUpdateError, manualDownloadUrl } from '../../../utils/updateErrors';
|
||||||
import { isTauri as isTauriEnv, invokeTauri, tauriInvoke } from '../../../hooks/useTauri';
|
import { isTauri as isTauriEnv, invokeTauri, tauriInvoke } from '../../../hooks/useTauri';
|
||||||
|
import { useKeychainMirrorStatus } from '../../../state/keychainMirror';
|
||||||
import { isSafeGlobalToggleKey } from '../../../hooks/useCallHotkeys';
|
import { isSafeGlobalToggleKey } from '../../../hooks/useCallHotkeys';
|
||||||
import { customWindowChromeAtom } from '../../../state/customWindowChrome';
|
import { customWindowChromeAtom } from '../../../state/customWindowChrome';
|
||||||
import { useDateFormatItems } from '../../../hooks/useDateFormat';
|
import { useDateFormatItems } from '../../../hooks/useDateFormat';
|
||||||
@@ -238,6 +239,27 @@ function AutostartSetting() {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// [Gitea #105] Desktop: whether the login is also kept in the OS keychain.
|
||||||
|
function KeychainMirrorSetting() {
|
||||||
|
const status = useKeychainMirrorStatus();
|
||||||
|
if (!isTauriEnv() || status.state === 'idle' || status.state === 'cleared') return null;
|
||||||
|
let description: string;
|
||||||
|
if (status.state === 'ok') {
|
||||||
|
description =
|
||||||
|
"A copy of your login is kept in the system keychain (Windows Credential Manager). A later update will keep it only there, out of the app's data folder.";
|
||||||
|
} else if (status.state === 'unsupported') {
|
||||||
|
description =
|
||||||
|
"Not available on this system yet. Your login is saved in the app's data folder, as before.";
|
||||||
|
} else {
|
||||||
|
description = `Couldn't save a copy to the system keychain (${status.error}). You stay logged in; your login is saved in the app's data folder, as before.`;
|
||||||
|
}
|
||||||
|
return (
|
||||||
|
<SequenceCard className={SequenceCardStyle} variant="SurfaceVariant" direction="Column">
|
||||||
|
<SettingTile title="Login in the system keychain" description={description} />
|
||||||
|
</SequenceCard>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
type ThemeSelectorProps = {
|
type ThemeSelectorProps = {
|
||||||
themeNames: Record<string, string>;
|
themeNames: Record<string, string>;
|
||||||
themes: Theme[];
|
themes: Theme[];
|
||||||
@@ -570,6 +592,7 @@ function Appearance() {
|
|||||||
|
|
||||||
<DesktopChromeSetting />
|
<DesktopChromeSetting />
|
||||||
<AutostartSetting />
|
<AutostartSetting />
|
||||||
|
<KeychainMirrorSetting />
|
||||||
|
|
||||||
<SequenceCard className={SequenceCardStyle} variant="SurfaceVariant" direction="Column">
|
<SequenceCard className={SequenceCardStyle} variant="SurfaceVariant" direction="Column">
|
||||||
<SettingTile
|
<SettingTile
|
||||||
|
|||||||
@@ -26,6 +26,22 @@ export type ClientConfig = {
|
|||||||
*/
|
*/
|
||||||
elementCallUrl?: string;
|
elementCallUrl?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #43] Desktop only: the loopback origin the desktop app's local
|
||||||
|
* server also answers on (e.g. "http://127.0.0.1:44548"), to load the
|
||||||
|
* bundled call page from a different origin than the app
|
||||||
|
* ("http://localhost:44548"). Set by cinny-desktop together with the server
|
||||||
|
* and CSP changes it needs; unset keeps the same-origin call page.
|
||||||
|
*/
|
||||||
|
desktopCallOrigin?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #124] Uptime Kuma status page per homeserver, for the status banner:
|
||||||
|
* { "<server name>": { url, slug, groups?: { homeserver, calls, login } } }.
|
||||||
|
* Homeservers not listed never contact Kuma.
|
||||||
|
*/
|
||||||
|
statusPages?: Record<string, unknown>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Absolute https URL of the public web app (e.g. https://chat.lotusguild.org).
|
* Absolute https URL of the public web app (e.g. https://chat.lotusguild.org).
|
||||||
* The desktop app sets it so it can hand calls it can't make to the browser.
|
* The desktop app sets it so it can hand calls it can't make to the browser.
|
||||||
|
|||||||
@@ -0,0 +1,98 @@
|
|||||||
|
import { useEffect, useState } from 'react';
|
||||||
|
import { kumaUrls, parseKumaStatus, ServerStatus, StatusPageConfig } from '../utils/kumaStatus';
|
||||||
|
|
||||||
|
/** Normal poll, and while a problem is showing (so recovery clears quickly). */
|
||||||
|
export const STATUS_POLL_MS = 5 * 60 * 1000;
|
||||||
|
export const STATUS_POLL_PROBLEM_MS = 60 * 1000;
|
||||||
|
const STATUS_FETCH_TIMEOUT_MS = 10 * 1000;
|
||||||
|
const STATUS_BACKOFF_MAX_MS = 15 * 60 * 1000;
|
||||||
|
|
||||||
|
const fetchJson = async (url: string, signal: AbortSignal): Promise<unknown> => {
|
||||||
|
const res = await fetch(url, { cache: 'no-store', credentials: 'omit', signal });
|
||||||
|
if (!res.ok) throw new Error(`HTTP ${res.status}`);
|
||||||
|
return res.json();
|
||||||
|
};
|
||||||
|
|
||||||
|
export const hasProblem = (s: ServerStatus | null): boolean =>
|
||||||
|
!!s &&
|
||||||
|
(s.homeserver === 'down' || s.calls === 'down' || s.login === 'down' || s.maintenance.length > 0);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #124] Poll the homeserver's Kuma status page (none configured → no
|
||||||
|
* requests, null). Only while the page is visible; every 5 min, every 60 s
|
||||||
|
* while something is wrong, and at once when `urgent` turns true (this
|
||||||
|
* client's connection dropped). Any failure → null ("no banner"), with
|
||||||
|
* backoff: Kuma being unreachable must never look like Matrix being down.
|
||||||
|
*/
|
||||||
|
export const useServerStatus = (
|
||||||
|
page: StatusPageConfig | undefined,
|
||||||
|
urgent = false,
|
||||||
|
): ServerStatus | null => {
|
||||||
|
const [status, setStatus] = useState<ServerStatus | null>(null);
|
||||||
|
const pageKey = page ? `${page.url}/${page.slug}` : '';
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (!page) {
|
||||||
|
setStatus(null);
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
const urls = kumaUrls(page);
|
||||||
|
let timer: ReturnType<typeof setTimeout> | undefined;
|
||||||
|
let controller: AbortController | undefined;
|
||||||
|
let failures = 0;
|
||||||
|
let stopped = false;
|
||||||
|
let last: ServerStatus | null = null;
|
||||||
|
|
||||||
|
const schedule = (ms: number) => {
|
||||||
|
if (timer) clearTimeout(timer);
|
||||||
|
timer = setTimeout(poll, ms);
|
||||||
|
};
|
||||||
|
|
||||||
|
async function poll() {
|
||||||
|
if (stopped) return;
|
||||||
|
if (typeof document !== 'undefined' && document.visibilityState === 'hidden') return;
|
||||||
|
controller?.abort();
|
||||||
|
controller = new AbortController();
|
||||||
|
const abort = controller;
|
||||||
|
const timeout = setTimeout(() => abort.abort(), STATUS_FETCH_TIMEOUT_MS);
|
||||||
|
try {
|
||||||
|
const [pageJson, heartbeatJson] = await Promise.all([
|
||||||
|
fetchJson(urls.page, abort.signal),
|
||||||
|
fetchJson(urls.heartbeat, abort.signal),
|
||||||
|
]);
|
||||||
|
if (stopped) return;
|
||||||
|
failures = 0;
|
||||||
|
last = parseKumaStatus(pageJson, heartbeatJson, page!.groups);
|
||||||
|
setStatus(last);
|
||||||
|
// While this client's connection is lost, keep asking every minute: that
|
||||||
|
// is how it learns Kuma has checked the server since the drop.
|
||||||
|
schedule(hasProblem(last) || urgent ? STATUS_POLL_PROBLEM_MS : STATUS_POLL_MS);
|
||||||
|
} catch {
|
||||||
|
if (stopped) return;
|
||||||
|
failures += 1;
|
||||||
|
last = null;
|
||||||
|
setStatus(null);
|
||||||
|
schedule(Math.min(STATUS_POLL_PROBLEM_MS * 2 ** failures, STATUS_BACKOFF_MAX_MS));
|
||||||
|
} finally {
|
||||||
|
clearTimeout(timeout);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const onVisible = () => {
|
||||||
|
if (document.visibilityState === 'visible') poll();
|
||||||
|
};
|
||||||
|
document.addEventListener('visibilitychange', onVisible);
|
||||||
|
poll();
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
stopped = true;
|
||||||
|
if (timer) clearTimeout(timer);
|
||||||
|
controller?.abort();
|
||||||
|
document.removeEventListener('visibilitychange', onVisible);
|
||||||
|
};
|
||||||
|
// pageKey identifies the page; the object itself is rebuilt from config.
|
||||||
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||||
|
}, [pageKey, urgent]);
|
||||||
|
|
||||||
|
return status;
|
||||||
|
};
|
||||||
+14
-2
@@ -36,7 +36,11 @@ import { applyCustomAccent, removeCustomAccent } from '../utils/accentColor';
|
|||||||
import { zIndices } from '../styles/zIndex';
|
import { zIndices } from '../styles/zIndex';
|
||||||
import { OIDC_CALLBACK_PATH } from './paths';
|
import { OIDC_CALLBACK_PATH } from './paths';
|
||||||
import { OidcCallback } from './auth/oidc/OidcCallback';
|
import { OidcCallback } from './auth/oidc/OidcCallback';
|
||||||
import { resolveCallPageUrl, setCallPageUrl } from '../plugins/call/callPageUrl';
|
import {
|
||||||
|
resolveCallPageUrl,
|
||||||
|
resolveDesktopCallPageUrl,
|
||||||
|
setCallPageUrl,
|
||||||
|
} from '../plugins/call/callPageUrl';
|
||||||
|
|
||||||
// The emoji families (Twemoji when "Twitter emoji" is on, Twemoji flags on
|
// The emoji families (Twemoji when "Twitter emoji" is on, Twemoji flags on
|
||||||
// Windows — see SystemEmojiFeature) must sit before the generic family, or the
|
// Windows — see SystemEmojiFeature) must sit before the generic family, or the
|
||||||
@@ -223,7 +227,15 @@ function App() {
|
|||||||
>
|
>
|
||||||
{(clientConfig) => {
|
{(clientConfig) => {
|
||||||
// [Gitea #43] Idempotent: where the call page is loaded from.
|
// [Gitea #43] Idempotent: where the call page is loaded from.
|
||||||
setCallPageUrl(resolveCallPageUrl(clientConfig.elementCallUrl, isTauri()));
|
setCallPageUrl(
|
||||||
|
isTauri()
|
||||||
|
? resolveDesktopCallPageUrl(
|
||||||
|
clientConfig.desktopCallOrigin,
|
||||||
|
window.location.origin,
|
||||||
|
import.meta.env.BASE_URL,
|
||||||
|
)
|
||||||
|
: resolveCallPageUrl(clientConfig.elementCallUrl, false),
|
||||||
|
);
|
||||||
return (
|
return (
|
||||||
<ClientConfigProvider value={clientConfig}>
|
<ClientConfigProvider value={clientConfig}>
|
||||||
<QueryClientProvider client={queryClient}>
|
<QueryClientProvider client={queryClient}>
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ import { AuthFlowsLoader } from '../../components/AuthFlowsLoader';
|
|||||||
import { AuthFlowsProvider } from '../../hooks/useAuthFlows';
|
import { AuthFlowsProvider } from '../../hooks/useAuthFlows';
|
||||||
import { AuthServerProvider } from '../../hooks/useAuthServer';
|
import { AuthServerProvider } from '../../hooks/useAuthServer';
|
||||||
import { tryDecodeURIComponent } from '../../utils/dom';
|
import { tryDecodeURIComponent } from '../../utils/dom';
|
||||||
|
import { LoginStatusBanner } from '../../features/server-status/ServerStatusBanner';
|
||||||
|
|
||||||
const LotusLogo = withOriginBaseUrl(getOriginBaseUrl(), '/public/res/lotus-logo.png');
|
const LotusLogo = withOriginBaseUrl(getOriginBaseUrl(), '/public/res/lotus-logo.png');
|
||||||
|
|
||||||
@@ -125,6 +126,8 @@ export function AuthLayout() {
|
|||||||
discoveryState.status === AsyncStatus.Success ? discoveryState.data.response : [];
|
discoveryState.status === AsyncStatus.Success ? discoveryState.data.response : [];
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
<Box direction="Column" style={{ height: '100%' }}>
|
||||||
|
<LoginStatusBanner serverName={server} />
|
||||||
<Scroll variant="Background" visibility="Hover" size="300" hideTrack>
|
<Scroll variant="Background" visibility="Hover" size="300" hideTrack>
|
||||||
<Box
|
<Box
|
||||||
className={classNames(css.AuthLayout, PatternsCss.BackgroundDotPattern)}
|
className={classNames(css.AuthLayout, PatternsCss.BackgroundDotPattern)}
|
||||||
@@ -209,5 +212,6 @@ export function AuthLayout() {
|
|||||||
<AuthFooter />
|
<AuthFooter />
|
||||||
</Box>
|
</Box>
|
||||||
</Scroll>
|
</Scroll>
|
||||||
|
</Box>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -44,6 +44,10 @@ import { useSyncState } from '../../hooks/useSyncState';
|
|||||||
import { stopPropagation } from '../../utils/keyboard';
|
import { stopPropagation } from '../../utils/keyboard';
|
||||||
import { SyncStatus } from './SyncStatus';
|
import { SyncStatus } from './SyncStatus';
|
||||||
import { ClockSkewBanner } from './ClockSkewBanner';
|
import { ClockSkewBanner } from './ClockSkewBanner';
|
||||||
|
import {
|
||||||
|
ServerStatusBanner,
|
||||||
|
ServerStatusFeature,
|
||||||
|
} from '../../features/server-status/ServerStatusBanner';
|
||||||
import { AuthMetadataProvider } from '../../hooks/useAuthMetadata';
|
import { AuthMetadataProvider } from '../../hooks/useAuthMetadata';
|
||||||
import { getFallbackSession, removeFallbackSession } from '../../state/sessions';
|
import { getFallbackSession, removeFallbackSession } from '../../state/sessions';
|
||||||
import { pushSessionToSW } from '../../../sw-session';
|
import { pushSessionToSW } from '../../../sw-session';
|
||||||
@@ -245,6 +249,8 @@ export function ClientRoot({ children }: ClientRootProps) {
|
|||||||
return (
|
return (
|
||||||
<AutoDiscovery userId={userId!} baseUrl={baseUrl!}>
|
<AutoDiscovery userId={userId!} baseUrl={baseUrl!}>
|
||||||
<SpecVersions baseUrl={baseUrl!}>
|
<SpecVersions baseUrl={baseUrl!}>
|
||||||
|
{mx && <ServerStatusFeature mx={mx} />}
|
||||||
|
{mx && !syncError && <ServerStatusBanner />}
|
||||||
{mx && !syncError && <SyncStatus mx={mx} />}
|
{mx && !syncError && <SyncStatus mx={mx} />}
|
||||||
{mx && !syncError && <ClockSkewBanner />}
|
{mx && !syncError && <ClockSkewBanner />}
|
||||||
{loading && <ClientRootOptions mx={mx} />}
|
{loading && <ClientRootOptions mx={mx} />}
|
||||||
|
|||||||
@@ -1,8 +1,11 @@
|
|||||||
import { MatrixClient, SyncState } from 'matrix-js-sdk';
|
import { MatrixClient, SyncState } from 'matrix-js-sdk';
|
||||||
import React, { useCallback, useState } from 'react';
|
import React, { useCallback, useState } from 'react';
|
||||||
|
import { useAtomValue } from 'jotai';
|
||||||
import { Box, config, Line, Text } from 'folds';
|
import { Box, config, Line, Text } from 'folds';
|
||||||
import { useSyncState } from '../../hooks/useSyncState';
|
import { useSyncState } from '../../hooks/useSyncState';
|
||||||
import { ContainerColor } from '../../styles/ContainerColor.css';
|
import { ContainerColor } from '../../styles/ContainerColor.css';
|
||||||
|
import { serverStatusAtom } from '../../state/serverStatus';
|
||||||
|
import { serverConfirmedUpSince } from '../../utils/kumaStatus';
|
||||||
|
|
||||||
type StateData = {
|
type StateData = {
|
||||||
current: SyncState | null;
|
current: SyncState | null;
|
||||||
@@ -13,6 +16,7 @@ type SyncStatusProps = {
|
|||||||
mx: MatrixClient;
|
mx: MatrixClient;
|
||||||
};
|
};
|
||||||
export function SyncStatus({ mx }: SyncStatusProps) {
|
export function SyncStatus({ mx }: SyncStatusProps) {
|
||||||
|
const serverStatus = useAtomValue(serverStatusAtom);
|
||||||
const [stateData, setStateData] = useState<StateData>({
|
const [stateData, setStateData] = useState<StateData>({
|
||||||
current: null,
|
current: null,
|
||||||
previous: undefined,
|
previous: undefined,
|
||||||
@@ -53,7 +57,14 @@ export function SyncStatus({ mx }: SyncStatusProps) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (stateData.current === SyncState.Reconnecting) {
|
// [Gitea #124] When Kuma confirms the homeserver is down, the status banner
|
||||||
|
// says so ("Lotus Chat's server is down…") instead of "Connection Lost!".
|
||||||
|
const serverDown = serverStatus.status?.homeserver === 'down';
|
||||||
|
// Only blame the user's connection when Kuma has checked the server since
|
||||||
|
// the drop and it was fine (a stale "up" from before proves nothing).
|
||||||
|
const serverUp = serverConfirmedUpSince(serverStatus.status, serverStatus.lostAt);
|
||||||
|
|
||||||
|
if (stateData.current === SyncState.Reconnecting && !serverDown) {
|
||||||
return (
|
return (
|
||||||
<Box direction="Column" shrink="No">
|
<Box direction="Column" shrink="No">
|
||||||
<Box
|
<Box
|
||||||
@@ -64,14 +75,18 @@ export function SyncStatus({ mx }: SyncStatusProps) {
|
|||||||
role="status"
|
role="status"
|
||||||
aria-live="polite"
|
aria-live="polite"
|
||||||
>
|
>
|
||||||
<Text size="L400">Connection Lost! Reconnecting...</Text>
|
<Text size="L400">
|
||||||
|
{serverUp
|
||||||
|
? "Connection lost. Our status checks say Lotus Chat's server is up, so it may be your internet connection. Reconnecting…"
|
||||||
|
: 'Connection Lost! Reconnecting...'}
|
||||||
|
</Text>
|
||||||
</Box>
|
</Box>
|
||||||
<Line variant="Warning" size="300" />
|
<Line variant="Warning" size="300" />
|
||||||
</Box>
|
</Box>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (stateData.current === SyncState.Error) {
|
if (stateData.current === SyncState.Error && !serverDown) {
|
||||||
return (
|
return (
|
||||||
<Box direction="Column" shrink="No">
|
<Box direction="Column" shrink="No">
|
||||||
<Box
|
<Box
|
||||||
@@ -82,7 +97,11 @@ export function SyncStatus({ mx }: SyncStatusProps) {
|
|||||||
role="alert"
|
role="alert"
|
||||||
aria-live="assertive"
|
aria-live="assertive"
|
||||||
>
|
>
|
||||||
<Text size="L400">Connection Lost!</Text>
|
<Text size="L400">
|
||||||
|
{serverUp
|
||||||
|
? "Connection lost. Our status checks say Lotus Chat's server is up, so check your internet connection."
|
||||||
|
: 'Connection Lost!'}
|
||||||
|
</Text>
|
||||||
</Box>
|
</Box>
|
||||||
<Line variant="Critical" size="300" />
|
<Line variant="Critical" size="300" />
|
||||||
</Box>
|
</Box>
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { test } from 'node:test';
|
import { test } from 'node:test';
|
||||||
import assert from 'node:assert/strict';
|
import assert from 'node:assert/strict';
|
||||||
import { resolveCallPageUrl } from './callPageUrl';
|
import { resolveCallPageUrl, resolveDesktopCallPageUrl } from './callPageUrl';
|
||||||
|
|
||||||
const URL_OK = 'https://call.chat.example.org/public/element-call/index.html';
|
const URL_OK = 'https://call.chat.example.org/public/element-call/index.html';
|
||||||
|
|
||||||
@@ -38,3 +38,44 @@ test('anything else falls back to the bundled page', () => {
|
|||||||
'data:text/html,x',
|
'data:text/html,x',
|
||||||
].forEach((v) => assert.equal(resolveCallPageUrl(v, false), undefined, String(v)));
|
].forEach((v) => assert.equal(resolveCallPageUrl(v, false), undefined, String(v)));
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const APP = 'http://localhost:44548';
|
||||||
|
const PAGE = '/public/element-call/index.html';
|
||||||
|
|
||||||
|
test('desktop: the bundled page from the loopback origin on the same port', () => {
|
||||||
|
assert.equal(
|
||||||
|
resolveDesktopCallPageUrl('http://127.0.0.1:44548', APP, '/'),
|
||||||
|
`http://127.0.0.1:44548${PAGE}`,
|
||||||
|
);
|
||||||
|
assert.equal(
|
||||||
|
resolveDesktopCallPageUrl('http://127.0.0.1:44548/', APP, '/app/'),
|
||||||
|
`http://127.0.0.1:44548/app${PAGE}`,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('desktop: unset or anything but same-port loopback http keeps the same-origin page', () => {
|
||||||
|
[
|
||||||
|
undefined,
|
||||||
|
'',
|
||||||
|
'http://127.0.0.1:44549',
|
||||||
|
'http://127.0.0.1',
|
||||||
|
'https://127.0.0.1:44548',
|
||||||
|
'http://localhost:44548',
|
||||||
|
'http://[::1]:44548',
|
||||||
|
'http://10.0.0.5:44548',
|
||||||
|
'https://call.chat.lotusguild.org',
|
||||||
|
'http://127.0.0.1:44548/evil/',
|
||||||
|
'http://127.0.0.1:44548/?x=1',
|
||||||
|
'http://user:pw@127.0.0.1:44548',
|
||||||
|
'not a url',
|
||||||
|
42,
|
||||||
|
].forEach((v) => assert.equal(resolveDesktopCallPageUrl(v, APP, '/'), undefined, String(v)));
|
||||||
|
});
|
||||||
|
|
||||||
|
test('desktop: only when the app itself runs on http://localhost (release builds)', () => {
|
||||||
|
const v = 'http://127.0.0.1:44548';
|
||||||
|
assert.equal(resolveDesktopCallPageUrl(v, 'tauri://localhost', '/'), undefined);
|
||||||
|
assert.equal(resolveDesktopCallPageUrl(v, 'http://tauri.localhost', '/'), undefined);
|
||||||
|
assert.equal(resolveDesktopCallPageUrl(v, 'https://chat.lotusguild.org', '/'), undefined);
|
||||||
|
assert.equal(resolveDesktopCallPageUrl(v, 'http://localhost', '/'), undefined);
|
||||||
|
});
|
||||||
|
|||||||
@@ -7,9 +7,9 @@
|
|||||||
* app loads it from that origin instead, so the call frame can no longer
|
* app loads it from that origin instead, so the call frame can no longer
|
||||||
* reach this origin's storage (login token, crypto store) or service worker.
|
* reach this origin's storage (login token, crypto store) or service worker.
|
||||||
*
|
*
|
||||||
* Web only: the desktop app keeps its bundled copy (its CSP doesn't allow
|
* Web only: the desktop app keeps its bundled copy (a network copy could
|
||||||
* another frame origin, and a network copy could drift from the bundle).
|
* drift from the bundle); see resolveDesktopCallPageUrl for how it isolates
|
||||||
* Anything that isn't an absolute https URL (http only on localhost, for
|
* it. Anything that isn't an absolute https URL (http only on localhost, for
|
||||||
* development) is ignored, so a bad value falls
|
* development) is ignored, so a bad value falls
|
||||||
* back to the bundled page instead of breaking calls.
|
* back to the bundled page instead of breaking calls.
|
||||||
*/
|
*/
|
||||||
@@ -28,6 +28,40 @@ export const resolveCallPageUrl = (value: unknown, desktop: boolean): string | u
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #43] Desktop: the bundled call page from a second origin.
|
||||||
|
*
|
||||||
|
* The desktop app is served by its local server at http://localhost:<port>.
|
||||||
|
* The same server answers on http://127.0.0.1:<port>, which is a different
|
||||||
|
* origin (and still a secure context), so loading the bundled call page from
|
||||||
|
* there cuts the call frame off from the app's storage (login token, crypto
|
||||||
|
* store) without a network copy that could drift from the bundle.
|
||||||
|
*
|
||||||
|
* Only used when cinny-desktop sets `desktopCallOrigin` (it ships the server
|
||||||
|
* and CSP changes this needs in the same release), only for a loopback http
|
||||||
|
* origin on the SAME port as the app, and only when the app itself runs on
|
||||||
|
* http://localhost (release builds). Anything else keeps the same-origin page.
|
||||||
|
*/
|
||||||
|
export const resolveDesktopCallPageUrl = (
|
||||||
|
value: unknown,
|
||||||
|
appOrigin: string,
|
||||||
|
basePath: string,
|
||||||
|
): string | undefined => {
|
||||||
|
if (typeof value !== 'string' || value.trim() === '') return undefined;
|
||||||
|
try {
|
||||||
|
const app = new URL(appOrigin);
|
||||||
|
const call = new URL(value);
|
||||||
|
if (app.protocol !== 'http:' || app.hostname !== 'localhost' || !app.port) return undefined;
|
||||||
|
if (call.protocol !== 'http:' || call.hostname !== '127.0.0.1') return undefined;
|
||||||
|
if (call.port !== app.port || call.username || call.password) return undefined;
|
||||||
|
if (call.pathname !== '/' || call.search || call.hash) return undefined;
|
||||||
|
const base = basePath.replace(/\/+$/, '');
|
||||||
|
return `${call.origin}${base}/public/element-call/index.html`;
|
||||||
|
} catch {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
let callPageUrl: string | undefined;
|
let callPageUrl: string | undefined;
|
||||||
|
|
||||||
export const setCallPageUrl = (url: string | undefined): void => {
|
export const setCallPageUrl = (url: string | undefined): void => {
|
||||||
|
|||||||
@@ -0,0 +1,117 @@
|
|||||||
|
import { test } from 'node:test';
|
||||||
|
import assert from 'node:assert/strict';
|
||||||
|
import { KeychainInvoke, sameTokens, syncKeychain, tokensOf } from './keychainMirror';
|
||||||
|
import type { Session } from './sessions';
|
||||||
|
|
||||||
|
const session: Session = {
|
||||||
|
baseUrl: 'https://matrix.example.org',
|
||||||
|
userId: '@alice:example.org',
|
||||||
|
deviceId: 'DEV1',
|
||||||
|
accessToken: 'syt_token',
|
||||||
|
refreshToken: 'mar_refresh',
|
||||||
|
};
|
||||||
|
|
||||||
|
/** An in-memory keychain behind the same commands the desktop app exposes. */
|
||||||
|
const fakeKeychain = (opts: { supported?: boolean; failSet?: boolean; corrupt?: boolean } = {}) => {
|
||||||
|
let stored: unknown = null;
|
||||||
|
const calls: string[] = [];
|
||||||
|
const invoke: KeychainInvoke = async (cmd, args) => {
|
||||||
|
calls.push(cmd);
|
||||||
|
switch (cmd) {
|
||||||
|
case 'secure_session_supported':
|
||||||
|
return opts.supported ?? true;
|
||||||
|
case 'secure_session_get':
|
||||||
|
return stored;
|
||||||
|
case 'secure_session_set':
|
||||||
|
if (opts.failSet) throw new Error('Access is denied.');
|
||||||
|
stored = opts.corrupt ? { ...(args?.tokens as object), accessToken: 'x' } : args?.tokens;
|
||||||
|
return null;
|
||||||
|
case 'secure_session_clear':
|
||||||
|
stored = null;
|
||||||
|
return null;
|
||||||
|
default:
|
||||||
|
throw new Error(`unknown ${cmd}`);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
return { invoke, calls, get: () => stored };
|
||||||
|
};
|
||||||
|
|
||||||
|
test('stores the tokens (not the whole session) and verifies them', async () => {
|
||||||
|
const kc = fakeKeychain();
|
||||||
|
assert.deepEqual(await syncKeychain(kc.invoke, session), { state: 'ok' });
|
||||||
|
assert.deepEqual(kc.get(), {
|
||||||
|
userId: '@alice:example.org',
|
||||||
|
deviceId: 'DEV1',
|
||||||
|
accessToken: 'syt_token',
|
||||||
|
refreshToken: 'mar_refresh',
|
||||||
|
});
|
||||||
|
assert.deepEqual(kc.calls, [
|
||||||
|
'secure_session_supported',
|
||||||
|
'secure_session_get',
|
||||||
|
'secure_session_set',
|
||||||
|
'secure_session_get',
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('an up-to-date copy is not rewritten', async () => {
|
||||||
|
const kc = fakeKeychain();
|
||||||
|
await syncKeychain(kc.invoke, session);
|
||||||
|
kc.calls.length = 0;
|
||||||
|
assert.deepEqual(await syncKeychain(kc.invoke, session), { state: 'ok' });
|
||||||
|
assert.deepEqual(kc.calls, ['secure_session_supported', 'secure_session_get']);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a token rotation rewrites; no session clears', async () => {
|
||||||
|
const kc = fakeKeychain();
|
||||||
|
await syncKeychain(kc.invoke, session);
|
||||||
|
await syncKeychain(kc.invoke, { ...session, accessToken: 'syt_new', refreshToken: undefined });
|
||||||
|
assert.equal((kc.get() as { accessToken: string }).accessToken, 'syt_new');
|
||||||
|
assert.equal('refreshToken' in (kc.get() as object), false);
|
||||||
|
assert.deepEqual(await syncKeychain(kc.invoke, null), { state: 'cleared' });
|
||||||
|
assert.equal(kc.get(), null);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('unsupported platform: nothing is touched', async () => {
|
||||||
|
const kc = fakeKeychain({ supported: false });
|
||||||
|
assert.deepEqual(await syncKeychain(kc.invoke, session), { state: 'unsupported' });
|
||||||
|
assert.deepEqual(kc.calls, ['secure_session_supported']);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('failures become a status, never an exception', async () => {
|
||||||
|
assert.deepEqual(await syncKeychain(fakeKeychain({ failSet: true }).invoke, session), {
|
||||||
|
state: 'error',
|
||||||
|
error: 'Access is denied.',
|
||||||
|
});
|
||||||
|
assert.deepEqual(await syncKeychain(fakeKeychain({ corrupt: true }).invoke, session), {
|
||||||
|
state: 'error',
|
||||||
|
error: 'read-back did not match',
|
||||||
|
});
|
||||||
|
// The credential store hangs (the support check itself is instant).
|
||||||
|
const hung: KeychainInvoke = async (cmd) =>
|
||||||
|
cmd === 'secure_session_supported'
|
||||||
|
? true
|
||||||
|
: new Promise(() => {
|
||||||
|
/* never settles */
|
||||||
|
});
|
||||||
|
assert.deepEqual(await syncKeychain(hung, session, 50), {
|
||||||
|
state: 'error',
|
||||||
|
error: 'keychain timed out',
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a desktop build without the commands reads as unsupported, not an error', async () => {
|
||||||
|
const missingCommand: KeychainInvoke = async (cmd) => {
|
||||||
|
throw new Error(`Command ${cmd} not found`);
|
||||||
|
};
|
||||||
|
assert.deepEqual(await syncKeychain(missingCommand, session), { state: 'unsupported' });
|
||||||
|
});
|
||||||
|
|
||||||
|
test('sameTokens compares only the secrets, treating a missing refresh token as absent', () => {
|
||||||
|
const t = tokensOf({ ...session, refreshToken: undefined });
|
||||||
|
assert.equal(sameTokens({ ...t }, t), true);
|
||||||
|
assert.equal(sameTokens({ ...t, refreshToken: undefined }, t), true);
|
||||||
|
assert.equal(sameTokens({ ...t, accessToken: 'other' }, t), false);
|
||||||
|
assert.equal(sameTokens({ ...t, refreshToken: 'r' }, t), false);
|
||||||
|
assert.equal(sameTokens(null, t), false);
|
||||||
|
assert.equal(sameTokens('string', t), false);
|
||||||
|
});
|
||||||
@@ -0,0 +1,141 @@
|
|||||||
|
import { useEffect, useState } from 'react';
|
||||||
|
import { getFallbackSession, onSessionPersisted, Session } from './sessions';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #105] Desktop, step 1: mirror the login tokens into the OS keychain.
|
||||||
|
*
|
||||||
|
* The session is still read from localStorage exactly as before; this only
|
||||||
|
* keeps a copy in the keychain (Windows Credential Manager) and checks it by
|
||||||
|
* reading it back, so real installs prove the keychain works before step 2
|
||||||
|
* switches reads over to it. Nothing here can log anyone out: every failure
|
||||||
|
* just records a status for Settings.
|
||||||
|
*
|
||||||
|
* Writes are serialized (a token rotation right after login must not race
|
||||||
|
* the login's write) and time out, so a hung credential store can't pile up.
|
||||||
|
* When there's no session the keychain entry is cleared, which also covers a
|
||||||
|
* logout whose page reload beat the clear.
|
||||||
|
*/
|
||||||
|
|
||||||
|
export type KeychainTokens = {
|
||||||
|
userId: string;
|
||||||
|
deviceId: string;
|
||||||
|
accessToken: string;
|
||||||
|
refreshToken?: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type KeychainMirrorStatus =
|
||||||
|
| { state: 'idle' }
|
||||||
|
| { state: 'unsupported' }
|
||||||
|
| { state: 'ok' }
|
||||||
|
| { state: 'cleared' }
|
||||||
|
| { state: 'error'; error: string };
|
||||||
|
|
||||||
|
export type KeychainInvoke = (cmd: string, args?: Record<string, unknown>) => Promise<unknown>;
|
||||||
|
|
||||||
|
export const KEYCHAIN_TIMEOUT_MS = 5000;
|
||||||
|
|
||||||
|
export const tokensOf = (session: Session): KeychainTokens => ({
|
||||||
|
userId: session.userId,
|
||||||
|
deviceId: session.deviceId,
|
||||||
|
accessToken: session.accessToken,
|
||||||
|
...(session.refreshToken ? { refreshToken: session.refreshToken } : {}),
|
||||||
|
});
|
||||||
|
|
||||||
|
export const sameTokens = (a: unknown, b: KeychainTokens): boolean => {
|
||||||
|
if (!a || typeof a !== 'object') return false;
|
||||||
|
const t = a as Partial<KeychainTokens>;
|
||||||
|
return (
|
||||||
|
t.userId === b.userId &&
|
||||||
|
t.deviceId === b.deviceId &&
|
||||||
|
t.accessToken === b.accessToken &&
|
||||||
|
(t.refreshToken ?? undefined) === (b.refreshToken ?? undefined)
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
const withTimeout = <T>(p: Promise<T>, ms: number): Promise<T> =>
|
||||||
|
new Promise<T>((resolve, reject) => {
|
||||||
|
const timer = setTimeout(() => reject(new Error('keychain timed out')), ms);
|
||||||
|
p.then(
|
||||||
|
(v) => {
|
||||||
|
clearTimeout(timer);
|
||||||
|
resolve(v);
|
||||||
|
},
|
||||||
|
(e) => {
|
||||||
|
clearTimeout(timer);
|
||||||
|
reject(e);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
const errorText = (e: unknown): string =>
|
||||||
|
(e instanceof Error ? e.message : String(e)).slice(0, 200);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Bring the keychain in line with `session` (null = no session). Reads first
|
||||||
|
* and only writes when the stored copy differs, then verifies by reading back.
|
||||||
|
*/
|
||||||
|
export const syncKeychain = async (
|
||||||
|
invoke: KeychainInvoke,
|
||||||
|
session: Session | null,
|
||||||
|
timeoutMs = KEYCHAIN_TIMEOUT_MS,
|
||||||
|
): Promise<KeychainMirrorStatus> => {
|
||||||
|
// A desktop build without the commands (older than this feature) rejects
|
||||||
|
// the call: that is "not supported", not an error to show the user.
|
||||||
|
let supported: unknown;
|
||||||
|
try {
|
||||||
|
supported = await withTimeout(invoke('secure_session_supported'), timeoutMs);
|
||||||
|
} catch {
|
||||||
|
supported = false;
|
||||||
|
}
|
||||||
|
if (supported !== true) return { state: 'unsupported' };
|
||||||
|
try {
|
||||||
|
if (!session) {
|
||||||
|
await withTimeout(invoke('secure_session_clear'), timeoutMs);
|
||||||
|
return { state: 'cleared' };
|
||||||
|
}
|
||||||
|
const tokens = tokensOf(session);
|
||||||
|
const stored = await withTimeout(invoke('secure_session_get'), timeoutMs);
|
||||||
|
if (sameTokens(stored, tokens)) return { state: 'ok' };
|
||||||
|
await withTimeout(invoke('secure_session_set', { tokens }), timeoutMs);
|
||||||
|
const back = await withTimeout(invoke('secure_session_get'), timeoutMs);
|
||||||
|
if (!sameTokens(back, tokens)) return { state: 'error', error: 'read-back did not match' };
|
||||||
|
return { state: 'ok' };
|
||||||
|
} catch (e) {
|
||||||
|
return { state: 'error', error: errorText(e) };
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let status: KeychainMirrorStatus = { state: 'idle' };
|
||||||
|
const statusListeners = new Set<(s: KeychainMirrorStatus) => void>();
|
||||||
|
const setStatus = (next: KeychainMirrorStatus): void => {
|
||||||
|
status = next;
|
||||||
|
statusListeners.forEach((cb) => cb(next));
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getKeychainMirrorStatus = (): KeychainMirrorStatus => status;
|
||||||
|
|
||||||
|
let started = false;
|
||||||
|
|
||||||
|
/** Start mirroring (desktop only; call once at boot). */
|
||||||
|
export const startKeychainMirror = (invoke: KeychainInvoke | undefined): void => {
|
||||||
|
if (!invoke || started) return;
|
||||||
|
started = true;
|
||||||
|
let chain: Promise<unknown> = Promise.resolve();
|
||||||
|
const enqueue = (session: Session | null) => {
|
||||||
|
chain = chain.then(async () => setStatus(await syncKeychain(invoke, session)));
|
||||||
|
};
|
||||||
|
enqueue(getFallbackSession() ?? null);
|
||||||
|
onSessionPersisted((session) => enqueue(session));
|
||||||
|
};
|
||||||
|
|
||||||
|
export const useKeychainMirrorStatus = (): KeychainMirrorStatus => {
|
||||||
|
const [value, setValue] = useState(status);
|
||||||
|
useEffect(() => {
|
||||||
|
setValue(status);
|
||||||
|
statusListeners.add(setValue);
|
||||||
|
return () => {
|
||||||
|
statusListeners.delete(setValue);
|
||||||
|
};
|
||||||
|
}, []);
|
||||||
|
return value;
|
||||||
|
};
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import { atom } from 'jotai';
|
||||||
|
import { ServerStatus } from '../utils/kumaStatus';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #124] The homeserver's status from its Kuma status page (null: none
|
||||||
|
* configured, not fetched yet, or Kuma unreachable — all mean "no banner"),
|
||||||
|
* plus whether this client's own connection is currently lost.
|
||||||
|
*/
|
||||||
|
export const serverStatusAtom = atom<{
|
||||||
|
status: ServerStatus | null;
|
||||||
|
syncLost: boolean;
|
||||||
|
/** When this client's connection dropped (ms), null while connected. */
|
||||||
|
lostAt: number | null;
|
||||||
|
}>({
|
||||||
|
status: null,
|
||||||
|
syncLost: false,
|
||||||
|
lostAt: null,
|
||||||
|
});
|
||||||
@@ -432,3 +432,20 @@ test('subscribeSessionChanges ignores unrelated storage keys', () => {
|
|||||||
listeners.forEach((cb) => cb({ key: 'some_unrelated_preference' }));
|
listeners.forEach((cb) => cb({ key: 'some_unrelated_preference' }));
|
||||||
assert.equal(fired, false);
|
assert.equal(fired, false);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('onSessionPersisted: told about writes and removals; a throwing listener is harmless', async () => {
|
||||||
|
installStorage();
|
||||||
|
const { onSessionPersisted } = await import('./sessions');
|
||||||
|
const seen: (string | null)[] = [];
|
||||||
|
const offBad = onSessionPersisted(() => {
|
||||||
|
throw new Error('boom');
|
||||||
|
});
|
||||||
|
const off = onSessionPersisted((s) => seen.push(s ? s.accessToken : null));
|
||||||
|
setFallbackSession('tok-a', 'DEV', '@a:hs', 'https://hs', { refreshToken: 'ref-a' });
|
||||||
|
removeFallbackSession();
|
||||||
|
off();
|
||||||
|
offBad();
|
||||||
|
setFallbackSession('tok-b', 'DEV', '@a:hs', 'https://hs');
|
||||||
|
assert.deepEqual(seen, ['tok-a', null]);
|
||||||
|
assert.equal(getFallbackSession()?.accessToken, 'tok-b', 'write still happened');
|
||||||
|
});
|
||||||
|
|||||||
@@ -233,6 +233,27 @@ export type SessionStoreName = {
|
|||||||
// crypto: 'crypto-store',
|
// crypto: 'crypto-store',
|
||||||
// } as const;
|
// } as const;
|
||||||
|
|
||||||
|
// [Gitea #105] Listeners told about every session write in THIS tab (login,
|
||||||
|
// token rotation) and removal (logout), e.g. the desktop keychain mirror.
|
||||||
|
// A throwing listener never breaks the write.
|
||||||
|
type PersistListener = (session: Session | null) => void;
|
||||||
|
const persistListeners = new Set<PersistListener>();
|
||||||
|
const notifyPersisted = (session: Session | null): void => {
|
||||||
|
persistListeners.forEach((cb) => {
|
||||||
|
try {
|
||||||
|
cb(session);
|
||||||
|
} catch {
|
||||||
|
/* listener errors must not affect login/logout */
|
||||||
|
}
|
||||||
|
});
|
||||||
|
};
|
||||||
|
export const onSessionPersisted = (cb: PersistListener): (() => void) => {
|
||||||
|
persistListeners.add(cb);
|
||||||
|
return () => {
|
||||||
|
persistListeners.delete(cb);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
// Persist the session. Writes the atomic blob FIRST (so the consistent,
|
// Persist the session. Writes the atomic blob FIRST (so the consistent,
|
||||||
// never-torn copy is established before the multi-key legacy write), then
|
// never-torn copy is established before the multi-key legacy write), then
|
||||||
// dual-writes the legacy keys for rollback safety. Signature is unchanged —
|
// dual-writes the legacy keys for rollback safety. Signature is unchanged —
|
||||||
@@ -249,6 +270,7 @@ export function setFallbackSession(
|
|||||||
localStorage.setItem(SESSION_BLOB_KEY, JSON.stringify(persisted));
|
localStorage.setItem(SESSION_BLOB_KEY, JSON.stringify(persisted));
|
||||||
// Dual-write the legacy keys (removal of this half is a future release).
|
// Dual-write the legacy keys (removal of this half is a future release).
|
||||||
writeLegacyKeys(persisted);
|
writeLegacyKeys(persisted);
|
||||||
|
notifyPersisted(sessionFromPersisted(persisted));
|
||||||
}
|
}
|
||||||
|
|
||||||
// Clear BOTH the atomic blob and every legacy key so no reader (blob-preferring
|
// Clear BOTH the atomic blob and every legacy key so no reader (blob-preferring
|
||||||
@@ -257,6 +279,7 @@ export const removeFallbackSession = () => {
|
|||||||
localStorage.removeItem(SESSION_BLOB_KEY);
|
localStorage.removeItem(SESSION_BLOB_KEY);
|
||||||
Object.values(LEGACY_KEYS).forEach((key) => localStorage.removeItem(key));
|
Object.values(LEGACY_KEYS).forEach((key) => localStorage.removeItem(key));
|
||||||
Object.values(OIDC_KEYS).forEach((key) => localStorage.removeItem(key));
|
Object.values(OIDC_KEYS).forEach((key) => localStorage.removeItem(key));
|
||||||
|
notifyPersisted(null);
|
||||||
};
|
};
|
||||||
|
|
||||||
// Read the session, preferring the atomic blob. If the blob is absent or
|
// Read the session, preferring the atomic blob. If the blob is absent or
|
||||||
|
|||||||
@@ -0,0 +1,262 @@
|
|||||||
|
import { test } from 'node:test';
|
||||||
|
import assert from 'node:assert/strict';
|
||||||
|
import {
|
||||||
|
DEFAULT_GROUPS,
|
||||||
|
kumaBeatTime,
|
||||||
|
kumaUrls,
|
||||||
|
parseKumaStatus,
|
||||||
|
pickBanner,
|
||||||
|
resolveStatusPage,
|
||||||
|
serverConfirmedUpSince,
|
||||||
|
ServerStatus,
|
||||||
|
} from './kumaStatus';
|
||||||
|
|
||||||
|
// The live `matrix` status page's groups (captured 2026-09-29).
|
||||||
|
const PAGE = {
|
||||||
|
publicGroupList: [
|
||||||
|
{ name: 'Homeserver', monitorList: [{ id: 30, name: 'Synapse HTTP' }] },
|
||||||
|
{
|
||||||
|
name: 'Voice calls',
|
||||||
|
monitorList: [
|
||||||
|
{ id: 37, name: 'Matrix: LiveKit (public /rtc)' },
|
||||||
|
{ id: 38, name: 'Matrix: call tokens (public /sfu/get)' },
|
||||||
|
{ id: 39, name: 'Matrix: call page (call.chat)' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{ name: 'Login', monitorList: [{ id: 15, name: 'Authentication Server' }] },
|
||||||
|
],
|
||||||
|
maintenanceList: [],
|
||||||
|
incidents: [],
|
||||||
|
};
|
||||||
|
const UP = 1;
|
||||||
|
const DOWN = 0;
|
||||||
|
const PENDING = 2;
|
||||||
|
/** Kuma's beat format: "YYYY-MM-DD HH:MM:SS.mmm" in UTC, oldest first. */
|
||||||
|
const beats = (...statuses: number[]) =>
|
||||||
|
statuses.map((status, i) => ({
|
||||||
|
status,
|
||||||
|
time: `2026-09-29 14:${String(10 + i).padStart(2, '0')}:00.000`,
|
||||||
|
msg: '',
|
||||||
|
}));
|
||||||
|
const hb = (over: Record<number, number[]> = {}) => ({
|
||||||
|
heartbeatList: {
|
||||||
|
30: beats(...(over[30] ?? [UP, UP, UP])),
|
||||||
|
37: beats(...(over[37] ?? [UP, UP])),
|
||||||
|
38: beats(...(over[38] ?? [UP, UP])),
|
||||||
|
39: beats(...(over[39] ?? [UP, UP])),
|
||||||
|
15: beats(...(over[15] ?? [UP, UP])),
|
||||||
|
},
|
||||||
|
uptimeList: {},
|
||||||
|
});
|
||||||
|
const parse = (page: unknown, heartbeat: unknown) =>
|
||||||
|
parseKumaStatus(page, heartbeat, DEFAULT_GROUPS);
|
||||||
|
|
||||||
|
test('config: only a valid page for the listed homeserver', () => {
|
||||||
|
const cfg = {
|
||||||
|
'matrix.lotusguild.org': { url: 'https://isitup.lotusguild.org/', slug: 'matrix' },
|
||||||
|
};
|
||||||
|
const page = resolveStatusPage(cfg, 'matrix.lotusguild.org');
|
||||||
|
assert.deepEqual(page, {
|
||||||
|
url: 'https://isitup.lotusguild.org',
|
||||||
|
slug: 'matrix',
|
||||||
|
groups: DEFAULT_GROUPS,
|
||||||
|
});
|
||||||
|
assert.deepEqual(kumaUrls(page!), {
|
||||||
|
page: 'https://isitup.lotusguild.org/api/status-page/matrix',
|
||||||
|
heartbeat: 'https://isitup.lotusguild.org/api/status-page/heartbeat/matrix',
|
||||||
|
});
|
||||||
|
assert.equal(resolveStatusPage(cfg, 'matrix.org'), undefined, 'other homeservers: nothing');
|
||||||
|
assert.equal(resolveStatusPage(cfg, undefined), undefined);
|
||||||
|
assert.equal(resolveStatusPage(undefined, 'matrix.lotusguild.org'), undefined);
|
||||||
|
for (const bad of [
|
||||||
|
{ url: 'http://isitup.lotusguild.org', slug: 'matrix' },
|
||||||
|
{ url: ['javascript', 'alert(1)'].join(':'), slug: 'matrix' },
|
||||||
|
{ url: 'https://isitup.lotusguild.org', slug: '../admin' },
|
||||||
|
{ url: 'https://isitup.lotusguild.org', slug: '' },
|
||||||
|
{ url: 'not a url', slug: 'matrix' },
|
||||||
|
]) {
|
||||||
|
assert.equal(resolveStatusPage({ hs: bad }, 'hs'), undefined, JSON.stringify(bad));
|
||||||
|
}
|
||||||
|
assert.equal(
|
||||||
|
resolveStatusPage({ hs: { url: 'http://localhost:3001', slug: 'm' } }, 'hs')?.url,
|
||||||
|
'http://localhost:3001',
|
||||||
|
'http allowed for local development',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('all green on the live page layout', () => {
|
||||||
|
const s = parse(PAGE, hb());
|
||||||
|
assert.equal(s.homeserver, 'up');
|
||||||
|
assert.equal(s.calls, 'up');
|
||||||
|
assert.equal(s.login, 'up');
|
||||||
|
assert.equal(pickBanner(s, { syncLost: false, where: 'client' }), undefined);
|
||||||
|
assert.equal(pickBanner(s, { syncLost: true, where: 'client' }), undefined);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('down needs two failing checks: down+down or pending+down; one blip is not down', () => {
|
||||||
|
assert.equal(parse(PAGE, hb({ 30: [UP, UP, DOWN] })).homeserver, 'up', 'single failure');
|
||||||
|
assert.equal(parse(PAGE, hb({ 30: [UP, PENDING] })).homeserver, 'up', 'pending only');
|
||||||
|
assert.equal(parse(PAGE, hb({ 30: [UP, DOWN, DOWN] })).homeserver, 'down');
|
||||||
|
assert.equal(parse(PAGE, hb({ 30: [UP, PENDING, DOWN] })).homeserver, 'down');
|
||||||
|
assert.equal(parse(PAGE, hb({ 30: [DOWN, DOWN, UP] })).homeserver, 'up', 'recovered');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('any failing monitor takes its group down (one piece breaks calls)', () => {
|
||||||
|
const s = parse(PAGE, hb({ 38: [DOWN, DOWN] }));
|
||||||
|
assert.equal(s.calls, 'down');
|
||||||
|
assert.equal(s.homeserver, 'up');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('unknown when the group or its beats are missing, and unknown shows nothing', () => {
|
||||||
|
const s = parse({ publicGroupList: [] }, hb());
|
||||||
|
assert.deepEqual([s.homeserver, s.calls, s.login], ['unknown', 'unknown', 'unknown']);
|
||||||
|
assert.equal(parse(PAGE, { heartbeatList: {} }).homeserver, 'unknown');
|
||||||
|
assert.equal(pickBanner(s, { syncLost: true, where: 'client' }), undefined);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('garbage from Kuma never throws and never shows a banner', () => {
|
||||||
|
for (const [page, heartbeat] of [
|
||||||
|
[null, null],
|
||||||
|
['<html>', 42],
|
||||||
|
[{ publicGroupList: 'x', maintenanceList: {}, incidents: 7 }, { heartbeatList: [] }],
|
||||||
|
[{ publicGroupList: [{ name: 'Homeserver', monitorList: [{ id: {} }] }] }, hb()],
|
||||||
|
]) {
|
||||||
|
const s = parse(page, heartbeat);
|
||||||
|
assert.equal(pickBanner(s, { syncLost: true, where: 'client' }), undefined);
|
||||||
|
}
|
||||||
|
assert.equal(pickBanner(null, { syncLost: true, where: 'client' }), undefined);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('beat times are read as UTC; checkedAt is the oldest latest beat', () => {
|
||||||
|
assert.equal(kumaBeatTime('2026-09-29 14:16:11.804'), Date.UTC(2026, 8, 29, 14, 16, 11, 804));
|
||||||
|
assert.equal(kumaBeatTime('nope'), undefined);
|
||||||
|
const s = parse(PAGE, hb());
|
||||||
|
assert.equal(s.homeserverCheckedAt, Date.UTC(2026, 8, 29, 14, 12));
|
||||||
|
});
|
||||||
|
|
||||||
|
test('"your connection" only when Kuma checked AFTER the drop and the server was up', () => {
|
||||||
|
const s = parse(PAGE, hb());
|
||||||
|
const checked = s.homeserverCheckedAt!;
|
||||||
|
assert.equal(serverConfirmedUpSince(s, checked - 60_000), true, 'checked after the drop');
|
||||||
|
assert.equal(serverConfirmedUpSince(s, checked + 1), false, 'stale: checked before the drop');
|
||||||
|
assert.equal(serverConfirmedUpSince(s, null), false, 'not disconnected');
|
||||||
|
const down = parse(PAGE, hb({ 30: [UP, DOWN, DOWN] }));
|
||||||
|
assert.equal(serverConfirmedUpSince(down, checked - 60_000), false);
|
||||||
|
assert.equal(serverConfirmedUpSince(null, 1), false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('server down vs having problems depends on this client’s own connection', () => {
|
||||||
|
const s = parse(PAGE, hb({ 30: [DOWN, DOWN] }));
|
||||||
|
assert.equal(pickBanner(s, { syncLost: true, where: 'client' })?.kind, 'server-down');
|
||||||
|
assert.equal(pickBanner(s, { syncLost: true, where: 'client' })?.tone, 'Critical');
|
||||||
|
assert.equal(pickBanner(s, { syncLost: false, where: 'client' })?.kind, 'server-problems');
|
||||||
|
assert.equal(pickBanner(s, { syncLost: false, where: 'login' })?.kind, 'server-down');
|
||||||
|
assert.equal(pickBanner(s, { syncLost: true, where: 'client' })?.dismissable, false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('priority: server > maintenance > calls > announcement; one strip only', () => {
|
||||||
|
const s: ServerStatus = {
|
||||||
|
...parse(PAGE, hb({ 30: [DOWN, DOWN], 37: [DOWN, DOWN] })),
|
||||||
|
maintenance: [{ id: '1', title: 'Upgrade', description: '' }],
|
||||||
|
incidents: [{ id: '2', title: 'Heads up', content: '', style: 'info', updated: 'x' }],
|
||||||
|
};
|
||||||
|
assert.equal(pickBanner(s, { syncLost: true, where: 'client' })?.kind, 'server-down');
|
||||||
|
assert.equal(
|
||||||
|
pickBanner({ ...s, homeserver: 'up' }, { syncLost: false, where: 'client' })?.kind,
|
||||||
|
'maintenance',
|
||||||
|
);
|
||||||
|
assert.equal(
|
||||||
|
pickBanner({ ...s, homeserver: 'up', maintenance: [] }, { syncLost: false, where: 'client' })
|
||||||
|
?.kind,
|
||||||
|
'calls-down',
|
||||||
|
);
|
||||||
|
assert.equal(
|
||||||
|
pickBanner(
|
||||||
|
{ ...s, homeserver: 'up', maintenance: [], calls: 'up' },
|
||||||
|
{ syncLost: false, where: 'client' },
|
||||||
|
)?.kind,
|
||||||
|
'announcement',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('calls-down is not shown on the login screen or when the whole server is down', () => {
|
||||||
|
const calls = parse(PAGE, hb({ 37: [DOWN, DOWN] }));
|
||||||
|
assert.equal(pickBanner(calls, { syncLost: false, where: 'login' }), undefined);
|
||||||
|
const both = parse(PAGE, hb({ 30: [DOWN, DOWN], 37: [DOWN, DOWN] }));
|
||||||
|
assert.equal(pickBanner(both, { syncLost: false, where: 'client' })?.kind, 'server-problems');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('login-down only on the login screen', () => {
|
||||||
|
const s = parse(PAGE, hb({ 15: [DOWN, DOWN] }));
|
||||||
|
assert.equal(pickBanner(s, { syncLost: false, where: 'login' })?.kind, 'login-down');
|
||||||
|
assert.equal(pickBanner(s, { syncLost: false, where: 'client' }), undefined);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('maintenance: title, end time and plain-text description', () => {
|
||||||
|
const end = '2026-09-29T22:15:00.000Z';
|
||||||
|
const s = parse(
|
||||||
|
{
|
||||||
|
...PAGE,
|
||||||
|
maintenanceList: [
|
||||||
|
{
|
||||||
|
id: 7,
|
||||||
|
title: 'Homeserver upgrade',
|
||||||
|
description: '**Synapse 1.160**, see [notes](https://x)',
|
||||||
|
status: 'under-maintenance',
|
||||||
|
timeslotList: [{ startDate: '2026-09-29T22:00:00.000Z', endDate: end }],
|
||||||
|
},
|
||||||
|
{ id: 8, title: 'Later', status: 'scheduled' },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
hb(),
|
||||||
|
);
|
||||||
|
assert.equal(s.maintenance.length, 1, 'only windows under maintenance');
|
||||||
|
assert.equal(s.maintenance[0].end, Date.parse(end));
|
||||||
|
const b = pickBanner(s, { syncLost: false, where: 'client' })!;
|
||||||
|
assert.equal(b.kind, 'maintenance');
|
||||||
|
assert.match(b.text, /^Maintenance in progress until .+: Homeserver upgrade\. /);
|
||||||
|
assert.equal(b.detail, 'Synapse 1.160, see notes');
|
||||||
|
assert.equal(b.dismissable, false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('announcements: tone from style, dismissable, a new edit comes back', () => {
|
||||||
|
const incident = {
|
||||||
|
id: 3,
|
||||||
|
style: 'danger',
|
||||||
|
title: 'Planned maintenance tonight',
|
||||||
|
content: 'Calls will drop briefly.',
|
||||||
|
active: true,
|
||||||
|
createdDate: '2026-09-29 15:00:00',
|
||||||
|
lastUpdatedDate: null,
|
||||||
|
};
|
||||||
|
const s = parse({ ...PAGE, incidents: [incident] }, hb());
|
||||||
|
const b = pickBanner(s, { syncLost: false, where: 'client' })!;
|
||||||
|
assert.equal(b.kind, 'announcement');
|
||||||
|
assert.equal(b.tone, 'Critical');
|
||||||
|
assert.equal(b.dismissable, true);
|
||||||
|
const dismissed = new Set([b.key]);
|
||||||
|
assert.equal(pickBanner(s, { syncLost: false, where: 'client', dismissed }), undefined);
|
||||||
|
const edited = parse(
|
||||||
|
{ ...PAGE, incidents: [{ ...incident, lastUpdatedDate: '2026-09-29 16:00:00' }] },
|
||||||
|
hb(),
|
||||||
|
);
|
||||||
|
assert.equal(
|
||||||
|
pickBanner(edited, { syncLost: false, where: 'client', dismissed })?.kind,
|
||||||
|
'announcement',
|
||||||
|
);
|
||||||
|
const inactive = parse({ ...PAGE, incidents: [{ ...incident, active: false }] }, hb());
|
||||||
|
assert.equal(pickBanner(inactive, { syncLost: false, where: 'client' }), undefined);
|
||||||
|
const info = parse({ ...PAGE, incidents: [{ ...incident, style: 'info' }] }, hb());
|
||||||
|
assert.equal(pickBanner(info, { syncLost: false, where: 'client' })?.tone, 'Primary');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('a dismissed calls-down banner lets the next one through, never hides server-down', () => {
|
||||||
|
const s = parse(PAGE, hb({ 37: [DOWN, DOWN] }));
|
||||||
|
const dismissed = new Set(['calls-down', 'server-down', 'server-problems']);
|
||||||
|
assert.equal(pickBanner(s, { syncLost: false, where: 'client', dismissed }), undefined);
|
||||||
|
const down = parse(PAGE, hb({ 30: [DOWN, DOWN] }));
|
||||||
|
assert.equal(
|
||||||
|
pickBanner(down, { syncLost: true, where: 'client', dismissed })?.kind,
|
||||||
|
'server-down',
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,332 @@
|
|||||||
|
/**
|
||||||
|
* [Gitea #124] Homeserver status from an Uptime Kuma status page.
|
||||||
|
*
|
||||||
|
* config.json maps a homeserver to a Kuma status page:
|
||||||
|
* "statusPages": { "matrix.lotusguild.org": { "url": "https://isitup.lotusguild.org",
|
||||||
|
* "slug": "matrix", "groups": { "homeserver": "Homeserver", "calls": "Voice calls",
|
||||||
|
* "login": "Login" } } }
|
||||||
|
* Users of any other homeserver never contact Kuma.
|
||||||
|
*
|
||||||
|
* Kuma 2.x public JSON:
|
||||||
|
* - GET /api/status-page/<slug>: publicGroupList[{name, monitorList[{id}]}],
|
||||||
|
* maintenanceList (only windows UNDER maintenance right now), incidents
|
||||||
|
* (announcements posted on the page).
|
||||||
|
* - GET /api/status-page/heartbeat/<slug>: heartbeatList{<monitorId>: [{status, time}]},
|
||||||
|
* status 0 down, 1 up, 2 pending, 3 maintenance.
|
||||||
|
*
|
||||||
|
* Everything here is pure and defensive: anything unexpected reads as
|
||||||
|
* "unknown", and unknown never shows a banner.
|
||||||
|
*/
|
||||||
|
|
||||||
|
export type StatusGroups = { homeserver?: string; calls?: string; login?: string };
|
||||||
|
export type StatusPageConfig = { url: string; slug: string; groups: StatusGroups };
|
||||||
|
|
||||||
|
export type ServiceState = 'up' | 'down' | 'unknown';
|
||||||
|
export type KumaMaintenance = { id: string; title: string; description: string; end?: number };
|
||||||
|
export type KumaIncident = {
|
||||||
|
id: string;
|
||||||
|
title: string;
|
||||||
|
content: string;
|
||||||
|
style: string;
|
||||||
|
updated: string;
|
||||||
|
};
|
||||||
|
export type ServerStatus = {
|
||||||
|
homeserver: ServiceState;
|
||||||
|
/**
|
||||||
|
* When Kuma last checked every homeserver monitor (the OLDEST of their
|
||||||
|
* latest beats, ms). Lets the client tell "Kuma has looked since my
|
||||||
|
* connection dropped and the server was fine" from a stale "up".
|
||||||
|
*/
|
||||||
|
homeserverCheckedAt?: number;
|
||||||
|
calls: ServiceState;
|
||||||
|
login: ServiceState;
|
||||||
|
maintenance: KumaMaintenance[];
|
||||||
|
incidents: KumaIncident[];
|
||||||
|
};
|
||||||
|
|
||||||
|
export const DEFAULT_GROUPS: Required<StatusGroups> = {
|
||||||
|
homeserver: 'Homeserver',
|
||||||
|
calls: 'Voice calls',
|
||||||
|
login: 'Login',
|
||||||
|
};
|
||||||
|
|
||||||
|
const obj = (v: unknown): Record<string, unknown> | undefined =>
|
||||||
|
v && typeof v === 'object' && !Array.isArray(v) ? (v as Record<string, unknown>) : undefined;
|
||||||
|
const str = (v: unknown): string => (typeof v === 'string' ? v : '');
|
||||||
|
|
||||||
|
/** The status page for `serverName`, if config.json names a valid one. */
|
||||||
|
export const resolveStatusPage = (
|
||||||
|
statusPages: unknown,
|
||||||
|
serverName: string | undefined,
|
||||||
|
): StatusPageConfig | undefined => {
|
||||||
|
if (!serverName) return undefined;
|
||||||
|
const entry = obj(obj(statusPages)?.[serverName]);
|
||||||
|
if (!entry) return undefined;
|
||||||
|
const slug = str(entry.slug);
|
||||||
|
if (!/^[a-z0-9-]{1,64}$/i.test(slug)) return undefined;
|
||||||
|
try {
|
||||||
|
const url = new URL(str(entry.url));
|
||||||
|
const local = url.hostname === 'localhost' || url.hostname === '127.0.0.1';
|
||||||
|
if (url.protocol !== 'https:' && !(url.protocol === 'http:' && local)) return undefined;
|
||||||
|
const g = obj(entry.groups) ?? {};
|
||||||
|
return {
|
||||||
|
url: url.origin,
|
||||||
|
slug,
|
||||||
|
groups: {
|
||||||
|
homeserver: str(g.homeserver) || DEFAULT_GROUPS.homeserver,
|
||||||
|
calls: str(g.calls) || DEFAULT_GROUPS.calls,
|
||||||
|
login: str(g.login) || DEFAULT_GROUPS.login,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
} catch {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const kumaUrls = (page: StatusPageConfig) => ({
|
||||||
|
page: `${page.url}/api/status-page/${page.slug}`,
|
||||||
|
heartbeat: `${page.url}/api/status-page/heartbeat/${page.slug}`,
|
||||||
|
});
|
||||||
|
|
||||||
|
const DOWN = 0;
|
||||||
|
|
||||||
|
const PENDING = 2;
|
||||||
|
|
||||||
|
/** Kuma beat time ("2026-09-29 14:16:11.804", UTC) → ms. */
|
||||||
|
export const kumaBeatTime = (time: unknown): number | undefined => {
|
||||||
|
const t = Date.parse(`${str(time).trim().replace(' ', 'T')}Z`);
|
||||||
|
return Number.isFinite(t) ? t : undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
const sortedBeats = (list: unknown): Record<string, unknown>[] =>
|
||||||
|
(Array.isArray(list) ? list : [])
|
||||||
|
.map((b) => obj(b))
|
||||||
|
.filter((b): b is Record<string, unknown> => !!b && typeof b.status === 'number')
|
||||||
|
.sort((a, b) => str(a.time).localeCompare(str(b.time)));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A group is down when ANY of its monitors is failing across two checks in a
|
||||||
|
* row: its latest beat is down and the one before is down or pending (Kuma
|
||||||
|
* marks a first failure "pending" when the monitor has a retry). One piece
|
||||||
|
* down, say the call token service, already breaks the feature; two checks so
|
||||||
|
* a single blip doesn't flash a banner. Up when every monitor we have beats
|
||||||
|
* for is fine; unknown when the group or its beats are missing.
|
||||||
|
*/
|
||||||
|
const groupState = (
|
||||||
|
groupName: string | undefined,
|
||||||
|
groups: Map<string, string[]>,
|
||||||
|
beats: Record<string, unknown>,
|
||||||
|
): ServiceState => {
|
||||||
|
if (!groupName) return 'unknown';
|
||||||
|
const ids = groups.get(groupName);
|
||||||
|
if (!ids || ids.length === 0) return 'unknown';
|
||||||
|
let known = 0;
|
||||||
|
let down = false;
|
||||||
|
ids.forEach((id) => {
|
||||||
|
const statuses = sortedBeats(beats[id]).map((b) => b.status as number);
|
||||||
|
if (statuses.length === 0) return;
|
||||||
|
known += 1;
|
||||||
|
const [prev, last] = statuses.slice(-2);
|
||||||
|
if (statuses.length >= 2 && last === DOWN && (prev === DOWN || prev === PENDING)) down = true;
|
||||||
|
});
|
||||||
|
if (down) return 'down';
|
||||||
|
return known > 0 ? 'up' : 'unknown';
|
||||||
|
};
|
||||||
|
|
||||||
|
export const parseKumaStatus = (
|
||||||
|
pageJson: unknown,
|
||||||
|
heartbeatJson: unknown,
|
||||||
|
groupNames: StatusGroups,
|
||||||
|
): ServerStatus => {
|
||||||
|
const page = obj(pageJson) ?? {};
|
||||||
|
const groups = new Map<string, string[]>();
|
||||||
|
(Array.isArray(page.publicGroupList) ? page.publicGroupList : []).forEach((g) => {
|
||||||
|
const group = obj(g);
|
||||||
|
if (!group) return;
|
||||||
|
const ids = (Array.isArray(group.monitorList) ? group.monitorList : [])
|
||||||
|
.map((m) => obj(m)?.id)
|
||||||
|
.filter((id): id is number | string => typeof id === 'number' || typeof id === 'string')
|
||||||
|
.map(String);
|
||||||
|
groups.set(str(group.name), ids);
|
||||||
|
});
|
||||||
|
const beats = obj(obj(heartbeatJson)?.heartbeatList) ?? {};
|
||||||
|
|
||||||
|
const maintenance: KumaMaintenance[] = (
|
||||||
|
Array.isArray(page.maintenanceList) ? page.maintenanceList : []
|
||||||
|
)
|
||||||
|
.map((m) => obj(m))
|
||||||
|
.filter((m): m is Record<string, unknown> => !!m && str(m.title) !== '')
|
||||||
|
.filter((m) => !m.status || m.status === 'under-maintenance')
|
||||||
|
.map((m) => {
|
||||||
|
const slot = obj((Array.isArray(m.timeslotList) ? m.timeslotList : [])[0]);
|
||||||
|
const end = Date.parse(str(slot?.endDate));
|
||||||
|
return {
|
||||||
|
id: String(m.id ?? str(m.title)),
|
||||||
|
title: str(m.title),
|
||||||
|
description: str(m.description),
|
||||||
|
...(Number.isFinite(end) ? { end } : {}),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
const incidents: KumaIncident[] = (Array.isArray(page.incidents) ? page.incidents : [])
|
||||||
|
.map((i) => obj(i))
|
||||||
|
.filter((i): i is Record<string, unknown> => !!i && str(i.title) !== '' && i.active !== false)
|
||||||
|
.map((i) => ({
|
||||||
|
id: String(i.id ?? str(i.title)),
|
||||||
|
title: str(i.title),
|
||||||
|
content: str(i.content),
|
||||||
|
style: str(i.style) || 'info',
|
||||||
|
updated: str(i.lastUpdatedDate) || str(i.createdDate),
|
||||||
|
}));
|
||||||
|
|
||||||
|
const hsIds = (groupNames.homeserver && groups.get(groupNames.homeserver)) || [];
|
||||||
|
const hsLatest = hsIds.map((id) => kumaBeatTime(sortedBeats(beats[id]).slice(-1)[0]?.time));
|
||||||
|
const homeserverCheckedAt =
|
||||||
|
hsLatest.length > 0 && hsLatest.every((t): t is number => t !== undefined)
|
||||||
|
? Math.min(...hsLatest)
|
||||||
|
: undefined;
|
||||||
|
|
||||||
|
return {
|
||||||
|
homeserver: groupState(groupNames.homeserver, groups, beats),
|
||||||
|
...(homeserverCheckedAt !== undefined ? { homeserverCheckedAt } : {}),
|
||||||
|
calls: groupState(groupNames.calls, groups, beats),
|
||||||
|
login: groupState(groupNames.login, groups, beats),
|
||||||
|
maintenance,
|
||||||
|
incidents,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Kuma checked the homeserver AFTER this client lost its connection, and it
|
||||||
|
* was fine: the problem is more likely on the user's side. A stale "up" from
|
||||||
|
* before the drop proves nothing (Kuma takes a minute or two to notice an
|
||||||
|
* outage), so it doesn't count.
|
||||||
|
*/
|
||||||
|
export const serverConfirmedUpSince = (
|
||||||
|
status: ServerStatus | null | undefined,
|
||||||
|
lostAt: number | null | undefined,
|
||||||
|
): boolean =>
|
||||||
|
!!status &&
|
||||||
|
!!lostAt &&
|
||||||
|
status.homeserver === 'up' &&
|
||||||
|
status.homeserverCheckedAt !== undefined &&
|
||||||
|
status.homeserverCheckedAt > lostAt;
|
||||||
|
|
||||||
|
export type BannerTone = 'Critical' | 'Warning' | 'Primary';
|
||||||
|
export type BannerKind =
|
||||||
|
| 'server-down'
|
||||||
|
| 'server-problems'
|
||||||
|
| 'maintenance'
|
||||||
|
| 'calls-down'
|
||||||
|
| 'announcement'
|
||||||
|
| 'login-down';
|
||||||
|
export type StatusBanner = {
|
||||||
|
kind: BannerKind;
|
||||||
|
/** Stable id for dismissing (announcements come back when edited). */
|
||||||
|
key: string;
|
||||||
|
tone: BannerTone;
|
||||||
|
text: string;
|
||||||
|
detail?: string;
|
||||||
|
dismissable: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
const formatTime = (ms: number): string =>
|
||||||
|
new Date(ms).toLocaleTimeString(undefined, { hour: 'numeric', minute: '2-digit' });
|
||||||
|
|
||||||
|
const incidentTone = (style: string): BannerTone => {
|
||||||
|
if (style === 'danger') return 'Critical';
|
||||||
|
if (style === 'warning') return 'Warning';
|
||||||
|
return 'Primary';
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Markdown-ish incident text as plain text for the Details line. */
|
||||||
|
const plain = (s: string): string =>
|
||||||
|
s
|
||||||
|
.replace(/!\[[^\]]*\]\([^)]*\)/g, '')
|
||||||
|
.replace(/\[([^\]]+)\]\([^)]*\)/g, '$1')
|
||||||
|
.replace(/[*_`#>]/g, '')
|
||||||
|
.replace(/\s+\n/g, '\n')
|
||||||
|
.trim();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The one strip to show, highest priority first. `syncLost`: this client's
|
||||||
|
* connection is reconnecting/erroring. `where`: the logged-in app or the
|
||||||
|
* login screen.
|
||||||
|
*/
|
||||||
|
export const pickBanner = (
|
||||||
|
status: ServerStatus | null | undefined,
|
||||||
|
opts: { syncLost: boolean; where: 'client' | 'login'; dismissed?: ReadonlySet<string> },
|
||||||
|
): StatusBanner | undefined => {
|
||||||
|
if (!status) return undefined;
|
||||||
|
const dismissed = opts.dismissed ?? new Set<string>();
|
||||||
|
const candidates: StatusBanner[] = [];
|
||||||
|
|
||||||
|
if (status.homeserver === 'down') {
|
||||||
|
if (opts.syncLost || opts.where === 'login') {
|
||||||
|
candidates.push({
|
||||||
|
kind: 'server-down',
|
||||||
|
key: 'server-down',
|
||||||
|
tone: 'Critical',
|
||||||
|
text:
|
||||||
|
opts.where === 'login'
|
||||||
|
? "Lotus Chat's server is down. We're on it."
|
||||||
|
: "Lotus Chat's server is down. We're on it, reconnecting…",
|
||||||
|
dismissable: false,
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
candidates.push({
|
||||||
|
kind: 'server-problems',
|
||||||
|
key: 'server-problems',
|
||||||
|
tone: 'Warning',
|
||||||
|
text: "Lotus Chat's server is having problems. Messages may be slow to send or arrive.",
|
||||||
|
dismissable: false,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const maint = status.maintenance[0];
|
||||||
|
if (maint) {
|
||||||
|
const until = maint.end ? ` until ${formatTime(maint.end)}` : '';
|
||||||
|
candidates.push({
|
||||||
|
kind: 'maintenance',
|
||||||
|
key: `maintenance:${maint.id}`,
|
||||||
|
tone: 'Warning',
|
||||||
|
text: `Maintenance in progress${until}: ${maint.title}. Messages and calls may be interrupted.`,
|
||||||
|
detail: plain(maint.description) || undefined,
|
||||||
|
dismissable: false,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.where === 'login' && status.login === 'down') {
|
||||||
|
candidates.push({
|
||||||
|
kind: 'login-down',
|
||||||
|
key: 'login-down',
|
||||||
|
tone: 'Warning',
|
||||||
|
text: "Sign-in is having problems right now. If it doesn't work, try again in a few minutes.",
|
||||||
|
dismissable: false,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.where === 'client' && status.calls === 'down' && status.homeserver !== 'down') {
|
||||||
|
candidates.push({
|
||||||
|
kind: 'calls-down',
|
||||||
|
key: 'calls-down',
|
||||||
|
tone: 'Warning',
|
||||||
|
text: 'Voice calls are down right now. Messages still work.',
|
||||||
|
dismissable: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
status.incidents.forEach((i) => {
|
||||||
|
candidates.push({
|
||||||
|
kind: 'announcement',
|
||||||
|
key: `announcement:${i.id}:${i.updated}`,
|
||||||
|
tone: incidentTone(i.style),
|
||||||
|
text: i.title,
|
||||||
|
detail: plain(i.content) || undefined,
|
||||||
|
dismissable: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
return candidates.find((b) => !(b.dismissable && dismissed.has(b.key)));
|
||||||
|
};
|
||||||
@@ -17,10 +17,16 @@ import App from './app/pages/App';
|
|||||||
import './app/i18n';
|
import './app/i18n';
|
||||||
import { pushSessionToSW } from './sw-session';
|
import { pushSessionToSW } from './sw-session';
|
||||||
import { getFallbackSession } from './app/state/sessions';
|
import { getFallbackSession } from './app/state/sessions';
|
||||||
|
import { startKeychainMirror } from './app/state/keychainMirror';
|
||||||
|
import { tauriInvoke } from './app/hooks/useTauri';
|
||||||
import { cleanupSearchCacheIfSignedOut } from './client/initMatrix';
|
import { cleanupSearchCacheIfSignedOut } from './client/initMatrix';
|
||||||
|
|
||||||
document.body.classList.add(configClass, varsClass);
|
document.body.classList.add(configClass, varsClass);
|
||||||
|
|
||||||
|
// [Gitea #105] Desktop: keep a copy of the login tokens in the OS keychain
|
||||||
|
// (step 1: mirror only; the session is still read from localStorage).
|
||||||
|
startKeychainMirror(tauriInvoke());
|
||||||
|
|
||||||
// Register Service Worker
|
// Register Service Worker
|
||||||
// Service workers only register on http(s) pages. The desktop app loads from
|
// Service workers only register on http(s) pages. The desktop app loads from
|
||||||
// `tauri://localhost` in debug builds (and on any platform where the localhost
|
// `tauri://localhost` in debug builds (and on any platform where the localhost
|
||||||
|
|||||||
Reference in New Issue
Block a user