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
Add controller-level tests for timezone handling in Query (#5809)
Uku Taht9e3102d819db
diff --git a/test/plausible_web/controllers/api/external_stats_controller/query_timezone_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_timezone_test.exsnew file mode 100644index 0000000000..c1c35542ec--- /dev/null+++ b/test/plausible_web/controllers/api/external_stats_controller/query_timezone_test.exs@@ -0,0 +1,296 @@+defmodule PlausibleWeb.Api.ExternalStatsController.QueryTimezoneTest do+ use PlausibleWeb.ConnCase+ use Plausible.Teams.Test++ setup [:create_user, :create_site, :create_api_key, :use_api_key]++ describe "query parser timezone conversion for date ranges" do+ test "uses site timezone to determine 'today' (negative offset)", %{+ conn: conn,+ site: site+ } do+ site = Plausible.Repo.update!(Ecto.Changeset.change(site, timezone: "America/New_York"))++ populate_stats(site, [+ build(:pageview, timestamp: ~N[2024-01-01 12:00:00]),+ build(:pageview, timestamp: ~N[2024-01-02 12:00:00]),+ build(:pageview, timestamp: ~N[2024-01-02 14:00:00])+ ])++ # 9pm on Jan 1st, 2024 in EST (UTC-5)+ Plausible.Stats.Query.Test.fix_now(~U[2024-01-02 02:00:00Z])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["pageviews"],+ "date_range" => "day"+ })++ response = json_response(conn, 200)++ assert [%{"metrics" => [pageview_count], "dimensions" => []}] = response["results"]+ assert pageview_count == 1+ end++ test "uses site timezone to determine 'today' (positive offset)", %{+ conn: conn,+ site: site+ } do+ site = Plausible.Repo.update!(Ecto.Changeset.change(site, timezone: "Asia/Tokyo"))++ populate_stats(site, [+ build(:pageview, timestamp: ~N[2024-01-01 10:00:00]),+ build(:pageview, timestamp: ~N[2024-01-01 12:00:00]),+ build(:pageview, timestamp: ~N[2024-01-02 12:00:00])+ ])++ # 01:00 on Jan 2nd, 2024 in JST (UTC+9)+ Plausible.Stats.Query.Test.fix_now(~U[2024-01-01 16:00:00Z])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["pageviews"],+ "date_range" => "day"+ })++ response = json_response(conn, 200)++ assert [%{"metrics" => [pageview_count], "dimensions" => []}] = response["results"]+ assert pageview_count == 1+ end++ test "handles timezone gap when date starts at non-existent midnight (spring forward)", %{+ conn: conn,+ site: site+ } do+ # On 2022-09-11 in America/Santiago, clocks spring forward from 00:00 to 01:00+ # So midnight doesn't exist - it's a "gap"+ site = Plausible.Repo.update!(Ecto.Changeset.change(site, timezone: "America/Santiago"))++ populate_stats(site, [+ # 2022-09-11 03:59:00 UTC = 2022-09-10 23:59:00 CLT (before gap)+ build(:pageview, timestamp: ~N[2022-09-11 03:59:00]),+ # 2022-09-11 04:00:00 UTC = 2022-09-11 01:00:00 CLT (after gap - midnight doesn't exist)+ build(:pageview, timestamp: ~N[2022-09-11 04:00:00]),+ # 2022-09-11 05:00:00 UTC = 2022-09-11 02:00:00 CLT (well after gap)+ build(:pageview, timestamp: ~N[2022-09-11 05:00:00])+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["pageviews"],+ "date_range" => ["2022-09-11", "2022-09-11"]+ })++ response = json_response(conn, 200)++ # Should include pageviews from 01:00:00 CLT onwards (after the gap)+ assert [%{"metrics" => [pageview_count], "dimensions" => []}] = response["results"]+ assert pageview_count == 2+ end++ test "handles ambiguous datetime at start of range (fall back)", %{+ conn: conn,+ site: site+ } do+ # On 2023-11-05 in America/Havana, clocks fall back at 01:00 CDT to 00:00 EST+ # So 00:00:00 happens twice - it's "ambiguous"+ site = Plausible.Repo.update!(Ecto.Changeset.change(site, timezone: "America/Havana"))++ populate_stats(site, [+ # 2023-11-05 04:30:00 UTC = 2023-11-05 00:30:00 CDT (in first occurrence hour)+ build(:pageview, timestamp: ~N[2023-11-05 04:30:00]),+ # 2023-11-05 05:30:00 UTC = 2023-11-05 00:30:00 EST (in second occurrence hour)+ build(:pageview, timestamp: ~N[2023-11-05 05:30:00]),+ # 2023-11-05 06:30:00 UTC = 2023-11-05 01:30:00 EST+ build(:pageview, timestamp: ~N[2023-11-05 06:30:00])+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["pageviews"],+ "date_range" => ["2023-11-05", "2023-11-05"]+ })++ response = json_response(conn, 200)++ # Range is 05:00:00 UTC to 04:59:59 UTC next day+ # Should include pageviews at 05:30 and 06:30 (2 pageviews)+ assert [%{"metrics" => [pageview_count], "dimensions" => []}] = response["results"]+ assert pageview_count == 2+ end++ test "handles ambiguous datetime at end of range (fall back)", %{+ conn: conn,+ site: site+ } do+ # On 2024-03-23 in America/Asuncion, clocks fall back creating ambiguous times+ site = Plausible.Repo.update!(Ecto.Changeset.change(site, timezone: "America/Asuncion"))++ populate_stats(site, [+ # 2024-03-23 12:00:00 UTC = 2024-03-23 09:00:00 PYT (during the day)+ build(:pageview, timestamp: ~N[2024-03-23 12:00:00]),+ # 2024-03-24 02:58:00 UTC = 2024-03-23 23:58:00 PYT (before end of day)+ build(:pageview, timestamp: ~N[2024-03-24 02:58:00]),+ # 2024-03-24 03:00:00 UTC = 2024-03-24 00:00:00 PYT (next day)+ build(:pageview, timestamp: ~N[2024-03-24 03:00:00])+ ])++ # Query for just the 23rd+ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["pageviews"],+ "date_range" => ["2024-03-23", "2024-03-23"]+ })++ response = json_response(conn, 200)++ # Should include first 2 pageviews but not the third (which is on the 24th)+ assert [%{"metrics" => [pageview_count], "dimensions" => []}] = response["results"]+ assert pageview_count == 2+ end+ end++ describe "legacy_time_on_page_cutoff timezone handling" do+ setup [:create_user, :create_site, :create_api_key, :use_api_key]++ setup %{site: site} = context do+ FunWithFlags.enable(:new_time_on_page, for_actor: site)+ context+ end++ test "uses site timezone for legacy_time_on_page_cutoff conversion", %{+ conn: conn,+ site: site+ } do+ # Set site to EST timezone (UTC-5)+ site = Plausible.Repo.update!(Ecto.Changeset.change(site, timezone: "America/New_York"))+ # Cutoff at 2024-01-01 in EST = 2024-01-01 05:00:00 UTC+ site = Plausible.Sites.update_legacy_time_on_page_cutoff!(site, ~D[2024-01-01])++ populate_stats(site, [+ # 2024-01-01 03:00:00 UTC = 2023-12-31 22:00:00 EST (before cutoff in EST)+ build(:pageview, user_id: 1, timestamp: ~N[2024-01-01 03:00:00]),+ build(:pageview, user_id: 1, pathname: "/exit", timestamp: ~N[2024-01-01 03:10:00]),+ # 2024-01-01 06:00:00 UTC = 2024-01-01 01:00:00 EST (after cutoff in EST)+ build(:pageview, user_id: 2, timestamp: ~N[2024-01-01 06:00:00]),+ build(:engagement,+ user_id: 2,+ timestamp: ~N[2024-01-01 06:05:00],+ engagement_time: 90_000+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["time_on_page"],+ "date_range" => "all",+ "dimensions" => ["event:page"]+ })++ response = json_response(conn, 200)++ # First pageview (03:00 < 05:00) uses legacy: 600s+ # Second pageview (06:00 > 05:00) uses new metric: merged (600 + 90) / 2 = 345s+ assert [+ %{"metrics" => [345], "dimensions" => ["/"]},+ %{"metrics" => [nil], "dimensions" => ["/exit"]}+ ] = response["results"]+ end++ test "handles timezone gap in legacy_time_on_page_cutoff date", %{+ conn: conn,+ site: site+ } do+ # On 2022-09-11 in America/Santiago, midnight doesn't exist (gap)+ # When converting 00:00:00 on 2022-09-11 to datetime, it should use just_before+ # which is 2022-09-10 23:59:59.999999-04:00 CLT+ site = Plausible.Repo.update!(Ecto.Changeset.change(site, timezone: "America/Santiago"))+ site = Plausible.Sites.update_legacy_time_on_page_cutoff!(site, ~D[2022-09-11])++ populate_stats(site, [+ # Before cutoff (03:30 < 03:59:59) - will use legacy time_on_page (based on exit)+ build(:pageview, user_id: 1, timestamp: ~N[2022-09-11 03:30:00]),+ build(:pageview, user_id: 1, pathname: "/exit", timestamp: ~N[2022-09-11 03:40:00]),+ # After cutoff (05:00 > 03:59:59) - will use new time_on_page (based on engagement)+ build(:pageview, user_id: 2, timestamp: ~N[2022-09-11 05:00:00]),+ build(:engagement,+ user_id: 2,+ timestamp: ~N[2022-09-11 05:05:00],+ engagement_time: 60_000+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["time_on_page"],+ "date_range" => "all",+ "dimensions" => ["event:page"]+ })++ response = json_response(conn, 200)++ # First pageview (before cutoff) uses legacy: 600s+ # Second pageview (after cutoff) uses new metric but it merges both: (600 + 60) / 2 = 330s+ assert [+ %{"metrics" => [330], "dimensions" => ["/"]},+ %{"metrics" => [nil], "dimensions" => ["/exit"]}+ ] = response["results"]+ end++ test "handles ambiguous datetime in legacy_time_on_page_cutoff date", %{+ conn: conn,+ site: site+ } do+ # On 2023-11-05 in America/Havana, 00:00:00 happens twice (ambiguous)+ # When converting 00:00:00 to datetime, it should use first_datetime+ # first_datetime = 2023-11-05 00:00:00-04:00 CDT = 2023-11-05 04:00:00 UTC+ site = Plausible.Repo.update!(Ecto.Changeset.change(site, timezone: "America/Havana"))+ site = Plausible.Sites.update_legacy_time_on_page_cutoff!(site, ~D[2023-11-05])++ populate_stats(site, [+ # Before cutoff (03:30 < 04:00) - will use legacy time_on_page+ build(:pageview, user_id: 1, timestamp: ~N[2023-11-05 03:30:00]),+ build(:pageview, user_id: 1, pathname: "/exit", timestamp: ~N[2023-11-05 03:40:00]),+ # After cutoff (04:30 > 04:00) - will use new time_on_page+ build(:pageview, user_id: 2, timestamp: ~N[2023-11-05 04:30:00]),+ build(:engagement,+ user_id: 2,+ timestamp: ~N[2023-11-05 04:35:00],+ engagement_time: 90_000+ ),+ # Also after cutoff (05:30 > 04:00) - will use new time_on_page+ build(:pageview, user_id: 3, timestamp: ~N[2023-11-05 05:30:00]),+ build(:engagement,+ user_id: 3,+ timestamp: ~N[2023-11-05 05:35:00],+ engagement_time: 30_000+ )+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "metrics" => ["time_on_page"],+ "date_range" => "all",+ "dimensions" => ["event:page"]+ })++ response = json_response(conn, 200)++ # First pageview (before cutoff) uses legacy: 600s+ # Other pageviews (after cutoff) use new metric, merged: (600 + 90 + 30) / 3 = 240s+ assert [+ %{"metrics" => [240], "dimensions" => ["/"]},+ %{"metrics" => [nil], "dimensions" => ["/exit"]}+ ] = response["results"]+ end+ end+enddiff --git a/test/plausible_web/controllers/api/stats_controller/main_graph_test.exs b/test/plausible_web/controllers/api/stats_controller/main_graph_test.exsindex 6ffc46e8f9..ff0d11daa1 100644--- a/test/plausible_web/controllers/api/stats_controller/main_graph_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/main_graph_test.exs@@ -1536,22 +1536,6 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest doassert 2 == Enum.sum(comparison_plot)end- test "bugfix: don't crash when timezone gap occurs", %{conn: conn, user: user} do- site = new_site(owner: user, timezone: "America/Santiago")-- populate_stats(site, [- build(:pageview, timestamp: relative_time(minute: -5))- ])-- conn =- get(- conn,- "/api/stats/#{site.domain}/main-graph?period=custom&from=2022-09-11&to=2022-09-21&date=2023-03-15&with_imported=true"- )-- assert %{"plot" => _} = json_response(conn, 200)- end-test "does not return imported data when with_imported is set to false when comparing", %{conn: conn,site: sitediff --git a/test/plausible_web/controllers/api/stats_controller/regions_test.exs b/test/plausible_web/controllers/api/stats_controller/regions_test.exsindex a78fea91f1..b3ba4a238d 100644--- a/test/plausible_web/controllers/api/stats_controller/regions_test.exs+++ b/test/plausible_web/controllers/api/stats_controller/regions_test.exs@@ -94,25 +94,5 @@ defmodule PlausibleWeb.Api.StatsController.RegionsTest doassert resp = response(conn, 400)assert resp =~ "Failed to parse 'to' argument."end-- test "bugfix: don't crash on ambiguous date time", %{conn: conn, user: user} do- # The site has timezone set to Azores.- # Given it's 28th Nov and there's 30 day range, the starting day falls on 29th Oct- # which coincides with daylight savings time change there:- # https://www.timeanddate.com/time/change/portugal/ponta-delgada-azores.- site = new_site(owner: user, timezone: "Atlantic/Azores")-- populate_stats(site, [- build(:pageview, timestamp: relative_time(minute: -5))- ])-- conn =- get(- conn,- "/api/stats/#{site.domain}/regions?period=30d&date=2023-11-28&with_imported=true"- )-- assert json_response(conn, 200)- endendend