mirror of
https://github.com/go-gitea/gitea.git
synced 2026-07-28 17:25:17 +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>
100 lines
3.1 KiB
Go
100 lines
3.1 KiB
Go
// Copyright 2025 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
//go:build goexperiment.jsonv2
|
|
|
|
package json
|
|
|
|
import (
|
|
"bytes"
|
|
jsonv1 "encoding/json" //nolint:depguard // this package wraps it
|
|
"encoding/json/jsontext" //nolint:depguard // this package wraps it
|
|
jsonv2 "encoding/json/v2" //nolint:depguard // this package wraps it
|
|
"io"
|
|
)
|
|
|
|
// JSONv2 implements Interface via encoding/json/v2
|
|
// Requires GOEXPERIMENT=jsonv2 to be set at build time
|
|
type JSONv2 struct {
|
|
marshalOptions jsonv2.Options
|
|
marshalKeepOptionalEmptyOptions jsonv2.Options
|
|
unmarshalOptions jsonv2.Options
|
|
unmarshalCaseInsensitiveOptions jsonv2.Options
|
|
}
|
|
|
|
var jsonV2 JSONv2
|
|
|
|
func init() {
|
|
commonMarshalOptions := []jsonv2.Options{
|
|
jsonv2.FormatNilSliceAsNull(true),
|
|
jsonv2.FormatNilMapAsNull(true),
|
|
}
|
|
jsonV2.marshalOptions = jsonv2.JoinOptions(commonMarshalOptions...)
|
|
jsonV2.unmarshalOptions = jsonv2.DefaultOptionsV2()
|
|
|
|
// By default, "json/v2" omitempty removes all `""` empty strings, no matter where it comes from.
|
|
// v1 has a different behavior: if the `""` is from a null pointer, or a Marshal function, it is kept.
|
|
// Golang issue: https://github.com/golang/go/issues/75623 encoding/json/v2: unable to make omitempty work with pointer or Optional type with goexperiment.jsonv2
|
|
jsonV2.marshalKeepOptionalEmptyOptions = jsonv2.JoinOptions(append(commonMarshalOptions, jsonv1.OmitEmptyWithLegacySemantics(true))...)
|
|
|
|
// Some legacy code uses case-insensitive matching (for example: parsing oci.ImageConfig)
|
|
jsonV2.unmarshalCaseInsensitiveOptions = jsonv2.JoinOptions(jsonv2.MatchCaseInsensitiveNames(true))
|
|
}
|
|
|
|
func getDefaultJSONHandler() Interface {
|
|
return &jsonV2
|
|
}
|
|
|
|
func MarshalKeepOptionalEmpty(v any) ([]byte, error) {
|
|
return jsonv2.Marshal(v, jsonV2.marshalKeepOptionalEmptyOptions)
|
|
}
|
|
|
|
func (j *JSONv2) Marshal(v any) ([]byte, error) {
|
|
return jsonv2.Marshal(v, j.marshalOptions)
|
|
}
|
|
|
|
func (j *JSONv2) MarshalWrite(w io.Writer, v any) error {
|
|
return jsonv2.MarshalWrite(w, v, j.marshalOptions)
|
|
}
|
|
|
|
func (j *JSONv2) Unmarshal(data []byte, v any) error {
|
|
return jsonv2.Unmarshal(data, v, j.unmarshalOptions)
|
|
}
|
|
|
|
func (j *JSONv2) NewEncoder(writer io.Writer) Encoder {
|
|
return &jsonV2Encoder{writer: writer, opts: j.marshalOptions}
|
|
}
|
|
|
|
func (j *JSONv2) NewDecoder(reader io.Reader) Decoder {
|
|
return &jsonV2Decoder{reader: reader, opts: j.unmarshalOptions}
|
|
}
|
|
|
|
// Indent implements Interface using standard library (JSON v2 doesn't have Indent yet)
|
|
func (*JSONv2) Indent(dst *bytes.Buffer, src []byte, prefix, indent string) error {
|
|
return jsonv1.Indent(dst, src, prefix, indent)
|
|
}
|
|
|
|
type jsonV2Encoder struct {
|
|
writer io.Writer
|
|
opts jsonv2.Options
|
|
}
|
|
|
|
func (e *jsonV2Encoder) Encode(v any) error {
|
|
return jsonv2.MarshalWrite(e.writer, v, e.opts)
|
|
}
|
|
|
|
type jsonV2Decoder struct {
|
|
reader io.Reader
|
|
opts jsonv2.Options
|
|
}
|
|
|
|
func (d *jsonV2Decoder) Decode(v any) error {
|
|
return jsonv2.UnmarshalRead(d.reader, v, d.opts)
|
|
}
|
|
|
|
func NewDecoderCaseInsensitive(reader io.Reader) Decoder {
|
|
return &jsonV2Decoder{reader: reader, opts: jsonV2.unmarshalCaseInsensitiveOptions}
|
|
}
|
|
|
|
type Value = jsontext.Value
|