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
Consolidated view lifecycle (#5760)
Adam Rutkowski41b2106489f4
diff --git a/extra/lib/plausible/consolidated_view.ex b/extra/lib/plausible/consolidated_view.exindex 1df8fb83d7..2a4365bf82 100644--- a/extra/lib/plausible/consolidated_view.ex+++ b/extra/lib/plausible/consolidated_view.ex@@ -15,9 +15,29 @@ defmodule Plausible.ConsolidatedView doimport Ecto.Query+ @spec reset_if_enabled(Team.t()) :: :ok+ def reset_if_enabled(%Team{} = team) do+ case get(team) do+ nil ->+ :skip++ consolidated_view ->+ if has_sites_to_consolidate?(team) do+ consolidated_view+ |> change_stats_dates(team)+ |> bump_updated_at()+ |> Repo.update!()+ else+ disable(team)+ end+ end++ :ok+ end+@spec sites(Ecto.Query.t() | Site) :: Ecto.Query.t()def sites(q \\ Site) do- from s in q, where: s.consolidated == true+ from(s in q, where: s.consolidated == true)end@spec enable(Team.t()) :: {:ok, Site.t()} | {:error, :no_sites}@@ -25,8 +45,14 @@ defmodule Plausible.ConsolidatedView dowith :ok <- ensure_eligible(team), do: do_enable(team)end+ @spec enabled?(Team.t()) :: boolean()+ def enabled?(%Team{} = team) do+ not is_nil(get(team))+ end+@spec disable(Team.t()) :: :okdef disable(%Team{} = team) do+ # consider `Plausible.Site.Removal.run/1` if we ever support memberships or invitationsPlausible.Repo.delete_all(from(s in sites(), where: s.domain == ^make_id(team))):okend@@ -52,30 +78,36 @@ defmodule Plausible.ConsolidatedView dodef get(id) when is_binary(id) doRepo.one(- from s in sites(), inner_join: assoc(s, :team), where: s.domain == ^id, preload: [:team]+ from(s in sites(), inner_join: assoc(s, :team), where: s.domain == ^id, preload: [:team]))end- @spec native_stats_start_at(Team.t()) :: NaiveDateTime.t() | nil- def native_stats_start_at(%Team{} = team) do- q =- from(sr in Site.regular(),- group_by: sr.team_id,- where: sr.team_id == ^team.id,- select: min(sr.native_stats_start_at)- )+ @spec change_stats_dates(Site.t() | Ecto.Changeset.t(), Team.t()) ::+ Ecto.Changeset.t() | Site.t()+ def change_stats_dates(site_or_changeset, %Team{} = team) do+ native_stats_start_at = native_stats_start_at(team)- Repo.one(q)+ if native_stats_start_at do+ start_date = NaiveDateTime.to_date(native_stats_start_at)++ site_or_changeset+ |> Site.set_native_stats_start_at(native_stats_start_at)+ |> Site.set_stats_start_date(start_date)+ else+ site_or_changeset+ end+ end++ defp bump_updated_at(struct_or_changeset) do+ Ecto.Changeset.change(struct_or_changeset, updated_at: NaiveDateTime.utc_now(:second))enddefp do_enable(%Team{} = team) docase get(team) donil ->- native_stats_start_at = native_stats_start_at(team)-team|> Site.new_for_team(%{consolidated: true, domain: make_id(team)})- |> Site.set_native_stats_start_at(native_stats_start_at)+ |> change_stats_dates(team)|> Repo.insert()consolidated_view ->@@ -90,10 +122,21 @@ defmodule Plausible.ConsolidatedView do# TODO: Only active trials and business subscriptions should be eligible.# This function should also call a new underlying feature module.defp ensure_eligible(%Team{} = team) do- if Plausible.Teams.owned_sites_count(team) == 0 do- {:error, :no_sites}- else- :ok- end+ if has_sites_to_consolidate?(team), do: :ok, else: {:error, :no_sites}+ end++ defp native_stats_start_at(%Team{} = team) do+ q =+ from(sr in Site.regular(),+ group_by: sr.team_id,+ where: sr.team_id == ^team.id,+ select: min(sr.native_stats_start_at)+ )++ Repo.one(q)+ end++ defp has_sites_to_consolidate?(%Team{} = team) do+ Teams.owned_sites_count(team) > 0endenddiff --git a/extra/lib/plausible/consolidated_view/cache.ex b/extra/lib/plausible/consolidated_view/cache.exindex 0e0e2f3c12..b0d04ede14 100644--- a/extra/lib/plausible/consolidated_view/cache.ex+++ b/extra/lib/plausible/consolidated_view/cache.ex@@ -36,7 +36,7 @@ defmodule Plausible.ConsolidatedView.Cache doorder_by: [desc: sc.id],select: %{consolidated_view_id: sc.domain,- site_ids: fragment("array_agg(?.id)", sr)+ site_ids: fragment("array_agg(? ORDER BY ? DESC)", sr.id, sr.id)}end@@ -56,7 +56,10 @@ defmodule Plausible.ConsolidatedView.Cache dowhere: sc.id in subquery(recently_updated_site_ids),group_by: sc.id,order_by: [desc: sc.id],- select: %{consolidated_view_id: sc.domain, site_ids: fragment("array_agg(?)", sr.id)}+ select: %{+ consolidated_view_id: sc.domain,+ site_ids: fragment("array_agg(? ORDER BY ? DESC)", sr.id, sr.id)+ }refresh(:updated_recently,diff --git a/lib/plausible/site/removal.ex b/lib/plausible/site/removal.exindex ff82470376..1d1f27512f 100644--- a/lib/plausible/site/removal.ex+++ b/lib/plausible/site/removal.ex@@ -20,6 +20,10 @@ defmodule Plausible.Site.Removal doTeams.Invitations.prune_guest_invitations(site.team)on_ee do+ if Plausible.Sites.regular?(site) do+ :ok = Plausible.ConsolidatedView.reset_if_enabled(site.team)+ end+Plausible.Billing.SiteLocker.update_for(site.team, send_email?: false)enddiff --git a/lib/plausible/sites.ex b/lib/plausible/sites.exindex 005d19947c..df9e132fd3 100644--- a/lib/plausible/sites.ex+++ b/lib/plausible/sites.ex@@ -348,27 +348,22 @@ defmodule Plausible.Sites do"""def stats_start_date(site)- def stats_start_date(%Site{stats_start_date: %Date{} = date}) do- date- end-on_ee do+ # for now, we're going to always update consolidated viewsdef stats_start_date(%Site{consolidated: true} = site) do- native_stats_start_at = Plausible.ConsolidatedView.native_stats_start_at(site.team)-- if native_stats_start_at do- start_date = NaiveDateTime.to_date(native_stats_start_at)-- site- |> Site.set_native_stats_start_at(native_stats_start_at)- |> Site.set_stats_start_date(start_date)- |> Repo.update!()+ team = Repo.preload(site, :team).team- start_date- end+ site+ |> Plausible.ConsolidatedView.change_stats_dates(team)+ |> Repo.update!()+ |> Map.fetch!(:stats_start_date)endend+ def stats_start_date(%Site{stats_start_date: %Date{} = date}) do+ date+ end+def stats_start_date(%Site{} = site) dostart_date =[diff --git a/lib/plausible/teams/invitations.ex b/lib/plausible/teams/invitations.exindex 663e4b7b0e..8718adb9c6 100644--- a/lib/plausible/teams/invitations.ex+++ b/lib/plausible/teams/invitations.ex@@ -440,6 +440,7 @@ defmodule Plausible.Teams.Invitations doon_ee doBilling.SiteLocker.update_for(prior_team, send_email?: false):unlocked = Billing.SiteLocker.update_for(team, send_email?: false)+ Plausible.ConsolidatedView.reset_if_enabled(prior_team)end:okdiff --git a/test/plausible/consolidated_view_test.exs b/test/plausible/consolidated_view_test.exsindex 1f1c163d73..203c576116 100644--- a/test/plausible/consolidated_view_test.exs+++ b/test/plausible/consolidated_view_test.exs@@ -7,13 +7,13 @@ defmodule Plausible.ConsolidatedViewTest doalias Plausible.ConsolidatedViewimport Plausible.Teams.Test- describe "enable/1" do+ describe "enable/1 and enabled?/1" dosetup [:create_user, :create_team]test "creates and persists a new consolidated site instance", %{team: team} donew_site(team: team)assert {:ok, %Plausible.Site{consolidated: true}} = ConsolidatedView.enable(team)- assert ConsolidatedView.get(team)+ assert ConsolidatedView.enabled?(team)endtest "is idempotent", %{team: team} do@@ -30,10 +30,27 @@ defmodule Plausible.ConsolidatedViewTest dotest "returns {:error, :no_sites} when the team does not have any sites", %{team: team} doassert {:error, :no_sites} = ConsolidatedView.enable(team)+ refute ConsolidatedView.enabled?(team)end@tag :skiptest "returns {:error, :upgrade_required} when team ineligible for this feature"++ test "creates consolidated view with stats start dates of the oldest site", %{team: team} do+ datetimes = [+ ~N[2024-01-01 12:00:00],+ ~N[2024-01-01 11:00:00],+ ~N[2024-02-01 12:00:00]+ ]++ for dt <- datetimes, do: new_site(team: team, native_stats_start_at: dt)++ {:ok, view} = ConsolidatedView.enable(team)++ min = Enum.min(datetimes)+ assert view.native_stats_start_at == min+ assert view.stats_start_date == NaiveDateTime.to_date(min)+ endenddescribe "disable/1" do@@ -92,26 +109,32 @@ defmodule Plausible.ConsolidatedViewTest doendend- describe "native_stats_start_at/1" do+ # see also: Site.RemovalTest and Sites.TransferTest+ describe "reset_if_enabled/1" dosetup [:create_user, :create_team]- test "returns nil if no included sites", %{team: team} do- ConsolidatedView.enable(team)- assert is_nil(ConsolidatedView.native_stats_start_at(team))+ test "no-op if disabled", %{team: team} do+ :ok = ConsolidatedView.reset_if_enabled(team)+ refute ConsolidatedView.enabled?(team)+ refute ConsolidatedView.get(team)end- test "returns earliest native_stats_start_at from included sites", %{team: team} do- ConsolidatedView.enable(team)+ @tag :slow+ test "re-enables", %{team: team} do+ _site = new_site(team: team, native_stats_start_at: ~N[2024-01-01 12:00:00])- datetimes = [- ~N[2024-01-01 12:00:00],- ~N[2024-01-01 11:00:00],- ~N[2024-02-01 12:00:00]- ]+ {:ok, first_enable} = ConsolidatedView.enable(team)- for dt <- datetimes, do: new_site(team: team, native_stats_start_at: dt)+ another_site = new_site(team: team, native_stats_start_at: ~N[2024-01-01 10:00:00])++ Process.sleep(1_000)++ :ok = ConsolidatedView.reset_if_enabled(team)+ assert ConsolidatedView.enabled?(team)- assert ConsolidatedView.native_stats_start_at(team) == Enum.min(datetimes)+ consolidated_view = ConsolidatedView.get(team)+ assert consolidated_view.native_stats_start_at == another_site.native_stats_start_at+ assert NaiveDateTime.after?(consolidated_view.updated_at, first_enable.updated_at)endendenddiff --git a/test/plausible/site/site_removal_test.exs b/test/plausible/site/site_removal_test.exsindex 70b71362e3..0fc72cdeb1 100644--- a/test/plausible/site/site_removal_test.exs+++ b/test/plausible/site/site_removal_test.exs@@ -39,18 +39,49 @@ defmodule Plausible.Site.SiteRemovalTest dorefute Repo.reload(team_invitation)end- @tag :ee_only- test "site deletion updates team dashboard lock state" do- owner = new_user(team: [locked: true])- site = new_site(owner: owner)- team = site.team+ on_ee do+ test "site deletion updates team dashboard lock state" do+ owner = new_user(team: [locked: true])+ site = new_site(owner: owner)+ team = site.team- assert team.locked+ assert team.locked- assert {:ok, context} = Removal.run(site)- assert context.delete_all == {1, nil}- refute Sites.get_by_domain(site.domain)+ assert {:ok, context} = Removal.run(site)+ assert context.delete_all == {1, nil}+ refute Sites.get_by_domain(site.domain)++ refute Repo.reload(team).locked+ end++ test "site deletion disables consolidated view if need be" do+ owner = new_user()+ site = new_site(owner: owner)+ team = team_of(owner)++ {:ok, _} = Plausible.ConsolidatedView.enable(team)+ assert Plausible.ConsolidatedView.enabled?(team)++ assert {:ok, _} = Removal.run(site)++ refute Plausible.ConsolidatedView.enabled?(team)+ end++ test "site deletion keeps consolidated view if there's still regular sites" do+ owner = new_user()+ site = new_site(owner: owner)++ # another site+ new_site(owner: owner)++ team = team_of(owner)++ {:ok, _} = Plausible.ConsolidatedView.enable(team)+ assert Plausible.ConsolidatedView.enabled?(team)++ assert {:ok, _} = Removal.run(site)- refute Repo.reload(team).locked+ assert Plausible.ConsolidatedView.enabled?(team)+ endendenddiff --git a/test/plausible/sites_test.exs b/test/plausible/sites_test.exsindex 7643360fb9..621f812609 100644--- a/test/plausible/sites_test.exs+++ b/test/plausible/sites_test.exs@@ -174,6 +174,25 @@ defmodule Plausible.SitesTest doassert Sites.stats_start_date(site) == Plausible.Times.today(site.timezone)assert Repo.reload!(site).stats_start_date == Plausible.Times.today(site.timezone)end++ on_ee do+ alias Plausible.ConsolidatedView++ test "resets consolidated view stats dates every time" do+ owner = new_user()+ new_site(owner: owner)+ team = team_of(owner)++ {:ok, consolidated_view} = ConsolidatedView.enable(team)++ assert consolidated_view.stats_start_date == ~D[2000-01-01]+ assert Sites.stats_start_date(consolidated_view) == ~D[2000-01-01]++ new_site(owner: owner, native_stats_start_at: ~N[1999-01-01 12:00:00])++ assert Sites.stats_start_date(consolidated_view) == ~D[1999-01-01]+ end+ endenddescribe "native_stats_start_date" dodiff --git a/test/plausible/teams/sites/transfer_test.exs b/test/plausible/teams/sites/transfer_test.exsindex 6d7e568a0a..1f70c1bce5 100644--- a/test/plausible/teams/sites/transfer_test.exs+++ b/test/plausible/teams/sites/transfer_test.exs@@ -84,6 +84,30 @@ defmodule Plausible.Teams.Sites.TransferTest do)end+ on_ee do+ alias Plausible.ConsolidatedView++ test "disables consolidated view if sites transferred out of team" do+ user = new_user()+ site = new_site(owner: user)+ team = team_of(user)++ assert {:ok, _} = ConsolidatedView.enable(team)+ assert ConsolidatedView.enabled?(team)++ another_owner = new_user()+ subscribe_to_growth_plan(another_owner)+ _ = new_site(owner: another_owner)+ another_team = team_of(another_owner)++ add_member(another_team, user: user, role: :owner)++ :ok = Transfer.change_team(site, user, another_team)++ refute ConsolidatedView.enabled?(team)+ end+ end+for role <- Plausible.Teams.Membership.roles() -- [:admin, :owner] dotest "refuses to change the team if #{role} in second team" douser = new_user()