mirror of
https://github.com/go-gitea/gitea.git
synced 2026-07-28 09:15:18 +02:00
13d0f24423
* 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>
77 lines
2.2 KiB
TypeScript
77 lines
2.2 KiB
TypeScript
interface JQuery {
|
|
fomanticExt: any; // fomantic extension
|
|
api: any, // fomantic
|
|
dimmer: any, // fomantic
|
|
dropdown: any; // fomantic
|
|
modal: any; // fomantic
|
|
transition: any, // fomantic
|
|
}
|
|
|
|
interface JQueryStatic {
|
|
api: any, // fomantic
|
|
}
|
|
|
|
interface Element {
|
|
_tippy: import('tippy.js').Instance;
|
|
}
|
|
|
|
interface Window {
|
|
config: {
|
|
appUrl: string,
|
|
appSubUrl: string,
|
|
assetUrlPrefix: string,
|
|
sharedWorkerUri: string,
|
|
runModeIsProd: boolean,
|
|
customEmojis: Record<string, string>,
|
|
pageData: Record<string, any> & {
|
|
adminUserListSearchForm?: {
|
|
SortType: string,
|
|
StatusFilterMap: Record<string, string>,
|
|
},
|
|
citationFileContent?: string,
|
|
prReview?: {
|
|
numberOfFiles: number,
|
|
numberOfViewedFiles: number,
|
|
},
|
|
DiffFileTree?: import('./modules/diff-file.ts').DiffFileTreeData,
|
|
FolderIcon?: string,
|
|
FolderOpenIcon?: string,
|
|
repoLink?: string,
|
|
repoActivityTopAuthors?: any[],
|
|
dashboardRepoList?: Record<string, any>,
|
|
},
|
|
notificationSettings: {
|
|
MinTimeout: number,
|
|
TimeoutStep: number,
|
|
MaxTimeout: number,
|
|
},
|
|
enableTimeTracking: boolean,
|
|
mermaidMaxSourceCharacters: number,
|
|
i18n: Record<string, string>,
|
|
frontendInited: boolean,
|
|
},
|
|
$: JQueryStatic,
|
|
jQuery: JQueryStatic,
|
|
_globalHandlerErrors: Array<ErrorEvent & PromiseRejectionEvent> & {
|
|
_inited: boolean,
|
|
push: (e: ErrorEvent & PromiseRejectionEvent) => void | number,
|
|
},
|
|
localUserSettings: typeof import('./modules/user-settings.ts').localUserSettings,
|
|
|
|
// various captcha plugins
|
|
grecaptcha: any,
|
|
turnstile: any,
|
|
hcaptcha: any,
|
|
|
|
// Make IIFE private functions can be managed by us in our scope, without exposing the IIFE module to global scope.
|
|
// Otherwise, when using "export" in IIFE code, the compiled JS will inject global "var externalRenderHelper = ..."
|
|
// which is not expected and may cause conflicts with other modules.
|
|
giteaExternalRenderHelper?: {
|
|
isValidCssColor(s: string | null): boolean,
|
|
queryParams: URLSearchParams,
|
|
postIframeMsg(cmd: string, data: Record<string, any> = {}),
|
|
}
|
|
|
|
// do not add more properties here unless it is a must
|
|
}
|