fix: make console writer thread-safe

pluralsh · May 14, 2024 · 3ba87e7 · 3ba87e7
1 parent c005a7a
commit 3ba87e7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/pkg/harness/sink/console.go b/pkg/harness/sink/console.go
@@ -13,6 +13,8 @@ import (
 )
 
 func (in *ConsoleWriter) Write(p []byte) (n int, err error) {
+	in.Lock()
+	defer in.Unlock()
 	n, err = in.buffer.Write(p)
 	in.bufferSizeChan <- in.buffer.Len()
 	return
@@ -26,7 +28,7 @@ func (in *ConsoleWriter) bufferedFlush() {
 		return
 	}
 
-	klog.V(log.LogLevelTrace).InfoS("flushing logs", "buffer_size", n, "limit", in.bufferSizeLimit)
+	klog.V(log.LogLevelTrace).InfoS("flushing buffered logs", "buffer_size", n, "limit", in.bufferSizeLimit, "step_id", in.id)
 	// flush logs
 	read := n
 	if read > in.bufferSizeLimit {
@@ -47,7 +49,7 @@ func (in *ConsoleWriter) flush(ignoreLimit bool) {
 	}
 
 	if ignoreLimit {
-		klog.V(log.LogLevelTrace).InfoS("flushing all remaining logs", "buffer_size", n)
+		klog.V(log.LogLevelTrace).InfoS("flushing all remaining logs", "buffer_size", n, "step_id", in.id)
 		// flush all logs
 		if err := in.client.AddStackRunLogs(in.id, in.buffer.String()); err != nil {
 			klog.Error(err)
@@ -56,7 +58,7 @@ func (in *ConsoleWriter) flush(ignoreLimit bool) {
 	}
 
 	// flush logs up to the limit
-	klog.V(log.LogLevelTrace).InfoS("flushing logs", "buffer_size", n, "limit", in.bufferSizeLimit)
+	klog.V(log.LogLevelTrace).InfoS("flushing logs", "buffer_size", n, "limit", in.bufferSizeLimit, "step_id", in.id)
 	read := n
 	if read > in.bufferSizeLimit {
 		read = in.bufferSizeLimit

diff --git a/pkg/harness/sink/console_types.go b/pkg/harness/sink/console_types.go
@@ -3,6 +3,7 @@ package sink
 import (
 	"bytes"
 	"context"
+	"sync"
 	"time"
 
 	console "github.com/pluralsh/deployment-operator/pkg/client"
@@ -14,6 +15,7 @@ const (
 )
 
 type ConsoleWriter struct {
+	sync.Mutex
 	ctx    context.Context
 	buffer *bytes.Buffer
 	// id is a stack run id that logs should be appended to