You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
analytics/lib/plausible/stats/query.ex

266 lines
7.2 KiB
Elixir

defmodule Plausible.Stats.Query do
use Plausible
defstruct date_range: nil,
interval: nil,
period: nil,
filters: %{},
sample_threshold: 20_000_000,
imported_data_requested: false,
include_imported: false,
now: nil
require OpenTelemetry.Tracer, as: Tracer
alias Plausible.Stats.{FilterParser, Interval}
@type t :: %__MODULE__{}
def from(site, params) do
now = NaiveDateTime.utc_now(:second)
query =
__MODULE__
|> struct!(now: now)
|> put_period(site, params)
|> put_interval(params)
|> put_parsed_filters(params)
|> put_imported_opts(site, params)
|> maybe_drop_prop_filter(site)
on_full_build do
query = Plausible.Stats.Sampling.put_threshold(query, params)
end
query
end
defp put_period(query, site, %{"period" => "realtime"}) do
date = today(site.timezone)
struct!(query, period: "realtime", date_range: Date.range(date, date))
end
defp put_period(query, site, %{"period" => "day"} = params) do
date = parse_single_date(site.timezone, params)
struct!(query, period: "day", date_range: Date.range(date, date))
end
defp put_period(query, site, %{"period" => "7d"} = params) do
end_date = parse_single_date(site.timezone, params)
start_date = end_date |> Timex.shift(days: -6)
struct!(
query,
period: "7d",
date_range: Date.range(start_date, end_date)
)
end
defp put_period(query, site, %{"period" => "30d"} = params) do
end_date = parse_single_date(site.timezone, params)
start_date = end_date |> Timex.shift(days: -30)
struct!(query, period: "30d", date_range: Date.range(start_date, end_date))
end
defp put_period(query, site, %{"period" => "month"} = params) do
date = parse_single_date(site.timezone, params)
start_date = Timex.beginning_of_month(date)
end_date = Timex.end_of_month(date)
struct!(query,
period: "month",
date_range: Date.range(start_date, end_date)
)
end
defp put_period(query, site, %{"period" => "6mo"} = params) do
end_date =
parse_single_date(site.timezone, params)
|> Timex.end_of_month()
start_date =
Timex.shift(end_date, months: -5)
|> Timex.beginning_of_month()
struct!(query,
period: "6mo",
date_range: Date.range(start_date, end_date)
)
end
defp put_period(query, site, %{"period" => "12mo"} = params) do
end_date =
parse_single_date(site.timezone, params)
|> Timex.end_of_month()
start_date =
Timex.shift(end_date, months: -11)
|> Timex.beginning_of_month()
struct!(query,
period: "12mo",
date_range: Date.range(start_date, end_date)
)
end
defp put_period(query, site, %{"period" => "year"} = params) do
end_date =
parse_single_date(site.timezone, params)
|> Timex.end_of_year()
start_date = Timex.beginning_of_year(end_date)
struct!(query,
period: "year",
date_range: Date.range(start_date, end_date)
)
end
defp put_period(query, site, %{"period" => "all"}) do
now = today(site.timezone)
start_date = Plausible.Site.local_start_date(site) || now
struct!(query,
period: "all",
date_range: Date.range(start_date, now)
)
end
defp put_period(query, site, %{"period" => "custom", "from" => from, "to" => to} = params) do
new_params =
params
|> Map.drop(["from", "to"])
|> Map.put("date", Enum.join([from, to], ","))
put_period(query, site, new_params)
end
defp put_period(query, _site, %{"period" => "custom", "date" => date}) do
[from, to] = String.split(date, ",")
from_date = Date.from_iso8601!(String.trim(from))
to_date = Date.from_iso8601!(String.trim(to))
struct!(query,
period: "custom",
date_range: Date.range(from_date, to_date)
)
end
defp put_period(query, site, params) do
put_period(query, site, Map.merge(params, %{"period" => "30d"}))
end
defp put_interval(%{:period => "all"} = query, params) do
interval = Map.get(params, "interval", Interval.default_for_date_range(query.date_range))
struct!(query, interval: interval)
end
defp put_interval(query, params) do
interval = Map.get(params, "interval", Interval.default_for_period(query.period))
struct!(query, interval: interval)
end
defp put_parsed_filters(query, params) do
struct!(query, filters: FilterParser.parse_filters(params["filters"]))
end
def put_filter(query, key, val) do
struct!(query,
filters: Map.put(query.filters, key, val)
)
end
def remove_event_filters(query, opts) do
new_filters =
Enum.filter(query.filters, fn {filter_key, _} ->
cond do
:page in opts && filter_key == "event:page" -> false
:goal in opts && filter_key == "event:goal" -> false
:props in opts && filter_key && String.starts_with?(filter_key, "event:props:") -> false
true -> true
end
end)
|> Enum.into(%{})
struct!(query, filters: new_filters)
end
def has_event_filters?(query) do
Enum.any?(query.filters, fn
{"event:" <> _, _} -> true
_ -> false
end)
end
def get_filter_by_prefix(query, prefix) do
Enum.find(query.filters, fn {prop, _value} ->
String.starts_with?(prop, prefix)
end)
end
defp today(tz) do
Timex.now(tz) |> Timex.to_date()
end
defp parse_single_date(tz, params) do
case params["date"] do
"today" -> Timex.now(tz) |> Timex.to_date()
date when is_binary(date) -> Date.from_iso8601!(date)
_ -> today(tz)
end
end
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?)
)
end
defp maybe_drop_prop_filter(query, site) do
prop_filter? = Map.has_key?(query.filters, "props")
props_available? = fn ->
site = Plausible.Repo.preload(site, :owner)
Plausible.Billing.Feature.Props.check_availability(site.owner) == :ok
end
if prop_filter? && !props_available?.(),
do: struct!(query, filters: Map.drop(query.filters, ["props"])),
else: query
end
@spec include_imported?(t(), Plausible.Site.t(), boolean()) :: boolean()
def include_imported?(query, site, requested?) do
cond do
is_nil(site.imported_data) -> false
site.imported_data.status != "ok" -> false
Timex.after?(query.date_range.first, site.imported_data.end_date) -> false
Enum.any?(query.filters) -> false
query.period == "realtime" -> false
true -> requested?
end
end
@spec trace(%__MODULE__{}, [atom()]) :: %__MODULE__{}
def trace(%__MODULE__{} = query, metrics) do
filter_keys = Map.keys(query.filters) |> Enum.sort() |> Enum.join(";")
metrics = metrics |> Enum.sort() |> Enum.join(";")
Tracer.set_attributes([
{"plausible.query.interval", query.interval},
{"plausible.query.period", query.period},
{"plausible.query.include_imported", query.include_imported},
{"plausible.query.filter_keys", filter_keys},
{"plausible.query.metrics", metrics}
])
query
end
end