Validate the metrics --range against the environment's max_range

Author: pjcdawkins

src/Command/Metrics/AllMetricsCommand.php

@@ -67,14 +67,14 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $timeSpec = $this->validateTimeInput($input);
+        $this->chooseEnvFilter = $this->filterEnvsByState(['active']);
+        $this->validateInput($input, false, true);
+
+        $timeSpec = $this->validateTimeInput($input, $this->getSelectedEnvironment());
         if ($timeSpec === false) {
             return 1;
         }
 
-        $this->chooseEnvFilter = $this->filterEnvsByState(['active']);
-        $this->validateInput($input, false, true);
-
         /** @var \Platformsh\Cli\Service\Table $table */
         $table = $this->getService('table');
 

src/Command/Metrics/CpuCommand.php

@@ -41,13 +41,14 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $timeSpec = $this->validateTimeInput($input);
+        $this->chooseEnvFilter = $this->filterEnvsByState(['active']);
+        $this->validateInput($input, false, true);
+
+        $timeSpec = $this->validateTimeInput($input, $this->getSelectedEnvironment());
         if ($timeSpec === false) {
             return 1;
         }
 
-        $this->validateInput($input, false, true);
-
         /** @var \Platformsh\Cli\Service\Table $table */
         $table = $this->getService('table');
 

src/Command/Metrics/CurlCommand.php

@@ -22,6 +22,7 @@ protected function configure()
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        $this->chooseEnvFilter = $this->filterEnvsByState(['active']);
         $this->validateInput($input, false, true);
 
         // Initialize the API service so that it gets CommandBase's event listeners

src/Command/Metrics/DiskUsageCommand.php

@@ -53,7 +53,10 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $timeSpec = $this->validateTimeInput($input);
+        $this->chooseEnvFilter = $this->filterEnvsByState(['active']);
+        $this->validateInput($input, false, true);
+
+        $timeSpec = $this->validateTimeInput($input, $this->getSelectedEnvironment());
         if ($timeSpec === false) {
             return 1;
         }
@@ -66,8 +69,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $table = $this->getService('table');
         $table->removeDeprecatedColumns(['interval'], '', $input, $output);
 
-        $this->validateInput($input, false, true);
-
         if (!$table->formatIsMachineReadable()) {
             $this->displayEnvironmentHeader();
         }

src/Command/Metrics/MemCommand.php

@@ -43,13 +43,14 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $timeSpec = $this->validateTimeInput($input);
+        $this->chooseEnvFilter = $this->filterEnvsByState(['active']);
+        $this->validateInput($input, false, true);
+
+        $timeSpec = $this->validateTimeInput($input, $this->getSelectedEnvironment());
         if ($timeSpec === false) {
             return 1;
         }
 
-        $this->validateInput($input, false, true);
-
         /** @var \Platformsh\Cli\Service\Table $table */
         $table = $this->getService('table');
 

src/Command/Metrics/MetricsCommandBase.php

@@ -123,7 +123,7 @@ protected function addMetricsOptions()
     /**
      * Returns the metrics URL and collection information for the selected environment.
      *
-     * @return array{'href': string, 'collection': string}|false
+     * @return array{href: string, collection: string, max_range: string}|false
      *   The link data or false on failure.
      */
     protected function getMetricsLink(Environment $environment)
@@ -332,10 +332,11 @@ protected function fetchMetrics(InputInterface $input, TimeSpec $timeSpec, Envir
      * @see self::startTime, self::$endTime, self::$interval
      *
      * @param InputInterface $input
+     * @param Environment|null $environment
      *
      * @return TimeSpec|false
      */
-    protected function validateTimeInput(InputInterface $input)
+    protected function validateTimeInput(InputInterface $input, Environment $environment = null)
     {
         $interval = null;
         if ($intervalStr = $input->getOption('interval')) {
@@ -361,13 +362,24 @@ protected function validateTimeInput(InputInterface $input)
             $endTime = time();
         }
         if ($rangeStr = $input->getOption('range')) {
-            $rangeSeconds = (new Duration())->toSeconds($rangeStr);
+            $rangeDuration = $this->parseDuration($rangeStr);
+            if (!$rangeDuration) {
+                $this->stdErr->writeln('Invalid --range: <error>' . $rangeStr . '</error>');
+                return false;
+            }
+            $rangeSeconds = $rangeDuration->toSeconds();
             if (empty($rangeSeconds)) {
                 $this->stdErr->writeln('Invalid --range: <error>' . $rangeStr . '</error>');
                 return false;
             } elseif ($rangeSeconds < self::MIN_RANGE) {
                 $this->stdErr->writeln(\sprintf('The --range <error>%s</error> is too short: it must be at least %d seconds (%s).', $rangeStr, self::MIN_RANGE, (new Duration())->humanize(self::MIN_RANGE)));
                 return false;
+            } elseif ($environment && ($link = $this->getMetricsLink($environment)) && isset($link['max_range'])) {
+                $maxRange = $this->parseDuration($link['max_range']);
+                if ($rangeSeconds > $maxRange->toSeconds()) {
+                    $this->stdErr->writeln(\sprintf('The --range <error>%s</error> is too long: the maximum is %s.', $rangeStr, $link['max_range']));
+                    return false;
+                }
             }
             $rangeSeconds = \intval($rangeSeconds);
         } else {
@@ -421,6 +433,22 @@ private function defaultInterval($range)
         return (int) $interval;
     }
 
+    /**
+     * @param string $duration
+     * @return Duration|false
+     */
+    private function parseDuration($duration)
+    {
+        if (substr($duration, -1) === 'y') {
+            $num = rtrim($duration, 'y');
+            if (!is_numeric($num)) {
+                return false;
+            }
+            return new Duration(intval($num) * 365.25 * 86400);
+        }
+        return (new Duration())->parse($duration);
+    }
+
     /**
      * Returns the deployment type of an environment (needed for differing queries).
      *