Skip to content

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

Refactoring preparation for DashboardQueryParser (#5929)

RobertJoonas12d818af8a8b
diff --git a/lib/plausible/segments/filters.ex b/lib/plausible/segments/filters.ex
index 92d9034fc8..8b9e1b6e5c 100644
--- a/lib/plausible/segments/filters.ex
+++ b/lib/plausible/segments/filters.ex
@@ -3,7 +3,7 @@ defmodule Plausible.Segments.Filters do
This module contains functions that enable resolving segments in filters.
"""
alias Plausible.Segments
- alias Plausible.Stats.{Filters, QueryParser}
+ alias Plausible.Stats.{Filters, ApiQueryParser}
@max_segment_filters_count 10
@@ -48,7 +48,7 @@ defmodule Plausible.Segments.Filters do
segments,
%{},
fn %Segments.Segment{id: id, segment_data: segment_data} ->
- case QueryParser.parse_filters(segment_data["filters"]) do
+ case ApiQueryParser.parse_filters(segment_data["filters"]) do
{:ok, filters} -> {id, filters}
_ -> {id, nil}
end
diff --git a/lib/plausible/stats/query_parser.ex b/lib/plausible/stats/api_query_parser.ex
similarity index 71%
rename from lib/plausible/stats/query_parser.ex
rename to lib/plausible/stats/api_query_parser.ex
index 8baf36b491..16cb1ddfad 100644
--- a/lib/plausible/stats/query_parser.ex
+++ b/lib/plausible/stats/api_query_parser.ex
@@ -1,29 +1,26 @@
-defmodule Plausible.Stats.QueryParser do
+defmodule Plausible.Stats.ApiQueryParser do
@moduledoc false
use Plausible
alias Plausible.Stats.{Filters, Metrics, DateTimeRange, JSONSchema}
- def parse(site, schema_type, params, now \\ nil) when is_map(params) do
- now = now || Plausible.Stats.Query.Test.get_fixed_now()
- date = now |> DateTime.shift_zone!(site.timezone) |> DateTime.to_date()
+ def parse(schema_type, params) when is_map(params) do
+ now = Plausible.Stats.Query.Test.get_fixed_now()
+ input_date_range = Map.get(params, "date_range")
with :ok <- JSONSchema.validate(schema_type, params),
- {:ok, date, now} <- parse_date(site, Map.get(params, "date"), date, now),
- {:ok, raw_time_range} <-
- parse_time_range(site, Map.get(params, "date_range"), date, now),
- utc_time_range = raw_time_range |> DateTimeRange.to_timezone("Etc/UTC"),
+ {:ok, input_date_range} <- parse_input_date_range(input_date_range),
{:ok, metrics} <- parse_metrics(Map.fetch!(params, "metrics")),
{:ok, filters} <- parse_filters(params["filters"]),
{:ok, dimensions} <- parse_dimensions(params["dimensions"]),
{:ok, order_by} <- parse_order_by(params["order_by"]),
{:ok, pagination} <- parse_pagination(params["pagination"]),
- {:ok, include} <- parse_include(params["include"], site) do
+ {:ok, include} <- parse_include(params["include"]) do
{:ok,
Plausible.Stats.ParsedQueryParams.new!(%{
now: now,
- utc_time_range: utc_time_range,
+ input_date_range: input_date_range,
metrics: metrics,
filters: filters,
dimensions: dimensions,
@@ -42,6 +39,13 @@ defmodule Plausible.Stats.QueryParser do
def parse_date_range_pair(_site, unknown), do: {:error, "Invalid date_range '#{i(unknown)}'."}
+ defp date_range_from_date_strings(site, from, to) do
+ with {:ok, from_date} <- Date.from_iso8601(from),
+ {:ok, to_date} <- Date.from_iso8601(to) do
+ {:ok, DateTimeRange.new!(from_date, to_date, site.timezone)}
+ end
+ end
+
defp parse_metrics(metrics) when is_list(metrics) do
parse_list(metrics, &parse_metric/1)
end
@@ -155,94 +159,43 @@ defmodule Plausible.Stats.QueryParser do
{:ok, []}
end
- defp parse_date(site, date_string, _date, _now) when is_binary(date_string) do
- with {:ok, date} <- Date.from_iso8601(date_string),
- {:ok, datetime} <- DateTime.new(date, ~T[00:00:00], site.timezone) do
- {:ok, date, datetime}
- else
- {:gap, just_before, _just_after} -> just_before
- {:ambiguous, first_datetime, _second_datetime} -> first_datetime
- _ -> {:error, "Invalid date '#{date_string}'."}
- end
- end
-
- defp parse_date(_site, _date_string, date, now) do
- {:ok, date, now}
- end
-
- defp parse_time_range(_site, date_range, _date, now) when date_range in ["realtime", "30m"] do
- duration_minutes =
- case date_range do
- "realtime" -> 5
- "30m" -> 30
- end
-
- first_datetime = DateTime.shift(now, minute: -duration_minutes)
- last_datetime = DateTime.shift(now, second: 5)
-
- {:ok, DateTimeRange.new!(first_datetime, last_datetime)}
- end
-
- defp parse_time_range(site, "day", date, _now) do
- {:ok, DateTimeRange.new!(date, date, site.timezone)}
- end
-
- defp parse_time_range(site, "month", date, _now) do
- last = date |> Date.end_of_month()
- first = last |> Date.beginning_of_month()
- {:ok, DateTimeRange.new!(first, last, site.timezone)}
- end
-
- defp parse_time_range(site, "year", date, _now) do
- last = date |> Plausible.Times.end_of_year()
- first = last |> Plausible.Times.beginning_of_year()
- {:ok, DateTimeRange.new!(first, last, site.timezone)}
- end
-
- defp parse_time_range(site, "all", date, _now) do
- start_date = Plausible.Sites.stats_start_date(site) || date
+ defp parse_input_date_range("realtime"), do: {:ok, :realtime}
+ defp parse_input_date_range("30m"), do: {:ok, :realtime_30m}
+ defp parse_input_date_range("day"), do: {:ok, :day}
+ defp parse_input_date_range("month"), do: {:ok, :month}
+ defp parse_input_date_range("year"), do: {:ok, :year}
+ defp parse_input_date_range("all"), do: {:ok, :all}
- {:ok, DateTimeRange.new!(start_date, date, site.timezone)}
- end
-
- defp parse_time_range(site, shorthand, date, _now) when is_binary(shorthand) do
+ defp parse_input_date_range(shorthand) when is_binary(shorthand) do
case Integer.parse(shorthand) do
- {n, "d"} when n > 0 and n <= 5_000 ->
- last = date |> Date.add(-1)
- first = date |> Date.add(-n)
- {:ok, DateTimeRange.new!(first, last, site.timezone)}
-
- {n, "mo"} when n > 0 and n <= 100 ->
- last = date |> Date.shift(month: -1) |> Date.end_of_month()
- first = date |> Date.shift(month: -n) |> Date.beginning_of_month()
- {:ok, DateTimeRange.new!(first, last, site.timezone)}
-
- _ ->
- {:error, "Invalid date_range #{i(shorthand)}"}
+ {n, "d"} when n > 0 and n <= 5_000 -> {:ok, {:last_n_days, n}}
+ {n, "mo"} when n > 0 and n <= 100 -> {:ok, {:last_n_months, n}}
+ _ -> {:error, "Invalid date_range #{i(shorthand)}"}
end
end
- defp parse_time_range(site, [from, to], _date, _now) when is_binary(from) and is_binary(to) do
- case date_range_from_date_strings(site, from, to) do
- {:ok, date_range} -> {:ok, date_range}
- {:error, _} -> date_range_from_timestamps(from, to)
+ defp parse_input_date_range([from, to]) when is_binary(from) and is_binary(to) do
+ case parse_date_strings(from, to) do
+ {:ok, dates} -> {:ok, dates}
+ {:error, _} -> parse_timestamp_strings(from, to)
end
end
- defp parse_time_range(_site, unknown, _date, _now),
- do: {:error, "Invalid date_range #{i(unknown)}"}
+ defp parse_input_date_range(unknown) do
+ {:error, "Invalid date_range #{i(unknown)}"}
+ end
- defp date_range_from_date_strings(site, from, to) do
+ defp parse_date_strings(from, to) do
with {:ok, from_date} <- Date.from_iso8601(from),
{:ok, to_date} <- Date.from_iso8601(to) do
- {:ok, DateTimeRange.new!(from_date, to_date, site.timezone)}
+ {:ok, {:date_range, from_date, to_date}}
end
end
- defp date_range_from_timestamps(from, to) do
+ defp parse_timestamp_strings(from, to) do
with {:ok, from_datetime, _offset} <- DateTime.from_iso8601(from),
{:ok, to_datetime, _offset} <- DateTime.from_iso8601(to) do
- {:ok, DateTimeRange.new!(from_datetime, to_datetime)}
+ {:ok, {:datetime_range, from_datetime, to_datetime}}
else
_ -> {:error, "Invalid date_range '#{i([from, to])}'."}
end
@@ -307,14 +260,14 @@ defmodule Plausible.Stats.QueryParser do
defp parse_order_direction([_, "desc"]), do: {:ok, :desc}
defp parse_order_direction(entry), do: {:error, "Invalid order_by entry '#{i(entry)}'."}
- def parse_include(include, site) when is_map(include) do
+ def parse_include(include) when is_map(include) do
with {:ok, include} <- atomize_include_keys(include) do
- update_comparisons_date_range(include, site)
+ parse_comparison_date_range(include)
end
end
- def parse_include(nil, _site), do: {:ok, nil}
- def parse_include(include, _site), do: {:error, "Invalid include '#{i(include)}'."}
+ def parse_include(nil), do: {:ok, nil}
+ def parse_include(include), do: {:error, "Invalid include '#{i(include)}'."}
defp atomize_include_keys(map) do
expected_keys =
@@ -329,13 +282,13 @@ defmodule Plausible.Stats.QueryParser do
end
end
- defp update_comparisons_date_range(%{comparisons: %{date_range: date_range}} = include, site) do
- with {:ok, parsed_date_range} <- parse_time_range(site, date_range, nil, nil) do
+ defp parse_comparison_date_range(%{comparisons: %{date_range: date_range}} = include) do
+ with {:ok, parsed_date_range} <- parse_input_date_range(date_range) do
{:ok, put_in(include, [:comparisons, :date_range], parsed_date_range)}
end
end
- defp update_comparisons_date_range(include, _site), do: {:ok, include}
+ defp parse_comparison_date_range(include), do: {:ok, include}
defp parse_pagination(pagination) when is_map(pagination) do
{:ok,
diff --git a/lib/plausible/stats/filters/filters.ex b/lib/plausible/stats/filters/filters.ex
index f99f32b74a..3d1eb43899 100644
--- a/lib/plausible/stats/filters/filters.ex
+++ b/lib/plausible/stats/filters/filters.ex
@@ -4,7 +4,7 @@ defmodule Plausible.Stats.Filters do
"""
alias Plausible.Stats.Query
- alias Plausible.Stats.QueryParser
+ alias Plausible.Stats.ApiQueryParser
alias Plausible.Stats.Filters.LegacyStatsAPIFilterParser
@visit_props [
@@ -75,7 +75,7 @@ defmodule Plausible.Stats.Filters do
end
def parse(filters) when is_list(filters) do
- {:ok, parsed_filters} = QueryParser.parse_filters(filters)
+ {:ok, parsed_filters} = ApiQueryParser.parse_filters(filters)
parsed_filters
end
diff --git a/lib/plausible/stats/interval.ex b/lib/plausible/stats/interval.ex
index 64d607f482..df80628996 100644
--- a/lib/plausible/stats/interval.ex
+++ b/lib/plausible/stats/interval.ex
@@ -7,7 +7,7 @@ defmodule Plausible.Stats.Interval do
`week`, and `month`.
"""
- alias Plausible.Stats.DateTimeRange
+ alias Plausible.Stats.{DateTimeRange, Query}
@type t() :: String.t()
@type(opt() :: {:site, Plausible.Site.t()} | {:from, Date.t()}, {:to, Date.t()})
@@ -23,24 +23,16 @@ defmodule Plausible.Stats.Interval do
interval in @intervals
end
- @spec default_for_period(period()) :: t()
+ @spec default_for_query(Query.t()) :: t()
@doc """
- Returns the suggested interval for the given time period.
+ Returns the suggested interval (i.e. the time dimension) for the given query.
"""
- def default_for_period(period) do
- case period do
- period when period in ["realtime", "30m"] -> "minute"
- "day" -> "hour"
- period when period in ["custom", "7d", "28d", "30d", "91d", "month"] -> "day"
- period when period in ["6mo", "12mo", "year"] -> "month"
- end
- end
+ def default_for_query(query)
- @spec default_for_date_range(DateTimeRange.t()) :: t()
- @doc """
- Returns the suggested interval for the given `DateTimeRange` struct.
- """
- def default_for_date_range(%DateTimeRange{first: first, last: last}) do
+ def default_for_query(%Query{
+ input_date_range: :all,
+ utc_time_range: %DateTimeRange{first: first, last: last}
+ }) do
cond do
Plausible.Times.diff(last, first, :month) > 0 ->
"month"
@@ -53,6 +45,17 @@ defmodule Plausible.Stats.Interval do
end
end
+ def default_for_query(%Query{} = query) do
+ case query.input_date_range do
+ period when period in [:realtime, :realtime_30m] -> "minute"
+ :day -> "hour"
+ {:last_n_days, _} -> "day"
+ period when period in [:custom, :month] -> "day"
+ {:last_n_months, _} -> "month"
+ :year -> "month"
+ end
+ end
+
@valid_by_period %{
"realtime" => ["minute"],
"day" => ["minute", "hour"],
diff --git a/lib/plausible/stats/legacy/legacy_dimensions.ex b/lib/plausible/stats/legacy/legacy_dimensions.ex
index 0e4451424f..d8b03d9006 100644
--- a/lib/plausible/stats/legacy/legacy_dimensions.ex
+++ b/lib/plausible/stats/legacy/legacy_dimensions.ex
@@ -1,6 +1,6 @@
defmodule Plausible.Stats.Legacy.Dimensions do
@moduledoc """
- Deprecated module. See QueryParser for list of valid dimensions
+ Deprecated module. See ApiQueryParser for list of valid dimensions
"""
@event_props ["event:page", "event:name", "event:goal", "event:hostname"]
@session_props [
diff --git a/lib/plausible/stats/legacy/legacy_query_builder.ex b/lib/plausible/stats/legacy/legacy_query_builder.ex
index 476d89f9dc..35bc19b7fc 100644
--- a/lib/plausible/stats/legacy/legacy_query_builder.ex
+++ b/lib/plausible/stats/legacy/legacy_query_builder.ex
@@ -8,7 +8,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
use Plausible
- alias Plausible.Stats.{Filters, Interval, Query, QueryParser, QueryBuilder, DateTimeRange}
+ alias Plausible.Stats.{Filters, Interval, Query, ApiQueryParser, QueryBuilder, DateTimeRange}
def from(site, params, debug_metadata, now \\ nil) do
now = now || Plausible.Stats.Query.Test.get_fixed_now()
@@ -84,10 +84,10 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
defp put_input_date_range(%Query{now: now} = query, _site, %{"period" => period})
when period in ["realtime", "30m"] do
- duration_minutes =
+ {duration_minutes, input_date_range_atom} =
case period do
- "realtime" -> 5
- "30m" -> 30
+ "realtime" -> {5, :realtime}
+ "30m" -> {30, :realtime_30m}
end
first_datetime = DateTime.shift(now, minute: -duration_minutes)
@@ -96,7 +96,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
datetime_range =
DateTimeRange.new!(first_datetime, last_datetime) |> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: period, utc_time_range: datetime_range)
+ struct!(query, input_date_range: input_date_range_atom, utc_time_range: datetime_range)
end
defp put_input_date_range(query, site, %{"period" => "day"} = params) do
@@ -105,7 +105,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
datetime_range =
DateTimeRange.new!(date, date, site.timezone) |> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: "day", utc_time_range: datetime_range)
+ struct!(query, input_date_range: :day, utc_time_range: datetime_range)
end
defp put_input_date_range(query, site, %{"period" => period} = params)
@@ -119,7 +119,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
DateTimeRange.new!(start_date, end_date, site.timezone)
|> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: period, utc_time_range: datetime_range)
+ struct!(query, input_date_range: {:last_n_days, days}, utc_time_range: datetime_range)
end
defp put_input_date_range(query, site, %{"period" => "month"} = params) do
@@ -131,7 +131,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
DateTimeRange.new!(start_date, end_date, site.timezone)
|> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: "month", utc_time_range: datetime_range)
+ struct!(query, input_date_range: :month, utc_time_range: datetime_range)
end
defp put_input_date_range(query, site, %{"period" => "6mo"} = params) do
@@ -148,7 +148,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
DateTimeRange.new!(start_date, end_date, site.timezone)
|> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: "6mo", utc_time_range: datetime_range)
+ struct!(query, input_date_range: {:last_n_months, 6}, utc_time_range: datetime_range)
end
defp put_input_date_range(query, site, %{"period" => "12mo"} = params) do
@@ -165,7 +165,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
DateTimeRange.new!(start_date, end_date, site.timezone)
|> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: "12mo", utc_time_range: datetime_range)
+ struct!(query, input_date_range: {:last_n_months, 12}, utc_time_range: datetime_range)
end
defp put_input_date_range(query, site, %{"period" => "year"} = params) do
@@ -179,7 +179,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
DateTimeRange.new!(start_date, end_date, site.timezone)
|> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: "year", utc_time_range: datetime_range)
+ struct!(query, input_date_range: :year, utc_time_range: datetime_range)
end
defp put_input_date_range(query, site, %{"period" => "all"}) do
@@ -189,7 +189,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
datetime_range =
DateTimeRange.new!(start_date, today, site.timezone) |> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: "all", utc_time_range: datetime_range)
+ struct!(query, input_date_range: :all, utc_time_range: datetime_range)
end
defp put_input_date_range(
@@ -214,7 +214,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
DateTimeRange.new!(from_date, to_date, site.timezone)
|> DateTimeRange.to_timezone("Etc/UTC")
- struct!(query, input_date_range: "custom", utc_time_range: datetime_range)
+ struct!(query, input_date_range: :custom, utc_time_range: datetime_range)
end
defp put_input_date_range(query, site, params) do
@@ -234,7 +234,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
end
defp put_include(query, site, params) do
- include = parse_include(site, params["include"])
+ include = parse_include(params["include"])
query
|> struct!(include: include)
@@ -271,7 +271,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
def parse_order_by(order_by) do
with true <- is_binary(order_by),
{:ok, order_by} <- JSON.decode(order_by),
- {:ok, order_by} <- QueryParser.parse_order_by(order_by) do
+ {:ok, order_by} <- ApiQueryParser.parse_order_by(order_by) do
order_by
else
_ -> []
@@ -280,17 +280,17 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
@doc """
### Examples:
- iex> QueryBuilder.parse_include(%{}, nil)
+ iex> Plausible.Stats.Legacy.QueryBuilder.parse_include(nil)
Plausible.Stats.ParsedQueryParams.default_include()
- iex> QueryBuilder.parse_include(%{}, ~s({"total_rows": true}))
+ iex> Plausible.Stats.Legacy.QueryBuilder.parse_include(~s({"total_rows": true}))
Map.merge(Plausible.Stats.ParsedQueryParams.default_include(), %{total_rows: true})
"""
- def parse_include(site, include) do
+ def parse_include(include) do
include =
with true <- is_binary(include),
{:ok, include} <- JSON.decode(include),
- {:ok, include} <- QueryParser.parse_include(include, site) do
+ {:ok, include} <- ApiQueryParser.parse_include(include) do
include
else
_ -> %{}
@@ -304,13 +304,8 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
struct!(query, order_by: parse_order_by(params["order_by"]))
end
- defp put_interval(%{:input_date_range => "all"} = query, params) do
- interval = Map.get(params, "interval", Interval.default_for_date_range(query.utc_time_range))
- struct!(query, interval: interval)
- end
-
defp put_interval(query, params) do
- interval = Map.get(params, "interval", Interval.default_for_period(query.input_date_range))
+ interval = Map.get(params, "interval", Interval.default_for_query(query))
struct!(query, interval: interval)
end
@@ -343,7 +338,7 @@ defmodule Plausible.Stats.Legacy.QueryBuilder do
def parse_comparison_params(site, %{"comparison" => "custom"} = params) do
{:ok, date_range} =
- QueryParser.parse_date_range_pair(site, [
+ ApiQueryParser.parse_date_range_pair(site, [
params["compare_from"],
params["compare_to"]
])
diff --git a/lib/plausible/stats/parsed_query_params.ex b/lib/plausible/stats/parsed_query_params.ex
index f1488b4ef8..997ebe0857 100644
--- a/lib/plausible/stats/parsed_query_params.ex
+++ b/lib/plausible/stats/parsed_query_params.ex
@@ -3,7 +3,7 @@ defmodule Plausible.Stats.ParsedQueryParams do
defstruct [
:now,
- :utc_time_range,
+ :input_date_range,
:metrics,
:filters,
:dimensions,
@@ -12,8 +12,6 @@ defmodule Plausible.Stats.ParsedQueryParams do
:include
]
- alias Plausible.Stats.DateTimeRange
-
@default_include %{
imports: false,
# `include.imports_meta` can be true even when `include.imports`
@@ -38,12 +36,11 @@ defmodule Plausible.Stats.ParsedQueryParams do
def default_pagination(), do: @default_pagination
def new!(params) when is_map(params) do
- %DateTimeRange{} = utc_time_range = Map.fetch!(params, :utc_time_range)
[_ | _] = metrics = Map.fetch!(params, :metrics)
%__MODULE__{
now: params[:now],
- utc_time_range: utc_time_range,
+ input_date_range: Map.fetch!(params, :input_date_range),
metrics: metrics,
filters: params[:filters] || [],
dimensions: params[:dimensions] || [],
diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.ex
index 6f99cdd8f8..f628e33ea1 100644
--- a/lib/plausible/stats/query.ex
+++ b/lib/plausible/stats/query.ex
@@ -40,7 +40,7 @@ defmodule Plausible.Stats.Query do
Imported,
Legacy,
Comparisons,
- QueryParser,
+ ApiQueryParser,
ParsedQueryParams,
QueryBuilder
}
@@ -54,8 +54,8 @@ defmodule Plausible.Stats.Query do
debug_metadata \\ %{}
) do
with {:ok, %ParsedQueryParams{} = parsed_query_params} <-
- QueryParser.parse(site, schema_type, params) do
- QueryBuilder.build(site, parsed_query_params, params, debug_metadata)
+ ApiQueryParser.parse(schema_type, params) do
+ QueryBuilder.build(site, parsed_query_params, debug_metadata)
end
end
@@ -160,7 +160,7 @@ defmodule Plausible.Stats.Query do
end
defp get_imports_in_range(_site, %__MODULE__{input_date_range: period})
- when period in ["realtime", "30m"] do
+ when period in [:realtime, :realtime_30m] do
[]
end
diff --git a/lib/plausible/stats/query_builder.ex b/lib/plausible/stats/query_builder.ex
index 498f6665a4..4fbf8d9a38 100644
--- a/lib/plausible/stats/query_builder.ex
+++ b/lib/plausible/stats/query_builder.ex
@@ -5,11 +5,20 @@ defmodule Plausible.Stats.QueryBuilder do
use Plausible
alias Plausible.Segments
- alias Plausible.Stats.{Query, ParsedQueryParams, Comparisons, Filters, Time, TableDecider}
- def build(site, parsed_query_params, params, debug_metadata \\ %{}) do
+ alias Plausible.Stats.{
+ Query,
+ ParsedQueryParams,
+ Comparisons,
+ Filters,
+ Time,
+ TableDecider,
+ DateTimeRange
+ }
+
+ def build(site, parsed_query_params, debug_metadata \\ %{}) do
with {:ok, parsed_query_params} <- resolve_segments_in_filters(parsed_query_params, site),
- query = do_build(parsed_query_params, site, params, debug_metadata),
+ query = do_build(parsed_query_params, site, debug_metadata),
:ok <- validate_order_by(query),
:ok <- validate_custom_props_access(site, query),
:ok <- validate_toplevel_only_filter_dimension(query),
@@ -45,9 +54,99 @@ defmodule Plausible.Stats.QueryBuilder do
end
end
- defp do_build(parsed_query_params, site, params, debug_metadata) do
- %ParsedQueryParams{metrics: metrics, filters: filters, dimensions: dimensions} =
- parsed_query_params
+ defp build_datetime_range(input_date_range, _site, now)
+ when input_date_range in [:realtime, :realtime_30m] do
+ duration_minutes =
+ case input_date_range do
+ :realtime -> 5
+ :realtime_30m -> 30
+ end
+
+ first_datetime = DateTime.shift(now, minute: -duration_minutes)
+ last_datetime = DateTime.shift(now, second: 5)
+
+ DateTimeRange.new!(first_datetime, last_datetime)
+ end
+
+ defp build_datetime_range(:day, site, now) do
+ today = today_from_now(site, now)
+ DateTimeRange.new!(today, today, site.timezone)
+ end
+
+ defp build_datetime_range(:month, site, now) do
+ today = today_from_now(site, now)
+ first = today |> Date.beginning_of_month()
+ last = today |> Date.end_of_month()
+ DateTimeRange.new!(first, last, site.timezone)
+ end
+
+ defp build_datetime_range(:year, site, now) do
+ today = today_from_now(site, now)
+ first = today |> Plausible.Times.beginning_of_year()
+ last = today |> Plausible.Times.end_of_year()
+ DateTimeRange.new!(first, last, site.timezone)
+ end
+
+ defp build_datetime_range(:all, site, now) do
+ today = today_from_now(site, now)
+ start_date = Plausible.Sites.stats_start_date(site) || today
+ DateTimeRange.new!(start_date, today, site.timezone)
+ end
+
+ defp build_datetime_range({:last_n_days, n}, site, now) do
+ today = today_from_now(site, now)
+ last = today |> Date.add(-1)
+ first = today |> Date.add(-n)
+ DateTimeRange.new!(first, last, site.timezone)
+ end
+
+ defp build_datetime_range({:last_n_months, n}, site, now) do
+ today = today_from_now(site, now)
+ last = today |> Date.shift(month: -1) |> Date.end_of_month()
+ first = today |> Date.shift(month: -n) |> Date.beginning_of_month()
+ DateTimeRange.new!(first, last, site.timezone)
+ end
+
+ defp build_datetime_range({:date_range, from, to}, site, _now) do
+ DateTimeRange.new!(from, to, site.timezone)
+ end
+
+ defp build_datetime_range({:datetime_range, from, to}, _site, _now) do
+ DateTimeRange.new!(from, to)
+ end
+
+ defp build_comparison_datetime_range(
+ %ParsedQueryParams{include: %{comparisons: %{date_range: date_range}}} =
+ parsed_query_params,
+ site
+ ) do
+ comparison_date_range = build_datetime_range(date_range, site, parsed_query_params.now)
+
+ new_include =
+ put_in(parsed_query_params.include, [:comparisons, :date_range], comparison_date_range)
+
+ struct(parsed_query_params, include: new_include)
+ end
+
+ defp build_comparison_datetime_range(%ParsedQueryParams{} = parsed_query_params, _site) do
+ parsed_query_params
+ end
+
+ defp do_build(parsed_query_params, site, debug_metadata) do
+ %ParsedQueryParams{
+ input_date_range: input_date_range,
+ now: now,
+ metrics: metrics,
+ filters: filters,
+ dimensions: dimensions
+ } = parsed_query_params
+
+ parsed_query_params = build_comparison_datetime_range(parsed_query_params, site)
+
+ utc_time_range =
+ input_date_range
+ |> build_datetime_range(site, now)
+ |> DateTimeRange.to_timezone("Etc/UTC")
{preloaded_goals, revenue_warning, revenue_currencies} =
preload_goals_and_revenue(site, metrics, filters, dimensions)
@@ -65,7 +164,7 @@ defmodule Plausible.Stats.QueryBuilder do
preloaded_goals: preloaded_goals,
revenue_warning: revenue_warning,
revenue_currencies: revenue_currencies,
- input_date_range: Map.get(params, "date_range"),
+ utc_time_range: utc_time_range,
debug_metadata: debug_metadata
)
@@ -350,6 +449,10 @@ defmodule Plausible.Stats.QueryBuilder do
end
end
+ defp today_from_now(site, now) do
+ now |> DateTime.shift_zone!(site.timezone) |> DateTime.to_date()
+ end
+
defp i(value), do: inspect(value, charlists: :as_lists)
defp validate_list(list, parser_function) do
diff --git a/lib/plausible/stats/query_optimizer.ex b/lib/plausible/stats/query_optimizer.ex
index c42c7fe653..0ce8a18277 100644
--- a/lib/plausible/stats/query_optimizer.ex
+++ b/lib/plausible/stats/query_optimizer.ex
@@ -261,7 +261,7 @@ defmodule Plausible.Stats.QueryOptimizer do
defp trim_relative_date_range(query), do: query
- defp should_trim_date_range?(%Query{input_date_range: "month"} = query) do
+ defp should_trim_date_range?(%Query{input_date_range: :month} = query) do
today = query.now |> DateTime.shift_zone!(query.timezone) |> DateTime.to_date()
date_range = Query.date_range(query)
@@ -271,7 +271,7 @@ defmodule Plausible.Stats.QueryOptimizer do
date_range.first == current_month_start and date_range.last == current_month_end
end
- defp should_trim_date_range?(%Query{input_date_range: "year"} = query) do
+ defp should_trim_date_range?(%Query{input_date_range: :year} = query) do
today = query.now |> DateTime.shift_zone!(query.timezone) |> DateTime.to_date()
date_range = Query.date_range(query)
@@ -281,7 +281,7 @@ defmodule Plausible.Stats.QueryOptimizer do
date_range.first == current_year_start and date_range.last == current_year_end
end
- defp should_trim_date_range?(%Query{input_date_range: "day"} = query) do
+ defp should_trim_date_range?(%Query{input_date_range: :day} = query) do
today = query.now |> DateTime.shift_zone!(query.timezone) |> DateTime.to_date()
date_range = Query.date_range(query)
@@ -291,7 +291,7 @@ defmodule Plausible.Stats.QueryOptimizer do
defp should_trim_date_range?(_query), do: false
defp trim_date_range_to_now(query) do
- if query.input_date_range == "day" do
+ if query.input_date_range == :day do
time_range = query.utc_time_range |> DateTimeRange.to_timezone(query.timezone)
current_hour =
diff --git a/lib/plausible/stats/timeseries.ex b/lib/plausible/stats/timeseries.ex
index 9ea7e19a0f..ff632e5f25 100644
--- a/lib/plausible/stats/timeseries.ex
+++ b/lib/plausible/stats/timeseries.ex
@@ -97,7 +97,7 @@ defmodule Plausible.Stats.Timeseries do
end)
end
- defp transform_realtime_labels(results, %Query{input_date_range: "30m"}) do
+ defp transform_realtime_labels(results, %Query{input_date_range: :realtime_30m}) do
Enum.with_index(results)
|> Enum.map(fn {entry, index} -> %{entry | date: -30 + index} end)
end
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex
index b24c15a54b..015f2525ae 100644
--- a/lib/plausible_web/controllers/api/stats_controller.ex
+++ b/lib/plausible_web/controllers/api/stats_controller.ex
@@ -282,10 +282,10 @@ defmodule PlausibleWeb.Api.StatsController do
toplevel_goal_filter?(query)
cond do
- query.input_date_range == "30m" && goal_filter? ->
+ query.input_date_range == :realtime_30m && goal_filter? ->
fetch_goal_realtime_top_stats(site, query)
- query.input_date_range == "30m" ->
+ query.input_date_range == :realtime_30m ->
fetch_realtime_top_stats(site, query)
goal_filter? ->
@@ -589,7 +589,7 @@ defmodule PlausibleWeb.Api.StatsController do
Filters.filtering_on_dimension?(query, "event:page") ->
{:error, {:invalid_funnel_query, "pages"}}
- query.input_date_range == "realtime" ->
+ query.input_date_range == :realtime ->
{:error, {:invalid_funnel_query, "realtime period"}}
true ->
diff --git a/test/plausible/stats/interval_test.exs b/test/plausible/stats/interval_test.exs
index 6ce90ccdd6..93eeecd266 100644
--- a/test/plausible/stats/interval_test.exs
+++ b/test/plausible/stats/interval_test.exs
@@ -2,23 +2,41 @@ defmodule Plausible.Stats.IntervalTest do
use Plausible.DataCase, async: true
import Plausible.Stats.Interval
- alias Plausible.Stats.DateTimeRange
+ alias Plausible.Stats.{DateTimeRange, Query}
- test "default_for_period/1" do
- assert default_for_period("realtime") == "minute"
- assert default_for_period("day") == "hour"
- assert default_for_period("7d") == "day"
- assert default_for_period("12mo") == "month"
+ defp build_query(params) do
+ params =
+ %{metrics: [:visitors]}
+ |> Map.merge(params)
+ |> Map.to_list()
+
+ struct!(Query, params)
end
- test "default_for_date_range/1" do
- year = DateTimeRange.new!(~D[2022-01-01], ~D[2023-01-01], "UTC")
- fifteen_days = DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-15], "UTC")
- day = DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-01], "UTC")
+ describe "default_for_query/1" do
+ test "by input_date_range" do
+ assert default_for_query(build_query(%{input_date_range: :realtime})) == "minute"
+ assert default_for_query(build_query(%{input_date_range: :day})) == "hour"
+ assert default_for_query(build_query(%{input_date_range: {:last_n_days, 7}})) == "day"
+ assert default_for_query(build_query(%{input_date_range: {:last_n_months, 12}})) == "month"
+ end
+
+ test "by utc_time_range when period input_date_range is :all" do
+ year = DateTimeRange.new!(~D[2022-01-01], ~D[2023-01-01], "UTC")
+ fifteen_days = DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-15], "UTC")
+ day = DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-01], "UTC")
- assert default_for_date_range(year) == "month"
- assert default_for_date_range(fifteen_days) == "day"
- assert default_for_date_range(day) == "hour"
+ assert default_for_query(build_query(%{input_date_range: :all, utc_time_range: year})) ==
+ "month"
+
+ assert default_for_query(
+ build_query(%{input_date_range: :all, utc_time_range: fifteen_days})
+ ) ==
+ "day"
+
+ assert default_for_query(build_query(%{input_date_range: :all, utc_time_range: day})) ==
+ "hour"
+ end
end
describe "valid_by_period/1" do
diff --git a/test/plausible/stats/query/query_from_test.exs b/test/plausible/stats/query/query_from_test.exs
index d8a485f32c..fb4ca3cef2 100644
--- a/test/plausible/stats/query/query_from_test.exs
+++ b/test/plausible/stats/query/query_from_test.exs
@@ -56,7 +56,7 @@ defmodule Plausible.Stats.Query.QueryFromTest do
assert q.utc_time_range.first == ~U[2024-05-03 16:25:00Z]
assert q.utc_time_range.last == ~U[2024-05-03 16:30:05Z]
- assert q.input_date_range == "realtime"
+ assert q.input_date_range == :realtime
end
test "parses month format", %{site: site} do
@@ -96,7 +96,7 @@ defmodule Plausible.Stats.Query.QueryFromTest do
assert q.utc_time_range.first == ~U[2020-01-01 05:00:00Z]
assert q.utc_time_range.last == ~U[2024-05-04 03:59:59Z]
- assert q.input_date_range == "all"
+ assert q.input_date_range == :all
assert q.interval == "month"
end
@@ -114,7 +114,7 @@ defmodule Plausible.Stats.Query.QueryFromTest do
assert q.utc_time_range.first == ~U[2024-05-03 04:00:00Z]
assert q.utc_time_range.last == ~U[2024-05-04 03:59:59Z]
- assert q.input_date_range == "all"
+ assert q.input_date_range == :all
assert q.interval == "hour"
end
@@ -124,7 +124,7 @@ defmodule Plausible.Stats.Query.QueryFromTest do
assert q.utc_time_range.first == ~U[2024-05-03 04:00:00Z]
assert q.utc_time_range.last == ~U[2024-05-04 03:59:59Z]
- assert q.input_date_range == "all"
+ assert q.input_date_range == :all
assert q.interval == "hour"
end
@@ -136,7 +136,7 @@ defmodule Plausible.Stats.Query.QueryFromTest do
assert q.utc_time_range.first == ~U[2024-05-02 04:00:00Z]
assert q.utc_time_range.last == ~U[2024-05-04 03:59:59Z]
- assert q.input_date_range == "all"
+ assert q.input_date_range == :all
assert q.interval == "day"
end
@@ -148,7 +148,7 @@ defmodule Plausible.Stats.Query.QueryFromTest do
assert q.utc_time_range.first == ~U[2024-04-03 04:00:00Z]
assert q.utc_time_range.last == ~U[2024-05-04 03:59:59Z]
- assert q.input_date_range == "all"
+ assert q.input_date_range == :all
assert q.interval == "month"
end
@@ -160,7 +160,7 @@ defmodule Plausible.Stats.Query.QueryFromTest do
assert q.utc_time_range.first == ~U[2024-04-03 04:00:00Z]
assert q.utc_time_range.last == ~U[2024-05-04 03:59:59Z]
- assert q.input_date_range == "all"
+ assert q.input_date_range == :all
assert q.interval == "week"
end
diff --git a/test/plausible/stats/query/query_optimizer_test.exs b/test/plausible/stats/query/query_optimizer_test.exs
index 1d72656b07..d483a4f05c 100644
--- a/test/plausible/stats/query/query_optimizer_test.exs
+++ b/test/plausible/stats/query/query_optimizer_test.exs
@@ -160,7 +160,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: DateTimeRange.new!(~D[2024-01-01], ~D[2024-01-31], "UTC"),
- input_date_range: "month",
+ input_date_range: :month,
now: now,
timezone: "UTC",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, true)
@@ -176,7 +176,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: DateTimeRange.new!(~D[2024-01-01], ~D[2024-12-31], "UTC"),
- input_date_range: "year",
+ input_date_range: :year,
now: now,
timezone: "UTC",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, true)
@@ -192,7 +192,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: DateTimeRange.new!(~D[2024-01-15], ~D[2024-01-15], "UTC"),
- input_date_range: "day",
+ input_date_range: :day,
now: now,
timezone: "UTC",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, true)
@@ -209,7 +209,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: original_range,
- input_date_range: "month",
+ input_date_range: :month,
now: now,
timezone: "UTC",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, true)
@@ -225,7 +225,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: original_range,
- input_date_range: "year",
+ input_date_range: :year,
now: now,
timezone: "UTC",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, true)
@@ -241,7 +241,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: original_range,
- input_date_range: "day",
+ input_date_range: :day,
now: now,
timezone: "UTC",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, true)
@@ -257,7 +257,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: original_range,
- input_date_range: "day",
+ input_date_range: :day,
now: now,
timezone: "UTC",
include:
@@ -276,7 +276,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: DateTimeRange.new!(~D[2024-01-01], ~D[2024-01-31], "UTC"),
- input_date_range: "month",
+ input_date_range: :month,
now: now,
timezone: "UTC",
include:
@@ -297,7 +297,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: original_range,
- input_date_range: "month",
+ input_date_range: :month,
now: now,
timezone: "UTC",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, false)
@@ -313,7 +313,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: original_range,
- input_date_range: "month",
+ input_date_range: :month,
now: now,
timezone: "UTC",
include: ParsedQueryParams.default_include()
@@ -330,7 +330,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
result =
perform(%{
utc_time_range: original_range,
- input_date_range: "7d",
+ input_date_range: {:last_n_days, 7},
now: now,
timezone: "UTC",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, true)
@@ -347,7 +347,7 @@ defmodule Plausible.Stats.Query.QueryOptimizerTest do
utc_time_range:
DateTimeRange.new!(~D[2024-01-01], ~D[2024-12-31], "America/New_York")
|> DateTimeRange.to_timezone("Etc/UTC"),
- input_date_range: "year",
+ input_date_range: :year,
now: now,
timezone: "America/New_York",
include: Map.put(ParsedQueryParams.default_include(), :trim_relative_date_range, true)
diff --git a/test/plausible/stats/query/query_parser_test.exs b/test/plausible/stats/query/query_parser_test.exs
index 34a21aebc7..b17f8703cf 100644
--- a/test/plausible/stats/query/query_parser_test.exs
+++ b/test/plausible/stats/query/query_parser_test.exs
@@ -1,22 +1,20 @@
-defmodule Plausible.Stats.Query.QueryParserTest do
+defmodule Plausible.Stats.ApiQueryParserTest do
use Plausible.DataCase
- import Plausible.Stats.QueryParser
+ import Plausible.Stats.ApiQueryParser
- setup [:create_user, :create_site]
-
- test "parsing empty map fails", %{site: site} do
+ test "parsing empty map fails" do
assert {:error, "#: Required properties site_id, metrics, date_range were not present."} =
- parse(site, :public, %{})
+ parse(:public, %{})
end
- test "invalid metric passed", %{site: site} do
+ test "invalid metric passed" do
params = %{
- "site_id" => site.domain,
+ "site_id" => "example.com",
"metrics" => ["visitors", "event:name"],
"date_range" => "all"
}
assert {:error, "#/metrics/1: Invalid metric \"event:name\""} =
- parse(site, :public, params)
+ parse(:public, params)
end
end
diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_comparisons_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_comparisons_test.exs
index 284d21431f..e0b2309a72 100644
--- a/test/plausible_web/controllers/api/external_stats_controller/query_comparisons_test.exs
+++ b/test/plausible_web/controllers/api/external_stats_controller/query_comparisons_test.exs
@@ -118,7 +118,10 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryComparisonsTest do
conn: conn,
site: site
} do
- today = ~D[2021-06-10]
+ now = ~U[2021-06-10 12:00:00Z]
+ Plausible.Stats.Query.Test.fix_now(now)
+
+ today = DateTime.to_date(now)
make_request = fn match_day_of_week ->
conn
@@ -126,7 +129,6 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryComparisonsTest do
"site_id" => site.domain,
"metrics" => ["visitors"],
"date_range" => "28d",
- "date" => Date.to_iso8601(today),
"dimensions" => ["time"],
"include" => %{
"time_labels" => true,
diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_test.exs
index c5b5200bd3..50ff8a5f25 100644
--- a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs
+++ b/test/plausible_web/controllers/api/external_stats_controller/query_test.exs
@@ -1592,6 +1592,8 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryTest do
end
test "shows month to date with time labels trimmed", %{conn: conn, site: site} do
+ Plausible.Stats.Query.Test.fix_now(~U[2021-01-15 12:00:00Z])
+
populate_stats(site, [
build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
build(:pageview, timestamp: ~N[2021-01-15 00:00:00]),
@@ -1603,7 +1605,6 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryTest do
"site_id" => site.domain,
"metrics" => ["visitors"],
"date_range" => "month",
- "date" => "2021-01-15",
"dimensions" => ["time:day"],
"include" => %{"trim_relative_date_range" => true}
})