File size: 13,528 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 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 | defmodule Plausible.Stats.Query.QueryOptimizerTest do
use Plausible.DataCase, async: true
alias Plausible.Stats.{Query, QueryOptimizer, DateTimeRange, ApiQueryParser}
@default_params %{metrics: [:visitors]}
def perform(params) do
params = Map.merge(@default_params, params) |> Map.to_list()
struct!(Query, params) |> QueryOptimizer.optimize()
end
describe "add_missing_order_by" do
test "does nothing if order_by passed" do
assert perform(%{order_by: [visitors: :desc]}).order_by == [{:visitors, :desc}]
end
test "adds first metric to order_by if order_by not specified" do
assert perform(%{metrics: [:pageviews, :visitors]}).order_by == [{:pageviews, :desc}]
assert perform(%{metrics: [:pageviews, :visitors], dimensions: ["event:page"]}).order_by ==
[{:pageviews, :desc}]
end
test "adds time and first metric to order_by if order_by not specified" do
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-31], "UTC"),
metrics: [:pageviews, :visitors],
dimensions: ["time", "event:page"]
}).order_by ==
[{"time:day", :asc}, {:pageviews, :desc}]
end
end
describe "update_group_by_time" do
test "does nothing if `time` dimension not passed" do
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-04], "UTC"),
dimensions: ["time:month"]
}).dimensions == ["time:month"]
end
test "updating time dimension" do
assert perform(%{
utc_time_range:
DateTimeRange.new!(
DateTime.new!(~D[2022-01-01], ~T[00:00:00], "UTC"),
DateTime.new!(~D[2022-01-01], ~T[05:00:00], "UTC")
),
dimensions: ["time"]
}).dimensions == ["time:hour"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-01], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:hour"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-02], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:hour"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-03], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:day"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-10], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:day"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-01-16], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:day"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-02-16], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:week"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-03-16], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:week"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2022-03-16], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:week"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2023-11-16], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:month"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2024-01-16], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:month"]
assert perform(%{
utc_time_range: DateTimeRange.new!(~D[2022-01-01], ~D[2026-01-01], "UTC"),
dimensions: ["time"]
}).dimensions == ["time:month"]
end
end
describe "update_time_in_order_by" do
test "updates explicit time dimension in order_by" do
assert perform(%{
utc_time_range:
DateTimeRange.new!(
DateTime.new!(~D[2022-01-01], ~T[00:00:00], "UTC"),
DateTime.new!(~D[2022-01-01], ~T[05:00:00], "UTC")
),
dimensions: ["time:hour"],
order_by: [{"time", :asc}]
}).order_by == [{"time:hour", :asc}]
end
end
describe "extend_hostname_filters_to_visit" do
test "updates filters it filtering by event:hostname and visit:referrer and visit:exit_page dimensions" do
assert perform(%{
utc_time_range: Date.range(~N[2022-01-01 00:00:00], ~N[2022-01-01 05:00:00]),
filters: [
[:is, "event:hostname", ["example.com"]],
[:matches_wildcard, "event:hostname", ["*.com"]]
],
dimensions: ["visit:referrer", "visit:exit_page"]
}).filters == [
[:is, "event:hostname", ["example.com"]],
[:matches_wildcard, "event:hostname", ["*.com"]],
[:is, "visit:entry_page_hostname", ["example.com"]],
[:matches_wildcard, "visit:entry_page_hostname", ["*.com"]],
[:is, "visit:exit_page_hostname", ["example.com"]],
[:matches_wildcard, "visit:exit_page_hostname", ["*.com"]]
]
end
test "does not update filters if not needed" do
assert perform(%{
utc_time_range: Date.range(~N[2022-01-01 00:00:00], ~N[2022-01-01 05:00:00]),
filters: [
[:is, "event:hostname", ["example.com"]]
],
dimensions: ["time", "event:hostname"]
}).filters == [
[:is, "event:hostname", ["example.com"]]
]
end
end
describe "trim_relative_date_range" do
test "trims current month period when flag is set" do
now = DateTime.new!(~D[2024-01-15], ~T[12:00:00], "UTC")
result =
perform(%{
utc_time_range: DateTimeRange.new!(~D[2024-01-01], ~D[2024-01-31], "UTC"),
input_date_range: :month,
now: now,
timezone: "UTC",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, true)
})
assert result.utc_time_range.first == ~U[2024-01-01 00:00:00Z]
assert result.utc_time_range.last == ~U[2024-01-15 23:59:59Z]
end
test "trims current year period when flag is set" do
now = DateTime.new!(~D[2024-03-15], ~T[12:00:00], "UTC")
result =
perform(%{
utc_time_range: DateTimeRange.new!(~D[2024-01-01], ~D[2024-12-31], "UTC"),
input_date_range: :year,
now: now,
timezone: "UTC",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, true)
})
assert result.utc_time_range.first == ~U[2024-01-01 00:00:00Z]
assert result.utc_time_range.last == ~U[2024-03-15 23:59:59Z]
end
test "trims current day period to current hour when flag is set" do
now = DateTime.new!(~D[2024-01-15], ~T[14:30:00], "UTC")
result =
perform(%{
utc_time_range: DateTimeRange.new!(~D[2024-01-15], ~D[2024-01-15], "UTC"),
input_date_range: :day,
now: now,
timezone: "UTC",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, true)
})
assert result.utc_time_range.first == ~U[2024-01-15 00:00:00Z]
assert result.utc_time_range.last == ~U[2024-01-15 14:59:59Z]
end
test "does not trim historical month periods even when flag is set" do
now = DateTime.new!(~D[2024-01-15], ~T[12:00:00], "UTC")
original_range = DateTimeRange.new!(~D[2023-06-01], ~D[2023-06-30], "UTC")
result =
perform(%{
utc_time_range: original_range,
input_date_range: :month,
now: now,
timezone: "UTC",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, true)
})
assert result.utc_time_range == original_range
end
test "does not trim historical year periods even when flag is set" do
now = DateTime.new!(~D[2024-03-15], ~T[12:00:00], "UTC")
original_range = DateTimeRange.new!(~D[2023-01-01], ~D[2023-12-31], "UTC")
result =
perform(%{
utc_time_range: original_range,
input_date_range: :year,
now: now,
timezone: "UTC",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, true)
})
assert result.utc_time_range == original_range
end
test "does not trim historical day periods even when flag is set" do
now = DateTime.new!(~D[2024-01-15], ~T[14:30:00], "UTC")
original_range = DateTimeRange.new!(~D[2024-01-10], ~D[2024-01-10], "UTC")
result =
perform(%{
utc_time_range: original_range,
input_date_range: :day,
now: now,
timezone: "UTC",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, true)
})
assert result.utc_time_range == original_range
end
test "does not trim day when comparisons are set" do
now = DateTime.new!(~D[2024-01-15], ~T[12:00:00], "UTC")
original_range = DateTimeRange.new!(~D[2024-01-01], ~D[2024-01-31], "UTC")
result =
perform(%{
utc_time_range: original_range,
input_date_range: :day,
now: now,
timezone: "UTC",
include:
Map.merge(
ApiQueryParser.default_include(),
%{comparisons: %{mode: "previous_period"}, trim_relative_date_range: true}
)
})
assert result.utc_time_range == original_range
end
test "trims month when comparisons are set" do
now = DateTime.new!(~D[2024-01-15], ~T[12:00:00], "UTC")
result =
perform(%{
utc_time_range: DateTimeRange.new!(~D[2024-01-01], ~D[2024-01-31], "UTC"),
input_date_range: :month,
now: now,
timezone: "UTC",
include:
Map.merge(
ApiQueryParser.default_include(),
%{comparisons: %{mode: "previous_period"}, trim_relative_date_range: true}
)
})
assert result.utc_time_range.first == ~U[2024-01-01 00:00:00Z]
assert result.utc_time_range.last == ~U[2024-01-15 23:59:59Z]
end
test "does not trim when flag is false" do
now = DateTime.new!(~D[2024-01-15], ~T[12:00:00], "UTC")
original_range = DateTimeRange.new!(~D[2024-01-01], ~D[2024-01-31], "UTC")
result =
perform(%{
utc_time_range: original_range,
input_date_range: :month,
now: now,
timezone: "UTC",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, false)
})
assert result.utc_time_range == original_range
end
test "does not trim when flag is not set" do
now = DateTime.new!(~D[2024-01-15], ~T[12:00:00], "UTC")
original_range = DateTimeRange.new!(~D[2024-01-01], ~D[2024-01-31], "UTC")
result =
perform(%{
utc_time_range: original_range,
input_date_range: :month,
now: now,
timezone: "UTC",
include: ApiQueryParser.default_include()
})
assert result.utc_time_range == original_range
end
test "does not trim non-current periods like custom date ranges" do
now = DateTime.new!(~D[2024-01-15], ~T[12:00:00], "UTC")
original_range = DateTimeRange.new!(~D[2024-01-10], ~D[2024-01-16], "UTC")
result =
perform(%{
utc_time_range: original_range,
input_date_range: {:last_n_days, 7},
now: now,
timezone: "UTC",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, true)
})
assert result.utc_time_range == original_range
end
test "handles timezone correctly when trimming year periods" do
now = DateTime.new!(~D[2024-03-15], ~T[12:00:00], "UTC")
result =
perform(%{
utc_time_range:
DateTimeRange.new!(~D[2024-01-01], ~D[2024-12-31], "America/New_York")
|> DateTimeRange.to_timezone("Etc/UTC"),
input_date_range: :year,
now: now,
timezone: "America/New_York",
include: Map.put(ApiQueryParser.default_include(), :trim_relative_date_range, true)
})
nyc_mar_15_end =
DateTimeRange.new!(~D[2024-03-15], ~D[2024-03-15], "America/New_York")
|> DateTimeRange.to_timezone("Etc/UTC")
|> Map.get(:last)
assert result.utc_time_range.last == nyc_mar_15_end
end
end
describe "set_sql_join_type" do
test "updates sql_join_type to :full if time:minute or time:hour dimension is present" do
assert perform(%{dimensions: ["time:minute"]}).sql_join_type == :full
assert perform(%{dimensions: ["time:hour"]}).sql_join_type == :full
end
test "keeps default sql_join_type otherwise" do
assert perform(%{dimensions: ["time:day"]}).sql_join_type == :left
assert perform(%{dimensions: []}).sql_join_type == :left
end
end
end
|