[Console] Consider STDIN interactive #33897
Conversation
eca5b0d to
7f35020
Compare
|
AFAICT, this could now make command actually hang when they are running in a place where they are not interactive but you don't explicitly add the flag, for instance on CI. Should we instead add a flag to explicit force interactive mode for case where you want to pipe your own input, rather than never detecting anything and breaking things for cases which were relying on this detection to disable interaction ? Without such detection, adding a question in an existing command becomes a BC break, as it becomes interactive and will hang. |
|
I don't think it will hang with this patch. What's the reproduction scenario for that? |
|
|
|
No it won't, what's reproducer for that? I already asked for that (and didn't get answer) and explained in detail why nothing important breaks in PR description. |
|
I'm reopening and canceling my downvote: I checked out this locally and can't find a situation where the removed logic was useful. Good for 5.0 on my side, could be good for 4.4 also, maybe 3.4. |
7f35020 to
ef157d5
Compare
|
Thank you @ostrolucky. |
This PR was submitted for the master branch but it was merged into the 4.4 branch instead. Discussion ---------- [Console] Consider STDIN interactive | Q | A | ------------- | --- | Branch? |4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #30726, supersedes #30796 | License | MIT | Doc PR | - As demonstrated with `yes | bin/console foo` in #30726, original assumption made in #1699 was wrong. Then, #8452 was merged which solved bug #8079 -> this was a use case when application hangs with `--no-interaction` flag - nobody probably realized that application can be in "non-interactive" mode, without using this flag and not hang. Then, there was #14102 which was poor man's fix for problem caused by this. So already plenty issues this behaviour causes. Looks like a mess to me. Application should be considered non-interactive only when explicitly specified so (--no-interactive flag), otherwise it doesn't hang. ### What this change means? It only changes one case: When doing `echo foo | bin/console bar`, `yes | bin/console bar`, `bin/console bar < foo`, etc. Redirecting stdout is not affected, as application in that case was considered interactive before too. With stdin, this opens possibility to control symfony/console based application by default via stdin, including via `proc_open`. Additionally, not only it allows to control the input for questions, it also makes the question and answers to display on screen. So before, user had no idea what questions are happening and what answers (defaults) are being used. ### About a BC break I'm not really aware of a valid use case this can break. Can you help find any? 1. Since symfony/console components were NOT interactive with stdin before, stdin couldn't be used to control them - so there this change breaks nothing, because it didn't make sense to pass stdin there instead of specifying -n flag. 1. If application uses internal logic where it relies on STDIN disregarding `Output::isInteractive` flag, this doesn't change anything for these either - they will keep using STDIN disregarding result of this flag. 1. What if application uses internal logic for stdin AND console components like QuestionHelper? To me, that doesn't make much sense, because with previous behaviour, such questions would result always into defaults. It might make sense in case application supports both modes - either stdin, or user supplied input and just use default answers with stdin. But I cannot figure out example of such use - what would be the case where application allows user to control something via stdin, but at the same time forbids them to set certain aspects (answers to questions given)? 1. What about `SHELL_INTERACTIVE` env variable? Only way to utilize it was to force enable interactive mode, but since it will be interactive now by default, it will do nothing and no behaviour changes. 1. Preventing stdin control was much bigger potential BC break. Despite that, it was disallowed in minor Symfony version. And as far as I can see, I saw no backlash. Finally, this targets Symfony 5.0 to be extra sure anyways, so I think it's ok, but feel free to suggest documenting this in upgrade guide or changelog. I would even target 4.4, but chose 5.0 as it's easier to push through there. Commits ------- ef157d5 [Console] Consider STDIN interactive
|
It broke all |
|
Would be worth separate issue and more investigation. Does composer pass in empty stdin? 🤔 |
|
See #35988 |
|
this also breaks docker run. this should not be interactive: docker run --rm IMAGE bin/console commandthis should be interactive: docker run --rm -it IMAGE bin/console commandwith this PR, both the above commands make the console interactive. removing consider revert? |
|
Let's stop talking about interactive flag. Console component needs to accept stdin input for controlling its commands, in similar fashion as happens when doing Changing interactive flag itself was just easiest solution to achieve that. Not using it for this purpose would loose its point. Ideally console component shouldn't have it at all. In the end change of semantics of this flag wouldn't make a difference in your case if component stopped using it. Solution here might be to change interactive flag to false before (or during, if not otherwise possible + repeat) first related exception happens ( |
As demonstrated with
yes | bin/console fooin #30726, original assumption made in #1699 was wrong. Then, #8452 was merged which solved bug #8079 -> this was a use case when application hangs with--no-interactionflag - nobody probably realized that application can be in "non-interactive" mode, without using this flag and not hang. Then, there was #14102 which was poor man's fix for problem caused by this. So already plenty issues this behaviour causes. Looks like a mess to me. Application should be considered non-interactive only when explicitly specified so (--no-interactive flag), otherwise it doesn't hang.What this change means?
It only changes one case: When doing
echo foo | bin/console bar,yes | bin/console bar,bin/console bar < foo, etc. Redirecting stdout is not affected, as application in that case was considered interactive before too. With stdin, this opens possibility to control symfony/console based application by default via stdin, including viaproc_open.Additionally, not only it allows to control the input for questions, it also makes the question and answers to display on screen. So before, user had no idea what questions are happening and what answers (defaults) are being used.
About a BC break
I'm not really aware of a valid use case this can break. Can you help find any?
Output::isInteractiveflag, this doesn't change anything for these either - they will keep using STDIN disregarding result of this flag.SHELL_INTERACTIVEenv variable? Only way to utilize it was to force enable interactive mode, but since it will be interactive now by default, it will do nothing and no behaviour changes.Finally, this targets Symfony 5.0 to be extra sure anyways, so I think it's ok, but feel free to suggest documenting this in upgrade guide or changelog. I would even target 4.4, but chose 5.0 as it's easier to push through there.