[Console] Advancing a progress bar clears too many lines #52446
Comments
|
@danepowell you are right. The reason is the following line: There is always used the newline parameter with true. So the change is, when we have the following example (pseudo code): Then is called the Before #51378 the /cc @chalasr @nicolas-grekas this is the change of output what comes from #51378. But this was exactly the issue to fix this behavior of the duplicated "\n". This comes from a ProgressBar with the format |
|
@joelwurtz would you mind taking a look at this since you authored #51378 ? |
|
@chalasr @nicolas-grekas could you take a look at this regression? If it was an intended change of behavior, can you suggest how downstream projects like ACLI should adjust to fix it? |
|
@danepowell Sorry for the lack of reply. We either need someone work on a fix or revert the bugfix that introduced this regression. I feel like it'd be worth trying to fix the regression without reverting the PR that introduced it, but I'm personally not able to take that time right now hence some help would be needed. Maybe something around:
would be enough if it doesn't cause more trouble. |
|
Hey, thanks for your report! |
|
Still a bug |
|
I tried to resolve it but i'm struggling creating a reproducer based on your code, i didn't manage to do it, i'm certainly missing something from your code, ATM i wrote this : <?php
require 'vendor/autoload.php';
$output = new \Symfony\Component\Console\Output\ConsoleOutput();
$input = new \Symfony\Component\Console\Input\ArgvInput();
$section = $output->section();
function run_step($section, $title)
{
$progressBar = new \Symfony\Component\Console\Helper\ProgressBar($section);
$progressBar->setBarCharacter('<info>✔</info>');
$progressBar->setProgressCharacter('⌛');
$progressBar->setEmptyBarCharacter('⌛');
$progressBar->setFormat(" %bar% %message%\n > %detail%");
$progressBar->setBarWidth(1);
$progressBar->setMessage($title);
$progressBar->setMessage('run 1', 'detail');
sleep(1);
$progressBar->setMessage('run 2', 'detail');
$progressBar->advance();
sleep(1);
$progressBar->setMessage('run 3', 'detail');
$progressBar->advance();
sleep(1);
$progressBar->setMessage('run 4', 'detail');
$progressBar->advance();
sleep(1);
$progressBar->setMessage('run 5', 'detail');
$progressBar->advance();
sleep(1);
$progressBar->setMessage('run 6', 'detail');
$progressBar->advance();
sleep(1);
$progressBar->finish();
$section->clear(1);
}
$io = new \Symfony\Component\Console\Style\SymfonyStyle($input, $section);
$io->confirm('Do you want to continue?', true);
run_step($section, 'Step 1');
run_step($section, 'Step 2');
run_step($section, 'Step 3');
run_step($section, 'Step 4'); |
|
@joelwurtz the format you use is not the same than in #52446 (comment) |
|
Wich format ? You mean about using the I'm not trying to reproduce this bug directly using console output, but more with progress bar and other method from section output as i think it may be more the way progress bar or other helper use the section rather than an implementation bug. (I try to change directly the implementation but a lot of tests fails, and a lot of output is done unecesseraly) |
|
I set the In my code, doWrite is called with But after #51378, this is changed to This seems like a bug; or there should be a better workaround than fudging a whitespace after the newline. |
|
Hey, thanks for your report! |
|
Still relevant |
|
I confirm the issue persist. Here is a single command app to reproduce this issue. #!/usr/bin/env php
<?php
require __DIR__.'/vendor/autoload.php';
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\SingleCommandApplication;
(new SingleCommandApplication())
->setCode(function (InputInterface $input, OutputInterface $output): int {
$progress_bar = new ProgressBar($output->section());
$progress_bar->setFormat('[%bar%] %percent:3s%%' . PHP_EOL . '<comment>%message%</comment>' . PHP_EOL);
$progress_bar->setMaxSteps(200);
$progress_bar->setMessage('');
$progress_bar->start();
$result_section = $output->section();
$progress_bar->setMessage('Doing something...');
for ($i = 1; $i <= 100; $i++) {
usleep(30_000);
$progress_bar->advance();
}
$result_section->writeln('<info>Something has been done successfully.</info>');
$progress_bar->setMessage('Doing something else...');
for ($i = 1; $i <= 100; $i++) {
usleep(30_000);
$progress_bar->advance();
}
$result_section->writeln('<info>Something else has been done successfully.</info>');
$progress_bar->setMessage('');
$progress_bar->finish();
return 1;
})
->run();The following capture shows this unexpected behaviour on |
|
Thanks for the reproducer, i'm not sure where the bug should be fixed however I managed to have something working by doing this : #!/usr/bin/env php
<?php
require __DIR__.'/vendor/autoload.php';
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\SingleCommandApplication;
(new SingleCommandApplication())
->setCode(function (InputInterface $input, OutputInterface $output): int {
$progress_bar = new ProgressBar($output->section());
$progress_bar->setFormat('[%bar%] %percent:3s%%' . PHP_EOL . '<comment>%message%</comment>');
$progress_bar->setMaxSteps(200);
$progress_bar->setMessage('Start');
$progress_bar->start();
$result_section = $output->section();
$progress_bar->setMessage('Doing something...');
for ($i = 1; $i <= 100; $i++) {
usleep(30_000);
$progress_bar->advance();
}
$result_section->writeln('<info>Something has been done successfully.</info>');
$progress_bar->setMessage('Doing something else...');
for ($i = 1; $i <= 100; $i++) {
usleep(30_000);
$progress_bar->advance();
}
$result_section->writeln('<info>Something else has been done successfully.</info>');
$progress_bar->setMessage('');
$progress_bar->finish();
return 1;
})
->run();
For me the bug may be in the message from progess bar passed to the section: it should remove PHP_EOL at the end of it |
|
In fact, in my application, I have 2 PHP_EOL at the end of the progress bar format. I made it this way to have a "padding" between my progress bar and my result section. Anyway, thanks for the workaround. |
|
Made a fix in #59874 |
…there is an EOL (joelwurtz) This PR was merged into the 6.4 branch. Discussion ---------- [Console] fix progress bar messing output in section when there is an EOL | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | #52446 | License | MIT This fix the progress bar making the output erase previous line when there is an EOL at the end of it Commits ------- cae2241 fix(console): fix progress bar messing output in section when there is an EOL
Symfony version(s) affected
6.3.4
Description
Our console application creates checklists based on Symfony progress bars to represent the progress of multi-step commands. You can see the code for this at https://github.com/acquia/cli/tree/main/src/Output
As of Symfony 6.3.4 (specifically #51378), these checklists / progress bars don't work correctly. Whenever the progress bar advances, it clears two lines instead of one, causing it to "eat" the prior console output, including the checklist. See a video of this in action with a few more details here: https://github.com/acquia/cli/issues/1620
This seems to be a regression introduced by #51378 . I'm not sure if it's a general regression or a problem with our particular implementation of progress bars.
How to reproduce
See https://github.com/acquia/cli/issues/1620
I haven't figured out how to reproduce this outside of our application yet
Possible Solution
No response
Additional Context
No response
The text was updated successfully, but these errors were encountered: