mirror of
https://github.com/go-gitea/gitea
synced 2026-07-27 17:28:57 +00: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>
79 lines
2.0 KiB
Go
79 lines
2.0 KiB
Go
// Copyright 2026 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package test
|
|
|
|
import (
|
|
"net"
|
|
"os"
|
|
"os/exec"
|
|
"time"
|
|
)
|
|
|
|
const (
|
|
testRedisHost = "127.0.0.1"
|
|
testRedisPort = "6379"
|
|
testRedisAddr = testRedisHost + ":" + testRedisPort
|
|
testRedisConnStr = "redis://" + testRedisAddr + "/0"
|
|
)
|
|
|
|
// waitRedisReady reports whether redis accepts connections within dur. Redis
|
|
// binds its listener last during startup, so a successful dial means it can
|
|
// serve. A plain dial, not a redis PING: the client retries its pool on a
|
|
// refused connect, which makes the "is one already running" probe take ~1s.
|
|
func waitRedisReady(dur time.Duration) bool {
|
|
for start := time.Now(); ; time.Sleep(50 * time.Millisecond) {
|
|
conn, err := net.DialTimeout("tcp", testRedisAddr, time.Second)
|
|
if err == nil {
|
|
_ = conn.Close()
|
|
return true
|
|
}
|
|
if time.Since(start) > dur {
|
|
return false
|
|
}
|
|
}
|
|
}
|
|
|
|
func redisServerCmd(t TestingT) *exec.Cmd {
|
|
redisServerProg, err := exec.LookPath("redis-server")
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
return &exec.Cmd{
|
|
Path: redisServerProg,
|
|
Args: []string{redisServerProg, "--bind", testRedisHost, "--port", testRedisPort},
|
|
Dir: t.TempDir(),
|
|
Stdin: os.Stdin,
|
|
Stdout: os.Stdout,
|
|
Stderr: os.Stderr,
|
|
}
|
|
}
|
|
|
|
// PrepareTestRedis returns a connection string to a running redis, starting one
|
|
// for the duration of the test if the port is free.
|
|
func PrepareTestRedis(t TestingT) string {
|
|
if waitRedisReady(0) {
|
|
return testRedisConnStr
|
|
}
|
|
redisServer := redisServerCmd(t)
|
|
if redisServer == nil {
|
|
if AllowSkipExternalService() {
|
|
t.Skipf("redis-server command not found, skipped")
|
|
} else {
|
|
t.Fatalf("no redis server or command, but skipping is not allowed")
|
|
}
|
|
return testRedisConnStr
|
|
}
|
|
if err := redisServer.Start(); err != nil {
|
|
t.Fatalf("failed to start redis-server: %v", err)
|
|
}
|
|
t.Cleanup(func() {
|
|
_ = redisServer.Process.Signal(os.Interrupt)
|
|
_ = redisServer.Wait()
|
|
})
|
|
if !waitRedisReady(5 * time.Second) {
|
|
t.Fatalf("failed to start redis-server")
|
|
}
|
|
return testRedisConnStr
|
|
}
|