cmd/prompt: remove uses of github.com/AlecAivazis/survey/v2 by thaJeztah · Pull Request #14161 · docker/compose

thaJeztah · 2026-09-01T18:12:22Z

taken from cmd/prompt: use ReadString instead of Fscanln, fix default value, and remove uses github.com/AlecAivazis/survey/v2 #13900

cmd/prompt: remove uses of github.com/AlecAivazis/survey/v2

The github.com/AlecAivazis/survey/v2 module was archived and is no longer
maintained. Looking at the code, we didn't really use most of its features;
survey mostly provided terminal input handling around a simple yes/no
question.

Replace the interactive confirmation implementation with a small local
prompt reader while keeping the exported prompt types and existing
non-terminal prompt behavior unchanged. Preserve the confirmation hint,
default handling, retries for invalid input, and Ctrl+C handling.

Interactive prompts continue to use raw terminal input so Ctrl+C is handled
by the prompt instead of requiring a second interrupt to terminate the
process.

What I did

Related issue

(not mandatory) A picture of a cute animal, if possible in relation to what you did

docker-agent

Assessment: 🟡 NEEDS ATTENTION

This PR cleanly removes the archived survey/v2 dependency and replaces it with a minimal local line-based implementation. The overall approach is sound. Two behavioral regressions in the new confirm() function are worth addressing before merge.

glours

I confirm the 2 catches made by @docker-agent and found a 3rd one

glours · 2026-09-02T13:17:07Z

+func confirm(stdin *bufio.Reader, stdout io.Writer, message string, defaultValue bool) (bool, error) {
+	_, _ = fmt.Fprint(stdout, message)
+
+	answer, err := stdin.ReadString('\n')


This blocking read has no way to observe cancellation. Since AdaptCmd's SIGINT handler (cmd/compose/compose.go:112) now intercepts Ctrl+C to cancel the context instead of letting the OS kill the process, a single Ctrl+C at a prompt no longer aborts it, the read stays blocked here and a second Ctrl+C is needed to actually terminate.
survey's raw-mode reader handled this internally (ISIG disabled, Ctrl+C caught as a keypress).

thaJeztah · 2026-09-02T13:23:47Z

Ah, yes, I need to look at this one; I thought I'd move this separate, but didn't look too closely yet 😂

docker-agent

Assessment: 🟢 APPROVE

The PR correctly removes the archived github.com/AlecAivazis/survey/v2 dependency and replaces it with golang.org/x/term. The core Confirm implementation is structurally sound: SetRawTerminal / defer RestoreTerminal is safe, term.NewTerminal usage is idiomatic, the error propagation path is correct, and go.mod properly promotes golang.org/x/term from indirect to direct. The new tests cover the happy path, invalid-input retry, and Ctrl+C interruption.

Lower-confidence findings (not posted inline)

[medium → verified low] cmd/prompt/prompt.go:94 — Ctrl+C handling relies on term.ReadLine returning io.EOF on byte 0x03; if golang.org/x/term changes this behaviour in a future release the loop would spin indefinitely until the TTY is closed. Currently working as intended in v0.45.0 — the verifier assessed this as speculative/low, score 40/100 (🟠 weak). No action required now; worth a comment in the code or a version note in go.mod if the team wants to guard against it long-term.

thaJeztah · 2026-09-05T12:19:11Z

if golang.org/x/term changes this behaviour in a future release the loop would spin indefinitely until the TTY is closed. Currently working as intended in v0.45.0

Yeah, not fixing that; we have tests, and they shouldn't break behavior.

codecov · 2026-09-05T12:35:22Z

Codecov Report

❌ Patch coverage is 71.42857% with 6 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
cmd/prompt/prompt.go	71.42%	5 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

thaJeztah · 2026-09-08T14:07:16Z

Rebased; probably should be OK for review now 😅

ndeloof

Legitimate change, worth landing: survey/v2 is archived, compose only used a yes/no out of it, and this drops five transitive dependencies while promoting an already-present x/term. Exported API intact, non-terminal Pipe path untouched, the pty-backed tests cover the right level, deferred RestoreTerminal covers error paths, and the retry/Enter-default semantics match survey.

One real compatibility regression and two smaller notes, inline. On top of those, one thing CI cannot tell us: the interactive path now goes through streams SetRawTerminal + x/term.Terminal on a Windows console, a different plumbing than survey's (go-colorable); the pty tests only exercise unix. Worth one manual check on Windows before merge, or a note in the description.

ndeloof · 2026-09-09T06:17:59Z

@@ -74,17 +75,34 @@ func (s streamsFileReader) Fd() uintptr {

 // Confirm asks for yes or no input
 func (u User) Confirm(message string, defaultValue bool) (bool, error) {


The "(y/N)" hint survey auto-appended is lost, and three call sites relied on it — the description's "current callers already include the confirmation hint" holds for the two prompts in cmd/compose/options.go only. These don't carry any hint in their message:

pkg/compose/publish.go — "Are you ok to publish these bind mount declarations?" and "…these sensitive data?" (via confirmOrCancel);

pkg/bridge/convert.go — "Output directory … will be permanently deleted. Continue?".

After this change those render as a bare question: the user no longer sees the expected input format nor the default — on destructive confirmations. Minimal fix that preserves every caller at once: have Confirm append " [y/N]: " / " [Y/n]: " (per defaultValue) when the message doesn't already end with a hint; alternatively, fix the three messages in this same PR.

If you go with option 2 (fixing individual messages rather than the centralized approach), don't miss two more call sites through the same Confirm with the same bare-question issue:

pkg/compose/publish.go:619 — buildEnvPromptMessage: "...Are you ok to publish these env declarations?"

pkg/compose/publish.go:629 — buildConfigContentPromptMessage: "...Are you ok to publish these config contents?"

The github.com/AlecAivazis/survey/v2 module was archived and is no longer maintained. Looking at the code, we didn't really use most of its features; survey mostly provided terminal input handling around a simple yes/no question. Replace the interactive confirmation implementation with a small local prompt reader while keeping the exported prompt types and existing non-terminal prompt behavior unchanged. Preserve the confirmation hint, default handling, retries for invalid input, and Ctrl+C handling. Interactive prompts continue to use raw terminal input so Ctrl+C is handled by the prompt instead of requiring a second interrupt to terminate the process. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah · 2026-09-09T20:34:51Z

🤔 Hm...

(Reading database ... 201598 files and directories currently installed.)
Purging configuration files for docker-ce (5:28.0.4-1~ubuntu.24.04~noble) ...
dpkg: warning: while removing docker-ce, directory '/usr/libexec/docker' not empty so not removed
Purging configuration files for containerd.io (2.3.4-2~ubuntu.24.04~noble) ...
Reading package lists...
Building dependency tree...
Reading state information...
curl is already the newest version (8.5.0-2ubuntu10.13).
0 upgraded, 0 newly installed, 0 to remove and 1 not upgraded.
# Executing docker install script, commit: 4e16be805b3af595aa448d1a4def857841f1c62c
+ sh -c apt-get -qq update >/dev/null
E: Failed to fetch https://dl.google.com/linux/chrome-stable/deb/dists/stable/main/binary-amd64/Packages.gz  Hash Sum mismatch
   Hashes of expected file:
    - Filesize:1405 [weak]
    - SHA256:233e56de019b57db89238fa7bcc3647718dbbea3a40c2dc1c633a8c8952aa9e9
    - SHA1:f25f722f552dc3fd510081e6b65a0e7174ec9321 [weak]
    - MD5Sum:2fc39e32c7bdf718a907c390338392ea [weak]
   Hashes of received file:
    - SHA256:bc1428ab27c6d76ee9bb76de07f1ded0ddb4aaabd958fc72855634ef5894a4b3
    - SHA1:f601c49edc3ea059583213f0be1589cb0fa6e2e5 [weak]
    - MD5Sum:2ce0a26fc7a49a488341fc13c6d05b52 [weak]
    - Filesize:1405 [weak]
   Last modification reported: Wed, 09 Sep 2026 09:41:12 +0000
   Release file created at: Wed, 09 Sep 2026 17:16:59 +0000
E: Some index files failed to download. They have been ignored, or old ones used instead.
Error: Process completed with exit code 100.

thaJeztah requested review from a team as code owners September 1, 2026 18:12

thaJeztah requested review from glours and ndeloof September 1, 2026 18:12

thaJeztah force-pushed the rm_survey branch from 8fe8459 to 8e20cce Compare September 1, 2026 18:14

docker-agent reviewed Sep 1, 2026

View reviewed changes

Comment thread cmd/prompt/prompt.go Outdated

Comment thread cmd/prompt/prompt.go Outdated

glours requested changes Sep 2, 2026

View reviewed changes

thaJeztah force-pushed the rm_survey branch 2 times, most recently from bed0960 to e61e69a Compare September 5, 2026 12:09

thaJeztah requested a review from docker-agent September 5, 2026 12:09

docker-agent reviewed Sep 5, 2026

View reviewed changes

thaJeztah force-pushed the rm_survey branch from e61e69a to 3b8ee52 Compare September 5, 2026 12:16

thaJeztah force-pushed the rm_survey branch from 3b8ee52 to 363d60d Compare September 5, 2026 12:23

thaJeztah force-pushed the rm_survey branch from 363d60d to 6463e95 Compare September 8, 2026 14:06

ndeloof reviewed Sep 9, 2026

View reviewed changes

thaJeztah force-pushed the rm_survey branch from 6463e95 to 9872921 Compare September 9, 2026 17:47

		@@ -74,17 +75,34 @@ func (s streamsFileReader) Fd() uintptr {

		// Confirm asks for yes or no input
		func (u User) Confirm(message string, defaultValue bool) (bool, error) {

Uh oh!

Conversation

thaJeztah commented Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!