Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

(improvement) Advanced search refactoring (#375)

Andrii Romasiunae086edf9e36
diff --git a/app/pages/Project/View/ViewProject.tsx b/app/pages/Project/View/ViewProject.tsx
index ac60b723b..71683f721 100644
--- a/app/pages/Project/View/ViewProject.tsx
+++ b/app/pages/Project/View/ViewProject.tsx
@@ -2984,12 +2984,12 @@ const ViewProject = ({
loading={funnelActionLoading}
/>
<SearchFilters
- t={t}
showModal={showFiltersSearch}
setShowModal={setShowFiltersSearch}
setProjectFilter={onFilterSearch}
pid={id}
- language={language}
+ tnMapping={tnMapping}
+ filters={activeTab === PROJECT_TABS.traffic ? filters : filtersPerf}
/>
{!embedded && (
<Footer authenticated={authenticated} minimal />
diff --git a/app/pages/Project/View/components/Filters.tsx b/app/pages/Project/View/components/Filters.tsx
index cd46b15f9..39ba27c46 100644
--- a/app/pages/Project/View/components/Filters.tsx
+++ b/app/pages/Project/View/components/Filters.tsx
@@ -1,4 +1,5 @@
import React, { memo } from 'react'
+import cx from 'clsx'
import _truncate from 'lodash/truncate'
import _map from 'lodash/map'
import PropTypes from 'prop-types'
@@ -6,13 +7,7 @@ import { useTranslation } from 'react-i18next'
import countries from 'utils/isoCountries'
-/**
- * This component is used for showing the filter in panel
- * @returns {JSX.Element}
- */
-const Filter = ({
- column, filter, isExclusive, onRemoveFilter, onChangeExclusive, tnMapping, language, t,
-}: {
+interface IFilter {
column: string
filter: string
isExclusive: boolean
@@ -23,12 +18,22 @@ const Filter = ({
tnMapping: Record<string, string>
language: string
t: (key: string) => string
-}): JSX.Element => {
+ canChangeExclusive?: boolean
+ removable?: boolean
+}
+
+/**
+ * This component is used for showing the filter in panel
+ * @returns {JSX.Element}
+ */
+export const Filter = ({
+ column, filter, isExclusive, onRemoveFilter, onChangeExclusive, tnMapping, language, t, canChangeExclusive, removable,
+}: IFilter): JSX.Element => {
const displayColumn = tnMapping[column]
let displayFilter = filter
if (column === 'cc') {
- displayFilter = countries.getName(filter, language)
+ displayFilter = countries.getName(filter, language) as string
}
if (column === 'pg') {
@@ -40,43 +45,42 @@ const Filter = ({
return (
<span
title={truncatedFilter === displayFilter ? undefined : displayFilter}
- className='inline-flex rounded-md items-center py-0.5 pl-2.5 pr-1 mr-2 mt-2 text-sm font-medium bg-gray-200 text-gray-800 dark:text-gray-50 dark:bg-slate-800'
+ className={cx('inline-flex rounded-md items-center py-0.5 pl-2.5 pr-1 mr-2 mt-2 text-sm font-medium bg-gray-200 text-gray-800 dark:text-gray-50 dark:bg-slate-800', {
+ 'pr-2': !removable,
+ })}
>
{displayColumn}
&nbsp;
- <span className='text-blue-400 border-blue-400 border-b-2 border-dotted cursor-pointer' onClick={() => onChangeExclusive(column, filter, !isExclusive)}>
- {t(`common.${isExclusive ? 'isNot' : 'is'}`)}
- </span>
+ {canChangeExclusive ? (
+ <span className='text-blue-400 border-blue-400 border-b-2 border-dotted cursor-pointer' onClick={() => onChangeExclusive(column, filter, !isExclusive)}>
+ {t(`common.${isExclusive ? 'isNot' : 'is'}`)}
+ </span>
+ ) : (
+ <span>
+ {t(`common.${isExclusive ? 'isNot' : 'is'}`)}
+ </span>
+ )}
&nbsp;
&quot;
{truncatedFilter}
&quot;
- <button
- onClick={() => onRemoveFilter(column, filter)}
- type='button'
- className='flex-shrink-0 ml-0.5 h-4 w-4 rounded-full inline-flex items-center justify-center text-gray-800 hover:text-gray-900 hover:bg-gray-300 focus:bg-gray-300 focus:text-gray-900 dark:text-gray-50 dark:bg-slate-800 dark:hover:text-gray-300 dark:hover:bg-gray-800 dark:focus:bg-gray-800 dark:focus:text-gray-300 focus:outline-none '
- >
- <span className='sr-only'>Remove filter</span>
- <svg className='h-2 w-2' stroke='currentColor' fill='none' viewBox='0 0 8 8'>
- <path strokeLinecap='round' strokeWidth='1.5' d='M1 1l6 6m0-6L1 7' />
- </svg>
- </button>
+ {removable && (
+ <button
+ onClick={() => onRemoveFilter(column, filter)}
+ type='button'
+ className='flex-shrink-0 ml-0.5 h-4 w-4 rounded-full inline-flex items-center justify-center text-gray-800 hover:text-gray-900 hover:bg-gray-300 focus:bg-gray-300 focus:text-gray-900 dark:text-gray-50 dark:bg-slate-800 dark:hover:text-gray-300 dark:hover:bg-gray-800 dark:focus:bg-gray-800 dark:focus:text-gray-300 focus:outline-none '
+ >
+ <span className='sr-only'>Remove filter</span>
+ <svg className='h-2 w-2' stroke='currentColor' fill='none' viewBox='0 0 8 8'>
+ <path strokeLinecap='round' strokeWidth='1.5' d='M1 1l6 6m0-6L1 7' />
+ </svg>
+ </button>
+ )}
</span>
)
}
-/**
- * This component is used for rendering the filter panel.
- *
- * @param {array} filters - Active filters.
- * @param {function} onRemoveFilter - Callback to remove a filter.
- * @param {function} onChangeExclusive - Callback to change the exclusive status of a filter.
- * @param {object} tnMapping - Mapping of column names to translated names.
- * @returns {JSX.Element}
- */
-const Filters = ({
- filters, onRemoveFilter, onChangeExclusive, tnMapping,
-}: {
+interface IFilters {
filters: {
column: string
filter: string
@@ -87,7 +91,20 @@ const Filters = ({
// eslint-disable-next-line no-shadow
onChangeExclusive: (column: string, filter: string, isExclusive: boolean) => void
tnMapping: Record<string, string>
-}) => {
+}
+
+/**
+ * This component is used for rendering the filter panel.
+ *
+ * @param {array} filters - Active filters.
+ * @param {function} onRemoveFilter - Callback to remove a filter.
+ * @param {function} onChangeExclusive - Callback to change the exclusive status of a filter.
+ * @param {object} tnMapping - Mapping of column names to translated names.
+ * @returns {JSX.Element}
+ */
+export const Filters = ({
+ filters, onRemoveFilter, onChangeExclusive, tnMapping,
+}: IFilters) => {
const { t, i18n: { language } } = useTranslation('common')
return (
@@ -97,7 +114,17 @@ const Filters = ({
const key = `${column}${filter}`
return (
- <Filter key={key} onRemoveFilter={onRemoveFilter} onChangeExclusive={onChangeExclusive} language={language} t={t} tnMapping={tnMapping} {...props} />
+ <Filter
+ key={key}
+ onRemoveFilter={onRemoveFilter}
+ onChangeExclusive={onChangeExclusive}
+ language={language}
+ t={t}
+ tnMapping={tnMapping}
+ canChangeExclusive
+ removable
+ {...props}
+ />
)
})}
</div>
diff --git a/app/pages/Project/View/components/SearchFilters.tsx b/app/pages/Project/View/components/SearchFilters.tsx
index a99d1292b..b78660a60 100644
--- a/app/pages/Project/View/components/SearchFilters.tsx
+++ b/app/pages/Project/View/components/SearchFilters.tsx
@@ -1,29 +1,20 @@
-import React, { useState, useEffect, useMemo } from 'react'
-
-import _some from 'lodash/some'
+import React, { useState, useEffect, useMemo, useCallback } from 'react'
+import { useTranslation } from 'react-i18next'
import _isEmpty from 'lodash/isEmpty'
-import _find from 'lodash/find'
+import _reduce from 'lodash/reduce'
import _filter from 'lodash/filter'
import _map from 'lodash/map'
-import _forEach from 'lodash/forEach'
-import _includes from 'lodash/includes'
-import _toUpper from 'lodash/toUpper'
-import countries from 'utils/isoCountries'
import Modal from 'ui/Modal'
-import MultiSelect from 'ui/MultiSelect'
import Checkbox from 'ui/Checkbox'
-import Dropdown from 'ui/Dropdown'
+import Select from 'ui/Select'
+import Combobox from 'ui/Combobox'
import { FILTERS_PANELS_ORDER } from 'redux/constants'
-
+import countries from 'utils/isoCountries'
import { getFilters } from 'api'
+import { Filter } from './Filters'
-import CCRow from './CCRow'
-
-const SearchFilters = ({
- t, setProjectFilter, pid, showModal, setShowModal, language,
-}: {
- t: (key: string) => string,
+interface ISearchFilters {
setProjectFilter: (filter: {
column: string
filter: string[]
@@ -31,167 +22,174 @@ const SearchFilters = ({
pid: string
showModal: boolean
setShowModal: (show: boolean) => void
- language: string
-}) => {
- const [filterType, setFilterType] = useState<string>('')
- const [filterList, setFilterList] = useState<string[]>([])
- const [searchList, setSearchList] = useState<string[]>([])
- const [activeFilter, setActiveFilter] = useState<{
+ tnMapping: Record<string, string>
+ filters: {
column: string
- filter: string[]
- }[]>([])
- const [overrideCurrentlyFilters, setOverrideCurrentlyFilters] = useState<boolean>(false)
- const filters: string[] = useMemo(() => {
- let filtersArray: string[] = []
- _forEach(activeFilter, (item) => {
- filtersArray = [...filtersArray, ...item.filter]
- })
- return filtersArray
- }, [activeFilter])
-
- const isCountryIncluded = useMemo(() => {
- if (_some(activeFilter, (item) => item.column === 'cc')) {
- return true
- }
+ filter: string
+ isExclusive: boolean
+ }[]
+}
- return false
- }, [activeFilter])
+const getLabelToTypeMap = (t: any) => _reduce(FILTERS_PANELS_ORDER, (acc, curr) => ({
+ ...acc,
+ [t(`project.mapping.${curr}`)]: curr,
+}), {})
- const getFiltersList = async () => {
- if (!_isEmpty(filterType)) {
- const res = await getFilters(pid, filterType)
- setFilterList(res)
- setSearchList(res)
- }
- }
+interface IActiveFilter {
+ column: string
+ filter: string[]
+}
+
+const formatFilters = (filters: any): IActiveFilter[] => {
+ const formatted: IActiveFilter[] = []
+
+ _map(filters, (filter, column) => {
+ formatted.push({ column, filter })
+ })
+
+ return formatted
+}
+
+const SearchFilters = ({
+ setProjectFilter, pid, showModal, setShowModal, tnMapping, filters,
+}: ISearchFilters) => {
+ const { t, i18n: { language } } = useTranslation('common')
+ const [filterType, setFilterType] = useState<string>('')
+ const [searchList, setSearchList] = useState<any[]>([])
+ const [activeFilters, setActiveFilters] = useState<any>({})
+ const [override, setOverride] = useState<boolean>(false)
+
+ const labelToTypeMap = useMemo(() => getLabelToTypeMap(t), [t])
+
+ const getFiltersList = useCallback(async (type: string) => {
+ const res = await getFilters(pid, type)
+ setSearchList(res)
+ }, [pid])
useEffect(() => {
- if (!showModal) {
- setSearchList(filterList)
+ if (!showModal || _isEmpty(filterType)) {
+ return
}
- // eslint-disable-next-line react-hooks/exhaustive-deps
- }, [showModal])
- useEffect(() => {
- getFiltersList()
- // eslint-disable-next-line react-hooks/exhaustive-deps
- }, [filterType])
+ getFiltersList(filterType)
+ }, [filterType, showModal, getFiltersList])
+
+ const closeModal = () => {
+ setShowModal(false)
+ setTimeout(() => {
+ setFilterType('')
+ setActiveFilters({})
+ setOverride(false)
+ }, 300)
+ }
return (
<Modal
- onClose={() => {
- setShowModal(false)
- }}
+ onClose={closeModal}
onSubmit={() => {
- setProjectFilter(activeFilter, overrideCurrentlyFilters)
- setShowModal(false)
+ setProjectFilter(formatFilters(activeFilters), override)
+ closeModal()
}}
- size='large'
submitText={t('project.applyFilters')}
- closeText={t('common.close')}
title={t('project.advancedFilters')}
message={
(
<div className='min-h-[410px]'>
- <Dropdown
- className='min-w-[160px]'
- title={!_isEmpty(filterType) ? t(`project.mapping.${filterType}`) : t('project.settings.reseted.selectFilters')}
+ <Select
+ label={t('project.selectCategory')}
items={FILTERS_PANELS_ORDER}
labelExtractor={(item) => t(`project.mapping.${item}`)}
- keyExtractor={(item) => item}
- onSelect={(item) => setFilterType(item)}
+ // @ts-ignore
+ onSelect={(item: string) => setFilterType(labelToTypeMap[item])}
+ title={_isEmpty(filterType) ? t('project.settings.reseted.selectFilters') : t(`project.mapping.${filterType}`)}
/>
- <div className='h-2' />
- {(filterType && !_isEmpty(filterList)) ? (
+ {!_isEmpty(filters) && (
<>
- <Checkbox
- checked={Boolean(overrideCurrentlyFilters)}
- onChange={(e) => setOverrideCurrentlyFilters(e.target.checked)}
- name='overrideCurrentlyFilters'
- id='overrideCurrentlyFilters'
- className='mt-4'
- label={t('project.overrideCurrentlyFilters')}
- />
- <MultiSelect
- className='max-w-max'
+ <p className='mt-5 text-sm font-medium text-gray-700 dark:text-gray-200'>
+ {t('project.currentFilters')}
+ </p>
+ {_map(filters, ({ column, filter, isExclusive }) => (
+ <Filter
+ key={`${column}-${filter}`}
+ t={t}
+ language={language}
+ onChangeExclusive={() => { }}
+ onRemoveFilter={() => { }}
+ isExclusive={isExclusive}
+ column={column}
+ filter={filter}
+ tnMapping={tnMapping}
+ removable={false}
+ canChangeExclusive={false}
+ />
+ ))}
+ </>
+ )}
+ {(filterType && !_isEmpty(searchList)) && (
+ <>
+ <p className='mt-5 text-sm font-medium text-gray-700 dark:text-gray-200'>
+ {t('project.newFilters')}
+ </p>
+ <Combobox
items={searchList}
- // eslint-disable-next-line react/no-unstable-nested-components
- itemExtractor={(item) => {
- if (filterType === 'cc') {
- return <CCRow cc={item} language={language} />
- }
-
- return item
- }}
- // eslint-disable-next-line react/no-unstable-nested-components
labelExtractor={(item) => {
- if (isCountryIncluded && _some(activeFilter, (i) => i.column === 'cc' && _includes(i.filter, item))) {
- return <CCRow cc={item} language={language} />
+ if (filterType === 'cc') {
+ return countries.getName(item, language)
}
return item
}}
- keyExtractor={(item) => item}
- label={filters}
- placholder={t('project.settings.reseted.filtersPlaceholder')}
- searchPlaseholder={t('project.search')}
- onSearch={(search: string) => {
- if (search.length > 0) {
- if (filterType === 'cc') {
- setSearchList(_filter(filterList, (item) => _includes(_toUpper(countries.getName(item, language)), _toUpper(search))))
- return
- }
-
- setSearchList(_filter(filterList, (item) => _includes(_toUpper(item), _toUpper(search))))
- } else {
- setSearchList(filterList)
- }
+ onSelect={(item: any) => {
+ const processedItem = filterType === 'cc'
+ ? countries.getAlpha2Code(item, language) as string
+ : item
+
+ setActiveFilters((prevFilters: any) => ({
+ ...prevFilters,
+ [filterType]: [...(prevFilters[filterType] || []), processedItem],
+ }))
}}
- onSelect={(item: string) => setActiveFilter((oldItems: {
- column: string
- filter: string[]
- }[]) => {
- if (_some(oldItems, (i) => i?.column === filterType)) {
- if (_some(oldItems, (i) => i?.column === filterType && _includes(i?.filter, item))) {
- return _filter(oldItems, (i) => i.column !== filterType).concat({
- column: filterType,
- filter: _filter(_find(oldItems, (i) => i.column === filterType)?.filter || [], (i) => i !== item),
+ placeholder={t('project.settings.reseted.filtersPlaceholder')}
+ />
+ {_map(activeFilters, (filter, column) => {
+ return _map(filter, (item) => (
+ <Filter
+ key={`${column}-${item}`}
+ t={t}
+ onRemoveFilter={(removeColumn, removeFilter) => {
+ setActiveFilters((prevFilters: any) => {
+ const filteredColumn = _filter(prevFilters[removeColumn], (item: string) => item !== removeFilter)
+
+ if (_isEmpty(filteredColumn)) {
+ return _filter(prevFilters, (_, key) => key !== removeColumn)
+ }
+
+ return {
+ ...prevFilters,
+ [removeColumn]: filteredColumn,
+ }
})
- }
-
- return _filter(oldItems, (i) => i?.column !== filterType).concat({
- column: filterType,
- filter: [..._find(oldItems, (i) => i?.column === filterType)?.filter || [], item],
- })
- }
-
- return oldItems.concat({
- column: filterType,
- filter: [item],
- })
- })}
- onRemove={(item: string) => setActiveFilter((oldItems: {
- column: string
- filter: string[]
- }[]) => {
- const newItems = _map(oldItems, (i) => {
- if (_includes(i.filter, item)) {
- return {
- column: i.column,
- filter: _filter(i.filter, (j) => j !== item),
- }
- }
- return i
- })
-
- return newItems
- })}
+ }}
+ language={language}
+ onChangeExclusive={() => { }}
+ isExclusive={false}
+ canChangeExclusive={false}
+ column={column}
+ filter={item}
+ tnMapping={tnMapping}
+ removable
+ />
+ ))
+ })}
+ <Checkbox
+ checked={Boolean(override)}
+ onChange={(e) => setOverride(e.target.checked)}
+ name='overrideCurrentlyFilters'
+ id='overrideCurrentlyFilters'
+ className='mt-4'
+ label={t('project.overrideCurrentlyFilters')}
/>
</>
- ) : (
- <p className='text-gray-500 dark:text-gray-300 italic mt-4 mb-4 text-sm'>
- {t('project.settings.reseted.noFilters')}
- </p>
)}
</div>
)
diff --git a/app/ui/Combobox.tsx b/app/ui/Combobox.tsx
index 672e3cc3c..7ef45edcc 100644
--- a/app/ui/Combobox.tsx
+++ b/app/ui/Combobox.tsx
@@ -18,11 +18,12 @@ interface ISelect {
labelExtractor?: (item: any, index: number) => string,
keyExtractor?: (item: any, index: number) => string,
onSelect: (item: any) => void,
+ placeholder?: string,
}
const Combobox = ({
title, className, items, labelExtractor, keyExtractor, onSelect,
- buttonClassName,
+ buttonClassName, placeholder,
}: ISelect): JSX.Element => {
const { t } = useTranslation('common')
const [query, setQuery] = useState('')
@@ -39,12 +40,13 @@ const Combobox = ({
return (
<HeadlessCombobox value={title} onChange={onSelect}>
<div className={cx('relative mt-1', className)}>
- <div className='relative w-full cursor-default overflow-hidden rounded-lg'>
+ <div className='relative w-full cursor-default rounded-lg'>
<HeadlessCombobox.Input
className={cx('relative w-full bg-white border border-gray-300 dark:text-gray-50 dark:border-gray-800 dark:bg-slate-800 rounded-md shadow-sm pl-3 pr-10 py-2 text-left cursor-default focus:outline-none focus:ring-1 focus:ring-indigo-500 focus:border-indigo-500 sm:text-sm', buttonClassName)}
// @ts-ignore
displayValue={(item) => labelExtractor ? labelExtractor(item, 0) : item}
onChange={(event) => setQuery(event.target.value)}
+ placeholder={placeholder}
/>
<HeadlessCombobox.Button className='absolute inset-y-0 right-0 flex items-center pr-2'>
<ChevronUpDownIcon
@@ -106,6 +108,7 @@ const Combobox = ({
Combobox.propTypes = {
title: PropTypes.string,
+ placeholder: PropTypes.string,
className: PropTypes.string,
buttonClassName: PropTypes.string,
items: PropTypes.array.isRequired,
@@ -116,6 +119,7 @@ Combobox.propTypes = {
Combobox.defaultProps = {
title: '',
+ placeholder: '',
className: '',
buttonClassName: '',
labelExtractor: null,
diff --git a/app/ui/Select.tsx b/app/ui/Select.tsx
index 3f88ec465..5e0b73fba 100644
--- a/app/ui/Select.tsx
+++ b/app/ui/Select.tsx
@@ -9,6 +9,7 @@ interface ISelect {
title?: string,
label: string,
className?: string,
+ labelClassName?: string,
buttonClassName?: string,
capitalise?: boolean,
items: any[],
@@ -21,7 +22,7 @@ interface ISelect {
const Select = ({
title, label, className, items, labelExtractor, keyExtractor, iconExtractor, onSelect, id,
- buttonClassName, capitalise,
+ buttonClassName, capitalise, labelClassName,
}: ISelect): JSX.Element => (
// @ts-ignore
<Listbox id={id || ''} value={title} onChange={onSelect}>
@@ -71,7 +72,7 @@ const Select = ({
'font-semibold': selected,
'font-normal': !selected,
'first-letter:capitalize': capitalise,
- })}
+ }, labelClassName)}
>
{labelExtractor ? labelExtractor(item, index) : item}
</span>
@@ -113,6 +114,7 @@ Select.propTypes = {
PropTypes.string, PropTypes.object,
])),
className: PropTypes.string,
+ labelClassName: PropTypes.string,
buttonClassName: PropTypes.string,
capitalise: PropTypes.bool,
labelExtractor: PropTypes.func,
@@ -123,6 +125,7 @@ Select.propTypes = {
Select.defaultProps = {
className: '',
+ labelClassName: '',
buttonClassName: '',
capitalise: false,
labelExtractor: null,
diff --git a/public/locales/en.json b/public/locales/en.json
index cf0df5b5b..ea9dc0849 100644
--- a/public/locales/en.json
+++ b/public/locales/en.json
@@ -558,6 +558,9 @@
},
"project": {
"search": "Search",
+ "selectCategory": "Select category to filter",
+ "currentFilters": "Currently applied filters",
+ "newFilters": "New filters",
"advancedFilters": "Advanced filters",
"applyFilters": "Apply filters",
"lookingForMore": "Looking for more?",