mirror of
https://github.com/go-gitea/gitea.git
synced 2026-08-06 02:26:17 +00:00
silverwind
f9819dbb74
The test raced the server-side SSE channel registration: a logout emitted before registration is silently dropped ([example flake](https://github.com/go-gitea/gitea/actions/runs/29699349255/job/88225654080)). The 500ms wait from https://github.com/go-gitea/gitea/pull/37403 only made this unlikely. The server now registers the channel before sending the initial response bytes, so an open connection implies registration. The shared worker forwards the built-in `open` event (replaying it to late-attaching ports via `EventSource.readyState`), the page exposes it as a `data-user-events-connected` attribute, and the test waits for that attribute instead of a fixed timeout.
125 lines
2.8 KiB
Go
125 lines
2.8 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package events
|
|
|
|
import (
|
|
"net/http"
|
|
"time"
|
|
|
|
"gitea.dev/modules/eventsource"
|
|
"gitea.dev/modules/graceful"
|
|
"gitea.dev/modules/log"
|
|
"gitea.dev/routers/web/auth"
|
|
"gitea.dev/services/context"
|
|
)
|
|
|
|
// Events listens for events
|
|
func Events(ctx *context.Context) {
|
|
// FIXME: Need to check if resp is actually a http.Flusher! - how though?
|
|
|
|
// Set the headers related to event streaming.
|
|
ctx.Resp.Header().Set("Content-Type", "text/event-stream")
|
|
ctx.Resp.Header().Set("Cache-Control", "no-cache")
|
|
ctx.Resp.Header().Set("Connection", "keep-alive")
|
|
ctx.Resp.Header().Set("X-Accel-Buffering", "no")
|
|
ctx.Resp.WriteHeader(http.StatusOK)
|
|
|
|
if !ctx.IsSigned {
|
|
// Return unauthorized status event
|
|
event := &eventsource.Event{
|
|
Name: "close",
|
|
Data: "unauthorized",
|
|
}
|
|
_, _ = event.WriteTo(ctx)
|
|
ctx.Resp.Flush()
|
|
return
|
|
}
|
|
|
|
// Listen to connection close and un-register messageChan
|
|
notify := ctx.Done()
|
|
|
|
shutdownCtx := graceful.GetManager().ShutdownContext()
|
|
|
|
uid := ctx.Doer.ID
|
|
|
|
messageChan := eventsource.GetManager().Register(uid)
|
|
|
|
unregister := func() {
|
|
eventsource.GetManager().Unregister(uid, messageChan)
|
|
// ensure the messageChan is closed
|
|
for {
|
|
_, ok := <-messageChan
|
|
if !ok {
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
// send the initial response bytes only after registering messageChan, so a client whose
|
|
// connection is open can rely on receiving all subsequent events
|
|
if _, err := ctx.Resp.Write([]byte("\n")); err != nil {
|
|
log.Error("Unable to write to EventStream: %v", err)
|
|
unregister()
|
|
return
|
|
}
|
|
ctx.Resp.Flush()
|
|
|
|
timer := time.NewTicker(30 * time.Second)
|
|
|
|
loop:
|
|
for {
|
|
select {
|
|
case <-timer.C:
|
|
event := &eventsource.Event{
|
|
Name: "ping",
|
|
}
|
|
_, err := event.WriteTo(ctx.Resp)
|
|
if err != nil {
|
|
log.Error("Unable to write to EventStream for user %s: %v", ctx.Doer.Name, err)
|
|
go unregister()
|
|
break loop
|
|
}
|
|
ctx.Resp.Flush()
|
|
case <-notify:
|
|
go unregister()
|
|
break loop
|
|
case <-shutdownCtx.Done():
|
|
go unregister()
|
|
break loop
|
|
case event, ok := <-messageChan:
|
|
if !ok {
|
|
break loop
|
|
}
|
|
|
|
// Handle logout
|
|
if event.Name == "logout" {
|
|
if ctx.Session.ID() == event.Data {
|
|
_, _ = (&eventsource.Event{
|
|
Name: "logout",
|
|
Data: "here",
|
|
}).WriteTo(ctx.Resp)
|
|
ctx.Resp.Flush()
|
|
go unregister()
|
|
auth.HandleSignOut(ctx)
|
|
break loop
|
|
}
|
|
// Replace the event - we don't want to expose the session ID to the user
|
|
event = &eventsource.Event{
|
|
Name: "logout",
|
|
Data: "elsewhere",
|
|
}
|
|
}
|
|
|
|
_, err := event.WriteTo(ctx.Resp)
|
|
if err != nil {
|
|
log.Error("Unable to write to EventStream for user %s: %v", ctx.Doer.Name, err)
|
|
go unregister()
|
|
break loop
|
|
}
|
|
ctx.Resp.Flush()
|
|
}
|
|
}
|
|
timer.Stop()
|
|
}
|