Skip to content

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

Improve test coverage and fix stats API and dashboard CSV export (#4110)

Adrian Gruntkowski756d9c28ce0c
diff --git a/lib/plausible/stats/imported.ex b/lib/plausible/stats/imported.ex
index 7d4b2faf24..0d24634459 100644
--- a/lib/plausible/stats/imported.ex
+++ b/lib/plausible/stats/imported.ex
@@ -332,6 +332,18 @@ defmodule Plausible.Stats.Imported do
|> select_imported_metrics(rest)
end
+ defp select_imported_metrics(
+ %Ecto.Query{from: %Ecto.Query.FromExpr{source: {"imported_exit_pages", _}}} = q,
+ [:bounce_rate | rest]
+ ) do
+ q
+ |> select_merge([i], %{
+ bounces: sum(i.bounces),
+ __internal_visits: sum(i.exits)
+ })
+ |> select_imported_metrics(rest)
+ end
+
defp select_imported_metrics(q, [:bounce_rate | rest]) do
q
|> select_merge([i], %{
@@ -353,6 +365,18 @@ defmodule Plausible.Stats.Imported do
|> select_imported_metrics(rest)
end
+ defp select_imported_metrics(
+ %Ecto.Query{from: %Ecto.Query.FromExpr{source: {"imported_exit_pages", _}}} = q,
+ [:visit_duration | rest]
+ ) do
+ q
+ |> select_merge([i], %{
+ visit_duration: sum(i.visit_duration),
+ __internal_visits: sum(i.exits)
+ })
+ |> select_imported_metrics(rest)
+ end
+
defp select_imported_metrics(q, [:visit_duration | rest]) do
q
|> select_merge([i], %{
diff --git a/lib/plausible_web/controllers/api/external_stats_controller.ex b/lib/plausible_web/controllers/api/external_stats_controller.ex
index a14abf6cd7..01424f50a2 100644
--- a/lib/plausible_web/controllers/api/external_stats_controller.ex
+++ b/lib/plausible_web/controllers/api/external_stats_controller.ex
@@ -68,11 +68,17 @@ defmodule PlausibleWeb.Api.ExternalStatsController do
end
defp validate_property(%{"property" => property}) do
- if Plausible.Stats.Props.valid_prop?(property) do
- :ok
- else
- {:error,
- "Invalid property '#{property}'. Please provide a valid property for the breakdown endpoint: https://plausible.io/docs/stats-api#properties"}
+ cond do
+ property == "event:hostname" ->
+ {:error,
+ "Property 'event:hostname' is currently not supported for breakdowns. Please provide a valid property for the breakdown endpoint: https://plausible.io/docs/stats-api#properties"}
+
+ Plausible.Stats.Props.valid_prop?(property) ->
+ :ok
+
+ true ->
+ {:error,
+ "Invalid property '#{property}'. Please provide a valid property for the breakdown endpoint: https://plausible.io/docs/stats-api#properties"}
end
end
diff --git a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs
index 1e009fde54..acc074480c 100644
--- a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs
+++ b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs
@@ -949,6 +949,109 @@ defmodule PlausibleWeb.Api.ExternalStatsController.BreakdownTest do
assert json_response(conn, 200) == %{"results" => []}
end
+ test "attempting to breakdown by event:hostname returns an error", %{conn: conn, site: site} do
+ conn =
+ get(conn, "/api/v1/stats/breakdown", %{
+ "site_id" => site.domain,
+ "period" => "day",
+ "date" => "2021-01-01",
+ "property" => "event:hostname",
+ "with_imported" => "true"
+ })
+
+ assert %{
+ "error" => error
+ } = json_response(conn, 400)
+
+ assert error =~ "Property 'event:hostname' is currently not supported for breakdowns."
+ end
+
+ describe "breakdown by visit:exit_page" do
+ setup %{site: site} do
+ site_import = insert(:site_import, site: site)
+
+ populate_stats(site, site_import.id, [
+ build(:pageview,
+ pathname: "/a",
+ timestamp: ~N[2021-01-01 00:00:00]
+ ),
+ build(:pageview,
+ user_id: @user_id,
+ pathname: "/a",
+ timestamp: ~N[2021-01-01 00:25:00]
+ ),
+ build(:pageview,
+ user_id: @user_id,
+ pathname: "/b",
+ timestamp: ~N[2021-01-01 00:35:00]
+ ),
+ build(:imported_exit_pages,
+ exit_page: "/b",
+ exits: 3,
+ visitors: 2,
+ pageviews: 5,
+ date: ~D[2021-01-01]
+ )
+ ])
+ end
+
+ test "can breakdown by visit:exit_page", %{conn: conn, site: site} do
+ conn =
+ get(conn, "/api/v1/stats/breakdown", %{
+ "site_id" => site.domain,
+ "period" => "day",
+ "date" => "2021-01-01",
+ "property" => "visit:exit_page",
+ "with_imported" => "true"
+ })
+
+ assert json_response(conn, 200) == %{
+ "results" => [
+ %{"exit_page" => "/b", "visitors" => 3},
+ %{"exit_page" => "/a", "visitors" => 1}
+ ]
+ }
+ end
+
+ test "handles all applicable metrics with graceful fallback for imported data when needed", %{
+ conn: conn,
+ site: site
+ } do
+ conn =
+ get(conn, "/api/v1/stats/breakdown", %{
+ "site_id" => site.domain,
+ "period" => "day",
+ "date" => "2021-01-01",
+ "property" => "visit:exit_page",
+ "metrics" => "visitors,visits,pageviews,bounce_rate,visit_duration,events",
+ "with_imported" => "true"
+ })
+
+ assert json_response(conn, 200) == %{
+ "results" => [
+ %{
+ "bounce_rate" => 0.0,
+ "events" => 7,
+ "exit_page" => "/b",
+ "pageviews" => 7,
+ "visit_duration" => 150.0,
+ "visitors" => 3,
+ "visits" => 4
+ },
+ %{
+ "bounce_rate" => 100.0,
+ "events" => 1,
+ "exit_page" => "/a",
+ "pageviews" => 1,
+ "visit_duration" => 0.0,
+ "visitors" => 1,
+ "visits" => 1
+ }
+ ]
+ }
+ end
+ end
+
describe "custom events" do
test "can breakdown by event:name", %{conn: conn, site: site} do
populate_stats(site, [
diff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exs
index 05b9c1f351..89821c5218 100644
--- a/test/plausible_web/controllers/stats_controller_test.exs
+++ b/test/plausible_web/controllers/stats_controller_test.exs
@@ -341,6 +341,213 @@ defmodule PlausibleWeb.StatsControllerTest do
[""]
]
end
+
+ test "exports imported data when requested", %{conn: conn, site: site} do
+ site_import = insert(:site_import, site: site)
+
+ insert(:goal, site: site, event_name: "Outbound Link: Click")
+
+ populate_stats(site, site_import.id, [
+ build(:imported_visitors, visitors: 9),
+ build(:imported_browsers, browser: "Chrome", pageviews: 1),
+ build(:imported_devices, device: "Desktop", pageviews: 1),
+ build(:imported_entry_pages, entry_page: "/test", pageviews: 1),
+ build(:imported_exit_pages, exit_page: "/test", pageviews: 1),
+ build(:imported_locations,
+ country: "PL",
+ region: "PL-22",
+ city: 3_099_434,
+ pageviews: 1
+ ),
+ build(:imported_operating_systems, operating_system: "Mac", pageviews: 1),
+ build(:imported_pages, page: "/test", pageviews: 1),
+ build(:imported_sources,
+ source: "Google",
+ utm_medium: "search",
+ utm_campaign: "ads",
+ utm_source: "google",
+ utm_content: "content",
+ utm_term: "term",
+ pageviews: 1
+ ),
+ build(:imported_custom_events,
+ name: "Outbound Link: Click",
+ link_url: "https://example.com",
+ visitors: 5,
+ events: 10
+ )
+ ])
+
+ conn = get(conn, "/#{site.domain}/export?with_imported=true")
+
+ assert response = response(conn, 200)
+ {:ok, zip} = :zip.unzip(response, [:memory])
+
+ filenames = zip |> Enum.map(fn {filename, _} -> to_string(filename) end)
+
+ # NOTE: currently, custom_props.csv is not populated from imported data
+ expected_filenames = [
+ "visitors.csv",
+ "sources.csv",
+ "utm_mediums.csv",
+ "utm_sources.csv",
+ "utm_campaigns.csv",
+ "utm_contents.csv",
+ "utm_terms.csv",
+ "pages.csv",
+ "entry_pages.csv",
+ "exit_pages.csv",
+ "countries.csv",
+ "regions.csv",
+ "cities.csv",
+ "browsers.csv",
+ "browser_versions.csv",
+ "operating_systems.csv",
+ "operating_system_versions.csv",
+ "devices.csv",
+ "conversions.csv",
+ "referrers.csv"
+ ]
+
+ Enum.each(expected_filenames, fn expected ->
+ assert expected in filenames
+ end)
+
+ Enum.each(zip, fn
+ {~c"visitors.csv", data} ->
+ csv = parse_csv(data)
+
+ assert List.first(csv) == [
+ "date",
+ "visitors",
+ "pageviews",
+ "visits",
+ "views_per_visit",
+ "bounce_rate",
+ "visit_duration"
+ ]
+
+ assert Enum.at(csv, -2) ==
+ [Date.to_iso8601(Date.utc_today()), "9", "1", "1", "1.0", "0.0", "10.0"]
+
+ {~c"sources.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors", "bounce_rate", "visit_duration"],
+ ["Google", "1", "0.0", "10.0"],
+ [""]
+ ]
+
+ {~c"utm_mediums.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors", "bounce_rate", "visit_duration"],
+ ["search", "1", "0.0", "10.0"],
+ [""]
+ ]
+
+ {~c"utm_sources.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors", "bounce_rate", "visit_duration"],
+ ["google", "1", "0.0", "10.0"],
+ [""]
+ ]
+
+ {~c"utm_campaigns.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors", "bounce_rate", "visit_duration"],
+ ["ads", "1", "0.0", "10.0"],
+ [""]
+ ]
+
+ {~c"utm_contents.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors", "bounce_rate", "visit_duration"],
+ ["content", "1", "0.0", "10.0"],
+ [""]
+ ]
+
+ {~c"utm_terms.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors", "bounce_rate", "visit_duration"],
+ ["term", "1", "0.0", "10.0"],
+ [""]
+ ]
+
+ {~c"pages.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors", "pageviews", "bounce_rate", "time_on_page"],
+ ["/test", "1", "1", "0.0", "10.0"],
+ [""]
+ ]
+
+ {~c"entry_pages.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "unique_entrances", "total_entrances", "visit_duration"],
+ ["/test", "1", "1", "10.0"],
+ [""]
+ ]
+
+ {~c"exit_pages.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "unique_exits", "total_exits", "exit_rate"],
+ ["/test", "1", "1", "100.0"],
+ [""]
+ ]
+
+ {~c"countries.csv", data} ->
+ assert parse_csv(data) == [["name", "visitors"], ["Poland", "1"], [""]]
+
+ {~c"regions.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors"],
+ ["Pomerania", "1"],
+ [""]
+ ]
+
+ {~c"cities.csv", data} ->
+ assert parse_csv(data) == [["name", "visitors"], ["Gdańsk", "1"], [""]]
+
+ {~c"browsers.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors"],
+ ["Chrome", "1"],
+ [""]
+ ]
+
+ {~c"browser_versions.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "version", "visitors"],
+ ["Chrome", "(not set)", "1"],
+ [""]
+ ]
+
+ {~c"operating_systems.csv", data} ->
+ assert parse_csv(data) == [["name", "visitors"], ["Mac", "1"], [""]]
+
+ {~c"operating_system_versions.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "version", "visitors"],
+ ["Mac", "(not set)", "1"],
+ [""]
+ ]
+
+ {~c"devices.csv", data} ->
+ assert parse_csv(data) == [["name", "visitors"], ["Desktop", "1"], [""]]
+
+ {~c"conversions.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "unique_conversions", "total_conversions"],
+ ["Outbound Link: Click", "5", "10"],
+ [""]
+ ]
+
+ {~c"referrers.csv", data} ->
+ assert parse_csv(data) == [
+ ["name", "visitors", "bounce_rate", "visit_duration"],
+ ["Direct / None", "1", "0.0", "10.0"],
+ [""]
+ ]
+ end)
+ end
end
defp parse_csv(file_content) when is_binary(file_content) do