Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.
TypeScript analyticsaudience-segmentationchartscohort-analysisgoogle-analyticsproduct-analyticsstatisticsuser-journeyweb-analytics
Updated fetch hook API.
Mike Cao69b317386a6f
diff --cc components/common/Tag.jsindex 000000000,000000000..29612dca8new file mode 100644--- /dev/null+++ b/components/common/Tag.js@@@ -1,0 -1,0 +1,7 @@@++import React from 'react';++import classNames from 'classnames';++import styles from './Tag.module.css';++++export default function Tag({ className, children }) {++ return <span className={classNames(styles.tag, className)}>{children}</span>;++}diff --cc components/common/Tag.module.cssindex e6cb39612,e6cb39612..38d666929--- a/components/common/Tag.module.css+++ b/components/common/Tag.module.css@@@ -1,4 -1,4 +1,4 @@@--.type {++.tag {font-size: var(--font-size-small);padding: 2px 4px;border: 1px solid var(--gray300);diff --cc components/metrics/ActiveUsers.jsindex ca93f3919,3d7b7001e..c099d8f7e--- a/components/metrics/ActiveUsers.js+++ b/components/metrics/ActiveUsers.js@@@ -3,9 -2,10 +3,12 @@@ import { FormattedMessage } from 'reactimport classNames from 'classnames';import useFetch from 'hooks/useFetch';import styles from './ActiveUsers.module.css';-import { FormattedMessage } from 'react-intl';export default function ActiveUsers({ websiteId, token, className }) {-- const { data } = useFetch(`/api/website/${websiteId}/active`, { token }, { interval: 60000 });++ const { data } = useFetch(`/api/website/${websiteId}/active`, {++ params: { token },++ interval: 60000,++ });const count = useMemo(() => {return data?.[0]?.x || 0;}, [data]);diff --cc components/metrics/EventsChart.jsindex 0a348a293,113c6f56a..c2804f9e2--- a/components/metrics/EventsChart.js+++ b/components/metrics/EventsChart.js@@@ -17,14 -17,14 +17,16 @@@ export default function EventsChart({ wconst { data } = useFetch(`/api/website/${websiteId}/events`,{-- start_at: +startDate,-- end_at: +endDate,-- unit,-- tz: timezone,-- url: query.url,-- token,++ params: {++ start_at: +startDate,++ end_at: +endDate,++ unit,++ tz: timezone,++ url: query.url,++ token,++ },},-- { update: [modified] },++ [modified],);const datasets = useMemo(() => {if (!data) return [];diff --cc components/metrics/EventsTable.jsindex 9a7a09cbb,9a7a09cbb..43b52c4d9--- a/components/metrics/EventsTable.js+++ b/components/metrics/EventsTable.js@@@ -1,7 -1,7 +1,7 @@@import React from 'react';import { FormattedMessage } from 'react-intl';import MetricsTable from './MetricsTable';--import styles from './EventsTable.module.css';++import Tag from 'components/common/Tag';export default function EventsTable({ websiteId, token, limit, onDataLoad }) {return (@@@ -22,7 -22,7 +22,7 @@@ const Label = ({ value }) =>const [event, label] = value.split(':');return (<>-- <span className={styles.type}>{event}</span>++ <Tag>{event}</Tag>{label}</>);diff --cc components/metrics/MetricsBar.jsindex ed2c7b121,b7a47a105..9fbc3054f--- a/components/metrics/MetricsBar.js+++ b/components/metrics/MetricsBar.js@@@ -18,17 -18,17 +18,19 @@@ export default function MetricsBar({ wequery: { url },} = usePageQuery();++ console.log({ modified });++const { data, error, loading } = useFetch(- `/api/website/${websiteId}/metrics`,- {- start_at: +startDate,- end_at: +endDate,- url,- token,- },+ `/api/website/${websiteId}/stats`,{- start_at: +startDate,- end_at: +endDate,- url,- token,- },- {-- update: [modified],++ params: {++ start_at: +startDate,++ end_at: +endDate,++ url,++ token,++ },},++ [modified],);const formatFunc = format ? formatLongNumber : formatNumber;diff --cc components/metrics/MetricsTable.jsindex 162dce0fe,6850a3bf9..2f508295a--- a/components/metrics/MetricsTable.js+++ b/components/metrics/MetricsTable.js@@@ -38,16 -38,16 +38,20 @@@ export default function MetricsTable(} = usePageQuery();const { data, loading, error } = useFetch(- `/api/website/${websiteId}/rankings`,+ `/api/website/${websiteId}/metrics`,{-- type,-- start_at: +startDate,-- end_at: +endDate,-- domain: websiteDomain,-- url,-- token,++ params: {++ type,++ start_at: +startDate,++ end_at: +endDate,++ domain: websiteDomain,++ url,++ token,++ },++ onDataLoad,++ delay: 300,},-- { onDataLoad, delay: 300, update: [modified] },++ [modified],);const [format, setFormat] = useState(true);const formatFunc = format ? formatLongNumber : formatNumber;diff --cc components/metrics/PageviewsChart.jsindex b937abe66,9120a6c3b..30e85e804--- a/components/metrics/PageviewsChart.js+++ b/components/metrics/PageviewsChart.js@@@ -4,17 -4,9 +4,17 @@@ import tinycolor from 'tinycolor2'import CheckVisible from 'components/helpers/CheckVisible';import BarChart from './BarChart';import useTheme from 'hooks/useTheme';--import { THEME_COLORS } from 'lib/constants';++import { THEME_COLORS, DEFAULT_ANIMATION_DURATION } from 'lib/constants';-export default function PageviewsChart({ websiteId, data, unit, records, className, loading }) {+export default function PageviewsChart({+ websiteId,+ data,+ unit,+ records,+ className,+ loading,- animationDuration = 300,++ animationDuration = DEFAULT_ANIMATION_DURATION,+}) {const intl = useIntl();const [theme] = useTheme();const primaryColor = tinycolor(THEME_COLORS[theme].primary);diff --cc components/metrics/RealtimeChart.jsindex b4703036a,000000000..ad7534fd8mode 100644,000000..100644--- a/components/metrics/RealtimeChart.js+++ b/components/metrics/RealtimeChart.js@@@ -1,53 -1,0 +1,54 @@@+import React, { useMemo, useRef } from 'react';+import { format, parseISO, startOfMinute, subMinutes, isBefore } from 'date-fns';+import PageviewsChart from './PageviewsChart';+import { getDateArray } from 'lib/date';++import { DEFAULT_ANIMATION_DURATION } from 'lib/constants';++function mapData(data) {+ let last = 0;+ const arr = [];++ data.reduce((obj, val) => {+ const { created_at } = val;+ const t = startOfMinute(parseISO(created_at));+ if (t.getTime() > last) {+ obj = { t: format(t, 'yyyy-LL-dd HH:mm:00'), y: 1 };+ arr.push(obj);+ last = t;+ } else {+ obj.y += 1;+ }+ return obj;+ }, {});++ return arr;+}++export default function RealtimeChart({ data, unit, ...props }) {+ const endDate = startOfMinute(new Date());+ const startDate = subMinutes(endDate, 30);+ const prevEndDate = useRef(endDate);++ const chartData = useMemo(() => {+ if (data) {+ return {+ pageviews: getDateArray(mapData(data.pageviews), startDate, endDate, unit),+ sessions: getDateArray(mapData(data.sessions), startDate, endDate, unit),+ };+ }+ return { pageviews: [], sessions: [] };+ }, [data]);++ // Don't animate the bars shifting over because it looks weird+ const animationDuration = useMemo(() => {+ if (isBefore(prevEndDate.current, endDate)) {+ prevEndDate.current = endDate;+ return 0;+ }- return 300;++ return DEFAULT_ANIMATION_DURATION;+ }, [data]);++ return (+ <PageviewsChart {...props} unit={unit} data={chartData} animationDuration={animationDuration} />+ );+}diff --cc components/metrics/RealtimeLog.jsindex 9164dcdba,000000000..1ea0080e0mode 100644,000000..100644--- a/components/metrics/RealtimeLog.js+++ b/components/metrics/RealtimeLog.js@@@ -1,130 -1,0 +1,131 @@@+import React, { useMemo } from 'react';+import { FormattedMessage, useIntl } from 'react-intl';+import { FixedSizeList } from 'react-window';+import firstBy from 'thenby';+import { format } from 'date-fns';+import Icon from 'components/common/Icon';+import Table, { TableRow } from 'components/common/Table';++import Tag from 'components/common/Tag';+import useLocale from 'hooks/useLocale';+import useCountryNames from 'hooks/useCountryNames';+import { BROWSERS } from 'lib/constants';+import Bolt from 'assets/bolt.svg';+import Visitor from 'assets/visitor.svg';+import Eye from 'assets/eye.svg';+import styles from './RealtimeLog.module.css';++export default function RealtimeLog({ data, websites }) {+ const intl = useIntl();+ const [locale] = useLocale();+ const countryNames = useCountryNames(locale);+ const logs = useMemo(() => {+ const { pageviews, sessions, events } = data;+ return [...pageviews, ...sessions, ...events].sort(firstBy('created_at', -1));+ }, [data]);++ const columns = [+ {+ key: 'time',+ label: <FormattedMessage id="label.time" defaultMessage="Time" />,+ className: 'col-1',+ render: ({ created_at }) => format(new Date(created_at), 'H:mm:ss'),+ },+ {+ key: 'website',+ label: <FormattedMessage id="label.website" defaultMessage="Website" />,+ className: 'col-2',+ render: getWebsite,+ },+ {+ key: 'type',+ label: <FormattedMessage id="label.event" defaultMessage="Event" />,+ className: 'col-9',+ render: row => (+ <>+ <Icon className={styles.icon} icon={getIcon(row)} title={getType(row)} />+ {getDescription(row)}+ </>+ ),+ },+ ];++ function getType({ view_id, session_id, event_id }) {+ if (event_id) {+ return intl.formatMessage({ id: 'label.event', defaultMessage: 'Event' });+ }+ if (view_id) {+ return intl.formatMessage({ id: 'label.pageview', defaultMessage: 'Pageview' });+ }+ if (session_id) {+ return intl.formatMessage({ id: 'label.visitor', defaultMessage: 'Visitor' });+ }+ return null;+ }++ function getIcon({ view_id, session_id, event_id }) {+ if (event_id) {+ return <Bolt />;+ }+ if (view_id) {+ return <Eye />;+ }+ if (session_id) {+ return <Visitor />;+ }+ return null;+ }++ function getWebsite({ website_id }) {+ return websites.find(n => n.website_id === website_id)?.name;+ }++ function getDescription({+ event_type,+ event_value,+ view_id,+ session_id,+ url,+ browser,+ os,+ country,+ device,+ }) {+ if (event_type) {+ return (+ <div>- <span className={styles.event}>{event_type}</span> {event_value}++ <Tag>{event_type}</Tag> {event_value}+ </div>+ );+ }+ if (view_id) {+ return url;+ }+ if (session_id) {+ return (+ <FormattedMessage+ id="message.log.visitor"+ defaultMessage="Visitor from {country} using {browser} on {os} {device}"+ values={{ country: countryNames[country], browser: BROWSERS[browser], os, device }}+ />+ );+ }+ }++ const Row = ({ index, style }) => {+ return (+ <div style={style}>+ <TableRow key={index} columns={columns} row={logs[index]} />+ </div>+ );+ };++ return (+ <div className={styles.log}>+ <Table className={styles.table} bodyClassName={styles.body} columns={columns} rows={logs}>+ <FixedSizeList height={600} itemCount={logs.length} itemSize={46}>+ {Row}+ </FixedSizeList>+ </Table>+ </div>+ );+}diff --cc components/metrics/RealtimeLog.module.cssindex a2ffa8931,000000000..5227be983mode 100644,000000..100644--- a/components/metrics/RealtimeLog.module.css+++ b/components/metrics/RealtimeLog.module.css@@@ -1,26 -1,0 +1,18 @@@+.table {+ font-size: var(--font-size-small);+}++.row {+ display: flex;+ border-bottom: 1px solid var(--gray300);+}++.body {+ height: 600px;+ overflow: auto;+}+- .event {- font-size: var(--font-size-small);- padding: 2px 4px;- border: 1px solid var(--gray300);- border-radius: 4px;- margin-right: 10px;- }-+.icon {+ align-self: center;+ margin-right: 20px;+}diff --cc components/metrics/WebsiteChart.jsindex 13d369c03,6a07afe5e..5a8e7dbf2--- a/components/metrics/WebsiteChart.js+++ b/components/metrics/WebsiteChart.js@@@ -35,24 -35,24 +35,27 @@@ export default function WebsiteChart(const { data, loading, error } = useFetch(`/api/website/${websiteId}/pageviews`,{-- start_at: +startDate,-- end_at: +endDate,-- unit,-- tz: timezone,-- url,-- token,++ params: {++ start_at: +startDate,++ end_at: +endDate,++ unit,++ tz: timezone,++ url,++ token,++ },++ onDataLoad,},-- { onDataLoad, update: [modified] },++ [modified],);- const [pageviews, uniques] = useMemo(() => {+ const chartData = useMemo(() => {if (data) {- return [- getDateArray(data.pageviews, startDate, endDate, unit),- getDateArray(data.uniques, startDate, endDate, unit),- ];+ return {+ pageviews: getDateArray(data.pageviews, startDate, endDate, unit),+ sessions: getDateArray(data.sessions, startDate, endDate, unit),+ };}- return [[], []];+ return { pageviews: [], sessions: [] };}, [data]);function handleCloseFilter() {diff --cc components/pages/RealtimeDashboard.jsindex af3fdc582,000000000..bb2948bc2mode 100644,000000..100644--- a/components/pages/RealtimeDashboard.js+++ b/components/pages/RealtimeDashboard.js@@@ -1,81 -1,0 +1,101 @@@- import React, { useState, useEffect } from 'react';++import React, { useState, useEffect, useMemo } from 'react';+import { FormattedMessage } from 'react-intl';+import { subMinutes, startOfMinute } from 'date-fns';+import Page from 'components/layout/Page';+import PageHeader from 'components/layout/PageHeader';+import DropDown from 'components/common/DropDown';+import useFetch from 'hooks/useFetch';+import RealtimeChart from '../metrics/RealtimeChart';+import RealtimeLog from '../metrics/RealtimeLog';++const REALTIME_RANGE = 30;+const REALTIME_INTERVAL = 5000;++function mergeData(state, data, time) {+ const ids = state.map(({ __id }) => __id);+ return state+ .concat(data.filter(({ __id }) => !ids.includes(__id)))+ .filter(({ created_at }) => new Date(created_at).getTime() >= time);+}+++function filterWebsite(data, id) {++ return data.filter(({ website_id }) => website_id === id);++}+++export default function RealtimeDashboard() {+ const [data, setData] = useState();+ const [website, setWebsite] = useState();- const { data: init, loading } = useFetch('/api/realtime', { type: 'init' });- const { data: updates } = useFetch(- '/api/realtime',- { type: 'update', start_at: data?.timestamp },- {- disabled: !init?.token || !data,- interval: REALTIME_INTERVAL,- headers: { 'x-umami-token': init?.token },- },- );++ const { data: init, loading } = useFetch('/api/realtime', { params: { type: 'init' } });++ const { data: updates } = useFetch('/api/realtime', {++ params: { type: 'update', start_at: data?.timestamp },++ disabled: !init?.token || !data,++ interval: REALTIME_INTERVAL,++ headers: { 'x-umami-token': init?.token },++ });++++ const realtimeData = useMemo(() => {++ if (website) {++ const { website_id } = website;++ const { pageviews, sessions, events, ...props } = data;++ return {++ pageviews: filterWebsite(pageviews, website_id),++ sessions: filterWebsite(sessions, website_id),++ events: filterWebsite(events, website_id),++ ...props,++ };++ }++ return data;++ }, [data, website]);++ useEffect(() => {+ if (init && !data) {+ setData(init.data);+ } else if (updates) {+ const { pageviews, sessions, events, timestamp } = updates;+ const minTime = subMinutes(startOfMinute(new Date()), REALTIME_RANGE).getTime();+ setData(state => ({+ pageviews: mergeData(state.pageviews, pageviews, minTime),+ sessions: mergeData(state.sessions, sessions, minTime),+ events: mergeData(state.events, events, minTime),+ timestamp,+ }));+ }+ }, [init, updates]);++ if (!init || loading || !data) {+ return null;+ }++ const { websites } = init;++ const options = [+ { label: <FormattedMessage id="label.all-websites" defaultMessage="All websites" />, value: 0 },+ ].concat(websites.map(({ name, website_id }) => ({ label: name, value: website_id })));+ const selectedValue = options.find(({ value }) => value === website?.website_id)?.value || 0;++ function handleSelect(value) {+ setWebsite(websites.find(({ website_id }) => website_id === value));+ }++ return (+ <Page>+ <PageHeader>+ <div>+ <FormattedMessage id="label.realtime" defaultMessage="Realtime" />+ </div>+ <DropDown value={selectedValue} options={options} onChange={handleSelect} />+ </PageHeader>- <RealtimeChart websiteId={website?.website_id} data={data} unit="minute" records={30} />++ <RealtimeChart++ websiteId={website?.website_id}++ data={realtimeData}++ unit="minute"++ records={REALTIME_RANGE}++ />+ <div className="row">+ <div className="col-12">- <RealtimeLog data={data} websites={websites} />++ <RealtimeLog data={realtimeData} websites={websites} />+ </div>+ </div>+ </Page>+ );+}diff --cc components/pages/WebsiteDetails.jsindex 66545928e,66545928e..23b19f19d--- a/components/pages/WebsiteDetails.js+++ b/components/pages/WebsiteDetails.js@@@ -31,7 -31,7 +31,7 @@@ const views =};export default function WebsiteDetails({ websiteId, token }) {-- const { data } = useFetch(`/api/website/${websiteId}`, { token });++ const { data } = useFetch(`/api/website/${websiteId}`, { params: { token } });const [chartLoaded, setChartLoaded] = useState(false);const [countryData, setCountryData] = useState();const [eventsData, setEventsData] = useState();diff --cc components/pages/WebsiteList.jsindex 73d20c98e,73d20c98e..cd96ae9f8--- a/components/pages/WebsiteList.js+++ b/components/pages/WebsiteList.js@@@ -9,7 -9,7 +9,7 @@@ import Arrow from 'assets/arrow-right.simport styles from './WebsiteList.module.css';export default function WebsiteList({ userId }) {-- const { data } = useFetch('/api/websites', { user_id: userId });++ const { data } = useFetch('/api/websites', { params: { user_id: userId } });if (!data) {return null;diff --cc components/settings/AccountSettings.jsindex aa206fa99,aa206fa99..8b3e874ef--- a/components/settings/AccountSettings.js+++ b/components/settings/AccountSettings.js@@@ -25,7 -25,7 +25,7 @@@ export default function AccountSettingsconst [deleteAccount, setDeleteAccount] = useState();const [saved, setSaved] = useState(0);const [message, setMessage] = useState();-- const { data } = useFetch(`/api/accounts`, {}, { update: [saved] });++ const { data } = useFetch(`/api/accounts`, {}, [saved]);const Checkmark = ({ is_admin }) => (is_admin ? <Icon icon={<Check />} size="medium" /> : null);diff --cc components/settings/WebsiteSettings.jsindex 17fc59525,17fc59525..b9bc731e5--- a/components/settings/WebsiteSettings.js+++ b/components/settings/WebsiteSettings.js@@@ -29,7 -29,7 +29,7 @@@ export default function WebsiteSettingsconst [showUrl, setShowUrl] = useState();const [saved, setSaved] = useState(0);const [message, setMessage] = useState();-- const { data } = useFetch(`/api/websites`, {}, { update: [saved] });++ const { data } = useFetch(`/api/websites`, {}, [saved]);const Buttons = row => (<ButtonLayout align="right">diff --cc hooks/useFetch.jsindex 5301e2a14,0eb82b138..0a75c58dd--- a/hooks/useFetch.js+++ b/hooks/useFetch.js@@@ -4,14 -4,17 +4,14 @@@ import { get } from 'lib/web'import { updateQuery } from 'redux/actions/queries';import { useRouter } from 'next/router';--export default function useFetch(url, params = {}, options = {}) {++export default function useFetch(url, options = {}, update = []) {const dispatch = useDispatch();const [data, setData] = useState();const [status, setStatus] = useState();const [error, setError] = useState();const [loading, setLoadiing] = useState(false);const { basePath } = useRouter();- const { update = [], onDataLoad = () => {}, disabled, headers, interval, delay = 0 } = options;- const keys = Object.keys(params)- .sort()- .map(key => params[key]);- const { update = [], onDataLoad = () => {} } = options;++ const { params, disabled, headers, interval, delay = 0, onDataLoad } = options;async function loadData() {try {@@@ -30,7 -33,7 +30,7 @@@}setStatus(status);-- onDataLoad(data);++ onDataLoad?.(data);} catch (e) {console.error(e);setError(e);@@@ -40,18 -43,18 +40,18 @@@}useEffect(() => {- if (url) {- const { interval, delay = 0 } = options;-+ if (url && !disabled) {- if (!data) {- setTimeout(() => loadData(), delay);- }+ setTimeout(() => loadData(), delay);++ }++ }, [url, disabled, ...update]);-- const id = interval ? setInterval(() => loadData(), interval) : null;++ useEffect(() => {++ const id = interval ? setInterval(() => loadData(), interval) : null;-- return () => {-- clearInterval(id);-- };-- }- }, [data, url, disabled, ...update]);- }, [url, ...keys, ...update]);++ return () => {++ clearInterval(id);++ };++ }, [interval, params]);return { data, status, error, loading };}diff --cc lib/constants.jsindex 855154819,87e0cf1d9..95d78f58c--- a/lib/constants.js+++ b/lib/constants.js@@@ -42,15 -42,11 +42,16 @@@ export const EVENT_COLORS ='#44b556','#e68619','#e34850',- '#1b959a',- '#d83790',- '#85d044',+ '#f7bd12',+ '#01bad7',+ '#6734bc',+ '#89c541',+ '#ffc301',+ '#ec1562',+ '#ffec16',];++export const DEFAULT_ANIMATION_DURATION = 300;export const DEFAULT_DATE_RANGE = '24hour';export const POSTGRESQL = 'postgresql';diff --cc package.jsonindex 22dd957b8,0ab5c0845..5d4d077c2--- a/package.json+++ b/package.json@@@ -1,6 -1,6 +1,6 @@@{"name": "umami",- "version": "0.82.0",- "version": "0.80.0",++ "version": "0.88.0","description": "A simple, fast, website analytics alternative to Google Analytics. ","author": "Mike Cao <[email protected]>","license": "MIT",diff --cc pages/share/[...id].jsindex 85455af4e,85455af4e..012e778af--- a/pages/share/[...id].js+++ b/pages/share/[...id].js@@@ -8,7 -8,7 +8,7 @@@ export default function SharePage()const router = useRouter();const { id } = router.query;const shareId = id?.[0];-- const { data } = useFetch(shareId ? `/api/share/${shareId}` : null);++ const { data } = useFetch(`/api/share/${shareId}`, { disabled: !shareId });if (!data) {return null;