feat(sse): support multiple topic subscriptions #2650
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| package service | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/tmaxmax/go-sse" | ||
|
|
||
| revactx "github.com/opencloud-eu/reva/v2/pkg/ctx" | ||
| "github.com/opencloud-eu/reva/v2/pkg/events" | ||
|
|
||
| "github.com/opencloud-eu/opencloud/pkg/log" | ||
| "github.com/opencloud-eu/opencloud/services/sse/pkg/config" | ||
| ) | ||
|
|
||
| const ( | ||
| SSETopicAllUsers = "all" | ||
| ) | ||
|
|
||
| // SSEHandler defines implements the business logic for Service. | ||
| type SSEHandler struct { | ||
| conf *config.Config | ||
| logger log.Logger | ||
| server *sse.Server | ||
| channel <-chan events.Event | ||
| } | ||
|
|
||
| // NewSSEHandler returns a service implementation for Service. | ||
| func NewSSEHandler(ctx context.Context, conf *config.Config, logger log.Logger, ch <-chan events.Event) (SSEHandler, error) { | ||
| handler := SSEHandler{ | ||
| conf: conf, | ||
| logger: logger, | ||
| channel: ch, | ||
| } | ||
|
|
||
| handler.server = &sse.Server{ | ||
| OnSession: func(_ http.ResponseWriter, r *http.Request) (topics []string, allowed bool) { | ||
| return handler.topics(r) | ||
| }, | ||
| } | ||
|
|
||
| go func() { | ||
| select { | ||
| case <-ctx.Done(): | ||
| if err := handler.server.Shutdown(ctx); err != nil { | ||
| logger.Error().Err(err).Msg("failed to shutdown SSE handler") | ||
| } | ||
| return | ||
| } | ||
| }() | ||
|
|
||
| go handler.listen() | ||
|
|
||
| return handler, nil | ||
| } | ||
|
|
||
| // ServeHTTP fulfills Handler interface | ||
| func (h SSEHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) { | ||
| topics, ok := h.topics(r) | ||
| if !ok { | ||
| h.logger.Error().Msg("sse: failed to get topics") | ||
| w.WriteHeader(http.StatusInternalServerError) | ||
| return | ||
| } | ||
|
|
||
| if h.conf.KeepAliveInterval != 0 { | ||
| ticker := time.NewTicker(h.conf.KeepAliveInterval) | ||
| defer ticker.Stop() | ||
| go func() { | ||
| for range ticker.C { | ||
| m := &sse.Message{} | ||
| m.AppendData("keep-alive") | ||
| if err := h.server.Publish(m, topics...); err != nil { | ||
| h.logger.Error().Err(err).Msg("sse: failed to publish message") | ||
| } | ||
| } | ||
| }() | ||
| } | ||
|
Comment on lines
+67
to
+79
There was a problem hiding this comment. 🔴 HIGH RISK The current keep-alive implementation has significant performance and resource issues:
Refactoring Suggestion: Move the keep-alive logic to a single background goroutine in |
||
|
|
||
| h.server.ServeHTTP(w, r) | ||
| } | ||
|
|
||
| // ListenForEvents listens for events | ||
| func (h SSEHandler) listen() { | ||
| for e := range h.channel { | ||
| switch ev := e.Event.(type) { | ||
| default: | ||
| h.logger.Error().Interface("event", ev).Msg("unhandled event") | ||
| case events.SendSSE: | ||
| m := &sse.Message{ | ||
| Type: sse.Type(ev.Type), | ||
| } | ||
| m.AppendData(string(ev.Message)) | ||
| if err := h.server.Publish(m, ev.UserIDs...); err != nil { | ||
| h.logger.Error().Err(err).Msg("sse: failed to publish message") | ||
| } | ||
| } | ||
| } | ||
|
Comment on lines
+85
to
+99
There was a problem hiding this comment. 🟡 MEDIUM RISK The |
||
| } | ||
|
|
||
| func (h SSEHandler) topics(r *http.Request) ([]string, bool) { | ||
| u, ok := revactx.ContextGetUser(r.Context()) | ||
| if !ok { | ||
| return nil, false | ||
| } | ||
|
|
||
| uid := u.GetId().GetOpaqueId() | ||
| if uid == "" { | ||
| return nil, false | ||
| } | ||
|
|
||
| return append([]string{SSETopicAllUsers}, uid), true | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 MEDIUM RISK
Suggestion: Using the already-cancelled
ctxforShutdownwill prevent the server from waiting for active connections to drain. Use a fresh context with a timeout.