mirror of
https://github.com/go-gitea/gitea.git
synced 2026-08-01 00:08:21 +00:00
mohammad rahimi
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>
40 lines
1.6 KiB
Go
40 lines
1.6 KiB
Go
// Copyright 2026 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
// Package pubsub fans real-time events out to local WebSocket subscribers.
|
|
// Backend is chosen at boot: in-process map (single-instance) or Redis
|
|
// (multi-process). DefaultBroker is wired by Init from setting.Websocket.
|
|
package pubsub
|
|
|
|
import "fmt"
|
|
|
|
// subChanBuffer is how many messages a subscriber may fall behind before its
|
|
// messages are dropped instead of stalling the publisher.
|
|
const subChanBuffer = 8
|
|
|
|
type Broker interface {
|
|
// Subscribe returns a buffered channel of messages for topic, and a cancel
|
|
// func that closes the channel and removes the subscription. cancel is
|
|
// idempotent.
|
|
Subscribe(topic string) (<-chan []byte, func())
|
|
|
|
// Publish delivers msg to every subscriber of topic. Non-blocking: a slow
|
|
// subscriber drops messages rather than stalling the publisher.
|
|
Publish(topic string, msg []byte)
|
|
|
|
// HasTopicSubscribers is an optimization hint for publishers that would
|
|
// otherwise do a DB lookup just to discover nobody is listening. Backends
|
|
// that cannot answer cheaply across processes return true to be safe.
|
|
HasTopicSubscribers(topic string) bool
|
|
}
|
|
|
|
// DefaultBroker is replaced by Init from setting.Websocket. It starts as an
|
|
// empty memory broker so non-web entry points (e.g. CLI), which skip Init, can
|
|
// publish without nil checks — with no subscribers every publish is a no-op.
|
|
// Tests construct a broker explicitly (NewMemoryBroker) instead of relying on this.
|
|
var DefaultBroker Broker = NewMemoryBroker()
|
|
|
|
func UserTopic(userID int64) string {
|
|
return fmt.Sprintf("user-%d", userID)
|
|
}
|