Leon4gr45 commited on
Commit
bf35535
·
verified ·
1 Parent(s): 440b30e

Delete test/plausible_web/controllers/api/stats_controller/top_stats_test.exs with huggingface_hub

Browse files
test/plausible_web/controllers/api/stats_controller/top_stats_test.exs DELETED
@@ -1,1783 +0,0 @@
1
- defmodule PlausibleWeb.Api.StatsController.TopStatsTest do
2
- use PlausibleWeb.ConnCase
3
-
4
- @user_id Enum.random(1000..9999)
5
-
6
- defp do_query_success(conn, site, params) do
7
- conn
8
- |> post("/api/stats/#{site.domain}/query", params)
9
- |> json_response(200)
10
- end
11
-
12
- describe "default" do
13
- setup [:create_user, :log_in, :create_site]
14
-
15
- test "returns all top stats metrics", %{conn: conn, site: site} do
16
- populate_stats(site, [
17
- build(:pageview, user_id: 3421, timestamp: ~N[2020-12-31 23:30:00]),
18
- build(:pageview, user_id: @user_id, timestamp: ~N[2020-12-31 23:59:00]),
19
- build(:pageview, user_id: @user_id, timestamp: ~N[2021-01-01 00:01:00]),
20
- build(:pageview, user_id: 2, timestamp: ~N[2020-12-31 23:59:00]),
21
- build(:pageview, user_id: 2, timestamp: ~N[2021-01-01 00:01:00]),
22
- build(:pageview, user_id: 617_235, timestamp: ~N[2021-01-03 00:00:00])
23
- ])
24
-
25
- params = %{
26
- "date_range" => "day",
27
- "relative_date" => "2021-01-01",
28
- "filters" => [],
29
- "metrics" => [
30
- "visitors",
31
- "visits",
32
- "pageviews",
33
- "views_per_visit",
34
- "bounce_rate",
35
- "visit_duration"
36
- ]
37
- }
38
-
39
- response = do_query_success(conn, site, params)
40
-
41
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2, 2, 2, 2.0, 0, 120]}]
42
- end
43
-
44
- test "returns all page-filtered top stats metrics", %{conn: conn, site: site} do
45
- populate_stats(site, [
46
- build(:pageview,
47
- pathname: "/pageA",
48
- user_id: @user_id,
49
- timestamp: ~N[2021-01-01 00:00:00]
50
- ),
51
- build(:engagement,
52
- pathname: "/pageA",
53
- user_id: @user_id,
54
- timestamp: ~N[2021-01-01 00:15:00],
55
- engagement_time: 199_000
56
- ),
57
- build(:pageview,
58
- pathname: "/pageB",
59
- user_id: @user_id,
60
- timestamp: ~N[2021-01-01 00:15:00]
61
- ),
62
- build(:pageview,
63
- pathname: "/pageA",
64
- timestamp: ~N[2021-01-01 00:15:00]
65
- ),
66
- build(:engagement,
67
- pathname: "/pageA",
68
- user_id: @user_id,
69
- timestamp: ~N[2021-01-01 00:15:00],
70
- engagement_time: 1_000
71
- )
72
- ])
73
-
74
- params = %{
75
- "date_range" => "day",
76
- "relative_date" => "2021-01-01",
77
- "filters" => [["is", "event:page", ["/pageA"]]],
78
- "metrics" => [
79
- "visitors",
80
- "visits",
81
- "pageviews",
82
- "bounce_rate",
83
- "scroll_depth",
84
- "time_on_page"
85
- ]
86
- }
87
-
88
- response = do_query_success(conn, site, params)
89
-
90
- assert response["results"] == [
91
- %{"dimensions" => [], "metrics" => [2, 2, 2, 50, 0, 200]}
92
- ]
93
- end
94
-
95
- test "calculates time on page when filtered for multiple pages", %{
96
- conn: conn,
97
- site: site
98
- } do
99
- populate_stats(site, [
100
- build(:pageview,
101
- pathname: "/pageA",
102
- user_id: @user_id,
103
- timestamp: ~N[2021-01-01 00:00:00]
104
- ),
105
- build(:engagement,
106
- pathname: "/pageA",
107
- user_id: @user_id,
108
- timestamp: ~N[2021-01-01 00:15:00],
109
- engagement_time: 199_000
110
- ),
111
- build(:pageview,
112
- pathname: "/pageB",
113
- user_id: @user_id,
114
- timestamp: ~N[2021-01-01 00:15:00]
115
- ),
116
- build(:engagement,
117
- pathname: "/pageB",
118
- user_id: @user_id,
119
- timestamp: ~N[2021-01-01 00:15:00],
120
- engagement_time: 20_000
121
- ),
122
- build(:pageview,
123
- pathname: "/pageC",
124
- user_id: @user_id,
125
- timestamp: ~N[2021-01-01 00:16:00]
126
- ),
127
- build(:engagement,
128
- pathname: "/pageC",
129
- user_id: @user_id,
130
- timestamp: ~N[2021-01-01 00:16:00],
131
- engagement_time: 30_000
132
- ),
133
- build(:pageview,
134
- pathname: "/pageA",
135
- timestamp: ~N[2021-01-01 00:17:00]
136
- ),
137
- build(:engagement,
138
- pathname: "/pageA",
139
- user_id: @user_id,
140
- timestamp: ~N[2021-01-01 00:17:00],
141
- engagement_time: 1_000
142
- )
143
- ])
144
-
145
- params = %{
146
- "date_range" => "all",
147
- "filters" => [["is", "event:page", ["/pageA", "/pageB"]]],
148
- "metrics" => ["time_on_page"]
149
- }
150
-
151
- response = do_query_success(conn, site, params)
152
-
153
- assert response["results"] == [%{"dimensions" => [], "metrics" => [220]}]
154
- end
155
-
156
- test "calculates time on page when filtered for multiple negated pages", %{
157
- conn: conn,
158
- site: site
159
- } do
160
- populate_stats(site, [
161
- build(:pageview,
162
- pathname: "/pageA",
163
- user_id: @user_id,
164
- timestamp: ~N[2021-01-01 00:00:00]
165
- ),
166
- build(:engagement,
167
- pathname: "/pageA",
168
- user_id: @user_id,
169
- timestamp: ~N[2021-01-01 00:15:00],
170
- engagement_time: 199_000
171
- ),
172
- build(:pageview,
173
- pathname: "/pageB",
174
- user_id: @user_id,
175
- timestamp: ~N[2021-01-01 00:15:00]
176
- ),
177
- build(:engagement,
178
- pathname: "/pageB",
179
- user_id: @user_id,
180
- timestamp: ~N[2021-01-01 00:15:00],
181
- engagement_time: 20_000
182
- ),
183
- build(:pageview,
184
- pathname: "/pageC",
185
- user_id: @user_id,
186
- timestamp: ~N[2021-01-01 00:16:00]
187
- ),
188
- build(:engagement,
189
- pathname: "/pageC",
190
- user_id: @user_id,
191
- timestamp: ~N[2021-01-01 00:16:00],
192
- engagement_time: 30_000
193
- ),
194
- build(:pageview,
195
- pathname: "/pageA",
196
- timestamp: ~N[2021-01-01 00:17:00]
197
- ),
198
- build(:engagement,
199
- pathname: "/pageA",
200
- user_id: @user_id,
201
- timestamp: ~N[2021-01-01 00:17:00],
202
- engagement_time: 1_000
203
- )
204
- ])
205
-
206
- params = %{
207
- "date_range" => "all",
208
- "filters" => [["is_not", "event:page", ["/pageA", "/pageC"]]],
209
- "metrics" => ["time_on_page"]
210
- }
211
-
212
- response = do_query_success(conn, site, params)
213
-
214
- assert response["results"] == [%{"dimensions" => [], "metrics" => [20]}]
215
- end
216
-
217
- test "calculates time_on_page when filtered for multiple contains pages", %{
218
- conn: conn,
219
- site: site
220
- } do
221
- populate_stats(site, [
222
- build(:pageview,
223
- pathname: "/blog/post-1",
224
- user_id: @user_id,
225
- timestamp: ~N[2021-01-01 00:00:00]
226
- ),
227
- build(:engagement,
228
- pathname: "/blog/post-1",
229
- user_id: @user_id,
230
- timestamp: ~N[2021-01-01 00:15:00],
231
- engagement_time: 100_000
232
- ),
233
- build(:pageview,
234
- pathname: "/about",
235
- user_id: @user_id,
236
- timestamp: ~N[2021-01-01 00:15:00]
237
- ),
238
- build(:engagement,
239
- pathname: "/about",
240
- user_id: @user_id,
241
- timestamp: ~N[2021-01-01 00:16:00],
242
- engagement_time: 20_000
243
- ),
244
- build(:pageview,
245
- pathname: "/articles/post-1",
246
- user_id: 321,
247
- timestamp: ~N[2021-01-01 00:16:00]
248
- ),
249
- build(:engagement,
250
- pathname: "/articles/post-1",
251
- user_id: @user_id,
252
- timestamp: ~N[2021-01-01 00:17:00],
253
- engagement_time: 30_000
254
- ),
255
- build(:pageview,
256
- pathname: "/",
257
- user_id: 321,
258
- timestamp: ~N[2021-01-01 00:17:00]
259
- ),
260
- build(:engagement,
261
- pathname: "/",
262
- user_id: @user_id,
263
- timestamp: ~N[2021-01-01 00:17:30],
264
- engagement_time: 3_000
265
- )
266
- ])
267
-
268
- params = %{
269
- "date_range" => "all",
270
- "filters" => [["contains", "event:page", ["/blog/", "/articles/"]]],
271
- "metrics" => ["time_on_page"]
272
- }
273
-
274
- response = do_query_success(conn, site, params)
275
-
276
- assert response["results"] == [%{"dimensions" => [], "metrics" => [130]}]
277
- end
278
-
279
- test "calculates time on page when filtered for multiple negated contains pages", %{
280
- conn: conn,
281
- site: site
282
- } do
283
- populate_stats(site, [
284
- build(:pageview,
285
- pathname: "/blog/post-1",
286
- user_id: @user_id,
287
- timestamp: ~N[2021-01-01 00:00:00]
288
- ),
289
- build(:engagement,
290
- pathname: "/blog/post-1",
291
- user_id: @user_id,
292
- timestamp: ~N[2021-01-01 00:15:00],
293
- engagement_time: 100_000
294
- ),
295
- build(:pageview,
296
- pathname: "/about",
297
- user_id: @user_id,
298
- timestamp: ~N[2021-01-01 00:15:00]
299
- ),
300
- build(:engagement,
301
- pathname: "/about",
302
- user_id: @user_id,
303
- timestamp: ~N[2021-01-01 00:16:00],
304
- engagement_time: 20_000
305
- ),
306
- build(:pageview,
307
- pathname: "/articles/post-1",
308
- user_id: 321,
309
- timestamp: ~N[2021-01-01 00:16:00]
310
- ),
311
- build(:engagement,
312
- pathname: "/articles/post-1",
313
- user_id: @user_id,
314
- timestamp: ~N[2021-01-01 00:17:00],
315
- engagement_time: 30_000
316
- ),
317
- build(:pageview,
318
- pathname: "/",
319
- user_id: 321,
320
- timestamp: ~N[2021-01-01 00:17:00]
321
- ),
322
- build(:engagement,
323
- pathname: "/",
324
- user_id: @user_id,
325
- timestamp: ~N[2021-01-01 00:17:30],
326
- engagement_time: 3_000
327
- )
328
- ])
329
-
330
- params = %{
331
- "date_range" => "all",
332
- "filters" => [["contains_not", "event:page", ["/blog/", "/articles/"]]],
333
- "metrics" => ["time_on_page"]
334
- }
335
-
336
- response = do_query_success(conn, site, params)
337
-
338
- assert response["results"] == [%{"dimensions" => [], "metrics" => [23]}]
339
- end
340
-
341
- test "bounce_rate is 0 when the page in filter was never a landing page", %{
342
- conn: conn,
343
- site: site
344
- } do
345
- populate_stats(site, [
346
- build(:pageview, pathname: "/A", user_id: @user_id, timestamp: ~N[2021-01-01 00:00:00]),
347
- build(:pageview, pathname: "/", user_id: @user_id, timestamp: ~N[2021-01-01 00:10:00])
348
- ])
349
-
350
- params = %{
351
- "date_range" => "all",
352
- "filters" => [["is", "event:page", ["/"]]],
353
- "metrics" => ["bounce_rate"]
354
- }
355
-
356
- response = do_query_success(conn, site, params)
357
-
358
- assert response["results"] == [%{"dimensions" => [], "metrics" => [0]}]
359
- end
360
-
361
- test "time_on_page is nil when it can't be calculated", %{conn: conn, site: site} do
362
- populate_stats(site, [
363
- build(:pageview, pathname: "/")
364
- ])
365
-
366
- params = %{
367
- "date_range" => "all",
368
- "filters" => [["is", "event:page", ["/"]]],
369
- "metrics" => ["time_on_page"]
370
- }
371
-
372
- response = do_query_success(conn, site, params)
373
-
374
- assert response["results"] == [%{"dimensions" => [], "metrics" => [nil]}]
375
- end
376
-
377
- test "returns empty metrics when no data", %{conn: conn, site: site} do
378
- requested_metrics = [
379
- "visitors",
380
- "visits",
381
- "pageviews",
382
- "views_per_visit",
383
- "bounce_rate",
384
- "visit_duration"
385
- ]
386
-
387
- params = %{
388
- "date_range" => "all",
389
- "filters" => [],
390
- "metrics" => requested_metrics
391
- }
392
-
393
- response = do_query_success(conn, site, params)
394
-
395
- assert response["query"]["metrics"] == requested_metrics
396
- assert response["results"] == [%{"dimensions" => [], "metrics" => [0, 0, 0, 0.0, 0, 0]}]
397
- end
398
-
399
- test "returns information about imports with the imports_meta option", %{
400
- conn: conn,
401
- site: site
402
- } do
403
- params = %{
404
- "date_range" => "all",
405
- "filters" => [],
406
- "metrics" => ["visitors"],
407
- "include" => %{"imports" => false, "imports_meta" => true}
408
- }
409
-
410
- response = do_query_success(conn, site, params)
411
-
412
- assert response["meta"] == %{
413
- "imports_included" => false,
414
- "imports_skip_reason" => "no_imported_data"
415
- }
416
- end
417
-
418
- test "drops time on page if unavailable", %{conn: conn, site: site} do
419
- site_import =
420
- insert(:site_import, site: site, start_date: ~D[2021-01-01], end_date: ~D[2022-01-01])
421
-
422
- site = Plausible.Sites.update_legacy_time_on_page_cutoff!(site, ~D[2023-01-01])
423
-
424
- populate_stats(site, site_import.id, [
425
- build(:pageview, pathname: "/"),
426
- build(:imported_pages, page: "/", date: ~D[2021-01-01])
427
- ])
428
-
429
- params = %{
430
- "date_range" => "all",
431
- "filters" => [["is", "event:page", ["/"]]],
432
- "metrics" => ["visitors", "time_on_page"],
433
- "include" => %{"imports" => true}
434
- }
435
-
436
- response = do_query_success(conn, site, params)
437
-
438
- assert response["meta"]["imports_included"]
439
- assert response["query"]["metrics"] == ["visitors"]
440
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2]}]
441
- end
442
- end
443
-
444
- describe "imported data" do
445
- setup [
446
- :create_user,
447
- :log_in,
448
- :create_site,
449
- :create_legacy_site_import
450
- ]
451
-
452
- test "returns scroll depth warning", %{conn: conn, site: site} do
453
- params = %{
454
- "date_range" => "all",
455
- "filters" => [["is", "event:page", ["/"]]],
456
- "metrics" => ["visitors", "scroll_depth"],
457
- "include" => %{"imports" => true}
458
- }
459
-
460
- assert %{"results" => results, "meta" => meta} =
461
- do_query_success(conn, site, params)
462
-
463
- assert results == [%{"dimensions" => [], "metrics" => [0, nil]}]
464
- assert meta["metric_warnings"]["scroll_depth"]["code"] == "no_imported_scroll_depth"
465
- end
466
-
467
- test "returns divisible metrics as 0 when no stats exist", %{
468
- site: site,
469
- conn: conn
470
- } do
471
- params = %{
472
- "date_range" => "all",
473
- "filters" => [],
474
- "metrics" => ["bounce_rate", "views_per_visit", "visit_duration"],
475
- "include" => %{"imports" => true}
476
- }
477
-
478
- response = do_query_success(conn, site, params)
479
-
480
- assert response["results"] == [%{"dimensions" => [], "metrics" => [0, 0, 0]}]
481
- end
482
-
483
- test "merges imported data into all top stat metrics", %{
484
- conn: conn,
485
- site: site
486
- } do
487
- populate_stats(site, [
488
- build(:pageview,
489
- user_id: @user_id,
490
- timestamp: ~N[2021-01-01 00:00:00]
491
- ),
492
- build(:pageview,
493
- user_id: @user_id,
494
- timestamp: ~N[2021-01-01 00:15:00]
495
- ),
496
- build(:pageview,
497
- timestamp: ~N[2021-01-01 00:15:00]
498
- ),
499
- build(:imported_visitors, date: ~D[2021-01-01])
500
- ])
501
-
502
- params = %{
503
- "date_range" => "all",
504
- "filters" => [],
505
- "metrics" => [
506
- "visitors",
507
- "visits",
508
- "pageviews",
509
- "views_per_visit",
510
- "bounce_rate",
511
- "visit_duration"
512
- ],
513
- "include" => %{"imports" => true}
514
- }
515
-
516
- response = do_query_success(conn, site, params)
517
-
518
- assert response["results"] == [
519
- %{"dimensions" => [], "metrics" => [3, 3, 4, 1.33, 33, 303]}
520
- ]
521
- end
522
-
523
- test ":member filter on country", %{
524
- conn: conn,
525
- site: site
526
- } do
527
- populate_stats(site, [
528
- build(:pageview,
529
- country_code: "EE",
530
- user_id: @user_id,
531
- timestamp: ~N[2021-01-01 00:00:00]
532
- ),
533
- build(:pageview,
534
- country_code: "EE",
535
- user_id: @user_id,
536
- timestamp: ~N[2021-01-01 00:01:00]
537
- ),
538
- build(:imported_locations,
539
- country: "EE",
540
- date: ~D[2021-01-01],
541
- visitors: 1,
542
- visits: 3,
543
- pageviews: 34,
544
- bounces: 0,
545
- visit_duration: 420
546
- ),
547
- build(:imported_locations,
548
- country: "FR",
549
- date: ~D[2021-01-01],
550
- visitors: 3,
551
- visits: 7,
552
- pageviews: 65,
553
- bounces: 1,
554
- visit_duration: 300
555
- ),
556
- build(:imported_locations, country: "US", date: ~D[2021-01-01], visitors: 999)
557
- ])
558
-
559
- params = %{
560
- "date_range" => ["2021-01-01", "2021-01-01"],
561
- "filters" => [["is", "visit:country", ["EE", "FR"]]],
562
- "metrics" => [
563
- "visitors",
564
- "visits",
565
- "pageviews",
566
- "views_per_visit",
567
- "bounce_rate",
568
- "visit_duration"
569
- ],
570
- "include" => %{"imports" => true}
571
- }
572
-
573
- response = do_query_success(conn, site, params)
574
-
575
- assert response["results"] == [
576
- %{"dimensions" => [], "metrics" => [5, 11, 101, 9.18, 9, 71]}
577
- ]
578
- end
579
-
580
- test ":is filter on page returns visitors, visits, pageviews bounce_rate, time_on_page and scroll_depth",
581
- %{
582
- conn: conn,
583
- site: site
584
- } do
585
- site_import =
586
- insert(:site_import, site: site, start_date: ~D[2021-01-01], has_scroll_depth: true)
587
-
588
- populate_stats(site, site_import.id, [
589
- build(:pageview,
590
- pathname: "/",
591
- user_id: @user_id,
592
- timestamp: ~N[2021-01-01 00:00:00]
593
- ),
594
- build(:pageview,
595
- pathname: "/",
596
- user_id: @user_id,
597
- timestamp: ~N[2021-01-01 00:01:00]
598
- ),
599
- build(:imported_pages,
600
- page: "/",
601
- date: ~D[2021-01-01],
602
- total_time_on_page: 120,
603
- total_time_on_page_visits: 3,
604
- visitors: 1,
605
- visits: 3,
606
- pageviews: 34
607
- ),
608
- build(:imported_pages, page: "/ignored", date: ~D[2021-01-01], visitors: 999)
609
- ])
610
-
611
- params = %{
612
- "date_range" => ["2021-01-01", "2021-01-01"],
613
- "filters" => [["is", "event:page", ["/"]]],
614
- "metrics" => [
615
- "visitors",
616
- "visits",
617
- "pageviews",
618
- "bounce_rate",
619
- "time_on_page",
620
- "scroll_depth"
621
- ],
622
- "include" => %{"imports" => true}
623
- }
624
-
625
- response = do_query_success(conn, site, params)
626
-
627
- assert response["results"] == [
628
- %{"dimensions" => [], "metrics" => [2, 4, 36, 0, 40, nil]}
629
- ]
630
- end
631
- end
632
-
633
- describe "imports_meta" do
634
- setup [:create_user, :log_in, :create_site]
635
-
636
- setup context do
637
- insert(:site_import,
638
- site: context.site,
639
- start_date: ~D[2021-03-01],
640
- end_date: ~D[2021-03-31]
641
- )
642
-
643
- context
644
- end
645
-
646
- test "in realtime", %{conn: conn, site: site} do
647
- params = %{
648
- "date_range" => ["2021-01-01", "2021-01-01"],
649
- "filters" => [],
650
- "metrics" => ["visitors"],
651
- "include" => %{"imports_meta" => true}
652
- }
653
-
654
- assert %{"meta" => meta} = do_query_success(conn, site, params)
655
-
656
- assert meta["imports_skip_reason"] == "out_of_range"
657
- assert meta["imports_included"] == false
658
- end
659
-
660
- test "when the site has no imported data", %{conn: conn, site: site} do
661
- Plausible.Imported.delete_imports_for_site(site)
662
-
663
- params = %{
664
- "date_range" => ["2021-01-01", "2021-01-01"],
665
- "filters" => [],
666
- "metrics" => ["visitors"],
667
- "include" => %{"imports_meta" => true}
668
- }
669
-
670
- assert %{"meta" => meta} = do_query_success(conn, site, params)
671
-
672
- assert meta["imports_skip_reason"] == "no_imported_data"
673
- assert meta["imports_included"] == false
674
- end
675
-
676
- test "when imported data does not exist in the queried period", %{conn: conn, site: site} do
677
- params = %{
678
- "date_range" => ["2022-05-05", "2022-05-05"],
679
- "filters" => [],
680
- "metrics" => ["visitors"],
681
- "include" => %{"imports_meta" => true}
682
- }
683
-
684
- assert %{"meta" => meta} = do_query_success(conn, site, params)
685
-
686
- assert meta["imports_skip_reason"] == "out_of_range"
687
- assert meta["imports_included"] == false
688
- end
689
-
690
- test "when imported data is requested, in range, and can be included", %{
691
- conn: conn,
692
- site: site
693
- } do
694
- params = %{
695
- "date_range" => ["2021-03-15", "2021-03-15"],
696
- "filters" => [],
697
- "metrics" => ["visitors"],
698
- "include" => %{"imports" => true, "imports_meta" => true}
699
- }
700
-
701
- assert %{"meta" => meta} = do_query_success(conn, site, params)
702
-
703
- assert meta["imports_skip_reason"] == nil
704
- assert meta["imports_included"] == true
705
- end
706
-
707
- test "when imported data is not requested, but in range and can be included", %{
708
- conn: conn,
709
- site: site
710
- } do
711
- params = %{
712
- "date_range" => ["2021-03-15", "2021-03-15"],
713
- "filters" => [],
714
- "metrics" => ["visitors"],
715
- "include" => %{"imports" => false, "imports_meta" => true}
716
- }
717
-
718
- assert %{"meta" => meta} = do_query_success(conn, site, params)
719
-
720
- assert meta["imports_skip_reason"] == nil
721
- assert meta["imports_included"] == false
722
- end
723
-
724
- test "when imported data is requested and in range, but cannot be included", %{
725
- conn: conn,
726
- site: site
727
- } do
728
- insert(:goal, site: site, event_name: "Signup")
729
-
730
- params = %{
731
- "date_range" => ["2021-03-15", "2021-03-15"],
732
- "filters" => [
733
- ["is", "event:goal", ["Signup"]],
734
- ["is", "event:page", ["/register"]]
735
- ],
736
- "metrics" => ["visitors"],
737
- "include" => %{"imports" => true, "imports_meta" => true}
738
- }
739
-
740
- assert %{"meta" => meta} = do_query_success(conn, site, params)
741
-
742
- assert meta["imports_skip_reason"] == "unsupported_query"
743
- assert meta["imports_included"] == false
744
- end
745
-
746
- test "when imported data is requested and in comparison range", %{conn: conn, site: site} do
747
- params = %{
748
- "date_range" => ["2022-03-15", "2022-03-15"],
749
- "filters" => [],
750
- "metrics" => ["visitors"],
751
- "include" => %{
752
- "imports" => true,
753
- "imports_meta" => true,
754
- "compare" => "year_over_year"
755
- }
756
- }
757
-
758
- assert %{"meta" => meta} = do_query_success(conn, site, params)
759
-
760
- assert meta["imports_skip_reason"] == nil
761
- assert meta["imports_included"] == true
762
- end
763
-
764
- test "when imported data is not requested and in comparison range", %{conn: conn, site: site} do
765
- params = %{
766
- "date_range" => ["2022-03-15", "2022-03-15"],
767
- "filters" => [],
768
- "metrics" => ["visitors"],
769
- "include" => %{
770
- "imports" => false,
771
- "imports_meta" => true,
772
- "compare" => "year_over_year"
773
- }
774
- }
775
-
776
- assert %{"meta" => meta} = do_query_success(conn, site, params)
777
-
778
- assert meta["imports_skip_reason"] == nil
779
- assert meta["imports_included"] == false
780
- end
781
- end
782
-
783
- describe "realtime" do
784
- setup [:create_user, :log_in, :create_site]
785
-
786
- test "current visitors (last 5 minutes)", %{conn: conn, site: site} do
787
- populate_stats(site, [
788
- build(:pageview, timestamp: relative_time(minute: -10)),
789
- build(:pageview, timestamp: relative_time(minute: -4)),
790
- build(:pageview, timestamp: relative_time(minute: -1))
791
- ])
792
-
793
- params = %{
794
- "date_range" => "realtime",
795
- "filters" => [],
796
- "metrics" => ["visitors"]
797
- }
798
-
799
- response = do_query_success(conn, site, params)
800
-
801
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2]}]
802
- end
803
-
804
- test "visitors and pageviews (last 30 minutes)", %{conn: conn, site: site} do
805
- populate_stats(site, [
806
- build(:pageview, user_id: @user_id, timestamp: relative_time(minute: -45)),
807
- build(:pageview, user_id: @user_id, timestamp: relative_time(minute: -25)),
808
- build(:pageview, user_id: @user_id, timestamp: relative_time(minute: -20)),
809
- build(:pageview, timestamp: relative_time(minute: -1))
810
- ])
811
-
812
- params = %{
813
- "date_range" => "realtime_30m",
814
- "filters" => [],
815
- "metrics" => ["visitors", "pageviews"]
816
- }
817
-
818
- response = do_query_success(conn, site, params)
819
-
820
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2, 3]}]
821
- end
822
-
823
- test "visitors, events, and CR with goal filter (last 30 min)", %{
824
- conn: conn,
825
- site: site
826
- } do
827
- populate_stats(site, [
828
- build(:event, name: "Signup", timestamp: relative_time(minute: -45)),
829
- build(:event, name: "Signup", timestamp: relative_time(minute: -25)),
830
- build(:event, name: "Signup", user_id: @user_id, timestamp: relative_time(minute: -22)),
831
- build(:event, name: "Signup", user_id: @user_id, timestamp: relative_time(minute: -21)),
832
- build(:event, name: "Signup", user_id: @user_id, timestamp: relative_time(minute: -20)),
833
- build(:pageview, timestamp: relative_time(minute: -20))
834
- ])
835
-
836
- insert(:goal, site: site, event_name: "Signup")
837
-
838
- params = %{
839
- "date_range" => "realtime_30m",
840
- "filters" => [["is", "event:goal", ["Signup"]]],
841
- "metrics" => ["visitors", "events", "conversion_rate"]
842
- }
843
-
844
- response = do_query_success(conn, site, params)
845
-
846
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2, 4, 66.67]}]
847
- end
848
- end
849
-
850
- describe "filters" do
851
- setup [:create_user, :log_in, :create_site]
852
-
853
- test "returns only visitors from a country based on alpha2 code", %{conn: conn, site: site} do
854
- populate_stats(site, [
855
- build(:pageview, country_code: "US"),
856
- build(:pageview, country_code: "US"),
857
- build(:pageview, country_code: "EE")
858
- ])
859
-
860
- params = %{
861
- "date_range" => "month",
862
- "filters" => [["is", "visit:country", ["US"]]],
863
- "metrics" => ["visitors"]
864
- }
865
-
866
- response = do_query_success(conn, site, params)
867
-
868
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2]}]
869
- end
870
-
871
- test "returns scroll_depth with a page filter", %{conn: conn, site: site} do
872
- populate_stats(site, [
873
- build(:pageview, user_id: 123, timestamp: ~N[2021-01-01 00:00:00]),
874
- build(:engagement, user_id: 123, timestamp: ~N[2021-01-01 00:00:10], scroll_depth: 40),
875
- build(:pageview, user_id: 123, timestamp: ~N[2021-01-01 00:00:10]),
876
- build(:engagement, user_id: 123, timestamp: ~N[2021-01-01 00:00:20], scroll_depth: 60),
877
- build(:pageview, user_id: 456, timestamp: ~N[2021-01-01 00:00:00]),
878
- build(:engagement, user_id: 456, timestamp: ~N[2021-01-01 00:00:10], scroll_depth: 80)
879
- ])
880
-
881
- params = %{
882
- "date_range" => "day",
883
- "relative_date" => "2021-01-01",
884
- "filters" => [["is", "event:page", ["/"]]],
885
- "metrics" => ["scroll_depth"]
886
- }
887
-
888
- response = do_query_success(conn, site, params)
889
-
890
- assert response["results"] == [%{"dimensions" => [], "metrics" => [70]}]
891
- end
892
-
893
- test "returns scroll_depth with a page filter with imported data", %{conn: conn, site: site} do
894
- site_import =
895
- insert(:site_import, site: site, start_date: ~D[2021-01-01], has_scroll_depth: true)
896
-
897
- populate_stats(site, site_import.id, [
898
- build(:pageview, user_id: 123, timestamp: ~N[2021-01-01 00:00:00]),
899
- build(:engagement, user_id: 123, timestamp: ~N[2021-01-01 00:00:10], scroll_depth: 40),
900
- build(:pageview, user_id: 123, timestamp: ~N[2021-01-01 00:00:10]),
901
- build(:engagement, user_id: 123, timestamp: ~N[2021-01-01 00:00:20], scroll_depth: 60),
902
- build(:pageview, user_id: 456, timestamp: ~N[2021-01-01 00:00:00]),
903
- build(:engagement, user_id: 456, timestamp: ~N[2021-01-01 00:00:10], scroll_depth: 80),
904
- build(:imported_pages,
905
- page: "/",
906
- date: ~D[2021-01-01],
907
- visitors: 8,
908
- total_scroll_depth: 410,
909
- total_scroll_depth_visits: 8
910
- ),
911
- build(:imported_pages, page: "/", date: ~D[2021-01-02], visitors: 100)
912
- ])
913
-
914
- params = %{
915
- "date_range" => "7d",
916
- "relative_date" => "2021-01-07",
917
- "filters" => [["is", "event:page", ["/"]]],
918
- "metrics" => ["visitors", "scroll_depth"],
919
- "include" => %{"imports" => true}
920
- }
921
-
922
- response = do_query_success(conn, site, params)
923
-
924
- assert response["results"] == [%{"dimensions" => [], "metrics" => [110, 55]}]
925
- end
926
-
927
- test "contains filter", %{conn: conn, site: site} do
928
- populate_stats(site, [
929
- build(:pageview, pathname: "/some-blog-post"),
930
- build(:pageview, pathname: "/blog/post1"),
931
- build(:pageview, pathname: "/another/post")
932
- ])
933
-
934
- params = %{
935
- "date_range" => "month",
936
- "filters" => [["contains", "event:page", ["blog"]]],
937
- "metrics" => ["visitors"]
938
- }
939
-
940
- response = do_query_success(conn, site, params)
941
-
942
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2]}]
943
- end
944
-
945
- test "returns only visitors with specific screen size", %{conn: conn, site: site} do
946
- populate_stats(site, [
947
- build(:pageview, screen_size: "Desktop"),
948
- build(:pageview, screen_size: "Desktop"),
949
- build(:pageview, screen_size: "Mobile")
950
- ])
951
-
952
- params = %{
953
- "date_range" => "month",
954
- "filters" => [["is", "visit:screen", ["Desktop"]]],
955
- "metrics" => ["visitors"]
956
- }
957
-
958
- response = do_query_success(conn, site, params)
959
-
960
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2]}]
961
- end
962
-
963
- test "returns only visitors with specific screen size for a given hostname", %{
964
- conn: conn,
965
- site: site
966
- } do
967
- populate_stats(site, [
968
- build(:pageview, screen_size: "Desktop", hostname: "blog.example.com"),
969
- build(:pageview, screen_size: "Desktop", hostname: "example.com", user_id: @user_id),
970
- build(:pageview, screen_size: "Desktop", hostname: "blog.example.com", user_id: @user_id),
971
- build(:pageview,
972
- screen_size: "Desktop",
973
- hostname: "blog.example.com",
974
- user_id: @user_id + 1
975
- ),
976
- build(:pageview, screen_size: "Desktop", hostname: "example.com", user_id: @user_id + 1),
977
- build(:pageview, screen_size: "Mobile", hostname: "blog.example.com")
978
- ])
979
-
980
- params = %{
981
- "date_range" => "month",
982
- "filters" => [
983
- ["is", "visit:screen", ["Desktop"]],
984
- ["is", "event:hostname", ["blog.example.com"]]
985
- ],
986
- "metrics" => ["visitors", "visits"]
987
- }
988
-
989
- response = do_query_success(conn, site, params)
990
-
991
- assert response["results"] == [%{"dimensions" => [], "metrics" => [3, 3]}]
992
- end
993
-
994
- test "returns only visitors with specific browser", %{conn: conn, site: site} do
995
- populate_stats(site, [
996
- build(:pageview, browser: "Chrome"),
997
- build(:pageview, browser: "Chrome"),
998
- build(:pageview, browser: "Safari")
999
- ])
1000
-
1001
- params = %{
1002
- "date_range" => "month",
1003
- "filters" => [["is", "visit:browser", ["Chrome"]]],
1004
- "metrics" => ["visitors"]
1005
- }
1006
-
1007
- response = do_query_success(conn, site, params)
1008
-
1009
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2]}]
1010
- end
1011
-
1012
- test "returns only visitors with specific operating system", %{conn: conn, site: site} do
1013
- populate_stats(site, [
1014
- build(:pageview, operating_system: "Mac"),
1015
- build(:pageview, operating_system: "Mac"),
1016
- build(:pageview, operating_system: "Windows")
1017
- ])
1018
-
1019
- params = %{
1020
- "date_range" => "month",
1021
- "filters" => [["is", "visit:os", ["Mac"]]],
1022
- "metrics" => ["visitors"]
1023
- }
1024
-
1025
- response = do_query_success(conn, site, params)
1026
-
1027
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2]}]
1028
- end
1029
-
1030
- test "returns number of visits from one specific referral source", %{conn: conn, site: site} do
1031
- populate_stats(site, [
1032
- build(:pageview,
1033
- user_id: @user_id,
1034
- referrer_source: "Google",
1035
- timestamp: ~N[2021-01-01 00:00:00]
1036
- ),
1037
- build(:pageview,
1038
- user_id: @user_id,
1039
- referrer_source: "Google",
1040
- timestamp: ~N[2021-01-01 00:05:00]
1041
- ),
1042
- build(:pageview,
1043
- user_id: @user_id,
1044
- referrer_source: "Google",
1045
- timestamp: ~N[2021-01-01 05:00:00]
1046
- ),
1047
- build(:pageview, timestamp: ~N[2021-01-01 00:10:00])
1048
- ])
1049
-
1050
- params = %{
1051
- "date_range" => "day",
1052
- "relative_date" => "2021-01-01",
1053
- "filters" => [["is", "visit:source", ["Google"]]],
1054
- "metrics" => ["visits"]
1055
- }
1056
-
1057
- response = do_query_success(conn, site, params)
1058
-
1059
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2]}]
1060
- end
1061
-
1062
- test "hostname exact filter", %{conn: conn, site: site} do
1063
- populate_stats(site, [
1064
- build(:pageview, pathname: "/index", hostname: "example.com"),
1065
- build(:pageview, pathname: "/index", hostname: "example.com", user_id: @user_id),
1066
- build(:pageview,
1067
- pathname: "/blog/post1",
1068
- hostname: "blog.example.com",
1069
- user_id: @user_id
1070
- ),
1071
- build(:pageview, pathname: "/blog/post2", hostname: "blog.example.com")
1072
- ])
1073
-
1074
- params = %{
1075
- "date_range" => "month",
1076
- "filters" => [["is", "event:hostname", ["example.com"]]],
1077
- "metrics" => ["visitors", "pageviews"]
1078
- }
1079
-
1080
- response = do_query_success(conn, site, params)
1081
-
1082
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2, 2]}]
1083
- end
1084
-
1085
- test "hostname contains filter", %{conn: conn, site: site} do
1086
- populate_stats(site, [
1087
- build(:pageview, pathname: "/index", hostname: "example.com"),
1088
- build(:pageview, pathname: "/index", hostname: "example.com", user_id: @user_id),
1089
- build(:pageview,
1090
- pathname: "/blog/post1",
1091
- hostname: "blog.example.com",
1092
- user_id: @user_id
1093
- ),
1094
- build(:pageview,
1095
- pathname: "/blog/post2",
1096
- hostname: "blog.example.com",
1097
- user_id: @user_id
1098
- ),
1099
- build(:pageview, pathname: "/blog/post2", hostname: "blog.example.com"),
1100
- build(:pageview, pathname: "/blog/post2", hostname: "about.example.com")
1101
- ])
1102
-
1103
- params = %{
1104
- "date_range" => "month",
1105
- "filters" => [["contains", "event:hostname", ["example.com"]]],
1106
- "metrics" => ["visitors", "pageviews"]
1107
- }
1108
-
1109
- response = do_query_success(conn, site, params)
1110
-
1111
- assert response["results"] == [%{"dimensions" => [], "metrics" => [4, 6]}]
1112
- end
1113
-
1114
- test "hostname contains subdomain filter", %{conn: conn, site: site} do
1115
- populate_stats(site, [
1116
- build(:pageview, pathname: "/index", hostname: "example.com"),
1117
- build(:pageview, pathname: "/index", hostname: "example.com", user_id: @user_id),
1118
- build(:pageview,
1119
- pathname: "/blog/post1",
1120
- hostname: "blog.example.com",
1121
- user_id: @user_id
1122
- ),
1123
- build(:pageview,
1124
- pathname: "/blog/post2",
1125
- hostname: "blog.example.com",
1126
- user_id: @user_id
1127
- ),
1128
- build(:pageview, pathname: "/blog/post3", hostname: "blog.example.com"),
1129
- build(:pageview,
1130
- pathname: "/blog/post2",
1131
- hostname: "blog.example.com",
1132
- user_id: 100_002_378_237
1133
- )
1134
- ])
1135
-
1136
- params = %{
1137
- "date_range" => "month",
1138
- "filters" => [["contains", "event:hostname", [".example.com"]]],
1139
- "metrics" => ["visitors", "pageviews"]
1140
- }
1141
-
1142
- response = do_query_success(conn, site, params)
1143
-
1144
- assert response["results"] == [%{"dimensions" => [], "metrics" => [3, 4]}]
1145
- end
1146
- end
1147
-
1148
- describe "goal filter" do
1149
- setup [:create_user, :log_in, :create_site]
1150
-
1151
- test "returns unique and total conversions and conversion rate", %{conn: conn, site: site} do
1152
- insert(:goal, site: site, event_name: "Signup")
1153
-
1154
- populate_stats(site, [
1155
- build(:pageview, user_id: @user_id),
1156
- build(:pageview, user_id: @user_id),
1157
- build(:pageview),
1158
- build(:event, user_id: 1, name: "Signup"),
1159
- build(:event, user_id: 1, name: "Signup"),
1160
- build(:event, user_id: 2, name: "Signup")
1161
- ])
1162
-
1163
- params = %{
1164
- "date_range" => "day",
1165
- "filters" => [["is", "event:goal", ["Signup"]]],
1166
- "metrics" => ["visitors", "events", "conversion_rate"]
1167
- }
1168
-
1169
- response = do_query_success(conn, site, params)
1170
-
1171
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2, 3, 50.0]}]
1172
- end
1173
-
1174
- @tag :ee_only
1175
- test "drops revenue metrics when they are not allowed", %{
1176
- conn: conn,
1177
- user: user,
1178
- site: site
1179
- } do
1180
- {:ok, team} = Plausible.Teams.get_or_create(user)
1181
- insert(:goal, site: site, event_name: "Purchase", currency: "EUR")
1182
- subscribe_to_growth_plan(team)
1183
-
1184
- params = %{
1185
- "date_range" => "day",
1186
- "filters" => [["is", "event:goal", ["Purchase"]]],
1187
- "metrics" => [
1188
- "visitors",
1189
- "events",
1190
- "conversion_rate",
1191
- "total_revenue",
1192
- "average_revenue"
1193
- ]
1194
- }
1195
-
1196
- %{"results" => results, "query" => query} = do_query_success(conn, site, params)
1197
-
1198
- assert query["metrics"] == ["visitors", "events", "conversion_rate"]
1199
- assert results == [%{"dimensions" => [], "metrics" => [0, 0, 0.0]}]
1200
- end
1201
-
1202
- @tag :ee_only
1203
- test "returns average and total when filtering by a revenue goal", %{conn: conn, site: site} do
1204
- insert(:goal,
1205
- site: site,
1206
- event_name: "Payment",
1207
- currency: "USD",
1208
- display_name: "PaymentUSD"
1209
- )
1210
-
1211
- insert(:goal,
1212
- site: site,
1213
- event_name: "AddToCart",
1214
- currency: "EUR",
1215
- display_name: "AddToCartEUR"
1216
- )
1217
-
1218
- populate_stats(site, [
1219
- build(:event,
1220
- name: "Payment",
1221
- revenue_reporting_amount: Decimal.new(13_29),
1222
- revenue_reporting_currency: "USD"
1223
- ),
1224
- build(:event,
1225
- name: "Payment",
1226
- revenue_reporting_amount: Decimal.new(19_90),
1227
- revenue_reporting_currency: "USD"
1228
- ),
1229
- build(:event,
1230
- name: "AddToCart",
1231
- revenue_reporting_amount: Decimal.new(10_31),
1232
- revenue_reporting_currency: "EUR"
1233
- ),
1234
- build(:event,
1235
- name: "AddToCart",
1236
- revenue_reporting_amount: Decimal.new(20_00),
1237
- revenue_reporting_currency: "EUR"
1238
- )
1239
- ])
1240
-
1241
- params = %{
1242
- "date_range" => "all",
1243
- "filters" => [["is", "event:goal", ["PaymentUSD"]]],
1244
- "metrics" => ["average_revenue", "total_revenue"]
1245
- }
1246
-
1247
- response = do_query_success(conn, site, params)
1248
-
1249
- assert response["results"] == [
1250
- %{
1251
- "dimensions" => [],
1252
- "metrics" => [
1253
- %{
1254
- "long" => "$1,659.50",
1255
- "short" => "$1.7K",
1256
- "value" => 1659.5,
1257
- "currency" => "USD"
1258
- },
1259
- %{
1260
- "long" => "$3,319.00",
1261
- "short" => "$3.3K",
1262
- "value" => 3319.0,
1263
- "currency" => "USD"
1264
- }
1265
- ]
1266
- }
1267
- ]
1268
- end
1269
-
1270
- @tag :ee_only
1271
- test "returns average and total when filtering by many revenue goals with same currency", %{
1272
- conn: conn,
1273
- site: site
1274
- } do
1275
- insert(:goal, site: site, event_name: "Payment", currency: "USD")
1276
- insert(:goal, site: site, event_name: "Payment2", currency: "USD")
1277
- insert(:goal, site: site, event_name: "AddToCart", currency: "EUR")
1278
-
1279
- populate_stats(site, [
1280
- build(:event,
1281
- name: "Payment",
1282
- revenue_reporting_amount: Decimal.new(13_29),
1283
- revenue_reporting_currency: "USD"
1284
- ),
1285
- build(:event,
1286
- name: "Payment",
1287
- revenue_reporting_amount: Decimal.new(19_90),
1288
- revenue_reporting_currency: "USD"
1289
- ),
1290
- build(:event,
1291
- name: "Payment2",
1292
- revenue_reporting_amount: Decimal.new(13_29),
1293
- revenue_reporting_currency: "USD"
1294
- ),
1295
- build(:event,
1296
- name: "Payment2",
1297
- revenue_reporting_amount: Decimal.new(19_90),
1298
- revenue_reporting_currency: "USD"
1299
- ),
1300
- build(:event,
1301
- name: "AddToCart",
1302
- revenue_reporting_amount: Decimal.new(10_31),
1303
- revenue_reporting_currency: "EUR"
1304
- ),
1305
- build(:event,
1306
- name: "AddToCart",
1307
- revenue_reporting_amount: Decimal.new(20_00),
1308
- revenue_reporting_currency: "EUR"
1309
- )
1310
- ])
1311
-
1312
- params = %{
1313
- "date_range" => "all",
1314
- "filters" => [["is", "event:goal", ["Payment", "Payment2"]]],
1315
- "metrics" => ["average_revenue", "total_revenue"]
1316
- }
1317
-
1318
- response = do_query_success(conn, site, params)
1319
-
1320
- assert response["results"] == [
1321
- %{
1322
- "dimensions" => [],
1323
- "metrics" => [
1324
- %{
1325
- "long" => "$1,659.50",
1326
- "short" => "$1.7K",
1327
- "value" => 1659.5,
1328
- "currency" => "USD"
1329
- },
1330
- %{
1331
- "long" => "$6,638.00",
1332
- "short" => "$6.6K",
1333
- "value" => 6638.0,
1334
- "currency" => "USD"
1335
- }
1336
- ]
1337
- }
1338
- ]
1339
- end
1340
-
1341
- @tag :ee_only
1342
- test "does not return average and total when filtering by many revenue goals with different currencies",
1343
- %{conn: conn, site: site} do
1344
- insert(:goal, site: site, event_name: "Payment", currency: "USD")
1345
- insert(:goal, site: site, event_name: "AddToCart", currency: "EUR")
1346
-
1347
- populate_stats(site, [
1348
- build(:event,
1349
- name: "Payment",
1350
- revenue_reporting_amount: Decimal.new(13_29),
1351
- revenue_reporting_currency: "USD"
1352
- ),
1353
- build(:event,
1354
- name: "Payment",
1355
- revenue_reporting_amount: Decimal.new(19_90),
1356
- revenue_reporting_currency: "USD"
1357
- ),
1358
- build(:event,
1359
- name: "AddToCart",
1360
- revenue_reporting_amount: Decimal.new(10_31),
1361
- revenue_reporting_currency: "EUR"
1362
- ),
1363
- build(:event,
1364
- name: "AddToCart",
1365
- revenue_reporting_amount: Decimal.new(20_00),
1366
- revenue_reporting_currency: "EUR"
1367
- )
1368
- ])
1369
-
1370
- params = %{
1371
- "date_range" => "all",
1372
- "filters" => [["is", "event:goal", ["Payment", "AddToCart"]]],
1373
- "metrics" => ["visitors", "events", "conversion_rate", "total_revenue", "average_revenue"]
1374
- }
1375
-
1376
- %{"results" => results, "query" => query} = do_query_success(conn, site, params)
1377
-
1378
- assert query["metrics"] == ["visitors", "events", "conversion_rate"]
1379
- assert results == [%{"dimensions" => [], "metrics" => [4, 4, 100.0]}]
1380
- end
1381
-
1382
- @tag :ee_only
1383
- test "returns average and total revenue when filtering by many goals some which don't have currencies",
1384
- %{conn: conn, site: site} do
1385
- insert(:goal, site: site, event_name: "Payment", currency: "USD")
1386
- insert(:goal, site: site, event_name: "Signup")
1387
-
1388
- populate_stats(site, [
1389
- build(:event,
1390
- name: "Payment",
1391
- revenue_reporting_amount: Decimal.new(1_000),
1392
- revenue_reporting_currency: "USD"
1393
- ),
1394
- build(:event,
1395
- name: "Payment",
1396
- revenue_reporting_amount: Decimal.new(1_000),
1397
- revenue_reporting_currency: "USD"
1398
- ),
1399
- build(:event, name: "Signup"),
1400
- build(:event, name: "Signup")
1401
- ])
1402
-
1403
- params = %{
1404
- "date_range" => "all",
1405
- "filters" => [["is", "event:goal", ["Payment", "Signup"]]],
1406
- "metrics" => ["average_revenue", "total_revenue"]
1407
- }
1408
-
1409
- response = do_query_success(conn, site, params)
1410
-
1411
- assert response["results"] == [
1412
- %{
1413
- "dimensions" => [],
1414
- "metrics" => [
1415
- %{
1416
- "long" => "$1,000.00",
1417
- "short" => "$1.0K",
1418
- "value" => 1000.0,
1419
- "currency" => "USD"
1420
- },
1421
- %{
1422
- "long" => "$2,000.00",
1423
- "short" => "$2.0K",
1424
- "value" => 2000.0,
1425
- "currency" => "USD"
1426
- }
1427
- ]
1428
- }
1429
- ]
1430
- end
1431
-
1432
- @tag :ee_only
1433
- test "returns average and total revenue when no conversions",
1434
- %{conn: conn, site: site} do
1435
- insert(:goal, site: site, event_name: "Payment", currency: "USD")
1436
-
1437
- params = %{
1438
- "date_range" => "all",
1439
- "filters" => [["is", "event:goal", ["Payment", "Signup"]]],
1440
- "metrics" => ["average_revenue", "total_revenue"]
1441
- }
1442
-
1443
- response = do_query_success(conn, site, params)
1444
-
1445
- assert response["results"] == [
1446
- %{
1447
- "dimensions" => [],
1448
- "metrics" => [
1449
- %{"long" => "$0.00", "short" => "$0.0", "value" => 0.0, "currency" => "USD"},
1450
- %{"long" => "$0.00", "short" => "$0.0", "value" => 0.0, "currency" => "USD"}
1451
- ]
1452
- }
1453
- ]
1454
- end
1455
-
1456
- @tag :ee_only
1457
- test "does not return average and total revenue when filtering non-currency goal",
1458
- %{conn: conn, site: site} do
1459
- insert(:goal, site: site, event_name: "Payment", display_name: "PaymentWithoutCurrency")
1460
-
1461
- populate_stats(site, [
1462
- build(:event,
1463
- name: "Payment",
1464
- revenue_reporting_amount: Decimal.new(1_000),
1465
- revenue_reporting_currency: "USD"
1466
- ),
1467
- build(:event,
1468
- name: "Payment",
1469
- revenue_reporting_amount: Decimal.new(1_000),
1470
- revenue_reporting_currency: "USD"
1471
- )
1472
- ])
1473
-
1474
- params = %{
1475
- "date_range" => "all",
1476
- "filters" => [["is", "event:goal", ["PaymentWithoutCurrency"]]],
1477
- "metrics" => ["visitors", "events", "conversion_rate", "total_revenue", "average_revenue"]
1478
- }
1479
-
1480
- %{"results" => results, "query" => query} = do_query_success(conn, site, params)
1481
-
1482
- assert query["metrics"] == ["visitors", "events", "conversion_rate"]
1483
- assert results == [%{"dimensions" => [], "metrics" => [2, 2, 100.0]}]
1484
- end
1485
-
1486
- @tag :ee_only
1487
- test "does not return average and total when site owner is on a growth plan",
1488
- %{conn: conn, site: site, user: user} do
1489
- subscribe_to_growth_plan(user)
1490
- insert(:goal, site: site, event_name: "Payment", currency: "USD")
1491
-
1492
- populate_stats(site, [
1493
- build(:event,
1494
- name: "Payment",
1495
- revenue_reporting_amount: Decimal.new(13_29),
1496
- revenue_reporting_currency: "USD"
1497
- )
1498
- ])
1499
-
1500
- params = %{
1501
- "date_range" => "all",
1502
- "filters" => [["is", "event:goal", ["Payment"]]],
1503
- "metrics" => ["visitors", "events", "conversion_rate", "total_revenue", "average_revenue"]
1504
- }
1505
-
1506
- %{"results" => results, "query" => query} = do_query_success(conn, site, params)
1507
-
1508
- assert query["metrics"] == ["visitors", "events", "conversion_rate"]
1509
- assert results == [%{"dimensions" => [], "metrics" => [1, 1, 100.0]}]
1510
- end
1511
-
1512
- test "page scroll goal filter", %{conn: conn, site: site} do
1513
- insert(:goal, site: site, page_path: "/blog", scroll_threshold: 50)
1514
-
1515
- populate_stats(site, [
1516
- build(:pageview, user_id: 123, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),
1517
- build(:engagement,
1518
- user_id: 123,
1519
- pathname: "/blog",
1520
- timestamp: ~N[2021-01-01 00:00:10],
1521
- scroll_depth: 60
1522
- ),
1523
- build(:pageview, user_id: 456, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),
1524
- build(:engagement,
1525
- user_id: 456,
1526
- pathname: "/blog",
1527
- timestamp: ~N[2021-01-01 00:00:10],
1528
- scroll_depth: 40
1529
- )
1530
- ])
1531
-
1532
- params = %{
1533
- "date_range" => "all",
1534
- "filters" => [["is", "event:goal", ["Visit /blog"]]],
1535
- "metrics" => ["visitors", "events", "conversion_rate"]
1536
- }
1537
-
1538
- response = do_query_success(conn, site, params)
1539
-
1540
- assert response["results"] == [%{"dimensions" => [], "metrics" => [1, nil, 50.0]}]
1541
- end
1542
-
1543
- test "goal is page scroll OR custom event", %{conn: conn, site: site} do
1544
- insert(:goal, site: site, page_path: "/blog", scroll_threshold: 50)
1545
- insert(:goal, site: site, event_name: "Signup")
1546
-
1547
- populate_stats(site, [
1548
- build(:pageview, user_id: 123, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),
1549
- build(:event,
1550
- user_id: 123,
1551
- pathname: "/blog",
1552
- name: "Signup",
1553
- timestamp: ~N[2021-01-01 00:00:05]
1554
- ),
1555
- build(:engagement,
1556
- user_id: 123,
1557
- pathname: "/blog",
1558
- timestamp: ~N[2021-01-01 00:00:10],
1559
- scroll_depth: 60
1560
- ),
1561
- build(:pageview, user_id: 456, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),
1562
- build(:engagement,
1563
- user_id: 456,
1564
- pathname: "/blog",
1565
- timestamp: ~N[2021-01-01 00:00:10],
1566
- scroll_depth: 40
1567
- ),
1568
- build(:pageview, user_id: 789, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),
1569
- build(:engagement,
1570
- user_id: 789,
1571
- pathname: "/blog",
1572
- timestamp: ~N[2021-01-01 00:00:10],
1573
- scroll_depth: 100
1574
- ),
1575
- build(:event, name: "Signup", timestamp: ~N[2021-01-01 00:01:00]),
1576
- build(:pageview, timestamp: ~N[2021-01-01 00:01:00])
1577
- ])
1578
-
1579
- params = %{
1580
- "date_range" => "all",
1581
- "filters" => [["is", "event:goal", ["Visit /blog", "Signup"]]],
1582
- "metrics" => ["visitors", "events", "conversion_rate"]
1583
- }
1584
-
1585
- response = do_query_success(conn, site, params)
1586
-
1587
- assert response["results"] == [%{"dimensions" => [], "metrics" => [3, nil, 60.0]}]
1588
- end
1589
-
1590
- test "goal is page scroll OR pageview goal", %{conn: conn, site: site} do
1591
- insert(:goal,
1592
- site: site,
1593
- page_path: "/blog**",
1594
- scroll_threshold: 50,
1595
- display_name: "Scroll 50 /blog**"
1596
- )
1597
-
1598
- insert(:goal, site: site, page_path: "/blog")
1599
-
1600
- populate_stats(site, [
1601
- build(:pageview, user_id: 123, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),
1602
- build(:engagement,
1603
- user_id: 123,
1604
- pathname: "/blog",
1605
- timestamp: ~N[2021-01-01 00:00:10],
1606
- scroll_depth: 60
1607
- ),
1608
- build(:pageview, user_id: 456, pathname: "/blog", timestamp: ~N[2021-01-01 00:00:00]),
1609
- build(:engagement,
1610
- user_id: 456,
1611
- pathname: "/blog",
1612
- timestamp: ~N[2021-01-01 00:00:10],
1613
- scroll_depth: 40
1614
- ),
1615
- build(:pageview, timestamp: ~N[2021-01-01 00:01:00])
1616
- ])
1617
-
1618
- params = %{
1619
- "date_range" => "all",
1620
- "filters" => [["is", "event:goal", ["Visit /blog", "Scroll 50 /blog**"]]],
1621
- "metrics" => ["visitors", "events", "conversion_rate"]
1622
- }
1623
-
1624
- response = do_query_success(conn, site, params)
1625
-
1626
- assert response["results"] == [%{"dimensions" => [], "metrics" => [2, nil, 66.67]}]
1627
- end
1628
- end
1629
-
1630
- describe "comparisons" do
1631
- setup [:create_user, :log_in, :create_site, :create_legacy_site_import]
1632
-
1633
- test "returns comparison data when mode is custom", %{site: site, conn: conn} do
1634
- populate_stats(site, [
1635
- build(:pageview, timestamp: ~N[2020-01-01 00:00:00]),
1636
- build(:pageview, timestamp: ~N[2020-01-05 00:00:00]),
1637
- build(:pageview, timestamp: ~N[2020-01-20 00:00:00]),
1638
- build(:pageview, timestamp: ~N[2020-12-31 00:00:00]),
1639
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
1640
- build(:pageview, timestamp: ~N[2021-01-01 00:01:00]),
1641
- build(:pageview, timestamp: ~N[2021-01-01 10:00:00])
1642
- ])
1643
-
1644
- params = %{
1645
- "date_range" => "day",
1646
- "relative_date" => "2021-01-01",
1647
- "filters" => [],
1648
- "metrics" => ["visits"],
1649
- "include" => %{"compare" => ["2020-01-01", "2020-01-20"]}
1650
- }
1651
-
1652
- response = do_query_success(conn, site, params)
1653
-
1654
- assert response["results"] == [
1655
- %{
1656
- "dimensions" => [],
1657
- "metrics" => [3],
1658
- "comparison" => %{"dimensions" => [], "metrics" => [3], "change" => [0]}
1659
- }
1660
- ]
1661
- end
1662
-
1663
- test "returns source query and comparison query date range", %{site: site, conn: conn} do
1664
- populate_stats(site, [
1665
- build(:pageview, timestamp: ~N[2020-01-01 00:00:00]),
1666
- build(:pageview, timestamp: ~N[2020-01-05 00:00:00]),
1667
- build(:pageview, timestamp: ~N[2020-01-20 00:00:00]),
1668
- build(:pageview, timestamp: ~N[2020-12-31 00:00:00]),
1669
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
1670
- build(:pageview, timestamp: ~N[2021-01-01 00:01:00]),
1671
- build(:pageview, timestamp: ~N[2021-01-01 10:00:00])
1672
- ])
1673
-
1674
- params = %{
1675
- "date_range" => "month",
1676
- "relative_date" => "2021-01-01",
1677
- "filters" => [],
1678
- "metrics" => ["visitors"],
1679
- "include" => %{"compare" => "previous_period"}
1680
- }
1681
-
1682
- assert %{"query" => query} = do_query_success(conn, site, params)
1683
-
1684
- assert query["date_range"] == ["2021-01-01T00:00:00Z", "2021-01-31T23:59:59Z"]
1685
- assert query["comparison_date_range"] == ["2020-12-01T00:00:00Z", "2020-12-31T23:59:59Z"]
1686
- end
1687
-
1688
- test "compares native and imported data", %{site: site, conn: conn} do
1689
- populate_stats(site, [
1690
- build(:imported_visitors, date: ~D[2020-01-02]),
1691
- build(:imported_visitors, date: ~D[2020-01-02]),
1692
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
1693
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
1694
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
1695
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00])
1696
- ])
1697
-
1698
- params = %{
1699
- "date_range" => "month",
1700
- "relative_date" => "2021-01-01",
1701
- "filters" => [],
1702
- "metrics" => ["visits"],
1703
- "include" => %{"imports" => true, "imports_meta" => true, "compare" => "year_over_year"}
1704
- }
1705
-
1706
- %{"results" => results, "meta" => meta} = do_query_success(conn, site, params)
1707
-
1708
- assert meta["imports_included"] == true
1709
-
1710
- assert results == [
1711
- %{
1712
- "dimensions" => [],
1713
- "metrics" => [4],
1714
- "comparison" => %{"dimensions" => [], "metrics" => [2], "change" => [100]}
1715
- }
1716
- ]
1717
- end
1718
-
1719
- test "does not compare imported data when include.imports is false", %{
1720
- site: site,
1721
- conn: conn
1722
- } do
1723
- populate_stats(site, [
1724
- build(:imported_visitors, date: ~D[2020-01-02]),
1725
- build(:imported_visitors, date: ~D[2020-01-02]),
1726
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
1727
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
1728
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00]),
1729
- build(:pageview, timestamp: ~N[2021-01-01 00:00:00])
1730
- ])
1731
-
1732
- params = %{
1733
- "date_range" => "month",
1734
- "relative_date" => "2021-01-01",
1735
- "filters" => [],
1736
- "metrics" => ["visits"],
1737
- "include" => %{"imports" => false, "compare" => "year_over_year"}
1738
- }
1739
-
1740
- response = do_query_success(conn, site, params)
1741
-
1742
- assert response["results"] == [
1743
- %{
1744
- "dimensions" => [],
1745
- "metrics" => [4],
1746
- "comparison" => %{"dimensions" => [], "metrics" => [0], "change" => [100]}
1747
- }
1748
- ]
1749
- end
1750
-
1751
- test "compares conversion rates", %{conn: conn, site: site} do
1752
- populate_stats(site, [
1753
- build(:pageview, user_id: @user_id, timestamp: ~N[2023-01-03T00:00:00]),
1754
- build(:pageview, user_id: @user_id, timestamp: ~N[2023-01-03T00:00:00]),
1755
- build(:pageview, timestamp: ~N[2023-01-03T00:00:00]),
1756
- build(:event, name: "Signup", timestamp: ~N[2023-01-03T00:00:00]),
1757
- build(:pageview, user_id: @user_id, timestamp: ~N[2023-01-02T00:00:00]),
1758
- build(:event, name: "Signup", timestamp: ~N[2023-01-02T00:00:00]),
1759
- build(:event, name: "Signup", timestamp: ~N[2023-01-02T00:00:00])
1760
- ])
1761
-
1762
- insert(:goal, site: site, event_name: "Signup")
1763
-
1764
- params = %{
1765
- "date_range" => "day",
1766
- "relative_date" => "2023-01-03",
1767
- "filters" => [["is", "event:goal", ["Signup"]]],
1768
- "metrics" => ["conversion_rate"],
1769
- "include" => %{"compare" => "previous_period"}
1770
- }
1771
-
1772
- response = do_query_success(conn, site, params)
1773
-
1774
- assert response["results"] == [
1775
- %{
1776
- "dimensions" => [],
1777
- "metrics" => [33.33],
1778
- "comparison" => %{"dimensions" => [], "metrics" => [66.67], "change" => [-33.3]}
1779
- }
1780
- ]
1781
- end
1782
- end
1783
- end