From df95b61ecaa9b490a82d9927c36b1b7231ea9bc3 Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Tue, 14 Mar 2023 12:45:05 +0200 Subject: [PATCH] Support multple filter clauses in combobox --- assets/js/dashboard/components/combobox.js | 50 ++++++++++--------- assets/js/dashboard/filters.js | 52 +++++--------------- assets/js/dashboard/stats/modals/filter.js | 56 ++++++++++------------ assets/js/dashboard/util/filters.js | 47 ++++++++++++++++-- 4 files changed, 105 insertions(+), 100 deletions(-) diff --git a/assets/js/dashboard/components/combobox.js b/assets/js/dashboard/components/combobox.js index abaae6132..76a60b777 100644 --- a/assets/js/dashboard/components/combobox.js +++ b/assets/js/dashboard/components/combobox.js @@ -3,15 +3,6 @@ import { Transition } from '@headlessui/react' import { ChevronDownIcon } from '@heroicons/react/20/solid' import debounce from 'debounce-promise' -function Spinner() { - return ( - - - - - ) -} - export default function PlausibleCombobox(props) { const [options, setOptions] = useState([]) const [loading, setLoading] = useState(false) @@ -37,20 +28,24 @@ export default function PlausibleCombobox(props) { function toggleOpen() { if (!isOpen) { - debouncedFetchOptions(searchRef.current.value) - setLoading(true) + fetchOptions(searchRef.current.value) + searchRef.current.focus() } setOpen(!isOpen) } function selectOption(option) { - props.onChange(option) - searchRef.current.value = '' + props.onChange([...props.values, option]) + if (searchRef.current.value !== '') { + searchRef.current.value = '' + fetchOptions('') + } searchRef.current.focus() } - function removeOption() { - props.onChange({value: '', label: ''}) + function removeOption(option) { + const newValues = props.values.filter((val) => val.value !== option.value) + props.onChange(newValues) searchRef.current.focus() } @@ -67,16 +62,18 @@ export default function PlausibleCombobox(props) { const noMatchesFound = !loading && options.length === 0 const matchesFound = !loading && options.length > 0 - const placeholder = props.value.label ? '' : props.placeholder return (
-
- { props.value.label && ( - {props.value.label} - )} - fetchOptions(e.target.value)} placeholder={placeholder} type="text" onChange={onInput}> -
+
+ { props.values.map((value) => { + return ( + {value.label} + ) + }) + } + +
{!loading && } {loading && }
@@ -117,3 +114,12 @@ export default function PlausibleCombobox(props) {
); } + +function Spinner() { + return ( + + + + + ) +} diff --git a/assets/js/dashboard/filters.js b/assets/js/dashboard/filters.js index 32542869a..2384b7920 100644 --- a/assets/js/dashboard/filters.js +++ b/assets/js/dashboard/filters.js @@ -37,51 +37,21 @@ function clearAllFilters(history, query) { ); } -function filterText(key, rawValue, query) { - const {type, value} = parseQueryFilter(rawValue) +function filterText(key, _rawValue, query) { + const {type, clauses} = parseQueryFilter(query, key) - if (key === "goal") { - return <>Completed goal {value} - } - if (key === "props") { - const [metaKey, metaValue] = Object.entries(value)[0] - const eventName = query.filters.goal ? query.filters.goal : 'event' - const metaFilter = parseQueryFilter(metaValue) - return <>{eventName}.{metaKey} {metaFilter.type} {metaFilter.value} - } - if (key === "browser_version") { - const isNotSet = query.filters.browser === '(not set)' || (!query.filters.browser) - const browserName = isNotSet ? 'Browser' : query.filters.browser - return <>{browserName}.Version {type} {value} - } - if (key === "os_version") { - const isNotSet = query.filters.os === '(not set)' || (!query.filters.os) - const osName = isNotSet ? 'Operating System' : query.filters.os - console.info('osname', osName) - return <>{osName}.Version {type} {value} - } - if (key === "country") { - const q = new URLSearchParams(window.location.search) - const countryName = q.get('country_name') - return <>Country {type} {countryName} - } - - if (key === "region") { - const q = new URLSearchParams(window.location.search) - const regionName = q.get('region_name') - return <>Region {type} {regionName} - } - - if (key === "city") { - const q = new URLSearchParams(window.location.search) - const cityName = q.get('city_name') - return <>City {type} {cityName} - } + // TODO + // if (key === "goal") { + // return <>Completed goal {value} + // } const formattedFilter = formattedFilters[key] - if (formattedFilter) { - return <>{formattedFilter} {type} {value} + if (key === "props") { + const [[propKey, _propValue]] = Object.entries(query.filters['props']) + return <>props.{propKey} {type} {clauses.map(({label}) => {label}).reduce((prev, curr) => [prev, ' or ', curr])} + } else if (formattedFilter) { + return <>{formattedFilter} {type} {clauses.map(({label}) => {label}).reduce((prev, curr) => [prev, ' or ', curr])} } throw new Error(`Unknown filter: ${key}`) diff --git a/assets/js/dashboard/stats/modals/filter.js b/assets/js/dashboard/stats/modals/filter.js index cc7b330b6..ecfe4ad86 100644 --- a/assets/js/dashboard/stats/modals/filter.js +++ b/assets/js/dashboard/stats/modals/filter.js @@ -17,38 +17,27 @@ function getFormState(filterGroup, query) { const entries = propsObject && Object.entries(propsObject) if (entries && entries.length == 1) { - const propKey = entries[0][0] - const {type, value} = parseQueryFilter(entries[0][1]) + const [[propKey, _propVal]] = entries + const {type, clauses} = parseQueryFilter(query, 'props') return { - 'prop_key': { label: propKey, value: propKey, type: FILTER_TYPES.is }, - 'prop_value': { label: value, value: value, type: type } + 'prop_key': { type: FILTER_TYPES.is, clauses: [{label: propKey, value: propKey}] }, + 'prop_value': { type, clauses } } } } return FILTER_GROUPS[filterGroup].reduce((result, filter) => { - const rawFilterValue = query.filters[filter] || '' - const {type, value} = parseQueryFilter(rawFilterValue) + const {type, clauses} = parseQueryFilter(query, filter) - let filterLabel = value - - if (filter === 'country' && value !== '') { - filterLabel = (new URLSearchParams(window.location.search)).get('country_name') - } - if (filter === 'region' && value !== '') { - filterLabel = (new URLSearchParams(window.location.search)).get('region_name') - } - if (filter === 'city' && value !== '') { - filterLabel = (new URLSearchParams(window.location.search)).get('city_name') - } - return Object.assign(result, { [filter]: { label: filterLabel, value: value, type } }) + return Object.assign(result, { [filter]: { type, clauses } }) }, {}) } -function toFilterQuery(value, type) { +function toFilterQuery(type, clauses) { const prefix = FILTER_PREFIXES[type]; - return prefix + value.trim(); + const result = clauses.map(clause => clause.value.trim()).join('|') + return prefix + result; } function supportsContains(filterName) { @@ -100,19 +89,18 @@ class FilterModal extends React.Component { handleSubmit() { const { formState } = this.state; - const filters = Object.entries(formState).reduce((res, [filterKey, { type, value, label }]) => { - if (filterKey === 'country') { res.push({ filter: 'country_name', value: label }) } - if (filterKey === 'region') { res.push({ filter: 'region_name', value: label }) } - if (filterKey === 'city') { res.push({ filter: 'city_name', value: label }) } + const filters = Object.entries(formState).reduce((res, [filterKey, { type, clauses }]) => { + if (filterKey === 'country') { res.push({ filter: 'country_labels', value: clauses.map(clause => clause.label).join('|') }) } + if (filterKey === 'region') { res.push({ filter: 'region_labels', value: clauses.map(clause => clause.label).join('|') }) } + if (filterKey === 'city') { res.push({ filter: 'city_labels', value: clauses.map(clause => clause.label).join('|') }) } if (filterKey === 'prop_value') { return res } if (filterKey === 'prop_key') { - let propValue = formState['prop_value'] - let filterValue = JSON.stringify({ [value]: toFilterQuery(propValue.value, propValue.type) }) - res.push({ filter: 'props', value: filterValue }) + const [{value: propKey}] = clauses + res.push({ filter: 'props', value: JSON.stringify({ [propKey]: toFilterQuery(formState.prop_value.type, formState.prop_value.clauses) }) }) return res } - res.push({ filter: filterKey, value: toFilterQuery(value, type) }) + res.push({ filter: filterKey, value: toFilterQuery(type, clauses) }) return res }, []) @@ -123,7 +111,7 @@ class FilterModal extends React.Component { return (selection) => { this.setState(prevState => ({ formState: Object.assign(prevState.formState, { - [filterName]: Object.assign(prevState.formState[filterName], selection) + [filterName]: Object.assign(prevState.formState[filterName], { clauses: selection }) }) })) } @@ -141,7 +129,7 @@ class FilterModal extends React.Component { return (input) => { const { query, formState } = this.state const formFilters = Object.fromEntries( - Object.entries(formState).map(([k, v]) => [k, v.code || v.value]) + Object.entries(formState).map(([filter, {type, clauses}]) => [filter, toFilterQuery(type, clauses)]) ) const updatedQuery = this.queryForSuggestions(query, formFilters, filter) return api.get(apiPath(this.props.site, `/suggestions/${filter}`), updatedQuery, { q: input.trim() }) @@ -165,7 +153,11 @@ class FilterModal extends React.Component { } isDisabled() { - return Object.entries(this.state.formState).every(([_key, { value: val }]) => !val) + if (this.state.selectedFilterGroup === 'props') { + return Object.entries(this.state.formState).some(([_key, { clauses }]) => clauses.length === 0) + } else { + return Object.entries(this.state.formState).every(([_key, { clauses }]) => clauses.length === 0) + } } selectFiltersAndCloseModal(filters) { @@ -184,7 +176,7 @@ class FilterModal extends React.Component { renderSearchBox(filter) { const isStrict = this.state.selectedFilterGroup === 'location' - return + return } renderFilterInputs() { diff --git a/assets/js/dashboard/util/filters.js b/assets/js/dashboard/util/filters.js index ee5a5b5b6..abda3d4a9 100644 --- a/assets/js/dashboard/util/filters.js +++ b/assets/js/dashboard/util/filters.js @@ -22,15 +22,52 @@ export const FILTER_PREFIXES = { [FILTER_TYPES.is]: '' }; -export function parseQueryFilter(queryFilter) { +function parsePrefix(rawValue) { const type = Object.keys(FILTER_PREFIXES) - .find(type => FILTER_PREFIXES[type] === queryFilter[0]) || FILTER_TYPES.is; + .find(type => FILTER_PREFIXES[type] === rawValue[0]) || FILTER_TYPES.is; const value = [FILTER_TYPES.isNot, FILTER_TYPES.contains].includes(type) - ? queryFilter.substring(1) - : queryFilter; + ? rawValue.substring(1) + : rawValue; - return {type, value} + const values = value + .split('|') + .filter((clause) => !!clause) + + return {type, values} +} + +export function parseQueryFilter(query, filter) { + if (filter === 'props') { + const rawValue = query.filters['props'] + const [[_propKey, propVal]] = Object.entries(rawValue) + const {type, values} = parsePrefix(propVal) + const clauses = values.map(val => { return {value: val, label: val}}) + return {type, clauses} + } else { + const {type, values} = parsePrefix(query.filters[filter] || '') + + let labels = values + + if (filter === 'country' && values.length > 0) { + const rawLabel = (new URLSearchParams(window.location.search)).get('country_labels') || '' + labels = rawLabel.split('|').filter(label => !!label) + } + + if (filter === 'region' && values.length > 0) { + const rawLabel = (new URLSearchParams(window.location.search)).get('region_labels') || '' + labels = rawLabel.split('|').filter(label => !!label) + } + + if (filter === 'city' && values.length > 0) { + const rawLabel = (new URLSearchParams(window.location.search)).get('city_labels') || '' + labels = rawLabel.split('|').filter(label => !!label) + } + + const clauses = values.map((value, index) => { return {value, label: labels[index]}}) + + return {type, clauses} + } } export function formatFilterGroup(filterGroup) {