Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Fix regression: Drop revenue metrics when not allowed on the dashboard (#6167)
RobertJoonas4858209c6b21
diff --git a/lib/plausible/stats/aggregate.ex b/lib/plausible/stats/aggregate.exindex f637c62a5a..ae2e80e7c9 100644--- a/lib/plausible/stats/aggregate.ex+++ b/lib/plausible/stats/aggregate.ex@@ -11,7 +11,8 @@ defmodule Plausible.Stats.Aggregate dodef aggregate(site, query, metrics) doquery =query- |> Query.set(metrics: metrics, remove_unavailable_revenue_metrics: true)+ |> Query.set(metrics: metrics)+ |> Query.set_include(:drop_unavailable_revenue_metrics, true)|> QueryOptimizer.optimize()%QueryResult{results: [entry], meta: meta} = QueryRunner.run(site, query)diff --git a/lib/plausible/stats/breakdown.ex b/lib/plausible/stats/breakdown.exindex 6219d7063a..e636640272 100644--- a/lib/plausible/stats/breakdown.ex+++ b/lib/plausible/stats/breakdown.ex@@ -32,9 +32,9 @@ defmodule Plausible.Stats.Breakdown dofilters: query.filters ++ dimension_filters(dimension),pagination: %{limit: limit, offset: (page - 1) * limit},# Allow pageview and event metrics to be queried off of sessions table- legacy_breakdown: true,- remove_unavailable_revenue_metrics: true+ legacy_breakdown: true)+ |> Query.set_include(:drop_unavailable_revenue_metrics, true)%QueryResult{results: results, meta: meta} = QueryRunner.run(site, query_with_metrics)diff --git a/lib/plausible/stats/dashboard/query_parser.ex b/lib/plausible/stats/dashboard/query_parser.exindex a969224ba1..277d947573 100644--- a/lib/plausible/stats/dashboard/query_parser.ex+++ b/lib/plausible/stats/dashboard/query_parser.ex@@ -80,7 +80,8 @@ defmodule Plausible.Stats.Dashboard.QueryParser docompare_match_day_of_week: params["include"]["compare_match_day_of_week"] == true,time_labels: params["include"]["time_labels"] == true,trim_relative_date_range: true,- drop_unavailable_time_on_page: true+ drop_unavailable_time_on_page: true,+ drop_unavailable_revenue_metrics: true}}endenddiff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.exindex 3a5ba04d89..b12802d6d8 100644--- a/lib/plausible/stats/query.ex+++ b/lib/plausible/stats/query.ex@@ -24,7 +24,6 @@ defmodule Plausible.Stats.Query do# Revenue metric specific metadatarevenue_currencies: %{},revenue_warning: nil,- remove_unavailable_revenue_metrics: false,site_id: nil,consolidated_site_ids: nil,site_native_stats_start_at: nil,diff --git a/lib/plausible/stats/query_builder.ex b/lib/plausible/stats/query_builder.exindex ac98c17405..580daa5d14 100644--- a/lib/plausible/stats/query_builder.ex+++ b/lib/plausible/stats/query_builder.ex@@ -234,7 +234,8 @@ defmodule Plausible.Stats.QueryBuilder doenddefp validate_revenue_metrics_access(site, query) do- if Revenue.requested?(query.metrics) and not Revenue.available?(site) do+ if Revenue.requested?(query.metrics) and not Revenue.available?(site) and+ not query.include.drop_unavailable_revenue_metrics do{:error,%QueryError{code: :feature_access,diff --git a/lib/plausible/stats/query_include.ex b/lib/plausible/stats/query_include.exindex aaf6c5b124..778b6405fd 100644--- a/lib/plausible/stats/query_include.ex+++ b/lib/plausible/stats/query_include.ex@@ -9,7 +9,8 @@ defmodule Plausible.Stats.QueryInclude docompare: nil,compare_match_day_of_week: false,legacy_time_on_page_cutoff: nil,- drop_unavailable_time_on_page: false+ drop_unavailable_time_on_page: false,+ drop_unavailable_revenue_metrics: false@type date_range_tuple() :: {:date_range, Date.t(), Date.t()}@type datetime_range_tuple() :: {:datetime_range, DateTime.t(), DateTime.t()}@@ -24,6 +25,7 @@ defmodule Plausible.Stats.QueryInclude donil | :previous_period | :year_over_year | date_range_tuple() | datetime_range_tuple(),compare_match_day_of_week: boolean(),legacy_time_on_page_cutoff: any(),- drop_unavailable_time_on_page: boolean()+ drop_unavailable_time_on_page: boolean(),+ drop_unavailable_revenue_metrics: boolean()}enddiff --git a/lib/plausible/stats/query_optimizer.ex b/lib/plausible/stats/query_optimizer.exindex 004045d327..27a9452c45 100644--- a/lib/plausible/stats/query_optimizer.ex+++ b/lib/plausible/stats/query_optimizer.ex@@ -205,7 +205,8 @@ defmodule Plausible.Stats.QueryOptimizer doon_ee dodefp remove_revenue_metrics_if_unavailable(query) do- if query.remove_unavailable_revenue_metrics and map_size(query.revenue_currencies) == 0 do+ if query.include.drop_unavailable_revenue_metrics and+ map_size(query.revenue_currencies) == 0 doQuery.set(query, metrics: query.metrics -- Plausible.Stats.Goal.Revenue.revenue_metrics())elsequerydiff --git a/lib/plausible/stats/timeseries.ex b/lib/plausible/stats/timeseries.exindex 12f662ef17..919af51b33 100644--- a/lib/plausible/stats/timeseries.ex+++ b/lib/plausible/stats/timeseries.ex@@ -23,9 +23,9 @@ defmodule Plausible.Stats.Timeseries do|> Query.set(metrics: transform_metrics(metrics, %{conversion_rate: :group_conversion_rate}),dimensions: [time_dimension(query)],- order_by: [{time_dimension(query), :asc}],- remove_unavailable_revenue_metrics: true+ order_by: [{time_dimension(query), :asc}])+ |> Query.set_include(:drop_unavailable_revenue_metrics, true)|> QueryOptimizer.optimize()comparison_query =diff --git a/test/plausible_web/controllers/api/stats_controller/internal_query_api_test.exs b/test/plausible_web/controllers/api/stats_controller/internal_query_api_test.exsindex f97edfd238..63f815b3b7 100644--- a/test/plausible_web/controllers/api/stats_controller/internal_query_api_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/internal_query_api_test.exs@@ -10,6 +10,35 @@ defmodule PlausibleWeb.Api.StatsController.InternalQueryApiTest dosetup [:create_user, :log_in, :create_site]describe "aggregates (e.g. top stats)" do+ on_ee do+ test "drops revenue metrics when they are not allowed", %{+ conn: conn,+ user: user,+ site: site+ } do+ {:ok, team} = Plausible.Teams.get_or_create(user)+ insert(:goal, site: site, event_name: "Purchase", currency: "EUR")+ subscribe_to_growth_plan(team)++ params = %{+ "date_range" => "day",+ "filters" => [["is", "event:goal", ["Purchase"]]],+ "metrics" => [+ "visitors",+ "events",+ "conversion_rate",+ "total_revenue",+ "average_revenue"+ ]+ }++ %{"results" => results, "query" => query} = do_query_success(conn, site, params)++ assert query["metrics"] == ["visitors", "events", "conversion_rate"]+ assert results == [%{"dimensions" => [], "metrics" => [0, 0, 0.0]}]+ end+ end+test "returns empty metrics when no data", %{conn: conn, site: site} dorequested_metrics = ["visitors",