adds code for display and evolution graph to work

Author: AltamashShaikh

Slack.php

@@ -29,6 +29,8 @@ class Slack extends Plugin
 
     private static $availableParameters = array(
         self::SLACK_CHANNEL_ID_PARAMETER => true,
+        ScheduledReports::EVOLUTION_GRAPH_PARAMETER   => false,
+        ScheduledReports::DISPLAY_FORMAT_PARAMETER    => true,
     );
 
     private static $managedReportTypes = array(
@@ -74,13 +76,33 @@ public function getClientSideTranslationKeys(&$translationKeys)
 
     public function validateReportParameters(&$parameters, $reportType)
     {
-        if (self::isSlackEvent($reportType)) {
-            $settings = StaticContainer::get(SystemSettings::class);
-            if (empty($settings->slackOauthToken->getValue())) {
-                throw new \Exception(Piwik::translate('Slack_OauthTokenRequiredErrorMessage'));
-            } elseif (empty($parameters[self::SLACK_CHANNEL_ID_PARAMETER])) {
-                throw new \Exception(Piwik::translate('Slack_SlackChannelIdRequiredErrorMessage'));
-            }
+        if (!self::isSlackEvent($reportType)) {
+            return;
+        }
+
+        $reportFormat = $parameters[ScheduledReports::DISPLAY_FORMAT_PARAMETER];
+        $availableDisplayFormats = array_keys(ScheduledReports::getDisplayFormats());
+        if (!in_array($reportFormat, $availableDisplayFormats)) {
+            throw new \Exception(
+                Piwik::translate(
+                    'General_ExceptionInvalidAggregateReportsFormat',
+                    array($reportFormat, implode(', ', $availableDisplayFormats))
+                )
+            );
+        }
+
+        // evolutionGraph is an optional parameter
+        if (!isset($parameters[ScheduledReports::EVOLUTION_GRAPH_PARAMETER])) {
+            $parameters[ScheduledReports::EVOLUTION_GRAPH_PARAMETER] = ScheduledReports::EVOLUTION_GRAPH_PARAMETER_DEFAULT_VALUE;
+        } else {
+            $parameters[ScheduledReports::EVOLUTION_GRAPH_PARAMETER] = self::valueIsTrue($parameters[ScheduledReports::EVOLUTION_GRAPH_PARAMETER]);
+        }
+
+        $settings = StaticContainer::get(SystemSettings::class);
+        if (empty($settings->slackOauthToken->getValue())) {
+            throw new \Exception(Piwik::translate('Slack_OauthTokenRequiredErrorMessage'));
+        } elseif (empty($parameters[self::SLACK_CHANNEL_ID_PARAMETER])) {
+            throw new \Exception(Piwik::translate('Slack_SlackChannelIdRequiredErrorMessage'));
         }
     }
 
@@ -220,6 +242,9 @@ public function templateReportParametersScheduledReports(&$out, $context = '')
 
         $settings = StaticContainer::get(SystemSettings::class);
         $view->isSlackOauthTokenAdded = !empty($settings->slackOauthToken->getValue());
+        $view->defaultDisplayFormat = ScheduledReports::DEFAULT_DISPLAY_FORMAT;
+        $view->defaultFormat = ReportRenderer::PDF_FORMAT;
+        $view->defaultEvolutionGraph = ScheduledReports::EVOLUTION_GRAPH_PARAMETER_DEFAULT_VALUE;
         $out .= $view->render();
     }
 
@@ -258,4 +283,9 @@ private function reportAlreadySent($report, Period $period)
 
         return $previousDate === $period->getRangeString();
     }
+
+    private static function valueIsTrue($value)
+    {
+        return $value == 'true' || $value == 1 || $value == '1' || $value === true;
+    }
 }

templates/reportParametersScheduledReports.twig

@@ -1,4 +1,7 @@
 <div
         vue-entry="Slack.ReportParameters"
         is-slack-oauth-token-added="{{ isSlackOauthTokenAdded|default(false)|json_encode }}"
+        default-format="{{ defaultFormat|default(null)|json_encode|e('html_attr') }}"
+        default-display-format="{{ defaultDisplayFormat|default(null)|json_encode|e('html_attr') }}"
+        default-evolution-graph="{{ defaultEvolutionGraph|default(false)|json_encode|e('html_attr') }}"
 ></div>

tests/UI/Slack_spec.js

@@ -99,4 +99,27 @@
     }, selector);
   });
 
+  it('should show display option for reportType:pdf', async function () {
+    const selector = '.page';
+    await captureScreen('slack_report_pdf_view', async () => {
+      await page.evaluate(() => $('#add-report').click());
+      await page.waitForNetworkIdle();
+      await page.type('textarea#report_description', 'Slack Report PDF');
+      await page.evaluate(() => $('#addEditReport .matomo-form-field:eq(6) input')[0].click());
+      await page.evaluate(() => $('#addEditReport .matomo-form-field:eq(6) ul li:last').click());
+    }, selector);
+  });
+
+  it('should save reportType:pdf with default display options', async function () {
+    const selector = '.page';
+    await captureScreen('slack_report_pdf_save', async () => {
+      await page.evaluate(() => $('#slackUserCountry_getCountry').click());
+      await page.type('input#channelID', 'ChannelID');
+      await page.click('.matomo-save-button input.btn');
+      await page.waitForNetworkIdle();
+    }, selector);
+  });
+
+  // TODO: Add tests for display options once core changes are merged
+
 });