File size: 9,087 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 | defmodule Plausible.Stats.Dashboard.QueryParserTest do
use Plausible.DataCase
import Plausible.Stats.Dashboard.QueryParser
alias Plausible.Stats.{ParsedQueryParams, QueryError}
@base_params %{
"date_range" => "28d",
"relative_date" => nil,
"filters" => [],
"dimensions" => [],
"metrics" => ["visitors"],
"include" => %{
"imports" => true,
"imports_meta" => false,
"compare" => nil,
"compare_match_day_of_week" => true
}
}
describe "input_date_range" do
test "is required" do
params = Map.drop(@base_params, ["date_range"])
assert {:error, %QueryError{code: :invalid_date_range}} = parse(params)
end
for period <- [:realtime, :day, :month, :year, :all] do
test "parses #{period} date_range" do
params = Map.merge(@base_params, %{"date_range" => Atom.to_string(unquote(period))})
{:ok, parsed} = parse(params)
assert_matches %ParsedQueryParams{input_date_range: ^unquote(period)} = parsed
end
end
for i <- [7, 28, 30, 91] do
test "parses #{i}d date_range" do
params = Map.merge(@base_params, %{"date_range" => "#{unquote(i)}d"})
{:ok, parsed} = parse(params)
assert_matches %ParsedQueryParams{
input_date_range: {:last_n_days, ^unquote(i)}
} = parsed
end
end
test "parses 24h period" do
params = Map.merge(@base_params, %{"date_range" => "24h"})
{:ok, parsed} = parse(params)
assert_matches %ParsedQueryParams{input_date_range: :"24h"} = parsed
end
for i <- [6, 12] do
test "parses #{i}mo date_range" do
params = Map.merge(@base_params, %{"date_range" => "#{unquote(i)}mo"})
{:ok, parsed} = parse(params)
assert_matches %ParsedQueryParams{
input_date_range: {:last_n_months, ^unquote(i)}
} =
parsed
end
end
test "parses custom date_range" do
params = Map.merge(@base_params, %{"date_range" => ["2021-01-01", "2021-03-05"]})
{:ok, parsed} = parse(params)
assert %ParsedQueryParams{
input_date_range: {:date_range, ~D[2021-01-01], ~D[2021-03-05]}
} = parsed
end
end
describe "relative_date" do
test "parses a valid iso8601 date string" do
params = Map.merge(@base_params, %{"relative_date" => "2021-05-05"})
{:ok, parsed} = parse(params)
assert %ParsedQueryParams{relative_date: ~D[2021-05-05]} = parsed
end
test "nil is accepted" do
params = Map.merge(@base_params, %{"relative_date" => nil})
{:ok, parsed} = parse(params)
assert %ParsedQueryParams{relative_date: nil} = parsed
end
test "errors when invalid date" do
params = Map.merge(@base_params, %{"relative_date" => "2021-13-32"})
{:error, %QueryError{code: :invalid_relative_date}} = parse(params)
end
end
describe "include.imports" do
test "true -> true" do
params = %{@base_params | "include" => %{@base_params["include"] | "imports" => true}}
{:ok, parsed} = parse(params)
assert parsed.include.imports == true
end
test "invalid -> false" do
params = %{@base_params | "include" => %{@base_params["include"] | "imports" => "foo"}}
{:ok, parsed} = parse(params)
assert parsed.include.imports == false
end
test "false -> false" do
params = %{@base_params | "include" => %{@base_params["include"] | "imports" => false}}
{:ok, parsed} = parse(params)
assert parsed.include.imports == false
end
end
describe "include.compare" do
for mode <- [:previous_period, :year_over_year] do
test "parses #{mode} mode" do
params = %{
@base_params
| "include" => %{@base_params["include"] | "compare" => "#{unquote(mode)}"}
}
{:ok, parsed} = parse(params)
assert parsed.include.compare == unquote(mode)
end
end
test "parses custom date range mode" do
params = %{
@base_params
| "include" => %{@base_params["include"] | "compare" => ["2021-01-01", "2021-04-30"]}
}
{:ok, parsed} = parse(params)
assert parsed.include.compare == {:date_range, ~D[2021-01-01], ~D[2021-04-30]}
end
test "fails with invalid custom dates" do
params = %{
@base_params
| "include" => %{@base_params["include"] | "compare" => ["2021-13-01", "2021-04-30"]}
}
assert {:error, %QueryError{code: :invalid_include}} = parse(params)
end
test "fails with random invalid compare value" do
params = %{
@base_params
| "include" => %{@base_params["include"] | "compare" => "foo"}
}
assert {:error, %QueryError{code: :invalid_include}} = parse(params)
end
test "compare is nil if not provided" do
params = %{
@base_params
| "include" => Map.drop(@base_params["include"], ["compare"])
}
{:ok, parsed} = parse(params)
assert parsed.include.compare == nil
end
end
describe "include.compare_match_day_of_week" do
test "true -> true" do
params = %{
@base_params
| "include" => %{@base_params["include"] | "compare_match_day_of_week" => true}
}
{:ok, parsed} = parse(params)
assert parsed.include.compare_match_day_of_week == true
end
test "invalid -> false" do
params = %{
@base_params
| "include" => %{@base_params["include"] | "compare_match_day_of_week" => "foo"}
}
{:ok, parsed} = parse(params)
assert parsed.include.compare_match_day_of_week == false
end
test "false -> false" do
params = %{
@base_params
| "include" => %{@base_params["include"] | "compare_match_day_of_week" => false}
}
{:ok, parsed} = parse(params)
assert parsed.include.compare_match_day_of_week == false
end
end
describe "dimensions" do
test "parses breakdown-only dimensions" do
params = Map.merge(@base_params, %{"dimensions" => ["event:prop_key"]})
{:ok, parsed} = parse(params)
assert parsed.dimensions == ["event:prop_key"]
end
end
describe "order_by" do
test "breakdown-only dimensions can be used in order_by" do
params =
Map.merge(@base_params, %{
"dimensions" => ["event:prop_key"],
"order_by" => [["event:prop_key", "asc"]]
})
{:ok, parsed} = parse(params)
assert parsed.order_by == [{"event:prop_key", :asc}]
end
end
describe "filters" do
test "parses valid filters" do
params =
Map.merge(@base_params, %{
"filters" => [
["has_not_done", ["is", "event:goal", ["Signup"]]],
["contains", "visit:exit_page", ["/:dashboard"]],
["is", "visit:source", ["Bing"]],
["is_not", "event:props:theme", ["system", "(none)"]]
]
})
{:ok, parsed} = parse(params)
assert parsed.filters == [
[:has_not_done, [:is, "event:goal", ["Signup"]]],
[:contains, "visit:exit_page", ["/:dashboard"]],
[:is, "visit:source", ["Bing"]],
[:is_not, "event:props:theme", ["system", "(none)"]]
]
end
test "cannot filter by breakdown-only dimensions" do
params =
Map.merge(@base_params, %{
"filters" => [["is", "event:prop_key", ["author"]]]
})
{:error, %QueryError{code: :invalid_filters}} = parse(params)
end
test "parses city filter with multiple clauses" do
params =
Map.merge(@base_params, %{
"filters" => [["is", "visit:city", ["2988507", "2950159"]]]
})
{:ok, parsed} = parse(params)
assert parsed.filters == [[:is, "visit:city", ["2988507", "2950159"]]]
end
test "parses a segment filter" do
params =
Map.merge(@base_params, %{
"filters" => [["is", "segment", [123]]]
})
{:ok, parsed} = parse(params)
assert parsed.filters == [[:is, "segment", [123]]]
end
end
describe "metrics" do
test "valid metrics" do
params = Map.merge(@base_params, %{"metrics" => ["visitors", "group_conversion_rate"]})
assert {:ok, parsed} = parse(params)
assert parsed.metrics == [:visitors, :group_conversion_rate]
end
test "at least one metric required" do
params = Map.merge(@base_params, %{"metrics" => []})
assert {:error, %QueryError{code: :invalid_metrics}} = parse(params)
end
end
describe "fixing now" do
test "now can't be fixed externally via params" do
params = Map.merge(@base_params, %{"now" => "2026-02-17T10:08:52.272894Z"})
{:ok, parsed} = parse(params)
assert parsed.now == nil
end
test "now can be fixed as an optional extra argument to parse/2" do
{:ok, parsed} = parse(@base_params, now: ~U[2026-02-17 10:08:00Z])
assert parsed.now == ~U[2026-02-17 10:08:00Z]
end
end
end
|