add missing tests and parsing include.empty_metrics

Author: RobertJoonas

lib/plausible/stats/dashboard/query_parser.ex

@@ -84,6 +84,7 @@ defmodule Plausible.Stats.Dashboard.QueryParser do
          time_labels: params["include"]["time_labels"] == true,
          partial_time_labels: params["include"]["partial_time_labels"] == true,
          present_index: params["include"]["present_index"] == true,
+         empty_metrics: params["include"]["empty_metrics"] == true,
          trim_relative_date_range: true,
          drop_unavailable_time_on_page: true,
          drop_unavailable_revenue_metrics: true

test/plausible/stats/query/query_test.exs

@@ -505,22 +505,70 @@ defmodule Plausible.Stats.QueryTest do
       assert is_nil(meta[:empty_metrics])
     end
 
-    test "for regular metrics", %{site: site} do
-      {:ok, query} =
-        QueryBuilder.build(site, %ParsedQueryParams{
-          metrics: [:visitors, :bounce_rate, :scroll_depth],
-          input_date_range: :all,
-          include: %QueryInclude{empty_metrics: true},
-          filters: [[:is, "event:page", ["/"]]]
-        })
+    for {metric, expected} <- [
+          {:visitors, 0},
+          {:visits, 0},
+          {:pageviews, 0},
+          {:views_per_visit, 0.0},
+          {:bounce_rate, 0.0},
+          {:visit_duration, nil}
+        ] do
+      test "default: empty #{metric} is #{expected}", %{site: site} do
+        {:ok, query} =
+          QueryBuilder.build(site, %ParsedQueryParams{
+            metrics: [unquote(metric)],
+            input_date_range: :all,
+            include: %QueryInclude{empty_metrics: true}
+          })
+
+        %Stats.QueryResult{meta: meta} = Stats.query(site, query)
+
+        assert meta[:empty_metrics] == [unquote(expected)]
+      end
+    end
 
-      %Stats.QueryResult{meta: meta} = Stats.query(site, query)
+    for {metric, expected} <- [
+          {:time_on_page, nil},
+          {:scroll_depth, nil}
+        ] do
+      test "page filter: empty #{metric} is #{expected}", %{site: site} do
+        {:ok, query} =
+          QueryBuilder.build(site, %ParsedQueryParams{
+            metrics: [unquote(metric)],
+            input_date_range: :all,
+            include: %QueryInclude{empty_metrics: true},
+            filters: [[:is, "event:page", ["/"]]]
+          })
+
+        %Stats.QueryResult{meta: meta} = Stats.query(site, query)
+
+        assert meta[:empty_metrics] == [unquote(expected)]
+      end
+    end
 
-      assert meta[:empty_metrics] == [0, 0.0, nil]
+    for {metric, expected} <- [
+          {:events, 0},
+          {:group_conversion_rate, 0.0}
+        ] do
+      test "goal filter: empty #{metric} is #{expected}", %{site: site} do
+        insert(:goal, site: site, event_name: "Signup")
+
+        {:ok, query} =
+          QueryBuilder.build(site, %ParsedQueryParams{
+            metrics: [unquote(metric)],
+            input_date_range: :all,
+            include: %QueryInclude{empty_metrics: true},
+            filters: [[:is, "event:goal", ["Signup"]]]
+          })
+
+        %Stats.QueryResult{meta: meta} = Stats.query(site, query)
+
+        assert meta[:empty_metrics] == [unquote(expected)]
+      end
     end
 
     @tag :ee_only
-    test "for revenue metrics", %{site: site} do
+    test "goal filter: empty revenue metrics", %{site: site} do
       insert(:goal, site: site, event_name: "Purchase", currency: "EUR")
 
       {:ok, query} =

test/plausible_web/controllers/api/stats_controller/main_graph_test.exs

@@ -501,6 +501,22 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do
                %{"dimensions" => ["2021-12-01"], "metrics" => [1]}
              ]
     end
+
+    test "returns empty metrics under response.meta", %{conn: conn, site: site} do
+      response =
+        do_query(
+          conn,
+          site,
+          %{
+            "date_range" => "28d",
+            "metrics" => ["visitors"],
+            "dimensions" => ["time:day"],
+            "include" => %{"empty_metrics" => true}
+          }
+        )
+
+      assert response["meta"]["empty_metrics"] == [0]
+    end
   end
 
   describe "default labels" do