Skip to content

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

Add filter helpers for inline filter editing (#6729)

Sanne de Vries457cf5acf5c0
diff --git a/assets/js/dashboard/nav-menu/segments/segment-pill-menu.tsx b/assets/js/dashboard/nav-menu/segments/segment-pill-menu.tsx
index c0d2cb96b8..1db2f26c81 100644
--- a/assets/js/dashboard/nav-menu/segments/segment-pill-menu.tsx
+++ b/assets/js/dashboard/nav-menu/segments/segment-pill-menu.tsx
@@ -7,7 +7,7 @@ import {
getNavigationToExpandSegment,
SavedSegments
} from '../../filtering/segments'
-import { plainFilterTextParts } from '../../util/filter-text'
+import { getFilterTextParts } from '../../util/filter-text'
import { SegmentAuthorship } from '../../segments/segment-authorship'
import { Role, useUserContext } from '../../user-context'
import { useRoutelessModalsContext } from '../../navigation/routeless-modals-context'
@@ -36,7 +36,7 @@ const deleteClassName = classNames(
const SegmentFilters = ({ segment }: { segment: SavedSegments[number] }) => (
<>
{segment.segment_data.filters.map((filter, index) => {
- const { subject, values } = plainFilterTextParts(
+ const { dimension, operation, values } = getFilterTextParts(
segment.segment_data,
filter
)
@@ -49,9 +49,9 @@ const SegmentFilters = ({ segment }: { segment: SavedSegments[number] }) => (
)}
>
<span className={popover.items.classNames.description}>
- {subject}
+ {`${dimension} ${operation}`}
</span>
- <span className="break-words">{values}</span>
+ <span className="break-words">{values.join(' or ')}</span>
</div>
)
})}
diff --git a/assets/js/dashboard/util/fetch-suggestions.test.ts b/assets/js/dashboard/util/fetch-suggestions.test.ts
new file mode 100644
index 0000000000..1dbe66fd3d
--- /dev/null
+++ b/assets/js/dashboard/util/fetch-suggestions.test.ts
@@ -0,0 +1,33 @@
+import { Filter } from '../dashboard-state'
+import { getValueSuggestionsRequest } from './fetch-suggestions'
+
+const site = { domain: 'dummy.site' }
+
+describe(`${getValueSuggestionsRequest.name}`, () => {
+ it.each<[Filter, ReturnType<typeof getValueSuggestionsRequest>]>([
+ [
+ ['is', 'source', ['Google']],
+ {
+ path: '/api/stats/dummy.site/suggestions/source/',
+ additionalFilter: ['is_not', 'source', []]
+ }
+ ],
+ [
+ ['is', 'goal', ['Signup']],
+ {
+ path: '/api/stats/dummy.site/suggestions/goal/',
+ additionalFilter: undefined
+ }
+ ],
+ [
+ ['is', 'props:author', ['john']],
+ {
+ path: '/api/stats/dummy.site/suggestions/custom-prop-values/author/',
+ additionalFilter: ['is_not', 'props:author', ['(none)']]
+ }
+ ],
+ [['contains', 'page', ['/blog']], null]
+ ])('for %p returns %p', (filter, expectedRequest) => {
+ expect(getValueSuggestionsRequest(site, filter)).toEqual(expectedRequest)
+ })
+})
diff --git a/assets/js/dashboard/util/fetch-suggestions.ts b/assets/js/dashboard/util/fetch-suggestions.ts
index e42e624fdd..8dfd4ae7be 100644
--- a/assets/js/dashboard/util/fetch-suggestions.ts
+++ b/assets/js/dashboard/util/fetch-suggestions.ts
@@ -1,15 +1,54 @@
import * as api from '../api'
import { DashboardState, Filter } from '../dashboard-state'
-import { replaceFilterByPrefix, omitFiltersByKeyPrefix } from './filters'
+import { PlausibleSite } from '../site-context'
+import { apiPath } from './url'
+import {
+ replaceFilterByPrefix,
+ omitFiltersByKeyPrefix,
+ EVENT_PROPS_PREFIX,
+ FILTER_OPERATIONS,
+ getPropertyKeyFromFilterKey,
+ isFreeChoiceFilterOperation
+} from './filters'
+
+export type Suggestion = { value: string | number; label: string }
+
+export type SuggestionsRequest = { path: string; additionalFilter?: Filter }
export function fetchSuggestions(
- apiPath: string,
+ path: string,
dashboardState: DashboardState,
input: string,
additionalFilter?: Filter
-) {
+): Promise<Suggestion[]> {
const updatedQuery = queryForSuggestions(dashboardState, additionalFilter)
- return api.get(apiPath, updatedQuery, { q: input.trim() })
+ return api.get(path, updatedQuery, { q: input.trim() })
+}
+
+export function getValueSuggestionsRequest(
+ site: Pick<PlausibleSite, 'domain'>,
+ [operation, filterKey]: Filter
+): SuggestionsRequest | null {
+ if (isFreeChoiceFilterOperation(operation)) {
+ return null
+ }
+ if (filterKey.startsWith(EVENT_PROPS_PREFIX)) {
+ const propKey = getPropertyKeyFromFilterKey(filterKey)
+ return {
+ path: apiPath(
+ site,
+ `/suggestions/custom-prop-values/${encodeURIComponent(propKey)}`
+ ),
+ additionalFilter: [FILTER_OPERATIONS.isNot, filterKey, ['(none)']]
+ }
+ }
+ return {
+ path: apiPath(site, `/suggestions/${filterKey}`),
+ additionalFilter:
+ filterKey === 'goal'
+ ? undefined
+ : [FILTER_OPERATIONS.isNot, filterKey, []]
+ }
}
function queryForSuggestions(
diff --git a/assets/js/dashboard/util/filter-text.test.tsx b/assets/js/dashboard/util/filter-text.test.tsx
index 0e02d49dcc..1179c5cc19 100644
--- a/assets/js/dashboard/util/filter-text.test.tsx
+++ b/assets/js/dashboard/util/filter-text.test.tsx
@@ -3,7 +3,7 @@ import { Filter, FilterClauseLabels } from '../dashboard-state'
import { plainFilterText, styledFilterText } from './filter-text'
import { render, screen } from '@testing-library/react'
-describe('styledFilterText() and plainFilterText()', () => {
+describe('plainFilterText()', () => {
it.each<[Filter, FilterClauseLabels, string]>([
[['is', 'page', ['/docs', '/blog']], {}, 'Page is /docs or /blog'],
[
@@ -15,28 +15,47 @@ describe('styledFilterText() and plainFilterText()', () => {
[
['is', 'props:browser_language', ['en-US']],
{},
- 'Property browser_language is en-US'
+ "Property 'browser_language' is en-US"
],
[
['has_not_done', 'goal', ['Signup', 'Login']],
{},
'Goal is not Signup or Login'
- ]
+ ],
+ [['is', 'source', []], {}, 'Source is']
])(
- 'when filter is %p and labels are %p, functions return %p',
+ 'when filter is %p and labels are %p, returns %p',
(filter, labels, expectedPlainText) => {
- const dashboardState = { labels }
-
- expect(plainFilterText(dashboardState, filter)).toBe(expectedPlainText)
+ expect(plainFilterText({ labels }, filter)).toBe(expectedPlainText)
+ }
+ )
+})
+describe('styledFilterText()', () => {
+ it.each<[Filter, FilterClauseLabels, string]>([
+ [['is', 'page', ['/docs', '/blog']], {}, 'Page is /docs or /blog'],
+ [
+ ['is', 'country', ['US']],
+ { US: 'United States' },
+ 'Country is United States'
+ ],
+ [
+ ['is', 'props:browser_language', ['en-US']],
+ {},
+ 'Property browser_language is en-US'
+ ],
+ [
+ ['has_not_done', 'goal', ['Signup', 'Login']],
+ {},
+ 'Goal is not Signup or Login'
+ ]
+ ])(
+ 'when filter is %p and labels are %p, renders %p',
+ (filter, labels, expectedText) => {
render(
- <p data-testid="filter-text">
- {styledFilterText(dashboardState, filter)}
- </p>
- )
- expect(screen.getByTestId('filter-text')).toHaveTextContent(
- expectedPlainText
+ <p data-testid="filter-text">{styledFilterText({ labels }, filter)}</p>
)
+ expect(screen.getByTestId('filter-text')).toHaveTextContent(expectedText)
}
)
})
diff --git a/assets/js/dashboard/util/filter-text.tsx b/assets/js/dashboard/util/filter-text.tsx
index b41a09a1df..371f51dc1a 100644
--- a/assets/js/dashboard/util/filter-text.tsx
+++ b/assets/js/dashboard/util/filter-text.tsx
@@ -1,4 +1,4 @@
-import React, { ReactNode, isValidElement, Fragment } from 'react'
+import React, { ReactNode, Fragment } from 'react'
import { DashboardState, Filter } from '../dashboard-state'
import {
EVENT_PROPS_PREFIX,
@@ -41,37 +41,43 @@ export function styledFilterText(
)
}
-/** e.g. { subject: 'Country is', values: 'Germany or Poland' } */
-export function plainFilterTextParts(
+/** e.g. { dimension: 'Country', operation: 'is', values: ['Germany', 'Poland'] } */
+export function getFilterTextParts(
dashboardState: Pick<DashboardState, 'labels'>,
[operation, filterKey, clauses]: Filter
) {
- const operationName = FILTER_OPERATIONS_DISPLAY_NAMES[operation]
- if (filterKey.startsWith(EVENT_PROPS_PREFIX)) {
- return {
- subject: `Property ${getPropertyKeyFromFilterKey(filterKey)} ${operationName}`,
- values: clauses.join(' or ')
- }
- }
- const formattedFilter = (
- formattedFilters as Record<string, string | undefined>
- )[filterKey]
- if (!formattedFilter) {
- throw new Error(`Unknown filter: ${filterKey}`)
- }
return {
- subject: `${capitalize(formattedFilter)} ${operationName}`,
- values: clauses
- .map((value) => getLabel(dashboardState.labels, filterKey, value))
- .join(' or ')
+ dimension: getDimensionName(filterKey),
+ operation: FILTER_OPERATIONS_DISPLAY_NAMES[operation],
+ values: clauses.map((value) =>
+ getLabel(dashboardState.labels, filterKey, value)
+ )
}
}
+/** e.g. 'Country is Germany or Poland' */
export function plainFilterText(
dashboardState: Pick<DashboardState, 'labels'>,
filter: Filter
) {
- return reactNodeToString(styledFilterText(dashboardState, filter))
+ const { dimension, operation, values } = getFilterTextParts(
+ dashboardState,
+ filter
+ )
+ return [dimension, operation, values.join(' or ')].filter(Boolean).join(' ')
+}
+
+function getDimensionName(filterKey: string): string {
+ if (filterKey.startsWith(EVENT_PROPS_PREFIX)) {
+ return `Property '${getPropertyKeyFromFilterKey(filterKey)}'`
+ }
+ const formattedFilter = (
+ formattedFilters as Record<string, string | undefined>
+ )[filterKey]
+ if (!formattedFilter) {
+ throw new Error(`Unknown filter: ${filterKey}`)
+ }
+ return capitalize(formattedFilter)
}
function formatClauses(labels: Array<string | number>): ReactNode[] {
@@ -86,19 +92,3 @@ function formatClauses(labels: Array<string | number>): ReactNode[] {
function capitalize(str: string): string {
return str[0].toUpperCase() + str.slice(1)
}
-
-function reactNodeToString(reactNode: ReactNode): string {
- let string = ''
- if (typeof reactNode === 'string') {
- string = reactNode
- } else if (typeof reactNode === 'number') {
- string = reactNode.toString()
- } else if (reactNode instanceof Array) {
- reactNode.forEach(function (child) {
- string += reactNodeToString(child)
- })
- } else if (isValidElement(reactNode)) {
- string += reactNodeToString(reactNode.props.children)
- }
- return string
-}
diff --git a/assets/js/dashboard/util/filters.js b/assets/js/dashboard/util/filters.js
index d13759751d..631630f48a 100644
--- a/assets/js/dashboard/util/filters.js
+++ b/assets/js/dashboard/util/filters.js
@@ -54,6 +54,21 @@ export function supportsHasDoneNot(filterName) {
return filterName === 'goal'
}
+export function getSupportedOperations(filterKey) {
+ if (filterKey === 'segment') {
+ return [FILTER_OPERATIONS.is]
+ }
+ const supported = {
+ [FILTER_OPERATIONS.is]: true,
+ [FILTER_OPERATIONS.isNot]: supportsIsNot(filterKey),
+ [FILTER_OPERATIONS.has_not_done]: supportsHasDoneNot(filterKey),
+ [FILTER_OPERATIONS.contains]: supportsContains(filterKey),
+ [FILTER_OPERATIONS.contains_not]:
+ supportsContains(filterKey) && supportsIsNot(filterKey)
+ }
+ return Object.keys(supported).filter((operation) => supported[operation])
+}
+
export function isFreeChoiceFilterOperation(operation) {
return [FILTER_OPERATIONS.contains, FILTER_OPERATIONS.contains_not].includes(
operation
@@ -61,15 +76,14 @@ export function isFreeChoiceFilterOperation(operation) {
}
export function getLabel(labels, filterKey, value) {
+ let label = value
if (['country', 'region', 'city'].includes(filterKey)) {
- return labels[value]
+ label = labels[value]
}
-
if (filterKey === 'segment') {
- return labels[formatSegmentIdAsLabelKey(value)]
+ label = labels[formatSegmentIdAsLabelKey(value)]
}
-
- return value
+ return String(label ?? value)
}
export function getPropertyKeyFromFilterKey(filterKey) {
diff --git a/assets/js/dashboard/util/filters.test.ts b/assets/js/dashboard/util/filters.test.ts
index 837e64a2b7..f9cb028740 100644
--- a/assets/js/dashboard/util/filters.test.ts
+++ b/assets/js/dashboard/util/filters.test.ts
@@ -1,4 +1,8 @@
-import { getAvailableFilterDimensions, serializeApiFilters } from './filters'
+import {
+ getAvailableFilterDimensions,
+ getSupportedOperations,
+ serializeApiFilters
+} from './filters'
const ALL_DIMENSIONS = [
'browser',
@@ -50,6 +54,19 @@ describe(`${getAvailableFilterDimensions.name}`, () => {
})
})
+describe(`${getSupportedOperations.name}`, () => {
+ it.each([
+ ['page', ['is', 'is_not', 'contains', 'contains_not']],
+ ['props:author', ['is', 'is_not', 'contains', 'contains_not']],
+ ['goal', ['is', 'has_not_done', 'contains']],
+ ['country', ['is', 'is_not']],
+ ['screen', ['is', 'is_not']],
+ ['segment', ['is']]
+ ])('for %s returns %p', (filterKey, expectedOperations) => {
+ expect(getSupportedOperations(filterKey)).toEqual(expectedOperations)
+ })
+})
+
describe(`${serializeApiFilters.name}`, () => {
it('should prefix filter keys with event: or visit: when appropriate', () => {
const filters = [
diff --git a/e2e/tests/dashboard/csv-export.spec.ts b/e2e/tests/dashboard/csv-export.spec.ts
index b6bf9d5702..92e8894af7 100644
--- a/e2e/tests/dashboard/csv-export.spec.ts
+++ b/e2e/tests/dashboard/csv-export.spec.ts
@@ -275,7 +275,7 @@ test('csv export column headers match expected metrics for each report', async (
await expect(
page.getByRole('button', {
- name: 'Remove filter: Property author is john'
+ name: "Remove filter: Property 'author' is john"
})
).toBeVisible()