Skip to content

Typed filters #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hextraza merged 4 commits into from
Apr 30, 2025
Merged

Typed filters #326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9adf47b
Filter refactor
Apr 21, 2025
0343b45
Fix FilterForm bugs, rename filters, add defaultOperator
Apr 21, 2025
af57ac1
Fix URL encoding behavior and tests
Apr 22, 2025
87e2cf6
Fix ranges on > and < operators
Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 116 additions & 87 deletions jbrowse/src/client/JBrowse/VariantSearch/components/FilterForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ import FormControl from '@mui/material/FormControl';
import InputLabel from '@mui/material/InputLabel';
import CardActions from '@mui/material/CardActions';
import Card from '@mui/material/Card';
import { FieldModel, Filter, getOperatorsForField, searchStringToInitialFilters } from '../../utils';
import { FieldModel, Filter, searchStringToInitialFilters } from '../../utils';
import { OperatorKey, OperatorRegistry } from '../operators';
import KeyboardArrowDownIcon from '@mui/icons-material/KeyboardArrowDown';
import { Box, Menu } from '@mui/material';
import { styled } from '@mui/material/styles';
Expand Down Expand Up @@ -77,19 +78,22 @@ const SubmitAndExternal = styled('div')(({ theme }) => ({

const FilterForm = (props: FilterFormProps ) => {
const { handleQuery, setFilters, handleClose, fieldTypeInfo, allowedGroupNames, promotedFilters } = props
const [filters, localSetFilters] = useState<Filter[]>(searchStringToInitialFilters(fieldTypeInfo.map((x) => x.name)));
const initial = searchStringToInitialFilters(fieldTypeInfo.map(x => x.name))
const [filters, localSetFilters] = useState<Filter[]>(
initial.length ? initial : [ new Filter('', OperatorKey.None, '') ]
)
const [highlightedInputs, setHighlightedInputs] = useState<{ [index: number]: { field: boolean, operator: boolean, value: boolean } }>({});
const [commonFilterMenuOpen, setCommonFilterMenuOpen] = useState<boolean>(false)
const buttonRef = React.useRef(null);

const handleAddFilter = () => {
localSetFilters([...filters, new Filter()]);
localSetFilters([...filters, new Filter('', OperatorKey.None, '')]);
};

const handleRemoveFilter = (index) => {
// If it's the last filter, just reset its values to default empty values
if (filters.length === 1) {
localSetFilters([new Filter()]);
localSetFilters([new Filter('', OperatorKey.None, '')]);
} else {
// Otherwise, remove the filter normally
localSetFilters(
Expand All @@ -100,64 +104,81 @@ const FilterForm = (props: FilterFormProps ) => {
}
};

const handleFilterChange = (index, key, value) => {
const newFilters = filters.map((filter, i) => {
if (i === index) {
const updatedFilter = Object.assign(new Filter(), { ...filter, [key]: value });

if (key === "operator") {
if (value === "is empty" || value === "is not empty") {
updatedFilter.value = '';
}

if (value === "equals one of" || filter.operator === "equals one of") {
updatedFilter.value = '';
}
}
const handleFilterChange = (
index: number,
key: 'field' | 'operator' | 'value',
value: any
) => {
const newFilters = filters.map((filter, i) => {
if (i !== index) return filter;

const updatedFilter = Object.assign(
new Filter('', OperatorKey.None, ''),
{ ...filter, [key]: value }
);

if (key === 'field') {
const fieldInfo = fieldTypeInfo.find(f => f.name === value);
const defaultOp = fieldInfo?.getDefaultOperator() ?? OperatorRegistry[OperatorKey.None];
updatedFilter.operator = defaultOp;
updatedFilter.value = '';
}
else if (key === 'operator') {
updatedFilter.operator = OperatorRegistry[value as OperatorKey];
updatedFilter.value = '';
}

return updatedFilter;
}
return filter;
});
return updatedFilter;
});

localSetFilters(newFilters);
localSetFilters(newFilters);
};


const handleSubmit = (event) => {
event.preventDefault();
const highlightedInputs = {};

filters.forEach((filter, index) => {
highlightedInputs[index] = { field: false, operator: false, value: false };

filter.field = filter.field ?? '';
filter.operator = filter.operator ?? '';
filter.value = filter.value ?? '';

if (filter.field === '') {
highlightedInputs[index].field = true;
}

if (filter.operator === '') {
highlightedInputs[index].operator = true;
}

if (filter.operator === 'is empty' || filter.operator === 'is not empty') {
filter.value = '';
} else if (filter.value === '') {
highlightedInputs[index].value = true;
}
});

const isSingleEmptyFilter = filters.length === 1 && !filters[0].field && !filters[0].operator && !filters[0].value;

setHighlightedInputs(highlightedInputs);
if (isSingleEmptyFilter || !Object.values(highlightedInputs).some(v => (v as any).field || (v as any).operator || (v as any).value)) {
handleQuery(filters);
setFilters(filters);
handleClose();
event.preventDefault()
const highlighted: Record<number, { field: boolean; operator: boolean; value: boolean }> = {}

filters.forEach((filter, i) => {
highlighted[i] = { field: false, operator: false, value: false }

filter.field = filter.field ?? ''
filter.value = filter.value ?? ''

if (!filter.field) {
highlighted[i].field = true
}
};

if (!filter.operator.key) {
highlighted[i].operator = true
}

if (
filter.operator.key === OperatorKey.IsEmpty ||
filter.operator.key === OperatorKey.IsNotEmpty
) {
filter.value = ''
} else if (!filter.value) {
highlighted[i].value = true
}
})

const isSingleEmpty =
filters.length === 1 &&
!filters[0].field &&
!filters[0].operator.key &&
!filters[0].value

setHighlightedInputs(highlighted)
if (
isSingleEmpty ||
!Object.values(highlighted).some(v => v.field || v.operator || v.value)
) {
handleQuery(filters)
setFilters(filters)
handleClose?.()
}
}

const handleMenuClose = () => {
setCommonFilterMenuOpen(false)
Expand Down Expand Up @@ -241,34 +262,33 @@ const FilterForm = (props: FilterFormProps ) => {
/>
</FormControlMinWidth>

<FormControlMinWidth sx={ highlightedInputs[index]?.operator ? highlightedSx : null } >
<InputLabel id="operator-label">Operator</InputLabel>
<Select
labelId="operator-label"
label="Operator"
value={filter.operator}
onChange={(event) =>
handleFilterChange(index, "operator", event.target.value)
}
>
<MenuItem value="None" style={{ display: 'none' }}>
<em>None</em>
</MenuItem>

{getOperatorsForField(fieldTypeInfo.find(obj => obj.name === filter.field)) ? (
getOperatorsForField(fieldTypeInfo.find(obj => obj.name === filter.field)).map((operator) => (
<MenuItem key={operator} value={operator}>
{operator}
</MenuItem>
))
) : (
<MenuItem></MenuItem>
)}

</Select>
<FormControlMinWidth sx={highlightedInputs[index]?.operator ? highlightedSx : null}>
<InputLabel id="operator-label">Operator</InputLabel>
<Select
labelId="operator-label"
label="Operator"
value={filter.operator.key}
onChange={event =>
handleFilterChange(index, "operator", event.target.value as OperatorKey)
}
>
<MenuItem value={OperatorKey.None}>
<em>None</em>
</MenuItem>
{(() => {
const ops = fieldTypeInfo.find(f => f.name === filter.field)?.getOperators() ?? [];
return ops.length > 0
? ops.map(op => (
<MenuItem key={op.key} value={op.key}>
{op.label}
</MenuItem>
))
: <MenuItem />;
})()}
</Select>
</FormControlMinWidth>

{filter.operator === "equals one of" ? (
{filter.operator.key === OperatorKey.EqualsOneOf ? (
<FormControlMinWidth sx={ highlightedInputs[index]?.value ? highlightedSx : null } >
<InputLabel id="value-select-label">Value</InputLabel>
<Select
Expand All @@ -288,13 +308,14 @@ const FilterForm = (props: FilterFormProps ) => {
) : fieldTypeInfo.find(obj => obj.name === filter.field)?.allowableValues?.length > 1 ? (
<FormControlMinWidth sx={ highlightedInputs[index]?.value ? highlightedSx : null } >
<AsyncSelect
key={`async-${index}-${filter.operator.key}`}
id={`value-select-${index}`}
inputId={`value-select-${index}`}
aria-labelledby={`value-select-${index}`}
noOptionsMessage={() => 'Type to search...'}
menuPortalTarget={document.body}
menuPosition={'fixed'}
isDisabled={filter.operator === "is empty" || filter.operator === "is not empty"}
isDisabled={filter.operator.key === OperatorKey.IsEmpty || filter.operator.key === OperatorKey.IsNotEmpty}
menuShouldBlockScroll={true}
// See here: https://stackoverflow.com/questions/77625507/my-react-project-with-react-18-2-0-version-and-react-select-5-4-0-v
styles={{ menuPortal: (base: any) => ({ ...base, zIndex: 9999 }) }}
Expand All @@ -309,8 +330,16 @@ const FilterForm = (props: FilterFormProps ) => {
.map(value => ({label: value, value}))
);
}}
onChange={(selected) => handleFilterChange(index, "value", selected?.length > 0 ? selected.map(s => s.value).join(',') : undefined)}
value={filter.value ? filter.value.split(',').map(value => ({label: value, value})) : undefined}
onChange={(selected) => {
const arr = Array.isArray(selected) ? selected : [selected].filter(Boolean)
const val = arr.map(s => s.value).join(',')
handleFilterChange(index, 'value', val)
}}
value={
filter.value
? (filter.value as string).split(',').map(v => ({ label: v, value: v }))
: null
}
/>
</FormControlMinWidth>
) : fieldTypeInfo.find(obj => obj.name === filter.field)?.allowableValues?.length > 0 ? (
Expand All @@ -321,7 +350,7 @@ const FilterForm = (props: FilterFormProps ) => {
label="Value"
id={`value-select-${index}`}
value={filter.value}
disabled={filter.operator === "is empty" || filter.operator === "is not empty"}
disabled={filter.operator.key === OperatorKey.IsEmpty || filter.operator.key === OperatorKey.IsNotEmpty}
onChange={(event) =>
handleFilterChange(index, "value", event.target.value)
}
Expand All @@ -340,7 +369,7 @@ const FilterForm = (props: FilterFormProps ) => {
sx={ highlightedInputs[index]?.value ? highlightedSx : null }
variant="outlined"
value={filter.value}
disabled={filter.operator === "is empty" || filter.operator === "is not empty"}
disabled={filter.operator.key === OperatorKey.IsEmpty || filter.operator.key === OperatorKey.IsNotEmpty}
onChange={(event) =>
handleFilterChange(index, 'value', event.target.value)
}
Expand Down
12 changes: 7 additions & 5 deletions jbrowse/src/client/JBrowse/VariantSearch/components/VariantTableWidget.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
GridToolbarExport
} from '@mui/x-data-grid';
import SearchIcon from '@mui/icons-material/Search';
import { OperatorKey } from '../operators'
import LinkIcon from '@mui/icons-material/Link';
import DownloadIcon from '@mui/icons-material/Download'
import { ActionURL } from '@labkey/api';
Expand All @@ -25,6 +26,7 @@ import { NoAssemblyRegion } from '@jbrowse/core/util/types';
import { toArray } from 'rxjs/operators';
import {
createEncodedFilterString,
buildLuceneQuery,
fetchFieldTypeInfo,
fetchLuceneQuery,
FieldModel,
Expand Down Expand Up @@ -78,7 +80,7 @@ const VariantTableWidget = observer(props => {
const { page = pageSizeModel.page, pageSize = pageSizeModel.pageSize } = pageQueryModel;
const { field = "genomicPosition", sort = false } = sortQueryModel[0] ?? {};

const encodedSearchString = createEncodedFilterString(passedFilters, false);
const encodedSearchString = createEncodedFilterString(passedFilters);
const currentUrl = new URL(window.location.href);
currentUrl.searchParams.set("searchString", encodedSearchString);
currentUrl.searchParams.set("page", page.toString());
Expand All @@ -98,7 +100,7 @@ const VariantTableWidget = observer(props => {
const handleExport = () => {
const currentUrl = new URL(window.location.href);

const searchString = createEncodedFilterString(filters, true);
const searchString = encodeURIComponent(buildLuceneQuery(filters));
const sortField = sortModel[0]?.field ?? 'genomicPosition';
const sortDirection = sortModel[0]?.sort ?? false;

Expand Down Expand Up @@ -552,14 +554,14 @@ const VariantTableWidget = observer(props => {
<div style={{ marginBottom: "10px", display: "flex", alignItems: "center" }}>
<div style={{ flex: 1 }}>
{filters.map((filter, index) => {
if ((filter as any).field && ((filter as any).operator === "is empty" || (filter as any).operator === "is not empty") && !(filter as any).value) {
if ((filter as any).field && ((filter as any).operator.key === OperatorKey.IsEmpty || (filter as any).operator.key === OperatorKey.IsNotEmpty) && !(filter as any).value) {
return (
<Button
key={index}
onClick={() => setFilterModalOpen(true)}
style={{ border: "1px solid gray", margin: "5px" }}
>
{`${(filter as any).field} ${(filter as any).operator}`}
{`${(filter as any).field} ${(filter as any).operator.key}`}
</Button>
);
}
Expand All @@ -577,7 +579,7 @@ const VariantTableWidget = observer(props => {
key={index}
onClick={() => setFilterModalOpen(true)}
style={{ border: "1px solid gray", margin: "5px" }} >
{`${(filter as any).field} ${(filter as any).operator} ${(filter as any).value}`}
{`${(filter as any).field} ${(filter as any).operator.key} ${(filter as any).value}`}
</Button>
);
})}
Expand Down
Loading