From b9a7e02ecb5d6b05f9864690aad142d3589ed648 Mon Sep 17 00:00:00 2001
From: Alfonso Acosta <alfonso@stellar.org>
Date: Tue, 18 Jun 2024 20:33:56 +0200
Subject: [PATCH] Add workaround for captive code bug in integration tests

Add a workaround for https://github.com/stellar/go/issues/5342 ,
which is causing a race in integration tests.
---
 .../integrationtest/infrastructure/test.go    | 34 +++++++++++++++----
 1 file changed, 28 insertions(+), 6 deletions(-)

diff --git a/cmd/soroban-rpc/internal/integrationtest/infrastructure/test.go b/cmd/soroban-rpc/internal/integrationtest/infrastructure/test.go
index 820fae41..e54168d0 100644
--- a/cmd/soroban-rpc/internal/integrationtest/infrastructure/test.go
+++ b/cmd/soroban-rpc/internal/integrationtest/infrastructure/test.go
@@ -194,7 +194,7 @@ func (i *Test) spawnContainers() {
 	i.runSuccessfulComposeCommand(upCmd...)
 	if i.runRPCInContainer() {
 		i.rpcContainerLogsCommand = i.getComposeCommand("logs", "--no-log-prefix", "-f", "rpc")
-		writer := testLogWriter{t: i.t, prefix: fmt.Sprintf(`rpc="container" version="%s" `, i.rpcContainerVersion)}
+		writer := newTestLogWriter(i.t, fmt.Sprintf(`rpc="container" version="%s" `, i.rpcContainerVersion))
 		i.rpcContainerLogsCommand.Stdout = writer
 		i.rpcContainerLogsCommand.Stderr = writer
 		require.NoError(i.t, i.rpcContainerLogsCommand.Start())
@@ -397,12 +397,34 @@ func (i *Test) generateRPCConfigFile(rpcConfig rpcConfig) {
 	require.NoError(i.t, err)
 }
 
-type testLogWriter struct {
-	t      *testing.T
-	prefix string
+func newTestLogWriter(t *testing.T, prefix string) *testLogWriter {
+	tw := &testLogWriter{t: t, prefix: prefix}
+	t.Cleanup(func() {
+		tw.testDoneMx.Lock()
+		tw.testDone = true
+		tw.testDoneMx.Unlock()
+	})
+	return tw
 }
 
-func (tw testLogWriter) Write(p []byte) (n int, err error) {
+type testLogWriter struct {
+	t          *testing.T
+	prefix     string
+	testDoneMx sync.RWMutex
+	testDone   bool
+}
+
+func (tw *testLogWriter) Write(p []byte) (n int, err error) {
+	tw.testDoneMx.RLock()
+	if tw.testDone {
+		// Workaround for https://github.com/stellar/go/issues/5342
+		// and https://github.com/stellar/go/issues/5350, which causes a race condition
+		// in test logging
+		// TODO: remove once the tickets are fixed
+		tw.testDoneMx.RUnlock()
+		return len(p), nil
+	}
+	tw.testDoneMx.RUnlock()
 	all := strings.TrimSpace(string(p))
 	lines := strings.Split(all, "\n")
 	for _, l := range lines {
@@ -423,7 +445,7 @@ func (i *Test) createRPCDaemon(c rpcConfig) *daemon.Daemon {
 	cfg.HistoryArchiveUserAgent = fmt.Sprintf("soroban-rpc/%s", config.Version)
 
 	logger := supportlog.New()
-	logger.SetOutput(testLogWriter{t: i.t, prefix: `rpc="daemon" `})
+	logger.SetOutput(newTestLogWriter(i.t, `rpc="daemon" `))
 	return daemon.MustNew(&cfg, logger)
 }