Move valid interval handling to top report controller action

top-report-refactor
Uku Taht 3 years ago
parent 26c3bf409a
commit d838e536d8

@ -29,8 +29,7 @@ if (container) {
embedded: container.dataset.embedded,
background: container.dataset.background,
isDbip: container.dataset.isDbip === 'true',
flags: JSON.parse(container.dataset.flags),
validIntervalsByPeriod: JSON.parse(container.dataset.validIntervalsByPeriod)
flags: JSON.parse(container.dataset.flags)
}
const loggedIn = container.dataset.loggedIn === 'true'

@ -2,9 +2,7 @@ import { Menu, Transition } from '@headlessui/react';
import { ChevronDownIcon } from '@heroicons/react/20/solid'
import React, { Fragment, useCallback, useEffect } from 'react';
import classNames from 'classnames'
import * as storage from '../../util/storage'
import { isKeyPressed } from '../../keybinding.js'
import { monthsBetweenDates } from '../../util/date.js'
const INTERVAL_LABELS = {
'minute': 'Minutes',
@ -14,22 +12,6 @@ const INTERVAL_LABELS = {
'month': 'Months'
}
function validIntervals(site, query) {
if (query.period === "custom" && monthsBetweenDates(query.from, query.to) > 12) {
return ["week", "month"]
} else {
return site.validIntervalsByPeriod[query.period]
}
}
function getStoredInterval(period, domain) {
return storage.getItem(`interval__${period}__${domain}`)
}
function storeInterval(period, domain, interval) {
storage.setItem(`interval__${period}__${domain}`, interval)
}
function subscribeKeybinding(element) {
const handleKeyPress = useCallback((event) => {
if (isKeyPressed(event, "i")) element.current?.click()
@ -41,41 +23,21 @@ function subscribeKeybinding(element) {
}, [handleKeyPress])
}
export const getCurrentInterval = function(site, query) {
const options = validIntervals(site, query)
const storedInterval = getStoredInterval(query.period, site.domain)
const defaultInterval = [...options].pop()
if (storedInterval && options.includes(storedInterval)) {
return storedInterval
} else {
return defaultInterval
}
}
export function IntervalPicker({ query, site, onIntervalUpdate }) {
export function IntervalPicker({ query, currentInterval, options, onIntervalUpdate }) {
if (query.period == 'realtime') return null
const menuElement = React.useRef(null)
const options = validIntervals(site, query)
const currentInterval = getCurrentInterval(site, query)
subscribeKeybinding(menuElement)
function updateInterval(interval) {
storeInterval(query.period, site.domain, interval)
onIntervalUpdate(interval)
}
function renderDropdownItem(option) {
return (
<Menu.Item onClick={() => updateInterval(option)} key={option} disabled={option == currentInterval}>
<Menu.Item onClick={() => onIntervalUpdate(option)} key={option} disabled={option == currentInterval}>
{({ active }) => (
<span className={classNames({
'bg-gray-100 dark:bg-gray-900 text-gray-900 dark:text-gray-200 cursor-pointer': active,
'text-gray-700 dark:text-gray-200': !active,
'font-bold cursor-none select-none': option == currentInterval,
'font-bold select-none': option == currentInterval,
}, 'block px-4 py-2 text-sm')}>
{INTERVAL_LABELS[option]}
</span>

@ -1,8 +1,7 @@
import React, { useState } from "react"
import * as api from '../../api'
import { getCurrentInterval } from "./interval-picker"
export default function StatsExport({site, query}) {
export default function StatsExport({site, query}) {
const [exporting, setExporting] = useState(false)
function startExport() {
@ -29,7 +28,8 @@ export default function StatsExport({site, query}) {
}
function renderExportLink() {
const interval = getCurrentInterval(site, query)
// FIXME const interval = getCurrentInterval(site, query)
const interval = 'day'
const queryParams = api.serializeQuery(query, [{ interval }])
const endpoint = `/${encodeURIComponent(site.domain)}/export${queryParams}`
@ -50,4 +50,4 @@ export default function StatsExport({site, query}) {
{!exporting && renderExportLink()}
</div>
)
}
}

@ -2,7 +2,7 @@ import React, { useState, useEffect, useRef, useCallback } from 'react';
import * as api from '../../api'
import * as storage from '../../util/storage'
import TopStats from './top-stats';
import { IntervalPicker, getCurrentInterval } from './interval-picker'
import { IntervalPicker } from './interval-picker'
import StatsExport from './stats-export'
import WithImportedSwitch from './with-imported-switch';
import SamplingNotice from './sampling-notice';
@ -10,6 +10,14 @@ import FadeIn from '../../fade-in';
import * as url from '../../util/url'
import LineGraphWithRouter from './line-graph'
function getStoredInterval(period, domain) {
return storage.getItem(`interval__${period}__${domain}`)
}
function storeInterval(period, domain, interval) {
storage.setItem(`interval__${period}__${domain}`, interval)
}
function fetchMainGraph(site, query, metric, interval) {
const params = {metric, interval}
return api.get(url.apiPath(site, '/main-graph'), query, params)
@ -40,6 +48,7 @@ export default function VisitorGraph(props) {
const onIntervalUpdate = useCallback((newInterval) => {
storeInterval(query.period, site.domain, newInterval)
setGraphData(null)
setGraphRefreshing(true)
fetchGraphData(getStoredMetric(), newInterval)
@ -49,7 +58,7 @@ export default function VisitorGraph(props) {
storage.setItem(`metric__${site.domain}`, newMetric)
setGraphData(null)
setGraphRefreshing(true)
fetchGraphData(newMetric, getCurrentInterval(site, query))
fetchGraphData(newMetric, getStoredInterval(query.period, site.domain))
}, [query])
useEffect(() => {
@ -74,10 +83,11 @@ export default function VisitorGraph(props) {
function fetchTopStatsAndGraphData() {
const metric = getStoredMetric()
const interval = getCurrentInterval(site, query)
const interval = getStoredInterval(query.period, site.domain)
fetchTopReport(site, query, metric, interval)
.then((res) => {
storeInterval(query.period, site.domain, res.interval)
storage.setItem(`metric__${site.domain}`, res.metric)
setTopStatData(res)
setTopStatsLoading(false)
@ -129,7 +139,7 @@ export default function VisitorGraph(props) {
{!isRealtime && <StatsExport site={site} query={query} />}
<SamplingNotice samplePercent={topStatData}/>
<WithImportedSwitch site={site} topStatData={topStatData} />
<IntervalPicker site={site} query={query} onIntervalUpdate={onIntervalUpdate} />
<IntervalPicker query={query} currentInterval={getStoredInterval(query.period, site.domain)} options={topStatData?.valid_intervals || []} onIntervalUpdate={onIntervalUpdate} />
</div>
<LineGraphWithRouter graphData={graphData} darkTheme={isDarkTheme} query={query} />
</div>

@ -124,8 +124,3 @@ export function isAfter(date1, date2, period) {
}
return date1.date() > date2.date()
}
export function monthsBetweenDates(date1, date2) {
var diffMonths = (date2.year() - date1.year()) * 12 + date2.month() - date1.month();
return Math.abs(diffMonths);
}

@ -100,10 +100,18 @@ 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) do
with {:ok, dates} <- parse_date_params(params) do
valid_intervals = Plausible.Stats.Interval.valid_by_period(site: site)[params["period"]]
params =
if params["interval"] in valid_intervals do
params
else
Map.delete(params, "interval")
end
query = Query.from(site, params)
timeseries_query =
if query.period == "realtime" do
%Query{query | period: "30m"}
@ -130,6 +138,7 @@ defmodule PlausibleWeb.Api.StatsController do
labels = label_timeseries(timeseries_result, comparison_result)
present_index = present_index_for(site, query, labels)
full_intervals = build_full_intervals(query, labels)
valid_intervals = Plausible.Stats.Interval.valid_by_period(site: site)[query.period]
json(conn, %{
metric: metric,
@ -146,6 +155,7 @@ defmodule PlausibleWeb.Api.StatsController do
full_intervals: full_intervals,
from: query.date_range.first,
to: query.date_range.last,
valid_intervals: valid_intervals,
top_stats: top_stats,
sample_percent: sample_percent
})

@ -39,9 +39,6 @@
data-is-dbip={to_string(@is_dbip)}
data-current-user-role={@conn.assigns[:current_user_role]}
data-flags={Jason.encode!(@flags)}
data-valid-intervals-by-period={
Plausible.Stats.Interval.valid_by_period(site: @site) |> Jason.encode!()
}
>
</div>
<div id="modal_root"></div>

@ -39,5 +39,7 @@ defmodule PlausibleWeb.Api.StatsController.TopReportTest do
end
test "overrides interval with default when invalid interval provided"
test "custom date range interval handling"
test "all time date range interval handling"
end
end

Loading…
Cancel
Save