feat: Replace SSE with WebSocket for UI notifications (#36965)

* 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>
This commit is contained in:
mohammad rahimi
2026-07-27 10:46:00 +03:00
committed by GitHub
parent e15a7e9066
commit 13d0f24423
77 changed files with 2070 additions and 1151 deletions
+8 -8
View File
@@ -13,6 +13,7 @@ import (
"gitea.dev/modules/structs"
"gitea.dev/services/context"
"gitea.dev/services/convert"
"gitea.dev/services/notifications"
)
func statusStringToNotificationStatus(status string) activities_model.NotificationStatus {
@@ -212,14 +213,13 @@ func ReadRepoNotifications(ctx *context.APIContext) {
targetStatus = activities_model.NotificationStatusRead
}
changed := make([]*structs.NotificationThread, 0, len(nl))
for _, n := range nl {
notif, err := activities_model.SetNotificationStatus(ctx, n.ID, ctx.Doer, targetStatus)
if err != nil {
ctx.APIErrorInternal(err)
return
}
updated, err := notifications.SetManyNotificationStatuses(ctx, nl, ctx.Doer, targetStatus)
if err != nil {
ctx.APIErrorInternal(err)
return
}
changed := make([]*structs.NotificationThread, 0, len(updated))
for _, notif := range updated {
_ = notif.LoadAttributes(ctx)
changed = append(changed, convert.ToNotificationThread(ctx, notif))
}
+2 -1
View File
@@ -12,6 +12,7 @@ import (
issues_model "gitea.dev/models/issues"
"gitea.dev/services/context"
"gitea.dev/services/convert"
"gitea.dev/services/notifications"
)
// GetThread get notification by ID
@@ -88,7 +89,7 @@ func ReadThread(ctx *context.APIContext) {
targetStatus = activities_model.NotificationStatusRead
}
notif, err := activities_model.SetNotificationStatus(ctx, n.ID, ctx.Doer, targetStatus)
notif, err := notifications.SetNotificationStatus(ctx, n.ID, ctx.Doer, targetStatus)
if err != nil {
ctx.APIErrorInternal(err)
return
+8 -8
View File
@@ -12,6 +12,7 @@ import (
"gitea.dev/modules/structs"
"gitea.dev/services/context"
"gitea.dev/services/convert"
"gitea.dev/services/notifications"
)
// ListNotifications list users's notification threads
@@ -160,14 +161,13 @@ func ReadNotifications(ctx *context.APIContext) {
targetStatus = activities_model.NotificationStatusRead
}
changed := make([]*structs.NotificationThread, 0, len(nl))
for _, n := range nl {
notif, err := activities_model.SetNotificationStatus(ctx, n.ID, ctx.Doer, targetStatus)
if err != nil {
ctx.APIErrorInternal(err)
return
}
updated, err := notifications.SetManyNotificationStatuses(ctx, nl, ctx.Doer, targetStatus)
if err != nil {
ctx.APIErrorInternal(err)
return
}
changed := make([]*structs.NotificationThread, 0, len(updated))
for _, notif := range updated {
_ = notif.LoadAttributes(ctx)
changed = append(changed, convert.ToNotificationThread(ctx, notif))
}
+4
View File
@@ -10,6 +10,7 @@ import (
"gitea.dev/routers/api/v1/utils"
"gitea.dev/services/context"
"gitea.dev/services/convert"
notify_service "gitea.dev/services/notify"
)
// StartIssueStopwatch creates a stopwatch for the given issue.
@@ -60,6 +61,7 @@ func StartIssueStopwatch(ctx *context.APIContext) {
ctx.APIError(http.StatusConflict, "cannot start a stopwatch again if it already exists")
return
}
notify_service.StopwatchChanged(ctx, ctx.Doer)
ctx.Status(http.StatusCreated)
}
@@ -112,6 +114,7 @@ func StopIssueStopwatch(ctx *context.APIContext) {
ctx.APIError(http.StatusConflict, "cannot stop a non-existent stopwatch")
return
}
notify_service.StopwatchChanged(ctx, ctx.Doer)
ctx.Status(http.StatusCreated)
}
@@ -163,6 +166,7 @@ func DeleteIssueStopwatch(ctx *context.APIContext) {
ctx.APIError(http.StatusConflict, "cannot cancel a non-existent stopwatch")
return
}
notify_service.StopwatchChanged(ctx, ctx.Doer)
ctx.Status(http.StatusNoContent)
}
+2 -2
View File
@@ -12,7 +12,6 @@ import (
"strings"
"time"
activities_model "gitea.dev/models/activities"
git_model "gitea.dev/models/git"
issues_model "gitea.dev/models/issues"
access_model "gitea.dev/models/perm/access"
@@ -41,6 +40,7 @@ import (
git_service "gitea.dev/services/git"
"gitea.dev/services/gitdiff"
issue_service "gitea.dev/services/issue"
"gitea.dev/services/notifications"
notify_service "gitea.dev/services/notify"
pull_service "gitea.dev/services/pull"
repo_service "gitea.dev/services/repository"
@@ -943,7 +943,7 @@ func MergePullRequest(ctx *context.APIContext) {
if ctx.IsSigned {
// Update issue-user.
if err = activities_model.SetIssueReadBy(ctx, pr.Issue.ID, ctx.Doer.ID); err != nil {
if err := notifications.SetIssueReadBy(ctx, pr.Issue.ID, ctx.Doer.ID); err != nil {
ctx.APIErrorInternal(err)
return
}