Compare commits
13
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
747400ea25 | ||
|
|
6ae0087213 | ||
|
|
d6548c56fd | ||
|
|
23f059d9a4 | ||
|
|
9b9f33b270 | ||
|
|
7d7a379ce0 | ||
|
|
91f82d60e3 | ||
|
|
f0865115a4 | ||
|
|
899e160aed | ||
|
|
3e5fdd0dab | ||
|
|
bb569d69a2 | ||
|
|
02d86caeb0 | ||
|
|
c0c93213c1 |
+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"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -257,12 +257,21 @@ test.describe('local homeserver regression', () => {
|
|||||||
await page.clock.install({ time: Date.now() + 14 * 60 * 1000 });
|
await page.clock.install({ time: Date.now() + 14 * 60 * 1000 });
|
||||||
await loginUI(page, alice);
|
await loginUI(page, alice);
|
||||||
await openRoom(page, room);
|
await openRoom(page, room);
|
||||||
for (let i = 0; i < 4; i += 1) {
|
const ticks = async (from: number, n: number) => {
|
||||||
|
for (let i = from; i < from + n; i += 1) {
|
||||||
// eslint-disable-next-line no-await-in-loop
|
// eslint-disable-next-line no-await-in-loop
|
||||||
await sendText(bob, room, `tick ${i}`);
|
await sendText(bob, room, `tick ${i}`);
|
||||||
// eslint-disable-next-line no-await-in-loop
|
// eslint-disable-next-line no-await-in-loop
|
||||||
await page.waitForTimeout(500);
|
await page.waitForTimeout(500);
|
||||||
}
|
}
|
||||||
|
};
|
||||||
|
await ticks(0, 4);
|
||||||
|
// "Ahead" could be a late delivery (a stalled server), so it is only
|
||||||
|
// reported once it has held for a minute of fresh samples.
|
||||||
|
await page.waitForTimeout(2000);
|
||||||
|
await expect(page.getByText(/clock is .*ahead of the server/)).toHaveCount(0);
|
||||||
|
await page.clock.fastForward('01:05');
|
||||||
|
await ticks(4, 2);
|
||||||
await expect(page.getByText(/clock is .*14 minutes ahead of the server/)).toBeVisible();
|
await expect(page.getByText(/clock is .*14 minutes ahead of the server/)).toBeVisible();
|
||||||
await page.getByRole('button', { name: 'Dismiss for 24 h' }).click();
|
await page.getByRole('button', { name: 'Dismiss for 24 h' }).click();
|
||||||
await expect(page.getByText(/clock is .*ahead of the server/)).toHaveCount(0);
|
await expect(page.getByText(/clock is .*ahead of the server/)).toHaveCount(0);
|
||||||
|
|||||||
@@ -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);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -72,9 +72,9 @@ export function CallStatus({ callEmbed }: CallStatusProps) {
|
|||||||
size="T200"
|
size="T200"
|
||||||
truncate
|
truncate
|
||||||
style={{ color: color.Warning.Main }}
|
style={{ color: color.Warning.Main }}
|
||||||
title="Fix your computer's clock — calls and encryption depend on it"
|
title="This device's clock is off. Calls and encryption depend on it: turn on automatic time in your system settings."
|
||||||
>
|
>
|
||||||
Clock {describeSkewVsServer(clockSkew.skewMs)} — calls will fail
|
Device clock {describeSkewVsServer(clockSkew.skewMs)}: calls may fail
|
||||||
</Text>
|
</Text>
|
||||||
</>
|
</>
|
||||||
)}
|
)}
|
||||||
|
|||||||
@@ -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,268 @@
|
|||||||
|
import { useSetAtom } from 'jotai';
|
||||||
|
import { useEffect } from 'react';
|
||||||
|
import {
|
||||||
|
ClientEvent,
|
||||||
|
ClientEventHandlerMap,
|
||||||
|
ConnectionError,
|
||||||
|
EventStatus,
|
||||||
|
KnownMembership,
|
||||||
|
MatrixClient,
|
||||||
|
MatrixError,
|
||||||
|
MatrixEvent,
|
||||||
|
Room,
|
||||||
|
RoomEvent,
|
||||||
|
RoomEventHandlerMap,
|
||||||
|
SyncState,
|
||||||
|
} from 'matrix-js-sdk';
|
||||||
|
import { useMatrixClient } from '../../hooks/useMatrixClient';
|
||||||
|
import { sendOfflineAtom } from '../../state/sendOffline';
|
||||||
|
import {
|
||||||
|
OUTBOX_MAX_AUTO_RETRIES,
|
||||||
|
OutboxEntry,
|
||||||
|
isRetryableSendError,
|
||||||
|
loadOutbox,
|
||||||
|
outboxRetryDelayMs,
|
||||||
|
planRestore,
|
||||||
|
saveOutbox,
|
||||||
|
shouldKeepInOutbox,
|
||||||
|
withEntry,
|
||||||
|
withoutEntry,
|
||||||
|
} from '../../utils/outbox';
|
||||||
|
|
||||||
|
const PENDING: ReadonlySet<EventStatus | null> = new Set([
|
||||||
|
EventStatus.SENDING,
|
||||||
|
EventStatus.ENCRYPTING,
|
||||||
|
EventStatus.QUEUED,
|
||||||
|
EventStatus.NOT_SENT,
|
||||||
|
]);
|
||||||
|
const ONLINE: ReadonlySet<SyncState | null> = new Set([
|
||||||
|
SyncState.Prepared,
|
||||||
|
SyncState.Syncing,
|
||||||
|
SyncState.Catchup,
|
||||||
|
]);
|
||||||
|
const OFFLINE: ReadonlySet<SyncState | null> = new Set([SyncState.Reconnecting, SyncState.Error]);
|
||||||
|
|
||||||
|
/** The server already has it: its transaction id came back down /sync. */
|
||||||
|
const isDelivered = (room: Room, txnId: string): boolean => {
|
||||||
|
const hasTxn = (events: MatrixEvent[]) =>
|
||||||
|
events.some((e) => e.getUnsigned().transaction_id === txnId);
|
||||||
|
return (
|
||||||
|
hasTxn(room.getLiveTimeline().getEvents()) ||
|
||||||
|
room.getThreads().some((t) => hasTxn(t.liveTimeline.getEvents()))
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
type OutboxSession = {
|
||||||
|
/** Own pending events of this session, by txnId. */
|
||||||
|
live: Map<string, { event: MatrixEvent; room: Room }>;
|
||||||
|
autoRetries: Map<string, number>;
|
||||||
|
restored: boolean;
|
||||||
|
retrying: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Per client, not per mount: a remount must neither restore twice nor forget
|
||||||
|
// the events it is tracking.
|
||||||
|
const sessions = new WeakMap<MatrixClient, OutboxSession>();
|
||||||
|
const getSession = (mx: MatrixClient): OutboxSession => {
|
||||||
|
let session = sessions.get(mx);
|
||||||
|
if (!session) {
|
||||||
|
session = { live: new Map(), autoRetries: new Map(), restored: false, retrying: false };
|
||||||
|
sessions.set(mx, session);
|
||||||
|
}
|
||||||
|
return session;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #112] Offline outbox (see utils/outbox.ts): mirrors own message sends
|
||||||
|
* into localStorage until the server confirms them, puts unsent ones back
|
||||||
|
* after a reload, and re-sends network failures when the connection returns.
|
||||||
|
*/
|
||||||
|
export function OutboxFeature() {
|
||||||
|
const mx = useMatrixClient();
|
||||||
|
const setOffline = useSetAtom(sendOfflineAtom);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const userId = mx.getSafeUserId();
|
||||||
|
let entries = loadOutbox(userId);
|
||||||
|
const session = getSession(mx);
|
||||||
|
const { live, autoRetries } = session;
|
||||||
|
let disposed = false;
|
||||||
|
let offlineNow = false;
|
||||||
|
const timers = new Set<ReturnType<typeof setTimeout>>();
|
||||||
|
|
||||||
|
const isOffline = () =>
|
||||||
|
OFFLINE.has(mx.getSyncState()) ||
|
||||||
|
(typeof navigator !== 'undefined' && navigator.onLine === false);
|
||||||
|
|
||||||
|
const persist = (next: OutboxEntry[]) => {
|
||||||
|
if (next === entries) return;
|
||||||
|
entries = next;
|
||||||
|
saveOutbox(userId, entries);
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A network failure while we think we're online (a blip neither sync nor
|
||||||
|
* the browser noticed): try again shortly, backing off. Real outages are
|
||||||
|
* handled by the reconnect / back-online triggers below.
|
||||||
|
*/
|
||||||
|
const scheduleBlipRetry = (event: MatrixEvent) => {
|
||||||
|
const attempts = autoRetries.get(event.getTxnId() ?? '') ?? 0;
|
||||||
|
if (!isRetryableSendError(event.error) || attempts >= OUTBOX_MAX_AUTO_RETRIES || isOffline())
|
||||||
|
return;
|
||||||
|
const timer = setTimeout(() => {
|
||||||
|
timers.delete(timer);
|
||||||
|
retryQueued();
|
||||||
|
}, outboxRetryDelayMs(attempts));
|
||||||
|
timers.add(timer);
|
||||||
|
};
|
||||||
|
|
||||||
|
const onLocalEcho: RoomEventHandlerMap[RoomEvent.LocalEchoUpdated] = (event, room) => {
|
||||||
|
const txnId = event.getTxnId();
|
||||||
|
if (!txnId || event.getSender() !== userId) return;
|
||||||
|
if (PENDING.has(event.status)) {
|
||||||
|
if (!shouldKeepInOutbox(event.getType(), event.getContent())) return;
|
||||||
|
live.set(txnId, { event, room });
|
||||||
|
if (event.status === EventStatus.NOT_SENT) scheduleBlipRetry(event);
|
||||||
|
persist(
|
||||||
|
withEntry(entries, {
|
||||||
|
txnId,
|
||||||
|
roomId: room.roomId,
|
||||||
|
threadId: event.threadRootId ?? null,
|
||||||
|
type: event.getType(),
|
||||||
|
content: event.getContent(),
|
||||||
|
ts: event.getTs(),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// SENT, CANCELLED, or the remote echo replaced it (status null).
|
||||||
|
live.delete(txnId);
|
||||||
|
autoRetries.delete(txnId);
|
||||||
|
persist(withoutEntry(entries, txnId));
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Re-send network failures, oldest first; a room stops at its first failure. */
|
||||||
|
const retryQueued = async () => {
|
||||||
|
if (session.retrying || disposed) return;
|
||||||
|
session.retrying = true;
|
||||||
|
try {
|
||||||
|
const byRoom = new Map<Room, MatrixEvent[]>();
|
||||||
|
Array.from(live.values())
|
||||||
|
.filter(
|
||||||
|
({ event }) =>
|
||||||
|
event.status === EventStatus.NOT_SENT &&
|
||||||
|
isRetryableSendError(event.error) &&
|
||||||
|
(autoRetries.get(event.getTxnId() ?? '') ?? 0) < OUTBOX_MAX_AUTO_RETRIES,
|
||||||
|
)
|
||||||
|
.sort((a, b) => a.event.getTs() - b.event.getTs())
|
||||||
|
.forEach(({ event, room }) => {
|
||||||
|
byRoom.set(room, [...(byRoom.get(room) ?? []), event]);
|
||||||
|
});
|
||||||
|
await Promise.all(
|
||||||
|
Array.from(byRoom.entries()).map(async ([room, events]) => {
|
||||||
|
for (const event of events) {
|
||||||
|
if (disposed || event.status !== EventStatus.NOT_SENT) continue;
|
||||||
|
const txnId = event.getTxnId() ?? '';
|
||||||
|
autoRetries.set(txnId, (autoRetries.get(txnId) ?? 0) + 1);
|
||||||
|
try {
|
||||||
|
// eslint-disable-next-line no-await-in-loop
|
||||||
|
await mx.resendEvent(event, room);
|
||||||
|
} catch (e) {
|
||||||
|
// Still offline: keep the rest of this room in order for the next try.
|
||||||
|
if (isRetryableSendError(e)) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
session.retrying = false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const restore = () => {
|
||||||
|
if (session.restored) return;
|
||||||
|
session.restored = true;
|
||||||
|
const plan = planRestore(
|
||||||
|
entries,
|
||||||
|
Date.now(),
|
||||||
|
(roomId) => mx.getRoom(roomId)?.getMyMembership() === KnownMembership.Join,
|
||||||
|
(entry) => {
|
||||||
|
const room = mx.getRoom(entry.roomId);
|
||||||
|
return !!room && isDelivered(room, entry.txnId);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
plan.drop.forEach((entry) => persist(withoutEntry(entries, entry.txnId)));
|
||||||
|
plan.restore.forEach((entry) => {
|
||||||
|
const room = mx.getRoom(entry.roomId);
|
||||||
|
if (!room || live.has(entry.txnId)) return;
|
||||||
|
// Same shape as the SDK's own local echo (client.sendCompleteEvent).
|
||||||
|
const event = new MatrixEvent({
|
||||||
|
type: entry.type,
|
||||||
|
content: entry.content,
|
||||||
|
event_id: `~${entry.roomId}:${entry.txnId}`,
|
||||||
|
sender: userId,
|
||||||
|
room_id: entry.roomId,
|
||||||
|
origin_server_ts: entry.ts,
|
||||||
|
});
|
||||||
|
const thread = entry.threadId ? room.getThread(entry.threadId) : undefined;
|
||||||
|
if (thread) event.setThread(thread);
|
||||||
|
event.setTxnId(entry.txnId);
|
||||||
|
event.setStatus(EventStatus.NOT_SENT);
|
||||||
|
if (plan.autoSend.has(entry.txnId)) {
|
||||||
|
// Recent: treat like a send that lost the network (shown as Queued
|
||||||
|
// while offline, re-sent below and on reconnect).
|
||||||
|
// (The SDK types `error` as MatrixError but stores any send error there.)
|
||||||
|
event.error = new ConnectionError(
|
||||||
|
'not sent before the app was closed',
|
||||||
|
) as unknown as MatrixError;
|
||||||
|
} else {
|
||||||
|
// Old: back as "Failed to send"; the user decides (Retry / Cancel).
|
||||||
|
autoRetries.set(entry.txnId, OUTBOX_MAX_AUTO_RETRIES);
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
room.addPendingEvent(event, entry.txnId); // emits LocalEchoUpdated → `live`
|
||||||
|
} catch {
|
||||||
|
// Already pending under this txnId: nothing to restore.
|
||||||
|
}
|
||||||
|
});
|
||||||
|
if (!isOffline()) retryQueued();
|
||||||
|
};
|
||||||
|
|
||||||
|
const updateOffline = () => {
|
||||||
|
const offline = isOffline();
|
||||||
|
// Back online (sync recovered or the browser says so): send what's queued.
|
||||||
|
if (offlineNow && !offline && session.restored) retryQueued();
|
||||||
|
offlineNow = offline;
|
||||||
|
setOffline(offline);
|
||||||
|
};
|
||||||
|
|
||||||
|
const onSync: ClientEventHandlerMap[ClientEvent.Sync] = (state, prevState) => {
|
||||||
|
updateOffline();
|
||||||
|
if (!ONLINE.has(state)) return;
|
||||||
|
if (!session.restored) {
|
||||||
|
restore();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (OFFLINE.has(prevState) || prevState === SyncState.Catchup) retryQueued();
|
||||||
|
};
|
||||||
|
const onBrowserOnline = () => updateOffline();
|
||||||
|
|
||||||
|
mx.on(RoomEvent.LocalEchoUpdated, onLocalEcho);
|
||||||
|
mx.on(ClientEvent.Sync, onSync);
|
||||||
|
window.addEventListener('online', onBrowserOnline);
|
||||||
|
window.addEventListener('offline', onBrowserOnline);
|
||||||
|
updateOffline();
|
||||||
|
if (ONLINE.has(mx.getSyncState())) restore();
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
disposed = true;
|
||||||
|
timers.forEach((t) => clearTimeout(t));
|
||||||
|
mx.off(RoomEvent.LocalEchoUpdated, onLocalEcho);
|
||||||
|
mx.off(ClientEvent.Sync, onSync);
|
||||||
|
window.removeEventListener('online', onBrowserOnline);
|
||||||
|
window.removeEventListener('offline', onBrowserOnline);
|
||||||
|
};
|
||||||
|
}, [mx, setOffline]);
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
@@ -26,6 +26,7 @@ import {
|
|||||||
config,
|
config,
|
||||||
} from 'folds';
|
} from 'folds';
|
||||||
import React, {
|
import React, {
|
||||||
|
CSSProperties,
|
||||||
FormEventHandler,
|
FormEventHandler,
|
||||||
MouseEventHandler,
|
MouseEventHandler,
|
||||||
ReactNode,
|
ReactNode,
|
||||||
@@ -38,7 +39,7 @@ import { useHover, useFocusWithin } from 'react-aria';
|
|||||||
import { MatrixEvent, Room, EventStatus } from 'matrix-js-sdk';
|
import { MatrixEvent, Room, EventStatus } from 'matrix-js-sdk';
|
||||||
import { Relations } from 'matrix-js-sdk/lib/models/relations';
|
import { Relations } from 'matrix-js-sdk/lib/models/relations';
|
||||||
import classNames from 'classnames';
|
import classNames from 'classnames';
|
||||||
import { useAtom } from 'jotai';
|
import { useAtom, useAtomValue } from 'jotai';
|
||||||
import { RoomPinnedEventsEventContent } from 'matrix-js-sdk/lib/types';
|
import { RoomPinnedEventsEventContent } from 'matrix-js-sdk/lib/types';
|
||||||
import {
|
import {
|
||||||
AvatarBase,
|
AvatarBase,
|
||||||
@@ -98,27 +99,39 @@ import { useBookmarks } from '../../../hooks/useBookmarks';
|
|||||||
import { PresenceRingAvatar } from '../../../components/presence';
|
import { PresenceRingAvatar } from '../../../components/presence';
|
||||||
import { useLotusShareBase } from '../../../hooks/useLotusLinkBase';
|
import { useLotusShareBase } from '../../../hooks/useLotusLinkBase';
|
||||||
import { AvatarDecoration } from '../../../components/avatar-decoration/AvatarDecoration';
|
import { AvatarDecoration } from '../../../components/avatar-decoration/AvatarDecoration';
|
||||||
|
import { sendOfflineAtom } from '../../../state/sendOffline';
|
||||||
|
import { isRetryableSendError } from '../../../utils/outbox';
|
||||||
|
|
||||||
// Delivery status indicator for own messages
|
// Delivery status indicator for own messages
|
||||||
function DeliveryStatus({
|
function DeliveryStatus({
|
||||||
status,
|
mEvent,
|
||||||
|
room,
|
||||||
lotusTerminal,
|
lotusTerminal,
|
||||||
}: {
|
}: {
|
||||||
status: string | null;
|
mEvent: MatrixEvent;
|
||||||
|
room: Room;
|
||||||
lotusTerminal: boolean;
|
lotusTerminal: boolean;
|
||||||
}) {
|
}) {
|
||||||
|
const mx = useMatrixClient();
|
||||||
|
const offline = useAtomValue(sendOfflineAtom);
|
||||||
|
const { status } = mEvent;
|
||||||
if (status === null) return null; // confirmed by server — read receipts take over
|
if (status === null) return null; // confirmed by server — read receipts take over
|
||||||
let iconSrc: IconSrc;
|
let iconSrc: IconSrc;
|
||||||
let label: string;
|
let label: string;
|
||||||
let colorStyle: string;
|
let colorStyle: string;
|
||||||
const isSending = status === EventStatus.SENDING || status === EventStatus.ENCRYPTING;
|
const isSending = status === EventStatus.SENDING || status === EventStatus.ENCRYPTING;
|
||||||
if (status === EventStatus.NOT_SENT || status === EventStatus.CANCELLED) {
|
// [Gitea #112] A network failure while offline is queued, not failed: the
|
||||||
|
// outbox sends it again when the connection is back.
|
||||||
|
const queued = status === EventStatus.NOT_SENT && offline && isRetryableSendError(mEvent.error);
|
||||||
|
const failed = !queued && (status === EventStatus.NOT_SENT || status === EventStatus.CANCELLED);
|
||||||
|
if (failed) {
|
||||||
iconSrc = Icons.Cross;
|
iconSrc = Icons.Cross;
|
||||||
label = 'Failed to send';
|
label = status === EventStatus.NOT_SENT ? 'Failed to send. Click to retry' : 'Failed to send';
|
||||||
colorStyle = lotusTerminal ? 'var(--lt-accent-red)' : color.Critical.Main;
|
colorStyle = lotusTerminal ? 'var(--lt-accent-red)' : color.Critical.Main;
|
||||||
} else if (status === EventStatus.QUEUED || isSending) {
|
} else if (queued || status === EventStatus.QUEUED || isSending) {
|
||||||
iconSrc = Icons.Send;
|
iconSrc = queued ? Icons.RecentClock : Icons.Send;
|
||||||
label = isSending ? 'Sending...' : 'Queued';
|
if (queued) label = "Queued. Will send when you're back online";
|
||||||
|
else label = isSending ? 'Sending...' : 'Queued';
|
||||||
colorStyle = lotusTerminal
|
colorStyle = lotusTerminal
|
||||||
? 'color-mix(in srgb, var(--lt-accent-cyan) 60%, transparent)'
|
? 'color-mix(in srgb, var(--lt-accent-cyan) 60%, transparent)'
|
||||||
: color.Secondary.Main;
|
: color.Secondary.Main;
|
||||||
@@ -129,12 +142,12 @@ function DeliveryStatus({
|
|||||||
? 'color-mix(in srgb, var(--lt-accent-cyan) 70%, transparent)'
|
? 'color-mix(in srgb, var(--lt-accent-cyan) 70%, transparent)'
|
||||||
: color.Secondary.Main;
|
: color.Secondary.Main;
|
||||||
}
|
}
|
||||||
return (
|
const retryable = failed && status === EventStatus.NOT_SENT;
|
||||||
<Box
|
const handleRetry: MouseEventHandler<HTMLButtonElement> = (evt) => {
|
||||||
as="span"
|
evt.stopPropagation();
|
||||||
aria-label={label}
|
if (mEvent.status === EventStatus.NOT_SENT) mx.resendEvent(mEvent, room).catch(() => undefined);
|
||||||
title={label}
|
};
|
||||||
style={{
|
const style: CSSProperties = {
|
||||||
display: 'inline-flex',
|
display: 'inline-flex',
|
||||||
alignItems: 'center',
|
alignItems: 'center',
|
||||||
marginTop: '2px',
|
marginTop: '2px',
|
||||||
@@ -142,14 +155,36 @@ function DeliveryStatus({
|
|||||||
color: colorStyle,
|
color: colorStyle,
|
||||||
opacity: 0.85,
|
opacity: 0.85,
|
||||||
userSelect: 'none',
|
userSelect: 'none',
|
||||||
...(lotusTerminal && status === EventStatus.NOT_SENT
|
...(lotusTerminal && failed ? { textShadow: 'var(--lt-glow-red)' } : {}),
|
||||||
? { textShadow: 'var(--lt-glow-red)' }
|
};
|
||||||
: {}),
|
const icon = (
|
||||||
}}
|
|
||||||
>
|
|
||||||
<span className={isSending ? SendingSpinClass : undefined}>
|
<span className={isSending ? SendingSpinClass : undefined}>
|
||||||
<Icon size="100" src={iconSrc} />
|
<Icon size="100" src={iconSrc} />
|
||||||
</span>
|
</span>
|
||||||
|
);
|
||||||
|
if (retryable) {
|
||||||
|
return (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={handleRetry}
|
||||||
|
aria-label={label}
|
||||||
|
title={label}
|
||||||
|
style={{
|
||||||
|
...style,
|
||||||
|
background: 'none',
|
||||||
|
border: 'none',
|
||||||
|
padding: 0,
|
||||||
|
cursor: 'pointer',
|
||||||
|
font: 'inherit',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{icon}
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return (
|
||||||
|
<Box as="span" aria-label={label} title={label} style={style}>
|
||||||
|
{icon}
|
||||||
</Box>
|
</Box>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -1102,7 +1137,7 @@ export const Message = React.memo(
|
|||||||
/>
|
/>
|
||||||
)}
|
)}
|
||||||
{isMine && !mEvent.isState() && readReceiptUsers.length === 0 && (
|
{isMine && !mEvent.isState() && readReceiptUsers.length === 0 && (
|
||||||
<DeliveryStatus status={mEvent.status} lotusTerminal={!!lotusTerminal} />
|
<DeliveryStatus mEvent={mEvent} room={room} lotusTerminal={!!lotusTerminal} />
|
||||||
)}
|
)}
|
||||||
</Box>
|
</Box>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -33,6 +33,8 @@ import { Badge, Box, Chip, Icon, Icons, Line, Scroll, Spinner, Text, color, conf
|
|||||||
import classNames from 'classnames';
|
import classNames from 'classnames';
|
||||||
import { Opts as LinkifyOpts } from 'linkifyjs';
|
import { Opts as LinkifyOpts } from 'linkifyjs';
|
||||||
import { isKeyHotkey } from 'is-hotkey';
|
import { isKeyHotkey } from 'is-hotkey';
|
||||||
|
import { isRetryableSendError } from '../../../utils/outbox';
|
||||||
|
import { sendOfflineAtom } from '../../../state/sendOffline';
|
||||||
import { eventWithShortcode, factoryEventSentBy } from '../../../utils/matrix';
|
import { eventWithShortcode, factoryEventSentBy } from '../../../utils/matrix';
|
||||||
import { useMatrixClient } from '../../../hooks/useMatrixClient';
|
import { useMatrixClient } from '../../../hooks/useMatrixClient';
|
||||||
import { useVirtualPaginator, ItemRange } from '../../../hooks/useVirtualPaginator';
|
import { useVirtualPaginator, ItemRange } from '../../../hooks/useVirtualPaginator';
|
||||||
@@ -253,6 +255,7 @@ export type ThreadTimelineProps = {
|
|||||||
|
|
||||||
export function ThreadTimeline({ room, thread, editor }: ThreadTimelineProps) {
|
export function ThreadTimeline({ room, thread, editor }: ThreadTimelineProps) {
|
||||||
const mx = useMatrixClient();
|
const mx = useMatrixClient();
|
||||||
|
const sendOffline = useAtomValue(sendOfflineAtom);
|
||||||
const alive = useAlive();
|
const alive = useAlive();
|
||||||
const useAuthentication = useMediaAuthentication();
|
const useAuthentication = useMediaAuthentication();
|
||||||
|
|
||||||
@@ -992,8 +995,12 @@ export function ThreadTimeline({ room, thread, editor }: ThreadTimelineProps) {
|
|||||||
const showEmptyReplies = ready && thread.length === 0;
|
const showEmptyReplies = ready && thread.length === 0;
|
||||||
|
|
||||||
const renderPendingEvent = (mEvent: MatrixEvent) => {
|
const renderPendingEvent = (mEvent: MatrixEvent) => {
|
||||||
|
// [Gitea #112] Network failures while offline are queued, not failed.
|
||||||
|
const queued =
|
||||||
|
mEvent.status === EventStatus.NOT_SENT && sendOffline && isRetryableSendError(mEvent.error);
|
||||||
const failed =
|
const failed =
|
||||||
mEvent.status === EventStatus.NOT_SENT || mEvent.status === EventStatus.CANCELLED;
|
!queued &&
|
||||||
|
(mEvent.status === EventStatus.NOT_SENT || mEvent.status === EventStatus.CANCELLED);
|
||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
key={mEvent.getId() ?? mEvent.getTxnId()}
|
key={mEvent.getId() ?? mEvent.getTxnId()}
|
||||||
@@ -1007,6 +1014,13 @@ export function ThreadTimeline({ room, thread, editor }: ThreadTimelineProps) {
|
|||||||
</Text>
|
</Text>
|
||||||
</Box>
|
</Box>
|
||||||
)}
|
)}
|
||||||
|
{queued && (
|
||||||
|
<Box style={{ padding: `0 ${config.space.S400}` }}>
|
||||||
|
<Text size="T200" priority="300">
|
||||||
|
Queued. Will send when you're back online
|
||||||
|
</Text>
|
||||||
|
</Box>
|
||||||
|
)}
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -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>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ import { allInvitesAtom } from '../../state/room-list/inviteList';
|
|||||||
import { useMatrixClient } from '../../hooks/useMatrixClient';
|
import { useMatrixClient } from '../../hooks/useMatrixClient';
|
||||||
import { useClientConfig } from '../../hooks/useClientConfig';
|
import { useClientConfig } from '../../hooks/useClientConfig';
|
||||||
import { useHydrateMsgDrafts } from '../../hooks/useHydrateMsgDrafts';
|
import { useHydrateMsgDrafts } from '../../hooks/useHydrateMsgDrafts';
|
||||||
|
import { OutboxFeature } from '../../features/outbox/OutboxFeature';
|
||||||
import { useSearchCacheInvalidation } from '../../utils/searchCacheInvalidation';
|
import { useSearchCacheInvalidation } from '../../utils/searchCacheInvalidation';
|
||||||
import { ClockSkewMonitor } from '../../utils/clockSkew';
|
import { ClockSkewMonitor } from '../../utils/clockSkew';
|
||||||
import { clockSkewAtom } from '../../state/clockSkew';
|
import { clockSkewAtom } from '../../state/clockSkew';
|
||||||
@@ -1071,6 +1072,10 @@ function ClockSkewFeature() {
|
|||||||
data,
|
data,
|
||||||
) => {
|
) => {
|
||||||
if (!data.liveEvent) return;
|
if (!data.liveEvent) return;
|
||||||
|
// Only events our homeserver stamped: a federated event's
|
||||||
|
// origin_server_ts is the other server's clock.
|
||||||
|
const senderServer = mEvent.getSender()?.split(':').slice(1).join(':');
|
||||||
|
if (senderServer !== mx.getDomain()) return;
|
||||||
monitor.sample(mEvent.getTs(), mEvent.getAge(), mEvent.localTimestamp);
|
monitor.sample(mEvent.getTs(), mEvent.getAge(), mEvent.localTimestamp);
|
||||||
};
|
};
|
||||||
mx.on(RoomEvent.Timeline, onTimeline);
|
mx.on(RoomEvent.Timeline, onTimeline);
|
||||||
@@ -1107,6 +1112,7 @@ export function ClientNonUIFeatures({ children }: ClientNonUIFeaturesProps) {
|
|||||||
<TauriDesktopFeatures />
|
<TauriDesktopFeatures />
|
||||||
<CloseBehaviorPrompt />
|
<CloseBehaviorPrompt />
|
||||||
<ConsentRequiredPrompt />
|
<ConsentRequiredPrompt />
|
||||||
|
<OutboxFeature />
|
||||||
<LotusDenoiseFeature />
|
<LotusDenoiseFeature />
|
||||||
<DeepLinkNavigator />
|
<DeepLinkNavigator />
|
||||||
<KeyboardShortcutsFeature />
|
<KeyboardShortcutsFeature />
|
||||||
|
|||||||
@@ -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} />}
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ const readDismissedUntil = (): number => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [Gitea #158] "Your computer's clock is 14 minutes ahead of the server."
|
* [Gitea #158] "This device's clock is 14 minutes ahead of the server."
|
||||||
* Same slot and style as the sync banners. Shown while the skew monitor is
|
* Same slot and style as the sync banners. Shown while the skew monitor is
|
||||||
* over its threshold; the direction matters, so it is said. Dismissable for
|
* over its threshold; the direction matters, so it is said. Dismissable for
|
||||||
* 24 h; never auto-corrects anything.
|
* 24 h; never auto-corrects anything.
|
||||||
@@ -53,8 +53,8 @@ export function ClockSkewBanner() {
|
|||||||
>
|
>
|
||||||
<Box alignItems="Center" gap="300" wrap="Wrap" justifyContent="Center">
|
<Box alignItems="Center" gap="300" wrap="Wrap" justifyContent="Center">
|
||||||
<Text size="L400" align="Center">
|
<Text size="L400" align="Center">
|
||||||
Your computer's clock is <b>{describeSkewVsServer(skewMs)}</b>. Encrypted messages
|
This device's clock is <b>{describeSkewVsServer(skewMs)}</b>. Voice calls and
|
||||||
and voice calls will fail until it is fixed.
|
encrypted messages can fail until it's corrected.
|
||||||
</Text>
|
</Text>
|
||||||
<Button
|
<Button
|
||||||
size="300"
|
size="300"
|
||||||
|
|||||||
@@ -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;
|
||||||
|
};
|
||||||
@@ -36,6 +36,7 @@ test('clearPlaintextCaches removes every plaintext/PII localStorage key', () =>
|
|||||||
store.set('cinny_recent_forward_targets_v1', '[]');
|
store.set('cinny_recent_forward_targets_v1', '[]');
|
||||||
store.set('cinny_recent_gifs_v1', '[]');
|
store.set('cinny_recent_gifs_v1', '[]');
|
||||||
store.set('cinny_recent_stickers_v1', '[]');
|
store.set('cinny_recent_stickers_v1', '[]');
|
||||||
|
store.set('lotus_outbox_v1', '{"userId":"@me:server","entries":[]}');
|
||||||
removed.length = 0;
|
removed.length = 0;
|
||||||
|
|
||||||
clearPlaintextCaches();
|
clearPlaintextCaches();
|
||||||
@@ -47,6 +48,7 @@ test('clearPlaintextCaches removes every plaintext/PII localStorage key', () =>
|
|||||||
'cinny_recent_forward_targets_v1',
|
'cinny_recent_forward_targets_v1',
|
||||||
'cinny_recent_gifs_v1',
|
'cinny_recent_gifs_v1',
|
||||||
'cinny_recent_stickers_v1',
|
'cinny_recent_stickers_v1',
|
||||||
|
'lotus_outbox_v1', // [Gitea #112] unsent message content
|
||||||
]) {
|
]) {
|
||||||
assert.ok(removed.includes(key), `${key} cleared`);
|
assert.ok(removed.includes(key), `${key} cleared`);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ import { clearRecentStickers } from './recentStickers';
|
|||||||
import { clearNavToActivePathStore } from './navToActivePath';
|
import { clearNavToActivePathStore } from './navToActivePath';
|
||||||
import { DRAFT_MSG_KEY_PREFIX } from '../utils/draft';
|
import { DRAFT_MSG_KEY_PREFIX } from '../utils/draft';
|
||||||
import { clearCallSession } from '../utils/callRejoin';
|
import { clearCallSession } from '../utils/callRejoin';
|
||||||
|
import { clearOutbox } from '../utils/outbox';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [Gitea #41] Wipe every persisted composer draft (`draft-msg-<roomId>`). Drafts
|
* [Gitea #41] Wipe every persisted composer draft (`draft-msg-<roomId>`). Drafts
|
||||||
@@ -44,6 +45,7 @@ const clearMsgDrafts = (): void => {
|
|||||||
* - `cinny_recent_forward_targets_v1` — recent forward contact/room graph (PII)
|
* - `cinny_recent_forward_targets_v1` — recent forward contact/room graph (PII)
|
||||||
* - `cinny_recent_gifs_v1` / `cinny_recent_stickers_v1` — media the user sent
|
* - `cinny_recent_gifs_v1` / `cinny_recent_stickers_v1` — media the user sent
|
||||||
* - `navToActivePath<userId>` — per-space last-visited room paths (needs userId)
|
* - `navToActivePath<userId>` — per-space last-visited room paths (needs userId)
|
||||||
|
* - `lotus_outbox_v1` — decrypted content of messages not yet sent ([Gitea #112])
|
||||||
* - `draft-msg-*` — unsent composer drafts (decrypted message text, unscoped by
|
* - `draft-msg-*` — unsent composer drafts (decrypted message text, unscoped by
|
||||||
* user — see [Gitea #41]; previously deliberately preserved across logout
|
* user — see [Gitea #41]; previously deliberately preserved across logout
|
||||||
* (N98), which let the next account on this device see/send a prior user's
|
* (N98), which let the next account on this device see/send a prior user's
|
||||||
@@ -93,6 +95,7 @@ export const clearPlaintextCaches = (userId?: string): void => {
|
|||||||
clearRecentGifs();
|
clearRecentGifs();
|
||||||
clearRecentStickers();
|
clearRecentStickers();
|
||||||
clearMsgDrafts();
|
clearMsgDrafts();
|
||||||
|
clearOutbox();
|
||||||
clearCallSession();
|
clearCallSession();
|
||||||
clearStatusMessage();
|
clearStatusMessage();
|
||||||
if (userId) clearNavToActivePathStore(userId);
|
if (userId) clearNavToActivePathStore(userId);
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { atom } from 'jotai';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #112] True while the client can't reach the homeserver (sync is
|
||||||
|
* reconnecting / erroring, or the browser reports offline). Messages that
|
||||||
|
* failed for network reasons show "Queued" instead of "Failed to send" while
|
||||||
|
* this is set; the outbox sends them again once it clears.
|
||||||
|
*/
|
||||||
|
export const sendOfflineAtom = atom(false);
|
||||||
@@ -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
|
||||||
|
|||||||
@@ -8,44 +8,96 @@ import {
|
|||||||
formatSkew,
|
formatSkew,
|
||||||
} from './clockSkew';
|
} from './clockSkew';
|
||||||
|
|
||||||
// A live event received when the local clock is `skew` ms ahead of the server:
|
const T = 1_700_000_000_000;
|
||||||
// origin_server_ts = T (server clock), age = a, localTimestamp = (T + a + skew) - a.
|
|
||||||
const feed = (m: ClockSkewMonitor, skew: number, age = 500, t = 1_700_000_000_000) =>
|
|
||||||
m.sample(t, age, t + skew);
|
|
||||||
|
|
||||||
test('needs three samples, then reports the median with direction', () => {
|
/**
|
||||||
|
* A live event received `atSec` seconds into the test, when the local clock is
|
||||||
|
* `skew` ms off the server and the response took `delay` ms to arrive:
|
||||||
|
* localTimestamp − origin_server_ts = skew + delay.
|
||||||
|
*/
|
||||||
|
const feed = (m: ClockSkewMonitor, skew: number, atSec = 0, delay = 0, wallJump = 0) =>
|
||||||
|
m.sample(T, 500, T + skew + delay, { wall: T + atSec * 1000 + wallJump, mono: atSec * 1000 });
|
||||||
|
|
||||||
|
test('behind: reported as soon as there are three samples', () => {
|
||||||
const m = new ClockSkewMonitor();
|
const m = new ClockSkewMonitor();
|
||||||
assert.equal(feed(m, 60_000).skewMs, null);
|
assert.equal(feed(m, -60_000, 0).skewMs, null);
|
||||||
assert.equal(feed(m, 61_000).skewMs, null);
|
assert.equal(feed(m, -61_000, 1).skewMs, null);
|
||||||
const s = feed(m, 59_000);
|
const s = feed(m, -59_000, 2);
|
||||||
assert.equal(s.skewMs, 60_000);
|
assert.equal(s.skewMs, -61_000);
|
||||||
assert.equal(s.warning, true);
|
assert.equal(s.warning, true);
|
||||||
assert.equal(formatSkew(s.skewMs!), '60 seconds ahead');
|
assert.equal(formatSkew(s.skewMs!), '61 seconds behind');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('one bad sample cannot trip the warning (median) and hysteresis clears only under 15 s', () => {
|
test('ahead: only once it has held for a minute', () => {
|
||||||
const m = new ClockSkewMonitor();
|
const m = new ClockSkewMonitor();
|
||||||
feed(m, 1000);
|
feed(m, 60_000, 0);
|
||||||
feed(m, 1500);
|
feed(m, 60_000, 10);
|
||||||
assert.equal(feed(m, 90_000).warning, false); // outlier
|
assert.equal(feed(m, 60_000, 20).warning, false);
|
||||||
assert.equal(m.getState().skewMs, 1500);
|
assert.equal(m.getState().skewMs, 60_000);
|
||||||
|
assert.equal(feed(m, 60_000, 59).warning, false);
|
||||||
|
assert.equal(feed(m, 60_000, 61).warning, true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('server stall (2026-09-29): a burst of late events does not read as a wrong clock', () => {
|
||||||
|
const m = new ClockSkewMonitor();
|
||||||
|
// Normal traffic, then the homeserver stalls and one /sync arrives 30 s late
|
||||||
|
// with a pile of events, then normal traffic again.
|
||||||
|
feed(m, 200, 0);
|
||||||
|
feed(m, 150, 5);
|
||||||
|
feed(m, 300, 10);
|
||||||
|
[1, 2, 3, 4, 5, 6].forEach(() => feed(m, 0, 130, 31_000));
|
||||||
|
assert.equal(m.getState().warning, false);
|
||||||
|
assert.ok(m.getState().skewMs! < 1000);
|
||||||
|
|
||||||
|
// Fresh client whose first samples are all from the late burst.
|
||||||
|
const fresh = new ClockSkewMonitor();
|
||||||
|
[1, 2, 3, 4, 5, 6].forEach(() => feed(fresh, 0, 0, 31_000));
|
||||||
|
assert.equal(fresh.getState().warning, false);
|
||||||
|
// …and the next timely event brings the estimate back down.
|
||||||
|
feed(fresh, 0, 70, 100);
|
||||||
|
assert.equal(fresh.getState().warning, false);
|
||||||
|
assert.equal(fresh.getState().skewMs, 100);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('slow deliveries mixed with fast ones: the fastest one wins', () => {
|
||||||
|
const m = new ClockSkewMonitor();
|
||||||
|
[0, 20, 40, 60, 80].forEach((at, i) => feed(m, 45_000, at, i === 2 ? 0 : 20_000));
|
||||||
|
assert.equal(m.getState().skewMs, 45_000);
|
||||||
|
assert.equal(m.getState().warning, true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('hysteresis: once on, clears only under 15 s', () => {
|
||||||
const w = new ClockSkewMonitor();
|
const w = new ClockSkewMonitor();
|
||||||
[40_000, 41_000, 39_000, 40_000, 40_000].forEach((s) => feed(w, s));
|
[0, 1, 2].forEach((at) => feed(w, -40_000, at));
|
||||||
assert.equal(w.getState().warning, true);
|
assert.equal(w.getState().warning, true);
|
||||||
// drifting down to 20 s: still >= 15 s → stays on
|
// Samples expire after 5 minutes; drifting to -20 s keeps it on (>= 15 s).
|
||||||
[20_000, 20_000, 20_000, 20_000, 20_000].forEach((s) => feed(w, s));
|
[400, 401, 402].forEach((at) => feed(w, -20_000, at));
|
||||||
|
assert.equal(w.getState().skewMs, -20_000);
|
||||||
assert.equal(w.getState().warning, true);
|
assert.equal(w.getState().warning, true);
|
||||||
[10_000, 10_000, 10_000, 10_000, 10_000].forEach((s) => feed(w, s));
|
[800, 801, 802].forEach((at) => feed(w, -10_000, at));
|
||||||
assert.equal(w.getState().warning, false);
|
assert.equal(w.getState().warning, false);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test('fixing the local clock starts the measurement afresh', () => {
|
||||||
|
const m = new ClockSkewMonitor();
|
||||||
|
[0, 1, 2].forEach((at) => feed(m, -14 * 60_000, at));
|
||||||
|
assert.equal(m.getState().warning, true);
|
||||||
|
// The user sets the clock forward 14 minutes: wall jumps vs the monotonic clock.
|
||||||
|
const jump = 14 * 60_000;
|
||||||
|
feed(m, 0, 10, 0, jump);
|
||||||
|
assert.equal(m.getState().warning, false);
|
||||||
|
assert.equal(m.getState().skewMs, null);
|
||||||
|
feed(m, 0, 11, 0, jump);
|
||||||
|
feed(m, 0, 12, 0, jump);
|
||||||
|
assert.equal(m.getState().skewMs, 0);
|
||||||
|
assert.equal(m.getState().warning, false);
|
||||||
|
});
|
||||||
|
|
||||||
test('stale or missing age is ignored (cache replay must not read as skew)', () => {
|
test('stale or missing age is ignored (cache replay must not read as skew)', () => {
|
||||||
const m = new ClockSkewMonitor();
|
const m = new ClockSkewMonitor();
|
||||||
const t = 1_700_000_000_000;
|
m.sample(T, undefined, T + 3_600_000);
|
||||||
m.sample(t, undefined, t + 3_600_000);
|
m.sample(T, 40 * 24 * 60 * 60 * 1000, T + 3_600_000);
|
||||||
m.sample(t, 40 * 24 * 60 * 60 * 1000, t + 3_600_000);
|
m.sample(T, -5, T);
|
||||||
m.sample(t, -5, t);
|
|
||||||
assert.equal(m.getState().skewMs, null);
|
assert.equal(m.getState().skewMs, null);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -53,10 +105,7 @@ test('subscribe fires on change only; reset clears', () => {
|
|||||||
const m = new ClockSkewMonitor();
|
const m = new ClockSkewMonitor();
|
||||||
const seen: (number | null)[] = [];
|
const seen: (number | null)[] = [];
|
||||||
m.subscribe((s) => seen.push(s.skewMs));
|
m.subscribe((s) => seen.push(s.skewMs));
|
||||||
feed(m, -120_000);
|
[0, 1, 2, 3].forEach((at) => feed(m, -120_000, at));
|
||||||
feed(m, -120_000);
|
|
||||||
feed(m, -120_000);
|
|
||||||
feed(m, -120_000);
|
|
||||||
assert.deepEqual(seen, [-120_000]);
|
assert.deepEqual(seen, [-120_000]);
|
||||||
assert.equal(formatSkew(-120_000), '2 minutes behind');
|
assert.equal(formatSkew(-120_000), '2 minutes behind');
|
||||||
m.reset();
|
m.reset();
|
||||||
|
|||||||
+56
-11
@@ -22,8 +22,23 @@
|
|||||||
|
|
||||||
export const SKEW_WARN_MS = 30_000;
|
export const SKEW_WARN_MS = 30_000;
|
||||||
export const SKEW_CLEAR_MS = 15_000;
|
export const SKEW_CLEAR_MS = 15_000;
|
||||||
export const SKEW_SAMPLES = 5;
|
|
||||||
export const SKEW_MIN_SAMPLES = 3;
|
export const SKEW_MIN_SAMPLES = 3;
|
||||||
|
/** Samples older than this are forgotten. */
|
||||||
|
export const SKEW_WINDOW_MS = 5 * 60 * 1000;
|
||||||
|
export const SKEW_MAX_SAMPLES = 30;
|
||||||
|
/**
|
||||||
|
* "Ahead" must hold across samples received at least this far apart.
|
||||||
|
*
|
||||||
|
* Incident 2026-09-29: the homeserver's host ran out of memory and stalled for
|
||||||
|
* ~2 minutes; the /sync that finally went out carried events whose `age` was
|
||||||
|
* computed ~30 s before it arrived, so every client read "your clock is 30 s
|
||||||
|
* ahead" — while the real problem was the server. A late delivery can only make
|
||||||
|
* the local clock look AHEAD (never behind), so the estimate is the LOWEST
|
||||||
|
* recent sample (the one delivered fastest), and "ahead" has to persist across
|
||||||
|
* a minute of fresh samples before it is reported. "Behind" can't come from a
|
||||||
|
* delay and is reported as soon as there are enough samples.
|
||||||
|
*/
|
||||||
|
export const SKEW_AHEAD_SPAN_MS = 60_000;
|
||||||
/**
|
/**
|
||||||
* Sanity cap on `age`. Old events are still valid samples (the server computes
|
* Sanity cap on `age`. Old events are still valid samples (the server computes
|
||||||
* `age` at response time, so `ts + age` is its clock regardless of the event's
|
* `age` at response time, so `ts + age` is its clock regardless of the event's
|
||||||
@@ -38,14 +53,21 @@ export type ClockSkewState = {
|
|||||||
warning: boolean;
|
warning: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
const median = (xs: number[]): number => {
|
/** A wall-clock change larger than this (vs the monotonic clock) resets the samples. */
|
||||||
const s = [...xs].sort((a, b) => a - b);
|
export const CLOCK_JUMP_MS = 5_000;
|
||||||
const mid = Math.floor(s.length / 2);
|
|
||||||
return s.length % 2 ? s[mid] : (s[mid - 1] + s[mid]) / 2;
|
type Sample = { skew: number; at: number };
|
||||||
|
|
||||||
|
const currentClock = (): { wall: number; mono: number } => {
|
||||||
|
const wall = Date.now();
|
||||||
|
const mono = typeof performance !== 'undefined' ? performance.now() : wall;
|
||||||
|
return { wall, mono };
|
||||||
};
|
};
|
||||||
|
|
||||||
export class ClockSkewMonitor {
|
export class ClockSkewMonitor {
|
||||||
private samples: number[] = [];
|
private samples: Sample[] = [];
|
||||||
|
|
||||||
|
private clockOffset: number | undefined;
|
||||||
|
|
||||||
private state: ClockSkewState = { skewMs: null, warning: false };
|
private state: ClockSkewState = { skewMs: null, warning: false };
|
||||||
|
|
||||||
@@ -64,25 +86,47 @@ export class ClockSkewMonitor {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Feed one live event. `originServerTs` + `age` come from the event;
|
* Feed one live event. `originServerTs` + `age` come from the event;
|
||||||
* `localTimestamp` is the SDK's `Date.now() − age` at construction.
|
* `localTimestamp` is the SDK's `Date.now() − age` at construction; `clock`
|
||||||
|
* is when the sample was taken: wall clock and a monotonic clock
|
||||||
|
* (performance.now()), so samples are aged by real elapsed time and a change
|
||||||
|
* of the local clock (someone fixing it) starts the measurement afresh.
|
||||||
|
* Only feed events stamped by OUR homeserver: another server's
|
||||||
|
* `origin_server_ts` carries that server's clock.
|
||||||
* Returns the new state (unchanged object when nothing moved).
|
* Returns the new state (unchanged object when nothing moved).
|
||||||
*/
|
*/
|
||||||
public sample(
|
public sample(
|
||||||
originServerTs: number,
|
originServerTs: number,
|
||||||
age: number | undefined,
|
age: number | undefined,
|
||||||
localTimestamp: number,
|
localTimestamp: number,
|
||||||
|
clock: { wall: number; mono: number } = currentClock(),
|
||||||
): ClockSkewState {
|
): ClockSkewState {
|
||||||
if (age === undefined || !Number.isFinite(age) || age < 0 || age > SKEW_MAX_AGE_MS) {
|
if (age === undefined || !Number.isFinite(age) || age < 0 || age > SKEW_MAX_AGE_MS) {
|
||||||
return this.state;
|
return this.state;
|
||||||
}
|
}
|
||||||
if (!Number.isFinite(originServerTs) || !Number.isFinite(localTimestamp)) return this.state;
|
if (!Number.isFinite(originServerTs) || !Number.isFinite(localTimestamp)) return this.state;
|
||||||
this.samples.push(localTimestamp - originServerTs);
|
const now = clock.mono;
|
||||||
if (this.samples.length > SKEW_SAMPLES) this.samples.shift();
|
const offset = clock.wall - clock.mono;
|
||||||
|
if (this.clockOffset !== undefined && Math.abs(offset - this.clockOffset) > CLOCK_JUMP_MS) {
|
||||||
|
// The local clock was changed: earlier samples measured the old clock.
|
||||||
|
this.reset();
|
||||||
|
}
|
||||||
|
this.clockOffset = offset;
|
||||||
|
this.samples.push({ skew: localTimestamp - originServerTs, at: now });
|
||||||
|
this.samples = this.samples.filter((s) => now - s.at <= SKEW_WINDOW_MS);
|
||||||
|
if (this.samples.length > SKEW_MAX_SAMPLES) this.samples.shift();
|
||||||
if (this.samples.length < SKEW_MIN_SAMPLES) return this.state;
|
if (this.samples.length < SKEW_MIN_SAMPLES) return this.state;
|
||||||
|
|
||||||
const skewMs = median(this.samples);
|
// Delivery delay only ever adds to a sample: the smallest is the truest.
|
||||||
|
const skewMs = Math.min(...this.samples.map((s) => s.skew));
|
||||||
const abs = Math.abs(skewMs);
|
const abs = Math.abs(skewMs);
|
||||||
const warning = this.state.warning ? abs >= SKEW_CLEAR_MS : abs > SKEW_WARN_MS;
|
let warning: boolean;
|
||||||
|
if (this.state.warning) warning = abs >= SKEW_CLEAR_MS;
|
||||||
|
else if (skewMs < -SKEW_WARN_MS) warning = true;
|
||||||
|
else if (skewMs > SKEW_WARN_MS) {
|
||||||
|
// Ahead: only if the fastest-delivered samples stayed high for a minute.
|
||||||
|
const span = now - Math.min(...this.samples.map((s) => s.at));
|
||||||
|
warning = span >= SKEW_AHEAD_SPAN_MS;
|
||||||
|
} else warning = false;
|
||||||
if (skewMs === this.state.skewMs && warning === this.state.warning) return this.state;
|
if (skewMs === this.state.skewMs && warning === this.state.warning) return this.state;
|
||||||
this.state = { skewMs, warning };
|
this.state = { skewMs, warning };
|
||||||
this.listeners.forEach((cb) => cb(this.state));
|
this.listeners.forEach((cb) => cb(this.state));
|
||||||
@@ -91,6 +135,7 @@ export class ClockSkewMonitor {
|
|||||||
|
|
||||||
public reset(): void {
|
public reset(): void {
|
||||||
this.samples = [];
|
this.samples = [];
|
||||||
|
this.clockOffset = undefined;
|
||||||
if (this.state.skewMs !== null || this.state.warning) {
|
if (this.state.skewMs !== null || this.state.warning) {
|
||||||
this.state = { skewMs: null, warning: false };
|
this.state = { skewMs: null, warning: false };
|
||||||
this.listeners.forEach((cb) => cb(this.state));
|
this.listeners.forEach((cb) => cb(this.state));
|
||||||
|
|||||||
@@ -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)));
|
||||||
|
};
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
import { test } from 'node:test';
|
||||||
|
import assert from 'node:assert/strict';
|
||||||
|
import {
|
||||||
|
OUTBOX_AUTOSEND_MS,
|
||||||
|
OUTBOX_MAX_ENTRIES,
|
||||||
|
OutboxEntry,
|
||||||
|
isRetryableSendError,
|
||||||
|
outboxRetryDelayMs,
|
||||||
|
parseOutbox,
|
||||||
|
planRestore,
|
||||||
|
shouldKeepInOutbox,
|
||||||
|
withEntry,
|
||||||
|
withoutEntry,
|
||||||
|
} from './outbox';
|
||||||
|
|
||||||
|
const entry = (txnId: string, ts: number, roomId = '!a:hs'): OutboxEntry => ({
|
||||||
|
txnId,
|
||||||
|
roomId,
|
||||||
|
threadId: null,
|
||||||
|
type: 'm.room.message',
|
||||||
|
content: { msgtype: 'm.text', body: txnId },
|
||||||
|
ts,
|
||||||
|
});
|
||||||
|
|
||||||
|
test('keeps message-like events, not call signalling or redactions', () => {
|
||||||
|
assert.equal(shouldKeepInOutbox('m.room.message', { body: 'hi' }), true);
|
||||||
|
assert.equal(shouldKeepInOutbox('m.reaction', { 'm.relates_to': { event_id: '$x' } }), true);
|
||||||
|
assert.equal(shouldKeepInOutbox('org.matrix.msc3381.poll.start', {}), true);
|
||||||
|
assert.equal(shouldKeepInOutbox('org.matrix.msc4075.rtc.notification', {}), false);
|
||||||
|
assert.equal(shouldKeepInOutbox('m.call.invite', {}), false);
|
||||||
|
assert.equal(shouldKeepInOutbox('m.room.redaction', {}), false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('skips events that point at another unsent message (local id)', () => {
|
||||||
|
assert.equal(
|
||||||
|
shouldKeepInOutbox('m.reaction', { 'm.relates_to': { event_id: '~!a:hs:m123' } }),
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
assert.equal(
|
||||||
|
shouldKeepInOutbox('m.room.message', {
|
||||||
|
body: 'reply',
|
||||||
|
'm.relates_to': { 'm.in_reply_to': { event_id: '~!a:hs:m1' } },
|
||||||
|
}),
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
assert.equal(
|
||||||
|
shouldKeepInOutbox('m.room.message', {
|
||||||
|
body: 'reply',
|
||||||
|
'm.relates_to': { 'm.in_reply_to': { event_id: '$real' } },
|
||||||
|
}),
|
||||||
|
true,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('retryable: connection loss, timeouts, rate limits, server errors', () => {
|
||||||
|
const connectionError = new Error('fetch failed');
|
||||||
|
Object.defineProperty(connectionError, 'name', { value: 'ConnectionError' });
|
||||||
|
assert.equal(isRetryableSendError(connectionError), true);
|
||||||
|
assert.equal(isRetryableSendError({ httpStatus: 429 }), true);
|
||||||
|
assert.equal(isRetryableSendError({ httpStatus: 408 }), true);
|
||||||
|
assert.equal(isRetryableSendError({ httpStatus: 502 }), true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('not retryable: client errors, consent, unknown or missing errors', () => {
|
||||||
|
assert.equal(isRetryableSendError({ httpStatus: 403, errcode: 'M_FORBIDDEN' }), false);
|
||||||
|
assert.equal(isRetryableSendError({ httpStatus: 403, errcode: 'M_CONSENT_NOT_GIVEN' }), false);
|
||||||
|
assert.equal(isRetryableSendError({ httpStatus: 400 }), false);
|
||||||
|
assert.equal(isRetryableSendError(new Error('encryption failed')), false);
|
||||||
|
assert.equal(isRetryableSendError(undefined), false);
|
||||||
|
assert.equal(isRetryableSendError(null), false);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('parse: only this user, only well-formed entries, junk tolerated', () => {
|
||||||
|
const good = entry('m1', 1);
|
||||||
|
const raw = JSON.stringify({ userId: '@me:hs', entries: [good, { txnId: 5 }, null] });
|
||||||
|
assert.deepEqual(parseOutbox(raw, '@me:hs'), [good]);
|
||||||
|
assert.deepEqual(parseOutbox(raw, '@other:hs'), []);
|
||||||
|
assert.deepEqual(parseOutbox('{not json', '@me:hs'), []);
|
||||||
|
assert.deepEqual(parseOutbox(null, '@me:hs'), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('withEntry: first write wins, sorted, capped (oldest dropped)', () => {
|
||||||
|
const a = entry('a', 2);
|
||||||
|
let list = withEntry([], a);
|
||||||
|
assert.equal(withEntry(list, { ...a, content: { body: 'changed' } }), list);
|
||||||
|
list = withEntry(list, entry('b', 1));
|
||||||
|
assert.deepEqual(
|
||||||
|
list.map((e) => e.txnId),
|
||||||
|
['b', 'a'],
|
||||||
|
);
|
||||||
|
let many: OutboxEntry[] = [];
|
||||||
|
for (let i = 0; i < OUTBOX_MAX_ENTRIES + 5; i += 1) many = withEntry(many, entry(`t${i}`, i));
|
||||||
|
assert.equal(many.length, OUTBOX_MAX_ENTRIES);
|
||||||
|
assert.equal(many[0].txnId, 't5');
|
||||||
|
});
|
||||||
|
|
||||||
|
test('withoutEntry: removes, and returns the same list when absent', () => {
|
||||||
|
const list = [entry('a', 1), entry('b', 2)];
|
||||||
|
assert.deepEqual(
|
||||||
|
withoutEntry(list, 'a').map((e) => e.txnId),
|
||||||
|
['b'],
|
||||||
|
);
|
||||||
|
assert.equal(withoutEntry(list, 'zzz'), list);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('restore plan: drops delivered / left rooms, auto-sends only recent ones', () => {
|
||||||
|
const now = 10 * OUTBOX_AUTOSEND_MS;
|
||||||
|
const recent = entry('recent', now - 60_000);
|
||||||
|
const old = entry('old', now - OUTBOX_AUTOSEND_MS - 1);
|
||||||
|
const delivered = entry('delivered', now - 1000);
|
||||||
|
const left = entry('left', now - 1000, '!left:hs');
|
||||||
|
const plan = planRestore(
|
||||||
|
[recent, left, old, delivered],
|
||||||
|
now,
|
||||||
|
(roomId) => roomId !== '!left:hs',
|
||||||
|
(e) => e.txnId === 'delivered',
|
||||||
|
);
|
||||||
|
assert.deepEqual(
|
||||||
|
plan.restore.map((e) => e.txnId),
|
||||||
|
['old', 'recent'],
|
||||||
|
);
|
||||||
|
assert.deepEqual([...plan.autoSend], ['recent']);
|
||||||
|
assert.deepEqual(plan.drop.map((e) => e.txnId).sort(), ['delivered', 'left']);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('blip retry delay backs off and is capped at a minute', () => {
|
||||||
|
assert.deepEqual(
|
||||||
|
[0, 1, 2, 3, 4, 9].map(outboxRetryDelayMs),
|
||||||
|
[5000, 10000, 20000, 40000, 60000, 60000],
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,182 @@
|
|||||||
|
import { IContent } from 'matrix-js-sdk';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [Gitea #112] Offline outbox: unsent messages survive a reload and are
|
||||||
|
* retried when the connection comes back.
|
||||||
|
*
|
||||||
|
* The SDK keeps local echoes in memory only (chronological pending ordering),
|
||||||
|
* so a reload used to drop every message that hadn't reached the server. Each
|
||||||
|
* own message send is mirrored here (type + clear content + txnId) from its
|
||||||
|
* first local echo until the server confirms it or the user cancels it. On
|
||||||
|
* the next start it is put back as a failed local echo (Retry / Cancel as
|
||||||
|
* usual) and, if it's recent, sent again with the SAME txnId — the server
|
||||||
|
* deduplicates a transaction it already accepted.
|
||||||
|
*
|
||||||
|
* The content is the decrypted message, like a composer draft: it lives in
|
||||||
|
* localStorage until sent and is wiped on logout (clearPlaintextCaches).
|
||||||
|
*/
|
||||||
|
|
||||||
|
export type OutboxEntry = {
|
||||||
|
txnId: string;
|
||||||
|
roomId: string;
|
||||||
|
threadId: string | null;
|
||||||
|
type: string;
|
||||||
|
content: IContent;
|
||||||
|
/** When the message was first sent (local echo timestamp, ms). */
|
||||||
|
ts: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
type Stored = { userId: string; entries: OutboxEntry[] };
|
||||||
|
|
||||||
|
const STORAGE_KEY = 'lotus_outbox_v1';
|
||||||
|
/** Hard cap so a long offline stretch can't grow localStorage without bound. */
|
||||||
|
export const OUTBOX_MAX_ENTRIES = 100;
|
||||||
|
/**
|
||||||
|
* Restored messages younger than this are sent again automatically after a
|
||||||
|
* reload; older ones come back as "Failed to send" and wait for the user
|
||||||
|
* (sending a message typed hours ago without asking would surprise people).
|
||||||
|
*/
|
||||||
|
export const OUTBOX_AUTOSEND_MS = 60 * 60 * 1000;
|
||||||
|
/** Auto-retries per message per session (one per reconnect). */
|
||||||
|
export const OUTBOX_MAX_AUTO_RETRIES = 10;
|
||||||
|
|
||||||
|
/** Delay before automatic retry number `attempt` (0-based) after a blip. */
|
||||||
|
export const outboxRetryDelayMs = (attempt: number): number =>
|
||||||
|
Math.min(5000 * 2 ** Math.max(0, attempt), 60_000);
|
||||||
|
|
||||||
|
/** Message-like events worth keeping. Not call signalling, not redactions. */
|
||||||
|
export const OUTBOX_EVENT_TYPES: ReadonlySet<string> = new Set([
|
||||||
|
'm.room.message',
|
||||||
|
'm.sticker',
|
||||||
|
'm.reaction',
|
||||||
|
'm.poll.start',
|
||||||
|
'm.poll.response',
|
||||||
|
'm.poll.end',
|
||||||
|
'org.matrix.msc3381.poll.start',
|
||||||
|
'org.matrix.msc3381.poll.response',
|
||||||
|
'org.matrix.msc3381.poll.end',
|
||||||
|
]);
|
||||||
|
|
||||||
|
const relatesToPendingEvent = (content: IContent): boolean => {
|
||||||
|
const rel = content['m.relates_to'] as
|
||||||
|
| { event_id?: unknown; 'm.in_reply_to'?: { event_id?: unknown } }
|
||||||
|
| undefined;
|
||||||
|
const ids = [rel?.event_id, rel?.['m.in_reply_to']?.event_id];
|
||||||
|
// A local echo's id ("~!room:txn") means nothing after a reload.
|
||||||
|
return ids.some((id) => typeof id === 'string' && id.startsWith('~'));
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Whether a send should be mirrored into the outbox. */
|
||||||
|
export const shouldKeepInOutbox = (type: string, content: IContent): boolean =>
|
||||||
|
OUTBOX_EVENT_TYPES.has(type) && !relatesToPendingEvent(content);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A failure the network is to blame for: no connection (the SDK's
|
||||||
|
* ConnectionError), a timeout, rate limiting or a server error. Anything else
|
||||||
|
* (403, consent, bad request, encryption failure) needs the user.
|
||||||
|
*/
|
||||||
|
export const isRetryableSendError = (err: unknown): boolean => {
|
||||||
|
if (!err || typeof err !== 'object') return false;
|
||||||
|
const { name, httpStatus } = err as { name?: unknown; httpStatus?: unknown };
|
||||||
|
if (name === 'ConnectionError') return true;
|
||||||
|
if (typeof httpStatus !== 'number') return false;
|
||||||
|
return httpStatus === 408 || httpStatus === 429 || httpStatus >= 500;
|
||||||
|
};
|
||||||
|
|
||||||
|
const isEntry = (e: unknown): e is OutboxEntry => {
|
||||||
|
if (!e || typeof e !== 'object') return false;
|
||||||
|
const o = e as Record<string, unknown>;
|
||||||
|
return (
|
||||||
|
typeof o.txnId === 'string' &&
|
||||||
|
typeof o.roomId === 'string' &&
|
||||||
|
(o.threadId === null || typeof o.threadId === 'string') &&
|
||||||
|
typeof o.type === 'string' &&
|
||||||
|
!!o.content &&
|
||||||
|
typeof o.content === 'object' &&
|
||||||
|
typeof o.ts === 'number'
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Parse the stored outbox, keeping only this user's well-formed entries. */
|
||||||
|
export const parseOutbox = (raw: string | null, userId: string): OutboxEntry[] => {
|
||||||
|
if (!raw) return [];
|
||||||
|
try {
|
||||||
|
const parsed = JSON.parse(raw) as Partial<Stored>;
|
||||||
|
if (parsed.userId !== userId || !Array.isArray(parsed.entries)) return [];
|
||||||
|
return parsed.entries.filter(isEntry);
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Add (or keep) an entry: first write wins, oldest dropped past the cap. */
|
||||||
|
export const withEntry = (entries: OutboxEntry[], entry: OutboxEntry): OutboxEntry[] => {
|
||||||
|
if (entries.some((e) => e.txnId === entry.txnId)) return entries;
|
||||||
|
const next = [...entries, entry].sort((a, b) => a.ts - b.ts);
|
||||||
|
return next.length > OUTBOX_MAX_ENTRIES ? next.slice(next.length - OUTBOX_MAX_ENTRIES) : next;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const withoutEntry = (entries: OutboxEntry[], txnId: string): OutboxEntry[] =>
|
||||||
|
entries.some((e) => e.txnId === txnId) ? entries.filter((e) => e.txnId !== txnId) : entries;
|
||||||
|
|
||||||
|
export type RestorePlan = {
|
||||||
|
/** Put back as failed local echoes, oldest first. */
|
||||||
|
restore: OutboxEntry[];
|
||||||
|
/** Subset of `restore` to send again right away. */
|
||||||
|
autoSend: Set<string>;
|
||||||
|
/** Already delivered or no longer sendable: forget them. */
|
||||||
|
drop: OutboxEntry[];
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decide what to do with the stored outbox on start.
|
||||||
|
* `canSend(roomId)`: the user is still joined; `delivered(entry)`: the
|
||||||
|
* server already has it (the transaction id came back down /sync).
|
||||||
|
*/
|
||||||
|
export const planRestore = (
|
||||||
|
entries: OutboxEntry[],
|
||||||
|
now: number,
|
||||||
|
canSend: (roomId: string) => boolean,
|
||||||
|
delivered: (entry: OutboxEntry) => boolean,
|
||||||
|
): RestorePlan => {
|
||||||
|
const restore: OutboxEntry[] = [];
|
||||||
|
const autoSend = new Set<string>();
|
||||||
|
const drop: OutboxEntry[] = [];
|
||||||
|
[...entries]
|
||||||
|
.sort((a, b) => a.ts - b.ts)
|
||||||
|
.forEach((entry) => {
|
||||||
|
if (!canSend(entry.roomId) || delivered(entry)) {
|
||||||
|
drop.push(entry);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
restore.push(entry);
|
||||||
|
if (now - entry.ts < OUTBOX_AUTOSEND_MS) autoSend.add(entry.txnId);
|
||||||
|
});
|
||||||
|
return { restore, autoSend, drop };
|
||||||
|
};
|
||||||
|
|
||||||
|
export const loadOutbox = (userId: string): OutboxEntry[] => {
|
||||||
|
try {
|
||||||
|
return parseOutbox(localStorage.getItem(STORAGE_KEY), userId);
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const saveOutbox = (userId: string, entries: OutboxEntry[]): void => {
|
||||||
|
try {
|
||||||
|
if (entries.length === 0) localStorage.removeItem(STORAGE_KEY);
|
||||||
|
else localStorage.setItem(STORAGE_KEY, JSON.stringify({ userId, entries } satisfies Stored));
|
||||||
|
} catch {
|
||||||
|
// Storage full or blocked: the outbox is best-effort.
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Wipe the outbox (logout): it holds decrypted message content. */
|
||||||
|
export const clearOutbox = (): void => {
|
||||||
|
try {
|
||||||
|
localStorage.removeItem(STORAGE_KEY);
|
||||||
|
} catch {
|
||||||
|
/* localStorage unavailable — nothing to clear */
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -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