Handle comparison of today and 24h against a date range (#6213)

* Handle comparison of today and 24h against a date range

* Remove unnecessary clauses from `DateTimeRange`

* Add tests for mixing dates and datetimes in `DateTimeRange.new!`

Author: zoldar

lib/plausible/stats/comparisons.ex

@@ -166,6 +166,16 @@ defmodule Plausible.Stats.Comparisons do
     DateTimeRange.new!(comparison_start, comparison_end)
   end
 
+  defp get_comparison_datetime_range(
+         %Query{
+           input_date_range: input_range,
+           include: %{compare: {:date_range, from_date, to_date}}
+         } = source_query
+       )
+       when input_range in [:"24h", :day] do
+    DateTimeRange.new!(from_date, to_date, source_query.timezone)
+  end
+
   defp get_comparison_date_range(%Query{include: %{compare: :year_over_year}} = source_query) do
     source_date_range = Query.date_range(source_query, trim_trailing: true)
 

test/plausible/stats/comparisons_test.exs

@@ -496,6 +496,40 @@ defmodule Plausible.Stats.ComparisonsTest do
       assert comparison_query.utc_time_range.last == ~U[2023-03-14 18:30:00Z]
     end
 
+    test "custom time zone works with 24h comparison and a custom date range" do
+      site = insert(:site, timezone: "US/Eastern")
+
+      query =
+        QueryBuilder.build!(site,
+          metrics: [:visitors],
+          input_date_range: :"24h",
+          include: [compare: {:date_range, ~D[2023-02-15], ~D[2023-02-18]}],
+          now: ~U[2023-03-15 18:30:00Z]
+        )
+
+      comparison_query = Comparisons.get_comparison_query(query)
+
+      assert comparison_query.utc_time_range.first == ~U[2023-02-15 05:00:00Z]
+      assert comparison_query.utc_time_range.last == ~U[2023-02-19 04:59:59Z]
+    end
+
+    test "custom time zone works with day/today comparison and a custom date range" do
+      site = insert(:site, timezone: "US/Eastern")
+
+      query =
+        QueryBuilder.build!(site,
+          metrics: [:visitors],
+          input_date_range: :day,
+          include: [compare: {:date_range, ~D[2023-02-15], ~D[2023-02-18]}],
+          now: ~U[2023-03-15 18:30:00Z]
+        )
+
+      comparison_query = Comparisons.get_comparison_query(query)
+
+      assert comparison_query.utc_time_range.first == ~U[2023-02-15 05:00:00Z]
+      assert comparison_query.utc_time_range.last == ~U[2023-02-19 04:59:59Z]
+    end
+
     test "shifts back 24h period to match day of week when mode is previous_period with match_day_of_week",
          %{site: site} do
       query =
@@ -516,5 +550,39 @@ defmodule Plausible.Stats.ComparisonsTest do
       assert comparison_query.utc_time_range.first == ~U[2023-03-07 18:30:00Z]
       assert comparison_query.utc_time_range.last == ~U[2023-03-08 18:30:00Z]
     end
+
+    test "handles custom date range comparison against 24h period", %{site: site} do
+      query =
+        QueryBuilder.build!(site,
+          metrics: [:visitors],
+          input_date_range: :"24h",
+          include: [compare: {:date_range, ~D[2023-02-15], ~D[2023-02-18]}],
+
+          # Wednesday
+          now: ~U[2023-03-15 18:30:00Z]
+        )
+
+      comparison_query = Comparisons.get_comparison_query(query)
+
+      assert comparison_query.utc_time_range.first == ~U[2023-02-15 00:00:00Z]
+      assert comparison_query.utc_time_range.last == ~U[2023-02-18 23:59:59Z]
+    end
+
+    test "handles custom date range comparison day (today) period", %{site: site} do
+      query =
+        QueryBuilder.build!(site,
+          metrics: [:visitors],
+          input_date_range: :day,
+          include: [compare: {:date_range, ~D[2023-02-15], ~D[2023-02-18]}],
+
+          # Wednesday
+          now: ~U[2023-03-15 18:30:00Z]
+        )
+
+      comparison_query = Comparisons.get_comparison_query(query)
+
+      assert comparison_query.utc_time_range.first == ~U[2023-02-15 00:00:00Z]
+      assert comparison_query.utc_time_range.last == ~U[2023-02-18 23:59:59Z]
+    end
   end
 end

test/plausible/stats/datetime_range_test.exs

@@ -46,6 +46,26 @@ defmodule Plausible.Stats.DateTimeRangeTest do
       assert range.last == DateTime.new!(last_date, ~T[23:59:59], "UTC")
     end
 
+    test "creates a range from a mix of date and datetime" do
+      first = DateTime.new!(~D[2023-02-15], ~T[12:30:00], "UTC")
+      last = ~D[2023-02-18]
+
+      range = DateTimeRange.new!(first, last, "UTC")
+
+      assert range.first == first
+      assert range.last == DateTime.new!(last, ~T[23:59:59], "UTC")
+    end
+
+    test "creates a range from a mix of datetime and date" do
+      first = ~D[2023-02-15]
+      last = DateTime.new!(~D[2023-02-18], ~T[12:30:00], "UTC")
+
+      range = DateTimeRange.new!(first, last, "UTC")
+
+      assert range.first == DateTime.new!(first, ~T[00:00:00], "UTC")
+      assert range.last == last
+    end
+
     test "handles timezone gaps (spring forward)" do
       # https://stackoverflow.com/questions/18489927/a-day-without-midnight
       range = DateTimeRange.new!(~D[2020-03-29], ~D[2020-03-29], "Asia/Beirut")