Delete stats improvements (#2318)
* Move clear stats functions to Plausible.Purge * Delete both native and imported stats when deleting a site This commit moves the delete site function to the Plausible.Purge module, and fixes a bug where deleted sites could leave dangling imported stats. * Clear sites.stats_start_date after clearing stats This commit fixes a bug where resetting stats left an invalid state of the stats_start_date field, used for GA imports, for example.pull/2320/head r2022.10.10-2
parent
aadf892a71
commit
0733efa89e
@ -0,0 +1,57 @@
|
||||
defmodule Plausible.Purge do
|
||||
@moduledoc """
|
||||
Deletes data from a site.
|
||||
|
||||
Stats are stored on Clickhouse, and unlike other databases data deletion is
|
||||
done asynchronously.
|
||||
|
||||
- [Clickhouse `ALTER TABLE ... DELETE` Statement`](https://clickhouse.com/docs/en/sql-reference/statements/alter/delete)
|
||||
- [Synchronicity of `ALTER` Queries](https://clickhouse.com/docs/en/sql-reference/statements/alter/#synchronicity-of-alter-queries)
|
||||
"""
|
||||
|
||||
@doc """
|
||||
Deletes a site and all associated stats.
|
||||
"""
|
||||
@spec delete_site!(Plausible.Site.t()) :: :ok
|
||||
def delete_site!(site) do
|
||||
delete_native_stats!(site)
|
||||
delete_imported_stats!(site)
|
||||
Plausible.Repo.delete!(site)
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
@spec delete_imported_stats!(Plausible.Site.t()) :: :ok
|
||||
@doc """
|
||||
Deletes imported stats from Google Analytics.
|
||||
"""
|
||||
def delete_imported_stats!(site) do
|
||||
Enum.each(Plausible.Imported.tables(), fn table ->
|
||||
sql = "ALTER TABLE #{table} DELETE WHERE site_id = ?"
|
||||
Ecto.Adapters.SQL.query!(Plausible.ClickhouseRepo, sql, [site.id])
|
||||
end)
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
@spec delete_native_stats!(Plausible.Site.t()) :: :ok
|
||||
@doc """
|
||||
Deletes native stats for a site, and clears the `stats_start_date` field.
|
||||
"""
|
||||
def delete_native_stats!(site) do
|
||||
events_sql = "ALTER TABLE events DELETE WHERE domain = ?"
|
||||
sessions_sql = "ALTER TABLE sessions DELETE WHERE domain = ?"
|
||||
Ecto.Adapters.SQL.query!(Plausible.ClickhouseRepo, events_sql, [site.domain])
|
||||
Ecto.Adapters.SQL.query!(Plausible.ClickhouseRepo, sessions_sql, [site.domain])
|
||||
|
||||
clear_stats_start_date!(site)
|
||||
|
||||
:ok
|
||||
end
|
||||
|
||||
defp clear_stats_start_date!(site) do
|
||||
site
|
||||
|> Ecto.Changeset.change(stats_start_date: nil)
|
||||
|> Plausible.Repo.update!()
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,79 @@
|
||||
defmodule Plausible.PurgeTest do
|
||||
use Plausible.DataCase
|
||||
import Plausible.TestUtils
|
||||
|
||||
setup do
|
||||
site = insert(:site, stats_start_date: ~D[2020-01-01])
|
||||
|
||||
populate_stats(site, [
|
||||
build(:pageview, domain: site.domain),
|
||||
build(:imported_visitors, site_id: site.id),
|
||||
build(:imported_sources, site_id: site.id),
|
||||
build(:imported_pages, site_id: site.id),
|
||||
build(:imported_entry_pages, site_id: site.id),
|
||||
build(:imported_exit_pages, site_id: site.id),
|
||||
build(:imported_locations, site_id: site.id),
|
||||
build(:imported_devices, site_id: site.id),
|
||||
build(:imported_browsers, site_id: site.id),
|
||||
build(:imported_operating_systems, site_id: site.id)
|
||||
])
|
||||
|
||||
{:ok, %{site: site}}
|
||||
end
|
||||
|
||||
defp assert_count(query, expected) do
|
||||
assert eventually(
|
||||
fn ->
|
||||
count = Plausible.ClickhouseRepo.aggregate(query, :count)
|
||||
{count == expected, count}
|
||||
end,
|
||||
200,
|
||||
10
|
||||
)
|
||||
end
|
||||
|
||||
test "delete_imported_stats!/1 deletes imported data", %{site: site} do
|
||||
assert :ok == Plausible.Purge.delete_imported_stats!(site)
|
||||
|
||||
Enum.each(Plausible.Imported.tables(), fn table ->
|
||||
query = from(imported in table, where: imported.site_id == ^site.id)
|
||||
assert_count(query, 0)
|
||||
end)
|
||||
end
|
||||
|
||||
test "delete_imported_stats!/1 does not reset stats_start_date", %{site: site} do
|
||||
assert :ok == Plausible.Purge.delete_imported_stats!(site)
|
||||
assert %Date{} = site.stats_start_date
|
||||
end
|
||||
|
||||
test "delete_native_stats!/1 deletes native stats", %{site: site} do
|
||||
assert :ok == Plausible.Purge.delete_native_stats!(site)
|
||||
|
||||
events_query = from(s in Plausible.ClickhouseSession, where: s.domain == ^site.domain)
|
||||
assert_count(events_query, 0)
|
||||
|
||||
sessions_query = from(s in Plausible.ClickhouseSession, where: s.domain == ^site.domain)
|
||||
assert_count(sessions_query, 0)
|
||||
end
|
||||
|
||||
test "delete_native_stats!/1 resets stats_start_date", %{site: site} do
|
||||
assert :ok == Plausible.Purge.delete_native_stats!(site)
|
||||
assert %Plausible.Site{stats_start_date: nil} = Plausible.Repo.reload(site)
|
||||
end
|
||||
|
||||
test "delete_site!/1 deletes the site and all stats", %{site: site} do
|
||||
assert :ok == Plausible.Purge.delete_site!(site)
|
||||
assert nil == Plausible.Repo.reload(site)
|
||||
|
||||
events_query = from(s in Plausible.ClickhouseSession, where: s.domain == ^site.domain)
|
||||
assert_count(events_query, 0)
|
||||
|
||||
sessions_query = from(s in Plausible.ClickhouseSession, where: s.domain == ^site.domain)
|
||||
assert_count(sessions_query, 0)
|
||||
|
||||
Enum.each(Plausible.Imported.tables(), fn table ->
|
||||
query = from(imported in table, where: imported.site_id == ^site.id)
|
||||
assert_count(query, 0)
|
||||
end)
|
||||
end
|
||||
end
|
||||
Loading…
Reference in New Issue