Skip to content

Commit

Permalink
Move some query building out of Query.ex
Browse files Browse the repository at this point in the history
  • Loading branch information
@macobo
macobo committed Jul 3, 2024
1 parent 8929103 commit f0f7b2d
Show file tree
Hide file tree
Showing 2 changed files with 189 additions and 177 deletions.
178 changes: 178 additions & 0 deletions lib/plausible/stats/legacy_query_builder.ex
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
defmodule Plausible.Stats.LegacyQueryBuilder do
use Plausible

alias Plausible.Stats.{Interval, Query}

def from(site, params) do
now = NaiveDateTime.utc_now(:second)

query =
Query
|> struct!(now: now, timezone: site.timezone)
|> put_period(site, params)
|> put_dimensions(params)
|> put_interval(params)
|> put_parsed_filters(params)
|> Query.put_experimental_reduced_joins(site, params)
|> Query.put_imported_opts(site, params)

on_ee 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.Sites.stats_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_dimensions(query, params) do
if not is_nil(params["property"]) do
struct!(query, dimensions: [params["property"]])
else
struct!(query, dimensions: Map.get(params, "dimensions", []))
end
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: Filters.parse(params["filters"]))
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
end
188 changes: 11 additions & 177 deletions lib/plausible/stats/query.ex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,31 +24,10 @@ defmodule Plausible.Stats.Query do
}

require OpenTelemetry.Tracer, as: Tracer
alias Plausible.Stats.{Filters, Interval, Imported}
alias Plausible.Stats.{Filters, Imported, LegacyQueryBuilder}

@type t :: %__MODULE__{}

@spec from(Plausible.Site.t(), map()) :: t()
def from(site, params) do
now = NaiveDateTime.utc_now(:second)

query =
__MODULE__
|> struct!(now: now, timezone: site.timezone)
|> put_experimental_reduced_joins(site, params)
|> put_period(site, params)
|> put_dimensions(params)
|> put_interval(params)
|> put_parsed_filters(params)
|> put_imported_opts(site, params)

on_ee do
query = Plausible.Stats.Sampling.put_threshold(query, params)
end

query
end

def build(site, params) do
with {:ok, query_data} <- Filters.QueryParser.parse(site, params) do
query =
Expand All @@ -61,7 +40,15 @@ defmodule Plausible.Stats.Query do
end
end

defp put_experimental_reduced_joins(query, site, params) do
@doc """
Builds query from old-style params. New code should prefer Query.build
"""
@spec from(Plausible.Site.t(), map()) :: t()
def from(site, params) do
LegacyQueryBuilder.from(site, params)
end

def put_experimental_reduced_joins(query, site, params) do
if Map.has_key?(params, "experimental_reduced_joins") do
struct!(query,
experimental_reduced_joins?: Map.get(params, "experimental_reduced_joins") == "true"
Expand All @@ -73,147 +60,6 @@ defmodule Plausible.Stats.Query do
end
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.Sites.stats_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_dimensions(query, params) do
if not is_nil(params["property"]) do
struct!(query, dimensions: [params["property"]])
else
struct!(query, dimensions: Map.get(params, "dimensions", []))
end
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: Filters.parse(params["filters"]))
end

def set(query, keywords) do
new_query = struct!(query, keywords)

Expand Down Expand Up @@ -289,19 +135,7 @@ defmodule Plausible.Stats.Query do
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
def put_imported_opts(query, site, params) do
requested? = params["with_imported"] == "true" || query.include.imports

latest_import_end_date =
Expand Down

0 comments on commit f0f7b2d

Please sign in to comment.