Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
QueryBuilder follow-up (#5971)
RobertJoonasb735382e2916
diff --git a/extra/lib/plausible/stats/consolidated_view.ex b/extra/lib/plausible/stats/consolidated_view.exindex 8b646ae11d..2d53065723 100644--- a/extra/lib/plausible/stats/consolidated_view.ex+++ b/extra/lib/plausible/stats/consolidated_view.ex@@ -90,12 +90,12 @@ defmodule Plausible.Stats.ConsolidatedView doto_datetime = now |> DateTime.from_naive!("Etc/UTC")graph_query =- QueryBuilder.build!(view, %ParsedQueryParams{+ QueryBuilder.build!(view,metrics: [:visitors],input_date_range: {:datetime_range, from_datetime, to_datetime},dimensions: ["time:hour"],order_by: [{"time:hour", :asc}]- })+ )%Stats.QueryResult{results: results} = Stats.query(view, graph_query)diff --git a/extra/lib/plausible_web/live/funnel_settings/form.ex b/extra/lib/plausible_web/live/funnel_settings/form.exindex 2dbeb46051..e273bd1400 100644--- a/extra/lib/plausible_web/live/funnel_settings/form.ex+++ b/extra/lib/plausible_web/live/funnel_settings/form.ex@@ -10,7 +10,7 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form doimport PlausibleWeb.Live.Components.Formalias Plausible.{Goals, Funnels}- alias Plausible.Stats.{QueryBuilder, ParsedQueryParams}+ alias Plausible.Stats.QueryBuilderdef mount(_params, %{"domain" => domain} = session, socket) dosite =@@ -350,10 +350,10 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form do)query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:pageviews],input_date_range: :month- })+ ){:ok, {definition, query}}enddiff --git a/lib/plausible/segments/filters.ex b/lib/plausible/segments/filters.exindex 8b9e1b6e5c..bec2c14f9e 100644--- a/lib/plausible/segments/filters.ex+++ b/lib/plausible/segments/filters.ex@@ -3,7 +3,7 @@ defmodule Plausible.Segments.Filters doThis module contains functions that enable resolving segments in filters."""alias Plausible.Segments- alias Plausible.Stats.{Filters, ApiQueryParser}+ alias Plausible.Stats.{Filters, ApiQueryParser, QueryError}@max_segment_filters_count 10@@ -15,7 +15,7 @@ defmodule Plausible.Segments.Filters do{:ok, [10, 20]}iex> get_segment_ids([[:and, [[:is, "segment", Enum.to_list(1..6)], [:is, "segment", Enum.to_list(1..6)]]]])- {:error, "Invalid filters. You can only use up to 10 segment filters in a query."}+ {:error, %Plausible.Stats.QueryError{code: :invalid_filters, message: "Invalid filters. You can only use up to 10 segment filters in a query."}}"""def get_segment_ids(filters) doids =@@ -28,7 +28,11 @@ defmodule Plausible.Segments.Filters doif length(ids) > @max_segment_filters_count do{:error,- "Invalid filters. You can only use up to #{@max_segment_filters_count} segment filters in a query."}+ %QueryError{+ code: :invalid_filters,+ message:+ "Invalid filters. You can only use up to #{@max_segment_filters_count} segment filters in a query."+ }}else{:ok, Enum.uniq(ids)}end@@ -56,7 +60,12 @@ defmodule Plausible.Segments.Filters do)},:ok <-if(Enum.any?(segment_ids, fn id -> is_nil(Map.get(segments_by_id, id)) end),- do: {:error, "Invalid filters. Some segments don't exist or aren't accessible."},+ do:+ {:error,+ %QueryError{+ code: :invalid_filters,+ message: "Invalid filters. Some segments don't exist or aren't accessible."+ }},else: :ok) do{:ok, segments_by_id}diff --git a/lib/plausible/segments/segment.ex b/lib/plausible/segments/segment.exindex 0f7ef3916e..dda0d25c47 100644--- a/lib/plausible/segments/segment.ex+++ b/lib/plausible/segments/segment.ex@@ -5,7 +5,7 @@ defmodule Plausible.Segments.Segment douse Plausibleuse Ecto.Schemaimport Ecto.Changeset- alias Plausible.Stats.{ApiQueryParser, QueryBuilder, ParsedQueryParams}+ alias Plausible.Stats.{ApiQueryParser, QueryBuilder, ParsedQueryParams, QueryError}@segment_types [:personal, :site]@@ -126,7 +126,11 @@ defmodule Plausible.Segments.Segment do:ok <- maybe_validate_filters_depth(parsed_filters, restricted_depth?) do:okelse- {:error, message} -> {:error, {:invalid_filters, message}}+ {:error, %QueryError{code: :invalid_filters, message: message}} ->+ {:error, {:invalid_filters, message}}++ {:error, :deep_filters_not_supported} ->+ {:error, {:invalid_filters, "Invalid filters. Deep filters are not supported."}}endend@@ -138,7 +142,7 @@ defmodule Plausible.Segments.Segment doif Enum.all?(filters, &dashboard_compatible_filter?/1) do:okelse- {:error, "Invalid filters. Deep filters are not supported."}+ {:error, :deep_filters_not_supported}endenddiff --git a/lib/plausible/stats/api_query_parser.ex b/lib/plausible/stats/api_query_parser.exindex 7023cd3541..f285a5749e 100644--- a/lib/plausible/stats/api_query_parser.ex+++ b/lib/plausible/stats/api_query_parser.ex@@ -3,7 +3,7 @@ defmodule Plausible.Stats.ApiQueryParser douse Plausible- alias Plausible.Stats.{Filters, Metrics, JSONSchema}+ alias Plausible.Stats.{Filters, Metrics, JSONSchema, QueryError}@default_include %Plausible.Stats.QueryInclude{imports: false,@@ -50,8 +50,12 @@ defmodule Plausible.Stats.ApiQueryParser dodefp parse_metric(metric_str) docase Metrics.from_string(metric_str) do- {:ok, metric} -> {:ok, metric}- _ -> {:error, "Unknown metric '#{i(metric_str)}'."}+ {:ok, metric} ->+ {:ok, metric}++ _ ->+ {:error,+ %QueryError{code: :invalid_metrics, message: "Unknown metric '#{i(metric_str)}'."}}endend@@ -82,7 +86,11 @@ defmodule Plausible.Stats.ApiQueryParser dodefp parse_operator(["not" | _rest]), do: {:ok, :not}defp parse_operator(["has_done" | _rest]), do: {:ok, :has_done}defp parse_operator(["has_not_done" | _rest]), do: {:ok, :has_not_done}- defp parse_operator(filter), do: {:error, "Unknown operator for filter '#{i(filter)}'."}++ defp parse_operator(filter),+ do:+ {:error,+ %QueryError{code: :invalid_filters, message: "Unknown operator for filter '#{i(filter)}'."}}def parse_filter_second(operator, [_, filters | _rest]) when operator in [:and, :or],do: parse_filters(filters)@@ -97,7 +105,8 @@ defmodule Plausible.Stats.ApiQueryParser doparse_filter_dimension_string(filter_dimension, "Invalid filter '#{i(filter)}'.")end- defp parse_filter_dimension(filter), do: {:error, "Invalid filter '#{i(filter)}'."}+ defp parse_filter_dimension(filter),+ do: {:error, %QueryError{code: :invalid_filters, message: "Invalid filter '#{i(filter)}'."}}defp parse_filter_rest(operator, filter)when operator in [@@ -133,7 +142,11 @@ defmodule Plausible.Stats.ApiQueryParser do{:ok, list}else{:error,- "Invalid visit:country filter, visit:country needs to be a valid 2-letter country code."}+ %QueryError{+ code: :invalid_filters,+ message:+ "Invalid visit:country filter, visit:country needs to be a valid 2-letter country code."+ }}end{"segment", _} when all_integers? ->@@ -143,11 +156,12 @@ defmodule Plausible.Stats.ApiQueryParser do{:ok, list}_ ->- {:error, "Invalid filter '#{i(filter)}'."}+ {:error, %QueryError{code: :invalid_filters, message: "Invalid filter '#{i(filter)}'."}}endend- defp parse_clauses_list(filter), do: {:error, "Invalid filter '#{i(filter)}'."}+ defp parse_clauses_list(filter),+ do: {:error, %QueryError{code: :invalid_filters, message: "Invalid filter '#{i(filter)}'."}}defp parse_filter_modifiers(modifiers) when is_map(modifiers) do{:ok, [atomize_keys(modifiers)]}@@ -164,9 +178,15 @@ defmodule Plausible.Stats.ApiQueryParser dodefp parse_input_date_range(shorthand) when is_binary(shorthand) docase Integer.parse(shorthand) do- {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)}"}+ {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,+ %QueryError{code: :invalid_date_range, message: "Invalid date_range #{i(shorthand)}"}}endend@@ -178,7 +198,7 @@ defmodule Plausible.Stats.ApiQueryParser doenddefp parse_input_date_range(unknown) do- {:error, "Invalid date_range #{i(unknown)}"}+ {:error, %QueryError{code: :invalid_date_range, message: "Invalid date_range #{i(unknown)}"}}enddefp parse_date_strings(from, to) do@@ -193,7 +213,9 @@ defmodule Plausible.Stats.ApiQueryParser do{:ok, to_datetime, _offset} <- DateTime.from_iso8601(to) do{:ok, {:datetime_range, from_datetime, to_datetime}}else- _ -> {:error, "Invalid date_range '#{i([from, to])}'."}+ _ ->+ {:error,+ %QueryError{code: :invalid_date_range, message: "Invalid date_range '#{i([from, to])}'."}}endend@@ -211,7 +233,11 @@ defmodule Plausible.Stats.ApiQueryParser doenddef parse_order_by(nil), do: {:ok, nil}- def parse_order_by(order_by), do: {:error, "Invalid order_by '#{i(order_by)}'."}++ def parse_order_by(order_by),+ do:+ {:error,+ %QueryError{code: :invalid_order_by, message: "Invalid order_by '#{i(order_by)}'."}}defp parse_order_by_entry(entry) dowith {:ok, value} <- parse_metric_or_dimension(entry),@@ -227,7 +253,7 @@ defmodule Plausible.Stats.ApiQueryParser do} do{{:ok, time}, _} -> {:ok, time}{_, {:ok, dimension}} -> {:ok, dimension}- _ -> {:error, error_message}+ _ -> {:error, %QueryError{code: :invalid_dimensions, message: error_message}}endend@@ -237,10 +263,18 @@ defmodule Plausible.Stats.ApiQueryParser doparse_metric(value),parse_filter_dimension_string(value)} do- {{:ok, time}, _, _} -> {:ok, time}- {_, {:ok, metric}, _} -> {:ok, metric}- {_, _, {:ok, dimension}} -> {:ok, dimension}- _ -> {:error, "Invalid order_by entry '#{i(entry)}'."}+ {{:ok, time}, _, _} ->+ {:ok, time}++ {_, {:ok, metric}, _} ->+ {:ok, metric}++ {_, _, {:ok, dimension}} ->+ {:ok, dimension}++ _ ->+ {:error,+ %QueryError{code: :invalid_order_by, message: "Invalid order_by entry '#{i(entry)}'."}}endend@@ -254,7 +288,11 @@ defmodule Plausible.Stats.ApiQueryParser dodefp parse_order_direction([_, "asc"]), do: {:ok, :asc}defp parse_order_direction([_, "desc"]), do: {:ok, :desc}- defp parse_order_direction(entry), do: {:error, "Invalid order_by entry '#{i(entry)}'."}++ defp parse_order_direction(entry),+ do:+ {:error,+ %QueryError{code: :invalid_order_by, message: "Invalid order_by entry '#{i(entry)}'."}}def parse_include(include) when is_map(include) doparsed_include_params_or_error =@@ -262,7 +300,7 @@ defmodule Plausible.Stats.ApiQueryParser do|> Enum.reduce_while({:ok, []}, fn {key, value}, {:ok, acc} ->case parse_include_entry(key, value) do{:ok, parsed_tuple} -> {:cont, {:ok, acc ++ [parsed_tuple]}}- {:error, msg} -> {:halt, {:error, msg}}+ {:error, query_error} -> {:halt, {:error, query_error}}endend)@@ -272,7 +310,9 @@ defmodule Plausible.Stats.ApiQueryParser doenddef parse_include(nil), do: {:ok, @default_include}- def parse_include(include), do: {:error, "Invalid include '#{i(include)}'."}++ def parse_include(include),+ do: {:error, %QueryError{code: :invalid_include, message: "Invalid include '#{i(include)}'."}}@allowed_include_keys Enum.map(Map.keys(@default_include), &Atom.to_string/1)@@ -280,7 +320,8 @@ defmodule Plausible.Stats.ApiQueryParser do{:ok, {String.to_existing_atom(key), value}}end- defp parse_include_entry(key, _value), do: {:error, "Invalid include key'#{i(key)}'."}+ defp parse_include_entry(key, _value),+ do: {:error, %QueryError{code: :invalid_include, message: "Invalid include key'#{i(key)}'."}}defp parse_pagination(pagination) when is_map(pagination) do{:ok, Map.merge(@default_pagination, atomize_keys(pagination))}@@ -300,28 +341,28 @@ defmodule Plausible.Stats.ApiQueryParser doif String.length(property_name) > 0 do{:ok, dimension}else- {:error, error_message}+ {:error, %QueryError{code: :invalid_filters, message: error_message}}end"event:" <> key ->if key in Filters.event_props() do{:ok, dimension}else- {:error, error_message}+ {:error, %QueryError{code: :invalid_filters, message: error_message}}end"visit:" <> key ->if key in Filters.visit_props() do{:ok, dimension}else- {:error, error_message}+ {:error, %QueryError{code: :invalid_filters, message: error_message}}end"segment" ->{:ok, dimension}_ ->- {:error, error_message}+ {:error, %QueryError{code: :invalid_filters, message: error_message}}endenddiff --git a/lib/plausible/stats/goal_suggestions.ex b/lib/plausible/stats/goal_suggestions.exindex 17438804f7..5ab861f405 100644--- a/lib/plausible/stats/goal_suggestions.ex+++ b/lib/plausible/stats/goal_suggestions.ex@@ -2,7 +2,7 @@ defmodule Plausible.Stats.GoalSuggestions do@moduledoc falsealias Plausible.{Repo, ClickhouseRepo}- alias Plausible.Stats.{Query, QueryBuilder, ParsedQueryParams, QueryInclude}+ alias Plausible.Stats.{Query, QueryBuilder}import Plausible.Stats.Baseimport Ecto.Query@@ -39,11 +39,11 @@ defmodule Plausible.Stats.GoalSuggestions dofrom_date = Date.shift(to_date, month: -6)query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: {:date_range, from_date, to_date},metrics: [:pageviews],- include: %QueryInclude{imports: true}- })+ include: [imports: true]+ )native_q =from(e in base_event_query(query),diff --git a/lib/plausible/stats/json_schema.ex b/lib/plausible/stats/json_schema.exindex 8b4f482d0a..c12b65e473 100644--- a/lib/plausible/stats/json_schema.ex+++ b/lib/plausible/stats/json_schema.ex@@ -7,6 +7,7 @@ defmodule Plausible.Stats.JSONSchema do"""use Plausiblealias Plausible.Stats.JSONSchema.Utils+ alias Plausible.Stats.QueryError@json_schema_filepath "priv/json-schemas/query-api-schema.json"@external_resource @json_schema_filepath@@ -28,8 +29,12 @@ defmodule Plausible.Stats.JSONSchema dodef validate(params) docase ExJsonSchema.Validator.validate(@query_schema, params) do- :ok -> :ok- {:error, errors} -> {:error, format_errors(errors, params)}+ :ok ->+ :ok++ {:error, errors} ->+ {:error,+ %QueryError{code: :failed_schema_validation, message: format_errors(errors, params)}}endenddiff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.exindex 63ca541d37..e9294cc862 100644--- a/lib/plausible/stats/query.ex+++ b/lib/plausible/stats/query.ex@@ -42,7 +42,8 @@ defmodule Plausible.Stats.Query doComparisons,ApiQueryParser,ParsedQueryParams,- QueryBuilder+ QueryBuilder,+ QueryError}@type t :: %__MODULE__{}@@ -60,8 +61,11 @@ defmodule Plausible.Stats.Query dodef parse_and_build!(site, params, debug_metadata \\ %{}) docase parse_and_build(site, params, debug_metadata) do- {:ok, query} -> query- {:error, reason} -> raise "Failed to build query: #{inspect(reason)}"+ {:ok, query} ->+ query++ {:error, %QueryError{message: message}} ->+ raise "Failed to build query: #{inspect(message)}"endenddiff --git a/lib/plausible/stats/query_builder.ex b/lib/plausible/stats/query_builder.exindex 6a9bf949be..5eb151138b 100644--- a/lib/plausible/stats/query_builder.ex+++ b/lib/plausible/stats/query_builder.ex@@ -13,10 +13,20 @@ defmodule Plausible.Stats.QueryBuilder doFilters,Time,TableDecider,- DateTimeRange+ DateTimeRange,+ QueryError,+ QueryInclude}- def build(site, parsed_query_params, debug_metadata \\ %{}) do+ @doc """+ Runs various validations and builds a `%Query{}` from already parsed params.++ For convenience, the "parsed params" can also be given as a keyword list, in+ which case it gets turned in to `ParsedQueryParams` by the function itself.+ """+ def build(site, parsed_query_params, debug_metadata \\ %{})++ def build(site, %ParsedQueryParams{} = parsed_query_params, debug_metadata) dowith {:ok, parsed_query_params} <- resolve_segments_in_filters(parsed_query_params, site),query = do_build(parsed_query_params, site, debug_metadata),:ok <- validate_order_by(query),@@ -46,10 +56,20 @@ defmodule Plausible.Stats.QueryBuilder doendend- def build!(site, parsed_query_params, debug_metadata \\ %{}) do- case build(site, parsed_query_params, debug_metadata) do- {:ok, query} -> query- {:error, reason} -> raise "Failed to build query: #{inspect(reason)}"+ def build(site, params, debug_metadata) when is_list(params) do+ include = struct!(QueryInclude, Keyword.get(params, :include, []))+ parsed_query_params = struct!(ParsedQueryParams, Keyword.put(params, :include, include))++ build(site, parsed_query_params, debug_metadata)+ end++ def build!(site, params, debug_metadata \\ %{}) do+ case build(site, params, debug_metadata) do+ {:ok, query} ->+ query++ {:error, %QueryError{message: message}} ->+ raise "Failed to build query: #{inspect(message)}"endend@@ -210,7 +230,11 @@ defmodule Plausible.Stats.QueryBuilder dodefp validate_revenue_metrics_access(site, query) doif Revenue.requested?(query.metrics) and not Revenue.available?(site) do- {:error, "The owner of this site does not have access to the revenue metrics feature."}+ {:error,+ %QueryError{+ code: :feature_access,+ message: "The owner of this site does not have access to the revenue metrics feature."+ }}else:okend@@ -236,7 +260,11 @@ defmodule Plausible.Stats.QueryBuilder do_ ->{:error,- "Invalid order_by entry '#{i(invalid_entry)}'. Entry is not a queried metric or dimension."}+ %QueryError{+ code: :invalid_order_by,+ message:+ "Invalid order_by entry '#{i(invalid_entry)}'. Entry is not a queried metric or dimension."+ }}endelse:ok@@ -260,7 +288,11 @@ defmodule Plausible.Stats.QueryBuilder doif invalid_filter do{:error,- "Invalid filters. The case_sensitive modifier is not allowed with pattern operators (#{i(invalid_filter)})"}+ %QueryError{+ code: :invalid_filters,+ message:+ "Invalid filters. The case_sensitive modifier is not allowed with pattern operators (#{i(invalid_filter)})"+ }}else:okend@@ -275,7 +307,11 @@ defmodule Plausible.Stats.QueryBuilder doif Enum.count(not_toplevel) > 0 do{:error,- "Invalid filters. Dimension `#{List.first(not_toplevel)}` can only be filtered at the top level."}+ %QueryError{+ code: :invalid_filters,+ message:+ "Invalid filters. Dimension `#{List.first(not_toplevel)}` can only be filtered at the top level."+ }}else:okend@@ -292,7 +328,11 @@ defmodule Plausible.Stats.QueryBuilder doif special_metric? and deep_custom_property? do{:error,- "Invalid filters. When `conversion_rate` or `group_conversion_rate` metrics are used, custom property filters can only be used on top level."}+ %QueryError{+ code: :invalid_filters,+ message:+ "Invalid filters. When `conversion_rate` or `group_conversion_rate` metrics are used, custom property filters can only be used on top level."+ }}else:okend@@ -316,12 +356,20 @@ defmodule Plausible.Stats.QueryBuilder dobehavioral_depth > 1 ->{:halt,{:error,- "Invalid filters. Behavioral filters (has_done, has_not_done) cannot be nested."}}+ %QueryError{+ code: :invalid_filters,+ message:+ "Invalid filters. Behavioral filters (has_done, has_not_done) cannot be nested."+ }}}not String.starts_with?(dimension, "event:") ->{:halt,{:error,- "Invalid filters. Behavioral filters (has_done, has_not_done) can only be used with event dimension filters."}}+ %QueryError{+ code: :invalid_filters,+ message:+ "Invalid filters. Behavioral filters (has_done, has_not_done) can only be used with event dimension filters."+ }}}true ->{:cont, :ok}@@ -355,7 +403,11 @@ defmodule Plausible.Stats.QueryBuilder do:okelse{:error,- "Invalid filters. The goal `#{clause}` is not configured for this site. Find out how to configure goals here: https://plausible.io/docs/stats-api#filtering-by-goals"}+ %QueryError{+ code: :invalid_filters,+ message:+ "Invalid filters. The goal `#{clause}` is not configured for this site. Find out how to configure goals here: https://plausible.io/docs/stats-api#filtering-by-goals"+ }}endend@@ -380,7 +432,11 @@ defmodule Plausible.Stats.QueryBuilder doif valid? do:okelse- {:error, "The owner of this site does not have access to the custom properties feature."}+ {:error,+ %QueryError{+ code: :feature_access,+ message: "The owner of this site does not have access to the custom properties feature."+ }}endend@@ -395,7 +451,11 @@ defmodule Plausible.Stats.QueryBuilder doFilters.filtering_on_dimension?(query, "event:goal", behavioral_filters: :ignore) do:okelse- {:error, "Metric `#{metric}` can only be queried with event:goal filters or dimensions."}+ {:error,+ %QueryError{+ code: :invalid_metrics,+ message: "Metric `#{metric}` can only be queried with event:goal filters or dimensions."+ }}endend@@ -406,7 +466,11 @@ defmodule Plausible.Stats.QueryBuilder doif page_dimension? or toplevel_page_filter? do:okelse- {:error, "Metric `#{metric}` can only be queried with event:page filters or dimensions."}+ {:error,+ %QueryError{+ code: :invalid_metrics,+ message: "Metric `#{metric}` can only be queried with event:page filters or dimensions."+ }}endend@@ -416,21 +480,37 @@ defmodule Plausible.Stats.QueryBuilder do:ok{["visit:exit_page"], true} ->- {:error, "Metric `#{metric}` cannot be queried when filtering on event dimensions."}+ {:error,+ %QueryError{+ code: :invalid_metrics,+ message: "Metric `#{metric}` cannot be queried when filtering on event dimensions."+ }}_ ->{:error,- "Metric `#{metric}` requires a `\"visit:exit_page\"` dimension. No other dimensions are allowed."}+ %QueryError{+ code: :invalid_metrics,+ message:+ "Metric `#{metric}` requires a `\"visit:exit_page\"` dimension. No other dimensions are allowed."+ }}endenddefp validate_metric(:views_per_visit = metric, query) docond doFilters.filtering_on_dimension?(query, "event:page", behavioral_filters: :ignore) ->- {:error, "Metric `#{metric}` cannot be queried with a filter on `event:page`."}+ {:error,+ %QueryError{+ code: :invalid_metrics,+ message: "Metric `#{metric}` cannot be queried with a filter on `event:page`."+ }}length(query.dimensions) > 0 ->- {:error, "Metric `#{metric}` cannot be queried with `dimensions`."}+ {:error,+ %QueryError{+ code: :invalid_metrics,+ message: "Metric `#{metric}` cannot be queried with `dimensions`."+ }}true ->:ok@@ -446,7 +526,12 @@ defmodule Plausible.Stats.QueryBuilder do:oktrue ->- {:error, "Metric `#{metric}` can only be queried with event:page filters or dimensions."}+ {:error,+ %QueryError{+ code: :invalid_metrics,+ message:+ "Metric `#{metric}` can only be queried with event:page filters or dimensions."+ }}endend@@ -456,7 +541,11 @@ defmodule Plausible.Stats.QueryBuilder dotime_dimension? = Enum.any?(query.dimensions, &Time.time_dimension?/1)if query.include.time_labels and not time_dimension? do- {:error, "Invalid include.time_labels: requires a time dimension."}+ {:error,+ %QueryError{+ code: :invalid_include,+ message: "Invalid include.time_labels: requires a time dimension."+ }}else:okenddiff --git a/lib/plausible/stats/query_error.ex b/lib/plausible/stats/query_error.exnew file mode 100644index 0000000000..3ec8a9e6ef--- /dev/null+++ b/lib/plausible/stats/query_error.ex@@ -0,0 +1,4 @@+defmodule Plausible.Stats.QueryError do+ @moduledoc false+ defstruct [:code, :message]+enddiff --git a/lib/plausible/stats/table_decider.ex b/lib/plausible/stats/table_decider.exindex e08ae206f6..2a19400ebf 100644--- a/lib/plausible/stats/table_decider.ex+++ b/lib/plausible/stats/table_decider.ex@@ -7,7 +7,7 @@ defmodule Plausible.Stats.TableDecider doimport Enum, only: [empty?: 1]import Plausible.Stats.Filters, only: [dimensions_used_in_filters: 1]- alias Plausible.Stats.Query+ alias Plausible.Stats.{Query, QueryError}def events_join_sessions?(query) doquery.filters@@ -43,11 +43,19 @@ defmodule Plausible.Stats.TableDecider donot empty?(session_only_metrics) and not empty?(event_only_dimensions) ->{:error,- "Session metric(s) #{i(session_only_metrics)} cannot be queried along with event dimension(s) #{i(event_only_dimensions)}"}+ %QueryError{+ code: :invalid_metrics,+ message:+ "Session metric(s) #{i(session_only_metrics)} cannot be queried along with event dimension(s) #{i(event_only_dimensions)}"+ }}not empty?(event_only_metrics) and not empty?(session_only_dimensions) ->{:error,- "Event metric(s) #{i(event_only_metrics)} cannot be queried along with session dimension(s) #{i(session_only_dimensions)}"}+ %QueryError{+ code: :invalid_metrics,+ message:+ "Event metric(s) #{i(event_only_metrics)} cannot be queried along with session dimension(s) #{i(session_only_dimensions)}"+ }}true ->:okdiff --git a/lib/plausible_web/controllers/api/external_query_api_controller.ex b/lib/plausible_web/controllers/api/external_query_api_controller.exindex 0d391540c5..f609371f6d 100644--- a/lib/plausible_web/controllers/api/external_query_api_controller.ex+++ b/lib/plausible_web/controllers/api/external_query_api_controller.ex@@ -4,7 +4,7 @@ defmodule PlausibleWeb.Api.ExternalQueryApiController douse PlausibleWeb, :controlleruse Plausible.Repouse PlausibleWeb.Plugs.ErrorHandler- alias Plausible.Stats.Query+ alias Plausible.Stats.{Query, QueryError}def query(conn, params) dosite = Repo.preload(conn.assigns.site, :owners)@@ -14,7 +14,7 @@ defmodule PlausibleWeb.Api.ExternalQueryApiController doresults = Plausible.Stats.query(site, query)json(conn, results)- {:error, message} ->+ {:error, %QueryError{message: message}} ->conn|> put_status(400)|> json(%{error: message})diff --git a/lib/plausible_web/live/goal_settings/form.ex b/lib/plausible_web/live/goal_settings/form.exindex 321e2947f6..716a7eb99e 100644--- a/lib/plausible_web/live/goal_settings/form.ex+++ b/lib/plausible_web/live/goal_settings/form.ex@@ -7,7 +7,7 @@ defmodule PlausibleWeb.Live.GoalSettings.Form doalias PlausibleWeb.Live.Components.ComboBoxalias Plausible.Repo- alias Plausible.Stats.{QueryBuilder, ParsedQueryParams, QueryInclude}+ alias Plausible.Stats.QueryBuilderdef update(assigns, socket) dosite = Repo.preload(assigns.site, [:team, :owners])@@ -507,11 +507,11 @@ defmodule PlausibleWeb.Live.GoalSettings.Form dodef suggest_page_paths(input, site) doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: :all,metrics: [:pageviews],- include: %QueryInclude{imports: true}- })+ include: [imports: true]+ )site|> Plausible.Stats.filter_suggestions(query, "page", input)diff --git a/lib/plausible_web/live/shields/hostname_rules.ex b/lib/plausible_web/live/shields/hostname_rules.exindex 6bc6880ab4..01cb6e961e 100644--- a/lib/plausible_web/live/shields/hostname_rules.ex+++ b/lib/plausible_web/live/shields/hostname_rules.ex@@ -8,7 +8,7 @@ defmodule PlausibleWeb.Live.Shields.HostnameRules doalias PlausibleWeb.Live.Components.Modalalias Plausible.Shieldsalias Plausible.Shield- alias Plausible.Stats.{QueryBuilder, ParsedQueryParams}+ alias Plausible.Stats.QueryBuilderdef update(assigns, socket) dosocket =@@ -253,10 +253,10 @@ defmodule PlausibleWeb.Live.Shields.HostnameRules dodef suggest_hostnames(input, _options, site) doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: :all,metrics: [:pageviews]- })+ )site|> Plausible.Stats.filter_suggestions(query, "hostname", input)diff --git a/lib/plausible_web/live/shields/page_rules.ex b/lib/plausible_web/live/shields/page_rules.exindex e6c78cf1b3..c7eac3023d 100644--- a/lib/plausible_web/live/shields/page_rules.ex+++ b/lib/plausible_web/live/shields/page_rules.ex@@ -8,7 +8,7 @@ defmodule PlausibleWeb.Live.Shields.PageRules doalias PlausibleWeb.Live.Components.Modalalias Plausible.Shieldsalias Plausible.Shield- alias Plausible.Stats.{QueryBuilder, ParsedQueryParams}+ alias Plausible.Stats.QueryBuilderdef update(assigns, socket) dosocket =@@ -249,11 +249,11 @@ defmodule PlausibleWeb.Live.Shields.PageRules dodef suggest_page_paths(input, _options, site, page_rules) doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: :all,metrics: [:pageviews],filters: [[:is_not, "event:page", Enum.map(page_rules, & &1.page_path)]]- })+ )site|> Plausible.Stats.filter_suggestions(query, "page", input)diff --git a/test/plausible/funnels_custom_props_goals_test.exs b/test/plausible/funnels_custom_props_goals_test.exsindex 8838dcd17a..439ecca947 100644--- a/test/plausible/funnels_custom_props_goals_test.exs+++ b/test/plausible/funnels_custom_props_goals_test.exs@@ -6,7 +6,7 @@ defmodule Plausible.FunnelsCustomPropsGoals doalias Plausible.Goalsalias Plausible.Funnelsalias Plausible.Stats- alias Plausible.Stats.{QueryBuilder, ParsedQueryParams}+ alias Plausible.Stats.QueryBuilderdescribe "Plausible.Stats.Funnel - with custom property goals" dosetup do@@ -57,7 +57,7 @@ defmodule Plausible.FunnelsCustomPropsGoals dobuild(:event, name: "Purchase", user_id: 300)])- query = QueryBuilder.build!(site, %ParsedQueryParams{input_date_range: :all})+ query = QueryBuilder.build!(site, input_date_range: :all){:ok, funnel_data} = Stats.funnel(site, query, funnel.id)@@ -120,7 +120,7 @@ defmodule Plausible.FunnelsCustomPropsGoals do)])- query = QueryBuilder.build!(site, %ParsedQueryParams{input_date_range: :all})+ query = QueryBuilder.build!(site, input_date_range: :all){:ok, funnel_data} = Stats.funnel(site, query, funnel.id)@@ -200,7 +200,7 @@ defmodule Plausible.FunnelsCustomPropsGoals do)])- query = QueryBuilder.build!(site, %ParsedQueryParams{input_date_range: :all})+ query = QueryBuilder.build!(site, input_date_range: :all){:ok, funnel_data} = Stats.funnel(site, query, funnel.id)@@ -244,7 +244,7 @@ defmodule Plausible.FunnelsCustomPropsGoals dobuild(:event, name: "Convert", user_id: 200)])- query = QueryBuilder.build!(site, %ParsedQueryParams{input_date_range: :all})+ query = QueryBuilder.build!(site, input_date_range: :all){:ok, funnel_data} = Stats.funnel(site, query, funnel.id)diff --git a/test/plausible/funnels_test.exs b/test/plausible/funnels_test.exsindex 6c27110c1d..53e3e2a296 100644--- a/test/plausible/funnels_test.exs+++ b/test/plausible/funnels_test.exs@@ -6,7 +6,7 @@ defmodule Plausible.FunnelsTest doalias Plausible.Goalsalias Plausible.Funnelsalias Plausible.Stats- alias Plausible.Stats.{QueryBuilder, ParsedQueryParams}+ alias Plausible.Stats.QueryBuildersetup dosite = new_site()@@ -201,7 +201,7 @@ defmodule Plausible.FunnelsTest dobuild(:event, name: "Signup", user_id: 666)])- query = QueryBuilder.build!(site, %ParsedQueryParams{input_date_range: :all})+ query = QueryBuilder.build!(site, input_date_range: :all)funnel_data = Stats.funnel(site, query, funnel_definition)@@ -260,7 +260,7 @@ defmodule Plausible.FunnelsTest dobuild(:event, name: "Signup", user_id: 666)])- query = QueryBuilder.build!(site, %ParsedQueryParams{input_date_range: :all})+ query = QueryBuilder.build!(site, input_date_range: :all)funnel_data = Stats.funnel(site, query, funnel.id)@@ -310,7 +310,7 @@ defmodule Plausible.FunnelsTest do[g1, g2, g3])- query = QueryBuilder.build!(site, %ParsedQueryParams{input_date_range: :all})+ query = QueryBuilder.build!(site, input_date_range: :all)funnel_data = Stats.funnel(site, query, funnel.id)diff --git a/test/plausible/google/api_test.exs b/test/plausible/google/api_test.exsindex 2a50f4c137..0b54d3f397 100644--- a/test/plausible/google/api_test.exs+++ b/test/plausible/google/api_test.exs@@ -3,7 +3,7 @@ defmodule Plausible.Google.APITest douse Plausible.Test.Support.HTTPMockeralias Plausible.Google- alias Plausible.Stats.{DateTimeRange, QueryBuilder, ParsedQueryParams}+ alias Plausible.Stats.{DateTimeRange, QueryBuilder}import ExUnit.CaptureLogimport Mox@@ -43,9 +43,9 @@ defmodule Plausible.Google.APITest do)query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}- })+ )assert {:error, "google_auth_error"} = Google.API.fetch_stats(site, query, {5, 0}, "")end@@ -63,9 +63,9 @@ defmodule Plausible.Google.APITest do)query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}- })+ )assert {:error, "some_error"} = Google.API.fetch_stats(site, query, {5, 0}, "")end@@ -83,9 +83,9 @@ defmodule Plausible.Google.APITest do)query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}- })+ )log =capture_log(fn ->@@ -111,9 +111,9 @@ defmodule Plausible.Google.APITest do)query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}- })+ )assert {:error, "invalid_grant"} = Google.API.fetch_stats(site, query, 5, "")end@@ -141,9 +141,9 @@ defmodule Plausible.Google.APITest domock_http_with("google_search_console.json")query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]}- })+ )assert {:ok,[@@ -174,10 +174,10 @@ defmodule Plausible.Google.APITest do)query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]},filters: [[:is, "event:page", ["/page"]]]- })+ )assert {:ok, []} = Google.API.fetch_stats(site, query, {5, 0}, "")end@@ -188,10 +188,10 @@ defmodule Plausible.Google.APITest doinsert(:goal, event_name: "Signup", site: site)query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,input_date_range: {:date_range, ~D[2022-01-01], ~D[2022-01-05]},filters: [[:is, "event:goal", ["Signup"]]]- })+ )assert {:error, :unsupported_filters} = Google.API.fetch_stats(site, query, 5, "")enddiff --git a/test/plausible/stats/comparisons_test.exs b/test/plausible/stats/comparisons_test.exsindex ac34637acb..4cb1a5bfd9 100644--- a/test/plausible/stats/comparisons_test.exs+++ b/test/plausible/stats/comparisons_test.exs@@ -9,12 +9,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-02 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2023-03-02],- include: %QueryInclude{compare: :previous_period}- })+ include: [compare: :previous_period]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -27,12 +27,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2023-03-01],- include: %QueryInclude{compare: :previous_period}- })+ include: [compare: :previous_period]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -45,12 +45,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-02 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2023-03-02],- include: %QueryInclude{compare: :previous_period, compare_match_day_of_week: true}- })+ include: [compare: :previous_period, compare_match_day_of_week: true]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -64,12 +64,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-02 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2023-03-02],- include: %QueryInclude{compare: :previous_period}- })+ include: [compare: :previous_period]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -83,12 +83,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2023-02-01],- include: %QueryInclude{compare: :previous_period}- })+ include: [compare: :previous_period]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -100,12 +100,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2023-02-01],- include: %QueryInclude{compare: :year_over_year}- })+ include: [compare: :year_over_year]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -119,12 +119,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2020-02-01],- include: %QueryInclude{compare: :year_over_year}- })+ include: [compare: :year_over_year]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -138,12 +138,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2023-02-01],- include: %QueryInclude{compare: :previous_period, compare_match_day_of_week: true}- })+ include: [compare: :previous_period, compare_match_day_of_week: true]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -155,12 +155,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :month,relative_date: ~D[2023-01-01],- include: %QueryInclude{compare: :previous_period, compare_match_day_of_week: true}- })+ include: [compare: :previous_period, compare_match_day_of_week: true]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -172,12 +172,12 @@ defmodule Plausible.Stats.ComparisonsTest dodescribe "year_over_year, exact dates behavior with leap years" dotest "start of the year matching", %{site: site} doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: {:last_n_days, 7},relative_date: ~D[2021-01-05],- include: %QueryInclude{compare: :year_over_year}- })+ include: [compare: :year_over_year]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -188,12 +188,12 @@ defmodule Plausible.Stats.ComparisonsTest dotest "leap day matching", %{site: site} doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: {:last_n_days, 7},relative_date: ~D[2021-03-04],- include: %QueryInclude{compare: :year_over_year}- })+ include: [compare: :year_over_year]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -205,12 +205,12 @@ defmodule Plausible.Stats.ComparisonsTest dotest "end of the year matching", %{site: site} doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: {:last_n_days, 7},relative_date: ~D[2021-11-25],- include: %QueryInclude{compare: :year_over_year}- })+ include: [compare: :year_over_year]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -225,12 +225,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :year,relative_date: ~D[2023-03-01],- include: %QueryInclude{compare: :previous_period}- })+ include: [compare: :previous_period]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -242,12 +242,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :year,relative_date: ~D[2023-03-01],- include: %QueryInclude{compare: :year_over_year}- })+ include: [compare: :year_over_year]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -259,12 +259,12 @@ defmodule Plausible.Stats.ComparisonsTest doPlausible.Stats.Query.Test.fix_now(~U[2023-03-01 14:00:00Z])query =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :year,relative_date: ~D[2023-03-01],- include: %QueryInclude{compare: :year_over_year, compare_match_day_of_week: true}- })+ include: [compare: :year_over_year, compare_match_day_of_week: true]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -276,12 +276,12 @@ defmodule Plausible.Stats.ComparisonsTest dodescribe "with period set to previous year" dotest "shifts back a whole year when mode is year_over_year", %{site: site} doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :year,relative_date: ~D[2022-03-02],- include: %QueryInclude{compare: :year_over_year}- })+ include: [compare: :year_over_year]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -291,12 +291,12 @@ defmodule Plausible.Stats.ComparisonsTest dotest "shifts back a whole year when mode is previous_period", %{site: site} doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :year,relative_date: ~D[2022-03-02],- include: %QueryInclude{compare: :previous_period}- })+ include: [compare: :previous_period]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -308,11 +308,11 @@ defmodule Plausible.Stats.ComparisonsTest dodescribe "with period set to custom" dotest "shifts back by the same number of days when mode is previous_period", %{site: site} doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: {:date_range, ~D[2023-01-01], ~D[2023-01-07]},- include: %QueryInclude{compare: :previous_period}- })+ include: [compare: :previous_period]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -322,11 +322,11 @@ defmodule Plausible.Stats.ComparisonsTest dotest "shifts back to last year when mode is year_over_year", %{site: site} doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: {:date_range, ~D[2023-01-01], ~D[2023-01-07]},- include: %QueryInclude{compare: :year_over_year}- })+ include: [compare: :year_over_year]+ )comparison_query = Comparisons.get_comparison_query(query)@@ -338,11 +338,11 @@ defmodule Plausible.Stats.ComparisonsTest dodescribe "with mode set to custom" dotest "sets first and last dates", %{site: site} doquery =- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: {:date_range, ~D[2023-01-01], ~D[2023-01-07]},- include: %QueryInclude{compare: {:date_range, ~D[2022-05-25], ~D[2022-05-30]}}- })+ include: [compare: {:date_range, ~D[2022-05-25], ~D[2022-05-30]}]+ )comparison_query = Comparisons.get_comparison_query(query)diff --git a/test/plausible/stats/query/api_query_parser_test.exs b/test/plausible/stats/query/api_query_parser_test.exsindex d26a221aba..218b6050cb 100644--- a/test/plausible/stats/query/api_query_parser_test.exs+++ b/test/plausible/stats/query/api_query_parser_test.exs@@ -1,9 +1,14 @@defmodule Plausible.Stats.ApiQueryParserTest douse Plausible.DataCaseimport Plausible.Stats.ApiQueryParser+ alias Plausible.Stats.QueryErrortest "parsing empty map fails" do- assert {:error, "#: Required properties site_id, metrics, date_range were not present."} =+ assert {:error,+ %QueryError{+ code: :failed_schema_validation,+ message: "#: Required properties site_id, metrics, date_range were not present."+ }} =parse(%{})end@@ -14,6 +19,11 @@ defmodule Plausible.Stats.ApiQueryParserTest do"date_range" => "all"}- assert {:error, "#/metrics/1: Invalid metric \"event:name\""} = parse(params)+ assert {:error,+ %QueryError{+ code: :failed_schema_validation,+ message: "#/metrics/1: Invalid metric \"event:name\""+ }} =+ parse(params)endenddiff --git a/test/plausible/stats/query/query_builder_test.exs b/test/plausible/stats/query/query_builder_test.exsindex eb6e864b97..5c28b7ef48 100644--- a/test/plausible/stats/query/query_builder_test.exs+++ b/test/plausible/stats/query/query_builder_test.exs@@ -1,6 +1,6 @@defmodule Plausible.Stats.QueryBuilderTest douse Plausible.DataCase- alias Plausible.Stats.{DateTimeRange, ParsedQueryParams, QueryBuilder, Query}+ alias Plausible.Stats.{DateTimeRange, ParsedQueryParams, QueryBuilder, Query, QueryError}@now DateTime.new!(~D[2021-05-05], ~T[12:30:00], "Etc/UTC")@date_range_realtime %DateTimeRange{@@ -124,7 +124,7 @@ defmodule Plausible.Stats.QueryBuilderTest dofilters: [[:has_done, [:is, "event:goal", ["Unknown"]]]]}- assert {:error, error} = QueryBuilder.build(site, params)+ assert {:error, %QueryError{message: error}} = QueryBuilder.build(site, params)assert error =="Invalid filters. The goal `Unknown` is not configured for this site. Find out how to configure goals here: https://plausible.io/docs/stats-api#filtering-by-goals"@@ -132,7 +132,7 @@ defmodule Plausible.Stats.QueryBuilderTest dofor operation <- [:matches, :matches_not, :matches_wildcard, :matches_wildcard_not] dotest "case_sensitive modifier is not valid for #{operation}", %{site: site} do- assert {:error, error} =+ assert {:error, %QueryError{message: error}} =QueryBuilder.build(site, %ParsedQueryParams{metrics: [:visitors],input_date_range: :all,@@ -150,7 +150,7 @@ defmodule Plausible.Stats.QueryBuilderTest dotest "prohibits case_sensitive modifier with pattern operator in a complex filter tree", %{site: site} do- assert {:error, error} =+ assert {:error, %QueryError{message: error}} =QueryBuilder.build(site, %ParsedQueryParams{metrics: [:visitors],input_date_range: :all,@@ -224,7 +224,7 @@ defmodule Plausible.Stats.QueryBuilderTest dodescribe "exit_rate metric" dotest "fails validation without visit:exit_page dimension", %{site: site} do- assert {:error, error} =+ assert {:error, %QueryError{message: error}} =QueryBuilder.build(site, %ParsedQueryParams{metrics: [:exit_rate],input_date_range: :all@@ -235,7 +235,7 @@ defmodule Plausible.Stats.QueryBuilderTest doendtest "fails validation with event only filters", %{site: site} do- assert {:error, error} =+ assert {:error, %QueryError{message: error}} =QueryBuilder.build(site, %ParsedQueryParams{metrics: [:exit_rate],dimensions: ["visit:exit_page"],@@ -247,7 +247,7 @@ defmodule Plausible.Stats.QueryBuilderTest doendtest "fails validation with event metrics", %{site: site} do- assert {:error, error} =+ assert {:error, %QueryError{message: error}} =QueryBuilder.build(site, %ParsedQueryParams{metrics: [:exit_rate, :pageviews],dimensions: ["visit:exit_page"],diff --git a/test/plausible/stats/query/query_parse_and_build_test.exs b/test/plausible/stats/query/query_parse_and_build_test.exsindex eea6fed64b..4a0c19ef8a 100644--- a/test/plausible/stats/query/query_parse_and_build_test.exs+++ b/test/plausible/stats/query/query_parse_and_build_test.exs@@ -2,7 +2,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest douse Plausible.DataCaseimport Plausible.AssertMatches- alias Plausible.Stats.{Query, DateTimeRange, Filters}+ alias Plausible.Stats.{Query, DateTimeRange, Filters, QueryError}@now DateTime.new!(~D[2021-05-05], ~T[12:30:00], "Etc/UTC")@date_range_day %DateTimeRange{@@ -87,7 +87,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => "all"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =~ "Invalid metric"end@@ -154,7 +154,11 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => "all"}- assert {:error, "#/metrics: Expected items to be unique but they were not."} =+ assert {:error,+ %QueryError{+ code: :failed_schema_validation,+ message: "#/metrics: Expected items to be unique but they were not."+ }} =Query.parse_and_build(site, params)end@@ -165,7 +169,11 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => "all"}- assert {:error, "#/metrics: Expected a minimum of 1 items but got 0."} =+ assert {:error,+ %QueryError{+ code: :failed_schema_validation,+ message: "#/metrics: Expected a minimum of 1 items but got 0."+ }} =Query.parse_and_build(site, params)endend@@ -215,7 +223,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="#/filters/0: Invalid filter [\"#{unquote(operation)}\", \"event:name\", \"foo\"]"@@ -233,7 +241,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="#/filters/0: Invalid filter [\"#{unquote(operation)}\", \"event:name\", [\"foo\"]]"@@ -264,7 +272,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == ~s(#/filters/0: Invalid filter #{inspect(unquote(too_short_filter))})end@@ -290,7 +298,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == ~s(#/filters/0: Invalid filter #{inspect(unquote(too_long_filter))})end@@ -306,7 +314,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/filters/0: Invalid filter [\"exists?\", \"event:name\", [\"foo\"]]"end@@ -408,7 +416,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/filters/0: Invalid filter [\"is\", \"event:device\", [\"foo\"]]"end@@ -423,7 +431,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/filters/0: Invalid filter [\"is\", \"visit:name\", [\"foo\"]]"end@@ -436,7 +444,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => "foobar"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/filters: Type mismatch. Expected Array but got String."end@@ -448,7 +456,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["is", "visit:os_version", [123]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Invalid filter '[\"is\", \"visit:os_version\", [123]]'."end@@ -508,7 +516,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["is", "visit:country", ["USA"]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid visit:country filter, visit:country needs to be a valid 2-letter country code."@@ -619,7 +627,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid filters. Behavioral filters (has_done, has_not_done) can only be used with event dimension filters."@@ -635,7 +643,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid filters. Behavioral filters (has_done, has_not_done) cannot be nested."@@ -650,7 +658,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [[unquote(operator), []]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/filters/0: Invalid filter [\"#{unquote(operator)}\", []]"endend@@ -687,7 +695,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["not", ["is", "event:hostname", ["a.plausible.io"]]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid filters. Dimension `event:hostname` can only be filtered at the top level."@@ -754,7 +762,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="#/filters/0: Invalid filter [\"#{unquote(operation)}\", \"event:hostname\", [\"a.plausible.io\"], %{\"case_sensitive\" => false}]"@@ -937,7 +945,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"include" => "foobar"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/include: Type mismatch. Expected Object but got String."end@@ -949,7 +957,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"include" => %{"time_labels" => true}}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Invalid include.time_labels: requires a time dimension."endend@@ -986,7 +994,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"pagination" => %{"limit" => 100_000}}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/pagination/limit: Expected the value to be <= 10000"end@@ -998,7 +1006,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"pagination" => %{"offset" => -5}}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/pagination/offset: Expected the value to be >= 0"endend@@ -1052,7 +1060,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid filters. The goal `Signup` is not configured for this site. Find out how to configure goals here: https://plausible.io/docs/stats-api#filtering-by-goals"@@ -1068,7 +1076,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid filters. The goal `Visit /thank-you` is not configured for this site. Find out how to configure goals here: https://plausible.io/docs/stats-api#filtering-by-goals"@@ -1084,7 +1092,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/filters/0: Invalid filter [\"is_not\", \"event:goal\", [\"Signup\"]]"end@@ -1105,7 +1113,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid filters. Dimension `event:goal` can only be filtered at the top level."@@ -1173,7 +1181,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => unquote(shortcut)}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =~ "Invalid date range"endend@@ -1338,7 +1346,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"metrics" => ["visitors"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/date_range: Invalid date range #{inspect(unquote(invalid_value))}"end@@ -1351,7 +1359,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"metrics" => ["visitors"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Invalid date_range \"999999999mo\""end@@ -1365,7 +1373,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"metrics" => ["visitors"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Invalid date_range '[\"2021-02-03T00:00:00\", \"2021-02-03T23:59:59\"]'."end@@ -1377,7 +1385,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"metrics" => ["visitors"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="#/date_range: Invalid date range [\"2021-02-03T00:00:00-25:00\", \"2021-02-03T23:59:59-25:00\"]"@@ -1390,7 +1398,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"metrics" => ["visitors"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="#/date_range: Invalid date range [\"2021-02-03T00:00:00Z\", \"2021-02-04\"]"@@ -1542,7 +1550,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["time:minute"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/dimensions/0: Invalid dimension \"time:minute\""end@@ -1576,7 +1584,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["event:props:"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/dimensions/0: Invalid dimension \"event:props:\""end@@ -1588,7 +1596,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["visitors"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/dimensions/0: Invalid dimension \"visitors\""end@@ -1600,7 +1608,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => "foobar"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/dimensions: Type mismatch. Expected Array but got String."end@@ -1612,7 +1620,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["event:name", "event:name"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/dimensions: Expected items to be unique but they were not."endend@@ -1671,7 +1679,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"order_by" => [["visssss", "desc"]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "#/order_by/0/0: Invalid value in order_by \"visssss\""end@@ -1683,7 +1691,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"order_by" => [["events", "desc"]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid order_by entry '{:events, :desc}'. Entry is not a queried metric or dimension."@@ -1697,7 +1705,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"order_by" => [["event:name", "desc"]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid order_by entry '{\"event:name\", :desc}'. Entry is not a queried metric or dimension."@@ -1715,7 +1723,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["not", ["is", "event:props:foobar", ["foo"]]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="The owner of this site does not have access to the custom properties feature."@@ -1731,7 +1739,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["event:props:foobar"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="The owner of this site does not have access to the custom properties feature."@@ -1746,7 +1754,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => "all"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Metric `conversion_rate` can only be queried with event:goal filters or dimensions."@@ -1852,7 +1860,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["event:goal"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid filters. When `conversion_rate` or `group_conversion_rate` metrics are used, custom property filters can only be used on top level."@@ -1867,7 +1875,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => "all"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Metric `scroll_depth` can only be queried with event:page filters or dimensions."@@ -1881,7 +1889,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["not", ["is", "event:page", ["/"]]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Metric `scroll_depth` can only be queried with event:page filters or dimensions."@@ -1970,7 +1978,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["is", "event:page", ["/"]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Metric `views_per_visit` cannot be queried with a filter on `event:page`."end@@ -1982,7 +1990,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["event:name"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Metric `views_per_visit` cannot be queried with `dimensions`."endend@@ -1995,7 +2003,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => "all"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Metric `time_on_page` can only be queried with event:page filters or dimensions."@@ -2055,7 +2063,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Metric `time_on_page` can only be queried with event:page filters or dimensions."@@ -2112,7 +2120,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => "all"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="The owner of this site does not have access to the revenue metrics feature."@@ -2350,7 +2358,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"date_range" => "all"}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="#/metrics/0: Invalid metric \"total_revenue\"\n#/metrics/1: Invalid metric \"average_revenue\""@@ -2387,7 +2395,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["event:props:foo"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Session metric(s) `bounce_rate` cannot be queried along with event dimension(s) `event:props:foo`"@@ -2401,7 +2409,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"dimensions" => ["visit:exit_page"]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Event metric(s) `events` cannot be queried along with session dimension(s) `visit:exit_page`"@@ -2474,7 +2482,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Invalid filters. You can only use up to 10 segment filters in a query."end@@ -2500,7 +2508,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["is", "segment", [segment.id]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Invalid filters. Some segments don't exist or aren't accessible."end@@ -2528,7 +2536,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["is", "segment", [segment.id]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="The owner of this site does not have access to the custom properties feature."@@ -2565,7 +2573,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["is", "segment", [segment.id]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error =="Invalid filters. Dimension `event:goal` can only be filtered at the top level."@@ -2701,7 +2709,7 @@ defmodule Plausible.Stats.Query.QueryParseAndBuildTest do"filters" => [["is", "segment", ["123"]]]}- assert {:error, error} = Query.parse_and_build(site, params)+ assert {:error, %QueryError{message: error}} = Query.parse_and_build(site, params)assert error == "Invalid filter '[\"is\", \"segment\", [\"123\"]]'."endenddiff --git a/test/plausible/stats/table_decider_test.exs b/test/plausible/stats/table_decider_test.exsindex 03c446d91f..5ca5055c00 100644--- a/test/plausible/stats/table_decider_test.exs+++ b/test/plausible/stats/table_decider_test.exs@@ -1,6 +1,6 @@defmodule Plausible.Stats.TableDeciderTest douse Plausible.DataCase, async: true- alias Plausible.Stats.{Query, QueryBuilder, ParsedQueryParams}+ alias Plausible.Stats.{Query, QueryBuilder, QueryError}import Plausible.Stats.TableDecider@@ -197,20 +197,32 @@ defmodule Plausible.Stats.TableDeciderTest do{[:scroll_depth], ["visit:device"], :ok},{[:bounce_rate, :scroll_depth], ["event:name"],{:error,- "Session metric(s) `bounce_rate` cannot be queried along with event dimension(s) `event:name`"}},+ %QueryError{+ code: :invalid_metrics,+ message:+ "Session metric(s) `bounce_rate` cannot be queried along with event dimension(s) `event:name`"+ }}},{[:visit_duration], ["event:props:foo"],{:error,- "Session metric(s) `visit_duration` cannot be queried along with event dimension(s) `event:props:foo`"}},+ %QueryError{+ code: :invalid_metrics,+ message:+ "Session metric(s) `visit_duration` cannot be queried along with event dimension(s) `event:props:foo`"+ }}},{[:bounce_rate, :scroll_depth], ["visit:exit_page"],{:error,- "Event metric(s) `scroll_depth` cannot be queried along with session dimension(s) `visit:exit_page`"}},+ %QueryError{+ code: :invalid_metrics,+ message:+ "Event metric(s) `scroll_depth` cannot be queried along with session dimension(s) `visit:exit_page`"+ }}},{[:bounce_rate, :scroll_depth], ["event:page"], :ok}] dotest "metrics #{inspect(metrics)} and dimensions #{inspect(dimensions)}" doquery =make_query() |> Query.set(metrics: unquote(metrics), dimensions: unquote(dimensions))- assert validate_no_metrics_dimensions_conflict(query) == unquote(expected)+ assert validate_no_metrics_dimensions_conflict(query) == unquote(Macro.escape(expected))endendend@@ -218,23 +230,23 @@ defmodule Plausible.Stats.TableDeciderTest dodefp make_query(filter_dimensions \\ [], dimensions \\ []) dosite = build(:site, id: :rand.uniform(100_000))- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :all,filters:Enum.map(filter_dimensions, fn filter_dimension -> [:is, filter_dimension, []] end),dimensions: dimensions- })+ )enddefp make_query_full_filters(filters) dosite = build(:site, id: :rand.uniform(100_000))- QueryBuilder.build!(site, %ParsedQueryParams{+ QueryBuilder.build!(site,metrics: [:visitors],input_date_range: :all,dimensions: [],filters: filters- })+ )endend