Skip to content

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

Excluding goals in dashboard (#4983)

Karl-Aksel Puulmannc0a762ae5669
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6b5620f617..85d597ad51 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file.
- Dashboard shows comparisons for all reports
- UTM Medium report and API shows (gclid) and (msclkid) for paid searches when no explicit utm medium present.
- Support for `case_sensitive: false` modifiers in Stats API V2 filters for case-insensitive searches.
+- Add filter `is not` for goals in dashboard plausible/analytics#4983
### Removed
diff --git a/assets/js/dashboard/components/filter-operator-selector.js b/assets/js/dashboard/components/filter-operator-selector.js
index 32a1852147..a45c560e38 100644
--- a/assets/js/dashboard/components/filter-operator-selector.js
+++ b/assets/js/dashboard/components/filter-operator-selector.js
@@ -6,7 +6,8 @@ import {
FILTER_OPERATIONS,
FILTER_OPERATIONS_DISPLAY_NAMES,
supportsContains,
- supportsIsNot
+ supportsIsNot,
+ supportsHasDoneNot
} from '../util/filters'
import { Menu, Transition } from '@headlessui/react'
import { ChevronDownIcon } from '@heroicons/react/20/solid'
@@ -75,6 +76,10 @@ export default function FilterOperatorSelector(props) {
FILTER_OPERATIONS.isNot,
supportsIsNot(filterName)
)}
+ {renderTypeItem(
+ FILTER_OPERATIONS.has_not_done,
+ supportsHasDoneNot(filterName)
+ )}
{renderTypeItem(
FILTER_OPERATIONS.contains,
supportsContains(filterName)
diff --git a/assets/js/dashboard/filters.js b/assets/js/dashboard/filters.js
index 40fc8ec01c..a0765e076d 100644
--- a/assets/js/dashboard/filters.js
+++ b/assets/js/dashboard/filters.js
@@ -12,10 +12,9 @@ import {
cleanLabels,
FILTER_MODAL_TO_FILTER_GROUP,
formatFilterGroup,
- EVENT_PROPS_PREFIX,
- plainFilterText,
- styledFilterText
-} from "./util/filters";
+ EVENT_PROPS_PREFIX
+} from "./util/filters"
+import { plainFilterText, styledFilterText } from "./util/filter-text"
const WRAPSTATE = { unwrapped: 0, waiting: 1, wrapped: 2 }
diff --git a/assets/js/dashboard/nav-menu/filter-pills-list.tsx b/assets/js/dashboard/nav-menu/filter-pills-list.tsx
index 830cae556f..a6c21758e4 100644
--- a/assets/js/dashboard/nav-menu/filter-pills-list.tsx
+++ b/assets/js/dashboard/nav-menu/filter-pills-list.tsx
@@ -6,10 +6,9 @@ import { FilterPill } from './filter-pill'
import {
cleanLabels,
EVENT_PROPS_PREFIX,
- FILTER_GROUP_TO_MODAL_TYPE,
- plainFilterText,
- styledFilterText
+ FILTER_GROUP_TO_MODAL_TYPE
} from '../util/filters'
+import { styledFilterText, plainFilterText } from '../util/filter-text'
import { useAppNavigate } from '../navigation/use-app-navigate'
import classNames from 'classnames'
diff --git a/assets/js/dashboard/nav-menu/filters-bar.test.tsx b/assets/js/dashboard/nav-menu/filters-bar.test.tsx
index 97d83577c3..13c99786a3 100644
--- a/assets/js/dashboard/nav-menu/filters-bar.test.tsx
+++ b/assets/js/dashboard/nav-menu/filters-bar.test.tsx
@@ -61,9 +61,9 @@ test('user can see expected filters and clear them one by one or all together',
)
expect(queryFilterPills().map((m) => m.textContent)).toEqual([
- 'Country is Germany ',
- 'Goal is Subscribed to Newsletter ',
- 'Page is /docs or /blog '
+ 'Country is Germany',
+ 'Goal is Subscribed to Newsletter',
+ 'Page is /docs or /blog'
])
await userEvent.click(
@@ -74,8 +74,8 @@ test('user can see expected filters and clear them one by one or all together',
)
expect(queryFilterPills().map((m) => m.textContent)).toEqual([
- 'Goal is Subscribed to Newsletter ',
- 'Page is /docs or /blog '
+ 'Goal is Subscribed to Newsletter',
+ 'Page is /docs or /blog'
])
await userEvent.click(
diff --git a/assets/js/dashboard/stats/modals/filter-modal-group.js b/assets/js/dashboard/stats/modals/filter-modal-group.js
index dd8ea2bb1a..63c5f832a0 100644
--- a/assets/js/dashboard/stats/modals/filter-modal-group.js
+++ b/assets/js/dashboard/stats/modals/filter-modal-group.js
@@ -20,7 +20,7 @@ export default function FilterModalGroup({
[filterGroup, rows]
)
- const showAddRow = filterGroup == 'props'
+ const showAddRow = ['props', 'goal'].includes(filterGroup)
const showTitle = filterGroup != 'props'
return (
@@ -42,7 +42,10 @@ export default function FilterModalGroup({
key={id}
filter={filter}
labels={labels}
+ canDelete={showAddRow}
+ showDelete={rows.length > 1}
onUpdate={(newFilter, labelUpdate) => onUpdateRowValue(id, newFilter, labelUpdate)}
+ onDelete={() => onDeleteRow(id)}
/>
)
)}
diff --git a/assets/js/dashboard/stats/modals/filter-modal-props-row.js b/assets/js/dashboard/stats/modals/filter-modal-props-row.js
index c13b3c924b..89ed40f0af 100644
--- a/assets/js/dashboard/stats/modals/filter-modal-props-row.js
+++ b/assets/js/dashboard/stats/modals/filter-modal-props-row.js
@@ -112,7 +112,7 @@ export default function FilterModalPropsRow({
/>
</div>
{showDelete && (
- <div className="col-span-1 flex flex-col justify-center">
+ <div className="col-span-1 flex flex-col mt-2">
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
<a
className="ml-2 text-red-600 h-5 w-5 cursor-pointer"
diff --git a/assets/js/dashboard/stats/modals/filter-modal-row.js b/assets/js/dashboard/stats/modals/filter-modal-row.js
index 03b171022a..dc9b4699c1 100644
--- a/assets/js/dashboard/stats/modals/filter-modal-row.js
+++ b/assets/js/dashboard/stats/modals/filter-modal-row.js
@@ -1,6 +1,8 @@
/** @format */
import React, { useMemo } from 'react'
+import { TrashIcon } from '@heroicons/react/20/solid'
+import classNames from 'classnames'
import FilterOperatorSelector from '../../components/filter-operator-selector'
import Combobox from '../../components/combobox'
@@ -16,7 +18,14 @@ import { apiPath } from '../../util/url'
import { useQueryContext } from '../../query-context'
import { useSiteContext } from '../../site-context'
-export default function FilterModalRow({ filter, labels, onUpdate }) {
+export default function FilterModalRow({
+ filter,
+ labels,
+ canDelete,
+ showDelete,
+ onUpdate,
+ onDelete
+}) {
const { query } = useQueryContext()
const site = useSiteContext()
const [operation, filterKey, clauses] = filter
@@ -64,7 +73,12 @@ export default function FilterModalRow({ filter, labels, onUpdate }) {
}
return (
- <div className="grid grid-cols-11 mt-1">
+ <div
+ className={classNames('grid mt-1', {
+ 'grid-cols-12': canDelete,
+ 'grid-cols-11': !canDelete
+ })}
+ >
<div className="col-span-3">
<FilterOperatorSelector
forFilter={filterKey}
@@ -83,6 +97,17 @@ export default function FilterModalRow({ filter, labels, onUpdate }) {
placeholder={`Select ${withIndefiniteArticle(formattedFilters[filterKey])}`}
/>
</div>
+ {showDelete && (
+ <div className="col-span-1 flex flex-col mt-2">
+ {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
+ <a
+ className="ml-2 text-red-600 h-5 w-5 cursor-pointer"
+ onClick={onDelete}
+ >
+ <TrashIcon />
+ </a>
+ </div>
+ )}
</div>
)
}
diff --git a/assets/js/dashboard/stats/reports/list.js b/assets/js/dashboard/stats/reports/list.js
index ae7e09fd48..b0cea772f7 100644
--- a/assets/js/dashboard/stats/reports/list.js
+++ b/assets/js/dashboard/stats/reports/list.js
@@ -14,9 +14,9 @@ import {
cleanLabels,
replaceFilterByPrefix,
isRealTimeDashboard,
- hasGoalFilter,
- plainFilterText
+ hasGoalFilter
} from '../../util/filters'
+import { plainFilterText } from '../../util/filter-text'
import { useQueryContext } from '../../query-context'
const MAX_ITEMS = 9
diff --git a/assets/js/dashboard/util/filter-text.test.tsx b/assets/js/dashboard/util/filter-text.test.tsx
new file mode 100644
index 0000000000..6f05294ae1
--- /dev/null
+++ b/assets/js/dashboard/util/filter-text.test.tsx
@@ -0,0 +1,24 @@
+import React from 'react'
+import { DashboardQuery, Filter, FilterClauseLabels } from '../query'
+import { plainFilterText, styledFilterText } from './filter-text'
+import { render, screen } from '@testing-library/react'
+
+describe('styledFilterText() and plainFilterText()', () => {
+ 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', 'goal', ['Signup']], {}, 'Goal is Signup'],
+ [['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, functions return %p',
+ (filter, labels, expectedPlainText) => {
+ const query = { labels } as unknown as DashboardQuery
+
+ expect(plainFilterText(query, filter)).toBe(expectedPlainText)
+
+ render(<p data-testid="filter-text">{styledFilterText(query, filter)}</p>)
+ expect(screen.getByTestId('filter-text')).toHaveTextContent(expectedPlainText)
+ }
+ )
+})
diff --git a/assets/js/dashboard/util/filter-text.tsx b/assets/js/dashboard/util/filter-text.tsx
new file mode 100644
index 0000000000..42e1892101
--- /dev/null
+++ b/assets/js/dashboard/util/filter-text.tsx
@@ -0,0 +1,77 @@
+/* @format */
+
+import React, { ReactNode, isValidElement, Fragment } from 'react'
+import { DashboardQuery, Filter } from '../query'
+import {
+ EVENT_PROPS_PREFIX,
+ FILTER_OPERATIONS_DISPLAY_NAMES,
+ formattedFilters,
+ getLabel,
+ getPropertyKeyFromFilterKey
+} from './filters'
+
+export function styledFilterText(
+ query: DashboardQuery,
+ [operation, filterKey, clauses]: Filter
+) {
+ if (filterKey.startsWith(EVENT_PROPS_PREFIX)) {
+ const propKey = getPropertyKeyFromFilterKey(filterKey)
+ return (
+ <>
+ Property <b>{propKey}</b> {FILTER_OPERATIONS_DISPLAY_NAMES[operation]}{' '}
+ {formatClauses(clauses)}
+ </>
+ )
+ }
+
+ const formattedFilter = (
+ formattedFilters as Record<string, string | undefined>
+ )[filterKey]
+ const clausesLabels = clauses.map((value) =>
+ getLabel(query.labels, filterKey, value)
+ )
+
+ if (!formattedFilter) {
+ throw new Error(`Unknown filter: ${filterKey}`)
+ }
+
+ return (
+ <>
+ {capitalize(formattedFilter)} {FILTER_OPERATIONS_DISPLAY_NAMES[operation]}{' '}
+ {formatClauses(clausesLabels)}
+ </>
+ )
+}
+
+export function plainFilterText(query: DashboardQuery, filter: Filter) {
+ return reactNodeToString(styledFilterText(query, filter))
+}
+
+function formatClauses(labels: Array<string | number>): ReactNode[] {
+ return labels.map((label, index) => (
+ <Fragment key={index}>
+ {index > 0 && ' or '}
+ <b>{label}</b>
+ </Fragment>
+ ))
+}
+
+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 082573c2aa..eeca12943e 100644
--- a/assets/js/dashboard/util/filters.js
+++ b/assets/js/dashboard/util/filters.js
@@ -1,6 +1,5 @@
/** @format */
-import React from 'react'
import * as api from '../api'
export const FILTER_MODAL_TO_FILTER_GROUP = {
@@ -29,14 +28,18 @@ export const FILTER_OPERATIONS = {
is: 'is',
isNot: 'is_not',
contains: 'contains',
- contains_not: 'contains_not'
+ contains_not: 'contains_not',
+ has_not_done: 'has_not_done'
}
export const FILTER_OPERATIONS_DISPLAY_NAMES = {
[FILTER_OPERATIONS.is]: 'is',
[FILTER_OPERATIONS.isNot]: 'is not',
[FILTER_OPERATIONS.contains]: 'contains',
- [FILTER_OPERATIONS.contains_not]: 'does not contain'
+ [FILTER_OPERATIONS.contains_not]: 'does not contain',
+ // :NOTE: Goal filters are displayed as "is not" in the UI, but in the backend they are wrapped with has_not_done.
+ // It is currently unclear if we'll do the same for other event filters in the future.
+ [FILTER_OPERATIONS.has_not_done]: 'is not'
}
export function supportsIsNot(filterName) {
@@ -49,6 +52,10 @@ export function supportsContains(filterName) {
.includes(filterName)
}
+export function supportsHasDoneNot(filterName) {
+ return filterName === 'goal'
+}
+
export function isFreeChoiceFilterOperation(operation) {
return [FILTER_OPERATIONS.contains, FILTER_OPERATIONS.contains_not].includes(
operation
@@ -104,48 +111,6 @@ export function isRealTimeDashboard(query) {
return query?.period === 'realtime'
}
-export function plainFilterText(query, [operation, filterKey, clauses]) {
- const formattedFilter = formattedFilters[filterKey]
-
- if (formattedFilter) {
- return `${formattedFilter} ${FILTER_OPERATIONS_DISPLAY_NAMES[operation]} ${clauses.map((value) => getLabel(query.labels, filterKey, value)).reduce((prev, curr) => `${prev} or ${curr}`)}`
- } else if (filterKey.startsWith(EVENT_PROPS_PREFIX)) {
- const propKey = getPropertyKeyFromFilterKey(filterKey)
- return `Property ${propKey} ${FILTER_OPERATIONS_DISPLAY_NAMES[operation]} ${clauses.reduce((prev, curr) => `${prev} or ${curr}`)}`
- }
-
- throw new Error(`Unknown filter: ${filterKey}`)
-}
-
-export function styledFilterText(query, [operation, filterKey, clauses]) {
- const formattedFilter = formattedFilters[filterKey]
-
- if (formattedFilter) {
- return (
- <>
- {formattedFilter} {FILTER_OPERATIONS_DISPLAY_NAMES[operation]}{' '}
- {clauses
- .map((value) => (
- <b key={value}>{getLabel(query.labels, filterKey, value)}</b>
- ))
- .reduce((prev, curr) => [prev, ' or ', curr])}{' '}
- </>
- )
- } else if (filterKey.startsWith(EVENT_PROPS_PREFIX)) {
- const propKey = getPropertyKeyFromFilterKey(filterKey)
- return (
- <>
- Property <b>{propKey}</b> {FILTER_OPERATIONS_DISPLAY_NAMES[operation]}{' '}
- {clauses
- .map((label) => <b key={label}>{label}</b>)
- .reduce((prev, curr) => [prev, ' or ', curr])}{' '}
- </>
- )
- }
-
- throw new Error(`Unknown filter: ${filterKey}`)
-}
-
// Note: Currently only a single goal filter can be applied at a time.
export function getGoalFilter(query) {
return getFiltersByKeyPrefix(query, 'goal')[0] || null
@@ -194,22 +159,27 @@ export function cleanLabels(filters, labels, mergedFilterKey, mergedLabels) {
const EVENT_FILTER_KEYS = new Set(['name', 'page', 'goal', 'hostname'])
export function serializeApiFilters(filters) {
- const apiFilters = filters.map(
- ([operation, filterKey, clauses, ...modifiers]) => {
- let apiFilterKey = `visit:${filterKey}`
- if (
- filterKey.startsWith(EVENT_PROPS_PREFIX) ||
- EVENT_FILTER_KEYS.has(filterKey)
- ) {
- apiFilterKey = `event:${filterKey}`
- }
- return [operation, apiFilterKey, clauses, ...modifiers]
- }
- )
-
+ const apiFilters = filters.map(serializeFilter)
return JSON.stringify(apiFilters)
}
+function serializeFilter([operation, filterKey, clauses, ...modifiers]) {
+ let apiFilterKey = `visit:${filterKey}`
+ if (
+ filterKey.startsWith(EVENT_PROPS_PREFIX) ||
+ EVENT_FILTER_KEYS.has(filterKey)
+ ) {
+ apiFilterKey = `event:${filterKey}`
+ }
+ if (operation === FILTER_OPERATIONS.has_not_done) {
+ // :NOTE: Frontend does not support advanced query building that's used in the backend.
+ // As such we emulate the backend behavior for has_not_done goal filters
+ return ['has_not_done', ['is', apiFilterKey, clauses, ...modifiers]]
+ } else {
+ return [operation, apiFilterKey, clauses, ...modifiers]
+ }
+}
+
export function fetchSuggestions(apiPath, query, input, additionalFilter) {
const updatedQuery = queryForSuggestions(query, additionalFilter)
return api.get(apiPath, updatedQuery, { q: input.trim() })
diff --git a/assets/js/dashboard/util/filters.test.ts b/assets/js/dashboard/util/filters.test.ts
new file mode 100644
index 0000000000..10661dc82d
--- /dev/null
+++ b/assets/js/dashboard/util/filters.test.ts
@@ -0,0 +1,29 @@
+import { serializeApiFilters } from './filters'
+
+describe('serializeApiFilters', () => {
+ it('should prefix filter keys with event: or visit: when appropriate', () => {
+ const filters = [
+ ['is', 'page', ['/docs', '/blog']],
+ ['contains', 'goal', ['Signup']],
+ ['contains_not', 'browser', ['chrom'], { case_sensitive: false }],
+ ['is', 'country', ['US']],
+ ['is_not', 'utm_source', ['google']]
+ ]
+ expect(serializeApiFilters(filters)).toEqual(JSON.stringify([
+ ['is', 'event:page', ['/docs', '/blog']],
+ ['contains', 'event:goal', ['Signup']],
+ ['contains_not', 'visit:browser', ['chrom'], { case_sensitive: false }],
+ ['is', 'visit:country', ['US']],
+ ['is_not', 'visit:utm_source', ['google']]
+ ]))
+ })
+
+ it('wraps has_not_done goal filters in API format', () => {
+ const filters = [
+ ['has_not_done', 'goal', ['Signup']]
+ ]
+ expect(serializeApiFilters(filters)).toEqual(JSON.stringify([
+ ['has_not_done', ['is', 'event:goal', ['Signup']]]
+ ]))
+ })
+})
diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.ex
index 70afd13b18..424fc07aea 100644
--- a/lib/plausible/stats/query.ex
+++ b/lib/plausible/stats/query.ex
@@ -182,9 +182,9 @@ defmodule Plausible.Stats.Query do
def trace(%__MODULE__{} = query, metrics) do
filter_dimensions =
query.filters
- |> Enum.map(fn [_op, dimension | _rest] -> dimension end)
- |> Enum.filter(&is_binary/1)
+ |> Plausible.Stats.Filters.dimensions_used_in_filters()
|> Enum.sort()
+ |> Enum.uniq()
|> Enum.join(";")
metrics = metrics |> Enum.sort() |> Enum.join(";")