Skip to content

Refactor PTTY handling in compose commands #1924

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

Merged
merged 5 commits into from
Jun 26, 2024
Merged

Refactor PTTY handling in compose commands #1924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0332be6
Refactor PTTY handling in compose commands
jsoriano Jun 20, 2024
621c6c1
Hide stdout if verbose mode is disabled
jsoriano Jun 20, 2024
47bfd8f
Print pty stats before running command
jsoriano Jun 24, 2024
04cae7a
Downgrade pty package
jsoriano Jun 25, 2024
0696bb1
Revert "Print pty stats before running command"
jsoriano Jun 25, 2024
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
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ require (
github.com/boumenot/gocover-cobertura v1.2.0
github.com/cbroglie/mustache v1.4.0
github.com/cespare/xxhash/v2 v2.3.0
github.com/creack/pty v1.1.21
github.com/creack/pty v1.1.19
github.com/dustin/go-humanize v1.0.1
github.com/elastic/elastic-integration-corpus-generator-tool v0.10.0
github.com/elastic/go-elasticsearch/v7 v7.17.10
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ github.com/cloudflare/circl v1.3.7/go.mod h1:sRTcRWXGLrKw6yIGJ+l7amYJFfAXbZG0kBS
github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/creack/pty v1.1.17/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4=
github.com/creack/pty v1.1.21 h1:1/QdRyBaHHJP61QkWMXlOIBfsgdDeeKfK8SYVUWJKf0=
github.com/creack/pty v1.1.21/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4=
github.com/creack/pty v1.1.19 h1:tUN6H7LWqNx4hQVxomd0CVsDwaDr9gaRQaI4GpSmrsA=
github.com/creack/pty v1.1.19/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4=
github.com/creasty/defaults v1.7.0 h1:eNdqZvc5B509z18lD8yc212CAqJNvfT1Jq6L8WowdBA=
github.com/creasty/defaults v1.7.0/go.mod h1:iGzKe6pbEHnpMPtfDXZEr0NVxWnPTjb1bbDy08fPzYM=
github.com/cyphar/filepath-securejoin v0.2.4 h1:Ugdm7cg7i6ZK6x3xDF1oEu1nfkyfH53EtKeQYTC3kyg=
Expand Down
28 changes: 8 additions & 20 deletions internal/compose/compose_other.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import (
"io"
"os"
"os/exec"
"sync"

"github.com/creack/pty"

Expand All @@ -30,14 +29,9 @@ func (p *Project) runDockerComposeCmd(ctx context.Context, opts dockerComposeOpt
}
cmd.Env = append(os.Environ(), opts.env...)

ptty, tty, err := pty.Open()
if err != nil {
return fmt.Errorf("failed to open pseudo-tty to capture stderr: %w", err)
}

var errBuffer bytes.Buffer
cmd.Stderr = tty
var stderr io.Writer = &errBuffer
cmd.Stdout = io.Discard
if logger.IsDebugMode() {
cmd.Stdout = os.Stdout
stderr = io.MultiWriter(&errBuffer, os.Stderr)
Expand All @@ -46,22 +40,16 @@ func (p *Project) runDockerComposeCmd(ctx context.Context, opts dockerComposeOpt
cmd.Stdout = opts.stdout
}

var wg sync.WaitGroup
wg.Add(1)
go func() {
defer wg.Done()
io.Copy(stderr, ptty)
}()

ptty, err := pty.Start(cmd)
if err != nil {
return fmt.Errorf("failed to start command with pseudo-tty: %w", err)
}
defer ptty.Close()
logger.Debugf("running command: %s", cmd)
err = cmd.Run()
tty.Close()
wg.Wait()

// Don't close the PTTY before the goroutine with the Copy has finished.
ptty.Close()
io.Copy(stderr, ptty)

if err != nil {
if err := cmd.Wait(); err != nil {
if msg := cleanComposeError(errBuffer.String()); len(msg) > 0 {
return fmt.Errorf("%w: %s", err, msg)
}
Expand Down