Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Update the filter dropdown to a compact list with submenus (#6686)

Sanne de Vries095a3d379c1d
diff --git a/assets/js/dashboard/components/icons.tsx b/assets/js/dashboard/components/icons.tsx
index a4c2726471..ac1e5471cc 100644
--- a/assets/js/dashboard/components/icons.tsx
+++ b/assets/js/dashboard/components/icons.tsx
@@ -1,5 +1,29 @@
import React from 'react'
+export const GlobeIcon = ({ className }: { className?: string }) => (
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ fill="none"
+ viewBox="0 0 24 24"
+ className={className}
+ >
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="M22 12H2M12 22c5.714-5.442 5.714-14.558 0-20M12 22C6.286 16.558 6.286 7.442 12 2"
+ />
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="M12 22c5.523 0 10-4.477 10-10S17.523 2 12 2 2 6.477 2 12s4.477 10 10 10Z"
+ />
+ </svg>
+)
+
export const FilterIcon = ({ className }: { className?: string }) => (
<svg
xmlns="http://www.w3.org/2000/svg"
@@ -143,6 +167,138 @@ export const DiamondIcon = ({ className }: { className?: string }) => (
</svg>
)
+export const TagIcon = ({ className }: { className?: string }) => (
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ fill="none"
+ viewBox="0 0 24 24"
+ className={className}
+ >
+ <path
+ fill="currentColor"
+ d="M8.7 10.2a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3"
+ />
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="M4.8 3.602h6.206a2.4 2.4 0 0 1 1.697.703l6.643 6.643a3.597 3.597 0 0 1 0 5.092l-3.308 3.308a3.6 3.6 0 0 1-5.092 0l-6.643-6.643a2.4 2.4 0 0 1-.703-1.697V4.802a1.2 1.2 0 0 1 1.2-1.2"
+ />
+ </svg>
+)
+
+export const RouteIcon = ({ className }: { className?: string }) => (
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ fill="none"
+ viewBox="0 0 24 24"
+ className={className}
+ >
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="M7 4.333h10.166a3.166 3.166 0 1 1 0 6.334H6.833a3.166 3.166 0 1 0 0 6.333h4.833M17.667 19.667a2.667 2.667 0 1 0 0-5.334 2.667 2.667 0 0 0 0 5.334"
+ />
+ </svg>
+)
+
+export const TargetArrowIcon = ({ className }: { className?: string }) => (
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ fill="none"
+ viewBox="0 0 24 24"
+ className={className}
+ >
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="m12 12 4.333-4.333M16.334 7.667l-1-3 3.333-3.334 1 3 3 1-3.333 3.334zM11.677 6.342a5.668 5.668 0 1 0 5.981 5.982"
+ />
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="M12.085 2.334h-.084c-5.339 0-9.667 4.328-9.667 9.666 0 5.339 4.328 9.667 9.667 9.667s9.666-4.328 9.666-9.667v-.085"
+ />
+ </svg>
+)
+
+export const DesktopIcon = ({ className }: { className?: string }) => (
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ fill="none"
+ viewBox="0 0 24 24"
+ className={className}
+ >
+ <g
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ >
+ <rect x="2" y="3" width="20" height="14" rx="2" />
+ <path d="M8 21h8M12 17v4" />
+ </g>
+ </svg>
+)
+
+export const BrowserWindowIcon = ({ className }: { className?: string }) => (
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ fill="none"
+ viewBox="0 0 24 24"
+ className={className}
+ >
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="M4.76 20.64H19.24A2.76 2.76 0 0 0 22 17.883V6.16A2.76 2.76 0 0 0 19.241 3.4H4.76A2.76 2.76 0 0 0 2.001 6.16v11.723a2.76 2.76 0 0 0 2.758 2.759"
+ />
+ <path
+ fill="currentColor"
+ d="M5.449 7.883a1.034 1.034 0 1 0 0-2.07 1.034 1.034 0 0 0 0 2.07M8.896 7.883a1.034 1.034 0 1 0 0-2.07 1.034 1.034 0 0 0 0 2.07"
+ />
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="M2 10.296h20"
+ />
+ </svg>
+)
+
+export const ServerIcon = ({ className }: { className?: string }) => (
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ fill="none"
+ viewBox="0 0 24 24"
+ className={className}
+ >
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ strokeWidth="1.5"
+ d="M4 20.818h16a2 2 0 0 0 2-2v-4.73q0-.18-.032-.355l-2.38-9.087A2 2 0 0 0 17.617 3H6.382a2 2 0 0 0-1.968 1.646l-2.381 9.087a2 2 0 0 0-.032.355v4.73a2 2 0 0 0 2 2M22 13.91H2"
+ />
+ <path
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeWidth="2.5"
+ d="M6.092 17.328v-.01M10.182 17.328v-.01"
+ />
+ </svg>
+)
+
export const Spinner = ({ className }: { className?: string }) => (
<svg
className={className}
diff --git a/assets/js/dashboard/components/popover.tsx b/assets/js/dashboard/components/popover.tsx
index ab1e2d4155..e6217df88c 100644
--- a/assets/js/dashboard/components/popover.tsx
+++ b/assets/js/dashboard/components/popover.tsx
@@ -46,29 +46,36 @@ const toggleButton = {
}
}
+const navigationLink = classNames(
+ 'flex items-center justify-between',
+ 'px-4 py-2.5 text-sm leading-tight rounded-md',
+ 'cursor-pointer'
+)
+
+const hoverLink = classNames(
+ 'hover:bg-gray-100',
+ 'hover:text-gray-900',
+ 'dark:hover:bg-gray-700',
+ 'dark:hover:text-gray-100',
+
+ 'focus-within:bg-gray-100',
+ 'focus-within:text-gray-900',
+ 'dark:focus-within:bg-gray-700',
+ 'dark:focus-within:text-gray-100'
+)
+
const items = {
classNames: {
- navigationLink: classNames(
- 'flex items-center justify-between',
- 'px-4 py-2.5 text-sm leading-tight rounded-md',
- 'cursor-pointer'
- ),
+ navigationLink,
+ hoverLink,
+ label: 'flex-1 min-w-0 truncate',
+ /** Full-width row that holds a leading icon and a `label` span. */
+ iconRow: classNames(navigationLink, hoverLink, 'gap-x-2 w-full text-left'),
selectedOption: classNames(
'data-[selected=true]:bg-gray-100',
'data-[selected=true]:dark:bg-gray-700',
'data-[selected=true]:text-gray-900',
'data-[selected=true]:dark:text-gray-100'
- ),
- hoverLink: classNames(
- 'hover:bg-gray-100',
- 'hover:text-gray-900',
- 'dark:hover:bg-gray-700',
- 'dark:hover:text-gray-100',
-
- 'focus-within:bg-gray-100',
- 'focus-within:text-gray-900',
- 'dark:focus-within:bg-gray-700',
- 'dark:focus-within:text-gray-100'
)
}
}
diff --git a/assets/js/dashboard/filtering/segments.test.ts b/assets/js/dashboard/filtering/segments.test.ts
index b356be9255..b3b2c49b7b 100644
--- a/assets/js/dashboard/filtering/segments.test.ts
+++ b/assets/js/dashboard/filtering/segments.test.ts
@@ -10,7 +10,9 @@ import {
SegmentType,
SavedSegment,
SegmentData,
- canExpandSegment
+ canExpandSegment,
+ getSegmentAuthorship,
+ getAttributionDateLabel
} from './segments'
import { Filter } from '../dashboard-state'
import { PlausibleSite } from '../site-context'
@@ -41,6 +43,64 @@ describe('segment labels in URL search params', () => {
})
})
+describe(`${getSegmentAuthorship.name}`, () => {
+ it('returns the owner name for a site segment with an owner', () => {
+ expect(
+ getSegmentAuthorship({
+ segment: { type: SegmentType.site, owner_name: 'Alice' },
+ showOnlyPublicData: false
+ })
+ ).toBe('Alice')
+ })
+
+ it('returns "Site segment" for a site segment with a dangling owner', () => {
+ expect(
+ getSegmentAuthorship({
+ segment: { type: SegmentType.site, owner_name: null },
+ showOnlyPublicData: false
+ })
+ ).toBe('Site segment')
+ })
+
+ it('returns "Site segment" for a site segment when the owner must stay hidden', () => {
+ expect(
+ getSegmentAuthorship({
+ segment: { type: SegmentType.site, owner_name: 'Alice' },
+ showOnlyPublicData: true
+ })
+ ).toBe('Site segment')
+ })
+
+ it('returns "Personal segment" for a personal segment regardless of owner (we assume personal segments are served only to the author)', () => {
+ expect(
+ getSegmentAuthorship({
+ segment: { type: SegmentType.personal, owner_name: 'Alice' },
+ showOnlyPublicData: false
+ })
+ ).toBe('Personal segment')
+ })
+})
+
+describe(`${getAttributionDateLabel.name}`, () => {
+ it('returns the created date when the segment was never edited', () => {
+ expect(
+ getAttributionDateLabel({
+ inserted_at: '2025-02-01 14:00:00',
+ updated_at: '2025-02-01 14:00:00'
+ })
+ ).toBe('1 Feb')
+ })
+
+ it('returns the edited date when the segment was edited', () => {
+ expect(
+ getAttributionDateLabel({
+ inserted_at: '2025-02-01 14:00:00',
+ updated_at: '2025-03-13 16:00:00'
+ })
+ ).toBe('Edited 13 Mar')
+ })
+})
+
describe(`${parseApiSegmentData.name}`, () => {
it('correctly formats values stored as API filters in their dashboard format', () => {
const apiFormatFilters = [
diff --git a/assets/js/dashboard/filtering/segments.ts b/assets/js/dashboard/filtering/segments.ts
index 4e12da2383..d42733fe02 100644
--- a/assets/js/dashboard/filtering/segments.ts
+++ b/assets/js/dashboard/filtering/segments.ts
@@ -4,6 +4,7 @@ import { plainFilterText } from '../util/filter-text'
import { AppNavigationTarget } from '../navigation/use-app-navigate'
import { PlausibleSite } from '../site-context'
import { Role, UserContextValue } from '../user-context'
+import { formatDayShort, parseNaiveDate } from '../util/date'
export enum SegmentType {
personal = 'personal',
@@ -164,6 +165,30 @@ export const SEGMENT_TYPE_LABELS = {
[SegmentType.site]: 'Site segment'
}
+export const getSegmentAuthorship = ({
+ segment,
+ showOnlyPublicData
+}: {
+ segment: Pick<SavedSegment | SavedSegmentPublic, 'type' | 'owner_name'>
+ showOnlyPublicData: boolean
+}): string => {
+ if (
+ segment.type === SegmentType.site &&
+ !showOnlyPublicData &&
+ segment.owner_name
+ ) {
+ return segment.owner_name
+ }
+ return SEGMENT_TYPE_LABELS[segment.type]
+}
+
+export const getAttributionDateLabel = (
+ segment: Pick<SavedSegment, 'inserted_at' | 'updated_at'>
+): string =>
+ segment.updated_at === segment.inserted_at
+ ? formatDayShort(parseNaiveDate(segment.inserted_at))
+ : `Edited ${formatDayShort(parseNaiveDate(segment.updated_at))}`
+
export function resolveFilters(
filters: Filter[],
segments: Array<Pick<SavedSegment, 'id'> & { segment_data: SegmentData }>
diff --git a/assets/js/dashboard/nav-menu/filter-menu-rows.tsx b/assets/js/dashboard/nav-menu/filter-menu-rows.tsx
new file mode 100644
index 0000000000..83fbca50ee
--- /dev/null
+++ b/assets/js/dashboard/nav-menu/filter-menu-rows.tsx
@@ -0,0 +1,81 @@
+import { ComponentType, SVGProps } from 'react'
+import {
+ CheckCircleIcon,
+ LinkIcon,
+ MapPinIcon,
+ StarIcon
+} from '@heroicons/react/24/outline'
+import {
+ BrowserWindowIcon,
+ DesktopIcon,
+ GlobeIcon,
+ RouteIcon,
+ ServerIcon,
+ TagIcon,
+ TargetArrowIcon
+} from '../components/icons'
+import { FILTER_GROUP_TO_DIMENSIONS, formattedFilters } from '../util/filters'
+import { PlausibleSite } from '../site-context'
+
+type IconComponent = ComponentType<SVGProps<SVGSVGElement>>
+
+export type FilterGroupKey = keyof typeof FILTER_GROUP_TO_DIMENSIONS
+
+export type FilterDimension = keyof typeof formattedFilters
+
+export type FilterMenuRow =
+ | { kind: 'segments'; key: 'segment'; label: string; Icon: IconComponent }
+ | {
+ kind: 'item'
+ key: FilterGroupKey
+ label: string
+ dimension: FilterDimension
+ Icon: IconComponent
+ }
+ | {
+ kind: 'submenu'
+ key: FilterGroupKey
+ label: string
+ dimensions: FilterDimension[]
+ Icon: IconComponent
+ }
+
+export type FilterSubmenuRow = Exclude<FilterMenuRow, { kind: 'item' }>
+
+const GROUPS: Record<FilterGroupKey, { label: string; Icon: IconComponent }> = {
+ segment: { label: 'Segment', Icon: StarIcon },
+ page: { label: 'Page', Icon: LinkIcon },
+ hostname: { label: 'Hostname', Icon: GlobeIcon },
+ source: { label: 'Source', Icon: RouteIcon },
+ utm: { label: 'UTM tags', Icon: TargetArrowIcon },
+ location: { label: 'Location', Icon: MapPinIcon },
+ screen: { label: 'Screen size', Icon: DesktopIcon },
+ browser: { label: 'Browser', Icon: BrowserWindowIcon },
+ os: { label: 'Operating system', Icon: ServerIcon },
+ goal: { label: 'Goal', Icon: CheckCircleIcon },
+ props: { label: 'Property', Icon: TagIcon }
+}
+
+export const SEGMENTS_ROW: Extract<FilterMenuRow, { kind: 'segments' }> = {
+ kind: 'segments',
+ key: 'segment',
+ ...GROUPS.segment
+}
+
+export function getFilterMenuRows({
+ propsAvailable
+}: Pick<PlausibleSite, 'propsAvailable'>): FilterMenuRow[] {
+ const keys = Object.keys(FILTER_GROUP_TO_DIMENSIONS) as FilterGroupKey[]
+
+ return keys
+ .filter(
+ (key) => key !== SEGMENTS_ROW.key && (key !== 'props' || propsAvailable)
+ )
+ .map((key) => {
+ const dimensions = FILTER_GROUP_TO_DIMENSIONS[key] as FilterDimension[]
+
+ return dimensions.length > 1
+ ? { kind: 'submenu', key, dimensions, ...GROUPS[key] }
+ : { kind: 'item', key, dimension: dimensions[0], ...GROUPS[key] }
+ })
+}
diff --git a/assets/js/dashboard/nav-menu/filter-menu.tsx b/assets/js/dashboard/nav-menu/filter-menu.tsx
index fa90e8425d..cfffb73041 100644
--- a/assets/js/dashboard/nav-menu/filter-menu.tsx
+++ b/assets/js/dashboard/nav-menu/filter-menu.tsx
@@ -1,56 +1,147 @@
-import React, { useMemo, useRef } from 'react'
-import {
- FILTER_MODAL_TO_FILTER_GROUP,
- formatFilterGroup
-} from '../util/filters'
-import { PlausibleSite, useSiteContext } from '../site-context'
+import React, {
+ useCallback,
+ useEffect,
+ useId,
+ useMemo,
+ useRef,
+ useState
+} from 'react'
+import { formattedFilters } from '../util/filters'
+import { useSiteContext } from '../site-context'
import { filterRoute } from '../router'
import { FilterIcon } from '../components/icons'
import { Popover, Transition } from '@headlessui/react'
+import { ChevronLeftIcon, ChevronRightIcon } from '@heroicons/react/20/solid'
+import { usePopper } from 'react-popper'
import { popover, BlurMenuButtonOnEscape } from '../components/popover'
import classNames from 'classnames'
import { AppNavigationLink } from '../navigation/use-app-navigate'
-import { SearchableSegmentsSection } from './segments/searchable-segments-section'
-import { useSegmentsContext } from '../filtering/segments-context'
-
-export function getFilterListItems({
- propsAvailable
-}: Pick<PlausibleSite, 'propsAvailable'>): Array<
- Array<{
- title: string
- modals: Array<false | keyof typeof FILTER_MODAL_TO_FILTER_GROUP>
- }>
-> {
- return [
- [
- {
- title: 'URL',
- modals: ['page', 'hostname']
- },
- {
- title: 'Acquisition',
- modals: ['source', 'utm']
- }
- ],
- [
- {
- title: 'Device',
- modals: ['location', 'screen', 'browser', 'os']
- },
- {
- title: 'Behaviour',
- modals: ['goal', !!propsAvailable && 'props']
- }
- ]
- ]
+import {
+ SegmentsSubmenu,
+ useListableSegments
+} from './segments/segments-submenu'
+import {
+ FilterGroupKey,
+ FilterMenuRow,
+ FilterSubmenuRow,
+ getFilterMenuRows,
+ SEGMENTS_ROW
+} from './filter-menu-rows'
+import { MenuSeparator } from './nav-menu-components'
+
+const iconClassName = 'size-4 shrink-0'
+
+const SUBMENU_CLOSE_DELAY_MS = 150
+
+const isMdOrWider = () => window.matchMedia('(min-width: 768px)').matches
+
+/**
+ * `besideMenu` is measured when the submenu opens. If wide enough, the submenu
+ * sits beside the menu; on small screens it replaces the menu.
+ */
+type OpenSubmenu = {
+ key: FilterGroupKey
+ anchor: HTMLElement
+ besideMenu: boolean
}
-const FilterMenuItems = ({ closeDropdown }: { closeDropdown: () => void }) => {
+const FilterMenuItems = ({
+ open,
+ closeDropdown
+}: {
+ open: boolean
+ closeDropdown: () => void
+}) => {
const site = useSiteContext()
- const columns = useMemo(() => getFilterListItems(site), [site])
+ const segments = useListableSegments()
const buttonRef = useRef<HTMLButtonElement>(null)
- const panelRef = useRef<HTMLDivElement>(null)
- const { limitedToSegment } = useSegmentsContext()
+ const submenuId = useId()
+
+ const rows = useMemo(() => {
+ const filterRows = getFilterMenuRows(site)
+ return segments.visible ? [SEGMENTS_ROW, ...filterRows] : filterRows
+ }, [site, segments.visible])
+
+ const [openSubmenu, setOpenSubmenu] = useState<OpenSubmenu | null>(null)
+ const [submenuElement, setSubmenuElement] = useState<HTMLDivElement | null>(
+ null
+ )
+ const openRow = useMemo(
+ () =>
+ rows.find(
+ (row): row is FilterSubmenuRow =>
+ row.kind !== 'item' && row.key === openSubmenu?.key
+ ) ?? null,
+ [rows, openSubmenu]
+ )
+ const besideMenu = !!openSubmenu?.besideMenu
+
+ const closeTimeout = useRef<ReturnType<typeof setTimeout>>()
+ const cancelScheduledClose = useCallback(() => {
+ if (closeTimeout.current) {
+ clearTimeout(closeTimeout.current)
+ closeTimeout.current = undefined
+ }
+ }, [])
+ const scheduleClose = useCallback(() => {
+ cancelScheduledClose()
+ closeTimeout.current = setTimeout(
+ () => setOpenSubmenu(null),
+ SUBMENU_CLOSE_DELAY_MS
+ )
+ }, [cancelScheduledClose])
+ useEffect(() => cancelScheduledClose, [cancelScheduledClose])
+
+ useEffect(() => {
+ if (!open) {
+ setOpenSubmenu(null)
+ }
+ }, [open])
+
+ const openWith = useCallback(
+ (key: FilterGroupKey, anchor: HTMLElement) => {
+ cancelScheduledClose()
+ setOpenSubmenu({ key, anchor, besideMenu: isMdOrWider() })
+ },
+ [cancelScheduledClose]
+ )
+
+ const closeSubmenuAndRefocus = useCallback(() => {
+ cancelScheduledClose()
+ openSubmenu?.anchor.focus()
+ setOpenSubmenu(null)
+ }, [cancelScheduledClose, openSubmenu])
+
+ /**
+ * The submenu opens on the right side by default, and flips to the
+ * left when the viewport doesn't have enough room.
+ */
+ const { styles, attributes } = usePopper(
+ openSubmenu?.anchor ?? null,
+ submenuElement,
+ {
+ placement: 'right-start',
+ modifiers: [
+ { name: 'offset', options: { offset: [-4, 0] } },
+ { name: 'flip', options: { fallbackPlacements: ['left-start'] } },
+ { name: 'preventOverflow', options: { padding: 8 } }
+ ]
+ }
+ )
+
+ const handleEscape = useCallback(
+ (event: React.KeyboardEvent) => {
+ if (event.key === 'Escape' && openSubmenu) {
+ closeSubmenuAndRefocus()
+ event.stopPropagation()
+ }
+ },
+ [closeSubmenuAndRefocus, openSubmenu]
+ )
+
+ const submenuBody = openRow && (
+ <SubmenuBody row={openRow} closeDropdown={closeDropdown} />
+ )
return (
<>
@@ -59,7 +150,8 @@ const FilterMenuItems = ({ closeDropdown }: { closeDropdown: () => void }) => {
ref={buttonRef}
className={classNames(
popover.toggleButton.classNames.rounded,
- popover.toggleButton.classNames.ghost
+ popover.toggleButton.classNames.ghost,
+ 'relative z-20'
)}
>
<FilterIcon className="block size-3.5" />
@@ -72,47 +164,80 @@ const FilterMenuItems = ({ closeDropdown }: { closeDropdown: () => void }) => {
{...popover.transition.props}
className={classNames(
popover.transition.classNames.fullwidth,
- 'mt-2 md:left-auto md:w-80 md:origin-top-right'
+ 'mt-2 md:left-auto md:w-56 md:origin-top-right'
)}
>
+ <div className="fixed top-0 left-0 w-full h-full"></div>
<Popover.Panel
- ref={panelRef}
- className={classNames(popover.panel.classNames.roundedSheet)}
+ className={classNames(
+ popover.panel.classNames.roundedSheet,
+ 'relative'
+ )}
data-testid="filtermenu"
>
- <div className="flex">
- {columns.map((filterGroups, index) => (
- <div key={index} className="flex flex-col w-1/2">
- {filterGroups.map(({ title, modals }) => (
- <div key={title}>
- <div className={titleClassName}>{title}</div>
- {modals
- .filter((m) => !!m)
- .map((modalKey) => (
- <AppNavigationLink
+ {openRow && !besideMenu ? (
+ <div className="flex flex-col gap-y-0.5" onKeyDown={handleEscape}>
+ <button
+ className={popover.items.classNames.iconRow}
+ onClick={() => setOpenSubmenu(null)}
+ >
+ <ChevronLeftIcon className={iconClassName} />
+ <span className={popover.items.classNames.label}>
+ {openRow.label}
+ </span>
+ </button>
+ <MenuSeparator />
+ <div
+ className="flex flex-col gap-y-0.5"
+ id={submenuId}
+ role="group"
+ aria-label={openRow.label}
+ data-testid="filtermenu-submenu"
+ >
+ {submenuBody}
+ </div>
+ </div>
+ ) : (
+ <div className="flex flex-col gap-y-0.5" onKeyDown={handleEscape}>
+ {rows.map((row) => (
+ <React.Fragment key={row.key}>
+ {row.kind === 'item' ? (
+ <ItemRow
+ row={row}
+ onPointerOrFocus={scheduleClose}
+ closeDropdown={closeDropdown}
+ />
+ ) : (
+ <>
+ <SubmenuRow
+ row={row}
+ expanded={openSubmenu?.key === row.key}
+ submenuId={submenuId}
+ onOpen={openWith}
+ />
+ {openRow?.key === row.key && (
+ <div
+ ref={setSubmenuElement}
+ style={styles.popper}
+ {...attributes.popper}
+ id={submenuId}
+ role="group"
+ aria-label={openRow.label}
+ data-testid="filtermenu-submenu"
className={classNames(
- popover.items.classNames.navigationLink,
- popover.items.classNames.hoverLink
+ popover.panel.classNames.roundedSheet,
+ 'z-20 w-72'
)}
- onClick={() => closeDropdown()}
- key={modalKey}
- path={filterRoute.path}
- params={{ field: modalKey }}
- search={(s) => s}
>
- {formatFilterGroup(modalKey)}
- </AppNavigationLink>
- ))}
- </div>
- ))}
- </div>
- ))}
- </div>
- {limitedToSegment === null && (
- <SearchableSegmentsSection
- closeList={closeDropdown}
- tooltipContainerRef={panelRef}
- />
+ {submenuBody}
+ </div>
+ )}
+ </>
+ )}
+ {row.kind === 'segments' && <MenuSeparator />}
+ </React.Fragment>
+ ))}
+ </div>
)}
</Popover.Panel>
</Transition>
@@ -120,11 +245,107 @@ const FilterMenuItems = ({ closeDropdown }: { closeDropdown: () => void }) => {
)
}
+const ItemRow = ({
+ row,
+ onPointerOrFocus,
+ closeDropdown
+}: {
+ row: Extract<FilterMenuRow, { kind: 'item' }>
+ onPointerOrFocus: () => void
+ closeDropdown: () => void
+}) => (
+ <AppNavigationLink
+ className={popover.items.classNames.iconRow}
+ onClick={closeDropdown}
+ onMouseEnter={onPointerOrFocus}
+ onFocus={onPointerOrFocus}
+ path={filterRoute.path}
+ params={{ field: row.dimension }}
+ search={(s) => s}
+ >
+ <row.Icon className={iconClassName} />
+ <span className={popover.items.classNames.label}>{row.label}</span>
+ </AppNavigationLink>
+)
+
+const SubmenuRow = ({
+ row,
+ expanded,
+ submenuId,
+ onOpen
+}: {
+ row: FilterSubmenuRow
+ expanded: boolean
+ submenuId: string
+ onOpen: (key: FilterGroupKey, anchor: HTMLElement) => void
+}) => {
+ const handleOpen = useCallback(
+ (event: React.SyntheticEvent<HTMLButtonElement>) =>
+ onOpen(row.key, event.currentTarget),
+ [onOpen, row.key]
+ )
+
+ const handleHoverOrFocus = useCallback(
+ (event: React.SyntheticEvent<HTMLButtonElement>) => {
+ if (isMdOrWider()) {
+ handleOpen(event)
+ }
+ },
+ [handleOpen]
+ )
+
+ return (
+ <button
+ className={classNames(
+ popover.items.classNames.iconRow,
+ popover.items.classNames.selectedOption
+ )}
+ data-selected={expanded}
+ aria-expanded={expanded}
+ aria-controls={expanded ? submenuId : undefined}
+ onClick={handleOpen}
+ onMouseEnter={handleHoverOrFocus}
+ onFocus={handleHoverOrFocus}
+ >
+ <row.Icon className={iconClassName} />
+ <span className={popover.items.classNames.label}>{row.label}</span>
+ <ChevronRightIcon className={iconClassName} />
+ </button>
+ )
+}
+
+const SubmenuBody = ({
+ row,
+ closeDropdown
+}: {
+ row: FilterSubmenuRow
+ closeDropdown: () => void
+}) => {
+ if (row.kind === 'segments') {
+ return <SegmentsSubmenu closeList={closeDropdown} />
+ }
+ return (
+ <>
+ {row.dimensions.map((dimension) => (
+ <AppNavigationLink
+ key={dimension}
+ className={popover.items.classNames.iconRow}
+ onClick={closeDropdown}
+ path={filterRoute.path}
+ params={{ field: dimension }}
+ search={(s) => s}
+ >
+ <span className={popover.items.classNames.label}>
+ {formattedFilters[dimension]}
+ </span>
+ </AppNavigationLink>
+ ))}
+ </>
+ )
+}
+
export const FilterMenu = () => (
<Popover className="shrink-0 md:relative">
- {({ close }) => <FilterMenuItems closeDropdown={close} />}
+ {({ open, close }) => <FilterMenuItems open={open} closeDropdown={close} />}
</Popover>
)
-
-const titleClassName =
- 'text-sm pb-1 px-4 pt-2 font-bold uppercase text-indigo-500 dark:text-indigo-400'
diff --git a/assets/js/dashboard/nav-menu/filter-pills-list.tsx b/assets/js/dashboard/nav-menu/filter-pills-list.tsx
index 43dc8a5cb2..df11e8cb19 100644
--- a/assets/js/dashboard/nav-menu/filter-pills-list.tsx
+++ b/assets/js/dashboard/nav-menu/filter-pills-list.tsx
@@ -1,11 +1,7 @@
import React, { DetailedHTMLProps, HTMLAttributes } from 'react'
import { useDashboardStateContext } from '../dashboard-state-context'
import { FilterPill, FilterPillProps } from './filter-pill'
-import {
- cleanLabels,
- EVENT_PROPS_PREFIX,
- FILTER_GROUP_TO_MODAL_TYPE
-} from '../util/filters'
+import { cleanLabels, EVENT_PROPS_PREFIX } from '../util/filters'
import { styledFilterText, plainFilterText } from '../util/filter-text'
import { useAppNavigate } from '../navigation/use-app-navigate'
import classNames from 'classnames'
@@ -79,10 +75,9 @@ export const AppliedFilterPillsList = React.forwardRef<
path: filterRoute.path,
search: (s) => s,
params: {
- field:
- FILTER_GROUP_TO_MODAL_TYPE[
- filter[1].startsWith(EVENT_PROPS_PREFIX) ? 'props' : filter[1]
- ]
+ field: filter[1].startsWith(EVENT_PROPS_PREFIX)
+ ? 'props'
+ : filter[1]
}
},
onRemoveClick: canRemoveFilter(filter, limitedToSegment)
diff --git a/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx b/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx
deleted file mode 100644
index 2d1436317d..0000000000
--- a/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx
+++ /dev/null
@@ -1,180 +0,0 @@
-import React, { RefObject } from 'react'
-import { useDashboardStateContext } from '../../dashboard-state-context'
-import { useSiteContext } from '../../site-context'
-import {
- SavedSegmentPublic,
- SavedSegment,
- SEGMENT_TYPE_LABELS,
- isListableSegment,
- getSearchToSetSegmentFilter
-} from '../../filtering/segments'
-import classNames from 'classnames'
-import { Tooltip } from '../../util/tooltip'
-import { SegmentAuthorship } from '../../segments/segment-authorship'
-import { SearchInput } from '../../components/search-input'
-import { EllipsisHorizontalIcon } from '@heroicons/react/24/solid'
-import { popover } from '../../components/popover'
-import { AppNavigationLink } from '../../navigation/use-app-navigate'
-import { MenuSeparator } from '../nav-menu-components'
-import { Role, useUserContext } from '../../user-context'
-import { useSegmentsContext } from '../../filtering/segments-context'
-import { useSearchableItems } from '../../hooks/use-searchable-items'
-
-const linkClassName = classNames(
- popover.items.classNames.navigationLink,
- popover.items.classNames.selectedOption,
- popover.items.classNames.hoverLink
-)
-
-const INITIAL_SEGMENTS_SHOWN = 5
-
-export const SearchableSegmentsSection = ({
- closeList,
- tooltipContainerRef
-}: {
- closeList: () => void
- tooltipContainerRef: RefObject<HTMLElement>
-}) => {
- const site = useSiteContext()
- const segmentsContext = useSegmentsContext()
-
- const { expandedSegment } = useDashboardStateContext()
- const user = useUserContext()
-
- const isPublicListQuery = !user.loggedIn || user.role === Role.public
-
- const {
- data,
- filteredData,
- showableData,
- showSearch,
- countOfMoreToShow,
- handleShowAll,
- handleClearSearch,
- handleSearchInput,
- searchRef,
- searching
- } = useSearchableItems({
- data: segmentsContext.segments.filter((segment) =>
- isListableSegment({ segment, site, user })
- ),
- maxItemsInitially: INITIAL_SEGMENTS_SHOWN,
- itemMatchesSearchValue: (segment, trimmedSearch) =>
- segment.name.toLowerCase().includes(trimmedSearch.toLowerCase())
- })
-
- if (expandedSegment) {
- return null
- }
-
- if (!data.length) {
- return null
- }
-
- return (
- <>
- <MenuSeparator />
- <div className="flex items-center py-2 px-4">
- <div className="text-sm font-bold uppercase text-indigo-500 dark:text-indigo-400 mr-4">
- Segments
- </div>
- {showSearch && (
- <SearchInput
- searchRef={searchRef}
- className="ml-auto py-1"
- onSearch={handleSearchInput}
- />
- )}
- </div>
-
- <div className="max-h-[228px] overflow-y-auto">
- {showableData.map((segment) => {
- return (
- <Tooltip
- containerRef={tooltipContainerRef}
- className="group"
- key={segment.id}
- info={
- <div className="max-w-60">
- <div className="break-all">{segment.name}</div>
- <div className="font-normal text-xs">
- {SEGMENT_TYPE_LABELS[segment.type]}
- </div>
-
- <SegmentAuthorship
- className="font-normal text-xs"
- {...(isPublicListQuery
- ? {
- showOnlyPublicData: true,
- segment: segment as SavedSegmentPublic
- }
- : {
- showOnlyPublicData: false,
- segment: segment as SavedSegment
- })}
- />
- </div>
- }
- >
- <SegmentLink {...segment} closeList={closeList} />
- </Tooltip>
- )
- })}
- {countOfMoreToShow > 0 && (
- <Tooltip
- className="group"
- info={null}
- containerRef={tooltipContainerRef}
- >
- <button
- className={classNames(
- linkClassName,
- 'w-full text-left font-bold hover:text-indigo-700 dark:hover:text-indigo-500'
- )}
- onClick={handleShowAll}
- >
- {`Show ${countOfMoreToShow} more`}
- <EllipsisHorizontalIcon className="block w-5 h-5" />
- </button>
- </Tooltip>
- )}
- </div>
- {searching && !filteredData.length && (
- <Tooltip
- className="group"
- info={null}
- containerRef={tooltipContainerRef}
- >
- <button
- className={classNames(
- linkClassName,
- 'w-full text-left font-bold hover:text-indigo-700 dark:hover:text-indigo-500'
- )}
- onClick={handleClearSearch}
- >
- No segments found. Clear search to show all.
- </button>
- </Tooltip>
- )}
- </>
- )
-}
-
-const SegmentLink = ({
- id,
- name,
- closeList
-}: Pick<SavedSegment, 'id' | 'name'> & {
- closeList: () => void
-}) => {
- return (
- <AppNavigationLink
- className={linkClassName}
- key={id}
- onClick={closeList}
- search={getSearchToSetSegmentFilter({ id, name })}
- >
- <div className="truncate">{name}</div>
- </AppNavigationLink>
- )
-}
diff --git a/assets/js/dashboard/nav-menu/segments/segments-submenu.tsx b/assets/js/dashboard/nav-menu/segments/segments-submenu.tsx
new file mode 100644
index 0000000000..944bf31f12
--- /dev/null
+++ b/assets/js/dashboard/nav-menu/segments/segments-submenu.tsx
@@ -0,0 +1,152 @@
+import React, { useMemo } from 'react'
+import { useDashboardStateContext } from '../../dashboard-state-context'
+import { useSiteContext } from '../../site-context'
+import {
+ SavedSegmentPublic,
+ SavedSegment,
+ isListableSegment,
+ getSearchToSetSegmentFilter,
+ getSegmentAuthorship,
+ getAttributionDateLabel
+} from '../../filtering/segments'
+import classNames from 'classnames'
+import { SearchInput } from '../../components/search-input'
+import { EllipsisHorizontalIcon } from '@heroicons/react/24/solid'
+import { AppNavigationLink } from '../../navigation/use-app-navigate'
+import { Role, useUserContext } from '../../user-context'
+import { useSegmentsContext } from '../../filtering/segments-context'
+import { useSearchableItems } from '../../hooks/use-searchable-items'
+import { popover } from '../../components/popover'
+
+const mutedRowClassName = classNames(
+ popover.items.classNames.iconRow,
+ 'text-gray-500 dark:text-gray-400 hover:text-gray-800 dark:hover:text-gray-200'
+)
+
+const INITIAL_SEGMENTS_SHOWN = 6
+
+export const useListableSegments = (): {
+ segments: (SavedSegment | SavedSegmentPublic)[]
+ visible: boolean
+} => {
+ const site = useSiteContext()
+ const user = useUserContext()
+ const { segments, limitedToSegment } = useSegmentsContext()
+ const { expandedSegment } = useDashboardStateContext()
+
+ const listableSegments = useMemo(
+ () =>
+ segments.filter((segment) => isListableSegment({ segment, site, user })),
+ [segments, site, user]
+ )
+
+ return {
+ segments: listableSegments,
+ visible:
+ !expandedSegment && limitedToSegment === null && !!listableSegments.length
+ }
+}
+
+export const SegmentsSubmenu = ({ closeList }: { closeList: () => void }) => {
+ const user = useUserContext()
+ const site = useSiteContext()
+ const { segments } = useListableSegments()
+
+ const isPublicListQuery = !user.loggedIn || user.role === Role.public
+
+ const showAuthorship = site.siteSegmentsAvailable
+
+ const {
+ filteredData,
+ showableData,
+ showSearch,
+ countOfMoreToShow,
+ handleShowAll,
+ handleClearSearch,
+ handleSearchInput,
+ searchRef,
+ searching
+ } = useSearchableItems({
+ data: segments,
+ maxItemsInitially: INITIAL_SEGMENTS_SHOWN,
+ itemMatchesSearchValue: (segment, trimmedSearch) =>
+ segment.name.toLowerCase().includes(trimmedSearch.toLowerCase())
+ })
+
+ return (
+ <>
+ {showSearch && (
+ <SearchInput
+ searchRef={searchRef}
+ className="!max-w-none"
+ onSearch={handleSearchInput}
+ />
+ )}
+
+ <div className="flex flex-col gap-y-0.5 max-h-100 overflow-y-auto">
+ {showableData.map((segment) => (
+ <SegmentLink
+ key={segment.id}
+ segment={segment}
+ showAuthorship={showAuthorship}
+ showOnlyPublicData={isPublicListQuery}
+ closeList={closeList}
+ />
+ ))}
+ {countOfMoreToShow > 0 && (
+ <button className={mutedRowClassName} onClick={handleShowAll}>
+ <span className={popover.items.classNames.label}>
+ {`Show ${countOfMoreToShow} more`}
+ </span>
+ <EllipsisHorizontalIcon className="block w-5 h-5 shrink-0" />
+ </button>
+ )}
+ </div>
+ {searching && !filteredData.length && (
+ <button className={mutedRowClassName} onClick={handleClearSearch}>
+ No segments found. Clear search to show all.
+ </button>
+ )}
+ </>
+ )
+}
+
+const SegmentLink = ({
+ segment,
+ showAuthorship,
+ showOnlyPublicData,
+ closeList
+}: {
+ segment: SavedSegment | SavedSegmentPublic
+ showAuthorship: boolean
+ showOnlyPublicData: boolean
+ closeList: () => void
+}) => {
+ const { id, name } = segment
+ const authorship = showAuthorship
+ ? getSegmentAuthorship({ segment, showOnlyPublicData })
+ : null
+ const dateLabel = getAttributionDateLabel(segment)
+
+ return (
+ <AppNavigationLink
+ className={popover.items.classNames.iconRow}
+ onClick={closeList}
+ search={getSearchToSetSegmentFilter({ id, name })}
+ >
+ <div className="flex flex-col gap-y-0.5 flex-1 min-w-0">
+ <div className="truncate" title={name}>
+ {name}
+ </div>
+ <div className="flex items-baseline gap-x-1 font-normal text-xs text-gray-500 dark:text-gray-400">
+ {!!authorship && (
+ <span className="truncate min-w-0">{authorship}</span>
+ )}
+ <span className="whitespace-nowrap shrink-0">
+ {authorship ? `• ${dateLabel}` : dateLabel}
+ </span>
+ </div>
+ </div>
+ </AppNavigationLink>
+ )
+}
diff --git a/assets/js/dashboard/nav-menu/top-bar.test.tsx b/assets/js/dashboard/nav-menu/top-bar.test.tsx
index be3cacf1b2..171733023d 100644
--- a/assets/js/dashboard/nav-menu/top-bar.test.tsx
+++ b/assets/js/dashboard/nav-menu/top-bar.test.tsx
@@ -4,7 +4,8 @@ import {
screen,
waitFor,
fireEvent,
- waitForElementToBeRemoved
+ waitForElementToBeRemoved,
+ within
} from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { TestContextProviders } from '../../../test-utils/app-context-providers'
@@ -13,8 +14,10 @@ import { MockAPI } from '../../../test-utils/mock-api'
import {
mockAnimationsApi,
mockResizeObserver,
- mockIntersectionObserver
+ mockIntersectionObserver,
+ mockViewportForTestGroup
} from 'jsdom-testing-mocks'
+import { SegmentType } from '../filtering/segments'
mockAnimationsApi()
mockResizeObserver()
@@ -107,7 +110,12 @@ test('user can open and close filters dropdown', async () => {
const toggleFilters = screen.getByRole('button', { name: 'Filter' })
await userEvent.click(toggleFilters)
- expect(screen.queryAllByRole('link').map((el) => el.textContent)).toEqual([
+
+ expect(
+ Array.from(
+ screen.getByTestId('filtermenu').querySelectorAll('a, button')
+ ).map((el) => el.textContent)
+ ).toEqual([
'Page',
'Hostname',
'Source',
@@ -118,11 +126,300 @@ test('user can open and close filters dropdown', async () => {
'Operating system',
'Goal'
])
+
+ // rows without a submenu link straight to their dimension
+ expect(screen.getByRole('link', { name: 'Hostname' })).toHaveAttribute(
+ 'href',
+ `/${domain}/filter/hostname`
+ )
+ expect(screen.queryByRole('link', { name: 'Page' })).not.toBeInTheDocument()
+
await userEvent.click(toggleFilters)
expect(screen.queryByTestId('filtermenu')).not.toBeInTheDocument()
expect(screen.queryAllByRole('link')).toEqual([])
})
+test.each([
+ [
+ 'Page',
+ [
+ ['Page', 'page'],
+ ['Entry page', 'entry_page'],
+ ['Exit page', 'exit_page']
+ ]
+ ],
+ [
+ 'Browser',
+ [
+ ['Browser', 'browser'],
+ ['Browser version', 'browser_version']
+ ]
+ ],
+ [
+ 'Location',
+ [
+ ['Country', 'country'],
+ ['Region', 'region'],
+ ['City', 'city']
+ ]
+ ]
+])('user can open the %s submenu', async (rowName, expectedItems) => {
+ render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders siteOptions={{ domain }} {...props} />
+ )
+ })
+
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+ const row = screen.getByRole('button', { name: rowName })
+ expect(row).toHaveAttribute('aria-expanded', 'false')
+
+ await userEvent.click(row)
+ expect(row).toHaveAttribute('aria-expanded', 'true')
+
+ const submenu = screen.getByTestId('filtermenu-submenu')
+ expect(
+ Array.from(submenu.querySelectorAll('a')).map((el) => [
+ el.textContent,
+ el.getAttribute('href')
+ ])
+ ).toEqual(
+ expectedItems.map(([label, dimension]) => [
+ label,
+ `/${domain}/filter/${dimension}`
+ ])
+ )
+})
+
+test('user can walk the filter menu and a submenu with Tab', async () => {
+ render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders siteOptions={{ domain }} {...props} />
+ )
+ })
+
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+
+ await userEvent.tab()
+ const pageRow = screen.getByRole('button', { name: 'Page' })
+ expect(pageRow).toHaveFocus()
+ expect(pageRow).toHaveAttribute('aria-expanded', 'true')
+
+ const submenuLinks = Array.from(
+ screen.getByTestId('filtermenu-submenu').querySelectorAll('a')
+ )
+ await userEvent.tab()
+ expect(submenuLinks[0]).toHaveFocus()
+ await userEvent.tab()
+ expect(submenuLinks[1]).toHaveFocus()
+ await userEvent.tab({ shift: true })
+ expect(submenuLinks[0]).toHaveFocus()
+
+ await userEvent.keyboard('{Escape}')
+ expect(pageRow).toHaveFocus()
+ await waitFor(() => {
+ expect(screen.queryByTestId('filtermenu-submenu')).not.toBeInTheDocument()
+ })
+ expect(screen.getByTestId('filtermenu')).toBeInTheDocument()
+})
+
+test('property row only shows when props are available', async () => {
+ const { unmount } = render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders siteOptions={{ domain }} {...props} />
+ )
+ })
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+ expect(
+ screen.queryByRole('link', { name: 'Property' })
+ ).not.toBeInTheDocument()
+ unmount()
+
+ render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders
+ siteOptions={{ domain, propsAvailable: true }}
+ {...props}
+ />
+ )
+ })
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+ expect(screen.getByRole('link', { name: 'Property' })).toHaveAttribute(
+ 'href',
+ `/${domain}/filter/props`
+ )
+})
+
+test('segment row only shows when listable segments exist, and lists them in its submenu', async () => {
+ const segment = {
+ id: 7,
+ name: 'My people',
+ type: SegmentType.personal,
+ owner_id: 1,
+ owner_name: 'Test User',
+ inserted_at: '2025-02-26T10:00:00',
+ updated_at: '2025-02-26T10:00:00',
+ segment_data: { filters: [], labels: {} }
+ }
+
+ const { unmount } = render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders siteOptions={{ domain }} {...props} />
+ )
+ })
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+ expect(
+ screen.queryByRole('button', { name: 'Segment' })
+ ).not.toBeInTheDocument()
+ unmount()
+
+ render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders
+ siteOptions={{ domain }}
+ preloaded={{ segments: [segment] }}
+ {...props}
+ />
+ )
+ })
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+ await userEvent.click(screen.getByRole('button', { name: 'Segment' }))
+
+ const submenu = screen.getByTestId('filtermenu-submenu')
+ expect(submenu.querySelectorAll('a')).toHaveLength(1)
+ expect(within(submenu).getByTitle(segment.name)).toBeVisible()
+ // Without shared segments, the authorship would say the same on every row.
+ expect(within(submenu).getByText('26 Feb')).toBeVisible()
+ expect(within(submenu).queryByText('Personal segment')).toBeNull()
+})
+
+test('segment rows show authorship and the edited date when shared segments are available', async () => {
+ const segments = [
+ {
+ id: 7,
+ name: 'My people',
+ type: SegmentType.personal,
+ owner_id: 1,
+ owner_name: 'Test User',
+ inserted_at: '2025-02-26T10:00:00',
+ updated_at: '2025-02-26T10:00:00',
+ segment_data: { filters: [], labels: {} }
+ },
+ {
+ id: 8,
+ name: 'APAC region',
+ type: SegmentType.site,
+ owner_id: 2,
+ owner_name: 'Jane Smith',
+ inserted_at: '2025-02-26T10:00:00',
+ updated_at: '2025-03-13T16:00:00',
+ segment_data: { filters: [], labels: {} }
+ }
+ ]
+
+ render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders
+ siteOptions={{ domain, siteSegmentsAvailable: true }}
+ preloaded={{ segments }}
+ {...props}
+ />
+ )
+ })
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+ await userEvent.click(screen.getByRole('button', { name: 'Segment' }))
+
+ const submenu = screen.getByTestId('filtermenu-submenu')
+ expect(within(submenu).getByText('Personal segment')).toBeVisible()
+ expect(within(submenu).getByText('• 26 Feb')).toBeVisible()
+ expect(within(submenu).getByText('Jane Smith')).toBeVisible()
+ expect(within(submenu).getByText('• Edited 13 Mar')).toBeVisible()
+})
+
+test.each([
+ { segmentCount: 6, expectSearch: false, expectedShowMoreRow: null },
+ { segmentCount: 7, expectSearch: true, expectedShowMoreRow: 'Show 1 more' }
+])(
+ 'the segment submenu shows a search box and a show-more row for $segmentCount segments: $expectSearch',
+ async ({ segmentCount, expectSearch, expectedShowMoreRow }) => {
+ const segments = Array.from({ length: segmentCount }, (_, index) => ({
+ id: index + 1,
+ name: `Segment ${index + 1}`,
+ type: SegmentType.personal,
+ owner_id: 1,
+ owner_name: 'Test User',
+ inserted_at: '2025-02-26T10:00:00',
+ updated_at: '2025-02-26T10:00:00',
+ segment_data: { filters: [], labels: {} }
+ }))
+
+ render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders
+ siteOptions={{ domain }}
+ preloaded={{ segments }}
+ {...props}
+ />
+ )
+ })
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+ await userEvent.click(screen.getByRole('button', { name: 'Segment' }))
+
+ const submenu = screen.getByTestId('filtermenu-submenu')
+ expect(!!within(submenu).queryByTestId('search-input')).toBe(expectSearch)
+ expect(
+ within(submenu).queryByText(/Show \d+ more/)?.textContent ?? null
+ ).toBe(expectedShowMoreRow)
+ expect(submenu.querySelectorAll('a')).toHaveLength(
+ Math.min(segmentCount, 6)
+ )
+ }
+)
+
+describe('narrow viewport (no room for a submenu beside the menu)', () => {
+ mockViewportForTestGroup({ width: '500px', height: '800px' })
+
+ const openFilterMenu = async () => {
+ render(<TopBar showCurrentVisitors={false} />, {
+ wrapper: (props) => (
+ <TestContextProviders siteOptions={{ domain }} {...props} />
+ )
+ })
+ await userEvent.click(screen.getByRole('button', { name: 'Filter' }))
+ }
+
+ test('a submenu row drills down in place, and the back button returns', async () => {
+ await openFilterMenu()
+ await userEvent.click(screen.getByRole('button', { name: 'Page' }))
+
+ const submenu = screen.getByTestId('filtermenu-submenu')
+ expect(
+ Array.from(submenu.querySelectorAll('a')).map((el) => el.textContent)
+ ).toEqual(['Page', 'Entry page', 'Exit page'])
+
+ // The main list is replaced, not shown beside the submenu.
+ expect(
+ screen.queryByRole('link', { name: 'Hostname' })
+ ).not.toBeInTheDocument()
+
+ await userEvent.click(screen.getByRole('button', { name: 'Page' }))
+
+ expect(screen.queryByTestId('filtermenu-submenu')).not.toBeInTheDocument()
+ expect(screen.getByRole('link', { name: 'Hostname' })).toBeInTheDocument()
+ })
+
+ test('tabbing onto a submenu row does not drill down', async () => {
+ await openFilterMenu()
+
+ await userEvent.tab()
+
+ const pageRow = screen.getByRole('button', { name: 'Page' })
+ expect(pageRow).toHaveFocus()
+ expect(pageRow).toHaveAttribute('aria-expanded', 'false')
+ expect(screen.queryByTestId('filtermenu-submenu')).not.toBeInTheDocument()
+ })
+})
+
test('current visitors renders when visitors are present and disappears after visitors are null', async () => {
mockAPI.get(`/api/stats/${domain}/current-visitors`, 500)
render(<TopBar showCurrentVisitors={true} />, {
diff --git a/assets/js/dashboard/stats/modals/filter-modal-group.js b/assets/js/dashboard/stats/modals/filter-modal-dimension.js
similarity index 73%
rename from assets/js/dashboard/stats/modals/filter-modal-group.js
rename to assets/js/dashboard/stats/modals/filter-modal-dimension.js
index 83d3d1d4a4..2e4f9819b3 100644
--- a/assets/js/dashboard/stats/modals/filter-modal-group.js
+++ b/assets/js/dashboard/stats/modals/filter-modal-dimension.js
@@ -1,14 +1,13 @@
import React, { useMemo } from 'react'
import FilterModalRow from './filter-modal-row'
import {
- formattedFilters,
- getFilterGroup,
+ getFilterDimension,
getPropertyKeyFromFilterKey
} from '../../util/filters'
import FilterModalPropsRow from './filter-modal-props-row'
-export default function FilterModalGroup({
- filterGroup,
+export default function FilterModalDimension({
+ dimension,
filterState,
labels,
onUpdateRowValue,
@@ -18,33 +17,27 @@ export default function FilterModalGroup({
const rows = useMemo(
() =>
Object.entries(filterState)
- .filter(([_, filter]) => getFilterGroup(filter) == filterGroup)
+ .filter(([_, filter]) => getFilterDimension(filter) == dimension)
.map(([id, filter]) => ({ id, filter })),
- [filterGroup, filterState]
+ [dimension, filterState]
)
const disabledOptions = useMemo(
() =>
- filterGroup == 'props'
+ dimension == 'props'
? rows.map(({ filter }) => ({
value: getPropertyKeyFromFilterKey(filter[1])
}))
: null,
- [filterGroup, rows]
+ [dimension, rows]
)
- const showAddRow = ['props', 'goal'].includes(filterGroup)
- const showTitle = filterGroup != 'props'
+ const showAddRow = ['props', 'goal'].includes(dimension)
return (
<>
<div>
- {showTitle && (
- <div className="text-sm font-medium text-gray-800 dark:text-gray-200">
- {formattedFilters[filterGroup]}
- </div>
- )}
{rows.map(({ id, filter }) =>
- filterGroup === 'props' ? (
+ dimension === 'props' ? (
<FilterModalPropsRow
testId={id}
key={id}
@@ -75,7 +68,7 @@ export default function FilterModalGroup({
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
<a
className="underline text-indigo-500 text-sm cursor-pointer"
- onClick={() => onAddRow(filterGroup)}
+ onClick={() => onAddRow(dimension)}
>
+ Add another
</a>
diff --git a/assets/js/dashboard/stats/modals/filter-modal.js b/assets/js/dashboard/stats/modals/filter-modal.js
index 7c02e1c349..d55049a318 100644
--- a/assets/js/dashboard/stats/modals/filter-modal.js
+++ b/assets/js/dashboard/stats/modals/filter-modal.js
@@ -4,49 +4,42 @@ import { useParams } from 'react-router-dom'
import { ModalLayout, ModalFooter } from '../../components/modal-layout'
import {
EVENT_PROPS_PREFIX,
- FILTER_GROUP_TO_MODAL_TYPE,
- formatFilterGroup,
+ formattedFilters,
FILTER_OPERATIONS,
- getFilterGroup,
- FILTER_MODAL_TO_FILTER_GROUP,
+ getFilterDimension,
cleanLabels,
- getAvailableFilterModals
+ getAvailableFilterDimensions
} from '../../util/filters'
import { useDashboardStateContext } from '../../dashboard-state-context'
import { useSiteContext } from '../../site-context'
import { isModifierPressed, isTyping } from '../../keybinding'
-import FilterModalGroup from './filter-modal-group'
+import FilterModalDimension from './filter-modal-dimension'
import { rootRoute } from '../../router'
import { useAppNavigate } from '../../navigation/use-app-navigate'
import { SegmentModal } from '../../segments/segment-modals'
import { findAppliedSegmentFilter } from '../../filtering/segments'
import { Button } from '../../components/button'
-function partitionFilters(modalType, filters) {
+function partitionFilters(dimension, filters) {
const otherFilters = []
const filterState = {}
- let hasRelevantFilters = false
+ let filtersToRemoveCount = 0
filters.forEach((filter, index) => {
- const filterGroup = getFilterGroup(filter)
- if (FILTER_GROUP_TO_MODAL_TYPE[filterGroup] === modalType) {
- const key = filterState[filterGroup]
- ? `${filterGroup}:${index}`
- : filterGroup
+ if (getFilterDimension(filter) === dimension) {
+ const key = filterState[dimension] ? `${dimension}:${index}` : dimension
filterState[key] = filter
- hasRelevantFilters = true
+ filtersToRemoveCount++
} else {
otherFilters.push(filter)
}
})
- FILTER_MODAL_TO_FILTER_GROUP[modalType].forEach((filterGroup) => {
- if (!filterState[filterGroup]) {
- filterState[filterGroup] = emptyFilter(filterGroup)
- }
- })
+ if (!filterState[dimension]) {
+ filterState[dimension] = emptyFilter(dimension)
+ }
- return { filterState, otherFilters, hasRelevantFilters }
+ return { filterState, otherFilters, filtersToRemoveCount }
}
function emptyFilter(key) {
@@ -59,13 +52,9 @@ class FilterModal extends React.Component {
constructor(props) {
super(props)
- const modalType = this.props.modalType
-
const dashboardState = this.props.dashboardState
- const { filterState, otherFilters, hasRelevantFilters } = partitionFilters(
- modalType,
- dashboardState.filters
- )
+ const { filterState, otherFilters, filtersToRemoveCount } =
+ partitionFilters(this.props.dimension, dashboardState.filters)
this.handleKeydown = this.handleKeydown.bind(this)
this.closeModal = this.closeModal.bind(this)
@@ -74,7 +63,7 @@ class FilterModal extends React.Component {
filterState,
labelState: dashboardState.labels,
otherFilters,
- hasRelevantFilters
+ filtersToRemoveCount
}
}
@@ -170,15 +159,10 @@ class FilterModal extends React.Component {
})
}
- getFilterGroups() {
- const groups = FILTER_MODAL_TO_FILTER_GROUP[this.props.modalType]
- return groups
- }
-
render() {
return (
<ModalLayout
- title={`Filter by ${formatFilterGroup(this.props.modalType)}`}
+ title={`Filter by ${formattedFilters[this.props.dimension]}`}
onClose={this.closeModal}
>
<form
@@ -186,21 +170,18 @@ class FilterModal extends React.Component {
onSubmit={this.handleSubmit.bind(this)}
>
<div className="flex flex-col gap-y-3 mb-2">
- {this.getFilterGroups().map((filterGroup) => (
- <FilterModalGroup
- key={filterGroup}
- filterGroup={filterGroup}
- filterState={this.state.filterState}
- labels={this.state.labelState}
- onUpdateRowValue={this.onUpdateRowValue.bind(this)}
- onAddRow={this.onAddRow.bind(this)}
- onDeleteRow={this.onDeleteRow.bind(this)}
- />
- ))}
+ <FilterModalDimension
+ dimension={this.props.dimension}
+ filterState={this.state.filterState}
+ labels={this.state.labelState}
+ onUpdateRowValue={this.onUpdateRowValue.bind(this)}
+ onAddRow={this.onAddRow.bind(this)}
+ onDeleteRow={this.onDeleteRow.bind(this)}
+ />
</div>
<ModalFooter>
- {this.state.hasRelevantFilters ? (
+ {this.state.filtersToRemoveCount > 0 ? (
<Button
theme="secondary"
size="sm"
@@ -208,7 +189,7 @@ class FilterModal extends React.Component {
this.selectFiltersAndCloseModal(this.state.otherFilters)
}}
>
- {FILTER_MODAL_TO_FILTER_GROUP[this.props.modalType].length > 1
+ {this.state.filtersToRemoveCount > 1
? 'Remove filters'
: 'Remove filter'}
</Button>
@@ -238,7 +219,7 @@ export default function FilterModalWithRouter(props) {
const { field } = useParams()
const { dashboardState } = useDashboardStateContext()
const site = useSiteContext()
- if (!Object.keys(getAvailableFilterModals(site)).includes(field)) {
+ if (!getAvailableFilterDimensions(site).includes(field)) {
return null
}
const appliedSegmentFilter =
@@ -252,7 +233,7 @@ export default function FilterModalWithRouter(props) {
return (
<FilterModal
{...props}
- modalType={field || 'page'}
+ dimension={field}
dashboardState={dashboardState}
navigate={navigate}
site={site}
diff --git a/assets/js/dashboard/util/filters.js b/assets/js/dashboard/util/filters.js
index dc5d72fada..d13759751d 100644
--- a/assets/js/dashboard/util/filters.js
+++ b/assets/js/dashboard/util/filters.js
@@ -1,34 +1,25 @@
import { formatSegmentIdAsLabelKey } from '../filtering/segments'
-export const FILTER_MODAL_TO_FILTER_GROUP = {
+export const FILTER_GROUP_TO_DIMENSIONS = {
+ segment: ['segment'],
page: ['page', 'entry_page', 'exit_page'],
+ hostname: ['hostname'],
source: ['source', 'channel', 'referrer'],
+ utm: ['utm_medium', 'utm_source', 'utm_campaign', 'utm_term', 'utm_content'],
location: ['country', 'region', 'city'],
screen: ['screen'],
browser: ['browser', 'browser_version'],
os: ['os', 'os_version'],
- utm: ['utm_medium', 'utm_source', 'utm_campaign', 'utm_term', 'utm_content'],
goal: ['goal'],
- props: ['props'],
- hostname: ['hostname'],
- segment: ['segment']
+ props: ['props']
}
-export function getAvailableFilterModals(site) {
- const { props, ...rest } = FILTER_MODAL_TO_FILTER_GROUP
- return {
- ...rest,
- ...(site.propsAvailable && { props })
- }
+export function getAvailableFilterDimensions(site) {
+ return Object.entries(FILTER_GROUP_TO_DIMENSIONS)
+ .filter(([group]) => group !== 'props' || site.propsAvailable)
+ .flatMap(([, dimensions]) => dimensions)
}
-export const FILTER_GROUP_TO_MODAL_TYPE = Object.fromEntries(
- Object.entries(FILTER_MODAL_TO_FILTER_GROUP).flatMap(
- ([modalName, filterGroups]) =>
- filterGroups.map((filterGroup) => [filterGroup, modalName])
- )
-)
-
export const EVENT_PROPS_PREFIX = 'props:'
export const FILTER_OPERATIONS = {
@@ -55,7 +46,7 @@ export function supportsIsNot(filterName) {
export function supportsContains(filterName) {
return !['screen']
- .concat(FILTER_MODAL_TO_FILTER_GROUP['location'])
+ .concat(FILTER_GROUP_TO_DIMENSIONS['location'])
.includes(filterName)
}
@@ -146,18 +137,6 @@ export function getGoalFilter(dashboardState) {
return getFiltersByKeyPrefix(dashboardState, 'goal')[0] || null
}
-export function formatFilterGroup(filterGroup) {
- if (filterGroup === 'utm') {
- return 'UTM tags'
- } else if (filterGroup === 'location') {
- return 'Location'
- } else if (filterGroup === 'props') {
- return 'Property'
- } else {
- return formattedFilters[filterGroup]
- }
-}
-
export function cleanLabels(filters, labels, mergedFilterKey, mergedLabels) {
const filteredBy = Object.fromEntries(
filters
@@ -278,7 +257,7 @@ function remapToApiFilter([operation, filterKey, clauses, ...modifiers]) {
}
}
-export function getFilterGroup([_operation, filterKey, _clauses]) {
+export function getFilterDimension([_operation, filterKey, _clauses]) {
return filterKey.startsWith(EVENT_PROPS_PREFIX) ? 'props' : filterKey
}
diff --git a/assets/js/dashboard/util/filters.test.ts b/assets/js/dashboard/util/filters.test.ts
index 20b8080567..837e64a2b7 100644
--- a/assets/js/dashboard/util/filters.test.ts
+++ b/assets/js/dashboard/util/filters.test.ts
@@ -1,55 +1,52 @@
-import { getAvailableFilterModals, serializeApiFilters } from './filters'
+import { getAvailableFilterDimensions, serializeApiFilters } from './filters'
-describe(`${getAvailableFilterModals.name}`, () => {
- it('gives limited object when props are not available', () => {
+const ALL_DIMENSIONS = [
+ 'browser',
+ 'browser_version',
+ 'channel',
+ 'city',
+ 'country',
+ 'entry_page',
+ 'exit_page',
+ 'goal',
+ 'hostname',
+ 'os',
+ 'os_version',
+ 'page',
+ 'props',
+ 'referrer',
+ 'region',
+ 'screen',
+ 'segment',
+ 'source',
+ 'utm_campaign',
+ 'utm_content',
+ 'utm_medium',
+ 'utm_source',
+ 'utm_term'
+]
+
+const sorted = (dimensions: string[]) => [...dimensions].sort()
+
+describe(`${getAvailableFilterDimensions.name}`, () => {
+ it('omits props when props are not available', () => {
expect(
- getAvailableFilterModals({
- propsAvailable: false
- })
- ).toEqual({
- browser: ['browser', 'browser_version'],
- goal: ['goal'],
- hostname: ['hostname'],
- location: ['country', 'region', 'city'],
- os: ['os', 'os_version'],
- page: ['page', 'entry_page', 'exit_page'],
- screen: ['screen'],
- source: ['source', 'channel', 'referrer'],
- utm: [
- 'utm_medium',
- 'utm_source',
- 'utm_campaign',
- 'utm_term',
- 'utm_content'
- ],
- segment: ['segment']
- })
+ sorted(
+ getAvailableFilterDimensions({
+ propsAvailable: false
+ })
+ )
+ ).toEqual(ALL_DIMENSIONS.filter((dimension) => dimension !== 'props'))
})
- it('gives full object when props and segments are available', () => {
+ it('includes props when props are available', () => {
expect(
- getAvailableFilterModals({
- propsAvailable: true
- })
- ).toEqual({
- browser: ['browser', 'browser_version'],
- goal: ['goal'],
- hostname: ['hostname'],
- location: ['country', 'region', 'city'],
- os: ['os', 'os_version'],
- page: ['page', 'entry_page', 'exit_page'],
- screen: ['screen'],
- source: ['source', 'channel', 'referrer'],
- utm: [
- 'utm_medium',
- 'utm_source',
- 'utm_campaign',
- 'utm_term',
- 'utm_content'
- ],
- props: ['props'],
- segment: ['segment']
- })
+ sorted(
+ getAvailableFilterDimensions({
+ propsAvailable: true
+ })
+ )
+ ).toEqual(ALL_DIMENSIONS)
})
})
diff --git a/assets/test-utils/jsdom-mocks.ts b/assets/test-utils/jsdom-mocks.ts
index 324a8b1a24..e338a33132 100644
--- a/assets/test-utils/jsdom-mocks.ts
+++ b/assets/test-utils/jsdom-mocks.ts
@@ -1,5 +1,9 @@
-import { configMocks } from 'jsdom-testing-mocks'
+import { configMocks, mockViewport } from 'jsdom-testing-mocks'
import { act } from '@testing-library/react'
// as per jsdom-testing-mocks docs, this is needed to avoid having to wrap everything in act calls
configMocks({ act })
+
+// jsdom has no window.matchMedia. Default every suite to a desktop viewport, and
+// let suites that test responsive behaviour narrow it with mockViewportForTestGroup.
+mockViewport({ width: '1024px', height: '768px' })
diff --git a/e2e/tests/dashboard/filtering.spec.ts b/e2e/tests/dashboard/filtering.spec.ts
index a106e02a79..7ab2b88719 100644
--- a/e2e/tests/dashboard/filtering.spec.ts
+++ b/e2e/tests/dashboard/filtering.spec.ts
@@ -3,6 +3,7 @@ import { setupSite, populateStats, addPageviewGoal } from '../fixtures'
import {
filterButton,
filterItemButton,
+ openFilterSubmenuItem,
applyFilterButton,
filterRow,
suggestedItem,
@@ -11,7 +12,8 @@ import {
} from '../test-utils'
test.describe('page filtering tests', () => {
- const pageFilterButton = (page: Page) => filterItemButton(page, 'Page')
+ const openPageFilter = (page: Page, item: string) =>
+ openFilterSubmenuItem(page, 'Page', item)
test('filtering by page with detailed behavior test', async ({
page,
@@ -36,7 +38,7 @@ test.describe('page filtering tests', () => {
const pageInput = page.getByPlaceholder('Select a Page')
await filterButton(page).click()
- await pageFilterButton(page).click()
+ await openPageFilter(page, 'Page')
await expect(
page.getByRole('heading', { name: 'Filter by Page' })
@@ -91,7 +93,7 @@ test.describe('page filtering tests', () => {
await test.step("'is not' operator", async () => {
await filterButton(page).click()
- await pageFilterButton(page).click()
+ await openPageFilter(page, 'Page')
await filterOperator(pageFilterRow).click()
await filterOperatorOption(pageFilterRow, 'is not').click()
@@ -115,7 +117,7 @@ test.describe('page filtering tests', () => {
await test.step("'contains' operator", async () => {
await filterButton(page).click()
- await pageFilterButton(page).click()
+ await openPageFilter(page, 'Page')
await filterOperator(pageFilterRow).click()
await filterOperatorOption(pageFilterRow, 'contains').click()
@@ -139,7 +141,7 @@ test.describe('page filtering tests', () => {
await test.step("'does not contain' operator", async () => {
await filterButton(page).click()
- await pageFilterButton(page).click()
+ await openPageFilter(page, 'Page')
await filterOperator(pageFilterRow).click()
await filterOperatorOption(pageFilterRow, 'does not contain').click()
@@ -165,7 +167,7 @@ test.describe('page filtering tests', () => {
await test.step("'is' operator with multiple choices", async () => {
await filterButton(page).click()
- await pageFilterButton(page).click()
+ await openPageFilter(page, 'Page')
await pageInput.fill('page')
await suggestedItem(pageFilterRow, '/page2').click()
@@ -205,7 +207,7 @@ test.describe('page filtering tests', () => {
const entryPageInput = page.getByPlaceholder('Select an Entry Page')
await filterButton(page).click()
- await pageFilterButton(page).click()
+ await openPageFilter(page, 'Entry page')
await entryPageInput.fill('page')
await suggestedItem(entryPageFilterRow, '/page1').click()
@@ -242,7 +244,7 @@ test.describe('page filtering tests', () => {
const exitPageInput = page.getByPlaceholder('Select an Exit Page')
await filterButton(page).click()
- await pageFilterButton(page).click()
+ await openPageFilter(page, 'Exit page')
await exitPageInput.fill('page')
await suggestedItem(exitPageFilterRow, '/page3').click()
@@ -295,7 +297,8 @@ test.describe('hostname filtering tests', () => {
})
test.describe('acquisition filtering tests', () => {
- const sourceFilterButton = (page: Page) => filterItemButton(page, 'Source')
+ const openSourceFilter = (page: Page, item: string) =>
+ openFilterSubmenuItem(page, 'Source', item)
test('filtering by source information', async ({ page, request }) => {
const { domain } = await setupSite({ page, request })
@@ -317,7 +320,7 @@ test.describe('acquisition filtering tests', () => {
const sourceInput = page.getByPlaceholder('Select a Source')
await filterButton(page).click()
- await sourceFilterButton(page).click()
+ await openSourceFilter(page, 'Source')
await sourceInput.fill('goog')
await suggestedItem(sourceFilterRow, 'Google').click()
@@ -344,7 +347,7 @@ test.describe('acquisition filtering tests', () => {
const channelInput = page.getByPlaceholder('Select a Channel')
await filterButton(page).click()
- await sourceFilterButton(page).click()
+ await openSourceFilter(page, 'Channel')
await channelInput.fill('paid')
await suggestedItem(channelFilterRow, 'Paid Search').click()
@@ -371,7 +374,7 @@ test.describe('acquisition filtering tests', () => {
const referrerInput = page.getByPlaceholder('Select a Referrer URL')
await filterButton(page).click()
- await sourceFilterButton(page).click()
+ await openSourceFilter(page, 'Referrer URL')
await referrerInput.fill('guard')
await suggestedItem(referrerFilterRow, 'https://theguardian.com').click()
@@ -398,7 +401,8 @@ test.describe('acquisition filtering tests', () => {
})
})
- const utmTagsFilterButton = (page: Page) => filterItemButton(page, 'UTM tags')
+ const openUtmFilter = (page: Page, item: string) =>
+ openFilterSubmenuItem(page, 'UTM tags', item)
test('filtering by UTM tags', async ({ page, request }) => {
const { domain } = await setupSite({ page, request })
@@ -422,7 +426,7 @@ test.describe('acquisition filtering tests', () => {
const utmMediumInput = page.getByPlaceholder('Select a UTM Medium')
await filterButton(page).click()
- await utmTagsFilterButton(page).click()
+ await openUtmFilter(page, 'UTM medium')
await utmMediumInput.fill('soc')
await suggestedItem(utmMediumFilterRow, 'social').click()
@@ -449,7 +453,7 @@ test.describe('acquisition filtering tests', () => {
const utmSourceInput = page.getByPlaceholder('Select a UTM Source')
await filterButton(page).click()
- await utmTagsFilterButton(page).click()
+ await openUtmFilter(page, 'UTM source')
await utmSourceInput.fill('hunt')
await suggestedItem(utmSourceFilterRow, 'producthunt').click()
@@ -476,7 +480,7 @@ test.describe('acquisition filtering tests', () => {
const utmCampaignInput = page.getByPlaceholder('Select a UTM Campaign')
await filterButton(page).click()
- await utmTagsFilterButton(page).click()
+ await openUtmFilter(page, 'UTM campaign')
await utmCampaignInput.fill('ads')
await suggestedItem(utmCampaignFilterRow, 'ads').click()
@@ -503,7 +507,7 @@ test.describe('acquisition filtering tests', () => {
const utmTermInput = page.getByPlaceholder('Select a UTM Term')
await filterButton(page).click()
- await utmTagsFilterButton(page).click()
+ await openUtmFilter(page, 'UTM term')
await utmTermInput.fill('pos')
await suggestedItem(utmTermFilterRow, 'post').click()
@@ -530,7 +534,7 @@ test.describe('acquisition filtering tests', () => {
const utmContentInput = page.getByPlaceholder('Select a UTM Content')
await filterButton(page).click()
- await utmTagsFilterButton(page).click()
+ await openUtmFilter(page, 'UTM content')
await utmContentInput.fill('web')
await suggestedItem(utmContentFilterRow, 'website').click()
@@ -555,8 +559,8 @@ test.describe('acquisition filtering tests', () => {
})
test.describe('location filtering tests', () => {
- const locationFilterButton = (page: Page) =>
- filterItemButton(page, 'Location')
+ const openLocationFilter = (page: Page, item: string) =>
+ openFilterSubmenuItem(page, 'Location', item)
test('filtering by location', async ({ page, request }) => {
const { domain } = await setupSite({ page, request })
@@ -582,7 +586,7 @@ test.describe('location filtering tests', () => {
const countryInput = page.getByPlaceholder('Select a Country')
await filterButton(page).click()
- await locationFilterButton(page).click()
+ await openLocationFilter(page, 'Country')
await countryInput.fill('est')
await suggestedItem(countryFilterRow, 'Estonia').click()
@@ -601,7 +605,7 @@ test.describe('location filtering tests', () => {
const regionInput = page.getByPlaceholder('Select a Region')
await filterButton(page).click()
- await locationFilterButton(page).click()
+ await openLocationFilter(page, 'Region')
await regionInput.fill('har')
await suggestedItem(regionFilterRow, 'Harjumaa').click()
@@ -627,13 +631,13 @@ test.describe('location filtering tests', () => {
// Add a browser filter so city ends up as the 4th pill. This ensures it overflows
// into "See more" regardless of viewport width.
await filterButton(page).click()
- await filterItemButton(page, 'Browser').click()
+ await openFilterSubmenuItem(page, 'Browser', 'Browser')
await browserInput.fill('chrom')
await suggestedItem(browserFilterRow, 'Chrome').click()
await applyFilterButton(page).click()
await filterButton(page).click()
- await locationFilterButton(page).click()
+ await openLocationFilter(page, 'City')
await cityInput.click()
await suggestedItem(cityFilterRow, 'Tallinn').click()
@@ -694,7 +698,8 @@ test.describe('screen size filtering tests', () => {
})
test.describe('browser filtering tests', () => {
- const browserFilterButton = (page: Page) => filterItemButton(page, 'Browser')
+ const openBrowserFilter = (page: Page, item: string) =>
+ openFilterSubmenuItem(page, 'Browser', item)
test('filtering by browser', async ({ page, request }) => {
const { domain } = await setupSite({ page, request })
@@ -717,7 +722,7 @@ test.describe('browser filtering tests', () => {
})
await filterButton(page).click()
- await browserFilterButton(page).click()
+ await openBrowserFilter(page, 'Browser')
await browserInput.fill('chrom')
await suggestedItem(browserFilterRow, 'Chrome').click()
@@ -738,7 +743,7 @@ test.describe('browser filtering tests', () => {
)
await filterButton(page).click()
- await browserFilterButton(page).click()
+ await openBrowserFilter(page, 'Browser version')
await browserVersionInput.fill('14')
await suggestedItem(browserVersionFilterRow, '14.0.7').click()
@@ -756,8 +761,8 @@ test.describe('browser filtering tests', () => {
})
test.describe('operating system filtering tests', () => {
- const operatingSystemFilterButton = (page: Page) =>
- filterItemButton(page, 'Operating system')
+ const openOperatingSystemFilter = (page: Page, item: string) =>
+ openFilterSubmenuItem(page, 'Operating system', item)
test('filtering by operating system', async ({ page, request }) => {
const { domain } = await setupSite({ page, request })
@@ -791,7 +796,7 @@ test.describe('operating system filtering tests', () => {
)
await filterButton(page).click()
- await operatingSystemFilterButton(page).click()
+ await openOperatingSystemFilter(page, 'Operating system')
// The same problem as in the case of screen size filter test.
await operatingSystemInput.click()
@@ -823,19 +828,23 @@ test.describe('operating system filtering tests', () => {
// Add browser and browser version filters so OS version ends up as the 4th pill.
// This ensures it overflows into "See more" regardless of viewport width
await filterButton(page).click()
- await filterItemButton(page, 'Browser').click()
+ await openFilterSubmenuItem(page, 'Browser', 'Browser')
await browserInput.fill('chrom')
await suggestedItem(browserFilterRow, 'Chrome').click()
await applyFilterButton(page).click()
await filterButton(page).click()
- await filterItemButton(page, 'Browser').click()
+ await openFilterSubmenuItem(page, 'Browser', 'Browser version')
await browserVersionInput.fill('14')
await suggestedItem(browserVersionFilterRow, '14.0.7').click()
await applyFilterButton(page).click()
await filterButton(page).click()
- await operatingSystemFilterButton(page).click()
+ await openFilterSubmenuItem(
+ page,
+ 'Operating system',
+ 'Operating system version'
+ )
await operatingSystemVersionInput.click()
await suggestedItem(operatingSystemVersionFilterRow, '11').click()
diff --git a/e2e/tests/dashboard/general.spec.ts b/e2e/tests/dashboard/general.spec.ts
index a3b54cf6e6..f96449a5a6 100644
--- a/e2e/tests/dashboard/general.spec.ts
+++ b/e2e/tests/dashboard/general.spec.ts
@@ -6,6 +6,7 @@ import {
populateStats,
createSharedLink
} from '../fixtures'
+import { openFilterSubmenuItem } from '../test-utils'
test('dashboard renders for logged in user', async ({ page, request }) => {
const { domain } = await setupSite({ page, request })
@@ -166,7 +167,7 @@ test('back navigation closes the modal', async ({ page, request, baseURL }) => {
await page.getByRole('button', { name: 'Filter' }).click()
- await page.getByRole('link', { name: 'Page' }).click()
+ await openFilterSubmenuItem(page, 'Page', 'Page')
await expect(page).toHaveURL(baseURL + '/' + domain + '/filter/page')
diff --git a/e2e/tests/dashboard/segments.spec.ts b/e2e/tests/dashboard/segments.spec.ts
index 4a5699ca0e..c5ef0d3280 100644
--- a/e2e/tests/dashboard/segments.spec.ts
+++ b/e2e/tests/dashboard/segments.spec.ts
@@ -2,7 +2,11 @@ import { test, expect, APIRequestContext, Page } from '@playwright/test'
import { setupSite, populateStats } from '../fixtures'
import {
filterButton,
- filterItemButton,
+ filterSubmenuSegmentItem,
+ openFilterSubmenuItem,
+ openSegmentsSubmenu,
+ closeFilterMenu,
+ filterSubmenuButton,
applyFilterButton,
filterRow,
suggestedItem,
@@ -39,15 +43,15 @@ const setupSiteAndStats = async ({
const segmentMenu = (page: Page) => page.getByTestId('segment-menu')
-const sourceFilterButton = (page: Page) => filterItemButton(page, 'Source')
-const utmTagsFilterButton = (page: Page) => filterItemButton(page, 'UTM tags')
+const segmentItemButton = (page: Page, name: string) =>
+ filterSubmenuSegmentItem(page, name)
const addSourceFilter = async (page: Page, sourceLabel: string) => {
const sourceFilterRow = filterRow(page, 'source')
const sourceInput = page.getByPlaceholder('Select a Source')
await filterButton(page).click()
- await sourceFilterButton(page).click()
+ await openFilterSubmenuItem(page, 'Source', 'Source')
await sourceInput.click()
await suggestedItem(sourceFilterRow, sourceLabel).click()
@@ -63,7 +67,7 @@ const addUtmSourceFilter = async (page: Page, utmSource: string) => {
const utmSourceInput = page.getByPlaceholder('Select a UTM Source')
await filterButton(page).click()
- await utmTagsFilterButton(page).click()
+ await openFilterSubmenuItem(page, 'UTM tags', 'UTM source')
await utmSourceInput.click()
await suggestedItem(utmSourceFilterRow, utmSource).click()
@@ -125,10 +129,11 @@ test('saving a segment', async ({ page, request }) => {
.click()
await filterButton(page).click()
+ await openSegmentsSubmenu(page)
- await expect(filterItemButton(page, 'Source is Facebook')).toBeVisible()
+ await expect(segmentItemButton(page, 'Source is Facebook')).toBeVisible()
- await filterButton(page).click()
+ await closeFilterMenu(page)
})
await test.step('creating a personal segment with a custom name', async () => {
@@ -163,11 +168,12 @@ test('saving a segment', async ({ page, request }) => {
.click()
await filterButton(page).click()
+ await openSegmentsSubmenu(page)
- await expect(filterItemButton(page, 'Traffic from Google')).toBeVisible()
- await expect(filterItemButton(page, 'Source is Facebook')).toBeVisible()
+ await expect(segmentItemButton(page, 'Traffic from Google')).toBeVisible()
+ await expect(segmentItemButton(page, 'Source is Facebook')).toBeVisible()
- await filterButton(page).click()
+ await closeFilterMenu(page)
})
await test.step('creating a site segment from more than one filter', async () => {
@@ -211,12 +217,13 @@ test('saving a segment', async ({ page, request }) => {
.click()
await filterButton(page).click()
+ await openSegmentsSubmenu(page)
- await expect(filterItemButton(page, 'Ads from Google')).toBeVisible()
- await expect(filterItemButton(page, 'Traffic from Google')).toBeVisible()
- await expect(filterItemButton(page, 'Source is Facebook')).toBeVisible()
+ await expect(segmentItemButton(page, 'Ads from Google')).toBeVisible()
+ await expect(segmentItemButton(page, 'Traffic from Google')).toBeVisible()
+ await expect(segmentItemButton(page, 'Source is Facebook')).toBeVisible()
- await filterButton(page).click()
+ await closeFilterMenu(page)
})
})
@@ -232,28 +239,31 @@ test('creating a segment from a combination of segment and a filter is not allow
await createPersonalSegment(page, 'Traffic from Google')
await addUtmSourceFilter(page, 'Adwords')
- // Add UTM medium and campaign filters so Segment ends up as the 4th pill.
- // This ensures it overflows into "See more" regardless of viewport width
+ // Add UTM medium and campaign filters. Every new filter is prepended, so
+ // Segment ends up as the last pill and overflows into "See more".
const utmMediumFilterRow = filterRow(page, 'utm_medium')
const utmCampaignFilterRow = filterRow(page, 'utm_campaign')
await filterButton(page).click()
- await utmTagsFilterButton(page).click()
+ await openFilterSubmenuItem(page, 'UTM tags', 'UTM medium')
await page.getByPlaceholder('Select a UTM Medium').click()
await suggestedItem(utmMediumFilterRow, 'email').click()
await applyFilterButton(page).click()
await filterButton(page).click()
- await utmTagsFilterButton(page).click()
+ await openFilterSubmenuItem(page, 'UTM tags', 'UTM campaign')
await page.getByPlaceholder('Select a UTM Campaign').click()
await suggestedItem(utmCampaignFilterRow, 'promo').click()
await applyFilterButton(page).click()
await expect(
- page.getByRole('link', { name: 'UTM source is Adwords' })
+ page.getByRole('link', { name: 'UTM campaign is promo' })
).toBeVisible()
await page.getByRole('button', { name: /See.*more/ }).click()
+ await expect(
+ page.getByRole('link', { name: 'UTM source is Adwords' })
+ ).toBeVisible()
await expect(
page.getByRole('link', { name: 'Segment is Traffic from Google' })
).toBeVisible()
@@ -306,9 +316,10 @@ test('editing an existing segment', async ({ page, request }) => {
await expect(page).not.toHaveURL(/f=is,segment,[0-9]+/)
await filterButton(page).click()
+ await openSegmentsSubmenu(page)
- await expect(filterItemButton(page, 'Ads from Google')).toBeVisible()
- await expect(filterItemButton(page, 'Traffic from Google')).toBeHidden()
+ await expect(segmentItemButton(page, 'Ads from Google')).toBeVisible()
+ await expect(segmentItemButton(page, 'Traffic from Google')).toBeHidden()
})
test('saving edited segment as new', async ({ page, request }) => {
@@ -351,11 +362,12 @@ test('saving edited segment as new', async ({ page, request }) => {
await modal(page).getByRole('button', { name: 'Remove filter' }).click()
await filterButton(page).click()
+ await openSegmentsSubmenu(page)
- await expect(filterItemButton(page, 'Ads from Google')).toBeVisible()
- await expect(filterItemButton(page, 'Traffic from Google')).toBeVisible()
+ await expect(segmentItemButton(page, 'Ads from Google')).toBeVisible()
+ await expect(segmentItemButton(page, 'Traffic from Google')).toBeVisible()
- await filterItemButton(page, 'Traffic from Google').click()
+ await segmentItemButton(page, 'Traffic from Google').click()
await page
.getByRole('link', { name: 'Segment is Traffic from Google' })
@@ -391,7 +403,8 @@ test('deleting segment', async ({ page, request }) => {
await filterButton(page).click()
- await expect(filterItemButton(page, 'Traffic from Google')).toBeHidden()
+ // The only segment is gone, so the filter menu no longer offers segments at all.
+ await expect(filterSubmenuButton(page, 'Segment')).toBeHidden()
})
test('closing edited segment without saving', async ({ page, request }) => {
@@ -415,8 +428,9 @@ test('closing edited segment without saving', async ({ page, request }) => {
await page.getByRole('link', { name: 'Close without saving' }).click()
await filterButton(page).click()
+ await openSegmentsSubmenu(page)
- await filterItemButton(page, 'Traffic from Google').click()
+ await segmentItemButton(page, 'Traffic from Google').click()
await page
.getByRole('link', { name: 'Segment is Traffic from Google' })
diff --git a/e2e/tests/test-utils.ts b/e2e/tests/test-utils.ts
index d9cb86b04a..b25c4330d7 100644
--- a/e2e/tests/test-utils.ts
+++ b/e2e/tests/test-utils.ts
@@ -88,8 +88,40 @@ export const closeModalButton = (page: Page) =>
export const filterButton = (page: Page) =>
page.getByRole('button', { name: 'Filter', exact: true })
+const filterMenu = (page: Page) => page.getByTestId('filtermenu')
+
+const filterSubmenu = (page: Page) => page.getByTestId('filtermenu-submenu')
+
export const filterItemButton = (page: Page, label: HasTextArg) =>
- page.getByTestId('filtermenu').getByRole('link', { name: label, exact: true })
+ filterMenu(page).getByRole('link', { name: label, exact: true })
+
+export const filterSubmenuButton = (page: Page, label: HasTextArg) =>
+ filterMenu(page).getByRole('button', { name: label, exact: true })
+
+export const filterSubmenuItemButton = (page: Page, label: HasTextArg) =>
+ filterSubmenu(page).getByRole('link', { name: label, exact: true })
+
+export const filterSubmenuSegmentItem = (page: Page, name: HasTextArg) =>
+ filterSubmenu(page).getByRole('link').filter({ hasText: name })
+
+export const openFilterSubmenuItem = async (
+ page: Page,
+ row: string,
+ item: string
+) => {
+ await filterSubmenuButton(page, row).click()
+ await filterSubmenuItemButton(page, item).click()
+}
+
+export const openSegmentsSubmenu = (page: Page) =>
+ filterSubmenuButton(page, 'Segment').click()
+
+// Waits for the panel to unmount. Reopening the menu during its closing
+// animation leaves the panel unmounted.
+export const closeFilterMenu = async (page: Page) => {
+ await filterButton(page).click()
+ await expect(filterMenu(page)).toBeHidden()
+}
export const applyFilterButton = (page: Page, { disabled = false } = {}) =>
page.getByRole('button', {