Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

fix(dashboard): the overview offers only filters it can apply

Carl-Gerhard Lindesvärd6383379c5bb0
diff --git a/apps/start/e2e/overview-filters.spec.ts b/apps/start/e2e/overview-filters.spec.ts
index c7ba949dd..e5f73f57a 100644
--- a/apps/start/e2e/overview-filters.spec.ts
+++ b/apps/start/e2e/overview-filters.spec.ts
@@ -273,7 +273,7 @@ test('page filter from the filter modal: totals match the API and the series is
});
});
-test('a revenue filter (offered by "Add filter") does not break the widgets', async ({
+test('a revenue filter in the URL is ignored by the overview instead of breaking the widgets', async ({
page,
}) => {
const filters = [filter('revenue', ['0'], 'gt')];
diff --git a/apps/start/e2e/verify-a-cohorts.spec.ts b/apps/start/e2e/verify-a-cohorts.spec.ts
index ccb458885..1e9548631 100644
--- a/apps/start/e2e/verify-a-cohorts.spec.ts
+++ b/apps/start/e2e/verify-a-cohorts.spec.ts
@@ -314,25 +314,31 @@ test('profiles list: in cohort and not in cohort', async ({ page }) => {
await page.screenshot({ path: `${SHOTS_DIR}/profiles-not-in-cohort.png` });
});
-test('overview: a cohort filter narrows the metrics to the cohort members', async ({
+test('the overview filter sheet offers only event filters, from the button and from a filter pill', async ({
page,
}) => {
- const cohort = cohorts.oneProperty;
- const memberVisitors = await clickhouseNumber(
- `SELECT uniqExact(profile_id) FROM sessions WHERE project_id = '${PROJECT}' AND created_at >= now() - INTERVAL 31 DAY AND profile_id IN (SELECT profile_id FROM cohort_members FINAL WHERE project_id = '${PROJECT}' AND cohort_id = '${cohort.id}')`
- );
- const stats = page.waitForResponse(
- (response) =>
- response.url().includes('/trpc/overview.stats') &&
- decodeURIComponent(response.url()).includes(cohort.id)
- );
- await openHydrated(page, `${BASE}?range=30d&f=cohort,inCohort,,${cohort.id}`);
- const body = await (await stats).json();
- await page.screenshot({
- path: `${SHOTS_DIR}/overview-cohort-filter.png`,
- fullPage: true,
- });
- expect(body.result.data.json.metrics.unique_visitors).toBe(memberVisitors);
+ await openHydrated(page, `${BASE}?range=30d&f=device,is,desktop`);
+ const openers = [
+ page.getByRole('button', { name: 'Filters', exact: true }),
+ page.getByRole('button', { name: /^device$/i }),
+ ];
+ for (const opener of openers) {
+ await opener.click();
+ const sheet = page.getByRole('dialog');
+ await sheet.getByRole('button', { name: 'Add filter' }).click();
+ const menu = page.locator('[data-radix-menu-content]');
+ await expect(menu).toBeVisible();
+ for (const category of [
+ 'Profile properties',
+ 'Group properties',
+ 'Cohorts',
+ ]) {
+ await expect(menu.getByText(category, { exact: true })).toHaveCount(0);
+ }
+ await page.keyboard.press('Escape');
+ await page.keyboard.press('Escape');
+ await expect(sheet).toBeHidden();
+ }
});
test('deleting a cohort removes it from the list and drops its members', async ({
diff --git a/apps/start/src/components/events/table/index.tsx b/apps/start/src/components/events/table/index.tsx
index 105961e03..c2ee7cc33 100644
--- a/apps/start/src/components/events/table/index.tsx
+++ b/apps/start/src/components/events/table/index.tsx
@@ -22,12 +22,11 @@ import { Button } from '@/components/ui/button';
import { useDataTableColumnVisibility } from '@/components/ui/data-table/data-table-hooks';
import { DataTableToolbarContainer } from '@/components/ui/data-table/data-table-toolbar';
import { DataTableViewOptions } from '@/components/ui/data-table/data-table-view-options';
-import { useAppParams } from '@/hooks/use-app-params';
import { pushModal } from '@/modals';
import type { RouterInputs, RouterOutputs } from '@/trpc/client';
import { cn } from '@/utils/cn';
-type Props = {
+interface Props {
query: UseInfiniteQueryResult<
TRPCInfiniteData<
RouterInputs['event']['events'],
@@ -36,7 +35,7 @@ type Props = {
unknown
>;
showEventListener?: boolean;
-};
+}
const LOADING_DATA = [{}, {}, {}, {}, {}, {}, {}, {}, {}] as IServiceEvent[];
const ROW_HEIGHT = 40;
@@ -335,7 +334,6 @@ function EventsTableToolbar({
table: Table<IServiceEvent>;
showEventListener: boolean;
}) {
- const { projectId } = useAppParams();
const [startDate, setStartDate] = useQueryState(
'startDate',
parseAsIsoDateTime
@@ -368,7 +366,10 @@ function EventsTableToolbar({
: 'Date range'}
</Button>
<OverviewFilterButton enableEventsFilter />
- <OverviewFiltersButtons className="justify-end p-0" />
+ <OverviewFiltersButtons
+ className="justify-end p-0"
+ filterModal={{ enableEventsFilter: true }}
+ />
</div>
<DataTableViewOptions table={table} />
</DataTableToolbarContainer>
diff --git a/apps/start/src/components/overview/filters/overview-filters-buttons.tsx b/apps/start/src/components/overview/filters/overview-filters-buttons.tsx
index 8c8e96919..57cc1c7fa 100644
--- a/apps/start/src/components/overview/filters/overview-filters-buttons.tsx
+++ b/apps/start/src/components/overview/filters/overview-filters-buttons.tsx
@@ -22,9 +22,13 @@ import type { OverviewFiltersProps } from '@/modals/overview-filters';
import { getPropertyLabel } from '@/translations/properties';
import { cn } from '@/utils/cn';
+/** What the Filters modal offers when it is opened from a filter pill. */
+type FilterModalOptions = Omit<OverviewFiltersProps, 'nuqsOptions'>;
+
interface OverviewFiltersButtonsProps {
className?: string;
nuqsOptions?: NuqsOptions;
+ filterModal?: FilterModalOptions;
}
export function OverviewFilterButton(props: OverviewFiltersProps) {
@@ -47,6 +51,7 @@ export function OverviewFilterButton(props: OverviewFiltersProps) {
interface FilterPillProps {
filter: IChartEventFilter;
nuqsOptions?: NuqsOptions;
+ filterModal?: FilterModalOptions;
onRemove: () => void;
onChangeOperator: (operator: IChartEventFilterOperator) => void;
onChangeValue: (value: string[]) => void;
@@ -55,6 +60,7 @@ interface FilterPillProps {
interface CohortFilterPillProps {
filter: IChartEventFilter;
nuqsOptions?: NuqsOptions;
+ filterModal?: FilterModalOptions;
onRemove: () => void;
onChangeOperator: (operator: IChartEventFilterOperator) => void;
onChangeCohorts: (cohortIds: string[]) => void;
@@ -63,6 +69,7 @@ interface CohortFilterPillProps {
function CohortFilterPill({
filter,
nuqsOptions,
+ filterModal,
onRemove,
onChangeOperator,
onChangeCohorts,
@@ -80,7 +87,9 @@ function CohortFilterPill({
<div className="flex h-8 items-stretch overflow-hidden rounded-md border text-sm">
<button
className="cursor-pointer px-2 transition-colors hover:bg-accent"
- onClick={() => pushModal('OverviewFilters', { nuqsOptions })}
+ onClick={() =>
+ pushModal('OverviewFilters', { ...filterModal, nuqsOptions })
+ }
type="button"
>
Cohort
@@ -133,6 +142,7 @@ function CohortFilterPill({
function FilterPill({
filter,
nuqsOptions,
+ filterModal,
onRemove,
onChangeOperator,
onChangeValue,
@@ -152,7 +162,9 @@ function FilterPill({
{/* Key — opens modal to change the property */}
<button
className="cursor-pointer px-2 transition-colors hover:bg-accent"
- onClick={() => pushModal('OverviewFilters', { nuqsOptions })}
+ onClick={() =>
+ pushModal('OverviewFilters', { ...filterModal, nuqsOptions })
+ }
type="button"
>
{getPropertyLabel(filter.name)}
@@ -204,6 +216,7 @@ function FilterPill({
export function OverviewFiltersButtons({
className,
nuqsOptions,
+ filterModal,
}: OverviewFiltersButtonsProps) {
const [events, setEvents] = useEventQueryNamesFilter(nuqsOptions);
const [filters, setFilter, setFilters, removeFilter] =
@@ -250,6 +263,7 @@ export function OverviewFiltersButtons({
return (
<CohortFilterPill
filter={filter}
+ filterModal={filterModal}
key={filter.name}
nuqsOptions={nuqsOptions}
onChangeCohorts={(cohortIds) =>
@@ -269,6 +283,7 @@ export function OverviewFiltersButtons({
return (
<FilterPill
filter={filter}
+ filterModal={filterModal}
key={filter.name}
nuqsOptions={nuqsOptions}
onChangeOperator={(operator) =>
diff --git a/apps/start/src/modals/overview-filters.tsx b/apps/start/src/modals/overview-filters.tsx
index 02f20c6ff..a94169dd6 100644
--- a/apps/start/src/modals/overview-filters.tsx
+++ b/apps/start/src/modals/overview-filters.tsx
@@ -176,6 +176,7 @@ export default function OverviewFilters({
'duration',
'created_at',
'has_profile',
+ 'revenue',
]
}
onSelect={(action) => {
diff --git a/apps/start/src/routeTree.gen.ts b/apps/start/src/routeTree.gen.ts
index 81b0a9d63..987eec64a 100644
--- a/apps/start/src/routeTree.gen.ts
+++ b/apps/start/src/routeTree.gen.ts
@@ -17,7 +17,6 @@ import { Route as PublicRouteImport } from './routes/_public'
import { Route as LoginRouteImport } from './routes/_login'
import { Route as AppRouteImport } from './routes/_app'
import { Route as IndexRouteImport } from './routes/index'
-import { Route as WidgetTestRouteImport } from './routes/widget/test'
import { Route as WidgetRealtimeRouteImport } from './routes/widget/realtime'
import { Route as WidgetCounterRouteImport } from './routes/widget/counter'
import { Route as WidgetBadgeRouteImport } from './routes/widget/badge'
@@ -159,11 +158,6 @@ const IndexRoute = IndexRouteImport.update({
path: '/',
getParentRoute: () => rootRouteImport,
} as any)
-const WidgetTestRoute = WidgetTestRouteImport.update({
- id: '/widget/test',
- path: '/widget/test',
- getParentRoute: () => rootRouteImport,
-} as any)
const WidgetRealtimeRoute = WidgetRealtimeRouteImport.update({
id: '/widget/realtime',
path: '/widget/realtime',
@@ -711,7 +705,6 @@ export interface FileRoutesByFullPath {
'/widget/badge': typeof WidgetBadgeRoute
'/widget/counter': typeof WidgetCounterRoute
'/widget/realtime': typeof WidgetRealtimeRoute
- '/widget/test': typeof WidgetTestRoute
'/$organizationId/$projectId': typeof AppOrganizationIdProjectIdRouteWithChildren
'/$organizationId/billing': typeof AppOrganizationIdBillingRoute
'/$organizationId/settings': typeof AppOrganizationIdSettingsRoute
@@ -798,7 +791,6 @@ export interface FileRoutesByTo {
'/widget/badge': typeof WidgetBadgeRoute
'/widget/counter': typeof WidgetCounterRoute
'/widget/realtime': typeof WidgetRealtimeRoute
- '/widget/test': typeof WidgetTestRoute
'/$organizationId/billing': typeof AppOrganizationIdBillingRoute
'/$organizationId/settings': typeof AppOrganizationIdSettingsRoute
'/onboarding/project': typeof StepsOnboardingProjectRoute
@@ -880,7 +872,6 @@ export interface FileRoutesById {
'/widget/badge': typeof WidgetBadgeRoute
'/widget/counter': typeof WidgetCounterRoute
'/widget/realtime': typeof WidgetRealtimeRoute
- '/widget/test': typeof WidgetTestRoute
'/_app/$organizationId/$projectId': typeof AppOrganizationIdProjectIdRouteWithChildren
'/_app/$organizationId/billing': typeof AppOrganizationIdBillingRoute
'/_app/$organizationId/settings': typeof AppOrganizationIdSettingsRoute
@@ -980,7 +971,6 @@ export interface FileRouteTypes {
| '/widget/badge'
| '/widget/counter'
| '/widget/realtime'
- | '/widget/test'
| '/$organizationId/$projectId'
| '/$organizationId/billing'
| '/$organizationId/settings'
@@ -1067,7 +1057,6 @@ export interface FileRouteTypes {
| '/widget/badge'
| '/widget/counter'
| '/widget/realtime'
- | '/widget/test'
| '/$organizationId/billing'
| '/$organizationId/settings'
| '/onboarding/project'
@@ -1148,7 +1137,6 @@ export interface FileRouteTypes {
| '/widget/badge'
| '/widget/counter'
| '/widget/realtime'
- | '/widget/test'
| '/_app/$organizationId/$projectId'
| '/_app/$organizationId/billing'
| '/_app/$organizationId/settings'
@@ -1245,7 +1233,6 @@ export interface RootRouteChildren {
WidgetBadgeRoute: typeof WidgetBadgeRoute
WidgetCounterRoute: typeof WidgetCounterRoute
WidgetRealtimeRoute: typeof WidgetRealtimeRoute
- WidgetTestRoute: typeof WidgetTestRoute
ShareDashboardShareIdRoute: typeof ShareDashboardShareIdRoute
ShareOverviewShareIdRoute: typeof ShareOverviewShareIdRoute
ShareReportShareIdRoute: typeof ShareReportShareIdRoute
@@ -1295,13 +1282,6 @@ declare module '@tanstack/react-router' {
preLoaderRoute: typeof IndexRouteImport
parentRoute: typeof rootRouteImport
}
- '/widget/test': {
- id: '/widget/test'
- path: '/widget/test'
- fullPath: '/widget/test'
- preLoaderRoute: typeof WidgetTestRouteImport
- parentRoute: typeof rootRouteImport
- }
'/widget/realtime': {
id: '/widget/realtime'
path: '/widget/realtime'
@@ -2499,7 +2479,6 @@ const rootRouteChildren: RootRouteChildren = {
WidgetBadgeRoute: WidgetBadgeRoute,
WidgetCounterRoute: WidgetCounterRoute,
WidgetRealtimeRoute: WidgetRealtimeRoute,
- WidgetTestRoute: WidgetTestRoute,
ShareDashboardShareIdRoute: ShareDashboardShareIdRoute,
ShareOverviewShareIdRoute: ShareOverviewShareIdRoute,
ShareReportShareIdRoute: ShareReportShareIdRoute,
diff --git a/apps/start/src/routes/_app.$organizationId.$projectId.events._tabs.stats.tsx b/apps/start/src/routes/_app.$organizationId.$projectId.events._tabs.stats.tsx
index 5e34d7e1a..e9d47f7a7 100644
--- a/apps/start/src/routes/_app.$organizationId.$projectId.events._tabs.stats.tsx
+++ b/apps/start/src/routes/_app.$organizationId.$projectId.events._tabs.stats.tsx
@@ -36,7 +36,10 @@ function Component() {
<div>
<div className="mb-2 flex items-center gap-2">
<OverviewFilterButton enableEventsFilter />
- <OverviewFiltersButtons className="justify-end p-0" />
+ <OverviewFiltersButtons
+ className="justify-end p-0"
+ filterModal={{ enableEventsFilter: true }}
+ />
</div>
<div className="grid grid-cols-1 gap-2 md:grid-cols-2">
<Widget className="w-full">
diff --git a/apps/start/src/routes/_app.$organizationId.$projectId.index.tsx b/apps/start/src/routes/_app.$organizationId.$projectId.index.tsx
index d580a4e8d..77396a007 100644
--- a/apps/start/src/routes/_app.$organizationId.$projectId.index.tsx
+++ b/apps/start/src/routes/_app.$organizationId.$projectId.index.tsx
@@ -55,7 +55,7 @@ function ProjectDashboard() {
<OverviewShare projectId={projectId} />
</div>
</div>
- <OverviewFiltersButtons />
+ <OverviewFiltersButtons filterModal={{ mode: 'events' }} />
</div>
</div>
<div className="grid grid-cols-6 gap-4 p-4 pt-0">
diff --git a/apps/start/src/routes/share.overview.$shareId.tsx b/apps/start/src/routes/share.overview.$shareId.tsx
index 6601af428..e4b378951 100644
--- a/apps/start/src/routes/share.overview.$shareId.tsx
+++ b/apps/start/src/routes/share.overview.$shareId.tsx
@@ -114,7 +114,7 @@ function RouteComponent() {
<LiveCounter projectId={projectId} shareId={shareId} />
</div>
</div>
- <OverviewFiltersButtons />
+ <OverviewFiltersButtons filterModal={{ mode: 'events' }} />
</div>
</div>
<div className="mx-auto grid max-w-7xl grid-cols-6 gap-4 p-4">
diff --git a/apps/start/src/routes/widget/test.tsx b/apps/start/src/routes/widget/test.tsx
deleted file mode 100644
index 01b92a133..000000000
--- a/apps/start/src/routes/widget/test.tsx
+++ /dev/null
@@ -1,34 +0,0 @@
-import { createFileRoute } from '@tanstack/react-router';
-
-export const Route = createFileRoute('/widget/test')({
- component: RouteComponent,
-});
-
-function RouteComponent() {
- return (
- <div className="center-center h-screen w-screen gap-4">
- <iframe
- className="rounded-xl border"
- height="400"
- src="http://localhost:3000/widget/realtime?shareId=qkC561&limit=2"
- title="Realtime Widget"
- width="300"
- />
- <iframe
- className="rounded-xl border"
- height="400"
- src="http://localhost:3000/widget/realtime?shareId=qkC562&limit=2"
- title="Realtime Widget"
- width="300"
- />
- <iframe
- className="rounded-xl border"
- frameBorder="0"
- height="32"
- src="http://localhost:3000/widget/counter?shareId=qkC561"
- title="Counter Widget"
- width="auto"
- />
- </div>
- );
-}
diff --git a/packages/core/src/modules/overview/overview.service.ts b/packages/core/src/modules/overview/overview.service.ts
index 92071f5fc..97f93bdce 100644
--- a/packages/core/src/modules/overview/overview.service.ts
+++ b/packages/core/src/modules/overview/overview.service.ts
@@ -61,7 +61,6 @@ const WHITELISTED_FILTERS = [
'origin',
'region',
'device',
- 'revenue',
'country',
'browser',
'referrer',
@@ -86,14 +85,14 @@ const UTM_COLUMNS = [
'utm_content',
];
-type MetricsRow = {
+interface MetricsRow {
bounce_rate: number;
unique_visitors: number;
total_sessions: number;
avg_session_duration: number;
total_screen_views: number;
views_per_session: number;
-};
+}
type MetricsSeriesRow = MetricsRow & { date: string; total_revenue: number };