mirror of
https://github.com/go-gitea/gitea.git
synced 2026-07-28 09:15:18 +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>
268 lines
8.2 KiB
Go
268 lines
8.2 KiB
Go
// Copyright 2018 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package uinotification
|
|
|
|
import (
|
|
"context"
|
|
|
|
activities_model "gitea.dev/models/activities"
|
|
"gitea.dev/models/db"
|
|
issues_model "gitea.dev/models/issues"
|
|
repo_model "gitea.dev/models/repo"
|
|
user_model "gitea.dev/models/user"
|
|
"gitea.dev/modules/container"
|
|
"gitea.dev/modules/graceful"
|
|
"gitea.dev/modules/log"
|
|
"gitea.dev/modules/queue"
|
|
notify_service "gitea.dev/services/notify"
|
|
)
|
|
|
|
type (
|
|
notificationService struct {
|
|
notify_service.NullNotifier
|
|
issueQueue *queue.WorkerPoolQueue[issueNotificationOpts]
|
|
}
|
|
|
|
issueNotificationOpts struct {
|
|
IssueID int64
|
|
CommentID int64
|
|
NotificationAuthorID int64
|
|
ReceiverID int64 // 0 -- ALL Watcher
|
|
}
|
|
)
|
|
|
|
func Init() error {
|
|
notify_service.RegisterNotifier(NewNotifier())
|
|
|
|
return nil
|
|
}
|
|
|
|
var _ notify_service.Notifier = ¬ificationService{}
|
|
|
|
// NewNotifier create a new notificationService notifier
|
|
func NewNotifier() notify_service.Notifier {
|
|
ns := ¬ificationService{}
|
|
ns.issueQueue = queue.CreateSimpleQueue(graceful.GetManager().ShutdownContext(), "notification-service", handler)
|
|
if ns.issueQueue == nil {
|
|
log.Fatal("Unable to create notification-service queue")
|
|
}
|
|
return ns
|
|
}
|
|
|
|
func handler(items ...issueNotificationOpts) []issueNotificationOpts {
|
|
ctx := graceful.GetManager().ShutdownContext()
|
|
for _, opts := range items {
|
|
notifiedIDs, err := activities_model.CreateOrUpdateIssueNotifications(ctx, opts.IssueID, opts.CommentID, opts.NotificationAuthorID, opts.ReceiverID)
|
|
if err != nil {
|
|
log.Error("Was unable to create issue notification: %v", err)
|
|
continue
|
|
}
|
|
for _, userID := range notifiedIDs {
|
|
notify_service.NotificationCountChange(ctx, userID)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (ns *notificationService) Run() {
|
|
go graceful.GetManager().RunWithCancel(ns.issueQueue) // TODO: using "go" here doesn't seem right, just leave it as old code
|
|
}
|
|
|
|
func (ns *notificationService) CreateIssueComment(ctx context.Context, doer *user_model.User, repo *repo_model.Repository,
|
|
issue *issues_model.Issue, comment *issues_model.Comment, mentions []*user_model.User,
|
|
) {
|
|
opts := issueNotificationOpts{
|
|
IssueID: issue.ID,
|
|
NotificationAuthorID: doer.ID,
|
|
}
|
|
if comment != nil {
|
|
opts.CommentID = comment.ID
|
|
}
|
|
_ = ns.issueQueue.Push(opts)
|
|
for _, mention := range mentions {
|
|
opts := issueNotificationOpts{
|
|
IssueID: issue.ID,
|
|
NotificationAuthorID: doer.ID,
|
|
ReceiverID: mention.ID,
|
|
}
|
|
if comment != nil {
|
|
opts.CommentID = comment.ID
|
|
}
|
|
_ = ns.issueQueue.Push(opts)
|
|
}
|
|
}
|
|
|
|
func (ns *notificationService) NewIssue(ctx context.Context, issue *issues_model.Issue, mentions []*user_model.User) {
|
|
_ = ns.issueQueue.Push(issueNotificationOpts{
|
|
IssueID: issue.ID,
|
|
NotificationAuthorID: issue.Poster.ID,
|
|
})
|
|
for _, mention := range mentions {
|
|
_ = ns.issueQueue.Push(issueNotificationOpts{
|
|
IssueID: issue.ID,
|
|
NotificationAuthorID: issue.Poster.ID,
|
|
ReceiverID: mention.ID,
|
|
})
|
|
}
|
|
}
|
|
|
|
func (ns *notificationService) IssueChangeStatus(ctx context.Context, doer *user_model.User, commitID string, issue *issues_model.Issue, actionComment *issues_model.Comment, isClosed bool) {
|
|
_ = ns.issueQueue.Push(issueNotificationOpts{
|
|
IssueID: issue.ID,
|
|
NotificationAuthorID: doer.ID,
|
|
CommentID: actionComment.ID,
|
|
})
|
|
}
|
|
|
|
func (ns *notificationService) IssueChangeTitle(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, oldTitle string) {
|
|
if err := issue.LoadPullRequest(ctx); err != nil {
|
|
log.Error("issue.LoadPullRequest: %v", err)
|
|
return
|
|
}
|
|
if issue.IsPull && issues_model.HasWorkInProgressPrefix(oldTitle) && !issue.PullRequest.IsWorkInProgress(ctx) {
|
|
_ = ns.issueQueue.Push(issueNotificationOpts{
|
|
IssueID: issue.ID,
|
|
NotificationAuthorID: doer.ID,
|
|
})
|
|
}
|
|
}
|
|
|
|
func (ns *notificationService) MergePullRequest(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest) {
|
|
_ = ns.issueQueue.Push(issueNotificationOpts{
|
|
IssueID: pr.Issue.ID,
|
|
NotificationAuthorID: doer.ID,
|
|
})
|
|
}
|
|
|
|
func (ns *notificationService) AutoMergePullRequest(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest) {
|
|
ns.MergePullRequest(ctx, doer, pr)
|
|
}
|
|
|
|
func (ns *notificationService) NewPullRequest(ctx context.Context, pr *issues_model.PullRequest, mentions []*user_model.User) {
|
|
if err := pr.LoadIssue(ctx); err != nil {
|
|
log.Error("Unable to load issue: %d for pr: %d: Error: %v", pr.IssueID, pr.ID, err)
|
|
return
|
|
}
|
|
toNotify := make(container.Set[int64], 32)
|
|
repoWatchers, err := repo_model.GetRepoWatchersIDs(ctx, pr.Issue.RepoID)
|
|
if err != nil {
|
|
log.Error("GetRepoWatchersIDs: %v", err)
|
|
return
|
|
}
|
|
for _, id := range repoWatchers {
|
|
toNotify.Add(id)
|
|
}
|
|
issueParticipants, err := issues_model.GetParticipantsIDsByIssueID(ctx, pr.IssueID)
|
|
if err != nil {
|
|
log.Error("GetParticipantsIDsByIssueID: %v", err)
|
|
return
|
|
}
|
|
for _, id := range issueParticipants {
|
|
toNotify.Add(id)
|
|
}
|
|
delete(toNotify, pr.Issue.PosterID)
|
|
for _, mention := range mentions {
|
|
toNotify.Add(mention.ID)
|
|
}
|
|
for receiverID := range toNotify {
|
|
_ = ns.issueQueue.Push(issueNotificationOpts{
|
|
IssueID: pr.Issue.ID,
|
|
NotificationAuthorID: pr.Issue.PosterID,
|
|
ReceiverID: receiverID,
|
|
})
|
|
}
|
|
}
|
|
|
|
func (ns *notificationService) PullRequestReview(ctx context.Context, pr *issues_model.PullRequest, r *issues_model.Review, c *issues_model.Comment, mentions []*user_model.User) {
|
|
opts := issueNotificationOpts{
|
|
IssueID: pr.Issue.ID,
|
|
NotificationAuthorID: r.Reviewer.ID,
|
|
}
|
|
if c != nil {
|
|
opts.CommentID = c.ID
|
|
}
|
|
_ = ns.issueQueue.Push(opts)
|
|
for _, mention := range mentions {
|
|
opts := issueNotificationOpts{
|
|
IssueID: pr.Issue.ID,
|
|
NotificationAuthorID: r.Reviewer.ID,
|
|
ReceiverID: mention.ID,
|
|
}
|
|
if c != nil {
|
|
opts.CommentID = c.ID
|
|
}
|
|
_ = ns.issueQueue.Push(opts)
|
|
}
|
|
}
|
|
|
|
func (ns *notificationService) PullRequestCodeComment(ctx context.Context, pr *issues_model.PullRequest, c *issues_model.Comment, mentions []*user_model.User) {
|
|
for _, mention := range mentions {
|
|
_ = ns.issueQueue.Push(issueNotificationOpts{
|
|
IssueID: pr.Issue.ID,
|
|
NotificationAuthorID: c.Poster.ID,
|
|
CommentID: c.ID,
|
|
ReceiverID: mention.ID,
|
|
})
|
|
}
|
|
}
|
|
|
|
func (ns *notificationService) PullRequestPushCommits(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest, comment *issues_model.Comment) {
|
|
opts := issueNotificationOpts{
|
|
IssueID: pr.IssueID,
|
|
NotificationAuthorID: doer.ID,
|
|
CommentID: comment.ID,
|
|
}
|
|
_ = ns.issueQueue.Push(opts)
|
|
}
|
|
|
|
func (ns *notificationService) PullReviewDismiss(ctx context.Context, doer *user_model.User, review *issues_model.Review, comment *issues_model.Comment) {
|
|
opts := issueNotificationOpts{
|
|
IssueID: review.IssueID,
|
|
NotificationAuthorID: doer.ID,
|
|
CommentID: comment.ID,
|
|
}
|
|
_ = ns.issueQueue.Push(opts)
|
|
}
|
|
|
|
func (ns *notificationService) IssueChangeAssignee(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, assignee *user_model.User, removed bool, comment *issues_model.Comment) {
|
|
if !removed && doer.ID != assignee.ID {
|
|
opts := issueNotificationOpts{
|
|
IssueID: issue.ID,
|
|
NotificationAuthorID: doer.ID,
|
|
ReceiverID: assignee.ID,
|
|
}
|
|
|
|
if comment != nil {
|
|
opts.CommentID = comment.ID
|
|
}
|
|
|
|
_ = ns.issueQueue.Push(opts)
|
|
}
|
|
}
|
|
|
|
func (ns *notificationService) PullRequestReviewRequest(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, reviewer *user_model.User, isRequest bool, comment *issues_model.Comment) {
|
|
if isRequest {
|
|
opts := issueNotificationOpts{
|
|
IssueID: issue.ID,
|
|
NotificationAuthorID: doer.ID,
|
|
ReceiverID: reviewer.ID,
|
|
}
|
|
|
|
if comment != nil {
|
|
opts.CommentID = comment.ID
|
|
}
|
|
|
|
_ = ns.issueQueue.Push(opts)
|
|
}
|
|
}
|
|
|
|
func (ns *notificationService) RepoPendingTransfer(ctx context.Context, doer, newOwner *user_model.User, repo *repo_model.Repository) {
|
|
err := db.WithTx(ctx, func(ctx context.Context) error {
|
|
return activities_model.CreateRepoTransferNotification(ctx, doer, newOwner, repo)
|
|
})
|
|
if err != nil {
|
|
log.Error("CreateRepoTransferNotification: %v", err)
|
|
}
|
|
}
|