File size: 11,105 Bytes
c9c49ab | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | defmodule Plausible.Stats.QueryBuilderTest do
use Plausible.DataCase
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{
first: DateTime.new!(~D[2021-05-05], ~T[12:25:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-05], ~T[12:30:05], "Etc/UTC")
}
@date_range_30m %DateTimeRange{
first: DateTime.new!(~D[2021-05-05], ~T[12:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-05], ~T[12:30:05], "Etc/UTC")
}
@date_range_24h %DateTimeRange{
first: DateTime.new!(~D[2021-05-04], ~T[12:30:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-05], ~T[12:30:00], "Etc/UTC")
}
@date_range_day %DateTimeRange{
first: DateTime.new!(~D[2021-05-05], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-05], ~T[23:59:59], "Etc/UTC")
}
@date_range_7d %DateTimeRange{
first: DateTime.new!(~D[2021-04-28], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-04], ~T[23:59:59], "Etc/UTC")
}
@date_range_10d %DateTimeRange{
first: DateTime.new!(~D[2021-04-25], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-04], ~T[23:59:59], "Etc/UTC")
}
@date_range_30d %DateTimeRange{
first: DateTime.new!(~D[2021-04-05], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-04], ~T[23:59:59], "Etc/UTC")
}
@date_range_month %DateTimeRange{
first: DateTime.new!(~D[2021-05-01], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-05-31], ~T[23:59:59], "Etc/UTC")
}
@date_range_3mo %DateTimeRange{
first: DateTime.new!(~D[2021-02-01], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-04-30], ~T[23:59:59], "Etc/UTC")
}
@date_range_6mo %DateTimeRange{
first: DateTime.new!(~D[2020-11-01], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-04-30], ~T[23:59:59], "Etc/UTC")
}
@date_range_year %DateTimeRange{
first: DateTime.new!(~D[2021-01-01], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-12-31], ~T[23:59:59], "Etc/UTC")
}
@date_range_12mo %DateTimeRange{
first: DateTime.new!(~D[2020-05-01], ~T[00:00:00], "Etc/UTC"),
last: DateTime.new!(~D[2021-04-30], ~T[23:59:59], "Etc/UTC")
}
setup [:create_user, :create_site]
describe "filter validation" do
for operation <- [
:is,
:is_not,
:matches_wildcard,
:matches_wildcard_not,
:matches,
:matches_not,
:contains,
:contains_not
] do
test "valid simple #{operation} filter passes validation", %{site: site} do
params = %ParsedQueryParams{
metrics: [:visitors],
input_date_range: :all,
filters: [[unquote(operation), "event:name", ["foo"]]]
}
assert {:ok, query} = QueryBuilder.build(site, params)
assert_matches %Query{filters: [[^unquote(operation), "event:name", ["foo"]]]} = query
end
test "valid complex nested #{operation} filter passes validation", %{site: site} do
params = %ParsedQueryParams{
metrics: [:visitors],
input_date_range: :all,
filters: [
[
:not,
[
:and,
[
[unquote(operation), "event:name", ["foo"]],
[unquote(operation), "event:name", ["bar"]]
]
]
]
]
}
assert {:ok, query} = QueryBuilder.build(site, params)
assert_matches %Query{
filters: [
[
:not,
[
:and,
[
[unquote(operation), "event:name", ["foo"]],
[unquote(operation), "event:name", ["bar"]]
]
]
]
]
} = query
end
end
test "event goal name is checked within behavioral filters", %{site: site} do
insert(:goal, %{site: site, event_name: "Signup"})
params = %ParsedQueryParams{
metrics: [:visitors],
input_date_range: :all,
filters: [[:has_done, [:is, "event:goal", ["Unknown"]]]]
}
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"
end
for operation <- [:matches, :matches_not, :matches_wildcard, :matches_wildcard_not] do
test "case_sensitive modifier is not valid for #{operation}", %{site: site} do
assert {:error, %QueryError{message: error}} =
QueryBuilder.build(site, %ParsedQueryParams{
metrics: [:visitors],
input_date_range: :all,
filters: [
[unquote(operation), "event:page", ["a"], %{case_insensitive: true}]
]
})
assert error =~ "Invalid filters."
assert error =~ "case_sensitive modifier is not allowed with pattern operators"
assert error =~ Atom.to_string(unquote(operation))
end
end
test "prohibits case_sensitive modifier with pattern operator in a complex filter tree", %{
site: site
} do
assert {:error, %QueryError{message: error}} =
QueryBuilder.build(site, %ParsedQueryParams{
metrics: [:visitors],
input_date_range: :all,
filters: [
[
:or,
[
[
:and,
[
[:is, "visit:city_name", ["London"]],
[:not, [:is, "visit:country_name", ["Canada"]]]
]
],
[:matches, "event:page", ["a"], %{case_insensitive: true}]
]
]
]
})
assert error =~ "Invalid filters."
assert error =~ "case_sensitive modifier is not allowed with pattern operators"
assert error =~ ":matches"
end
end
describe "date range" do
for {input_date_range, expected_utc_time_range} <- [
{:realtime, @date_range_realtime},
{:realtime_30m, @date_range_30m},
{:"24h", @date_range_24h}
] do
test "builds utc_time_range for #{input_date_range} input_date_range", %{site: site} do
assert {:ok, query} =
QueryBuilder.build(site, %ParsedQueryParams{
now: @now,
metrics: [:visitors],
input_date_range: unquote(input_date_range)
})
assert query.utc_time_range == unquote(Macro.escape(expected_utc_time_range))
end
end
test "utc_time_range construction respects relative_date", %{site: site} do
relative_date = @now |> DateTime.to_date()
# Replace the fixed now. Otherwise this test could pass ignoring relative_date
now = DateTime.utc_now(:second)
for {date_range_shortcut, expected_utc_time_range} <- [
{:day, @date_range_day},
{{:last_n_days, 7}, @date_range_7d},
{{:last_n_days, 10}, @date_range_10d},
{{:last_n_days, 30}, @date_range_30d},
{:month, @date_range_month},
{{:last_n_months, 3}, @date_range_3mo},
{{:last_n_months, 6}, @date_range_6mo},
{{:last_n_months, 12}, @date_range_12mo},
{:year, @date_range_year}
] do
assert {:ok, query} =
QueryBuilder.build(site, %ParsedQueryParams{
now: now,
metrics: [:visitors],
relative_date: relative_date,
input_date_range: date_range_shortcut
})
assert query.utc_time_range == expected_utc_time_range
end
end
end
describe "exit_rate metric" do
test "fails validation without visit:exit_page dimension", %{site: site} do
assert {:error, %QueryError{message: error}} =
QueryBuilder.build(site, %ParsedQueryParams{
metrics: [:exit_rate],
input_date_range: :all
})
assert error ==
"Metric `exit_rate` requires a `\"visit:exit_page\"` dimension. No other dimensions are allowed."
end
test "fails validation with event only filters", %{site: site} do
assert {:error, %QueryError{message: error}} =
QueryBuilder.build(site, %ParsedQueryParams{
metrics: [:exit_rate],
dimensions: ["visit:exit_page"],
filters: [[:is, "event:page", ["/"]]],
input_date_range: :all
})
assert error == "Metric `exit_rate` cannot be queried when filtering on event dimensions."
end
test "fails validation with event metrics", %{site: site} do
assert {:error, %QueryError{message: error}} =
QueryBuilder.build(site, %ParsedQueryParams{
metrics: [:exit_rate, :pageviews],
dimensions: ["visit:exit_page"],
input_date_range: :all
})
assert error ==
"Event metric(s) `pageviews` cannot be queried along with session dimension(s) `visit:exit_page`"
end
test "passes validation", %{site: site} do
assert {:ok, query} =
QueryBuilder.build(site, %ParsedQueryParams{
metrics: [:exit_rate],
dimensions: ["visit:exit_page"],
input_date_range: :all
})
assert_matches %Query{
metrics: [:exit_rate],
dimensions: ["visit:exit_page"]
} = query
end
end
on_ee do
describe "query.consolidated_site_ids" do
test "is set to nil when site is regular", %{site: site} do
assert {:ok, %Query{consolidated_site_ids: nil}} =
QueryBuilder.build(site, %ParsedQueryParams{
metrics: [:visitors],
input_date_range: :all
})
end
test "is set to a list of site_ids when site is consolidated", %{site: site} do
new_site(team: site.team)
cv = new_consolidated_view(site.team)
assert {:ok, %Query{consolidated_site_ids: consolidated_site_ids}} =
QueryBuilder.build(cv, %ParsedQueryParams{
metrics: [:visitors],
input_date_range: :all
})
assert length(consolidated_site_ids) == 2
assert site.id in consolidated_site_ids
end
end
end
end
|