revert change to Report that set initial processed metrics as Process…

…edMetric instances, as those are meant to be added conditionally based on a query parameter. for API consumers this means to get all formulas they will need to use API.getProcessedReport
matomo-org · Sep 18, 2024 · ff4aa13 · ff4aa13
1 parent 3cf3c98
commit ff4aa13
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 479 deletions.
diff --git a/core/Plugin/Report.php b/core/Plugin/Report.php
@@ -120,7 +120,8 @@ class Report
      * @var array
      * @api
      */
-    protected $processedMetrics = []; // default set in constructor
+    protected $processedMetrics = array('nb_actions_per_visit', 'avg_time_on_site', 'bounce_rate', 'conversion_rate');
+    // for a little performance improvement we avoid having to call Metrics::getDefaultProcessedMetrics for each report
 
     /**
      * The semantic types for all metrics this report displays (including processed metrics).
@@ -261,13 +262,6 @@ final public function __construct()
             $this->action = lcfirst($parts[4]);
         }
 
-        $this->processedMetrics = [
-            new ActionsPerVisit(),
-            new AverageTimeOnSite(),
-            new BounceRate(),
-            new ConversionRate(),
-        ];
-
         $this->init();
     }
 

diff --git a/...tem/expected/test_Contents_Contents.getContentNames_lastN__API.getProcessedReport_day.xml b/...tem/expected/test_Contents_Contents.getContentNames_lastN__API.getProcessedReport_day.xml
@@ -23,6 +23,9 @@
 		<processedMetrics>
 			<interaction_rate>Interaction Rate</interaction_rate>
 		</processedMetrics>
+		<processedMetricFormulas>
+			<interaction_rate>$nb_interactions / $nb_impressions</interaction_rate>
+		</processedMetricFormulas>
 		<metricTypes>
 			<nb_impressions>number</nb_impressions>
 			<nb_interactions>number</nb_interactions>

diff --git a/...em/expected/test_Contents_Contents.getContentPieces_lastN__API.getProcessedReport_day.xml b/...em/expected/test_Contents_Contents.getContentPieces_lastN__API.getProcessedReport_day.xml
@@ -23,6 +23,9 @@
 		<processedMetrics>
 			<interaction_rate>Interaction Rate</interaction_rate>
 		</processedMetrics>
+		<processedMetricFormulas>
+			<interaction_rate>$nb_interactions / $nb_impressions</interaction_rate>
+		</processedMetricFormulas>
 		<metricTypes>
 			<nb_impressions>number</nb_impressions>
 			<nb_interactions>number</nb_interactions>

diff --git a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getMetadata_day.xml b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getMetadata_day.xml
@@ -29,20 +29,8 @@
 			<revenue_per_visit>Revenue per Visit</revenue_per_visit>
 		</processedMetrics>
 		<processedMetricFormulas>
-			<nb_actions_per_visit>$nb_actions / $nb_visits</nb_actions_per_visit>
-			<avg_time_on_site>$sum_visit_length / $nb_visits</avg_time_on_site>
-			<bounce_rate>$bounce_count / $nb_visits</bounce_rate>
-			<conversion_rate>$nb_visits_converted / $nb_visits</conversion_rate>
 			<revenue_per_visit>$revenue / ($nb_visits != 0 ? $nb_visits : $nb_conversions)</revenue_per_visit>
 		</processedMetricFormulas>
-		<temporaryMetricAggregationTypes>
-			<sum_visit_length>sum</sum_visit_length>
-			<bounce_count>sum</bounce_count>
-		</temporaryMetricAggregationTypes>
-		<temporaryMetricSemanticTypes>
-			<sum_visit_length>number</sum_visit_length>
-			<bounce_count>number</bounce_count>
-		</temporaryMetricSemanticTypes>
 		<metricTypes>
 			<nb_visits>number</nb_visits>
 			<nb_uniq_visitors>number</nb_uniq_visitors>

diff --git a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getProcessedReport_day.xml
@@ -31,20 +31,8 @@
 			<revenue_per_visit>Revenue per Visit</revenue_per_visit>
 		</processedMetrics>
 		<processedMetricFormulas>
-			<nb_actions_per_visit>$nb_actions / $nb_visits</nb_actions_per_visit>
-			<avg_time_on_site>$sum_visit_length / $nb_visits</avg_time_on_site>
-			<bounce_rate>$bounce_count / $nb_visits</bounce_rate>
-			<conversion_rate>$nb_visits_converted / $nb_visits</conversion_rate>
 			<revenue_per_visit>$revenue / ($nb_visits != 0 ? $nb_visits : $nb_conversions)</revenue_per_visit>
 		</processedMetricFormulas>
-		<temporaryMetricAggregationTypes>
-			<sum_visit_length>sum</sum_visit_length>
-			<bounce_count>sum</bounce_count>
-		</temporaryMetricAggregationTypes>
-		<temporaryMetricSemanticTypes>
-			<sum_visit_length>number</sum_visit_length>
-			<bounce_count>number</bounce_count>
-		</temporaryMetricSemanticTypes>
 		<metricTypes>
 			<nb_visits>number</nb_visits>
 			<nb_uniq_visitors>number</nb_uniq_visitors>