mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-19 16:02:01 +00:00
0350e2df58
Summary: A formula returning an empty RecordSet in a RefList columns results in storing [] instead of null. This caused a bug where the empty list was 'flattened' and the cell not appearing in filters at all. This diff fixes the bug by filtering for the default value `null` instead for RefLists and the empty string for ChoiceLists. I didn't manage to actually reproduce the bug for ChoiceLists, but this seemed the most sensible thing to do. Test Plan: New nbrowser test. Reviewers: georgegevoian Reviewed By: georgegevoian Differential Revision: https://phab.getgrist.com/D3478
53 lines
2.2 KiB
TypeScript
53 lines
2.2 KiB
TypeScript
import {CellValue} from "app/common/DocActions";
|
|
import {FilterState, isRangeFilter, makeFilterState} from "app/common/FilterState";
|
|
import {decodeObject} from "app/plugin/objtypes";
|
|
import {isList, isListType, isNumberType} from "./gristTypes";
|
|
|
|
export type ColumnFilterFunc = (value: CellValue) => boolean;
|
|
|
|
// Returns a filter function for a particular column: the function takes a cell value and returns
|
|
// whether it's accepted according to the given FilterState.
|
|
export function makeFilterFunc(state: FilterState,
|
|
columnType?: string): ColumnFilterFunc {
|
|
|
|
if (isRangeFilter(state)) {
|
|
const {min, max} = state;
|
|
if (isNumberType(columnType)) {
|
|
return (val) => {
|
|
if (typeof val !== 'number') { return false; }
|
|
return (
|
|
(max === undefined ? true : val <= max) &&
|
|
(min === undefined ? true : min <= val)
|
|
);
|
|
};
|
|
} else {
|
|
// Although it is not possible to set a range filter for non numeric columns, this still can
|
|
// happen as a result of a column type conversion. In this case, let's include all values.
|
|
return () => true;
|
|
}
|
|
}
|
|
|
|
const {include, values} = state;
|
|
|
|
// NOTE: This logic results in complex values and their stringified JSON representations as equivalent.
|
|
// For example, a TypeError in the formula column and the string '["E","TypeError"]' would be seen as the same.
|
|
// TODO: This narrow corner case seems acceptable for now, but may be worth revisiting.
|
|
return (val: CellValue) => {
|
|
if (isList(val) && columnType && isListType(columnType)) {
|
|
const list = decodeObject(val) as unknown[];
|
|
if (list.length) {
|
|
return list.some(item => values.has(item as any) === include);
|
|
}
|
|
// If the list is empty, filter instead by an empty value for the whole list
|
|
val = columnType === "ChoiceList" ? "" : null;
|
|
}
|
|
return (values.has(Array.isArray(val) ? JSON.stringify(val) : val) === include);
|
|
};
|
|
}
|
|
|
|
// Given a JSON string, returns a ColumnFilterFunc
|
|
export function buildColFilter(filterJson: string | undefined,
|
|
columnType?: string): ColumnFilterFunc | null {
|
|
return filterJson ? makeFilterFunc(makeFilterState(filterJson), columnType) : null;
|
|
}
|