diff options
| author | Paul Buetow <paul@buetow.org> | 2025-06-26 20:57:53 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2025-06-26 20:57:53 +0300 |
| commit | 4a657e44e7111d7d3b9a9ba5e453901e19af2ecb (patch) | |
| tree | 5cc8571e00a29ab7656633984fb9893ca369ccec /internal/clients | |
| parent | ee5250441a2d241dc1a980dfd051a12f2db898cf (diff) | |
fix: resolve package conflicts and update documentation
- Move main package files to benchmarks/cmd/ to fix test failures
- Update CLAUDE.md with comprehensive benchmarking and profiling instructions
- Fix unused imports in serverless.go
- Remove experimental buffered pipe/copy implementations
- Remove outdated documentation files
All integration tests now pass successfully.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'internal/clients')
| -rw-r--r-- | internal/clients/connectors/serverless.go | 101 | ||||
| -rw-r--r-- | internal/clients/connectors/serverless_test.go | 167 |
2 files changed, 50 insertions, 218 deletions
diff --git a/internal/clients/connectors/serverless.go b/internal/clients/connectors/serverless.go index 7bcff47..7cebf8a 100644 --- a/internal/clients/connectors/serverless.go +++ b/internal/clients/connectors/serverless.go @@ -3,7 +3,6 @@ package connectors import ( "context" "io" - "sync" "github.com/mimecast/dtail/internal/clients/handlers" "github.com/mimecast/dtail/internal/config" @@ -83,47 +82,54 @@ func (s *Serverless) handle(ctx context.Context, cancel context.CancelFunc) erro cancel() } - // Create a sync.WaitGroup to track goroutines - var wg sync.WaitGroup - wg.Add(2) + // Use buffered channels to prevent deadlock + // This approach avoids the circular dependency of direct io.Copy - // Use channels to prevent deadlock - const bufferSize = 32 * 1024 // Smaller chunks for better flow - fromClient := make(chan []byte, 100) // Larger channel buffer - fromServer := make(chan []byte, 100) // Larger channel buffer + // Channels for data flow + toServer := make(chan []byte, 100) + fromServer := make(chan []byte, 100) - // Goroutine 1: Read from client handler, send to channel + // Error tracking + errChan := make(chan error, 4) + + // Read from client handler go func() { - defer wg.Done() - defer close(fromClient) - - buf := make([]byte, bufferSize) + defer close(toServer) + buf := make([]byte, 32*1024) for { n, err := s.handler.Read(buf) if n > 0 { data := make([]byte, n) copy(data, buf[:n]) select { - case fromClient <- data: + case toServer <- data: case <-ctx.Done(): return } } if err != nil { if err != io.EOF { - dlog.Client.Trace("Read from handler error:", err) + errChan <- err } return } } }() - // Goroutine 2: Read from server handler, send to channel + // Write to server handler + go func() { + for data := range toServer { + if _, err := serverHandler.Write(data); err != nil { + errChan <- err + return + } + } + }() + + // Read from server handler go func() { - defer wg.Done() defer close(fromServer) - - buf := make([]byte, bufferSize) + buf := make([]byte, 64*1024) // Larger buffer for server responses for { n, err := serverHandler.Read(buf) if n > 0 { @@ -137,63 +143,56 @@ func (s *Serverless) handle(ctx context.Context, cancel context.CancelFunc) erro } if err != nil { if err != io.EOF { - dlog.Client.Trace("Read from serverHandler error:", err) + errChan <- err } return } } }() - // Goroutine 3: Write from client to server - go func() { - for data := range fromClient { - if _, err := serverHandler.Write(data); err != nil { - dlog.Client.Trace("Write to serverHandler error:", err) - terminate() - return - } - } - }() - - // Goroutine 4: Write from server to client + // Write to client handler + serverDone := make(chan struct{}) go func() { + defer close(serverDone) for data := range fromServer { if _, err := s.handler.Write(data); err != nil { - dlog.Client.Trace("Write to handler error:", err) - terminate() + errChan <- err return } } }() - // Goroutine 5: Monitor for completion + // Send commands after setting up the data flow + for _, command := range s.commands { + dlog.Client.Debug("Sending command to serverless server", command) + if err := s.handler.SendMessage(command); err != nil { + dlog.Client.Debug(err) + } + } + + // Monitor for completion go func() { defer terminate() select { case <-s.handler.Done(): dlog.Client.Trace("<-s.handler.Done()") + case <-serverDone: + dlog.Client.Trace("Server transfer done") case <-ctx.Done(): dlog.Client.Trace("<-ctx.Done()") } }() - - // Send all commands to server - for _, command := range s.commands { - dlog.Client.Debug("Sending command to serverless server", command) - if err := s.handler.SendMessage(command); err != nil { - dlog.Client.Debug(err) - } - } - - // Wait for context to be done - <-ctx.Done() - // Shutdown handlers - dlog.Client.Trace("s.handler.Shutdown()") - s.handler.Shutdown() + // Wait for completion + <-ctx.Done() - // Wait for goroutines to finish - wg.Wait() + // Check for errors + select { + case err := <-errChan: + return err + default: + } + s.handler.Shutdown() return nil } diff --git a/internal/clients/connectors/serverless_test.go b/internal/clients/connectors/serverless_test.go deleted file mode 100644 index fb15acb..0000000 --- a/internal/clients/connectors/serverless_test.go +++ /dev/null @@ -1,167 +0,0 @@ -package connectors - -import ( - "bytes" - "fmt" - "io" - "sync" - "testing" - "time" - - "github.com/mimecast/dtail/internal/io/bufferedpipe" -) - -// TestServerlessDeadlockSimple demonstrates the deadlock issue with io.Copy -func TestServerlessDeadlockSimple(t *testing.T) { - // This test demonstrates the deadlock that occurs with bidirectional io.Copy - // when buffers fill up on both sides - - // Create two pipes to simulate the handler connections - r1, w1 := io.Pipe() - r2, w2 := io.Pipe() - - // Buffer to track completion - var wg sync.WaitGroup - wg.Add(2) - - // Simulate the problematic io.Copy pattern from serverless.go - go func() { - defer wg.Done() - // This simulates: io.Copy(serverHandler, s.handler) - io.Copy(w2, r1) - }() - - go func() { - defer wg.Done() - // This simulates: io.Copy(s.handler, serverHandler) - io.Copy(w1, r2) - }() - - // Try to write a large amount of data - dataSize := 512 * 1024 // 512KB - testData := bytes.Repeat([]byte("x"), dataSize) - - done := make(chan bool) - go func() { - // Try to write data - w1.Write(testData) - w1.Close() - w2.Close() - wg.Wait() - done <- true - }() - - // Wait for completion or timeout - select { - case <-done: - t.Error("Expected deadlock but completed successfully") - case <-time.After(2 * time.Second): - // Expected behavior with current implementation - t.Log("Confirmed: bidirectional io.Copy causes deadlock with large data") - } -} - -// TestBufferedPipeNoDeadlock tests that our fix prevents deadlocks -func TestBufferedPipeNoDeadlock(t *testing.T) { - // Test the buffered pipe approach - bp := bufferedpipe.New(64 * 1024) // 64KB buffer - - // Create two pipes to simulate handler connections - r1, w1 := io.Pipe() - r2, w2 := io.Pipe() - - // Create adapters - adapter1 := &pipeAdapter{r: r1, w: w2} - adapter2 := &pipeAdapter{r: r2, w: w1} - - // Large data that would cause deadlock with direct io.Copy - dataSize := 512 * 1024 // 512KB - testData := bytes.Repeat([]byte("x"), dataSize) - - done := make(chan bool) - go func() { - // Write large data - adapter1.Write(testData) - w1.Close() - w2.Close() - done <- true - }() - - // Connect with buffered pipe - go func() { - bp.ConnectBidirectional(adapter1, adapter2) - }() - - // Read the data - result := make([]byte, dataSize) - go func() { - io.ReadFull(adapter2, result) - }() - - // Should complete without deadlock - select { - case <-done: - t.Log("Success: BufferedPipe prevented deadlock with large data") - case <-time.After(5 * time.Second): - t.Error("BufferedPipe operation timed out - possible deadlock") - } -} - -// pipeAdapter adapts separate read/write pipes to io.ReadWriter -type pipeAdapter struct { - r io.Reader - w io.Writer -} - -func (p *pipeAdapter) Read(b []byte) (int, error) { - return p.r.Read(b) -} - -func (p *pipeAdapter) Write(b []byte) (int, error) { - return p.w.Write(b) -} - -// BenchmarkIOCopyDeadlock measures when deadlock occurs -func BenchmarkIOCopyDeadlock(b *testing.B) { - sizes := []int{ - 1024, // 1KB - should work - 64 * 1024, // 64KB - should work (below typical pipe buffer) - 65 * 1024, // 65KB - might deadlock - 128 * 1024, // 128KB - likely deadlock - } - - for _, size := range sizes { - b.Run(fmt.Sprintf("size_%dKB", size/1024), func(b *testing.B) { - for i := 0; i < b.N; i++ { - r1, w1 := io.Pipe() - r2, w2 := io.Pipe() - - testData := bytes.Repeat([]byte("x"), size) - success := make(chan bool, 1) - - go func() { - io.Copy(w2, r1) - }() - - go func() { - io.Copy(w1, r2) - }() - - go func() { - w1.Write(testData) - w1.Close() - w2.Close() - success <- true - }() - - select { - case <-success: - // Completed successfully - case <-time.After(100 * time.Millisecond): - // Deadlock detected - b.Logf("Deadlock at size %dKB", size/1024) - } - } - }) - } -}
\ No newline at end of file |
