bug #40450 [Console] ProgressBar clears too many lines on update (danepowell)

nicolas-grekas · nicolas-grekas · commit a78fb1832b73 · 2021-03-16T09:54:45.000+01:00
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- [Console] ProgressBar clears too many lines on update | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? |no  | Deprecations? |no  | License | MIT The ProgressBar incorrectly calculates line lengths when updating, including non-displayable characters such as ANSI colors. This causes it to clear too many lines if the terminal width is greater than the displayed line length but less than the line length including non-displayed characters. An example of this bug in action is https://github.com/acquia/cli/issues/467 Commits ------- 2aa3df0 [Console] ProgressBar clears too many lines on update
diff --git a/src/Symfony/Component/Console/Helper/ProgressBar.php b/src/Symfony/Component/Console/Helper/ProgressBar.php
@@ -441,7 +441,7 @@ private function overwrite(string $message): void
         if ($this->overwrite) {
             if (null !== $this->previousMessage) {
                 if ($this->output instanceof ConsoleSectionOutput) {
-                    $lines = floor(Helper::strlen($message) / $this->terminal->getWidth()) + $this->formatLineCount + 1;
+                    $lines = floor(Helper::strlenWithoutDecoration($this->output->getFormatter(), $message) / $this->terminal->getWidth()) + $this->formatLineCount + 1;
                     $this->output->clear($lines);
                 } else {
                     // Erase previous lines
diff --git a/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php b/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php
@@ -343,6 +343,31 @@ public function testOverwriteWithSectionOutput()
         );
     }
 
+    public function testOverwriteWithAnsiSectionOutput()
+    {
+        // output has 43 visible characters plus 2 invisible ANSI characters
+        putenv('COLUMNS=43');
+        $sections = [];
+        $stream = $this->getOutputStream(true);
+        $output = new ConsoleSectionOutput($stream->getStream(), $sections, $stream->getVerbosity(), $stream->isDecorated(), new OutputFormatter());
+
+        $bar = new ProgressBar($output, 50, 0);
+        $bar->setFormat(" \033[44;37m%current%/%max%\033[0m [%bar%] %percent:3s%%");
+        $bar->start();
+        $bar->display();
+        $bar->advance();
+        $bar->advance();
+
+        rewind($output->getStream());
+        $this->assertSame(
+            " \033[44;37m 0/50\033[0m [>---------------------------]   0%".\PHP_EOL.
+            "\x1b[1A\x1b[0J"." \033[44;37m 1/50\033[0m [>---------------------------]   2%".\PHP_EOL.
+            "\x1b[1A\x1b[0J"." \033[44;37m 2/50\033[0m [=>--------------------------]   4%".\PHP_EOL,
+            stream_get_contents($output->getStream())
+        );
+        putenv('COLUMNS=120');
+    }
+
     public function testOverwriteMultipleProgressBarsWithSectionOutputs()
     {
         $sections = [];
