mirror of
https://github.com/go-gitea/gitea.git
synced 2026-07-28 01:05:20 +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>
100 lines
2.3 KiB
Go
100 lines
2.3 KiB
Go
// Copyright 2026 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package pubsub
|
|
|
|
import (
|
|
"sync"
|
|
"sync/atomic"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
// TestMemoryBroker runs the shared broker scenarios against MemoryBroker.
|
|
// Memory delivers synchronously and tracks live subscribers exactly.
|
|
func TestMemoryBroker(t *testing.T) {
|
|
testBrokerBasic(t, func(t *testing.T) Broker {
|
|
return NewMemoryBroker()
|
|
}, time.Second)
|
|
}
|
|
|
|
// MemoryBroker tracks live subscribers exactly, so it reports none once the last cancels.
|
|
func TestMemoryBroker_HasNoTopicSubscribers(t *testing.T) {
|
|
b := NewMemoryBroker()
|
|
assert.False(t, b.HasTopicSubscribers("topic"))
|
|
_, cancel := b.Subscribe("topic")
|
|
cancel()
|
|
assert.False(t, b.HasTopicSubscribers("topic"))
|
|
}
|
|
|
|
// Backend-specific: MemoryBroker prunes empty topics from its internal map so
|
|
// idle-user entries don't accumulate.
|
|
func TestMemoryBroker_CancelDeletesEmptyTopic(t *testing.T) {
|
|
b := NewMemoryBroker()
|
|
_, cancel := b.Subscribe("topic")
|
|
cancel()
|
|
b.mu.RLock()
|
|
defer b.mu.RUnlock()
|
|
_, present := b.subs["topic"]
|
|
assert.False(t, present, "empty topic must be removed from the map so idle-user entries don't accumulate")
|
|
}
|
|
|
|
// Backend-specific: stresses MemoryBroker's cancel/Publish mutex interlock that
|
|
// prevents send-on-closed-channel panics.
|
|
func TestMemoryBroker_ConcurrentPublishSubscribeCancel(t *testing.T) {
|
|
b := NewMemoryBroker()
|
|
|
|
const writers = 4
|
|
const readers = 8
|
|
const duration = 200 * time.Millisecond
|
|
|
|
stop := make(chan struct{})
|
|
var wg sync.WaitGroup
|
|
|
|
var published atomic.Int64
|
|
for range writers {
|
|
wg.Go(func() {
|
|
for {
|
|
select {
|
|
case <-stop:
|
|
return
|
|
default:
|
|
b.Publish("topic", []byte("x"))
|
|
published.Add(1)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
for range readers {
|
|
wg.Go(func() {
|
|
for {
|
|
select {
|
|
case <-stop:
|
|
return
|
|
default:
|
|
ch, cancel := b.Subscribe("topic")
|
|
// Drain a few messages then cancel - this exercises the
|
|
// cancel/Publish interlock that prevents send-on-closed.
|
|
for range 3 {
|
|
select {
|
|
case <-ch:
|
|
case <-time.After(10 * time.Millisecond):
|
|
}
|
|
}
|
|
cancel()
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
time.Sleep(duration)
|
|
close(stop)
|
|
wg.Wait()
|
|
|
|
// Test passes if no panic (send on closed channel) and no deadlock.
|
|
assert.Positive(t, published.Load())
|
|
}
|