From 4244fbf1e1146d45d24ec87abaf78839fef4f39e Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Tue, 2 Apr 2024 20:20:43 +0300 Subject: [PATCH] WIP - pairing with @RobertJoonas --- .../js/dashboard/stats/graph/visitor-graph.js | 36 ++++------- .../controllers/api/stats_controller.ex | 60 +++++++++++++++++++ lib/plausible_web/router.ex | 1 + .../api/stats_controller/top_report_test.exs | 37 ++++++++++++ 4 files changed, 109 insertions(+), 25 deletions(-) create mode 100644 test/plausible_web/controllers/api/stats_controller/top_report_test.exs diff --git a/assets/js/dashboard/stats/graph/visitor-graph.js b/assets/js/dashboard/stats/graph/visitor-graph.js index a9b51f7ae..00f77be3b 100644 --- a/assets/js/dashboard/stats/graph/visitor-graph.js +++ b/assets/js/dashboard/stats/graph/visitor-graph.js @@ -1,7 +1,6 @@ import React, { useState, useEffect, useRef, useCallback } from 'react'; import * as api from '../../api' import * as storage from '../../util/storage' -import { getGraphableMetrics } from './graph-util' import TopStats from './top-stats'; import { IntervalPicker, getCurrentInterval } from './interval-picker' import StatsExport from './stats-export' @@ -9,24 +8,18 @@ import WithImportedSwitch from './with-imported-switch'; import SamplingNotice from './sampling-notice'; import FadeIn from '../../fade-in'; import * as url from '../../util/url' -import { isComparisonEnabled } from '../../comparison-input' import LineGraphWithRouter from './line-graph' -function fetchTopStats(site, query) { - const q = { ...query } - - if (!isComparisonEnabled(q.comparison)) { - q.comparison = 'previous_period' - } - - return api.get(url.apiPath(site, '/top-stats'), q) -} - function fetchMainGraph(site, query, metric, interval) { const params = {metric, interval} return api.get(url.apiPath(site, '/main-graph'), query, params) } +function fetchTopReport(site, query, metric, interval) { + const params = {metric, interval} + return api.get(url.apiPath(site, '/top-report'), query, params) +} + export default function VisitorGraph(props) { const {site, query, lastLoadTimestamp} = props const isRealtime = query.period === 'realtime' @@ -79,23 +72,16 @@ export default function VisitorGraph(props) { }, [topStatData]) function fetchTopStatsAndGraphData() { - fetchTopStats(site, query) + const metric = getStoredMetric() + const interval = getCurrentInterval(site, query) + + fetchTopReport(site, query, metric, interval) .then((res) => { setTopStatData(res) setTopStatsLoading(false) + setGraphData(res) + setGraphLoading(false) }) - - let metric = getStoredMetric() - const availableMetrics = getGraphableMetrics(query, site) - - if (!availableMetrics.includes(metric)) { - metric = availableMetrics[0] - storage.setItem(`metric__${site.domain}`, metric) - } - - const interval = getCurrentInterval(site, query) - - fetchGraphData(metric, interval) } function fetchGraphData(metric, interval) { diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index 080142c0e..df35b095c 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -96,6 +96,66 @@ defmodule PlausibleWeb.Api.StatsController do ``` """ + + def top_report(conn, params) do + site = conn.assigns[:site] + + with {:ok, dates} <- parse_date_params(params), + :ok <- validate_interval(params), + :ok <- validate_interval_granularity(site, params, dates), + query = Query.from(site, params), + {:ok, metric} <- parse_and_validate_graph_metric(params, query) do + timeseries_query = + if query.period == "realtime" do + %Query{query | period: "30m"} + else + query + end + + timeseries_result = Stats.timeseries(site, timeseries_query, [metric]) + + comparison_opts = parse_comparison_opts(params) + + {comparison_query, comparison_result} = + case Comparisons.compare(site, query, params["comparison"], comparison_opts) do + {:ok, comparison_query} -> + {comparison_query, Stats.timeseries(site, comparison_query, [metric])} + + {:error, :not_supported} -> + {nil, nil} + end + + {top_stats, sample_percent} = fetch_top_stats(site, query, comparison_query) + + labels = label_timeseries(timeseries_result, comparison_result) + present_index = present_index_for(site, query, labels) + full_intervals = build_full_intervals(query, labels) + + site_import = Plausible.Imported.get_earliest_import(site) + + json(conn, %{ + metric: metric, + plot: plot_timeseries(timeseries_result, metric), + labels: labels, + comparison_plot: comparison_result && plot_timeseries(comparison_result, metric), + comparison_labels: comparison_result && label_timeseries(comparison_result, nil), + comparing_from: comparison_result && comparison_query.date_range.first, + comparing_to: comparison_result && comparison_query.date_range.last, + present_index: present_index, + interval: query.interval, + with_imported: with_imported?(query, comparison_query), + imported_source: site_import && SiteImport.label(site_import), + full_intervals: full_intervals, + from: query.date_range.first, + to: query.date_range.last, + top_stats: top_stats, + sample_percent: sample_percent + }) + else + {:error, message} when is_binary(message) -> bad_request(conn, message) + end + end + def main_graph(conn, params) do site = conn.assigns[:site] diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex index 914b549fb..e49de8072 100644 --- a/lib/plausible_web/router.ex +++ b/lib/plausible_web/router.ex @@ -135,6 +135,7 @@ defmodule PlausibleWeb.Router do get "/:domain/current-visitors", StatsController, :current_visitors get "/:domain/main-graph", StatsController, :main_graph + get "/:domain/top-report", StatsController, :top_report get "/:domain/top-stats", StatsController, :top_stats get "/:domain/sources", StatsController, :sources get "/:domain/utm_mediums", StatsController, :utm_mediums diff --git a/test/plausible_web/controllers/api/stats_controller/top_report_test.exs b/test/plausible_web/controllers/api/stats_controller/top_report_test.exs new file mode 100644 index 000000000..60b2a5ecf --- /dev/null +++ b/test/plausible_web/controllers/api/stats_controller/top_report_test.exs @@ -0,0 +1,37 @@ +defmodule PlausibleWeb.Api.StatsController.TopReportTest do + use PlausibleWeb.ConnCase + + @user_id 123 + + describe "GET /api/stats/top-report" do + setup [:create_user, :log_in, :create_new_site] + + test "returns graph and top stats", %{conn: conn, site: site} do + populate_stats(site, [ + build(:pageview, timestamp: ~N[2021-01-11 04:00:00]), + build(:pageview, timestamp: ~N[2021-01-11 05:00:00]), + build(:pageview, timestamp: ~N[2021-01-11 18:00:00]) + ]) + + conn = + get( + conn, + "/api/stats/#{site.domain}/top-report?period=day&date=2021-01-11&metric=pageviews" + ) + + assert %{"plot" => curr, "top_stats" => top_stats} = json_response(conn, 200) + assert [0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0] = curr + + assert %{ + "name" => "Unique visitors", + "value" => 3, + "graph_metric" => "visitors" + } in top_stats + end + + test "always adds comparison for top stats" + test "compares both top stats and graph when requested" + test "overrides metric with default when invalid metric provided" + test "overrides interval with default when invalid interval provided" + end +end