[Console] Add progress indicator helper #12119

kbond · 2014-10-03T19:15:46Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	todo

This is an alternative to the ProgressBar helper without a max inspired by the npm cli. You can use the ProgressBar but IMO it doesn't look great or fallback nicely in non-ansi environments.

A lot of work needs to be done still but thought I would get some comments on this idea.

Example code

$progress = new ProgressIndicator($output);
$progress->start('Starting...');

for ($i = 0; $i < 100; $i++) {
    usleep(25000);
    $progress->advance();

    switch ($i) {
        case 20:
            $progress->setMessage('Just started...');
            break;
        case 50:
            $progress->setMessage('Half way...');
            break;
        case 90:
            $progress->setMessage('Almost Done...');
            break;
    }
}

$progress->finish('Done.');

Screenshot

Nicofuma · 2014-10-05T10:56:30Z

It could be helpfull

fabpot · 2015-09-14T08:00:48Z

@kbond Still willing to finish this one? I think this is indeed a good idea.

kbond · 2015-09-14T14:17:17Z

@fabpot sure, I rebased and fixed some CS issues.

One thing I noticed with the animation is it sometimes looks strange - you can see it in the above gif after the "Half way..." message it just alternates between / and \ only. I wonder if we should use some kind of timer to ensure the animation is smooth...?

Anyway, anything that needs to be changed/fixed, let me know.

keradus · 2015-09-23T16:28:01Z

Tests fail on Windows: https://ci.appveyor.com/project/fabpot/symfony/build/1.0.846/job/vcf2cxf0l2wxw52s#L550 , could you help with that?

kbond · 2015-09-23T16:41:15Z

It can't be from the PR - I haven't added any tests yet.

fabpot · 2015-10-06T16:00:17Z

@kbond Can you add some tests?

kbond · 2015-10-06T18:49:43Z

@fabpot added.

kbond · 2015-10-09T14:05:41Z

I rebased to master. The console component's tests are failing but is unrelated to this PR.

Taluu · 2015-10-09T14:28:36Z

src/Symfony/Component/Console/Helper/ProgressIndicator.php

+            $this->indicatorCurrent = 0;
+        } else {
+            ++$this->indicatorCurrent;
+        }


I would just do a simple incrementation here (++$this->indicatorCurrent;), and then use a modulo where it is used.

kbond · 2015-10-09T17:07:42Z

I added a speed trap so the indicator doesn't change more than once per 100 (default) milliseconds.

fabpot · 2015-10-11T09:46:14Z

src/Symfony/Component/Console/Helper/ProgressIndicator.php

+     */
+    public function getStartTime()
+    {
+        return $this->startTime;


Start time can probably be removed altogether as it's not used anywhere. It's useful in the progress bar as we display time information, but as this is not the case here, I don't see how it can be useful. Or would it be useful to add the possibility to add the elapsed time in the format?

…king

kbond · 2015-10-13T12:47:32Z

To make the indicator immutable, should I remove some public setters? setFormat, setIndicatorChangeInterval, setIndicatorValues could be moved to the constructor. The user could potentially change these values during rendering and that could cause problems.

fabpot · 2015-10-13T14:37:04Z

👍 for making it immutable; if the list of arguments on the constructor is too large, you can also keep the setter but throw an exception when used after the indicator is started.

stof · 2015-10-13T14:50:18Z

I agree with @fabpot. changing the display in the middle does not make much sense to me (and could even cause issues).

kbond · 2015-10-13T15:11:45Z

Ok, I made it immutable and ensured it can be used multiple times per instance.

Unless there are any other changes, this is good to go.

fabpot · 2015-10-13T15:32:25Z

src/Symfony/Component/Console/Helper/ProgressIndicator.php

+     * Gets the current indicator message.
+     *
+     * @return string|null
+     */


This one is also internal, right?

Just getMessage - I will mark as such. Unless you want me to remove setMessage and just use advance to set a new message.

fabpot · 2015-10-13T15:42:42Z

👍

fabpot · 2015-10-19T12:18:02Z

@kbond Looks like the tests on Windows do not pass.

kbond · 2015-10-19T12:23:42Z

Damn, ok I will have a look. It's hard to see what the problem is from the output.

kbond · 2015-10-19T19:21:10Z

Tests on Windows are passing now!

fabpot · 2015-10-19T21:13:54Z

Thank you @kbond.

This PR was squashed before being merged into the 3.0-dev branch (closes #12119). Discussion ---------- [Console] Add progress indicator helper | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | *todo* This is an alternative to the `ProgressBar` helper *without a max* inspired by the `npm` cli. You can use the `ProgressBar` but IMO it doesn't look great or fallback nicely in non-ansi environments. A lot of work needs to be done still but thought I would get some comments on this idea. ##### Example code ```php $progress = new ProgressIndicator($output); $progress->start('Starting...'); for ($i = 0; $i < 100; $i++) { usleep(25000); $progress->advance(); switch ($i) { case 20: $progress->setMessage('Just started...'); break; case 50: $progress->setMessage('Half way...'); break; case 90: $progress->setMessage('Almost Done...'); break; } } $progress->finish('Done.'); ``` ##### Screenshot ![output](https://cloud.githubusercontent.com/assets/127811/4511167/95302026-4b31-11e4-824e-5cb26f96e4cb.gif) Commits ------- abf389c [Console] Add progress indicator helper

kbond · 2015-10-31T12:45:43Z

I noticed this was merged into 3.0 but not 2.8 - I thought 3.0 was not getting any new features that are not in 2.8.

xabbuh · 2015-11-01T11:46:33Z

@kbond Looks like a mistake to me (see #16409).

This PR was merged into the 2.8 branch. Discussion ---------- [Console] Add progress indicator helper | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #12119 | License | MIT | Doc PR | Commits ------- be0a364 [Console] Add progress indicator helper

stof added Console RFC RFC = Request For Comments (proposals about features that you want to be discussed) labels Oct 6, 2014

Taluu reviewed Oct 9, 2015
View reviewed changes

kbond added 2 commits October 9, 2015 13:02

added progress indicator helper

abacef0

add speed trap to prevent flashing indicator

2480070

fabpot reviewed Oct 11, 2015
View reviewed changes

cleanup comments and ProgressIndicator::setIndicatorValues error chec…

f1144a3

…king

kbond added 3 commits October 13, 2015 10:55

make ProgressIndicator immutable

e9c18ab

add @internal 5.3 compat flag for public setters

faab1d4

ensure ProgressIndicator can be used multiple times with one instance

01b8e1a

fabpot reviewed Oct 13, 2015
View reviewed changes

mark ProgressIndicator::getMessage as internal

7bcabb4

fix test on windows

12bf736

fabpot changed the title ~~[PoC][Console] Add progress indicator helper~~ [Console] Add progress indicator helper Oct 19, 2015

fabpot closed this Oct 19, 2015

xabbuh mentioned this pull request Nov 1, 2015

[Console] Add progress indicator helper #16409

Merged

fabpot mentioned this pull request Nov 16, 2015

Release v3.0.0-BETA1 #16560

Merged

ogizanagi mentioned this pull request Mar 2, 2022

Disable progress bar when not in an interactive terminal #45596

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Add progress indicator helper #12119

[Console] Add progress indicator helper #12119

kbond commented Oct 3, 2014

Nicofuma commented Oct 5, 2014

fabpot commented Sep 14, 2015

kbond commented Sep 14, 2015

keradus commented Sep 23, 2015

kbond commented Sep 23, 2015

fabpot commented Oct 6, 2015

kbond commented Oct 6, 2015

kbond commented Oct 9, 2015

Taluu Oct 9, 2015

kbond Oct 9, 2015

kbond commented Oct 9, 2015

fabpot Oct 11, 2015

fabpot Oct 11, 2015

kbond commented Oct 13, 2015

fabpot commented Oct 13, 2015

stof commented Oct 13, 2015

kbond commented Oct 13, 2015

fabpot Oct 13, 2015

kbond Oct 13, 2015

fabpot commented Oct 13, 2015

fabpot commented Oct 19, 2015

kbond commented Oct 19, 2015

kbond commented Oct 19, 2015

fabpot commented Oct 19, 2015

kbond commented Oct 31, 2015

xabbuh commented Nov 1, 2015

[Console] Add progress indicator helper #12119

[Console] Add progress indicator helper #12119

Conversation

kbond commented Oct 3, 2014

Example code

Screenshot

Nicofuma commented Oct 5, 2014

fabpot commented Sep 14, 2015

kbond commented Sep 14, 2015

keradus commented Sep 23, 2015

kbond commented Sep 23, 2015

fabpot commented Oct 6, 2015

kbond commented Oct 6, 2015

kbond commented Oct 9, 2015

Taluu Oct 9, 2015

Choose a reason for hiding this comment

kbond Oct 9, 2015

Choose a reason for hiding this comment

kbond commented Oct 9, 2015

fabpot Oct 11, 2015

Choose a reason for hiding this comment

fabpot Oct 11, 2015

Choose a reason for hiding this comment

kbond commented Oct 13, 2015

fabpot commented Oct 13, 2015

stof commented Oct 13, 2015

kbond commented Oct 13, 2015

fabpot Oct 13, 2015

Choose a reason for hiding this comment

kbond Oct 13, 2015

Choose a reason for hiding this comment

fabpot commented Oct 13, 2015

fabpot commented Oct 19, 2015

kbond commented Oct 19, 2015

kbond commented Oct 19, 2015

fabpot commented Oct 19, 2015

kbond commented Oct 31, 2015

xabbuh commented Nov 1, 2015