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
Add per-site pageview breakdown to pageview usage section (#6097)
Sanne de Vries9eb884e77c9e
diff --git a/lib/plausible/stats/clickhouse.ex b/lib/plausible/stats/clickhouse.exindex dd652d8d42..66f31cdcb0 100644--- a/lib/plausible/stats/clickhouse.ex+++ b/lib/plausible/stats/clickhouse.ex@@ -76,6 +76,40 @@ defmodule Plausible.Stats.Clickhouse dodef usage_breakdown([], _date_range), do: {0, 0}+ def per_site_usage_breakdown(+ site_ids,+ date_range,+ limit \\ Plausible.Teams.Billing.max_sites_for_usage_breakdown()+ )++ def per_site_usage_breakdown([], _date_range, _limit), do: []++ def per_site_usage_breakdown(+ [sid | _] = site_ids,+ date_range,+ limit+ )+ when is_integer(sid) and length(site_ids) <= limit do+ ClickhouseRepo.all(+ from(e in "events_v2",+ where: e.site_id in ^site_ids,+ where: e.name != "engagement",+ where: fragment("toDate(?)", e.timestamp) >= ^date_range.first,+ where: fragment("toDate(?)", e.timestamp) <= ^date_range.last,+ group_by: e.site_id,+ order_by: [+ desc: fragment("countIf(? = 'pageview') + countIf(? != 'pageview')", e.name, e.name)+ ],+ limit: ^limit,+ select: {+ e.site_id,+ fragment("countIf(? = 'pageview')", e.name),+ fragment("countIf(? != 'pageview')", e.name)+ }+ )+ )+ end+def current_visitors(site) doStats.current_visitors(site)enddiff --git a/lib/plausible/teams/billing.ex b/lib/plausible/teams/billing.exindex 828eb02838..dacf595c6f 100644--- a/lib/plausible/teams/billing.ex+++ b/lib/plausible/teams/billing.ex@@ -21,6 +21,9 @@ defmodule Plausible.Teams.Billing do@limit_sites_since ~D[2021-05-05]+ @max_sites_for_usage_breakdown 10+ def max_sites_for_usage_breakdown, do: @max_sites_for_usage_breakdown+@typep last_30_days_usage() :: %{:last_30_days => Quota.usage_cycle()}@typep monthly_pageview_usage() :: Quota.cycles_usage() | last_30_days_usage()@@ -426,7 +429,8 @@ defmodule Plausible.Teams.Billing dodate_range: date_range,pageviews: pageviews,custom_events: custom_events,- total: pageviews + custom_events+ total: pageviews + custom_events,+ sites: per_site_usage(owned_site_ids, date_range)}end@@ -465,10 +469,50 @@ defmodule Plausible.Teams.Billing dodate_range: date_range,pageviews: pageviews,custom_events: custom_events,- total: pageviews + custom_events+ total: pageviews + custom_events,+ sites: per_site_usage(owned_site_ids, date_range)}end+ defp per_site_usage(owned_site_ids, _date_range)+ when length(owned_site_ids) <= 1 or length(owned_site_ids) > @max_sites_for_usage_breakdown,+ do: []++ defp per_site_usage(owned_site_ids, date_range) do+ per_site_usage_breakdown =+ Plausible.Stats.Clickhouse.per_site_usage_breakdown(owned_site_ids, date_range)++ active_site_ids = Enum.map(per_site_usage_breakdown, fn {site_id, _, _} -> site_id end)+ inactive_site_ids = owned_site_ids -- active_site_ids++ domains =+ Map.new(+ Repo.all(+ from(s in Plausible.Site,+ where: s.id in ^owned_site_ids,+ select: {s.id, s.domain}+ )+ )+ )++ usage_mapping =+ Map.new(per_site_usage_breakdown, fn {site_id, pageviews, custom_events} ->+ {site_id, %{pageviews: pageviews, custom_events: custom_events}}+ end)++ Enum.map(active_site_ids ++ inactive_site_ids, fn site_id ->+ pageviews = usage_mapping[site_id][:pageviews] || 0+ custom_events = usage_mapping[site_id][:custom_events] || 0++ %{+ domain: Map.get(domains, site_id),+ pageviews: pageviews,+ custom_events: custom_events,+ total: pageviews + custom_events+ }+ end)+ end+@spec features_usage(Teams.Team.t() | nil, list() | nil) :: [atom()]@doc """Given only a team, this function returns the features used across all thediff --git a/lib/plausible_web/components/billing/billing.ex b/lib/plausible_web/components/billing/billing.exindex 1fe4f7710a..95bc7a1116 100644--- a/lib/plausible_web/components/billing/billing.ex+++ b/lib/plausible_web/components/billing/billing.ex@@ -75,7 +75,7 @@ defmodule PlausibleWeb.Components.Billing dousage={@usage.current_cycle}limit={@limit}period={:current_cycle}- expanded={not @show_all}+ expanded={not @show_all and Enum.empty?(@usage.current_cycle.sites)}/><%= if @show_all do %><.monthly_pageview_usage_breakdown@@ -110,7 +110,10 @@ defmodule PlausibleWeb.Components.Billing do</p><.usage_progress_bar id={"total_pageviews_#{@period}"} usage={@usage.total} limit={@limit} /></div>- <button class="flex justify-between items-center w-full text-left" x-on:click="open = !open">+ <button+ class="flex justify-between items-center flex-wrap w-full text-left"+ x-on:click="open = !open"+ ><span class="flex items-center gap-1 text-sm font-medium text-gray-900 dark:text-gray-100"><Heroicons.chevron_rightmini@@ -118,30 +121,59 @@ defmodule PlausibleWeb.Components.Billing dox-bind:class="open ? 'rotate-90' : ''"/> Total billable pageviews</span>- <span class="text-sm font-medium text-gray-900 dark:text-gray-100">+ <span class="ml-5 text-sm font-medium text-gray-900 dark:text-gray-100">{PlausibleWeb.TextHelpers.number_format(@usage.total)}{if is_number(@limit), do: "/ #{PlausibleWeb.TextHelpers.number_format(@limit)}"}{if @limit == :unlimited, do: "/ Unlimited"}</span></button><div x-show="open" class="flex flex-col gap-3 text-sm text-gray-900 dark:text-gray-100">- <div id={"pageviews_#{@period}"} class="flex justify-between">- <span>- <span class="inline-block size-4 mr-1 text-center">•</span> Pageviews- </span>- <span>{PlausibleWeb.TextHelpers.number_format(@usage.pageviews)}</span>- </div>- <div id={"custom_events_#{@period}"} class="flex justify-between">- <span>- <span class="inline-block size-4 mr-1 text-center">•</span> Custom events- </span>- <span>{PlausibleWeb.TextHelpers.number_format(@usage.custom_events)}</span>+ <.pageview_usage_row+ id={"pageviews_#{@period}"}+ label={if Enum.empty?(@usage.sites), do: "Pageviews", else: "Total pageviews"}+ value={@usage.pageviews}+ />+ <.pageview_usage_row+ id={"custom_events_#{@period}"}+ label={if Enum.empty?(@usage.sites), do: "Custom events", else: "Total custom events"}+ value={@usage.custom_events}+ />+ <div+ :if={not Enum.empty?(@usage.sites)}+ id={"per_site_breakdown_#{@period}"}+ class="flex flex-col gap-3 border-t border-gray-200 dark:border-gray-700 pt-3 pl-5"+ >+ <div :for={{site, index} <- Enum.with_index(@usage.sites)} class="flex flex-col gap-3">+ <hr :if={index > 0} class="border-gray-200 dark:border-gray-700" />+ <div class="flex justify-between flex-wrap font-medium">+ <span class="truncate">{site.domain}</span>+ <span class="shrink-0">{PlausibleWeb.TextHelpers.number_format(site.total)}</span>+ </div>+ <.pageview_usage_row label="Pageviews" value={site.pageviews} />+ <.pageview_usage_row label="Custom events" value={site.custom_events} />+ </div></div></div></div>"""end+ attr :id, :string, default: nil+ attr :label, :string, required: true+ attr :value, :integer, required: true++ defp pageview_usage_row(assigns) do+ ~H"""+ <div id={@id} class="flex justify-between flex-wrap">+ <span class="flex items-center gap-1">+ <span class="inline-block size-4 text-center">•</span>+ {@label}+ </span>+ <span class="ml-5">{PlausibleWeb.TextHelpers.number_format(@value)}</span>+ </div>+ """+ end+defp cycle_label(:current_cycle), do: "(current cycle)"defp cycle_label(:last_30_days), do: "(last 30 days)"diff --git a/lib/plausible_web/templates/settings/subscription.html.heex b/lib/plausible_web/templates/settings/subscription.html.heexindex 6764bcb159..e97f7b17f9 100644--- a/lib/plausible_web/templates/settings/subscription.html.heex+++ b/lib/plausible_web/templates/settings/subscription.html.heex@@ -143,7 +143,7 @@usage={@site_usage}limit={@site_limit}/>- <div class="flex justify-between text-sm font-medium text-gray-900 dark:text-gray-100">+ <div class="flex justify-between flex-wrap text-sm font-medium text-gray-900 dark:text-gray-100"><span>Owned sites</span><span data-test-id="sites-usage">{PlausibleWeb.TextHelpers.number_format(@site_usage)}@@ -159,7 +159,7 @@usage={@team_member_usage}limit={@team_member_limit}/>- <div class="flex justify-between text-sm font-medium text-gray-900 dark:text-gray-100">+ <div class="flex justify-between flex-wrap text-sm font-medium text-gray-900 dark:text-gray-100"><span>Team members</span><span data-test-id="team-member-usage">{PlausibleWeb.TextHelpers.number_format(@team_member_usage)}diff --git a/test/plausible/billing/quota_test.exs b/test/plausible/billing/quota_test.exsindex 1ab14af1d2..a080d2a978 100644--- a/test/plausible/billing/quota_test.exs+++ b/test/plausible/billing/quota_test.exs@@ -956,6 +956,72 @@ defmodule Plausible.Billing.QuotaTest doendend+ describe "usage_cycle/1 per-site breakdown" do+ test "includes per-site breakdown when team has between 2 and 10 sites" do+ user = new_user()+ site1 = new_site(owner: user)+ site2 = new_site(owner: user)+ team = team_of(user)+ today = ~D[2023-06-01]++ populate_stats(site1, [+ build(:event, timestamp: ~N[2023-05-15 00:00:00], name: "pageview"),+ build(:event, timestamp: ~N[2023-05-15 00:00:00], name: "custom")+ ])++ populate_stats(site2, [+ build(:event, timestamp: ~N[2023-05-15 00:00:00], name: "pageview")+ ])++ %{sites: sites} = Plausible.Teams.Billing.usage_cycle(team, :last_30_days, nil, today)++ assert length(sites) == 2++ assert %{pageviews: 1, custom_events: 1, total: 2} =+ Enum.find(sites, &(&1.domain == site1.domain))++ assert %{pageviews: 1, custom_events: 0, total: 1} =+ Enum.find(sites, &(&1.domain == site2.domain))+ end++ test "sites with zero events in the period still appear in the breakdown" do+ user = new_user()+ site1 = new_site(owner: user)+ site2 = new_site(owner: user)+ team = team_of(user)+ today = ~D[2023-06-01]++ populate_stats(site1, [+ build(:event, timestamp: ~N[2023-05-15 00:00:00], name: "pageview")+ ])++ %{sites: sites} = Plausible.Teams.Billing.usage_cycle(team, :last_30_days, nil, today)++ assert length(sites) == 2++ assert %{pageviews: 0, custom_events: 0, total: 0} =+ Enum.find(sites, &(&1.domain == site2.domain))+ end++ test "returns empty sites list when team has only one site" do+ user = new_user()+ _site = new_site(owner: user)+ team = team_of(user)+ today = ~D[2023-06-01]++ assert %{sites: []} = Plausible.Teams.Billing.usage_cycle(team, :last_30_days, nil, today)+ end++ test "returns empty sites list when team has more than 10 sites" do+ user = new_user()+ for _ <- 1..11, do: new_site(owner: user)+ team = team_of(user)+ today = ~D[2023-06-01]++ assert %{sites: []} = Plausible.Teams.Billing.usage_cycle(team, :last_30_days, nil, today)+ end+ end+describe "suggest_tier/2" dosetup douser = new_user()diff --git a/test/plausible_web/components/billing/billing_test.exs b/test/plausible_web/components/billing/billing_test.exsindex 07a9925f9b..cbf9d7ad1f 100644--- a/test/plausible_web/components/billing/billing_test.exs+++ b/test/plausible_web/components/billing/billing_test.exs@@ -183,7 +183,8 @@ defmodule PlausibleWeb.Components.BillingTest dopageviews: 0,custom_events: 0,total: 0,- date_range: Date.range(~D[2024-01-01], ~D[2024-01-31])+ date_range: Date.range(~D[2024-01-01], ~D[2024-01-31]),+ sites: []}test "only shows current cycle when neither last nor current cycle is exceeded" do@@ -241,6 +242,84 @@ defmodule PlausibleWeb.Components.BillingTest doassert element_exists?(html, "#total_pageviews_last_cycle")assert element_exists?(html, "#total_pageviews_penultimate_cycle")end++ test "shows 'Pageviews' and 'Custom events' labels when no per-site breakdown" do+ usage = %{current_cycle: @cycle, last_cycle: @cycle, penultimate_cycle: @cycle}++ html = render_monthly_pageview_usage(usage, 10_000)++ assert text_of_element(html, "#pageviews_current_cycle") =~ "Pageviews"+ refute text_of_element(html, "#pageviews_current_cycle") =~ "Total pageviews"+ assert text_of_element(html, "#custom_events_current_cycle") =~ "Custom events"+ refute text_of_element(html, "#custom_events_current_cycle") =~ "Total custom events"+ end++ test "shows 'Total pageviews' and 'Total custom events' labels when per-site breakdown is present" do+ cycle_with_sites = %{+ @cycle+ | sites: [+ %{domain: "example.com", pageviews: 100, custom_events: 50, total: 150},+ %{domain: "app.example.com", pageviews: 200, custom_events: 30, total: 230}+ ]+ }++ usage = %{current_cycle: cycle_with_sites, last_cycle: @cycle, penultimate_cycle: @cycle}++ html = render_monthly_pageview_usage(usage, 10_000)++ assert text_of_element(html, "#pageviews_current_cycle") =~ "Total pageviews"+ assert text_of_element(html, "#custom_events_current_cycle") =~ "Total custom events"+ end++ test "renders per-site breakdown when sites are present" do+ cycle_with_sites = %{+ @cycle+ | sites: [+ %{domain: "example.com", pageviews: 100, custom_events: 50, total: 150},+ %{domain: "app.example.com", pageviews: 200, custom_events: 30, total: 230}+ ]+ }++ usage = %{current_cycle: cycle_with_sites, last_cycle: @cycle, penultimate_cycle: @cycle}++ html = render_monthly_pageview_usage(usage, 10_000)++ assert element_exists?(html, "#per_site_breakdown_current_cycle")+ assert text_of_element(html, "#per_site_breakdown_current_cycle") =~ "example.com"+ assert text_of_element(html, "#per_site_breakdown_current_cycle") =~ "app.example.com"+ end++ test "does not render per-site breakdown when sites list is empty" do+ usage = %{current_cycle: @cycle, last_cycle: @cycle, penultimate_cycle: @cycle}++ html = render_monthly_pageview_usage(usage, 10_000)++ refute element_exists?(html, "#per_site_breakdown_current_cycle")+ end++ test "current cycle is expanded by default when no per-site breakdown" do+ usage = %{current_cycle: @cycle, last_cycle: @cycle, penultimate_cycle: @cycle}++ html = render_monthly_pageview_usage(usage, 10_000)++ assert html =~ "{ open: true }"+ end++ test "current cycle is not expanded by default when per-site breakdown is present" do+ cycle_with_sites = %{+ @cycle+ | sites: [+ %{domain: "example.com", pageviews: 100, custom_events: 50, total: 150},+ %{domain: "app.example.com", pageviews: 200, custom_events: 30, total: 230}+ ]+ }++ usage = %{current_cycle: cycle_with_sites, last_cycle: @cycle, penultimate_cycle: @cycle}++ html = render_monthly_pageview_usage(usage, 10_000)++ refute html =~ "{ open: true }"+ endenddefp render_progress_bar(usage, limit) do