API v2: add partial_time_labels and present_index to meta

Author: RobertJoonas

lib/plausible/stats/dashboard/query_parser.ex

@@ -81,6 +81,8 @@ defmodule Plausible.Stats.Dashboard.QueryParser do
          compare: compare,
          compare_match_day_of_week: params["include"]["compare_match_day_of_week"] == true,
          time_labels: params["include"]["time_labels"] == true,
+         partial_time_labels: params["include"]["partial_time_labels"] == true,
+         present_index: params["include"]["present_index"] == true,
          trim_relative_date_range: true,
          drop_unavailable_time_on_page: true,
          drop_unavailable_revenue_metrics: true

lib/plausible/stats/query_include.ex

@@ -4,6 +4,8 @@ defmodule Plausible.Stats.QueryInclude do
   defstruct imports: false,
             imports_meta: false,
             time_labels: false,
+            present_index: false,
+            partial_time_labels: false,
             total_rows: false,
             trim_relative_date_range: false,
             compare: nil,
@@ -19,6 +21,8 @@ defmodule Plausible.Stats.QueryInclude do
           imports: boolean(),
           imports_meta: boolean(),
           time_labels: boolean(),
+          present_index: boolean(),
+          partial_time_labels: boolean(),
           total_rows: boolean(),
           trim_relative_date_range: boolean(),
           compare:

lib/plausible/stats/query_result.ex

@@ -57,6 +57,8 @@ defmodule Plausible.Stats.QueryResult do
     |> add_imports_meta(runner.main_query)
     |> add_metric_warnings_meta(runner.main_query)
     |> add_time_labels_meta(runner.main_query)
+    |> add_present_index_meta(runner.main_query)
+    |> add_partial_time_labels_meta(runner.main_query)
     |> add_total_rows_meta(runner.main_query, runner.total_rows)
     |> Enum.sort_by(&elem(&1, 0))
   end
@@ -93,6 +95,30 @@ defmodule Plausible.Stats.QueryResult do
     end
   end
 
+  defp add_present_index_meta(meta, query) do
+    time_labels = meta[:time_labels]
+
+    if query.include.present_index and is_list(time_labels) do
+      Map.put(meta, :present_index, Plausible.Stats.Time.present_index(time_labels, query))
+    else
+      meta
+    end
+  end
+
+  defp add_partial_time_labels_meta(meta, query) do
+    time_labels = meta[:time_labels]
+
+    if query.include.partial_time_labels and is_list(time_labels) do
+      Map.put(
+        meta,
+        :partial_time_labels,
+        Plausible.Stats.Time.partial_time_labels(time_labels, query)
+      )
+    else
+      meta
+    end
+  end
+
   defp add_total_rows_meta(meta, query, total_rows) do
     if query.include.total_rows do
       Map.put(meta, :total_rows, total_rows)

lib/plausible/stats/time.ex

@@ -120,6 +120,64 @@ defmodule Plausible.Stats.Time do
     |> Enum.map(&format_datetime/1)
   end
 
+  def partial_time_labels(time_labels, query) do
+    case time_dimension(query) do
+      "time:week" ->
+        date_range = Query.date_range(query)
+        partial_labels(time_labels, date_range, &Date.beginning_of_week/1, &Date.end_of_week/1)
+
+      "time:month" ->
+        date_range = Query.date_range(query)
+        partial_labels(time_labels, date_range, &Date.beginning_of_month/1, &Date.end_of_month/1)
+
+      _ ->
+        nil
+    end
+  end
+
+  defp partial_labels(time_labels, date_range, start_fn, end_fn) do
+    Enum.filter(time_labels, fn label ->
+      case Date.from_iso8601(label) do
+        {:ok, date} ->
+          start_in_range = Enum.member?(date_range, start_fn.(date))
+          end_in_range = Enum.member?(date_range, end_fn.(date))
+          not start_in_range or not end_in_range
+
+        _ ->
+          false
+      end
+    end)
+  end
+
+  def present_index(time_labels, query) do
+    now = DateTime.now!(query.timezone)
+
+    current_label =
+      case time_dimension(query) do
+        "time:month" ->
+          DateTime.to_date(now)
+          |> Date.beginning_of_month()
+          |> Date.to_string()
+
+        "time:week" ->
+          DateTime.to_date(now)
+          |> date_or_weekstart(Query.date_range(query))
+          |> Date.to_string()
+
+        "time:day" ->
+          DateTime.to_date(now)
+          |> Date.to_string()
+
+        "time:hour" ->
+          Calendar.strftime(now, "%Y-%m-%d %H:00:00")
+
+        "time:minute" ->
+          Calendar.strftime(now, "%Y-%m-%d %H:%M:00")
+      end
+
+    Enum.find_index(time_labels, &(&1 == current_label))
+  end
+
   def date_or_weekstart(date, date_range) do
     weekstart = Date.beginning_of_week(date)