Add Trace statements for StdIn/StdOut/StdErr.

openHPI · Sep 10, 2024 · e89d2e3 · e89d2e3
1 parent 6252699
commit e89d2e3
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/internal/api/ws/codeocean_reader.go b/internal/api/ws/codeocean_reader.go
@@ -2,6 +2,7 @@ package ws
 
 import (
 	"context"
+	"fmt"
 	"io"
 
 	"github.com/gorilla/websocket"
@@ -100,7 +101,7 @@ func handleInput(ctx context.Context, reader io.Reader, buffer chan byte) (done
 		return true
 	}
 
-	log.WithContext(ctx).WithField("message", string(message)).Trace("Received message from client")
+	log.WithContext(ctx).WithField("message", fmt.Sprintf("%q", message)).Trace("Received message from client")
 	for _, character := range message {
 		select {
 		case <-ctx.Done():

diff --git a/internal/nomad/sentry_debug_writer.go b/internal/nomad/sentry_debug_writer.go
@@ -56,6 +56,7 @@ func (s *SentryDebugWriter) Write(debugData []byte) (n int, err error) {
 	if _, err = s.Target.Write([]byte{}); err != nil {
 		return 0, fmt.Errorf("SentryDebugWriter cannot write to target: %w", err)
 	}
+	log.WithContext(s.lastSpan.Context()).WithField("data", fmt.Sprintf("%q", debugData)).Trace("Received data from Nomad container")
 
 	if !timeDebugMessagePatternStart.Match(debugData) {
 		count, err := s.Target.Write(debugData)

diff --git a/internal/nomad/sentry_debug_writer_test.go b/internal/nomad/sentry_debug_writer_test.go
@@ -6,11 +6,11 @@ import (
 
 func (s *MainTestSuite) TestSentryDebugWriter_Write() {
 	buf := &bytes.Buffer{}
-	w := SentryDebugWriter{Target: buf, Ctx: s.TestCtx}
+	debugWriter := NewSentryDebugWriter(s.TestCtx, buf)
 
 	description := "TestDebugMessageDescription"
 	data := "\x1EPoseidon " + description + " 1676646791482\x1E"
-	count, err := w.Write([]byte(data))
+	count, err := debugWriter.Write([]byte(data))
 
 	s.Require().NoError(err)
 	s.Equal(len(data), count)
@@ -19,10 +19,10 @@ func (s *MainTestSuite) TestSentryDebugWriter_Write() {
 
 func (s *MainTestSuite) TestSentryDebugWriter_WriteComposed() {
 	buf := &bytes.Buffer{}
-	w := SentryDebugWriter{Target: buf, Ctx: s.TestCtx}
+	debugWriter := NewSentryDebugWriter(s.TestCtx, buf)
 
 	data := "Hello World!\r\n\x1EPoseidon unset 1678540012404\x1E\x1EPoseidon /sbin/setuser user 1678540012408\x1E"
-	count, err := w.Write([]byte(data))
+	count, err := debugWriter.Write([]byte(data))
 
 	s.Require().NoError(err)
 	s.Equal(len(data), count)

diff --git a/internal/runner/nomad_runner.go b/internal/runner/nomad_runner.go
@@ -245,6 +245,9 @@ func (r *NomadJob) UpdateFileSystem(requestCtx context.Context, copyRequest *dto
 			nomad.ErrExecutorCommunicationFailed,
 			err)
 	}
+	if stdErr.Len() > 0 {
+		log.WithContext(ctx).WithField("stdErr", fmt.Sprintf("%q", stdErr.Bytes())).Trace("Received stdErr from Nomad update fs")
+	}
 	if exitCode != 0 {
 		return fmt.Errorf(
 			"%w: stderr output '%s' and stdout output '%s'",