[ProgressBar] Replace step based frequency with time-based frequency

ostrolucky · ostrolucky · commit fcc028b3b69d · 2018-04-01T14:57:40.000+02:00
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 4.x to 5.0
 =======================
 
+Console
+------
+
+ * The `ProgressBar::setRedrawFrequency()` method has been removed and replaced with time-based redraw frequency set via constructor.
+
 Config
 ------
 
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * added option to run suggested command if command is not found and only 1 alternative is available
  * added option to modify console output and print multiple modifiable sections
+ * deprecated `ProgressBar::setRedrawFrequency()`
 
 4.0.0
 -----
diff --git a/src/Symfony/Component/Console/Helper/ProgressBar.php b/src/Symfony/Component/Console/Helper/ProgressBar.php
@@ -32,6 +32,8 @@ final class ProgressBar
     private $format;
     private $internalFormat;
     private $redrawFreq = 1;
+    private $redrawFrequency;
+    private $lastWriteTime;
     private $output;
     private $step = 0;
     private $max;
@@ -42,23 +44,27 @@ final class ProgressBar
     private $messages = array();
     private $overwrite = true;
     private $terminal;
-    private $firstRun = true;
 
+    private $firstRun = true;
     private static $formatters;
     private static $formats;
 
     /**
-     * @param OutputInterface $output An OutputInterface instance
-     * @param int             $max    Maximum steps (0 if unknown)
+     * @param OutputInterface $output          An OutputInterface instance
+     * @param int             $max             Maximum steps (0 if unknown)
+     * @param float|null      $redrawFrequency Frequency of redrawing in seconds.
+     *                                         If null, value in $redrawFreq is used instead,
+     *                                         which is frequency of redrawing in steps.
      */
-    public function __construct(OutputInterface $output, int $max = 0)
+    public function __construct(OutputInterface $output, int $max = 0, float $redrawFrequency = null /* .1 */)
     {
         if ($output instanceof ConsoleOutputInterface) {
             $output = $output->getErrorOutput();
         }
 
         $this->output = $output;
         $this->setMaxSteps($max);
+        $this->redrawFrequency = $redrawFrequency;
         $this->terminal = new Terminal();
 
         if (!$this->output->isDecorated()) {
@@ -237,9 +243,13 @@ public function setFormat(string $format)
      * Sets the redraw frequency.
      *
      * @param int|float $freq The frequency in steps
+     *
+     * @deprecated since version 4.1, to be removed in 5.0. Use $redrawFrequency argument in constructor instead.
      */
     public function setRedrawFrequency(int $freq)
     {
+        @trigger_error(sprintf('The %s() method is deprecated since Symfony 4.1 and will be removed in 5.0. Use $redrawFrequency argument in constructor instead.', __METHOD__), E_USER_DEPRECATED);
+
         $this->redrawFreq = max($freq, 1);
     }
 
@@ -291,7 +301,12 @@ public function setProgress(int $step)
         $currPeriod = (int) ($step / $this->redrawFreq);
         $this->step = $step;
         $this->percent = $this->max ? (float) $this->step / $this->max : 0;
-        if ($prevPeriod !== $currPeriod || $this->max === $step) {
+
+        if (null === $this->redrawFrequency) {
+            if ($prevPeriod !== $currPeriod || $this->max === $step) {
+                $this->display();
+            }
+        } elseif (microtime(true) - $this->lastWriteTime >= $this->redrawFrequency || $this->max === $step) {
             $this->display();
         }
     }
@@ -398,6 +413,7 @@ private function overwrite(string $message): void
         }
 
         $this->firstRun = false;
+        $this->lastWriteTime = microtime(true);
 
         $this->output->write($message);
     }
diff --git a/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php b/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php
@@ -456,6 +456,9 @@ public function testRedrawFrequency()
         );
     }
 
+    /**
+     * @group legacy
+     */
     public function testRedrawFrequencyIsAtLeastOneIfZeroGiven()
     {
         $bar = new ProgressBar($output = $this->getOutputStream());
@@ -471,6 +474,9 @@ public function testRedrawFrequencyIsAtLeastOneIfZeroGiven()
         );
     }
 
+    /**
+     * @group legacy
+     */
     public function testRedrawFrequencyIsAtLeastOneIfSmallerOneGiven()
     {
         $bar = new ProgressBar($output = $this->getOutputStream());
@@ -896,4 +902,13 @@ public function testBarWidthWithMultilineFormat()
         $this->assertEquals(5, $bar->getBarWidth(), stream_get_contents($output->getStream()));
         putenv('COLUMNS=120');
     }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation The Symfony\Component\Console\Helper\ProgressBar::setRedrawFrequency() method is deprecated since Symfony 4.1 and will be removed in 5.0. Use $redrawFrequency argument in constructor instead.
+     */
+    public function testEnabledStrictEmailOptionIsMappedToStrictEmailValidationMode()
+    {
+        (new ProgressBar($this->getOutputStream()))->setRedrawFrequency(1);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -456,6 +456,9 @@ public function testRedrawFrequency()`
`456`	`456`	`);`
`457`	`457`	`}`
`458`	`458`
	`459`	`+ /**`
	`460`	`+ * @group legacy`
	`461`	`+ */`
`459`	`462`	`public function testRedrawFrequencyIsAtLeastOneIfZeroGiven()`
`460`	`463`	`{`
`461`	`464`	`$bar = new ProgressBar($output = $this->getOutputStream());`
`@@ -471,6 +474,9 @@ public function testRedrawFrequencyIsAtLeastOneIfZeroGiven()`
`471`	`474`	`);`
`472`	`475`	`}`
`473`	`476`
	`477`	`+ /**`
	`478`	`+ * @group legacy`
	`479`	`+ */`
`474`	`480`	`public function testRedrawFrequencyIsAtLeastOneIfSmallerOneGiven()`
`475`	`481`	`{`
`476`	`482`	`$bar = new ProgressBar($output = $this->getOutputStream());`
`@@ -896,4 +902,13 @@ public function testBarWidthWithMultilineFormat()`
`896`	`902`	`$this->assertEquals(5, $bar->getBarWidth(), stream_get_contents($output->getStream()));`
`897`	`903`	`putenv('COLUMNS=120');`
`898`	`904`	`}`
	`905`	`+`
	`906`	`+ /**`
	`907`	`+ * @group legacy`
	`908`	`+ * @expectedDeprecation The Symfony\Component\Console\Helper\ProgressBar::setRedrawFrequency() method is deprecated since Symfony 4.1 and will be removed in 5.0. Use $redrawFrequency argument in constructor instead.`
	`909`	`+ */`
	`910`	`+ public function testEnabledStrictEmailOptionIsMappedToStrictEmailValidationMode()`
	`911`	`+ {`
	`912`	`+ (new ProgressBar($this->getOutputStream()))->setRedrawFrequency(1);`
	`913`	`+ }`
`899`	`914`	`}`