8000 Optimize SSE build event streaming by analytically · Pull Request #9169 · concourse/concourse · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Optimize SSE build event streaming #9169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Optimize SSE build event streaming #9169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 44 additions & 38 d 8000 eletions atc/api/buildserver/eventhandler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,76 +2,82 @@

import (
"encoding/json"
"fmt"
"io"
"net/http"
"strconv"

"code.cloudfoundry.org/lager/v3"
"github.com/concourse/concourse/atc/db"
"github.com/vito/go-sse/sse"
)

const ProtocolVersionHeader = "X-ATC-Stream-Version"
const CurrentProtocolVersion = "2.0"
const (
ProtocolVersionHeader = "X-ATC-Stream-Version"
CurrentProtocolVersion = "2.0"
)

func NewEventHandler(logger lager.Logger, build db.BuildForAPI) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var eventID uint = 0
if r.Header.Get("Last-Event-ID") != "" {
startString := r.Header.Get("Last-Event-ID")
_, err := fmt.Sscanf(startString, "%d", &eventID)

// Parse Last-Event-ID header
if lastEventID := r.Header.Get("Last-Event-ID"); lastEventID != "" {
parsedID, err := strconv.ParseUint(lastEventID, 10, 64)
if err != nil {
logger.Info("failed-to-parse-last-event-id", lager.Data{"last-event-id": startString})
logger.Info("failed-to-parse-last-event-id", lager.Data{"last-event-id": lastEventID})
w.WriteHeader(http.Statu 8000 sBadRequest)
return
}

eventID++
eventID = uint(parsedID) + 1

Check failure

Code scanning / CodeQL

Incorrect conversion between integer types High

Incorrect conversion of an unsigned 64-bit integer from
strconv.ParseUint
Loading
to a lower bit size type uint without an upper bound check.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're well past 32 bit these days smh

}

w.Header().Add("Content-Type", "text/event-stream; charset=utf-8")
w.Header().Add("Cache-Control", "no-cache, no-store, must-revalidate")
w.Header().Add("X-Accel-Buffering", "no")
w.Header().Add(ProtocolVersionHeader, CurrentProtocolVersion)
// Set response headers
w.Header().Set("Content-Type", "text/event-stream; charset=utf-8")
w.Header().Set("Cache-Control", "no-cache, no-store, must-revalidate")
w.Header().Set("X-Accel-Buffering", "no")
w.Header().Set(ProtocolVersionHeader, CurrentProtocolVersion)

flusher, ok := w.(http.Flusher)
if !ok {
logger.Error("streaming-not-supported", nil)
w.WriteHeader(http.StatusInternalServerError)
return
}

writer := eventWriter{
responseWriter: w,
responseFlusher: w.(http.Flusher),
responseFlusher: flusher,
}

events, err := build.Events(eventID)
if err != nil {
logger.Error("failed-to-get-build-events", err, lager.Data{"build-id": build.ID(), "start": eventID})
logger.Error("failed-to-get-build-events", err, lager.Data{
"build-id": build.ID(),
"start": eventID,
})
w.WriteHeader(http.StatusInternalServerError)
return
}

defer db.Close(events)

for {
logger = logger.WithData(lager.Data{"id": eventID})
contextLogger := logger.WithData(lager.Data{"id": eventID})

ev, err := events.Next()
if err != nil {
if err == db.ErrEndOfBuildEventStream {
err := writer.WriteEnd(eventID)
if err != nil {
logger.Info("failed-to-write-end", lager.Data{"error": err.Error()})
return
if err := writer.WriteEnd(eventID); err != nil {
contextLogger.Info("failed-to-write-end", lager.Data{"error": err.Error()})
}

<-r.Context().Done()
} else {
logger.Error("failed-to-get-next-build-event", err)
return
contextLogger.Error("failed-to-get-next-build-event", err)
}

return
}

err = writer.WriteEvent(eventID, ev)
if err != nil {
logger.Info("failed-to-write-event", lager.Data{"error": err.Error()})
if err := writer.WriteEvent(eventID, ev); err != nil {
contextLogger.Info("failed-to-write-event", lager.Data{"error": err.Error()})
return
}

Expand All @@ -91,30 +97,30 @@
return err
}

err = sse.Event{
ID: fmt.Sprintf("%d", id),
event := sse.Event{
ID: strconv.FormatUint(uint64(id), 10),
Name: "event",
Data: payload,
}.Write(writer.responseWriter)
if err != nil {
}

if err := event.Write(writer.responseWriter); err != nil {
return err
}

writer.responseFlusher.Flush()

return nil
}

func (writer eventWriter) WriteEnd(id uint) error {
err := sse.Event{
ID: fmt.Sprintf("%d", id),
event := sse.Event{
ID: strconv.FormatUint(uint64(id), 10),
Name: "end",
}.Write(writer.responseWriter)
if err != nil {
}

if err := event.Write(writer.responseWriter); err != nil {
return err
}

writer.responseFlusher.Flush()

return nil
}
0