Skip to content

⚡ Bolt: [performance improvement] Add sync.Pool for response writer buffers #380

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
rschumann wants to merge 1 commit into
base: main
Choose a base branch
from
Open

⚡ Bolt: [performance improvement] Add sync.Pool for response writer buffers #380

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
21 changes: 19 additions & 2 deletions internal/api/middleware/response_writer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,19 @@ import (
"bytes"
"net/http"
"strings"
"sync"

"github.com/gin-gonic/gin"
"github.com/traylinx/switchAILocal/internal/interfaces"
"github.com/traylinx/switchAILocal/internal/logging"
)

var responseBodyPool = sync.Pool{
New: func() interface{} {
return new(bytes.Buffer)
},
}

// RequestInfo holds essential details of an incoming HTTP request for logging purposes.
type RequestInfo struct {
URL string // URL is the request URL.
Expand Down Expand Up @@ -53,9 +60,11 @@ type ResponseWriterWrapper struct {
// Returns:
// - A pointer to a new ResponseWriterWrapper.
func NewResponseWriterWrapper(w gin.ResponseWriter, logger logging.RequestLogger, requestInfo *RequestInfo) *ResponseWriterWrapper {
buf := responseBodyPool.Get().(*bytes.Buffer)
buf.Reset()
return &ResponseWriterWrapper{
ResponseWriter: w,
body: &bytes.Buffer{},
body: buf,
logger: logger,
requestInfo: requestInfo,
headers: make(map[string][]string),
Expand Down Expand Up @@ -301,7 +310,15 @@ func (w *ResponseWriterWrapper) Finalize(c *gin.Context) error {
return nil
}

return w.logRequest(finalStatusCode, w.cloneHeaders(), w.body.Bytes(), w.extractAPIRequest(c), w.extractAPIResponse(c), slicesAPIResponseError, forceLog)
bodyBytes := w.body.Bytes()
err := w.logRequest(finalStatusCode, w.cloneHeaders(), bodyBytes, w.extractAPIRequest(c), w.extractAPIResponse(c), slicesAPIResponseError, forceLog)

// Return buffer to pool, avoiding memory bloat from occasional massive payloads
if w.body.Cap() <= 128*1024 {
responseBodyPool.Put(w.body)
}

return err
}

func (w *ResponseWriterWrapper) cloneHeaders() map[string][]string {
Expand Down
Loading