mirror of
https://github.com/go-gitea/gitea.git
synced 2026-08-01 16:24:21 +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>
120 lines
3.0 KiB
Go
120 lines
3.0 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package notify
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
|
|
activities_model "gitea.dev/models/activities"
|
|
"gitea.dev/models/db"
|
|
issues_model "gitea.dev/models/issues"
|
|
"gitea.dev/services/context"
|
|
"gitea.dev/services/convert"
|
|
"gitea.dev/services/notifications"
|
|
)
|
|
|
|
// GetThread get notification by ID
|
|
func GetThread(ctx *context.APIContext) {
|
|
// swagger:operation GET /notifications/threads/{id} notification notifyGetThread
|
|
// ---
|
|
// summary: Get notification thread by ID
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: id
|
|
// in: path
|
|
// description: id of notification thread
|
|
// type: string
|
|
// required: true
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/NotificationThread"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
n := getThread(ctx)
|
|
if n == nil {
|
|
return
|
|
}
|
|
if err := n.LoadAttributes(ctx); err != nil && !issues_model.IsErrCommentNotExist(err) {
|
|
ctx.APIErrorInternal(err)
|
|
return
|
|
}
|
|
|
|
ctx.JSON(http.StatusOK, convert.ToNotificationThread(ctx, n))
|
|
}
|
|
|
|
// ReadThread mark notification as read by ID
|
|
func ReadThread(ctx *context.APIContext) {
|
|
// swagger:operation PATCH /notifications/threads/{id} notification notifyReadThread
|
|
// ---
|
|
// summary: Mark notification thread as read by ID
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: id
|
|
// in: path
|
|
// description: id of notification thread
|
|
// type: string
|
|
// required: true
|
|
// - name: to-status
|
|
// in: query
|
|
// description: Status to mark notifications as
|
|
// type: string
|
|
// default: read
|
|
// required: false
|
|
// responses:
|
|
// "205":
|
|
// "$ref": "#/responses/NotificationThread"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
// "404":
|
|
// "$ref": "#/responses/notFound"
|
|
|
|
n := getThread(ctx)
|
|
if n == nil {
|
|
return
|
|
}
|
|
|
|
targetStatus := statusStringToNotificationStatus(ctx.FormString("to-status"))
|
|
if targetStatus == 0 {
|
|
targetStatus = activities_model.NotificationStatusRead
|
|
}
|
|
|
|
notif, err := notifications.SetNotificationStatus(ctx, n.ID, ctx.Doer, targetStatus)
|
|
if err != nil {
|
|
ctx.APIErrorInternal(err)
|
|
return
|
|
}
|
|
if err = notif.LoadAttributes(ctx); err != nil && !issues_model.IsErrCommentNotExist(err) {
|
|
ctx.APIErrorInternal(err)
|
|
return
|
|
}
|
|
ctx.JSON(http.StatusResetContent, convert.ToNotificationThread(ctx, notif))
|
|
}
|
|
|
|
func getThread(ctx *context.APIContext) *activities_model.Notification {
|
|
n, err := activities_model.GetNotificationByID(ctx, ctx.PathParamInt64("id"))
|
|
if err != nil {
|
|
if db.IsErrNotExist(err) {
|
|
ctx.APIError(http.StatusNotFound, err.Error())
|
|
} else {
|
|
ctx.APIErrorInternal(err)
|
|
}
|
|
return nil
|
|
}
|
|
if n.UserID != ctx.Doer.ID && !ctx.Doer.IsAdmin {
|
|
ctx.APIError(http.StatusForbidden, fmt.Sprintf("only user itself and admin are allowed to read/change this thread %d", n.ID))
|
|
return nil
|
|
}
|
|
return n
|
|
}
|