Prevent ProgressBar redraw when message is same

fmasa · fmasa · commit dbf9b4d27f5e · 2019-10-07T14:09:22.000+02:00
diff --git a/src/Symfony/Component/Console/Helper/ProgressBar.php b/src/Symfony/Component/Console/Helper/ProgressBar.php
@@ -42,6 +42,7 @@ final class ProgressBar
     private $overwrite = true;
     private $terminal;
     private $firstRun = true;
+    private $currentMessage = '';
 
     private static $formatters;
     private static $formats;
@@ -464,6 +465,12 @@ private function setMaxSteps($max)
      */
     private function overwrite($message)
     {
+        if ($this->currentMessage === $message) {
+            return;
+        }
+
+        $this->currentMessage = $message;
+
         if ($this->overwrite) {
             if (!$this->firstRun) {
                 // Erase previous lines
diff --git a/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php b/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php
@@ -185,7 +185,6 @@ public function testFormat()
     {
         $expected =
             '  0/10 [>---------------------------]   0%'.
-            $this->generateOutput(' 10/10 [============================] 100%').
             $this->generateOutput(' 10/10 [============================] 100%')
         ;
 
@@ -294,7 +293,6 @@ public function testPercent()
         rewind($output->getStream());
         $this->assertEquals(
             '  0/50 [>---------------------------]   0%'.
-            $this->generateOutput('  0/50 [>---------------------------]   0%').
             $this->generateOutput('  1/50 [>---------------------------]   2%').
             $this->generateOutput('  2/50 [=>--------------------------]   4%'),
             stream_get_contents($output->getStream())
@@ -316,7 +314,6 @@ public function testOverwriteWithShorterLine()
         rewind($output->getStream());
         $this->assertEquals(
             '  0/50 [>---------------------------]   0%'.
-            $this->generateOutput('  0/50 [>---------------------------]   0%').
             $this->generateOutput('  1/50 [>---------------------------]   2%').
             $this->generateOutput('  2/50 [=>--------------------------]'),
             stream_get_contents($output->getStream())
@@ -350,7 +347,6 @@ public function testSetCurrentProgress()
         rewind($output->getStream());
         $this->assertEquals(
             '  0/50 [>---------------------------]   0%'.
-            $this->generateOutput('  0/50 [>---------------------------]   0%').
             $this->generateOutput('  1/50 [>---------------------------]   2%').
             $this->generateOutput(' 15/50 [========>-------------------]  30%').
             $this->generateOutput(' 25/50 [==============>-------------]  50%'),
@@ -457,7 +453,6 @@ public function testPercentNotHundredBeforeComplete()
         rewind($output->getStream());
         $this->assertEquals(
             '   0/200 [>---------------------------]   0%'.
-            $this->generateOutput('   0/200 [>---------------------------]   0%').
             $this->generateOutput(' 199/200 [===========================>]  99%').
             $this->generateOutput(' 200/200 [============================] 100%'),
             stream_get_contents($output->getStream())
@@ -802,4 +797,19 @@ public function testBarWidthWithMultilineFormat()
         $this->assertEquals(5, $bar->getBarWidth(), stream_get_contents($output->getStream()));
         putenv('COLUMNS=120');
     }
+
+    public function testNoWriteWhenMessageIsSame(): void
+    {
+        $bar = new ProgressBar($output = $this->getOutputStream(), 2);
+        $bar->start();
+        $bar->advance();
+        $bar->display();
+
+        rewind($output->getStream());
+        $this->assertEquals(
+            ' 0/2 [>---------------------------]   0%'.
+            $this->generateOutput(' 1/2 [==============>-------------]  50%'),
+            stream_get_contents($output->getStream())
+        );
+    }
 }
