Skip to content

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

POC: Rollup view (#5719)

RobertJoonasd02636dd07af
diff --git a/lib/plausible/site.ex b/lib/plausible/site.ex
index 7aec34d6d1..d69793a421 100644
--- a/lib/plausible/site.ex
+++ b/lib/plausible/site.ex
@@ -62,9 +62,23 @@ defmodule Plausible.Site do
has_many :completed_imports, Plausible.Imported.SiteImport, where: [status: :completed]
+ field :rollup, :boolean, virtual: true, default: false
+
timestamps()
end
+ def rollup(team) do
+ %Plausible.Site{
+ id: 0,
+ native_stats_start_at: ~N[2018-01-01 00:00:00],
+ stats_start_date: ~D[2018-01-01],
+ rollup: true,
+ domain: "rollup:#{team.identifier}",
+ team: team,
+ team_id: team.id
+ }
+ end
+
def new_for_team(team, params) do
params
|> new()
diff --git a/lib/plausible/stats/filters/query_parser.ex b/lib/plausible/stats/filters/query_parser.ex
index d0eae7b1ee..7b64d45df7 100644
--- a/lib/plausible/stats/filters/query_parser.ex
+++ b/lib/plausible/stats/filters/query_parser.ex
@@ -47,8 +47,10 @@ defmodule Plausible.Stats.Filters.QueryParser do
{:ok, pagination} <- parse_pagination(Map.get(params, "pagination", %{})),
{preloaded_goals, revenue_warning, revenue_currencies} <-
preload_goals_and_revenue(site, metrics, filters, dimensions),
+ rollup_site_ids = get_rollup_site_ids(site),
query = %{
now: now,
+ rollup_site_ids: rollup_site_ids,
input_date_range: Map.get(params, "date_range"),
metrics: metrics,
filters: filters,
@@ -75,6 +77,12 @@ defmodule Plausible.Stats.Filters.QueryParser do
end
end
+ def get_rollup_site_ids(%Plausible.Site{rollup: true} = site) do
+ Plausible.Teams.owned_sites_ids(site.team)
+ end
+
+ def get_rollup_site_ids(_site), do: nil
+
def parse_date_range_pair(site, [from, to]) when is_binary(from) and is_binary(to) do
with {:ok, date_range} <- date_range_from_date_strings(site, from, to) do
{:ok, date_range |> DateTimeRange.to_timezone("Etc/UTC")}
diff --git a/lib/plausible/stats/legacy/legacy_query_builder.ex b/lib/plausible/stats/legacy/legacy_query_builder.ex
index fdb643462f..88e27d25c6 100644
--- a/lib/plausible/stats/legacy/legacy_query_builder.ex
+++ b/lib/plausible/stats/legacy/legacy_query_builder.ex
@@ -28,6 +28,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
|> put_parsed_filters(params)
|> resolve_segments(site)
|> preload_goals_and_revenue(site)
+ |> put_rollup_site_ids(site)
|> put_order_by(params)
|> put_include(site, params)
|> Query.put_comparison_utc_time_range()
@@ -41,6 +42,13 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
query
end
+ defp put_rollup_site_ids(query, %Plausible.Site{rollup: true} = site) do
+ site_ids = Plausible.Teams.owned_sites_ids(site.team)
+ struct!(query, rollup_site_ids: site_ids)
+ end
+
+ defp put_rollup_site_ids(query, _site), do: query
+
defp resolve_segments(query, site) do
with {:ok, preloaded_segments} <-
Plausible.Segments.Filters.preload_needed_segments(site, query.filters),
diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.ex
index aabb61f26a..5bbf7f4484 100644
--- a/lib/plausible/stats/query.ex
+++ b/lib/plausible/stats/query.ex
@@ -26,6 +26,7 @@ defmodule Plausible.Stats.Query do
revenue_warning: nil,
remove_unavailable_revenue_metrics: false,
site_id: nil,
+ rollup_site_ids: nil,
site_native_stats_start_at: nil,
# Contains information to determine how to combine legacy and new time on page metrics
time_on_page_data: %{},
diff --git a/lib/plausible/stats/sql/where_builder.ex b/lib/plausible/stats/sql/where_builder.ex
index a8c79fbd9c..3842e0e25a 100644
--- a/lib/plausible/stats/sql/where_builder.ex
+++ b/lib/plausible/stats/sql/where_builder.ex
@@ -41,6 +41,19 @@ defmodule Plausible.Stats.SQL.WhereBuilder do
end
end
+ defp filter_site_time_range(
+ :events,
+ %Plausible.Stats.Query{rollup_site_ids: [_ | _] = site_ids} = query
+ ) do
+ {first_datetime, last_datetime} = utc_boundaries(query)
+
+ dynamic(
+ [e],
+ e.site_id in ^site_ids and e.timestamp >= ^first_datetime and
+ e.timestamp <= ^last_datetime
+ )
+ end
+
defp filter_site_time_range(:events, query) do
{first_datetime, last_datetime} = utc_boundaries(query)
@@ -51,6 +64,21 @@ defmodule Plausible.Stats.SQL.WhereBuilder do
)
end
+ defp filter_site_time_range(
+ :sessions,
+ %Plausible.Stats.Query{rollup_site_ids: [_ | _] = site_ids} = query
+ ) do
+ {first_datetime, last_datetime} = utc_boundaries(query)
+
+ dynamic(
+ [s],
+ s.site_id in ^site_ids and
+ s.start >= ^NaiveDateTime.add(first_datetime, -7, :day) and
+ s.timestamp >= ^first_datetime and
+ s.start <= ^last_datetime
+ )
+ end
+
defp filter_site_time_range(:sessions, query) do
{first_datetime, last_datetime} = utc_boundaries(query)
diff --git a/lib/plausible_web/plugs/authorize_public_api.ex b/lib/plausible_web/plugs/authorize_public_api.ex
index 5bbdfb2874..d18aa644d5 100644
--- a/lib/plausible_web/plugs/authorize_public_api.ex
+++ b/lib/plausible_web/plugs/authorize_public_api.ex
@@ -121,7 +121,7 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPI do
defp verify_by_scope(conn, api_key, "stats:read:" <> _ = scope) do
with :ok <- check_scope(api_key, scope),
- {:ok, site} <- find_site(conn.params["site_id"]),
+ {:ok, site} <- find_site(conn.params["site_id"], api_key),
:ok <- verify_site_access(api_key, site) do
Plausible.OpenTelemetry.add_site_attributes(site)
site = Plausible.Repo.preload(site, :completed_imports)
@@ -173,9 +173,18 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPI do
end
end
- defp find_site(nil), do: {:error, :missing_site_id}
+ defp find_site(nil, _api_key), do: {:error, :missing_site_id}
- defp find_site(site_id) do
+ defp find_site("rollup:" <> team_identifier, api_key) do
+ with true <- Plausible.Auth.is_super_admin?(api_key.user),
+ %Plausible.Teams.Team{} = team <- Plausible.Teams.get(team_identifier) do
+ {:ok, Plausible.Site.rollup(team)}
+ else
+ _ -> {:error, :invalid_api_key}
+ end
+ end
+
+ defp find_site(site_id, _api_key) do
domain_based_search =
from s in Plausible.Site, where: s.domain == ^site_id or s.domain_changed_from == ^site_id
diff --git a/lib/plausible_web/plugs/authorize_site_access.ex b/lib/plausible_web/plugs/authorize_site_access.ex
index 589cac5ff7..8c8924976c 100644
--- a/lib/plausible_web/plugs/authorize_site_access.ex
+++ b/lib/plausible_web/plugs/authorize_site_access.ex
@@ -172,6 +172,15 @@ defmodule PlausibleWeb.Plugs.AuthorizeSiteAccess do
end
end
+ defp get_site_with_role(conn, current_user, "rollup:" <> team_identifier) do
+ with true <- Plausible.Auth.is_super_admin?(current_user),
+ %Plausible.Teams.Team{} = team <- Plausible.Teams.get(team_identifier) do
+ {:ok, %{site: Plausible.Site.rollup(team), role: nil, member_type: nil}}
+ else
+ _ -> error_not_found(conn)
+ end
+ end
+
defp get_site_with_role(conn, current_user, domain) do
site = Repo.get_by(Plausible.Site, domain: domain)
diff --git a/test/plausible/stats/query_parser_test.exs b/test/plausible/stats/query_parser_test.exs
index 80db0025b9..6d67c65075 100644
--- a/test/plausible/stats/query_parser_test.exs
+++ b/test/plausible/stats/query_parser_test.exs
@@ -77,7 +77,8 @@ defmodule Plausible.Stats.Filters.QueryParserTest do
:input_date_range,
:preloaded_goals,
:revenue_warning,
- :revenue_currencies
+ :revenue_currencies,
+ :rollup_site_ids
])
assert result == expected_result