mirror of
https://github.com/go-gitea/gitea.git
synced 2026-07-28 09:15:18 +02:00
* Closes #36942 * Fixes #19265 Replaces the SSE-based push channel (`/user/events`) with a WebSocket endpoint (`/-/ws`). ### What changes - **New `/-/ws` endpoint** (authenticated). One WebSocket per origin, shared across tabs via a single `SharedWorker`. - **Pubsub broker** (`services/pubsub`) for fan-out by topic, behind a `Broker` interface. `MemoryBroker` is the default (single process); a Redis backend is available for multi-process setups, configured via `[websocket].PUBSUB_TYPE` / `PUBSUB_CONN_STR`. The internal Gitea queue was not usable here because it has FIFO/single-consumer semantics. - **Push-only event production.** Events are emitted by write-triggered notifiers — `NotificationCountChange`, `PublishStopwatchesForUser`, and the logout publisher — wired into the existing `notify.Notifier` interface. No server-side pollers. - **Typed pub/sub on the client.** `web_src/js/modules/worker.ts` is a singleton transport; features subscribe per event type via `onUserEvent('notification-count', cb)` instead of branching on `event.data.type`. - **Wire contract** (`UserEventType` union) is shared between the worker and consumers via `web_src/js/types.ts`, kept in sync with `services/websocket/events.go`. - **Client-side periodic polling fallback** kicks in only when the WebSocket cannot be established (e.g. proxy blocks WS, browser lacks module-SharedWorker support). ### What's removed - `modules/eventsource` (SSE manager, run loop, messenger). - `/user/events` route and `tests/integration/eventsource_test.go`. - All server-side polling for stopwatches and notification counts. ### Stopwatch multi-tab fix The navbar stopwatch icon was previously rendered conditionally on `{{if $activeStopwatch}}`, so tabs loaded before the timer started had no DOM element to update. The icon and popup are now always rendered (toggled with `tw-hidden`), and the start/stop/cancel handlers POST silently so all open tabs reflect the change in real time. ### Deployment note WebSocket needs the upgrade headers to pass through a reverse proxy, e.g. for nginx: ```nginx proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; ``` Without them the WebSocket cannot be established, and after 3 consecutive failed opens the shared worker signals `push-unavailable`: the notification count and stopwatch fall back to periodic polling on the existing `[ui.notification]` timeouts. Real-time push is lost, the features keep working. The reverse-proxy docs need the same note (see the `docs-update-needed` label). --------- Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Epid <rexmrj@gmail.com>
111 lines
3.5 KiB
TypeScript
111 lines
3.5 KiB
TypeScript
import {GET} from '../modules/fetch.ts';
|
|
import {toggleElem, createElementFromHTML} from '../utils/dom.ts';
|
|
import {onUserEvent} from '../modules/worker.ts';
|
|
|
|
const {appSubUrl, notificationSettings} = window.config;
|
|
let notificationSequenceNumber = 0;
|
|
|
|
async function receiveUpdateCount(count: number) {
|
|
toggleElem('.notification_count', count !== 0);
|
|
for (const el of document.querySelectorAll('.notification_count')) {
|
|
el.textContent = String(count);
|
|
}
|
|
await updateNotificationTable();
|
|
}
|
|
|
|
export function initNotificationCount() {
|
|
if (!document.querySelector('.notification_count')) return;
|
|
|
|
const startPeriodicPoller = (timeout: number, lastCount?: number) => {
|
|
if (timeout <= 0 || !Number.isFinite(timeout)) return;
|
|
lastCount = lastCount ?? getCurrentCount();
|
|
setTimeout(async () => {
|
|
await updateNotificationCountWithCallback(startPeriodicPoller, timeout, lastCount);
|
|
}, timeout);
|
|
};
|
|
|
|
let pollerStarted = false;
|
|
onUserEvent('notification-count', (msg) => { receiveUpdateCount(msg.eventData.count) }); // no await
|
|
// On each (re)connect, reconcile the count from the server to recover any push dropped during the connect gap.
|
|
onUserEvent('worker-connected', () => { updateNotificationCount(); updateNotificationTable() }); // no await
|
|
onUserEvent('worker-unavailable', () => {
|
|
if (pollerStarted) return;
|
|
pollerStarted = true;
|
|
startPeriodicPoller(notificationSettings.MinTimeout);
|
|
});
|
|
}
|
|
|
|
function getCurrentCount() {
|
|
return Number(document.querySelector('.notification_count')!.textContent ?? '0');
|
|
}
|
|
|
|
async function updateNotificationCountWithCallback(callback: (timeout: number, newCount: number) => void, timeout: number, lastCount: number) {
|
|
const currentCount = getCurrentCount();
|
|
if (lastCount !== currentCount) {
|
|
callback(notificationSettings.MinTimeout, currentCount);
|
|
return;
|
|
}
|
|
|
|
const newCount = await updateNotificationCount();
|
|
let needsUpdate = false;
|
|
|
|
if (lastCount !== newCount) {
|
|
needsUpdate = true;
|
|
timeout = notificationSettings.MinTimeout;
|
|
} else if (timeout < notificationSettings.MaxTimeout) {
|
|
timeout += notificationSettings.TimeoutStep;
|
|
}
|
|
|
|
callback(timeout, newCount);
|
|
if (needsUpdate) {
|
|
await updateNotificationTable();
|
|
}
|
|
}
|
|
|
|
async function updateNotificationTable() {
|
|
const notificationDiv = document.querySelector('#notification_div');
|
|
if (!notificationDiv) return;
|
|
|
|
try {
|
|
const params = new URLSearchParams(window.location.search);
|
|
params.set('div-only', 'true');
|
|
params.set('sequence-number', String(++notificationSequenceNumber));
|
|
const response = await GET(`${appSubUrl}/notifications?${params.toString()}`);
|
|
|
|
if (!response.ok) {
|
|
throw new Error('Failed to fetch notification table');
|
|
}
|
|
|
|
const data = await response.text();
|
|
const el = createElementFromHTML(data);
|
|
if (parseInt(el.getAttribute('data-sequence-number')!) === notificationSequenceNumber) {
|
|
notificationDiv.outerHTML = data;
|
|
}
|
|
} catch (error) {
|
|
console.error(error);
|
|
}
|
|
}
|
|
|
|
async function updateNotificationCount(): Promise<number> {
|
|
try {
|
|
const response = await GET(`${appSubUrl}/notifications/new`);
|
|
|
|
if (!response.ok) {
|
|
throw new Error('Failed to fetch notification count');
|
|
}
|
|
|
|
const data = await response.json();
|
|
|
|
toggleElem('.notification_count', data.new !== 0);
|
|
|
|
for (const el of document.querySelectorAll('.notification_count')) {
|
|
el.textContent = String(data.new);
|
|
}
|
|
|
|
return data.new as number;
|
|
} catch (error) {
|
|
console.error(error);
|
|
return 0;
|
|
}
|
|
}
|