From d88722a91b881421cd8c48ba8f34b124278bc476 Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Fri, 15 Mar 2024 09:52:18 +0800 Subject: [PATCH 1/9] fix timezones --- lib/plausible/timezones.ex | 17 ++++++++++------- test/plausible/timezones_test.exs | 2 +- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/lib/plausible/timezones.ex b/lib/plausible/timezones.ex index 9aa030e3d..b9b69d2bf 100644 --- a/lib/plausible/timezones.ex +++ b/lib/plausible/timezones.ex @@ -8,15 +8,18 @@ defmodule Plausible.Timezones do @spec to_utc_datetime(NaiveDateTime.t(), String.t()) :: DateTime.t() def to_utc_datetime(naive_date_time, timezone) do - case Timex.to_datetime(naive_date_time, timezone) do - %DateTime{} = tz_dt -> - Timex.Timezone.convert(tz_dt, "UTC") + case DateTime.from_naive(naive_date_time, timezone) do + {:ok, date_time} -> + DateTime.shift_zone!(date_time, "Etc/UTC") - %Timex.AmbiguousDateTime{after: after_dt} -> - Timex.Timezone.convert(after_dt, "UTC") + {:gap, _before_dt, after_dt} -> + DateTime.shift_zone!(after_dt, "Etc/UTC") - {:error, {:could_not_resolve_timezone, _, _, _}} -> - Timex.Timezone.convert(naive_date_time, "UTC") + {:ambiguous, _first_dt, second_dt} -> + DateTime.shift_zone!(second_dt, "Etc/UTC") + + {:error, :time_zone_not_found} -> + DateTime.from_naive!(naive_date_time, "Etc/UTC") end end diff --git a/test/plausible/timezones_test.exs b/test/plausible/timezones_test.exs index 890d2e2f2..282241d54 100644 --- a/test/plausible/timezones_test.exs +++ b/test/plausible/timezones_test.exs @@ -23,7 +23,7 @@ defmodule Plausible.TimezonesTest do assert to_utc_datetime(~N[2022-09-11 00:00:00], "Etc/UTC") == ~U[2022-09-11 00:00:00Z] assert to_utc_datetime(~N[2022-09-11 00:00:00], "America/Santiago") == - ~U[2022-09-11 00:00:00Z] + ~U[2022-09-11 04:00:00Z] assert to_utc_datetime(~N[2023-10-29 00:00:00], "Atlantic/Azores") == ~U[2023-10-29 01:00:00Z] end From bbdf8979b00e3ffa0405b44cb79c145d980d9614 Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Sat, 16 Mar 2024 09:52:05 +0800 Subject: [PATCH 2/9] shift in the opposite direction in to_datetime_in_timezone --- lib/plausible/timezones.ex | 26 +++++++++++++++++++++----- test/plausible/timezones_test.exs | 16 +++++++++------- 2 files changed, 30 insertions(+), 12 deletions(-) diff --git a/lib/plausible/timezones.ex b/lib/plausible/timezones.ex index b9b69d2bf..67d96aa52 100644 --- a/lib/plausible/timezones.ex +++ b/lib/plausible/timezones.ex @@ -23,15 +23,31 @@ defmodule Plausible.Timezones do end end - @spec to_date_in_timezone(Date.t() | NaiveDateTime.t() | DateTime.t(), String.t()) :: Date.t() + @spec to_date_in_timezone(NaiveDateTime.t() | DateTime.t(), String.t()) :: Date.t() def to_date_in_timezone(dt, timezone) do - to_datetime_in_timezone(dt, timezone) |> Timex.to_date() + dt |> to_datetime_in_timezone(timezone) |> DateTime.to_date() end - @spec to_datetime_in_timezone(Date.t() | NaiveDateTime.t() | DateTime.t(), String.t()) :: + @doc """ + Represents a point in time in a different timezone. + Naive datetimes are assumed to be GMT. + + Examples: + + iex> to_datetime_in_timezone(~U[2024-03-16 01:50:45.180928Z], "Asia/Kuala_Lumpur") + #DateTime<2024-03-16 09:50:45.180928+08:00 +08 Asia/Kuala_Lumpur> + + """ + @spec to_datetime_in_timezone(NaiveDateTime.t() | DateTime.t(), String.t()) :: DateTime.t() - def to_datetime_in_timezone(dt, timezone) do - dt |> Timex.to_datetime("UTC") |> Timex.Timezone.convert(timezone) + def to_datetime_in_timezone(%NaiveDateTime{} = naive, timezone) do + naive + |> DateTime.from_naive!("Etc/UTC") + |> to_datetime_in_timezone(timezone) + end + + def to_datetime_in_timezone(%DateTime{} = dt, timezone) do + DateTime.shift_zone!(dt, timezone) end defp build_option(timezone_code, acc, now) do diff --git a/test/plausible/timezones_test.exs b/test/plausible/timezones_test.exs index 282241d54..f2e531cb4 100644 --- a/test/plausible/timezones_test.exs +++ b/test/plausible/timezones_test.exs @@ -3,6 +3,8 @@ defmodule Plausible.TimezonesTest do import Plausible.Timezones + doctest Plausible.Timezones, import: true + test "options/0 returns a list of timezones" do options = options() refute Enum.empty?(options) @@ -29,14 +31,14 @@ defmodule Plausible.TimezonesTest do end test "to_date_in_timezone/1" do - assert to_date_in_timezone(~D[2021-01-03], "Etc/UTC") == ~D[2021-01-03] assert to_date_in_timezone(~U[2015-01-13 13:00:07Z], "Etc/UTC") == ~D[2015-01-13] assert to_date_in_timezone(~N[2015-01-13 13:00:07], "Etc/UTC") == ~D[2015-01-13] - assert to_date_in_timezone(~N[2015-01-13 19:00:07], "Etc/GMT+12") == ~D[2015-01-14] + assert to_date_in_timezone(~N[2015-01-13 19:00:07], "Etc/GMT+12") == ~D[2015-01-13] + assert to_date_in_timezone(~N[2015-01-13 11:00:07], "Etc/GMT+12") == ~D[2015-01-12] + assert to_date_in_timezone(~N[2015-01-13 19:00:07], "Etc/GMT-12") == ~D[2015-01-14] end test "to_datetime_in_timezone/1" do - assert to_datetime_in_timezone(~D[2021-01-03], "Etc/UTC") == ~U[2021-01-03 00:00:00Z] assert to_datetime_in_timezone(~N[2015-01-13 13:00:07], "Etc/UTC") == ~U[2015-01-13 13:00:07Z] assert to_datetime_in_timezone(~N[2015-01-13 19:00:07], "Etc/GMT+12") == @@ -45,13 +47,13 @@ defmodule Plausible.TimezonesTest do second: 7, calendar: Calendar.ISO, month: 1, - day: 14, + day: 13, year: 2015, minute: 0, hour: 7, - time_zone: "Etc/GMT-12", - zone_abbr: "+12", - utc_offset: 43_200, + time_zone: "Etc/GMT+12", + zone_abbr: "-12", + utc_offset: -43_200, std_offset: 0 } From 0be28cf41d9b5bca81c7fb120cd7b82f252b1fe0 Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Sat, 16 Mar 2024 10:07:39 +0800 Subject: [PATCH 3/9] more tests --- lib/plausible/timezones.ex | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/plausible/timezones.ex b/lib/plausible/timezones.ex index 67d96aa52..1a171c7a0 100644 --- a/lib/plausible/timezones.ex +++ b/lib/plausible/timezones.ex @@ -37,6 +37,12 @@ defmodule Plausible.Timezones do iex> to_datetime_in_timezone(~U[2024-03-16 01:50:45.180928Z], "Asia/Kuala_Lumpur") #DateTime<2024-03-16 09:50:45.180928+08:00 +08 Asia/Kuala_Lumpur> + iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45.180928], "Asia/Kuala_Lumpur") + #DateTime<2024-03-16 09:50:45.180928+08:00 +08 Asia/Kuala_Lumpur> + + iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45.180928], "Etc/GMT-8") + #DateTime<2024-03-16 09:50:45.180928+08:00 +08 Etc/GMT-8> + """ @spec to_datetime_in_timezone(NaiveDateTime.t() | DateTime.t(), String.t()) :: DateTime.t() From 5e67f396579f9618b2b470a2a0f1e28dcb01891b Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Sat, 16 Mar 2024 12:38:03 +0800 Subject: [PATCH 4/9] eh --- lib/plausible/sites.ex | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/lib/plausible/sites.ex b/lib/plausible/sites.ex index 12d4235ad..8ea8374c6 100644 --- a/lib/plausible/sites.ex +++ b/lib/plausible/sites.ex @@ -199,24 +199,21 @@ defmodule Plausible.Sites do @doc """ Returns the date of the first recorded stat in the timezone configured by the user. This function does 2 transformations: - UTC %NaiveDateTime{} -> Local %DateTime{} -> Local %Date + Date -> UTC DateTime at 00:00 -> Local %DateTime{} -> Local %Date ## Examples iex> Plausible.Site.local_start_date(%Plausible.Site{stats_start_date: nil}) nil - iex> utc_start = ~N[2022-09-28 00:00:00] - iex> tz = "Europe/Helsinki" - iex> site = %Plausible.Site{stats_start_date: utc_start, timezone: tz} + iex> site = %Plausible.Site{stats_start_date: ~D[2022-09-28], timezone: "Europe/Helsinki"} iex> Plausible.Site.local_start_date(site) ~D[2022-09-28] - iex> utc_start = ~N[2022-09-28 00:00:00] - iex> tz = "America/Los_Angeles" - iex> site = %Plausible.Site{stats_start_date: utc_start, timezone: tz} + iex> site = %Plausible.Site{stats_start_date: ~D[2022-09-28], timezone: "America/Los_Angeles"} iex> Plausible.Site.local_start_date(site) ~D[2022-09-27] + """ @spec local_start_date(Site.t()) :: Date.t() | nil def local_start_date(site) do From ddbb79fa1a20fb3596ae5a6cbc33c0f56b8b2bc7 Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Sat, 16 Mar 2024 12:55:34 +0800 Subject: [PATCH 5/9] eh --- lib/plausible/sites.ex | 9 +++++---- lib/plausible/timezones.ex | 10 ++++++++-- test/plausible/site/sites_test.exs | 1 + 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/lib/plausible/sites.ex b/lib/plausible/sites.ex index 8ea8374c6..442ac2348 100644 --- a/lib/plausible/sites.ex +++ b/lib/plausible/sites.ex @@ -198,20 +198,21 @@ defmodule Plausible.Sites do @doc """ Returns the date of the first recorded stat in the timezone configured by the user. - This function does 2 transformations: + This function does 3 transformations: Date -> UTC DateTime at 00:00 -> Local %DateTime{} -> Local %Date ## Examples - iex> Plausible.Site.local_start_date(%Plausible.Site{stats_start_date: nil}) + iex> %Plausible.Site{stats_start_date: nil} = site = Plausible.Factory.insert(:site) + iex> Plausible.Sites.local_start_date(site) nil iex> site = %Plausible.Site{stats_start_date: ~D[2022-09-28], timezone: "Europe/Helsinki"} - iex> Plausible.Site.local_start_date(site) + iex> Plausible.Sites.local_start_date(site) ~D[2022-09-28] iex> site = %Plausible.Site{stats_start_date: ~D[2022-09-28], timezone: "America/Los_Angeles"} - iex> Plausible.Site.local_start_date(site) + iex> Plausible.Sites.local_start_date(site) ~D[2022-09-27] """ diff --git a/lib/plausible/timezones.ex b/lib/plausible/timezones.ex index 1a171c7a0..c213e6167 100644 --- a/lib/plausible/timezones.ex +++ b/lib/plausible/timezones.ex @@ -23,7 +23,7 @@ defmodule Plausible.Timezones do end end - @spec to_date_in_timezone(NaiveDateTime.t() | DateTime.t(), String.t()) :: Date.t() + @spec to_date_in_timezone(NaiveDateTime.t() | DateTime.t() | Date.t(), String.t()) :: Date.t() def to_date_in_timezone(dt, timezone) do dt |> to_datetime_in_timezone(timezone) |> DateTime.to_date() end @@ -44,7 +44,7 @@ defmodule Plausible.Timezones do #DateTime<2024-03-16 09:50:45.180928+08:00 +08 Etc/GMT-8> """ - @spec to_datetime_in_timezone(NaiveDateTime.t() | DateTime.t(), String.t()) :: + @spec to_datetime_in_timezone(NaiveDateTime.t() | DateTime.t() | Date.t(), String.t()) :: DateTime.t() def to_datetime_in_timezone(%NaiveDateTime{} = naive, timezone) do naive @@ -52,6 +52,12 @@ defmodule Plausible.Timezones do |> to_datetime_in_timezone(timezone) end + def to_datetime_in_timezone(%Date{} = date, timezone) do + date + |> DateTime.new!(~T[00:00:00], "Etc/UTC") + |> to_datetime_in_timezone(timezone) + end + def to_datetime_in_timezone(%DateTime{} = dt, timezone) do DateTime.shift_zone!(dt, timezone) end diff --git a/test/plausible/site/sites_test.exs b/test/plausible/site/sites_test.exs index e623ffdc5..e52f1ba59 100644 --- a/test/plausible/site/sites_test.exs +++ b/test/plausible/site/sites_test.exs @@ -2,6 +2,7 @@ defmodule Plausible.SitesTest do use Plausible.DataCase alias Plausible.Sites + doctest Sites, import: true describe "create a site" do test "creates a site" do From 3bbf28faca291f8b93a927c08ea5ff0faa842c13 Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Sat, 16 Mar 2024 13:25:22 +0800 Subject: [PATCH 6/9] eh --- lib/plausible/timezones.ex | 90 +++++++++++++++++++++++++++++++++----- 1 file changed, 78 insertions(+), 12 deletions(-) diff --git a/lib/plausible/timezones.ex b/lib/plausible/timezones.ex index c213e6167..b76e75584 100644 --- a/lib/plausible/timezones.ex +++ b/lib/plausible/timezones.ex @@ -6,23 +6,83 @@ defmodule Plausible.Timezones do |> Enum.sort_by(& &1[:offset], :desc) end - @spec to_utc_datetime(NaiveDateTime.t(), String.t()) :: DateTime.t() - def to_utc_datetime(naive_date_time, timezone) do + @doc """ + Represents a point in wall time as UTC. + + iex> to_utc_datetime(~N[2024-03-16 09:50:45], "Asia/Kuala_Lumpur") + ~U[2024-03-16 01:50:45Z] + + When the point in wall time is ambiguous - for instance during changing from summer to winter time - + the larger UTC timestamp is returned by default. + + # before the CEST -> CET overlap + iex> to_utc_datetime(~N[2018-10-28 01:59:59], "Europe/Copenhagen") + ~U[2018-10-27 23:59:59Z] + + # during + iex> to_utc_datetime(~N[2018-10-28 02:00:00], "Europe/Copenhagen") + ~U[2018-10-28 01:00:00Z] + + iex> to_utc_datetime(~N[2018-10-28 02:00:00], "Europe/Copenhagen", :up) + ~U[2018-10-28 01:00:00Z] + + iex> to_utc_datetime(~N[2018-10-28 02:00:00], "Europe/Copenhagen", :down) + ~U[2018-10-28 00:00:00Z] + + iex> to_utc_datetime(~N[2018-10-28 02:30:00], "Europe/Copenhagen") + ~U[2018-10-28 01:30:00Z] + + # after + iex> to_utc_datetime(~N[2018-10-28 03:00:00], "Europe/Copenhagen") + ~U[2018-10-28 02:00:00Z] + + When there is a gap in wall time - for instance in spring when the clocks are turned forward - + the larger UTC timestamp (at the end of the gap) is returned by default as well. + + # before the CET -> CEST gap + iex> to_utc_datetime(~N[2019-03-31 01:59:59], "Europe/Copenhagen") + ~U[2019-03-31 00:59:59Z] + + # during + iex> to_utc_datetime(~N[2019-03-31 02:00:00], "Europe/Copenhagen") + ~U[2019-03-31 01:00:00Z] + + iex> to_utc_datetime(~N[2019-03-31 02:30:00], "Europe/Copenhagen", :up) + ~U[2019-03-31 01:00:00Z] + + iex> to_utc_datetime(~N[2019-03-31 02:30:00], "Europe/Copenhagen", :down) + ~U[2019-03-31 00:59:59.999999Z] + + # after + iex> to_utc_datetime(~N[2019-03-31 03:00:00], "Europe/Copenhagen") + ~U[2019-03-31 01:00:00Z] + + If the supplied time zone is invalid, the wall time is assumed to be GMT. + + iex> to_utc_datetime(~N[2024-03-16 09:50:45], "Europe/Asia") + ~U[2024-03-16 09:50:45Z] + + """ + @spec to_utc_datetime(NaiveDateTime.t(), String.t(), :up | :down) :: DateTime.t() + def to_utc_datetime(naive_date_time, timezone, direction \\ :up) do case DateTime.from_naive(naive_date_time, timezone) do {:ok, date_time} -> DateTime.shift_zone!(date_time, "Etc/UTC") - {:gap, _before_dt, after_dt} -> - DateTime.shift_zone!(after_dt, "Etc/UTC") + {:gap, before_dt, after_dt} -> + DateTime.shift_zone!(pick_datetime(direction, before_dt, after_dt), "Etc/UTC") - {:ambiguous, _first_dt, second_dt} -> - DateTime.shift_zone!(second_dt, "Etc/UTC") + {:ambiguous, first_dt, second_dt} -> + DateTime.shift_zone!(pick_datetime(direction, first_dt, second_dt), "Etc/UTC") {:error, :time_zone_not_found} -> DateTime.from_naive!(naive_date_time, "Etc/UTC") end end + defp pick_datetime(:up, _, dt), do: dt + defp pick_datetime(:down, dt, _), do: dt + @spec to_date_in_timezone(NaiveDateTime.t() | DateTime.t() | Date.t(), String.t()) :: Date.t() def to_date_in_timezone(dt, timezone) do dt |> to_datetime_in_timezone(timezone) |> DateTime.to_date() @@ -34,14 +94,20 @@ defmodule Plausible.Timezones do Examples: - iex> to_datetime_in_timezone(~U[2024-03-16 01:50:45.180928Z], "Asia/Kuala_Lumpur") - #DateTime<2024-03-16 09:50:45.180928+08:00 +08 Asia/Kuala_Lumpur> + iex> to_datetime_in_timezone(~U[2024-03-16 01:50:45Z], "Asia/Kuala_Lumpur") + #DateTime<2024-03-16 09:50:45+08:00 +08 Asia/Kuala_Lumpur> + + iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45], "Asia/Kuala_Lumpur") + #DateTime<2024-03-16 09:50:45+08:00 +08 Asia/Kuala_Lumpur> + + # see https://stackoverflow.com/questions/53076575/time-zones-etc-gmt-why-it-is-other-way-round + iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45], "Etc/GMT-8") + #DateTime<2024-03-16 09:50:45+08:00 +08 Etc/GMT-8> - iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45.180928], "Asia/Kuala_Lumpur") - #DateTime<2024-03-16 09:50:45.180928+08:00 +08 Asia/Kuala_Lumpur> + iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45], "GMT+8") + #DateTime<2024-03-16 09:50:45+08:00 +08 GMT+8> - iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45.180928], "Etc/GMT-8") - #DateTime<2024-03-16 09:50:45.180928+08:00 +08 Etc/GMT-8> + # amniguous """ @spec to_datetime_in_timezone(NaiveDateTime.t() | DateTime.t() | Date.t(), String.t()) :: From 98d4b7b3113e8174c9f1c1ba245a91e2f3f03652 Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Sat, 16 Mar 2024 13:26:06 +0800 Subject: [PATCH 7/9] eh --- lib/plausible/timezones.ex | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/plausible/timezones.ex b/lib/plausible/timezones.ex index b76e75584..2dc467da5 100644 --- a/lib/plausible/timezones.ex +++ b/lib/plausible/timezones.ex @@ -107,8 +107,6 @@ defmodule Plausible.Timezones do iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45], "GMT+8") #DateTime<2024-03-16 09:50:45+08:00 +08 GMT+8> - # amniguous - """ @spec to_datetime_in_timezone(NaiveDateTime.t() | DateTime.t() | Date.t(), String.t()) :: DateTime.t() From f8e53b528ba07fcef12e5a9acd5f95699a648a6b Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Sat, 16 Mar 2024 14:19:57 +0800 Subject: [PATCH 8/9] cleanup --- lib/plausible/timezones.ex | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/lib/plausible/timezones.ex b/lib/plausible/timezones.ex index 2dc467da5..4ce730d97 100644 --- a/lib/plausible/timezones.ex +++ b/lib/plausible/timezones.ex @@ -90,12 +90,7 @@ defmodule Plausible.Timezones do @doc """ Represents a point in time in a different timezone. - Naive datetimes are assumed to be GMT. - - Examples: - - iex> to_datetime_in_timezone(~U[2024-03-16 01:50:45Z], "Asia/Kuala_Lumpur") - #DateTime<2024-03-16 09:50:45+08:00 +08 Asia/Kuala_Lumpur> + Naive datetimes are assumed to be in GMT timezone. iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45], "Asia/Kuala_Lumpur") #DateTime<2024-03-16 09:50:45+08:00 +08 Asia/Kuala_Lumpur> From 5844a84cc471245cb6cb9fb4ca9565af32daea09 Mon Sep 17 00:00:00 2001 From: ruslandoga <67764432+ruslandoga@users.noreply.github.com> Date: Sun, 17 Mar 2024 12:49:31 +0800 Subject: [PATCH 9/9] improve tests/docs --- lib/plausible/timezones.ex | 25 ++++++++++++++++++------- test/plausible/timezones_test.exs | 26 ++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 7 deletions(-) diff --git a/lib/plausible/timezones.ex b/lib/plausible/timezones.ex index 4ce730d97..b78f7fb43 100644 --- a/lib/plausible/timezones.ex +++ b/lib/plausible/timezones.ex @@ -7,13 +7,13 @@ defmodule Plausible.Timezones do end @doc """ - Represents a point in wall time as UTC. + Represents wall time as Etc/UTC. iex> to_utc_datetime(~N[2024-03-16 09:50:45], "Asia/Kuala_Lumpur") ~U[2024-03-16 01:50:45Z] - When the point in wall time is ambiguous - for instance during changing from summer to winter time - - the larger UTC timestamp is returned by default. + When wall time is ambiguous - for instance during changing from summer to winter time - + the larger Etc/UTC timestamp is returned by default. # before the CEST -> CET overlap iex> to_utc_datetime(~N[2018-10-28 01:59:59], "Europe/Copenhagen") @@ -37,7 +37,7 @@ defmodule Plausible.Timezones do ~U[2018-10-28 02:00:00Z] When there is a gap in wall time - for instance in spring when the clocks are turned forward - - the larger UTC timestamp (at the end of the gap) is returned by default as well. + the larger Etc/UTC timestamp (at the end of the gap) is returned by default as well. # before the CET -> CEST gap iex> to_utc_datetime(~N[2019-03-31 01:59:59], "Europe/Copenhagen") @@ -57,7 +57,7 @@ defmodule Plausible.Timezones do iex> to_utc_datetime(~N[2019-03-31 03:00:00], "Europe/Copenhagen") ~U[2019-03-31 01:00:00Z] - If the supplied time zone is invalid, the wall time is assumed to be GMT. + If the supplied time zone is invalid, the wall time is assumed to be Etc/UTC. iex> to_utc_datetime(~N[2024-03-16 09:50:45], "Europe/Asia") ~U[2024-03-16 09:50:45Z] @@ -83,14 +83,22 @@ defmodule Plausible.Timezones do defp pick_datetime(:up, _, dt), do: dt defp pick_datetime(:down, dt, _), do: dt + @doc """ + Same as `to_datetime_in_timezone/2` but extracts the date from the result. + + iex> to_date_in_timezone(~N[2024-03-16 01:50:45], "Asia/Kuala_Lumpur") + ~D[2024-03-16] + + """ @spec to_date_in_timezone(NaiveDateTime.t() | DateTime.t() | Date.t(), String.t()) :: Date.t() def to_date_in_timezone(dt, timezone) do dt |> to_datetime_in_timezone(timezone) |> DateTime.to_date() end @doc """ - Represents a point in time in a different timezone. - Naive datetimes are assumed to be in GMT timezone. + Represents a timestamp in a different timezone. + Naive datetimes are assumed to be in Etc/UTC timezone. + Dates are assumed to mean a Etc/UTC midnight. iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45], "Asia/Kuala_Lumpur") #DateTime<2024-03-16 09:50:45+08:00 +08 Asia/Kuala_Lumpur> @@ -102,6 +110,9 @@ defmodule Plausible.Timezones do iex> to_datetime_in_timezone(~N[2024-03-16 01:50:45], "GMT+8") #DateTime<2024-03-16 09:50:45+08:00 +08 GMT+8> + iex> to_datetime_in_timezone(~D[2018-10-28], "Europe/Copenhagen") + #DateTime<2018-10-28 02:00:00+02:00 CEST Europe/Copenhagen> + """ @spec to_datetime_in_timezone(NaiveDateTime.t() | DateTime.t() | Date.t(), String.t()) :: DateTime.t() diff --git a/test/plausible/timezones_test.exs b/test/plausible/timezones_test.exs index f2e531cb4..4a60e8859 100644 --- a/test/plausible/timezones_test.exs +++ b/test/plausible/timezones_test.exs @@ -31,6 +31,7 @@ defmodule Plausible.TimezonesTest do end test "to_date_in_timezone/1" do + assert to_date_in_timezone(~D[2021-01-03], "Etc/UTC") == ~D[2021-01-03] assert to_date_in_timezone(~U[2015-01-13 13:00:07Z], "Etc/UTC") == ~D[2015-01-13] assert to_date_in_timezone(~N[2015-01-13 13:00:07], "Etc/UTC") == ~D[2015-01-13] assert to_date_in_timezone(~N[2015-01-13 19:00:07], "Etc/GMT+12") == ~D[2015-01-13] @@ -39,6 +40,7 @@ defmodule Plausible.TimezonesTest do end test "to_datetime_in_timezone/1" do + assert to_datetime_in_timezone(~D[2021-01-03], "Etc/UTC") == ~U[2021-01-03 00:00:00Z] assert to_datetime_in_timezone(~N[2015-01-13 13:00:07], "Etc/UTC") == ~U[2015-01-13 13:00:07Z] assert to_datetime_in_timezone(~N[2015-01-13 19:00:07], "Etc/GMT+12") == @@ -71,5 +73,29 @@ defmodule Plausible.TimezonesTest do utc_offset: 3600, std_offset: 3600 } + + ambiguous = [ + ~N[2018-10-28 00:00:00], + ~N[2018-10-28 00:30:00], + ~N[2018-10-28 01:00:00], + ~N[2018-10-28 01:30:00] + ] + + assert for(t <- ambiguous, do: inspect(to_datetime_in_timezone(t, "Europe/Copenhagen"))) == [ + "#DateTime<2018-10-28 02:00:00+02:00 CEST Europe/Copenhagen>", + "#DateTime<2018-10-28 02:30:00+02:00 CEST Europe/Copenhagen>", + "#DateTime<2018-10-28 02:00:00+01:00 CET Europe/Copenhagen>", + "#DateTime<2018-10-28 02:30:00+01:00 CET Europe/Copenhagen>" + ] + + gap = [ + ~N[2019-03-31 00:59:59], + ~N[2019-03-31 01:00:00] + ] + + assert for(t <- gap, do: inspect(to_datetime_in_timezone(t, "Europe/Copenhagen"))) == [ + "#DateTime<2019-03-31 01:59:59+01:00 CET Europe/Copenhagen>", + "#DateTime<2019-03-31 03:00:00+02:00 CEST Europe/Copenhagen>" + ] end end