devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
499 lines (498 loc) • 19 kB
JavaScript
/**
* DevExtreme (esm/__internal/grids/new/grid_core/search/utils.test.js)
* Version: 25.1.3
* Build date: Wed Jun 25 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
import _extends from "@babel/runtime/helpers/esm/extends";
import {
describe,
expect,
it
} from "@jest/globals";
import {
normalizeColumn
} from "../columns_controller/columns_controller.mock";
import {
defaultColumnProperties
} from "../columns_controller/options";
import {
allowSearch,
calculateSearchFilter,
compareTextPart,
createFilterExpression,
splitHighlightedText
} from "./utils";
describe("Search", (() => {
describe("Text highlighting", (() => {
describe("Utils", (() => {
describe("compareTextPart", (() => {
it.each([{
textPart: "AAA",
searchStr: "aaa",
result: true
}, {
textPart: "aaa",
searchStr: "AAA",
result: true
}, {
textPart: "aaa",
searchStr: "aaa",
result: true
}, {
textPart: "AAA",
searchStr: "AAA",
result: true
}, {
textPart: "bbb",
searchStr: "aaa",
result: false
}, {
textPart: "BBB",
searchStr: "aaa",
result: false
}])('case insensitive comparison: "$textPart" with "$searchStr" = $result', (_ref => {
let {
textPart: textPart,
searchStr: searchStr,
result: result
} = _ref;
const comparisonResult = compareTextPart(textPart, searchStr, false);
expect(comparisonResult).toBe(result)
}));
it.each([{
textPart: "AAA",
searchStr: "aaa",
result: false
}, {
textPart: "aaa",
searchStr: "AAA",
result: false
}, {
textPart: "aaa",
searchStr: "aaa",
result: true
}, {
textPart: "AAA",
searchStr: "AAA",
result: true
}, {
textPart: "bbb",
searchStr: "aaa",
result: false
}, {
textPart: "BBB",
searchStr: "aaa",
result: false
}])('case sensitive comparison: "$textPart" with "$searchStr" = $result', (_ref2 => {
let {
textPart: textPart,
searchStr: searchStr,
result: result
} = _ref2;
const comparisonResult = compareTextPart(textPart, searchStr, true);
expect(comparisonResult).toBe(result)
}))
}));
describe("splitHighlightedText", (() => {
it("should return null if highlighting disabled", (() => {
const result = splitHighlightedText("some text", {
enabled: false,
searchStr: "some",
caseSensitive: false
});
expect(result).toBeNull()
}));
it("should return null if search string is empty", (() => {
const result = splitHighlightedText("some text", {
enabled: true,
searchStr: "",
caseSensitive: false
});
expect(result).toBeNull()
}));
it("case insensitive: should return null if search string has not any matches with text", (() => {
const result = splitHighlightedText("some text", {
enabled: true,
searchStr: "AAA",
caseSensitive: false
});
expect(result).toBeNull()
}));
it("case sensitive: should return null if search string has not any matches with text", (() => {
const result = splitHighlightedText("some text", {
enabled: true,
searchStr: "SOME TEXT",
caseSensitive: true
});
expect(result).toBeNull()
}));
it.each([{
caseName: "case insensitive: start match",
text: "Some text",
searchStr: "some",
caseSensitive: false,
result: [{
type: "highlighted",
text: "Some"
}, {
type: "usual",
text: " text"
}]
}, {
caseName: "case insensitive: middle match",
text: "some text",
searchStr: "ME TE",
caseSensitive: false,
result: [{
type: "usual",
text: "so"
}, {
type: "highlighted",
text: "me te"
}, {
type: "usual",
text: "xt"
}]
}, {
caseName: "case insensitive: end match",
text: "Some TeXt",
searchStr: "text",
caseSensitive: false,
result: [{
type: "usual",
text: "Some "
}, {
type: "highlighted",
text: "TeXt"
}]
}, {
caseName: "case insensitive: one letter match",
text: "some text sOme text",
searchStr: "o",
caseSensitive: false,
result: [{
type: "usual",
text: "s"
}, {
type: "highlighted",
text: "o"
}, {
type: "usual",
text: "me text s"
}, {
type: "highlighted",
text: "O"
}, {
type: "usual",
text: "me text"
}]
}, {
caseName: "case insensitive: multiple match",
text: "some multiple text some match",
searchStr: "SOME",
caseSensitive: false,
result: [{
type: "highlighted",
text: "some"
}, {
type: "usual",
text: " multiple text "
}, {
type: "highlighted",
text: "some"
}, {
type: "usual",
text: " match"
}]
}, {
caseName: "case insensitive: special characters match",
text: "$@some $!@text $@var",
searchStr: "$@",
caseSensitive: false,
result: [{
type: "highlighted",
text: "$@"
}, {
type: "usual",
text: "some $!@text "
}, {
type: "highlighted",
text: "$@"
}, {
type: "usual",
text: "var"
}]
}, {
caseName: "case insensitive: special characters with text match",
text: "$@some $!@text $@var",
searchStr: "$!@text",
caseSensitive: false,
result: [{
type: "usual",
text: "$@some "
}, {
type: "highlighted",
text: "$!@text"
}, {
type: "usual",
text: " $@var"
}]
}, {
caseName: "case sensitive: start match",
text: "Some text",
searchStr: "Some",
caseSensitive: true,
result: [{
type: "highlighted",
text: "Some"
}, {
type: "usual",
text: " text"
}]
}, {
caseName: "case sensitive: middle match",
text: "Some Text",
searchStr: "me Te",
caseSensitive: true,
result: [{
type: "usual",
text: "So"
}, {
type: "highlighted",
text: "me Te"
}, {
type: "usual",
text: "xt"
}]
}, {
caseName: "case sensitive: end match",
text: "Some Text",
searchStr: "Text",
caseSensitive: true,
result: [{
type: "usual",
text: "Some "
}, {
type: "highlighted",
text: "Text"
}]
}, {
caseName: "case sensitive: one letter match",
text: "Some text sOme text",
searchStr: "o",
caseSensitive: true,
result: [{
type: "usual",
text: "S"
}, {
type: "highlighted",
text: "o"
}, {
type: "usual",
text: "me text sOme text"
}]
}, {
caseName: "case sensitive: multiple match",
text: "Some multiple text some match",
searchStr: "Some",
caseSensitive: true,
result: [{
type: "highlighted",
text: "Some"
}, {
type: "usual",
text: " multiple text some match"
}]
}, {
caseName: "case sensitive: special characters match",
text: "$@some $!@text $@var",
searchStr: "$@",
caseSensitive: true,
result: [{
type: "highlighted",
text: "$@"
}, {
type: "usual",
text: "some $!@text "
}, {
type: "highlighted",
text: "$@"
}, {
type: "usual",
text: "var"
}]
}, {
caseName: "case sensitive: special characters with text match",
text: "$@some $!@TeXt $@var $!@text",
searchStr: "$!@TeXt",
caseSensitive: true,
result: [{
type: "usual",
text: "$@some "
}, {
type: "highlighted",
text: "$!@TeXt"
}, {
type: "usual",
text: " $@var $!@text"
}]
}])("$caseName", (_ref3 => {
let {
text: text,
searchStr: searchStr,
caseSensitive: caseSensitive,
result: result
} = _ref3;
const textParts = splitHighlightedText(text, {
enabled: true,
searchStr: searchStr,
caseSensitive: caseSensitive
});
expect(textParts).toStrictEqual(result)
}))
}))
}))
}))
}));
describe("allowSearch", (() => {
it.each([{
caseName: "Disallow search in a column with default settings",
column: defaultColumnProperties,
searchVisibleColumnsOnly: false,
expectedResult: false
}, {
caseName: "Allow search in a column with default settings and with dataField",
column: _extends({}, defaultColumnProperties, {
dataField: "ID"
}),
searchVisibleColumnsOnly: false,
expectedResult: true
}, {
caseName: "Allow search in invisible column with default settings if searchVisibleColumnsOnly=false",
column: _extends({}, defaultColumnProperties, {
dataField: "ID",
visible: false
}),
searchVisibleColumnsOnly: false,
expectedResult: true
}, {
caseName: "Disallow search in invisible column with default settings if searchVisibleColumnsOnly=true",
column: _extends({}, defaultColumnProperties, {
dataField: "ID",
visible: false
}),
searchVisibleColumnsOnly: true,
expectedResult: false
}, {
caseName: "Disallow search in a column with default settings if allowSearch=false",
column: _extends({}, defaultColumnProperties, {
dataField: "ID",
allowSearch: false
}),
searchVisibleColumnsOnly: false,
expectedResult: false
}])("$caseName", (_ref4 => {
let {
column: column,
searchVisibleColumnsOnly: searchVisibleColumnsOnly,
expectedResult: expectedResult
} = _ref4;
const result = allowSearch(normalizeColumn(column), searchVisibleColumnsOnly);
expect(result).toEqual(expectedResult)
}))
}));
describe("createFilterExpression", (() => {
describe("targe=search and selectedFilterOperation=undefined", (() => {
it.each([{
caseName: "Column with default settings",
column: _extends({}, defaultColumnProperties, {
dataField: "ID"
}),
filterValue: "a",
expectedResult: ["ID", "contains", "a"]
}, {
caseName: "Column with number type",
column: _extends({}, defaultColumnProperties, {
dataField: "ID",
dataType: "number"
}),
filterValue: "1",
expectedResult: ["ID", "=", "1"]
}, {
caseName: "Column with calculateFilterExpression function",
column: _extends({}, defaultColumnProperties, {
dataField: "ID",
dataType: "number",
calculateFilterExpression: () => ["ID", "=", "5"]
}),
filterValue: "1",
expectedResult: ["ID", "=", "5"]
}])("$caseName", (_ref5 => {
let {
column: column,
filterValue: filterValue,
expectedResult: expectedResult
} = _ref5;
const result = createFilterExpression(column, filterValue, void 0, "search");
expect(result).toEqual(expectedResult)
}))
}))
}));
describe("calculateSearchFilter", (() => {
it.each([{
caseName: "Text is empty",
text: "",
columns: [],
searchVisibleColumnsOnly: false,
expectedResult: null
}, {
caseName: "Two visible columns",
text: "A",
columns: [_extends({}, defaultColumnProperties, {
dataField: "ID1"
}), _extends({}, defaultColumnProperties, {
dataField: "ID2"
})],
searchVisibleColumnsOnly: false,
expectedResult: [
["ID1", "contains", "A"], "or", ["ID2", "contains", "A"]
]
}, {
caseName: "Two visible columns with number format",
text: "3",
columns: [_extends({}, defaultColumnProperties, {
dataField: "ID1",
dataType: "number"
}), _extends({}, defaultColumnProperties, {
dataField: "ID2",
dataType: "number"
})],
searchVisibleColumnsOnly: false,
expectedResult: [
["ID1", "=", 3], "or", ["ID2", "=", 3]
]
}, {
caseName: "One visible and invisible column and searchVisibleColumnsOnly=true",
text: "A",
columns: [_extends({}, defaultColumnProperties, {
dataField: "ID1",
visible: false
}), _extends({}, defaultColumnProperties, {
dataField: "ID2"
})],
searchVisibleColumnsOnly: true,
expectedResult: ["ID2", "contains", "A"]
}])("$caseName", (_ref6 => {
let {
text: text,
columns: columns,
searchVisibleColumnsOnly: searchVisibleColumnsOnly,
expectedResult: expectedResult
} = _ref6;
const result = calculateSearchFilter(text, columns.map(normalizeColumn), searchVisibleColumnsOnly);
expect(result).toEqual(expectedResult)
}))
}));