Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Safeguard sign-dependent metrics from negative values (#5569)

Adrian Gruntkowski8da98fb26ed6
diff --git a/lib/plausible/stats/sql/expression.ex b/lib/plausible/stats/sql/expression.ex
index 5f03022c4d..9c01185ec8 100644
--- a/lib/plausible/stats/sql/expression.ex
+++ b/lib/plausible/stats/sql/expression.ex
@@ -328,31 +328,31 @@ defmodule Plausible.Stats.SQL.Expression do
^condition,
^condition
),
- __internal_visits: fragment("toUInt32(sum(sign))")
+ __internal_visits: fragment("toUInt32(greatest(sum(sign), 0))")
})
end
def session_metric(:exit_rate, _query) do
wrap_alias([s], %{
- __internal_visits: fragment("toUInt32(sum(sign))")
+ __internal_visits: fragment("toUInt32(greatest(sum(sign), 0))")
})
end
def session_metric(:visits, _query) do
wrap_alias([s], %{
- visits: scale_sample(fragment("sum(?)", s.sign))
+ visits: scale_sample(fragment("greatest(sum(?), 0)", s.sign))
})
end
def session_metric(:pageviews, _query) do
wrap_alias([s], %{
- pageviews: scale_sample(fragment("sum(? * ?)", s.sign, s.pageviews))
+ pageviews: scale_sample(fragment("greatest(sum(? * ?), 0)", s.sign, s.pageviews))
})
end
def session_metric(:events, _query) do
wrap_alias([s], %{
- events: scale_sample(fragment("sum(? * ?)", s.sign, s.events))
+ events: scale_sample(fragment("greatest(sum(? * ?), 0)", s.sign, s.events))
})
end
@@ -365,8 +365,8 @@ defmodule Plausible.Stats.SQL.Expression do
def session_metric(:visit_duration, _query) do
wrap_alias([], %{
visit_duration:
- fragment("toUInt32(ifNotFinite(round(sum(duration * sign) / sum(sign)), 0))"),
- __internal_visits: fragment("toUInt32(sum(sign))")
+ fragment("toUInt32(greatest(ifNotFinite(round(sum(duration * sign) / sum(sign)), 0), 0))"),
+ __internal_visits: fragment("toUInt32(greatest(sum(sign), 0))")
})
end
@@ -374,12 +374,12 @@ defmodule Plausible.Stats.SQL.Expression do
wrap_alias([s], %{
views_per_visit:
fragment(
- "ifNotFinite(round(sum(? * ?) / sum(?), 2), 0)",
+ "greatest(ifNotFinite(round(sum(? * ?) / sum(?), 2), 0), 0)",
s.sign,
s.pageviews,
s.sign
),
- __internal_visits: fragment("toUInt32(sum(sign))")
+ __internal_visits: fragment("toUInt32(greatest(sum(sign), 0))")
})
end
diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_test.exs
index a7ece059b3..45f62ac7c5 100644
--- a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs
+++ b/test/plausible_web/controllers/api/external_stats_controller/query_test.exs
@@ -3633,6 +3633,69 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryTest do
]
end
+ test "visits, visit_duration and views_per_visit calculation handles invalid session data gracefully",
+ %{
+ conn: conn,
+ site: site
+ } do
+ # NOTE: At the time of this test is added, it appears it does _not_
+ # catch the regression on MacOS (ARM), regardless if Clickhouse is run
+ # natively or from a docker container. The test still does catch
+ # that regression when ran on Linux for instance (including CI).
+
+ user_id = System.unique_integer([:positive])
+
+ populate_stats(site, [
+ build(:pageview,
+ user_id: user_id,
+ pathname: "/",
+ timestamp: ~N[2021-01-01 00:00:00]
+ )
+ ])
+
+ session =
+ Plausible.IngestRepo.get_by!(Plausible.ClickhouseSessionV2,
+ site_id: site.id,
+ user_id: user_id
+ )
+
+ # The session values are manually manipulated to trigger negative values for certain metrics
+ negative1 = %{session | pageviews: 0, events: session.events + 1, sign: -1}
+ negative2 = %{session | pageviews: 0, events: session.events + 2, sign: -1}
+
+ Plausible.Session.WriteBuffer.insert([negative1, negative2])
+ Plausible.Session.WriteBuffer.flush()
+
+ conn =
+ post(conn, "/api/v2/query", %{
+ "site_id" => site.domain,
+ "date_range" => "all",
+ "metrics" => [
+ "visits",
+ "visit_duration"
+ ],
+ "dimensions" => ["visit:exit_page"]
+ })
+
+ assert json_response(conn, 200)["results"] == [
+ %{"dimensions" => ["/"], "metrics" => [0, 0]}
+ ]
+
+ conn =
+ post(conn, "/api/v2/query", %{
+ "site_id" => site.domain,
+ "date_range" => "all",
+ "metrics" => [
+ "views_per_visit"
+ ],
+ "dimensions" => []
+ })
+
+ assert json_response(conn, 200)["results"] == [
+ %{"dimensions" => [], "metrics" => [0]}
+ ]
+ end
+
describe "using the returned query object in a new POST request" do
test "yields the same results for a simple aggregate query", %{conn: conn, site: site} do
Plausible.Site.changeset(site, %{timezone: "Europe/Tallinn"})