mirror of
https://github.com/kremalicious/umami.git
synced 2025-02-06 01:15:42 +01:00
add dropdown logic for revenue report, defaults to USD for unknown currency code
This commit is contained in:
parent
214396f4b6
commit
be50e8a575
@ -56,11 +56,11 @@ export function TestConsole({ websiteId }: { websiteId: string }) {
|
|||||||
}));
|
}));
|
||||||
window['umami'].track('checkout-cart', {
|
window['umami'].track('checkout-cart', {
|
||||||
revenue: parseFloat((Math.random() * 100000).toFixed(2)),
|
revenue: parseFloat((Math.random() * 100000).toFixed(2)),
|
||||||
currency: 'USD',
|
currency: 'SHIBA',
|
||||||
});
|
});
|
||||||
window['umami'].track('affiliate-link', {
|
window['umami'].track('affiliate-link', {
|
||||||
revenue: parseFloat((Math.random() * 100000).toFixed(2)),
|
revenue: parseFloat((Math.random() * 100000).toFixed(2)),
|
||||||
currency: 'USD',
|
currency: 'ETH',
|
||||||
});
|
});
|
||||||
window['umami'].track('promotion-link', {
|
window['umami'].track('promotion-link', {
|
||||||
revenue: parseFloat((Math.random() * 100000).toFixed(2)),
|
revenue: parseFloat((Math.random() * 100000).toFixed(2)),
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
import { useMessages } from 'components/hooks';
|
import { useMessages } from 'components/hooks';
|
||||||
|
import useRevenueValues from 'components/hooks/queries/useRevenueValues';
|
||||||
import { useContext } from 'react';
|
import { useContext } from 'react';
|
||||||
import { Dropdown, Form, FormButtons, FormInput, FormRow, Item, SubmitButton } from 'react-basics';
|
import { Dropdown, Form, FormButtons, FormInput, FormRow, Item, SubmitButton } from 'react-basics';
|
||||||
import BaseParameters from '../[reportId]/BaseParameters';
|
import BaseParameters from '../[reportId]/BaseParameters';
|
||||||
@ -10,6 +11,7 @@ export function RevenueParameters() {
|
|||||||
const { id, parameters } = report || {};
|
const { id, parameters } = report || {};
|
||||||
const { websiteId, dateRange } = parameters || {};
|
const { websiteId, dateRange } = parameters || {};
|
||||||
const queryEnabled = websiteId && dateRange;
|
const queryEnabled = websiteId && dateRange;
|
||||||
|
const { data: values = [] } = useRevenueValues(websiteId, dateRange.startDate, dateRange.endDate);
|
||||||
|
|
||||||
const handleSubmit = (data: any, e: any) => {
|
const handleSubmit = (data: any, e: any) => {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
@ -23,7 +25,7 @@ export function RevenueParameters() {
|
|||||||
<BaseParameters showDateSelect={true} allowWebsiteSelect={!id} />
|
<BaseParameters showDateSelect={true} allowWebsiteSelect={!id} />
|
||||||
<FormRow label={formatMessage(labels.currency)}>
|
<FormRow label={formatMessage(labels.currency)}>
|
||||||
<FormInput name="currency" rules={{ required: formatMessage(labels.required) }}>
|
<FormInput name="currency" rules={{ required: formatMessage(labels.required) }}>
|
||||||
<Dropdown items={['USD', 'EUR', 'MXN']}>
|
<Dropdown items={values.map(item => item.currency)}>
|
||||||
{item => <Item key={item}>{item}</Item>}
|
{item => <Item key={item}>{item}</Item>}
|
||||||
</Dropdown>
|
</Dropdown>
|
||||||
</FormInput>
|
</FormInput>
|
||||||
|
@ -3,3 +3,9 @@
|
|||||||
gap: 20px;
|
gap: 20px;
|
||||||
margin-bottom: 40px;
|
margin-bottom: 40px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.row {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 10px;
|
||||||
|
}
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
|
import classNames from 'classnames';
|
||||||
import { colord } from 'colord';
|
import { colord } from 'colord';
|
||||||
import BarChart from 'components/charts/BarChart';
|
import BarChart from 'components/charts/BarChart';
|
||||||
import PieChart from 'components/charts/PieChart';
|
import PieChart from 'components/charts/PieChart';
|
||||||
import { useLocale, useMessages } from 'components/hooks';
|
import TypeIcon from 'components/common/TypeIcon';
|
||||||
|
import { useCountryNames, useLocale, useMessages } from 'components/hooks';
|
||||||
import { GridRow } from 'components/layout/Grid';
|
import { GridRow } from 'components/layout/Grid';
|
||||||
import ListTable from 'components/metrics/ListTable';
|
import ListTable from 'components/metrics/ListTable';
|
||||||
import MetricCard from 'components/metrics/MetricCard';
|
import MetricCard from 'components/metrics/MetricCard';
|
||||||
@ -9,7 +11,7 @@ import MetricsBar from 'components/metrics/MetricsBar';
|
|||||||
import { renderDateLabels } from 'lib/charts';
|
import { renderDateLabels } from 'lib/charts';
|
||||||
import { CHART_COLORS } from 'lib/constants';
|
import { CHART_COLORS } from 'lib/constants';
|
||||||
import { formatLongCurrency, formatLongNumber } from 'lib/format';
|
import { formatLongCurrency, formatLongNumber } from 'lib/format';
|
||||||
import { useContext, useMemo } from 'react';
|
import { useCallback, useContext, useMemo } from 'react';
|
||||||
import { ReportContext } from '../[reportId]/Report';
|
import { ReportContext } from '../[reportId]/Report';
|
||||||
import RevenueTable from './RevenueTable';
|
import RevenueTable from './RevenueTable';
|
||||||
import styles from './RevenueView.module.css';
|
import styles from './RevenueView.module.css';
|
||||||
@ -21,6 +23,7 @@ export interface RevenueViewProps {
|
|||||||
export function RevenueView({ isLoading }: RevenueViewProps) {
|
export function RevenueView({ isLoading }: RevenueViewProps) {
|
||||||
const { formatMessage, labels } = useMessages();
|
const { formatMessage, labels } = useMessages();
|
||||||
const { locale } = useLocale();
|
const { locale } = useLocale();
|
||||||
|
const { countryNames } = useCountryNames(locale);
|
||||||
const { report } = useContext(ReportContext);
|
const { report } = useContext(ReportContext);
|
||||||
const {
|
const {
|
||||||
data,
|
data,
|
||||||
@ -28,6 +31,16 @@ export function RevenueView({ isLoading }: RevenueViewProps) {
|
|||||||
} = report || {};
|
} = report || {};
|
||||||
const showTable = data?.table.length > 1;
|
const showTable = data?.table.length > 1;
|
||||||
|
|
||||||
|
const renderCountryName = useCallback(
|
||||||
|
({ x: code }) => (
|
||||||
|
<span className={classNames(locale, styles.row)}>
|
||||||
|
<TypeIcon type="country" value={code?.toLowerCase()} />
|
||||||
|
{countryNames[code]}
|
||||||
|
</span>
|
||||||
|
),
|
||||||
|
[countryNames, locale],
|
||||||
|
);
|
||||||
|
|
||||||
const chartData = useMemo(() => {
|
const chartData = useMemo(() => {
|
||||||
if (!data) return [];
|
if (!data) return [];
|
||||||
|
|
||||||
@ -119,7 +132,7 @@ export function RevenueView({ isLoading }: RevenueViewProps) {
|
|||||||
isLoading={isLoading}
|
isLoading={isLoading}
|
||||||
/>
|
/>
|
||||||
{data && (
|
{data && (
|
||||||
<GridRow columns="one-two">
|
<GridRow columns="two">
|
||||||
<ListTable
|
<ListTable
|
||||||
metric={formatMessage(labels.country)}
|
metric={formatMessage(labels.country)}
|
||||||
data={data?.country.map(({ name, value }) => ({
|
data={data?.country.map(({ name, value }) => ({
|
||||||
@ -127,6 +140,7 @@ export function RevenueView({ isLoading }: RevenueViewProps) {
|
|||||||
y: value,
|
y: value,
|
||||||
z: (value / data?.total.sum) * 100,
|
z: (value / data?.total.sum) * 100,
|
||||||
}))}
|
}))}
|
||||||
|
renderLabel={renderCountryName}
|
||||||
/>
|
/>
|
||||||
<PieChart type="doughnut" data={countryData} />
|
<PieChart type="doughnut" data={countryData} />
|
||||||
</GridRow>
|
</GridRow>
|
||||||
|
18
src/components/hooks/queries/useRevenueValues.ts
Normal file
18
src/components/hooks/queries/useRevenueValues.ts
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
import { useApi } from './useApi';
|
||||||
|
|
||||||
|
export function useRevenueValues(websiteId: string, startDate: Date, endDate: Date) {
|
||||||
|
const { get, useQuery } = useApi();
|
||||||
|
|
||||||
|
return useQuery({
|
||||||
|
queryKey: ['revenue:values', { websiteId, startDate, endDate }],
|
||||||
|
queryFn: () =>
|
||||||
|
get(`/reports/revenue`, {
|
||||||
|
websiteId,
|
||||||
|
startDate,
|
||||||
|
endDate,
|
||||||
|
}),
|
||||||
|
enabled: !!(websiteId && startDate && endDate),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export default useRevenueValues;
|
@ -83,10 +83,22 @@ export function stringToColor(str: string) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function formatCurrency(value: number, currency: string, locale = 'en-US') {
|
export function formatCurrency(value: number, currency: string, locale = 'en-US') {
|
||||||
return new Intl.NumberFormat(locale, {
|
let formattedValue;
|
||||||
style: 'currency',
|
|
||||||
currency: currency,
|
try {
|
||||||
}).format(value);
|
formattedValue = new Intl.NumberFormat(locale, {
|
||||||
|
style: 'currency',
|
||||||
|
currency: currency,
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
// Fallback to default currency format if an error occurs
|
||||||
|
formattedValue = new Intl.NumberFormat(locale, {
|
||||||
|
style: 'currency',
|
||||||
|
currency: 'USD',
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return formattedValue.format(value);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function formatLongCurrency(value: number, currency: string, locale = 'en-US') {
|
export function formatLongCurrency(value: number, currency: string, locale = 'en-US') {
|
||||||
|
@ -5,12 +5,13 @@ import { TimezoneTest, UnitTypeTest } from 'lib/yup';
|
|||||||
import { NextApiResponse } from 'next';
|
import { NextApiResponse } from 'next';
|
||||||
import { methodNotAllowed, ok, unauthorized } from 'next-basics';
|
import { methodNotAllowed, ok, unauthorized } from 'next-basics';
|
||||||
import { getRevenue } from 'queries/analytics/reports/getRevenue';
|
import { getRevenue } from 'queries/analytics/reports/getRevenue';
|
||||||
|
import { getRevenueValues } from 'queries/analytics/reports/getRevenueValues';
|
||||||
import * as yup from 'yup';
|
import * as yup from 'yup';
|
||||||
|
|
||||||
export interface RevenueRequestBody {
|
export interface RevenueRequestBody {
|
||||||
websiteId: string;
|
websiteId: string;
|
||||||
currency: string;
|
currency?: string;
|
||||||
timezone: string;
|
timezone?: string;
|
||||||
dateRange: { startDate: string; endDate: string; unit?: string };
|
dateRange: { startDate: string; endDate: string; unit?: string };
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -37,6 +38,21 @@ export default async (
|
|||||||
await useAuth(req, res);
|
await useAuth(req, res);
|
||||||
await useValidate(schema, req, res);
|
await useValidate(schema, req, res);
|
||||||
|
|
||||||
|
if (req.method === 'GET') {
|
||||||
|
const { websiteId, startDate, endDate } = req.query;
|
||||||
|
|
||||||
|
if (!(await canViewWebsite(req.auth, websiteId))) {
|
||||||
|
return unauthorized(res);
|
||||||
|
}
|
||||||
|
|
||||||
|
const data = await getRevenueValues(websiteId, {
|
||||||
|
startDate: new Date(startDate),
|
||||||
|
endDate: new Date(endDate),
|
||||||
|
});
|
||||||
|
|
||||||
|
return ok(res, data);
|
||||||
|
}
|
||||||
|
|
||||||
if (req.method === 'POST') {
|
if (req.method === 'POST') {
|
||||||
const {
|
const {
|
||||||
websiteId,
|
websiteId,
|
||||||
|
75
src/queries/analytics/reports/getRevenueValues.ts
Normal file
75
src/queries/analytics/reports/getRevenueValues.ts
Normal file
@ -0,0 +1,75 @@
|
|||||||
|
import prisma from 'lib/prisma';
|
||||||
|
import clickhouse from 'lib/clickhouse';
|
||||||
|
import { runQuery, CLICKHOUSE, PRISMA, getDatabaseType, POSTGRESQL } from 'lib/db';
|
||||||
|
|
||||||
|
export async function getRevenueValues(
|
||||||
|
...args: [
|
||||||
|
websiteId: string,
|
||||||
|
criteria: {
|
||||||
|
startDate: Date;
|
||||||
|
endDate: Date;
|
||||||
|
},
|
||||||
|
]
|
||||||
|
) {
|
||||||
|
return runQuery({
|
||||||
|
[PRISMA]: () => relationalQuery(...args),
|
||||||
|
[CLICKHOUSE]: () => clickhouseQuery(...args),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function relationalQuery(
|
||||||
|
websiteId: string,
|
||||||
|
criteria: {
|
||||||
|
startDate: Date;
|
||||||
|
endDate: Date;
|
||||||
|
},
|
||||||
|
) {
|
||||||
|
const { rawQuery } = prisma;
|
||||||
|
const { startDate, endDate } = criteria;
|
||||||
|
|
||||||
|
const db = getDatabaseType();
|
||||||
|
const like = db === POSTGRESQL ? 'ilike' : 'like';
|
||||||
|
|
||||||
|
return rawQuery(
|
||||||
|
`
|
||||||
|
select distinct string_value as currency
|
||||||
|
from event_data
|
||||||
|
where website_id = {websiteId:UUID}
|
||||||
|
and created_at between {startDate:DateTime64} and {endDate:DateTime64}
|
||||||
|
and data_key ${like} '%currency%'
|
||||||
|
order by currency
|
||||||
|
`,
|
||||||
|
{
|
||||||
|
websiteId,
|
||||||
|
startDate,
|
||||||
|
endDate,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function clickhouseQuery(
|
||||||
|
websiteId: string,
|
||||||
|
criteria: {
|
||||||
|
startDate: Date;
|
||||||
|
endDate: Date;
|
||||||
|
},
|
||||||
|
) {
|
||||||
|
const { rawQuery } = clickhouse;
|
||||||
|
const { startDate, endDate } = criteria;
|
||||||
|
|
||||||
|
return rawQuery(
|
||||||
|
`
|
||||||
|
select distinct string_value as currency
|
||||||
|
from event_data
|
||||||
|
where website_id = {websiteId:UUID}
|
||||||
|
and created_at between {startDate:DateTime64} and {endDate:DateTime64}
|
||||||
|
and positionCaseInsensitive(data_key, 'currency') > 0
|
||||||
|
order by currency
|
||||||
|
`,
|
||||||
|
{
|
||||||
|
websiteId,
|
||||||
|
startDate,
|
||||||
|
endDate,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user