Refactor: Use HeadlessUI for search-select component (#2676)

* Use HeadlessUI for search select box

* Remove downshift from package.json

* More consistent API for Combobox component

* Combine toFilterType and valueWithoutPrefix into a single function

* Rename MyCombobox -> PlausibleCombobox

* Update webpack-cli

* Disable cache for build

* Revert "Disable cache for build"

This reverts commit aa130541f8.

* Disable cache for build

* Update webpack dependencies

* Remove glob from webpack config

* Webpack is required by package.json

* Require autoprefixer in postcss config

* Revert build changes

* Fix styling for dark mode
pull/2263/head
Uku Taht 4 years ago committed by GitHub
parent 565036c9b2
commit 531dfb114b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,106 @@
import React, { Fragment, useState, useCallback } from 'react'
import { Combobox, Transition } from '@headlessui/react'
import { ChevronDownIcon } from '@heroicons/react/20/solid'
import debounce from 'debounce-promise'
function Spinner() {
return (
<svg className="animate-spin h-4 w-4 text-indigo-500" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24">
<circle className="opacity-25" cx="12" cy="12" r="10" stroke="currentColor" strokeWidth="4"></circle>
<path className="opacity-75" fill="currentColor" d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"></path>
</svg>
)
}
export default function PlausibleCombobox(props) {
const [options, setOptions] = useState([])
const [loading, setLoading] = useState(false)
function fetchOptions(query) {
setLoading(true)
return props.fetchOptions(query).then((loadedOptions) => {
setLoading(false)
setOptions(loadedOptions)
})
}
const debouncedFetchOptions = useCallback(debounce(fetchOptions, 200), [])
function onOpen() {
setOptions([])
fetchOptions(props.selection.label)
}
function onBlur(e) {
!props.strict && props.onChange({
value: e.target.value,
label: e.target.value
})
}
function renderOptions() {
if (loading) {
return (
<div className="relative cursor-default select-none py-2 px-4 text-gray-700 dark:text-gray-300">
Loading options...
</div>
)
} else if (!loading && options.length === 0) {
return (
<div className="relative cursor-default select-none py-2 px-4 text-gray-700 dark:text-gray-300">
No matches found in the current dashboard. Try selecting a different time range or searching for something different
</div>
)
} else {
return options.map((option) => {
return (
<Combobox.Option
key={option.value}
className={({ active }) =>
`relative cursor-default select-none py-2 px-3 ${active ? 'bg-indigo-600 text-white' : 'text-gray-900 dark:text-gray-300'
}`
}
value={option}
>
<span className="block truncate">{option.label}</span>
</Combobox.Option>
)
})
}
}
return (
<Combobox value={props.selection} onChange={(val) => props.onChange(val)}>
<div className="relative ml-2 w-full">
<Combobox.Button as="div" className="relative dark:bg-gray-900 dark:text-gray-300 block rounded-md shadow-sm border border-gray-300 dark:border-gray-700 hover:border-gray-400 dark:hover:border-gray-200 focus-within:ring-indigo-500 focus-within:border-indigo-500 ">
<Combobox.Input
className="border-none rounded-md focus:outline-none focus:ring-0 pr-10 text-sm"
style={{backgroundColor: 'inherit'}}
placeholder={props.placeholder}
displayValue={(item) => item && item.label}
onChange={(event) => debouncedFetchOptions(event.target.value)}
onBlur={onBlur}
/>
<div className="absolute inset-y-0 right-0 flex items-center pr-2">
{!loading && <ChevronDownIcon className="h-4 w-4 text-gray-500" />}
{loading && <Spinner />}
</div>
</Combobox.Button>
<Transition
as={Fragment}
leave="transition ease-in duration-100"
leaveFrom="opacity-100"
leaveTo="opacity-0"
beforeEnter={onOpen}
>
<Combobox.Options className="z-50 absolute mt-1 max-h-60 w-full overflow-auto rounded-md bg-white py-1 text-base shadow-lg ring-1 ring-black ring-opacity-5 focus:outline-none sm:text-sm dark:bg-gray-900">
{renderOptions()}
</Combobox.Options>
</Transition>
</div>
</Combobox>
)
}

@ -1,109 +0,0 @@
/* eslint react/jsx-props-no-spreading: 0 */
import React, {useState, useCallback} from 'react'
import {useCombobox} from 'downshift'
import classNames from 'classnames'
import debounce from 'debounce-promise'
import { ChevronDownIcon } from '@heroicons/react/20/solid'
function selectInputText(e) {
e.target.select()
}
function Spinner() {
return (
<svg className="animate-spin h-4 w-4 text-indigo-500" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24">
<circle className="opacity-25" cx="12" cy="12" r="10" stroke="currentColor" strokeWidth="4"></circle>
<path className="opacity-75" fill="currentColor" d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"></path>
</svg>
)
}
export default function SearchSelect(props) {
const [items, setItems] = useState([])
const [loading, setLoading] = useState(false)
function fetchOptions({inputValue, isOpen}) {
setLoading(isOpen)
return props.fetchOptions(inputValue || '').then((loadedItems) => {
setLoading(false)
setItems(loadedItems)
})
}
const debouncedFetchOptions = useCallback(debounce(fetchOptions, 200), [])
const {
isOpen,
inputValue,
getToggleButtonProps,
getMenuProps,
getInputProps,
getComboboxProps,
highlightedIndex,
getItemProps,
closeMenu,
} = useCombobox({
items,
itemToString: (item) => item.hasOwnProperty('name') ? item.name : item,
onInputValueChange: (changes) => {
debouncedFetchOptions(changes)
props.onInput(changes.inputValue)
if (changes.inputValue === '') {
props.onSelect({name: '', code: ''})
}
},
onSelectedItemChange: (changes) => {
props.onSelect(changes.selectedItem)
},
initialSelectedItem: props.initialSelectedItem,
onIsOpenChange: (state) => {
if (state.isOpen) {
fetchOptions(state)
}
}
})
function keydown(e) {
if (e.ctrlKey || e.metaKey || e.shiftKey || e.altKey || e.isComposing || e.keyCode === 229) return
if (e.key === 'Enter' && isOpen && highlightedIndex === -1) {
closeMenu()
e.preventDefault()
}
}
return (
<div className="ml-2 relative w-full">
<div className="relative rounded-md shadow-sm" {...getToggleButtonProps()} {...getComboboxProps()}>
<input {...getInputProps({onKeyDown: keydown})} onFocus={selectInputText} placeholder={props.placeholder} type="text" className={classNames('w-full pr-10 border-gray-300 dark:border-gray-700 hover:border-gray-400 dark:hover:border-gray-200 focus:outline-none focus:ring-indigo-500 focus:border-indigo-500 text-sm rounded-md dark:bg-gray-900 dark:text-gray-300 block', {'cursor-pointer': inputValue === '' && !isOpen})} />
<div className="absolute inset-y-0 right-0 flex items-center pr-2 pointer-events-none">
{ !loading && <ChevronDownIcon className="h-4 w-4 text-gray-500" /> }
{ loading && <Spinner /> }
</div>
</div>
<div {...getMenuProps()}>
{ isOpen && (
<ul className="absolute z-10 mt-1 w-full bg-white dark:bg-gray-900 shadow-lg max-h-60 rounded-md py-1 text-base ring-1 ring-black ring-opacity-5 overflow-auto focus:outline-none sm:text-sm">
{ !loading && items.length === 0 &&
<li className="text-gray-500 select-none py-2 px-3">No matches found in the current dashboard. Try selecting a different time range or searching for something different</li> }
{ loading && items.length === 0 &&
<li className="text-gray-500 select-none py-2 px-3">Loading options...</li> }
{
items.map((item, index) => (
<li
className={classNames("cursor-pointer select-none relative py-2 pl-3 pr-9", {'text-white bg-indigo-600': highlightedIndex === index, 'text-gray-900 dark:text-gray-100': highlightedIndex !== index})}
key={`${item.name ? item.name : item}`}
{...getItemProps({ item, index })}
>
{item.name ? item.name : item}
</li>
))
}
</ul>
)}
</div>
</div>
)
}

@ -9,8 +9,7 @@ import {
FILTER_GROUPS,
formatFilterGroup,
filterGroupForFilter,
toFilterType,
valueWithoutPrefix
parseQueryFilter
} from "./stats/modals/filter";
function removeFilter(key, history, query) {
@ -38,8 +37,7 @@ function clearAllFilters(history, query) {
}
function filterText(key, rawValue, query) {
let type = toFilterType(rawValue)
const value = valueWithoutPrefix(rawValue)
const {type, value} = parseQueryFilter(rawValue)
if (key === "goal") {
return <>Completed goal <b>{value}</b></>
@ -47,7 +45,8 @@ function filterText(key, rawValue, query) {
if (key === "props") {
const [metaKey, metaValue] = Object.entries(value)[0]
const eventName = query.filters.goal ? query.filters.goal : 'event'
return <>{eventName}.{metaKey} {toFilterType(metaValue)} <b>{valueWithoutPrefix(metaValue)}</b></>
const metaFilter = parseQueryFilter(metaValue)
return <>{eventName}.{metaKey} {metaFilter.type} <b>{metaFilter.value}</b></>
}
if (key === "browser_version") {
const isNotSet = query.filters.browser === '(not set)' || (!query.filters.browser)

@ -4,11 +4,11 @@ import classNames from 'classnames'
import { Menu, Transition } from '@headlessui/react'
import { ChevronDownIcon } from '@heroicons/react/20/solid'
import SearchSelect from '../../components/search-select'
import Combobox from '../../components/combobox'
import Modal from './modal'
import { parseQuery, formattedFilters } from '../../query'
import * as api from '../../api'
import {apiPath, siteBasePath} from '../../util/url'
import { apiPath, siteBasePath } from '../../util/url'
export const FILTER_GROUPS = {
'page': ['page', 'entry_page', 'exit_page'],
@ -29,32 +29,31 @@ function getFormState(filterGroup, query) {
if (entries && entries.length == 1) {
const propKey = entries[0][0]
const propValue = valueWithoutPrefix(entries[0][1])
const {type, value} = parseQueryFilter(entries[0][1])
return {
'prop_key': {name: propKey, value: propKey, type: FILTER_TYPES.is},
'prop_value': {name: propValue, value: propValue, type: toFilterType(entries[0][1])}
'prop_key': { label: propKey, value: propKey, type: FILTER_TYPES.is },
'prop_value': { label: value, value: value, type: type }
}
}
}
return FILTER_GROUPS[filterGroup].reduce((result, filter) => {
const rawFilterValue = query.filters[filter] || ''
const type = toFilterType(rawFilterValue)
const filterValue = valueWithoutPrefix(rawFilterValue)
const {type, value} = parseQueryFilter(rawFilterValue)
let filterName = filterValue
let filterLabel = value
if (filter === 'country' && filterValue !== '') {
filterName = (new URLSearchParams(window.location.search)).get('country_name')
if (filter === 'country' && value !== '') {
filterLabel = (new URLSearchParams(window.location.search)).get('country_name')
}
if (filter === 'region' && filterValue !== '') {
filterName = (new URLSearchParams(window.location.search)).get('region_name')
if (filter === 'region' && value !== '') {
filterLabel = (new URLSearchParams(window.location.search)).get('region_name')
}
if (filter === 'city' && filterValue !== '') {
filterName = (new URLSearchParams(window.location.search)).get('city_name')
if (filter === 'city' && value !== '') {
filterLabel = (new URLSearchParams(window.location.search)).get('city_name')
}
return Object.assign(result, {[filter]: {name: filterName, value: filterValue, type}})
return Object.assign(result, { [filter]: { label: filterLabel, value: value, type } })
}, {})
}
@ -70,15 +69,15 @@ const FILTER_PREFIXES = {
[FILTER_TYPES.is]: ''
};
export function toFilterType(value) {
return Object.keys(FILTER_PREFIXES)
.find(type => FILTER_PREFIXES[type] === value[0]) || FILTER_TYPES.is;
}
export function parseQueryFilter(queryFilter) {
const type = Object.keys(FILTER_PREFIXES)
.find(type => FILTER_PREFIXES[type] === queryFilter[0]) || FILTER_TYPES.is;
const value = [FILTER_TYPES.isNot, FILTER_TYPES.contains].includes(type)
? queryFilter.substring(1)
: queryFilter;
export function valueWithoutPrefix(value) {
return [FILTER_TYPES.isNot, FILTER_TYPES.contains].includes(toFilterType(value))
? value.substring(1)
: value;
return {type, value}
}
function toFilterQuery(value, type) {
@ -96,11 +95,11 @@ function supportsIsNot(filterName) {
function withIndefiniteArticle(word) {
if (word.startsWith('UTM')) {
return `a ${ word}`
return `a ${word}`
} if (['a', 'e', 'i', 'o', 'u'].some((vowel) => word.toLowerCase().startsWith(vowel))) {
return `an ${ word}`
return `an ${word}`
}
return `a ${ word}`
return `a ${word}`
}
@ -123,7 +122,7 @@ export function filterGroupForFilter(filter) {
filtersToAdd[filterInGroup] = group
})
return { ...filterToGroupMap, ...filtersToAdd}
return { ...filterToGroupMap, ...filtersToAdd }
}, {})
@ -137,7 +136,7 @@ class FilterModal extends React.Component {
const selectedFilterGroup = this.props.match.params.field || 'page'
const formState = getFormState(selectedFilterGroup, query)
this.state = {selectedFilterGroup, query, formState}
this.state = { selectedFilterGroup, query, formState }
}
componentDidMount() {
@ -161,58 +160,46 @@ class FilterModal extends React.Component {
handleSubmit() {
const { formState } = this.state;
const filters = Object.entries(formState).reduce((res, [filterKey, {type, value, name}]) => {
if (filterKey === 'country') { res.push({filter: 'country_name', value: name}) }
if (filterKey === 'region') { res.push({filter: 'region_name', value: name}) }
if (filterKey === 'city') { res.push({filter: 'city_name', value: name}) }
if (filterKey === 'prop_value') {return res}
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 }) }
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})
res.push({ filter: 'props', value: filterValue })
return res
}
res.push({filter: filterKey, value: toFilterQuery(value, type)})
res.push({ filter: filterKey, value: toFilterQuery(value, type) })
return res
}, [])
this.selectFiltersAndCloseModal(filters)
}
onSelect(filterName) {
if (this.state.selectedFilterGroup !== 'location') {
return () => {}
}
return (value) => {
this.setState(prevState => ({formState: Object.assign(prevState.formState, {
[filterName]: Object.assign(prevState.formState[filterName], {value: value.code, name: value.name})
})}))
}
}
onInput(filterName) {
if (this.state.selectedFilterGroup === 'location') {
return () => {}
}
return (value) => {
this.setState(prevState => ({formState: Object.assign(prevState.formState, {
[filterName]: Object.assign(prevState.formState[filterName], {value})
})}))
onChange(filterName) {
return (selection) => {
this.setState(prevState => ({
formState: Object.assign(prevState.formState, {
[filterName]: Object.assign(prevState.formState[filterName], selection)
})
}))
}
}
setFilterType(filterName, newType) {
this.setState(prevState => ({formState: Object.assign(prevState.formState, {
[filterName]: Object.assign(prevState.formState[filterName], {type: newType})
})}))
this.setState(prevState => ({
formState: Object.assign(prevState.formState, {
[filterName]: Object.assign(prevState.formState[filterName], { type: newType })
})
}))
}
fetchOptions(filter) {
return (input) => {
const {query, formState} = this.state
const { query, formState } = this.state
const formFilters = Object.fromEntries(
Object.entries(formState).map(([k, v]) => [k, v.code || v.value])
)
@ -223,13 +210,13 @@ class FilterModal extends React.Component {
queryForSuggestions(query, formFilters, filter) {
if (filter === 'prop_key') {
const propsFilter = formFilters.prop_value ? {'': formFilters.prop_value} : null
return {...query, filters: { ...query.filters, props: propsFilter}}
const propsFilter = formFilters.prop_value ? { '': formFilters.prop_value } : null
return { ...query, filters: { ...query.filters, props: propsFilter } }
} else if (filter === 'prop_value') {
const propsFilter = formFilters.prop_key ? {[formFilters.prop_key]: '!(none)'} : null
return {...query, filters: { ...query.filters, props: propsFilter}}
const propsFilter = formFilters.prop_key ? { [formFilters.prop_key]: '!(none)' } : null
return { ...query, filters: { ...query.filters, props: propsFilter } }
} else {
return {...query, filters: { ...query.filters, ...formFilters, [filter]: null }}
return { ...query, filters: { ...query.filters, ...formFilters, [filter]: null } }
}
}
@ -238,7 +225,7 @@ class FilterModal extends React.Component {
}
isDisabled() {
return Object.entries(this.state.formState).every(([_key, {value: val}]) => !val)
return Object.entries(this.state.formState).every(([_key, { value: val }]) => !val)
}
selectFiltersAndCloseModal(filters) {
@ -252,7 +239,12 @@ class FilterModal extends React.Component {
}
})
this.props.history.replace({pathname: siteBasePath(this.props.site), search: queryString.toString()})
this.props.history.replace({ pathname: siteBasePath(this.props.site), search: queryString.toString() })
}
renderSearchBox(filter) {
const isStrict = this.state.selectedFilterGroup === 'location'
return <Combobox fetchOptions={this.fetchOptions(filter)} strict={isStrict} selection={this.state.formState[filter]} onChange={this.onChange(filter)} placeholder={`Select ${withIndefiniteArticle(formattedFilters[filter])}`} />
}
renderFilterInputs() {
@ -261,17 +253,10 @@ class FilterModal extends React.Component {
return groups.map((filter) => {
return (
<div className="mt-4" key={filter}>
<div className="text-sm font-medium text-gray-700 dark:text-gray-300">{ formattedFilters[filter] }</div>
<div className="text-sm font-medium text-gray-700 dark:text-gray-300">{formattedFilters[filter]}</div>
<div className="flex items-start mt-1">
{ this.renderFilterTypeSelector(filter) }
<SearchSelect
key={filter}
fetchOptions={this.fetchOptions(filter)}
initialSelectedItem={this.state.formState[filter]}
onInput={this.onInput(filter)}
onSelect={this.onSelect(filter)}
placeholder={`Select ${withIndefiniteArticle(formattedFilters[filter])}`}
/>
{this.renderFilterTypeSelector(filter)}
{this.renderSearchBox(filter)}
</div>
</div>
)
@ -285,7 +270,7 @@ class FilterModal extends React.Component {
<>
<div className="w-24">
<Menu.Button className="inline-flex justify-between items-center w-full rounded-md border border-gray-300 dark:border-gray-500 shadow-sm px-4 py-2 bg-white dark:bg-gray-800 text-sm text-gray-700 dark:text-gray-200 hover:bg-gray-50 dark:hover:bg-gray-850 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-offset-gray-100 dark:focus:ring-offset-gray-900 focus:ring-indigo-500">
{ this.selectedFilterType(filterName) }
{this.selectedFilterType(filterName)}
<ChevronDownIcon className="-mr-2 ml-2 h-4 w-4 text-gray-500 dark:text-gray-400" aria-hidden="true" />
</Menu.Button>
</div>
@ -305,9 +290,9 @@ class FilterModal extends React.Component {
className="z-10 origin-top-left absolute left-0 mt-2 w-24 rounded-md shadow-lg bg-white dark:bg-gray-800 ring-1 ring-black ring-opacity-5 focus:outline-none"
>
<div className="py-1">
{ this.renderTypeItem(filterName, FILTER_TYPES.is, true) }
{ this.renderTypeItem(filterName, FILTER_TYPES.isNot, supportsIsNot(filterName)) }
{ this.renderTypeItem(filterName, FILTER_TYPES.contains, supportsContains(filterName)) }
{this.renderTypeItem(filterName, FILTER_TYPES.is, true)}
{this.renderTypeItem(filterName, FILTER_TYPES.isNot, supportsIsNot(filterName))}
{this.renderTypeItem(filterName, FILTER_TYPES.contains, supportsContains(filterName))}
</div>
</Menu.Items>
</Transition>
@ -329,7 +314,7 @@ class FilterModal extends React.Component {
"cursor-pointer block px-4 py-2 text-sm"
)}
>
{ type }
{type}
</span>
)}
</Menu.Item>
@ -364,7 +349,7 @@ class FilterModal extends React.Component {
type="button"
className="ml-2 button px-4 flex bg-red-500 dark:bg-red-500 hover:bg-red-600 dark:hover:bg-red-700 items-center"
onClick={() => {
const updatedFilters = FILTER_GROUPS[selectedFilterGroup].map((filterName) => ({filter: filterName, value: null}))
const updatedFilters = FILTER_GROUPS[selectedFilterGroup].map((filterName) => ({ filter: filterName, value: null }))
this.selectFiltersAndCloseModal(updatedFilters)
}}
>
@ -393,7 +378,7 @@ class FilterModal extends React.Component {
render() {
return (
<Modal site={this.props.site} maxWidth="460px">
{ this.renderBody()}
{this.renderBody()}
</Modal>
)
}

File diff suppressed because it is too large Load Diff

@ -14,7 +14,7 @@
"@babel/core": "^7.14.3",
"@babel/preset-env": "^7.14.4",
"@babel/preset-react": "^7.13.13",
"@headlessui/react": "^1.3.0",
"@headlessui/react": "^1.7.10",
"@heroicons/react": "^2.0.11",
"@juggle/resize-observer": "^3.3.1",
"@kunukn/react-collapse": "^2.2.9",
@ -33,7 +33,6 @@
"css-minimizer-webpack-plugin": "^3.2.0",
"datamaps": "^0.5.9",
"debounce-promise": "^3.1.2",
"downshift": "^6.1.3",
"iframe-resizer": "^4.3.2",
"mini-css-extract-plugin": "^1.6.0",
"phoenix": "1.5.0",

@ -1,5 +1,4 @@
const path = require('path');
const glob = require('glob');
const webpack = require('webpack');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const TerserPlugin = require('terser-webpack-plugin');

@ -21,8 +21,8 @@ defmodule Plausible.Stats.FilterSuggestions do
|> Enum.slice(0..24)
|> Enum.map(fn match ->
%{
code: match.alpha_2,
name: match.name
value: match.alpha_2,
label: match.name
}
end)
end
@ -41,8 +41,8 @@ defmodule Plausible.Stats.FilterSuggestions do
subdiv = Location.get_subdivision(c)
%{
code: c,
name: subdiv.name
value: c,
label: subdiv.name
}
end)
end
@ -64,8 +64,8 @@ defmodule Plausible.Stats.FilterSuggestions do
|> Enum.slice(0..24)
|> Enum.map(fn subdiv ->
%{
code: subdiv.code,
name: subdiv.name
value: subdiv.code,
label: subdiv.name
}
end)
end
@ -84,8 +84,8 @@ defmodule Plausible.Stats.FilterSuggestions do
city = Location.get_city(c)
%{
code: Integer.to_string(c),
name: (city && city.name) || "N/A"
value: Integer.to_string(c),
label: (city && city.name) || "N/A"
}
end)
end
@ -111,8 +111,8 @@ defmodule Plausible.Stats.FilterSuggestions do
|> Enum.slice(0..24)
|> Enum.map(fn c ->
%{
code: Integer.to_string(c.id),
name: c.name
value: Integer.to_string(c.id),
label: c.name
}
end)
end
@ -127,6 +127,7 @@ defmodule Plausible.Stats.FilterSuggestions do
String.downcase(filter_search)
)
end)
|> wrap_suggestions()
end
def filter_suggestions(site, query, "prop_key", filter_search) do
@ -151,6 +152,7 @@ defmodule Plausible.Stats.FilterSuggestions do
ClickhouseRepo.all(q)
|> Enum.filter(fn suggestion -> suggestion != "" end)
|> wrap_suggestions()
end
def filter_suggestions(site, query, "prop_value", filter_search) do
@ -175,6 +177,7 @@ defmodule Plausible.Stats.FilterSuggestions do
ClickhouseRepo.all(q)
|> Enum.filter(fn suggestion -> suggestion != "" end)
|> wrap_suggestions()
end
def filter_suggestions(site, query, filter_name, filter_search) do
@ -298,5 +301,10 @@ defmodule Plausible.Stats.FilterSuggestions do
ClickhouseRepo.all(q)
|> Enum.filter(fn suggestion -> suggestion != "" end)
|> wrap_suggestions()
end
defp wrap_suggestions(list) do
Enum.map(list, fn val -> %{value: val, label: val} end)
end
end

@ -7,14 +7,22 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
test "returns suggestions for pages without a query", %{conn: conn, site: site} do
conn = get(conn, "/api/stats/#{site.domain}/suggestions/page?period=month&date=2019-01-01")
assert json_response(conn, 200) == ["/", "/register", "/contact", "/irrelevant"]
assert json_response(conn, 200) == [
%{"label" => "/", "value" => "/"},
%{"label" => "/register", "value" => "/register"},
%{"label" => "/contact", "value" => "/contact"},
%{"label" => "/irrelevant", "value" => "/irrelevant"}
]
end
test "returns suggestions for pages with a query", %{conn: conn, site: site} do
conn =
get(conn, "/api/stats/#{site.domain}/suggestions/page?period=month&date=2019-01-01&q=re")
assert json_response(conn, 200) == ["/register", "/irrelevant"]
assert json_response(conn, 200) == [
%{"label" => "/register", "value" => "/register"},
%{"label" => "/irrelevant", "value" => "/irrelevant"}
]
end
test "returns suggestions for pages without any suggestions", %{conn: conn, site: site} do
@ -37,7 +45,10 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
conn =
get(conn, "/api/stats/#{site.domain}/suggestions/source?period=month&date=2019-01-01")
assert json_response(conn, 200) == ["10words", "Bing"]
assert json_response(conn, 200) == [
%{"label" => "10words", "value" => "10words"},
%{"label" => "Bing", "value" => "Bing"}
]
end
test "returns suggestions for countries", %{conn: conn, site: site} do
@ -47,7 +58,7 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
"/api/stats/#{site.domain}/suggestions/country?period=month&date=2019-01-01&q=Unit"
)
assert json_response(conn, 200) == [%{"code" => "US", "name" => "United States"}]
assert json_response(conn, 200) == [%{"value" => "US", "label" => "United States"}]
end
test "returns suggestions for regions", %{conn: conn, user: user} do
@ -64,7 +75,7 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
"/api/stats/#{site.domain}/suggestions/region?q=Har"
)
assert json_response(conn, 200) == [%{"code" => "EE-37", "name" => "Harjumaa"}]
assert json_response(conn, 200) == [%{"value" => "EE-37", "label" => "Harjumaa"}]
end
test "returns suggestions for cities", %{conn: conn, user: user} do
@ -81,7 +92,7 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
"/api/stats/#{site.domain}/suggestions/city?q=Kär"
)
assert json_response(conn, 200) == [%{"code" => "591632", "name" => "Kärdla"}]
assert json_response(conn, 200) == [%{"value" => "591632", "label" => "Kärdla"}]
end
test "returns suggestions for countries without country in search", %{conn: conn, site: site} do
@ -98,14 +109,14 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
conn =
get(conn, "/api/stats/#{site.domain}/suggestions/screen?period=month&date=2019-01-01")
assert json_response(conn, 200) == ["Desktop"]
assert json_response(conn, 200) == [%{"value" => "Desktop", "label" => "Desktop"}]
end
test "returns suggestions for browsers", %{conn: conn, site: site} do
conn =
get(conn, "/api/stats/#{site.domain}/suggestions/browser?period=month&date=2019-01-01")
assert json_response(conn, 200) == ["Chrome"]
assert json_response(conn, 200) == [%{"label" => "Chrome", "value" => "Chrome"}]
end
test "returns suggestions for browser versions", %{conn: conn, site: site} do
@ -117,13 +128,13 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
"/api/stats/#{site.domain}/suggestions/browser_version?period=month&date=2019-01-01&filters=#{filters}"
)
assert json_response(conn, 200) == ["78.0"]
assert json_response(conn, 200) == [%{"value" => "78.0", "label" => "78.0"}]
end
test "returns suggestions for OS", %{conn: conn, site: site} do
conn = get(conn, "/api/stats/#{site.domain}/suggestions/os?period=month&date=2019-01-01")
assert json_response(conn, 200) == ["Mac"]
assert json_response(conn, 200) == [%{"value" => "Mac", "label" => "Mac"}]
end
test "returns suggestions for OS versions", %{conn: conn, site: site} do
@ -135,7 +146,7 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
"/api/stats/#{site.domain}/suggestions/os_version?period=month&date=2019-01-01&filters=#{filters}"
)
assert json_response(conn, 200) == ["10.15"]
assert json_response(conn, 200) == [%{"label" => "10.15", "value" => "10.15"}]
end
test "returns suggestions for OS versions with search", %{conn: conn, site: site} do
@ -154,7 +165,9 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
conn =
get(conn, "/api/stats/#{site.domain}/suggestions/referrer?period=month&date=2019-01-01")
assert json_response(conn, 200) == ["10words.com/page1"]
assert json_response(conn, 200) == [
%{"value" => "10words.com/page1", "label" => "10words.com/page1"}
]
end
end
@ -183,7 +196,11 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
conn =
get(conn, "/api/stats/#{site.domain}/suggestions/prop_key?period=day&date=2022-01-01")
assert json_response(conn, 200) |> Enum.sort() == ["author", "dark_mode", "logged_in"]
assert json_response(conn, 200) |> Enum.map(& &1["value"]) |> Enum.sort() == [
"author",
"dark_mode",
"logged_in"
]
end
test "returns suggestions for prop key with value filter", %{conn: conn, site: site} do
@ -213,7 +230,10 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
"/api/stats/#{site.domain}/suggestions/prop_key?period=day&date=2022-01-01&filters=#{filters}"
)
assert json_response(conn, 200) |> Enum.sort() == ["dark_mode", "logged_in"]
assert json_response(conn, 200) |> Enum.map(& &1["value"]) |> Enum.sort() == [
"dark_mode",
"logged_in"
]
end
test "returns suggestions for prop value with no filter", %{conn: conn, site: site} do
@ -238,7 +258,11 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
conn =
get(conn, "/api/stats/#{site.domain}/suggestions/prop_value?period=day&date=2022-01-01")
assert json_response(conn, 200) |> Enum.sort() == ["Uku Taht", "false", "true"]
assert json_response(conn, 200) |> Enum.map(& &1["value"]) |> Enum.sort() == [
"Uku Taht",
"false",
"true"
]
end
test "returns suggestions for prop value with filter on prop key", %{conn: conn, site: site} do
@ -268,7 +292,7 @@ defmodule PlausibleWeb.Api.StatsController.SuggestionsTest do
"/api/stats/#{site.domain}/suggestions/prop_value?period=day&date=2022-01-01&filters=#{filters}"
)
assert json_response(conn, 200) |> Enum.sort() == ["Uku Taht"]
assert json_response(conn, 200) |> Enum.map(& &1["value"]) |> Enum.sort() == ["Uku Taht"]
end
test "when date is borked, bad request is returned", %{

Loading…
Cancel
Save