[Console] progress bar fix #19012

fabpot · 2016-06-09T15:12:40Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#13019
License	MIT
Doc PR	-

This is #16490 where I've simplified the code as much as possible and added a test for the bug we're trying to fix.

The main change is the renaming of the TerminalDimensionsProvider to just Terminal. The new class can probably be useful to add more about the terminal.

stof · 2016-06-09T15:19:05Z

There is still 1 drawback here: as the ProgressBar uses its own Terminal instance, it will ignore any explicit overwrite done in the Application.

stof · 2016-06-09T15:20:46Z

do you want to merge this in 3.2 only or in older branches as a bugfix ?

fabpot · 2016-06-09T15:23:57Z

I'm aware of the drawback. I don't see how to fix this and TBH, I don't think it matters too much as playing with the dimensions should only be done when testing an app.

Only for 3.2.

fabpot · 2016-06-09T15:24:15Z

Added some deprecations now.

stof · 2016-06-09T15:26:30Z

src/Symfony/Component/Console/Application.php

     */
    protected function getTerminalWidth()
    {
-        $dimensions = $this->getTerminalDimensions();
-
-        return $dimensions[0];


please add the deprecation warnings too

javiereguiluz · 2016-06-09T15:28:45Z

The new Symfony\Component\Console\Terminal class is missing in the PR.

fabpot · 2016-06-09T15:41:56Z

added the deprecations and simplified the code again by removing getDimensions().

stof · 2016-06-09T16:10:20Z

src/Symfony/Component/Console/Terminal.php

+    /**
+     * Sets the terminal height.
+     *
+     * @param int


missing param name, makign the phpdoc invalid

nicolas-grekas · 2016-06-09T17:25:21Z

It could be useful to configure width+height with an env var, especially in tests.
This would allow testing commands that hardcode new SymfonyStyle and would replace the stty cols 120 in the .travis.yml file (and could replace the getTerminal extension points and replace related mocks).

fabpot · 2016-06-10T06:27:49Z

@nicolas-grekas Done. I've kept the config in .travis.yml

nicolas-grekas · 2016-06-10T08:21:01Z

LGTM, except a test failure

stof · 2016-06-10T08:39:41Z

src/Symfony/Component/Console/Application.php

-        $this->terminalDimensions = array($width, $height);
+        @trigger_error(sprintf('%s is deprecated as of 3.2 and will be removed in 4.0. Set the ANSICON env var instead.', __METHOD__, ArgumentResolverInterface::class), E_USER_DEPRECATED);
+
+        putenv('ANSICON='.$width.'x'.$height);


this is a bad idea, as it will also impact the detection of color support on Windows

We should support a different env var following the same format if we want to go this way (but keeping support for the ANSICON one for auto-detection)

btw, this code is broken, as it does not invalidate the Terminal cache

What about using COLUMNS and LINES? These are what bash uses (they are magic variables that can be overriden, try echo $COLUMNS).

fabpot · 2016-06-16T13:22:06Z

Broken test on HHVM not related.

nicolas-grekas · 2016-06-16T13:54:53Z

👍 with this patch:

--- a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/UserPasswordEncoderCommandTest.php
+++ b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/UserPasswordEncoderCommandTest.php
@@ -28,6 +28,8 @@ class UserPasswordEncoderCommandTest extends WebTestCase

    public function testEncodePasswordEmptySalt()
    {
+        putenv('COLUMNS=120');
+
        $this->passwordEncoderCommandTester->execute(array(
            'command' => 'security:encode-password',

stof · 2016-06-16T13:54:57Z

@fabpot are you sure ? the failing test is related to line wrapping in commands.

I think one of your Console test does not properly reset the env variables on teardown, and so it impacts subsequent tests. Non-hhvm builds are unaffected because they use a separate PHP process per component to run things in parallel

stof · 2016-06-16T13:57:08Z

src/Symfony/Component/Console/Application.php

+        @trigger_error(sprintf('%s is deprecated as of 3.2 and will be removed in 4.0. Set the COLUMNS and LINES env vars instead.', __METHOD__, ArgumentResolverInterface::class), E_USER_DEPRECATED);
+
+        putenv('COLUMNS='.$width);
+        putenv('LINES='.$height);


this does not work in case the dimensions were already retrieved previously, because of the Terminal internal cache

fabpot · 2016-06-16T16:07:03Z

should be good now :)

nicolas-grekas · 2016-06-17T06:49:06Z

src/Symfony/Component/Console/Terminal.php

+            }
+        }
+
+        if (0 === self::$width) {


not sure this check works: when is this zero?

that's old code, removed.

fabpot · 2016-06-17T17:52:26Z

Thank you @TomasVotruba.

This PR was merged into the 3.2-dev branch. Discussion ---------- [Console] progress bar fix | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #13019 | License | MIT | Doc PR | - This is #16490 where I've simplified the code as much as possible and added a test for the bug we're trying to fix. The main change is the renaming of the `TerminalDimensionsProvider` to just `Terminal`. The new class can probably be useful to add more about the terminal. Commits ------- 2f81247 switched to use COLUMNS and LINES env vars to change terminal dimensions bf7a5c5 fixed logic a589635 deprecated some Console Application methods 8f206c8 fixed CS, simplified code b030c24 [Console] ProgressBar - adjust to the window width (static)

TomasVotruba · 2016-06-17T19:18:00Z

Thank you @fabpot for finishing!

This PR was merged into the 4.0-dev branch. Discussion ---------- [Console] Remove deprecated features | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | yes | Deprecations? | no | Tests pass? | yes | Fixed tickets | ~~#18999 #19012~~ | License | MIT | Doc PR | n/a Commits ------- 4cde3b9 [Console] Remove deprecated features

carsonbot added Status: Needs Review Console Bug labels Jun 9, 2016

fabpot mentioned this pull request Jun 9, 2016

[Console] progress bar fix #16490

Closed

fabpot force-pushed the console-progress-bar-fix branch from 85ee0c8 to db12bb6 Compare June 9, 2016 15:14

stof reviewed Jun 9, 2016
View reviewed changes

fabpot force-pushed the console-progress-bar-fix branch 5 times, most recently from a095d0b to 8d71aff Compare June 9, 2016 15:41

fabpot force-pushed the console-progress-bar-fix branch 3 times, most recently from 9773191 to 5afbdbb Compare June 9, 2016 16:03

stof reviewed Jun 9, 2016
View reviewed changes

src/Symfony/Component/Console/Terminal.php

/**

* Sets the terminal height.

*

* @param int

Copy link

Member

stof Jun 9, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing param name, makign the phpdoc invalid

fabpot force-pushed the console-progress-bar-fix branch 2 times, most recently from 60a2d62 to a38bb97 Compare June 9, 2016 16:26

stof reviewed Jun 10, 2016
View reviewed changes

fabpot force-pushed the console-progress-bar-fix branch from 6e105a8 to 2eeb7bd Compare June 13, 2016 19:50

fabpot force-pushed the console-progress-bar-fix branch 2 times, most recently from 534d825 to c92b2b4 Compare June 16, 2016 13:11

stof reviewed Jun 16, 2016
View reviewed changes

fabpot force-pushed the console-progress-bar-fix branch 4 times, most recently from 660b6e8 to b233974 Compare June 16, 2016 15:54

fabpot force-pushed the console-progress-bar-fix branch from b233974 to 355ad6c Compare June 16, 2016 16:11

nicolas-grekas reviewed Jun 17, 2016
View reviewed changes

fabpot force-pushed the console-progress-bar-fix branch from 355ad6c to dba73e7 Compare June 17, 2016 07:00

TomasVotruba and others added 5 commits June 17, 2016 19:36

[Console] ProgressBar - adjust to the window width (static)

b030c24

fixed CS, simplified code

8f206c8

deprecated some Console Application methods

a589635

fixed logic

bf7a5c5

switched to use COLUMNS and LINES env vars to change terminal dimensions

2f81247

fabpot force-pushed the console-progress-bar-fix branch from dba73e7 to 2f81247 Compare June 17, 2016 17:36

fabpot merged commit 2f81247 into symfony:master Jun 17, 2016

fabpot mentioned this pull request Oct 27, 2016

Release v3.2.0-BETA1 #20317

Merged

chalasr mentioned this pull request May 20, 2017

[Console] Remove deprecated features #22799

Merged

derrabus mentioned this pull request Dec 14, 2023

[Console] ProgressBar behavior (question) #13019

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] progress bar fix #19012

[Console] progress bar fix #19012

fabpot commented Jun 9, 2016 •

edited

Loading

stof commented Jun 9, 2016

stof commented Jun 9, 2016

fabpot commented Jun 9, 2016

fabpot commented Jun 9, 2016

stof Jun 9, 2016

javiereguiluz commented Jun 9, 2016

fabpot commented Jun 9, 2016

stof Jun 9, 2016

nicolas-grekas commented Jun 9, 2016

fabpot commented Jun 10, 2016

nicolas-grekas commented Jun 10, 2016

stof Jun 10, 2016

stof Jun 10, 2016

stof Jun 10, 2016

nicolas-grekas Jun 10, 2016

fabpot commented Jun 16, 2016

nicolas-grekas commented Jun 16, 2016

stof commented Jun 16, 2016

stof Jun 16, 2016

fabpot Jun 16, 2016

fabpot commented Jun 16, 2016

nicolas-grekas Jun 17, 2016

fabpot Jun 17, 2016

fabpot commented Jun 17, 2016

TomasVotruba commented Jun 17, 2016

[Console] progress bar fix #19012

[Console] progress bar fix #19012

Conversation

fabpot commented Jun 9, 2016 • edited Loading

stof commented Jun 9, 2016

stof commented Jun 9, 2016

fabpot commented Jun 9, 2016

fabpot commented Jun 9, 2016

Choose a reason for hiding this comment

javiereguiluz commented Jun 9, 2016

fabpot commented Jun 9, 2016

Choose a reason for hiding this comment

nicolas-grekas commented Jun 9, 2016

fabpot commented Jun 10, 2016

nicolas-grekas commented Jun 10, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Jun 16, 2016

nicolas-grekas commented Jun 16, 2016

stof commented Jun 16, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Jun 16, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Jun 17, 2016

TomasVotruba commented Jun 17, 2016

fabpot commented Jun 9, 2016 •

edited

Loading