From 5fcee362b032cec815f3d132e2d45b74623f3aa5 Mon Sep 17 00:00:00 2001 From: Robert Joonas Date: Sun, 17 Mar 2024 19:46:14 +0000 Subject: [PATCH] Return graph_metric key from Top Stats API This commit introduces no behavioral changes - only starts returning an additional field, allowing us to avoid the following logic in React: 1. Finding the metric names, given a stat display name. E.g. `Unique visitors (last 30 min) -> visitors` 2. Checking if a metric is graphable or not --- .../controllers/api/stats_controller.ex | 90 ++++-- .../api/stats_controller/top_stats_test.exs | 260 +++++++++++++++--- 2 files changed, 277 insertions(+), 73 deletions(-) diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index 6b9798d10..44f059dc0 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -299,10 +299,12 @@ defmodule PlausibleWeb.Api.StatsController do }, %{ name: "Unique conversions (last 30 min)", + graph_metric: :visitors, value: unique_conversions }, %{ name: "Total conversions (last 30 min)", + graph_metric: :events, value: total_conversions } ] @@ -325,10 +327,12 @@ defmodule PlausibleWeb.Api.StatsController do }, %{ name: "Unique visitors (last 30 min)", + graph_metric: :visitors, value: visitors }, %{ name: "Pageviews (last 30 min)", + graph_metric: :pageviews, value: pageviews } ] @@ -345,15 +349,21 @@ defmodule PlausibleWeb.Api.StatsController do [ top_stats_entry(results, comparison, "Unique visitors", :total_visitors), - top_stats_entry(results, comparison, "Unique conversions", :visitors), - top_stats_entry(results, comparison, "Total conversions", :events), + top_stats_entry(results, comparison, "Unique conversions", :visitors, graphable?: true), + top_stats_entry(results, comparison, "Total conversions", :events, graphable?: true), on_full_build do - top_stats_entry(results, comparison, "Average revenue", :average_revenue, &format_money/1) + top_stats_entry(results, comparison, "Average revenue", :average_revenue, + formatter: &format_money/1, + graphable?: true + ) end, on_full_build do - top_stats_entry(results, comparison, "Total revenue", :total_revenue, &format_money/1) + top_stats_entry(results, comparison, "Total revenue", :total_revenue, + formatter: &format_money/1, + graphable?: true + ) end, - top_stats_entry(results, comparison, "Conversion rate", :conversion_rate) + top_stats_entry(results, comparison, "Conversion rate", :conversion_rate, graphable?: true) ] |> Enum.reject(&is_nil/1) |> then(&{&1, 100}) @@ -387,39 +397,63 @@ defmodule PlausibleWeb.Api.StatsController do stats = [ - top_stats_entry(current_results, prev_results, "Unique visitors", :visitors), - top_stats_entry(current_results, prev_results, "Total visits", :visits), - top_stats_entry(current_results, prev_results, "Total pageviews", :pageviews), - top_stats_entry(current_results, prev_results, "Views per visit", :views_per_visit), - top_stats_entry(current_results, prev_results, "Bounce rate", :bounce_rate), - top_stats_entry(current_results, prev_results, "Visit duration", :visit_duration), - top_stats_entry(current_results, prev_results, "Time on page", :time_on_page, fn - nil -> 0 - value -> value - end) + top_stats_entry(current_results, prev_results, "Unique visitors", :visitors, + graphable?: true + ), + top_stats_entry(current_results, prev_results, "Total visits", :visits, graphable?: true), + top_stats_entry(current_results, prev_results, "Total pageviews", :pageviews, + graphable?: true + ), + top_stats_entry(current_results, prev_results, "Views per visit", :views_per_visit, + graphable?: true + ), + top_stats_entry(current_results, prev_results, "Bounce rate", :bounce_rate, + graphable?: true + ), + top_stats_entry(current_results, prev_results, "Visit duration", :visit_duration, + graphable?: true + ), + top_stats_entry(current_results, prev_results, "Time on page", :time_on_page, + formatter: fn + nil -> 0 + value -> value + end + ) ] |> Enum.filter(& &1) {stats, current_results[:sample_percent][:value]} end - defp top_stats_entry(current_results, prev_results, name, key, formatter \\ & &1) do + defp top_stats_entry(current_results, prev_results, name, key, opts \\ []) do if current_results[key] do + formatter = Keyword.get(opts, :formatter, & &1) value = get_in(current_results, [key, :value]) - if prev_results do - prev_value = get_in(prev_results, [key, :value]) - change = Stats.Compare.calculate_change(key, prev_value, value) + %{name: name, value: formatter.(value)} + |> maybe_put_graph_metric(opts, key) + |> maybe_put_comparison(prev_results, key, value, formatter) + end + end - %{ - name: name, - value: formatter.(value), - comparison_value: formatter.(prev_value), - change: change - } - else - %{name: name, value: formatter.(value)} - end + defp maybe_put_graph_metric(entry, opts, key) do + if Keyword.get(opts, :graphable?) do + entry |> Map.put(:graph_metric, key) + else + entry + end + end + + defp maybe_put_comparison(entry, prev_results, key, value, formatter) do + if prev_results do + prev_value = get_in(prev_results, [key, :value]) + change = Stats.Compare.calculate_change(key, prev_value, value) + + entry + |> Map.put(:comparison_value, formatter.(prev_value)) + |> Map.put(:change, change) + else + entry end end diff --git a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs index 6ef32c322..3d34370d1 100644 --- a/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs +++ b/test/plausible_web/controllers/api/stats_controller/top_stats_test.exs @@ -6,6 +6,36 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do describe "GET /api/stats/top-stats - default" do setup [:create_user, :log_in, :create_new_site] + test "returns graph_metric key for graphable top stats", %{conn: conn, site: site} do + [visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration] = + conn + |> get("/api/stats/#{site.domain}/top-stats") + |> json_response(200) + |> Map.get("top_stats") + + assert %{"graph_metric" => "visitors"} = visitors + assert %{"graph_metric" => "visits"} = visits + assert %{"graph_metric" => "pageviews"} = pageviews + assert %{"graph_metric" => "views_per_visit"} = views_per_visit + assert %{"graph_metric" => "bounce_rate"} = bounce_rate + assert %{"graph_metric" => "visit_duration"} = visit_duration + end + + test "returns graph_metric key for graphable top stats in realtime mode", %{ + conn: conn, + site: site + } do + [current_visitors, unique_visitors, pageviews] = + conn + |> get("/api/stats/#{site.domain}/top-stats?period=realtime") + |> json_response(200) + |> Map.get("top_stats") + + refute Map.has_key?(current_visitors, "graph_metric") + assert %{"graph_metric" => "visitors"} = unique_visitors + assert %{"graph_metric" => "pageviews"} = pageviews + end + test "counts distinct user ids", %{conn: conn, site: site} do populate_stats(site, [ build(:pageview, user_id: @user_id), @@ -19,7 +49,8 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do assert %{ "name" => "Unique visitors", - "value" => 2 + "value" => 2, + "graph_metric" => "visitors" } in res["top_stats"] end @@ -36,7 +67,8 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do assert %{ "name" => "Total pageviews", - "value" => 3 + "value" => 3, + "graph_metric" => "pageviews" } in res["top_stats"] end @@ -59,12 +91,16 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) assert res["top_stats"] == [ - %{"name" => "Unique visitors", "value" => 2}, - %{"name" => "Total visits", "value" => 2}, - %{"name" => "Total pageviews", "value" => 2}, - %{"name" => "Views per visit", "value" => 2.0}, - %{"name" => "Bounce rate", "value" => 0}, - %{"name" => "Visit duration", "value" => 120} + %{"name" => "Unique visitors", "value" => 2, "graph_metric" => "visitors"}, + %{"name" => "Total visits", "value" => 2, "graph_metric" => "visits"}, + %{"name" => "Total pageviews", "value" => 2, "graph_metric" => "pageviews"}, + %{ + "name" => "Views per visit", + "value" => 2.0, + "graph_metric" => "views_per_visit" + }, + %{"name" => "Bounce rate", "value" => 0, "graph_metric" => "bounce_rate"}, + %{"name" => "Visit duration", "value" => 120, "graph_metric" => "visit_duration"} ] end @@ -80,7 +116,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Views per visit", "value" => 1.33} in res["top_stats"] + assert %{"name" => "Views per visit", "value" => 1.33, "graph_metric" => "views_per_visit"} in res[ + "top_stats" + ] end test "calculates bounce rate", %{conn: conn, site: site} do @@ -94,7 +132,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Bounce rate", "value" => 50} in res["top_stats"] + assert %{"name" => "Bounce rate", "value" => 50, "graph_metric" => "bounce_rate"} in res[ + "top_stats" + ] end test "calculates average visit duration", %{conn: conn, site: site} do @@ -116,7 +156,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Visit duration", "value" => 450} in res["top_stats"] + assert %{"name" => "Visit duration", "value" => 450, "graph_metric" => "visit_duration"} in res[ + "top_stats" + ] end test "calculates time on page instead when filtered for page", %{conn: conn, site: site} do @@ -339,7 +381,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do filters = Jason.encode!(%{page: "/"}) path = "/api/stats/#{site.domain}/top-stats?period=day&date=2021-01-01&filters=#{filters}" - assert %{"name" => "Bounce rate", "value" => 0} == + assert %{"name" => "Bounce rate", "value" => 0, "graph_metric" => "bounce_rate"} == conn |> get(path) |> json_response(200) @@ -435,9 +477,17 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Bounce rate", "value" => 0} in res["top_stats"] - assert %{"name" => "Views per visit", "value" => 0.0} in res["top_stats"] - assert %{"name" => "Visit duration", "value" => 0} in res["top_stats"] + assert %{"name" => "Bounce rate", "value" => 0, "graph_metric" => "bounce_rate"} in res[ + "top_stats" + ] + + assert %{"name" => "Views per visit", "value" => 0.0, "graph_metric" => "views_per_visit"} in res[ + "top_stats" + ] + + assert %{"name" => "Visit duration", "value" => 0, "graph_metric" => "visit_duration"} in res[ + "top_stats" + ] end test "merges imported data into all top stat metrics", %{ @@ -468,12 +518,16 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) assert res["top_stats"] == [ - %{"name" => "Unique visitors", "value" => 3}, - %{"name" => "Total visits", "value" => 3}, - %{"name" => "Total pageviews", "value" => 4}, - %{"name" => "Views per visit", "value" => 1.33}, - %{"name" => "Bounce rate", "value" => 33}, - %{"name" => "Visit duration", "value" => 303} + %{"name" => "Unique visitors", "value" => 3, "graph_metric" => "visitors"}, + %{"name" => "Total visits", "value" => 3, "graph_metric" => "visits"}, + %{"name" => "Total pageviews", "value" => 4, "graph_metric" => "pageviews"}, + %{ + "name" => "Views per visit", + "value" => 1.33, + "graph_metric" => "views_per_visit" + }, + %{"name" => "Bounce rate", "value" => 33, "graph_metric" => "bounce_rate"}, + %{"name" => "Visit duration", "value" => 303, "graph_metric" => "visit_duration"} ] end end @@ -504,7 +558,12 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=realtime") res = json_response(conn, 200) - assert %{"name" => "Unique visitors (last 30 min)", "value" => 2} in res["top_stats"] + + assert %{ + "name" => "Unique visitors (last 30 min)", + "value" => 2, + "graph_metric" => "visitors" + } in res["top_stats"] end test "shows pageviews (last 30 minutes)", %{conn: conn, site: site} do @@ -518,7 +577,10 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=realtime") res = json_response(conn, 200) - assert %{"name" => "Pageviews (last 30 min)", "value" => 3} in res["top_stats"] + + assert %{"name" => "Pageviews (last 30 min)", "value" => 3, "graph_metric" => "pageviews"} in res[ + "top_stats" + ] end test "shows current visitors (last 5 min) with goal filter", %{conn: conn, site: site} do @@ -554,14 +616,77 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do conn = get(conn, "/api/stats/#{site.domain}/top-stats?period=realtime&filters=#{filters}") res = json_response(conn, 200) - assert %{"name" => "Unique conversions (last 30 min)", "value" => 2} in res["top_stats"] - assert %{"name" => "Total conversions (last 30 min)", "value" => 4} in res["top_stats"] + + assert %{ + "name" => "Unique conversions (last 30 min)", + "value" => 2, + "graph_metric" => "visitors" + } in res["top_stats"] + + assert %{ + "name" => "Total conversions (last 30 min)", + "value" => 4, + "graph_metric" => "events" + } in res["top_stats"] end end describe "GET /api/stats/top-stats - filters" do setup [:create_user, :log_in, :create_new_site] + test "returns graph_metric key for graphable top stats with a page filter", %{ + conn: conn, + site: site + } do + filters = Jason.encode!(%{page: "/A"}) + + [visitors, visits, pageviews, bounce_rate, time_on_page] = + conn + |> get("/api/stats/#{site.domain}/top-stats?filters=#{filters}") + |> json_response(200) + |> Map.get("top_stats") + + assert %{"graph_metric" => "visitors"} = visitors + assert %{"graph_metric" => "visits"} = visits + assert %{"graph_metric" => "pageviews"} = pageviews + assert %{"graph_metric" => "bounce_rate"} = bounce_rate + + refute Map.has_key?(time_on_page, "graph_metric") + end + + test "returns graph_metric key for graphable top stats with a goal filter", %{ + conn: conn, + site: site + } do + filters = Jason.encode!(%{goal: "Signup"}) + + [unique_visitors, unique_conversions, total_conversions, cr] = + conn + |> get("/api/stats/#{site.domain}/top-stats?filters=#{filters}") + |> json_response(200) + |> Map.get("top_stats") + + refute Map.has_key?(unique_visitors, "graph_metric") + assert %{"graph_metric" => "visitors"} = unique_conversions + assert %{"graph_metric" => "events"} = total_conversions + assert %{"graph_metric" => "conversion_rate"} = cr + end + + test "returns graph_metric key for graphable top stats with a goal filter in realtime mode", + %{conn: conn, site: site} do + filters = Jason.encode!(%{goal: "Signup"}) + + [current_visitors, unique_conversions, total_conversions] = + conn + |> get("/api/stats/#{site.domain}/top-stats?period=realtime&filters=#{filters}") + |> json_response(200) + |> Map.get("top_stats") + + refute Map.has_key?(current_visitors, "graph_metric") + assert %{"graph_metric" => "visitors"} = unique_conversions + assert %{"graph_metric" => "events"} = total_conversions + end + test "returns only visitors from a country based on alpha2 code", %{conn: conn, site: site} do populate_stats(site, [ build(:pageview, country_code: "US"), @@ -579,7 +704,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2, "graph_metric" => "visitors"} in res[ + "top_stats" + ] end test "page glob filter", %{conn: conn, site: site} do @@ -599,7 +726,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2, "graph_metric" => "visitors"} in res[ + "top_stats" + ] end test "contains (~) filter", %{conn: conn, site: site} do @@ -619,7 +748,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2, "graph_metric" => "visitors"} in res[ + "top_stats" + ] end test "returns only visitors with specific screen size", %{conn: conn, site: site} do @@ -639,7 +770,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2, "graph_metric" => "visitors"} in res[ + "top_stats" + ] end test "returns only visitors with specific browser", %{conn: conn, site: site} do @@ -659,7 +792,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2, "graph_metric" => "visitors"} in res[ + "top_stats" + ] end test "returns only visitors with specific operating system", %{conn: conn, site: site} do @@ -679,7 +814,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Unique visitors", "value" => 2} in res["top_stats"] + assert %{"name" => "Unique visitors", "value" => 2, "graph_metric" => "visitors"} in res[ + "top_stats" + ] end test "returns number of visits from one specific referral source", %{conn: conn, site: site} do @@ -712,7 +849,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Total visits", "value" => 2} in res["top_stats"] + assert %{"name" => "Total visits", "value" => 2, "graph_metric" => "visits"} in res[ + "top_stats" + ] end test "does not return the views_per_visit metric when a page filter is applied", %{ @@ -782,7 +921,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Unique conversions", "value" => 1} in res["top_stats"] + assert %{"name" => "Unique conversions", "value" => 1, "graph_metric" => "visitors"} in res[ + "top_stats" + ] end test "returns conversion rate", %{conn: conn, site: site} do @@ -803,7 +944,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Conversion rate", "value" => 33.3} in res["top_stats"] + assert %{"name" => "Conversion rate", "value" => 33.3, "graph_metric" => "conversion_rate"} in res[ + "top_stats" + ] end test "returns conversion rate without change when comparison mode disallowed", %{ @@ -827,7 +970,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Conversion rate", "value" => 33.3} in res["top_stats"] + assert %{"name" => "Conversion rate", "value" => 33.3, "graph_metric" => "conversion_rate"} in res[ + "top_stats" + ] end @tag :full_build_only @@ -864,12 +1009,14 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do assert %{ "name" => "Average revenue", - "value" => %{"long" => "$1,659.50", "short" => "$1.7K"} + "value" => %{"long" => "$1,659.50", "short" => "$1.7K"}, + "graph_metric" => "average_revenue" } in top_stats assert %{ "name" => "Total revenue", - "value" => %{"long" => "$3,319.00", "short" => "$3.3K"} + "value" => %{"long" => "$3,319.00", "short" => "$3.3K"}, + "graph_metric" => "total_revenue" } in top_stats end @@ -921,12 +1068,14 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do assert %{ "name" => "Average revenue", - "value" => %{"long" => "$1,659.50", "short" => "$1.7K"} + "value" => %{"long" => "$1,659.50", "short" => "$1.7K"}, + "graph_metric" => "average_revenue" } in top_stats assert %{ "name" => "Total revenue", - "value" => %{"long" => "$6,638.00", "short" => "$6.6K"} + "value" => %{"long" => "$6,638.00", "short" => "$6.6K"}, + "graph_metric" => "total_revenue" } in top_stats end @@ -993,7 +1142,7 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do describe "GET /api/stats/top-stats - with comparisons" do setup [:create_user, :log_in, :create_new_site, :add_imported_data] - test "defaults to previous period when comparison is not set", %{site: site, conn: conn} do + test "does not return comparisons by default", %{site: site, conn: conn} do populate_stats(site, [ build(:pageview, timestamp: ~N[2020-12-31 00:00:00]), build(:pageview, timestamp: ~N[2020-12-31 00:00:00]), @@ -1006,7 +1155,9 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"name" => "Total visits", "value" => 3} in res["top_stats"] + assert %{"name" => "Total visits", "value" => 3, "graph_metric" => "visits"} in res[ + "top_stats" + ] end test "returns comparison data when mode is custom", %{site: site, conn: conn} do @@ -1028,7 +1179,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do res = json_response(conn, 200) - assert %{"change" => 0, "comparison_value" => 3, "name" => "Total visits", "value" => 3} in res[ + assert %{ + "change" => 0, + "comparison_value" => 3, + "name" => "Total visits", + "value" => 3, + "graph_metric" => "visits" + } in res[ "top_stats" ] end @@ -1087,7 +1244,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do assert %{"top_stats" => top_stats, "with_imported" => true} = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 2, "name" => "Total visits", "value" => 4} in top_stats + assert %{ + "change" => 100, + "comparison_value" => 2, + "name" => "Total visits", + "value" => 4, + "graph_metric" => "visits" + } in top_stats end test "does not compare imported data when with_imported is set to false", %{ @@ -1122,7 +1285,13 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do assert %{"top_stats" => top_stats, "with_imported" => false} = json_response(conn, 200) - assert %{"change" => 100, "comparison_value" => 0, "name" => "Total visits", "value" => 4} in top_stats + assert %{ + "change" => 100, + "comparison_value" => 0, + "name" => "Total visits", + "value" => 4, + "graph_metric" => "visits" + } in top_stats end test "compares conversion rates", %{conn: conn, site: site} do @@ -1150,7 +1319,8 @@ defmodule PlausibleWeb.Api.StatsController.TopStatsTest do "change" => -33.4, "comparison_value" => 66.7, "name" => "Conversion rate", - "value" => 33.3 + "value" => 33.3, + "graph_metric" => "conversion_rate" } in res["top_stats"] end end