Resolve graph metric on backend

top-report-refactor
Uku Taht 3 years ago
parent 4244fbf1e1
commit fe307466e3

@ -1,42 +1,4 @@
import numberFormatter, {durationFormatter} from '../../util/number-formatter'
import { parsePrefix } from '../../util/filters'
export function getGraphableMetrics(query, site) {
const isRealtime = query.period === 'realtime'
const goalFilter = query.filters.goal
const pageFilter = query.filters.page
if (isRealtime && goalFilter) {
return ["visitors"]
} else if (isRealtime) {
return ["visitors", "pageviews"]
} else if (goalFilter && canGraphRevenueMetrics(goalFilter, site)) {
return ["visitors", "events", "average_revenue", "total_revenue", "conversion_rate"]
} else if (goalFilter) {
return ["visitors", "events", "conversion_rate"]
} else if (pageFilter) {
return ["visitors", "visits", "pageviews", "bounce_rate", "time_on_page"]
} else {
return ["visitors", "visits", "pageviews", "views_per_visit", "bounce_rate", "visit_duration"]
}
}
// Revenue metrics can only be graphed if:
// * The query is filtered by at least one revenue goal
// * All revenue goals in filter have the same currency
function canGraphRevenueMetrics(goalFilter, site) {
const goalsInFilter = parsePrefix(goalFilter).values
const revenueGoalsInFilter = site.revenueGoals.filter((rg) => {
return goalsInFilter.includes(rg.event_name)
})
const singleCurrency = revenueGoalsInFilter.every((rg) => {
return rg.currency === revenueGoalsInFilter[0].currency
})
return revenueGoalsInFilter.length > 0 && singleCurrency
}
export const METRIC_LABELS = {
'visitors': 'Visitors',

@ -5,7 +5,6 @@ import classNames from "classnames";
import numberFormatter, { durationFormatter } from '../../util/number-formatter'
import * as storage from '../../util/storage'
import { formatDateRange } from '../../util/date.js'
import { getGraphableMetrics } from "./graph-util.js";
function Maybe({condition, children}) {
if (condition) {
@ -88,18 +87,6 @@ export default function TopStats(props) {
)
}
function canMetricBeGraphed(stat) {
const graphableMetrics = getGraphableMetrics(query, site)
return stat.graph_metric && graphableMetrics.includes(stat.graph_metric)
}
function maybeUpdateMetric(stat) {
if (canMetricBeGraphed(stat)) {
storage.setItem(`metric__${site.domain}`, stat.graph_metric)
onMetricUpdate(stat.graph_metric)
}
}
function blinkingDot() {
return (
<div key="dot" className="block pulsating-circle" style={{ left: '125px', top: '52px' }}></div>
@ -130,13 +117,13 @@ export default function TopStats(props) {
function renderStat(stat, index) {
const className = classNames('px-4 md:px-6 w-1/2 my-4 lg:w-auto group select-none', {
'cursor-pointer': canMetricBeGraphed(stat),
'cursor-pointer': stat.graph_metric,
'lg:border-l border-gray-300': index > 0,
'border-r lg:border-r-0': index % 2 === 0
})
return (
<Tooltip key={stat.name} info={tooltip(stat, query)} className={className} onClick={() => { maybeUpdateMetric(stat) }} boundary={tooltipBoundary}>
<Tooltip key={stat.name} info={tooltip(stat, query)} className={className} onClick={() => { onMetricUpdate(stat.graph_metric) }} boundary={tooltipBoundary}>
{renderStatName(stat)}
<div className="my-1 space-y-2">
<div>

@ -46,6 +46,7 @@ export default function VisitorGraph(props) {
}, [query])
const onMetricUpdate = useCallback((newMetric) => {
storage.setItem(`metric__${site.domain}`, newMetric)
setGraphData(null)
setGraphRefreshing(true)
fetchGraphData(newMetric, getCurrentInterval(site, query))
@ -77,6 +78,7 @@ export default function VisitorGraph(props) {
fetchTopReport(site, query, metric, interval)
.then((res) => {
storage.setItem(`metric__${site.domain}`, res.metric)
setTopStatData(res)
setTopStatsLoading(false)
setGraphData(res)

@ -24,4 +24,8 @@ defmodule Plausible.Stats.Metrics do
def from_string!(str) do
Map.fetch!(@metric_mappings, str)
end
def from_string(str, default) do
Map.get(@metric_mappings, str, default)
end
end

@ -103,8 +103,7 @@ defmodule PlausibleWeb.Api.StatsController do
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
query = Query.from(site, params) do
timeseries_query =
if query.period == "realtime" do
%Query{query | period: "30m"}
@ -112,20 +111,21 @@ defmodule PlausibleWeb.Api.StatsController do
query
end
timeseries_result = Stats.timeseries(site, timeseries_query, [metric])
comparison_opts = parse_comparison_opts(params)
{comparison_query, comparison_result} =
comparison_query =
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}
{:ok, comparison_query} -> comparison_query
{:error, :not_supported} -> nil
end
{top_stats, sample_percent} = fetch_top_stats(site, query, comparison_query)
metric = resolve_metric(top_stats, params)
timeseries_result = Stats.timeseries(site, timeseries_query, [metric])
comparison_result =
if comparison_query, do: Stats.timeseries(site, comparison_query, [metric])
labels = label_timeseries(timeseries_result, comparison_result)
present_index = present_index_for(site, query, labels)
@ -163,7 +163,7 @@ defmodule PlausibleWeb.Api.StatsController do
: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
metric <- Plausible.Stats.Metrics.from_string(params["metric"], :visitors) do
timeseries_query =
if query.period == "realtime" do
%Query{query | period: "30m"}
@ -1416,23 +1416,6 @@ defmodule PlausibleWeb.Api.StatsController do
end
end
defp parse_and_validate_graph_metric(params, query) do
metric =
case params["metric"] do
nil -> :visitors
"conversions" -> :visitors
m -> Plausible.Stats.Metrics.from_string!(m)
end
requires_goal_filter? = metric in [:conversion_rate, :events]
if requires_goal_filter? and !query.filters["event:goal"] do
{:error, "Metric `#{metric}` can only be queried with a goal filter"}
else
{:ok, metric}
end
end
defp bad_request(conn, message, extra \\ %{}) do
payload = Map.merge(extra, %{error: message})
@ -1442,6 +1425,21 @@ defmodule PlausibleWeb.Api.StatsController do
|> halt()
end
defp resolve_metric(top_stats, params) do
available_metrics =
top_stats
|> Enum.map(& &1[:graph_metric])
|> Enum.reject(&is_nil/1)
requested_metric = Plausible.Stats.Metrics.from_string(params["metric"], :visitors)
if requested_metric in available_metrics do
requested_metric
else
List.first(available_metrics)
end
end
defp parse_comparison_opts(params) do
[
from: params["compare_from"],

@ -436,20 +436,6 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do
describe "GET /api/stats/main-graph - conversion_rate plot" do
setup [:create_user, :log_in, :create_new_site]
test "returns 400 when conversion rate is queried without a goal filter", %{
conn: conn,
site: site
} do
conn =
get(
conn,
"/api/stats/#{site.domain}/main-graph?period=month&date=2021-01-01&metric=conversion_rate"
)
assert %{"error" => error} = json_response(conn, 400)
assert error =~ "can only be queried with a goal filter"
end
test "displays conversion_rate for a month", %{conn: conn, site: site} do
insert(:goal, site: site, event_name: "Signup")
@ -481,20 +467,6 @@ defmodule PlausibleWeb.Api.StatsController.MainGraphTest do
describe "GET /api/stats/main-graph - events (total conversions) plot" do
setup [:create_user, :log_in, :create_new_site]
test "returns 400 when the `events` metric is queried without a goal filter", %{
conn: conn,
site: site
} do
conn =
get(
conn,
"/api/stats/#{site.domain}/main-graph?period=month&date=2021-01-01&metric=events"
)
assert %{"error" => error} = json_response(conn, 400)
assert error =~ "`events` can only be queried with a goal filter"
end
test "displays total conversions for a goal", %{conn: conn, site: site} do
insert(:goal, site: site, event_name: "Signup")

@ -31,7 +31,13 @@ defmodule PlausibleWeb.Api.StatsController.TopReportTest do
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 metric with default when invalid metric provided", %{site: site, conn: conn} do
# requires goal filter
conn = get(conn, "/api/stats/#{site.domain}/top-report?period=day&metric=events")
assert %{"metric" => "visitors"} = json_response(conn, 200)
end
test "overrides interval with default when invalid interval provided"
end
end

Loading…
Cancel
Save