Skip to content

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

Introduce :skip_imported_reason field into Query struct (#4115)

RobertJoonasdf178ea2d551
diff --git a/lib/plausible/stats/comparisons.ex b/lib/plausible/stats/comparisons.ex
index 5a6169ad4c..86ee0f3554 100644
--- a/lib/plausible/stats/comparisons.ex
+++ b/lib/plausible/stats/comparisons.ex
@@ -8,6 +8,7 @@ defmodule Plausible.Stats.Comparisons do
"""
alias Plausible.Stats
+ alias Plausible.Stats.Query
@modes ~w(previous_period year_over_year custom)
@disallowed_periods ~w(realtime all)
@@ -161,10 +162,25 @@ defmodule Plausible.Stats.Comparisons do
Date.add(date, -days_to_subtract)
end
- defp maybe_include_imported(query, source_query, site) do
- requested? = source_query.imported_data_requested
- include_imported? = Stats.Query.include_imported?(query, site, requested?)
- %Stats.Query{query | include_imported: include_imported?}
+ defp maybe_include_imported(query, %Query{imported_data_requested: false}, _site) do
+ %Stats.Query{query | include_imported: false}
+ end
+
+ defp maybe_include_imported(query, _source_query, site) do
+ case Query.ensure_include_imported(query, site) do
+ :ok ->
+ struct!(query,
+ imported_data_requested: true,
+ include_imported: true
+ )
+
+ {:error, reason} ->
+ struct!(query,
+ imported_data_requested: true,
+ include_imported: false,
+ skip_imported_reason: reason
+ )
+ end
end
defp validate_mode(%Stats.Query{period: period}, mode) do
diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.ex
index 4fa8f4a94f..90f347d61a 100644
--- a/lib/plausible/stats/query.ex
+++ b/lib/plausible/stats/query.ex
@@ -9,6 +9,7 @@ defmodule Plausible.Stats.Query do
sample_threshold: 20_000_000,
imported_data_requested: false,
include_imported: false,
+ skip_imported_reason: nil,
now: nil,
experimental_session_count?: false,
experimental_reduced_joins?: false
@@ -248,20 +249,31 @@ defmodule Plausible.Stats.Query do
defp put_imported_opts(query, site, params) do
requested? = params["with_imported"] == "true"
- struct!(query,
- imported_data_requested: requested?,
- include_imported: include_imported?(query, site, requested?)
- )
+ case ensure_include_imported(query, site) do
+ :ok ->
+ struct!(query,
+ imported_data_requested: requested?,
+ include_imported: requested?
+ )
+
+ {:error, reason} ->
+ struct!(query,
+ imported_data_requested: requested?,
+ include_imported: false,
+ skip_imported_reason: reason
+ )
+ end
end
- @spec include_imported?(t(), Plausible.Site.t(), boolean()) :: boolean()
- def include_imported?(query, site, requested?) do
+ @spec ensure_include_imported(t(), Plausible.Site.t()) ::
+ :ok | {:error, :no_imported_data | :out_of_range | :unsupported_query}
+ def ensure_include_imported(query, site) do
cond do
- is_nil(site.latest_import_end_date) -> false
- Date.after?(query.date_range.first, site.latest_import_end_date) -> false
- not Imported.schema_supports_query?(query) -> false
- query.period == "realtime" -> false
- true -> requested?
+ is_nil(site.latest_import_end_date) -> {:error, :no_imported_data}
+ Date.after?(query.date_range.first, site.latest_import_end_date) -> {:error, :out_of_range}
+ not Imported.schema_supports_query?(query) -> {:error, :unsupported_query}
+ query.period == "realtime" -> {:error, :unsupported_query}
+ true -> :ok
end
end
diff --git a/test/plausible/stats/query_test.exs b/test/plausible/stats/query_test.exs
index b509b6914c..43419ef782 100644
--- a/test/plausible/stats/query_test.exs
+++ b/test/plausible/stats/query_test.exs
@@ -217,7 +217,7 @@ defmodule Plausible.Stats.QueryTest do
end
test "is false when imported data does not exist", %{site: site} do
- assert %{include_imported: false} =
+ assert %{include_imported: false, skip_imported_reason: :no_imported_data} =
Query.from(site, %{"period" => "day", "with_imported" => "true"})
end
@@ -225,7 +225,7 @@ defmodule Plausible.Stats.QueryTest do
insert(:site_import, site: site, start_date: ~D[2021-01-01], end_date: ~D[2022-01-01])
site = Plausible.Imported.load_import_data(site)
- assert %{include_imported: false} =
+ assert %{include_imported: false, skip_imported_reason: :out_of_range} =
Query.from(site, %{"period" => "day", "with_imported" => "true"})
end
@@ -233,7 +233,7 @@ defmodule Plausible.Stats.QueryTest do
insert(:site_import, site: site)
site = Plausible.Imported.load_import_data(site)
- assert %{include_imported: false} =
+ assert %{include_imported: false, skip_imported_reason: :unsupported_query} =
Query.from(site, %{"period" => "realtime", "with_imported" => "true"})
end
@@ -241,7 +241,7 @@ defmodule Plausible.Stats.QueryTest do
insert(:site_import, site: site)
site = Plausible.Imported.load_import_data(site)
- assert %{include_imported: false} =
+ assert %{include_imported: false, skip_imported_reason: :unsupported_query} =
Query.from(site, %{
"period" => "day",
"with_imported" => "true",