-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Expand file tree
/
Copy pathSearchQueryUtils.ts
More file actions
2247 lines (1950 loc) · 95.4 KB
/
Copy pathSearchQueryUtils.ts
File metadata and controls
2247 lines (1950 loc) · 95.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {addDays, endOfMonth, format, parse, startOfMonth, startOfYear, subMonths} from 'date-fns';
import cloneDeep from 'lodash/cloneDeep';
import Onyx from 'react-native-onyx';
import type {NullishDeep, OnyxCollection, OnyxUpdate} from 'react-native-onyx';
import type {ValueOf} from 'type-fest';
import type {LocaleContextProps, LocalizedTranslate} from '@components/LocaleContextProvider';
import type {
ASTNode,
QueryFilter,
QueryFilters,
RawQueryFilter,
ReportFieldDateKey,
ReportFieldNegatedKey,
ReportFieldTextKey,
SearchAmountFilterKeys,
SearchAutocompleteResult,
SearchDateFilterKeys,
SearchDateKey,
SearchDatePreset,
SearchFilterKey,
SearchQueryJSON,
SearchQueryString,
SearchStatus,
SearchWithdrawalType,
SyntaxFilterKey,
UserFriendlyKey,
UserFriendlyValue,
} from '@components/Search/types';
import type {FeedKeysWithAssignedCards} from '@hooks/useFeedKeysWithAssignedCards';
import CONST from '@src/CONST';
import NAVIGATORS from '@src/NAVIGATORS';
import type {OnyxCollectionKey, OnyxCollectionValuesMapping} from '@src/ONYXKEYS';
import ONYXKEYS from '@src/ONYXKEYS';
import SCREENS from '@src/SCREENS';
import type {SearchAdvancedFiltersForm} from '@src/types/form';
import FILTER_KEYS, {ALLOWED_TYPE_FILTERS, AMOUNT_FILTER_KEYS, DATE_FILTER_KEYS} from '@src/types/form/SearchAdvancedFiltersForm';
import type {ExpenseTypeValue, ExpenseTypeValues, HasFilterValue, HasFilterValues, IsFilterValue, IsFilterValues, SearchAdvancedFiltersKey} from '@src/types/form/SearchAdvancedFiltersForm';
import type * as OnyxTypes from '@src/types/onyx';
import type {SearchDataTypes, SearchResultDataType} from '@src/types/onyx/SearchResults';
import {getCardFeedsForDisplay} from './CardFeedUtils';
import {getCardDescription} from './CardUtils';
import {convertToBackendAmount, convertToFrontendAmountAsInteger} from './CurrencyUtils';
import DateUtils from './DateUtils';
import Log from './Log';
import {validateAmount} from './MoneyRequestUtils';
import {getPreservedNavigatorState} from './Navigation/AppNavigator/createSplitNavigator/usePreserveNavigatorState';
import navigationRef from './Navigation/navigationRef';
import type {SearchFullscreenNavigatorParamList} from './Navigation/types';
import {getDisplayNameOrDefault, getPersonalDetailByEmail} from './PersonalDetailsUtils';
import {getCleanedTagName} from './PolicyUtils';
import {getReportName} from './ReportNameUtils';
import {parse as parseForAutocomplete} from './SearchParser/autocompleteParser';
import {parse as parseSearchQuery} from './SearchParser/searchParser';
import StringUtils from './StringUtils';
import {hashText} from './UserUtils';
import {isValidDate} from './ValidationUtils';
type FilterKeys = keyof typeof CONST.SEARCH.SYNTAX_FILTER_KEYS;
// This map contains chars that match each operator
const operatorToCharMap = {
[CONST.SEARCH.SYNTAX_OPERATORS.EQUAL_TO]: ':' as const,
[CONST.SEARCH.SYNTAX_OPERATORS.CONTAINS]: '*:' as const,
[CONST.SEARCH.SYNTAX_OPERATORS.LOWER_THAN]: '<' as const,
[CONST.SEARCH.SYNTAX_OPERATORS.LOWER_THAN_OR_EQUAL_TO]: '<=' as const,
[CONST.SEARCH.SYNTAX_OPERATORS.GREATER_THAN]: '>' as const,
[CONST.SEARCH.SYNTAX_OPERATORS.GREATER_THAN_OR_EQUAL_TO]: '>=' as const,
[CONST.SEARCH.SYNTAX_OPERATORS.AND]: ',' as const,
[CONST.SEARCH.SYNTAX_OPERATORS.OR]: ' ' as const,
};
// Pre-computed validation Sets for buildFilterFormValuesFromQuery (avoids recreating per filter iteration)
const VALID_EXPENSE_TYPES = new Set(Object.values(CONST.SEARCH.TRANSACTION_TYPE));
const VALID_HAS_TYPES = new Set(Object.values(CONST.SEARCH.HAS_VALUES));
const VALID_IS_TYPES = new Set(Object.values(CONST.SEARCH.IS_VALUES));
const VALID_WITHDRAWAL_TYPES = new Set(Object.values(CONST.SEARCH.WITHDRAWAL_TYPE));
const VALID_WITHDRAWAL_STATUSES = new Set<string>(Object.values(CONST.SEARCH.SETTLEMENT_STATUS));
// Create reverse lookup maps for O(1) performance
const createKeyToUserFriendlyMap = () => {
const map = new Map<string, string>();
// Map SYNTAX_FILTER_KEYS values to their user-friendly names
for (const [keyName, keyValue] of Object.entries(CONST.SEARCH.SYNTAX_FILTER_KEYS)) {
if (!(keyName in CONST.SEARCH.SEARCH_USER_FRIENDLY_KEYS)) {
continue;
}
map.set(keyValue, CONST.SEARCH.SEARCH_USER_FRIENDLY_KEYS[keyName as keyof typeof CONST.SEARCH.SEARCH_USER_FRIENDLY_KEYS]);
}
// Map SYNTAX_ROOT_KEYS values to their user-friendly names
for (const [keyName, keyValue] of Object.entries(CONST.SEARCH.SYNTAX_ROOT_KEYS)) {
if (!(keyName in CONST.SEARCH.SEARCH_USER_FRIENDLY_KEYS)) {
continue;
}
map.set(keyValue, CONST.SEARCH.SEARCH_USER_FRIENDLY_KEYS[keyName as keyof typeof CONST.SEARCH.SEARCH_USER_FRIENDLY_KEYS]);
}
return map;
};
// Create the maps once at module initialization for performance
const keyToUserFriendlyMap = createKeyToUserFriendlyMap();
/**
* Lookup a key in the keyToUserFriendlyMap and return the user-friendly key.
*
* @example
* getUserFriendlyKey("taxRate") // returns "tax-rate"
*/
function getUserFriendlyKey(
keyName: SearchFilterKey | typeof CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY | typeof CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER | typeof CONST.SEARCH.SYNTAX_ROOT_KEYS.LIMIT,
): UserFriendlyKey {
const isReportField = keyName.startsWith(CONST.SEARCH.REPORT_FIELD.GLOBAL_PREFIX);
if (isReportField) {
return keyName.replace(CONST.SEARCH.REPORT_FIELD.GLOBAL_PREFIX, CONST.SEARCH.SEARCH_USER_FRIENDLY_KEYS.REPORT_FIELD) as UserFriendlyKey;
}
return (keyToUserFriendlyMap.get(keyName) ?? keyName) as UserFriendlyKey;
}
/**
* Converts a filter value from backend value to user friendly display text.
*
* @example
* getUserFriendlyValues("perDiem") // returns "per-diem"
*/
function getUserFriendlyValue(value: string | undefined): UserFriendlyValue {
return CONST.SEARCH.SEARCH_USER_FRIENDLY_VALUES_MAP[value as keyof typeof CONST.SEARCH.SEARCH_USER_FRIENDLY_VALUES_MAP] ?? value;
}
/**
* @private
* Returns string value wrapped in quotes "", if the value contains space or (no-breaking space).
*/
function sanitizeSearchValue(str: string) {
if (str.includes(' ') || str.includes(`\xA0`)) {
return `"${str}"`;
}
return str;
}
function getRangeQueryValue(from?: string, to?: string) {
if (from && to) {
return `${from},${to}`;
}
if (from) {
return from;
}
if (to) {
return `,${to}`;
}
return '';
}
function getInclusiveRangeBoundary(date?: string, dayOffset = 0) {
const validDate = date ?? '';
if (!isValidDate(validDate)) {
return undefined;
}
return format(addDays(parse(validDate, 'yyyy-MM-dd', new Date()), dayOffset), 'yyyy-MM-dd');
}
function getRangeBoundariesFromFormValue(rangeValue?: string, fallbackAfter?: string, fallbackBefore?: string) {
const parsedRange = parseRangeQueryValue(rangeValue);
if (rangeValue && (parsedRange.from || parsedRange.to)) {
return parsedRange;
}
const from = getInclusiveRangeBoundary(fallbackAfter, 1);
const to = getInclusiveRangeBoundary(fallbackBefore, -1);
if (from && to && from > to) {
return {
from: undefined,
to: undefined,
};
}
return {
from,
to,
};
}
function getDateRangeDisplayValueFromFormValue(rangeValue?: string, fallbackAfter?: string, fallbackBefore?: string, shouldOmitCurrentYear = false) {
if (!rangeValue) {
return '';
}
const rangeBoundaries = getRangeBoundariesFromFormValue(rangeValue, fallbackAfter, fallbackBefore);
if (rangeBoundaries.from && rangeBoundaries.to) {
const shouldShowFullYear = !shouldOmitCurrentYear || DateUtils.doesDateBelongToAPastYear(rangeBoundaries.from) || DateUtils.doesDateBelongToAPastYear(rangeBoundaries.to);
return DateUtils.getFormattedDateRangeForSearch(rangeBoundaries.from, rangeBoundaries.to, shouldShowFullYear, shouldOmitCurrentYear);
}
const singleBoundary = rangeBoundaries.from ?? rangeBoundaries.to;
return singleBoundary ? DateUtils.formatToReadableString(singleBoundary) : '';
}
function parseRangeQueryValue(rangeValue?: string) {
if (!rangeValue) {
return {
from: undefined,
to: undefined,
};
}
const [rawFrom = '', rawTo = ''] = rangeValue.split(',', 2);
const from = isValidDate(rawFrom) ? rawFrom : undefined;
const to = isValidDate(rawTo) ? rawTo : undefined;
return {
from,
to,
};
}
/**
* @private
* Returns date filter value for QueryString.
*/
function buildDateFilterQuery(filterValues: Partial<SearchAdvancedFiltersForm>, filterKey: SearchDateFilterKeys) {
const negatedDate = filterValues[`${filterKey}${CONST.SEARCH.NOT_MODIFIER}`];
const dateOn = filterValues[`${filterKey}${CONST.SEARCH.DATE_MODIFIERS.ON}`];
const dateAfter = filterValues[`${filterKey}${CONST.SEARCH.DATE_MODIFIERS.AFTER}`];
const dateBefore = filterValues[`${filterKey}${CONST.SEARCH.DATE_MODIFIERS.BEFORE}`];
const dateRange = filterValues[`${filterKey}${CONST.SEARCH.DATE_MODIFIERS.RANGE}`];
const rangeBoundaries = parseRangeQueryValue(dateRange);
const hasRange = !!(rangeBoundaries.from ?? rangeBoundaries.to);
const dateFilters = [];
if (dateOn) {
dateFilters.push(`${filterKey}:${dateOn}`);
}
if (hasRange) {
if (rangeBoundaries.from) {
dateFilters.push(`${filterKey}${operatorToCharMap[CONST.SEARCH.SYNTAX_OPERATORS.GREATER_THAN_OR_EQUAL_TO]}${rangeBoundaries.from}`);
}
if (rangeBoundaries.to) {
dateFilters.push(`${filterKey}${operatorToCharMap[CONST.SEARCH.SYNTAX_OPERATORS.LOWER_THAN_OR_EQUAL_TO]}${rangeBoundaries.to}`);
}
}
if (dateAfter) {
dateFilters.push(`${filterKey}>${dateAfter}`);
}
if (dateBefore) {
dateFilters.push(`${filterKey}<${dateBefore}`);
}
if (negatedDate) {
dateFilters.push(`-${filterKey}:${negatedDate}`);
}
return dateFilters.join(' ');
}
/**
* @private
* Returns amount filter value for QueryString.
*/
function buildAmountFilterQuery(filterKey: SearchAmountFilterKeys, filterValues: Partial<SearchAdvancedFiltersForm>) {
const negatedAmount = filterValues[`${filterKey}${CONST.SEARCH.NOT_MODIFIER}`];
const equalTo = filterValues[`${filterKey}${CONST.SEARCH.AMOUNT_MODIFIERS.EQUAL_TO}`];
const lessThan = filterValues[`${filterKey}${CONST.SEARCH.AMOUNT_MODIFIERS.LESS_THAN}`];
const greaterThan = filterValues[`${filterKey}${CONST.SEARCH.AMOUNT_MODIFIERS.GREATER_THAN}`];
const amountStrings = [];
if (equalTo) {
amountStrings.push(`${filterKey}:${equalTo}`);
}
if (greaterThan) {
amountStrings.push(`${filterKey}>${greaterThan}`);
}
if (lessThan) {
amountStrings.push(`${filterKey}<${lessThan}`);
}
if (negatedAmount) {
amountStrings.push(`-${filterKey}:${negatedAmount}`);
}
return amountStrings.join(' ');
}
/**
* @private
* Returns string of correctly formatted filter values from QueryFilters object.
*/
function buildFilterValuesString(filterName: string, queryFilters: QueryFilter[]) {
const delimiter = filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD ? ' ' : ',';
const allowedOps = new Set<string>([CONST.SEARCH.SYNTAX_OPERATORS.EQUAL_TO, CONST.SEARCH.SYNTAX_OPERATORS.NOT_EQUAL_TO]);
let filterValueString = '';
for (const [index, queryFilter] of queryFilters.entries()) {
const previousValueHasSameOp = allowedOps.has(queryFilter.operator) && queryFilters?.at(index - 1)?.operator === queryFilter.operator;
const nextValueHasSameOp = allowedOps.has(queryFilter.operator) && queryFilters?.at(index + 1)?.operator === queryFilter.operator;
// If the previous queryFilter has the same operator (this rule applies only to eq and neq operators) then append the current value
if (index !== 0 && (previousValueHasSameOp || nextValueHasSameOp)) {
filterValueString += `${delimiter}${sanitizeSearchValue(queryFilter.value.toString())}`;
} else if (filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD) {
filterValueString += `${delimiter}${sanitizeSearchValue(queryFilter.value.toString())}`;
} else if (queryFilter.operator === CONST.SEARCH.SYNTAX_OPERATORS.NOT_EQUAL_TO) {
filterValueString += ` -${filterName}:${sanitizeSearchValue(queryFilter.value.toString())}`;
} else if (queryFilter.operator === CONST.SEARCH.SYNTAX_OPERATORS.RANGE) {
const rangeBoundaries = parseRangeQueryValue(queryFilter.value.toString());
if (rangeBoundaries.from) {
filterValueString += ` ${filterName}${operatorToCharMap[CONST.SEARCH.SYNTAX_OPERATORS.GREATER_THAN_OR_EQUAL_TO]}${sanitizeSearchValue(rangeBoundaries.from)}`;
}
if (rangeBoundaries.to) {
filterValueString += ` ${filterName}${operatorToCharMap[CONST.SEARCH.SYNTAX_OPERATORS.LOWER_THAN_OR_EQUAL_TO]}${sanitizeSearchValue(rangeBoundaries.to)}`;
}
} else {
const operatorChar = operatorToCharMap[queryFilter.operator];
if (!operatorChar) {
continue;
}
filterValueString += ` ${filterName}${operatorChar}${sanitizeSearchValue(queryFilter.value.toString())}`;
}
}
return filterValueString;
}
/**
* @private
* Traverses the AST and returns filters as a QueryFilters object.
*/
function getFilters(queryJSON: SearchQueryJSON) {
const filters = [] as QueryFilters;
const filterKeys = Object.values(CONST.SEARCH.SYNTAX_FILTER_KEYS);
function traverse(node: ASTNode) {
if (!node.operator) {
return;
}
if (typeof node.left === 'object' && node.left) {
traverse(node.left);
}
if (typeof node.right === 'object' && node.right && !Array.isArray(node.right)) {
traverse(node.right);
}
// Only process if its a leaf
if (typeof node.left !== 'string') {
return;
}
const nodeKey = node.left;
if (!filterKeys.includes(nodeKey) && !nodeKey.startsWith(CONST.SEARCH.REPORT_FIELD.GLOBAL_PREFIX)) {
return;
}
const filterArray = [];
if (!Array.isArray(node.right)) {
filterArray.push({
operator: node.operator,
value: node.right as string | number,
});
} else {
for (const element of node.right) {
filterArray.push({
operator: node.operator,
value: element,
});
}
}
filters.push({key: nodeKey, filters: filterArray});
}
if (queryJSON.filters) {
traverse(queryJSON.filters);
}
return filters;
}
/**
* @private
* Returns an updated filter value for some query filters.
* - for `AMOUNT` it formats value to "backend" amount
* - for personal filters it tries to substitute any user emails with accountIDs
*/
function getUpdatedFilterValue(filterName: SyntaxFilterKey, filterValue: string | string[], shouldSkipAmountConversion = false) {
if (AMOUNT_FILTER_KEYS.includes(filterName as SearchAmountFilterKeys)) {
if (shouldSkipAmountConversion) {
return filterValue;
}
if (typeof filterValue === 'string') {
const backendAmount = convertToBackendAmount(Number(filterValue));
return Number.isNaN(backendAmount) ? filterValue : backendAmount.toString();
}
return filterValue.map((amount) => {
const backendAmount = convertToBackendAmount(Number(amount));
return Number.isNaN(backendAmount) ? amount : backendAmount.toString();
});
}
if (
filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM ||
filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.TO ||
filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.PAYER ||
filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPORTER ||
filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.ATTENDEE
) {
if (typeof filterValue === 'string') {
return getPersonalDetailByEmail(filterValue)?.accountID.toString() ?? filterValue;
}
return filterValue.map((email) => getPersonalDetailByEmail(email)?.accountID.toString() ?? email);
}
if (filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.REPORT_ID || filterName === CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWAL_ID) {
const cleanIDs = (value: string) =>
value
.split(',')
.map((id) => id.trim())
.filter((id) => id.length > 0)
.join(',');
if (typeof filterValue === 'string') {
return cleanIDs(filterValue);
}
return filterValue.map(cleanIDs);
}
return filterValue;
}
/**
* @private
* This is a custom collator only for getQueryHashes function.
* The reason for this is that the computation of hashes should not depend on the locale.
* This is used to ensure that hashes stay consistent.
*/
const customCollator = new Intl.Collator('en', {usage: 'sort', sensitivity: 'variant', numeric: true, caseFirst: 'upper'});
let defaultSearchQueryJSON: SearchQueryJSON | undefined;
function getDefaultSearchQueryJSON() {
if (defaultSearchQueryJSON) {
return defaultSearchQueryJSON;
}
defaultSearchQueryJSON = parseSearchQuery('') as SearchQueryJSON;
return defaultSearchQueryJSON;
}
function wasViewExplicitlySet(queryJSON?: SearchQueryJSON | Readonly<SearchQueryJSON>) {
if (!queryJSON?.view) {
return false;
}
if (queryJSON.rawFilterList?.some((filter) => filter.key === CONST.SEARCH.SYNTAX_ROOT_KEYS.VIEW)) {
return true;
}
if (queryJSON.isViewExplicitlySet) {
return true;
}
if (queryJSON.view !== getDefaultSearchQueryJSON()?.view) {
return true;
}
return false;
}
/**
* @private
* Computes and returns a numerical hash for a given queryJSON.
* Sorts the query keys and values to ensure that hashes stay consistent.
*/
function getQueryHashes(query: SearchQueryJSON) {
let orderedQuery = '';
orderedQuery += `${CONST.SEARCH.SYNTAX_ROOT_KEYS.TYPE}:${query.type}`;
orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.STATUS}:${Array.isArray(query.status) ? query.status.join(',') : query.status}`;
orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.GROUP_BY}:${query.groupBy}`;
if (query.policyID) {
orderedQuery += ` ${CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID}:${Array.isArray(query.policyID) ? query.policyID.join(',') : query.policyID} `;
}
const filterSet = new Set<string>(orderedQuery);
// Certain filters shouldn't affect whether two searchers are similar or not, since they dont
// actually filter out results
const similarSearchIgnoredFilters = new Set<SearchFilterKey>([CONST.SEARCH.SYNTAX_FILTER_KEYS.GROUP_CURRENCY]);
// Certain filters' values are significant in deciding which search we are on, so we want to include
// their value when computing the similarSearchHash
const similarSearchValueBasedFilters = new Set<SearchFilterKey>([CONST.SEARCH.SYNTAX_FILTER_KEYS.ACTION]);
const flatFilters = query.flatFilters
.map((filter) => {
const filterKey = filter.key;
const filters = cloneDeep(filter.filters);
filters.sort((a, b) => customCollator.compare(a.value.toString(), b.value.toString()));
return {filterString: buildFilterValuesString(filterKey, filters), filterKey};
})
.sort((a, b) => customCollator.compare(a.filterString, b.filterString));
for (const {filterString, filterKey} of flatFilters) {
if (!similarSearchIgnoredFilters.has(filterKey)) {
filterSet.add(filterKey);
}
if (similarSearchValueBasedFilters.has(filterKey)) {
filterSet.add(filterString.trim());
}
orderedQuery += ` ${filterString}`;
}
const similarSearchHash = hashText(Array.from(filterSet).join(''), 2 ** 32);
const recentSearchHash = hashText(orderedQuery, 2 ** 32);
if (query.groupBy && wasViewExplicitlySet(query)) {
orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.VIEW}:${query.view}`;
}
orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}:${query.sortBy}`;
orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}:${query.sortOrder}`;
orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.COLUMNS}:${Array.isArray(query.columns) ? query.columns.join(',') : query.columns}`;
if (query.limit !== undefined) {
orderedQuery += ` ${CONST.SEARCH.SYNTAX_ROOT_KEYS.LIMIT}:${query.limit}`;
}
const primaryHash = hashText(orderedQuery, 2 ** 32);
return {primaryHash, recentSearchHash, similarSearchHash};
}
/**
* Returns whether a given string is a date preset (e.g. Last month)
*/
function isSearchDatePreset(date: string | undefined): date is SearchDatePreset {
return Object.values(CONST.SEARCH.DATE_PRESETS).some((datePreset) => datePreset === date);
}
/**
* Returns whether a given search filter is supported in a given search data type
*/
function isFilterSupported(filter: SearchAdvancedFiltersKey, type: SearchDataTypes) {
const supportedTypeFilters = ALLOWED_TYPE_FILTERS[type];
if (!supportedTypeFilters) {
return false;
}
if (supportedTypeFilters.has(filter)) {
return true;
}
if (filter.startsWith(CONST.SEARCH.REPORT_FIELD.GLOBAL_PREFIX)) {
return supportedTypeFilters.has(CONST.SEARCH.SYNTAX_FILTER_KEYS.REPORT_FIELD);
}
return false;
}
/**
* Parses a given search query string into a structured `SearchQueryJSON` format.
* This format of query is most commonly shared between components and also sent to backend to retrieve search results.
*
* In a way this is the reverse of buildSearchQueryString()
*/
function getRawFilterListFromQuery(rawQuery: SearchQueryString) {
try {
const rawResult = parseSearchQuery(rawQuery) as SearchQueryJSON;
const sanitizedFilters = getSanitizedRawFilters(rawResult);
return sanitizedFilters;
} catch (error) {
Log.warn('[Search] Failed to parse raw query for raw filters', {error, rawQuery});
}
return undefined;
}
// Cache for buildSearchQueryJSON to avoid re-running the PEG parser for identical queries.
// Cached values are shallow-frozen; callers needing to change fields must spread into a new object first.
// This is a pure function called from 64+ sites — many fire during the same render cycle
// with identical query strings, each running the full parser from scratch.
const buildSearchQueryJSONCache = new Map<string, Readonly<SearchQueryJSON> | undefined>();
const BUILD_SEARCH_QUERY_JSON_CACHE_MAX_SIZE = 50;
const BUILD_SEARCH_QUERY_JSON_CACHE_KEY_SEPARATOR = '\x00'; // Null byte prevents collisions if query/rawQuery contain arbitrary strings
function getBuildSearchQueryJSONCacheKey(query: SearchQueryString, rawQuery?: SearchQueryString) {
return rawQuery ? `${query}${BUILD_SEARCH_QUERY_JSON_CACHE_KEY_SEPARATOR}${rawQuery}` : query;
}
function getCachedSearchQueryJSON(query: SearchQueryString, rawQuery?: SearchQueryString): Readonly<SearchQueryJSON> | undefined {
const cacheKey = getBuildSearchQueryJSONCacheKey(query, rawQuery);
if (buildSearchQueryJSONCache.has(cacheKey)) {
return buildSearchQueryJSONCache.get(cacheKey);
}
try {
const result = parseSearchQuery(query) as SearchQueryJSON;
const flatFilters = getFilters(result);
const rawFilterList = rawQuery ? getRawFilterListFromQuery(rawQuery) : result.rawFilterList;
// Add the full input and hash to the results
result.inputQuery = query;
result.flatFilters = flatFilters;
result.isViewExplicitlySet = rawFilterList?.some((filter) => filter.key === CONST.SEARCH.SYNTAX_ROOT_KEYS.VIEW) ?? false;
if (result.policyID && typeof result.policyID === 'string') {
// Ensure policyID is always an array for consistency
result.policyID = [result.policyID];
}
// Normalize limit before computing hashes to ensure invalid values don't affect hash
if (result.limit !== undefined) {
const num = Number(result.limit);
result.limit = Number.isInteger(num) && num > 0 ? num : undefined;
}
const {primaryHash, recentSearchHash, similarSearchHash} = getQueryHashes(result);
result.hash = primaryHash;
result.recentSearchHash = recentSearchHash;
result.similarSearchHash = similarSearchHash;
delete result.rawFilterList;
if (rawQuery) {
result.rawFilterList = rawFilterList;
}
if (buildSearchQueryJSONCache.size >= BUILD_SEARCH_QUERY_JSON_CACHE_MAX_SIZE) {
const firstKey = buildSearchQueryJSONCache.keys().next().value;
if (firstKey !== undefined) {
buildSearchQueryJSONCache.delete(firstKey);
}
}
const frozen = Object.freeze(result);
buildSearchQueryJSONCache.set(cacheKey, frozen);
return frozen;
} catch (e) {
console.error(`Error when parsing SearchQuery: "${query}"`, e);
}
}
/** Parses {@link query} (and optionally {@link rawQuery}) into JSON. Repeated calls share the same cached object identity for referential stability. */
function buildSearchQueryJSON(query: SearchQueryString, rawQuery?: SearchQueryString): Readonly<SearchQueryJSON> | undefined {
return getCachedSearchQueryJSON(query, rawQuery);
}
/**
* Formats a given `SearchQueryJSON` object into the string version of query.
* This format of query is the most basic string format and is used as the query param `q` in search URLs.
*
* In a way this is the reverse of buildSearchQueryJSON()
*/
function buildSearchQueryString(queryJSON?: SearchQueryJSON | Readonly<SearchQueryJSON>) {
const queryParts: string[] = [];
const defaultQueryJSON = buildSearchQueryJSON('');
const isViewExplicitlySet = wasViewExplicitlySet(queryJSON);
for (const [, key] of Object.entries(CONST.SEARCH.SYNTAX_ROOT_KEYS)) {
if (key === CONST.SEARCH.SYNTAX_ROOT_KEYS.VIEW && (!isViewExplicitlySet || !queryJSON?.groupBy)) {
continue;
}
const existingFieldValue = queryJSON?.[key];
const queryFieldValue = existingFieldValue ?? defaultQueryJSON?.[key];
if (queryFieldValue) {
if (Array.isArray(queryFieldValue)) {
queryParts.push(`${key}:${queryFieldValue.join(',')}`);
} else {
queryParts.push(`${key}:${queryFieldValue}`);
}
}
}
if (queryJSON?.policyID) {
queryParts.push(`${CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID}:${Array.isArray(queryJSON.policyID) ? queryJSON.policyID.join(',') : queryJSON.policyID}`);
}
if (!queryJSON) {
return queryParts.join(' ');
}
const filters = queryJSON.flatFilters;
for (const filter of filters) {
const filterValueString = buildFilterValuesString(filter.key, filter.filters);
queryParts.push(filterValueString.trim());
}
return queryParts.join(' ');
}
function getSanitizedRawFilters(queryJSON: SearchQueryJSON): RawQueryFilter[] | undefined {
if (!queryJSON.rawFilterList || queryJSON.rawFilterList.length === 0) {
return undefined;
}
const sanitizedFilters = queryJSON.rawFilterList.reduce<RawQueryFilter[]>((accumulator, rawFilter) => {
if (!rawFilter) {
return accumulator;
}
if (rawFilter.isDefault) {
accumulator.push(rawFilter);
return accumulator;
}
const rawValue = rawFilter.value;
const filterKey = rawFilter.key;
const isRecognizedFilterKey = Object.values(CONST.SEARCH.SYNTAX_FILTER_KEYS).includes(filterKey as SyntaxFilterKey);
let updatedValue: string | string[] = Array.isArray(rawValue) ? rawValue.map((value) => value?.toString() ?? '') : (rawValue?.toString() ?? '');
if (isRecognizedFilterKey) {
updatedValue = getUpdatedFilterValue(filterKey as SyntaxFilterKey, updatedValue);
}
accumulator.push({
...rawFilter,
value: updatedValue,
});
return accumulator;
}, []);
const seenKeys = new Set<string>();
for (let index = sanitizedFilters.length - 1; index >= 0; index -= 1) {
const filter = sanitizedFilters.at(index);
if (!filter) {
continue;
}
const filterKey = filter.key;
if (seenKeys.has(filterKey) && filter.isDefault) {
sanitizedFilters.splice(index, 1);
continue;
}
seenKeys.add(filterKey);
}
return sanitizedFilters;
}
type BuildQueryStringOptions = {
sortBy?: string;
sortOrder?: string;
limit?: number;
};
/**
* Formats a given object with search filter values into the string version of the query.
* Main usage is to consume data format that comes from AdvancedFilters Onyx Form Data, and generate query string.
*
* Reverse operation of buildFilterFormValuesFromQuery()
*/
function buildQueryStringFromFilterFormValues(filterValues: Partial<SearchAdvancedFiltersForm>, options?: BuildQueryStringOptions) {
const supportedFilterValues = {...filterValues};
// When switching types/setting the type, ensure we aren't polluting our query with filters that are
// only available for the previous type. Remove all filters that are not allowed for the new type
const providedFilterKeys = Object.keys(supportedFilterValues) as SearchAdvancedFiltersKey[];
for (const filter of providedFilterKeys) {
const isDateRangeModifier = filter.endsWith(CONST.SEARCH.DATE_MODIFIERS.RANGE);
if (isDateRangeModifier) {
const dateKey = filter.slice(0, -CONST.SEARCH.DATE_MODIFIERS.RANGE.length);
const afterKey = `${dateKey}${CONST.SEARCH.DATE_MODIFIERS.AFTER}` as SearchAdvancedFiltersKey;
const beforeKey = `${dateKey}${CONST.SEARCH.DATE_MODIFIERS.BEFORE}` as SearchAdvancedFiltersKey;
if (
isFilterSupported(afterKey, supportedFilterValues.type ?? CONST.SEARCH.DATA_TYPES.EXPENSE) ||
isFilterSupported(beforeKey, supportedFilterValues.type ?? CONST.SEARCH.DATA_TYPES.EXPENSE)
) {
continue;
}
}
if (isFilterSupported(filter, supportedFilterValues.type ?? CONST.SEARCH.DATA_TYPES.EXPENSE)) {
continue;
}
supportedFilterValues[filter] = undefined;
}
// We separate type and status filters from other filters to maintain hashes consistency for saved searches
const {type, status, groupBy, view, columns, limit, ...otherFilters} = supportedFilterValues;
const filtersString: string[] = [];
if (options?.sortBy) {
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_BY}:${options.sortBy}`);
}
if (options?.sortOrder) {
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.SORT_ORDER}:${options.sortOrder}`);
}
if (type) {
const sanitizedType = sanitizeSearchValue(type);
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.TYPE}:${sanitizedType}`);
}
if (groupBy) {
const sanitizedGroupBy = sanitizeSearchValue(groupBy);
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.GROUP_BY}:${sanitizedGroupBy}`);
}
// View is only valid when groupBy is set
if (view && groupBy) {
const sanitizedView = sanitizeSearchValue(view);
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.VIEW}:${sanitizedView}`);
}
if (status && typeof status === 'string') {
const sanitizedStatus = sanitizeSearchValue(status);
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.STATUS}:${sanitizedStatus}`);
}
if (status && Array.isArray(status)) {
const filterValueArray = [...new Set<string>(status)];
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.STATUS}:${filterValueArray.map(sanitizeSearchValue).join(',')}`);
}
if (columns?.length) {
const filterValueArray = [...new Set<string>(columns)];
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.COLUMNS}:${filterValueArray.map(sanitizeSearchValue).join(',')}`);
}
const mappedFilters = Object.entries(otherFilters)
.map(([filterKey, filterValue]) => {
const isNegated = filterKey.endsWith(CONST.SEARCH.NOT_MODIFIER);
if (isNegated) {
// eslint-disable-next-line no-param-reassign
filterKey = filterKey.replace(CONST.SEARCH.NOT_MODIFIER, '');
}
const prefix = isNegated ? '-' : '';
if (
(filterKey === FILTER_KEYS.MERCHANT ||
filterKey === FILTER_KEYS.DESCRIPTION ||
filterKey === FILTER_KEYS.REIMBURSABLE ||
filterKey === FILTER_KEYS.BILLABLE ||
filterKey === FILTER_KEYS.TITLE ||
filterKey === FILTER_KEYS.PAYER ||
filterKey === FILTER_KEYS.GROUP_CURRENCY ||
filterKey === FILTER_KEYS.WITHDRAWAL_TYPE ||
filterKey === FILTER_KEYS.ACTION) &&
filterValue
) {
const keyInCorrectForm = (Object.keys(CONST.SEARCH.SYNTAX_FILTER_KEYS) as FilterKeys[]).find((key) => CONST.SEARCH.SYNTAX_FILTER_KEYS[key] === filterKey);
if (keyInCorrectForm) {
return `${prefix}${CONST.SEARCH.SYNTAX_FILTER_KEYS[keyInCorrectForm]}:${sanitizeSearchValue(filterValue as string)}`;
}
}
if ((filterKey === FILTER_KEYS.REPORT_ID || filterKey === FILTER_KEYS.WITHDRAWAL_ID) && filterValue) {
const reportIDs = (filterValue as string)
.split(',')
.map((id) => sanitizeSearchValue(id.trim()))
.filter((id) => id.length > 0);
const keyInCorrectForm = (Object.keys(CONST.SEARCH.SYNTAX_FILTER_KEYS) as FilterKeys[]).find((key) => CONST.SEARCH.SYNTAX_FILTER_KEYS[key] === filterKey);
if (keyInCorrectForm && reportIDs.length > 0) {
return `${prefix}${CONST.SEARCH.SYNTAX_FILTER_KEYS[keyInCorrectForm]}:${reportIDs.join(',')}`;
}
}
if (filterKey === FILTER_KEYS.KEYWORD && filterValue) {
const value = (filterValue as string).split(' ').map(sanitizeSearchValue).join(' ');
return `${value}`;
}
if (filterKey.startsWith(CONST.SEARCH.REPORT_FIELD.GLOBAL_PREFIX) && filterValue) {
const value = sanitizeSearchValue(filterValue as string);
const isFieldNegated = filterKey.startsWith(CONST.SEARCH.REPORT_FIELD.NOT_PREFIX);
const isTextBasedReportField = filterKey.startsWith(CONST.SEARCH.REPORT_FIELD.DEFAULT_PREFIX) || isNegated;
const fieldPrefix = isFieldNegated ? '-' : '';
const isRangeDateField = filterKey.startsWith(CONST.SEARCH.REPORT_FIELD.RANGE_PREFIX);
if (isTextBasedReportField) {
return `${fieldPrefix}${filterKey}:${value}`;
}
const isOnDateField = filterKey.startsWith(CONST.SEARCH.REPORT_FIELD.ON_PREFIX);
const isAfterDateField = filterKey.startsWith(CONST.SEARCH.REPORT_FIELD.AFTER_PREFIX);
const isBeforeDateField = filterKey.startsWith(CONST.SEARCH.REPORT_FIELD.BEFORE_PREFIX);
if (isOnDateField) {
const key = filterKey.replace(CONST.SEARCH.REPORT_FIELD.ON_PREFIX, CONST.SEARCH.REPORT_FIELD.DEFAULT_PREFIX);
return `${key}:${value}`;
}
if (isRangeDateField) {
const suffix = filterKey.replace(CONST.SEARCH.REPORT_FIELD.RANGE_PREFIX, '');
const key = `${CONST.SEARCH.REPORT_FIELD.DEFAULT_PREFIX}${suffix}`;
const rangeBoundaries = parseRangeQueryValue(filterValue as string | undefined);
const rangeFilters: string[] = [];
if (rangeBoundaries.from) {
rangeFilters.push(`${key}${operatorToCharMap[CONST.SEARCH.SYNTAX_OPERATORS.GREATER_THAN_OR_EQUAL_TO]}${rangeBoundaries.from}`);
}
if (rangeBoundaries.to) {
rangeFilters.push(`${key}${operatorToCharMap[CONST.SEARCH.SYNTAX_OPERATORS.LOWER_THAN_OR_EQUAL_TO]}${rangeBoundaries.to}`);
}
if (rangeFilters.length === 0) {
return undefined;
}
return rangeFilters.join(' ');
}
if (isAfterDateField) {
const key = filterKey.replace(CONST.SEARCH.REPORT_FIELD.AFTER_PREFIX, CONST.SEARCH.REPORT_FIELD.DEFAULT_PREFIX);
return `${key}>${value}`;
}
if (isBeforeDateField) {
const key = filterKey.replace(CONST.SEARCH.REPORT_FIELD.BEFORE_PREFIX, CONST.SEARCH.REPORT_FIELD.DEFAULT_PREFIX);
return `${key}<${value}`;
}
}
if (
(filterKey === FILTER_KEYS.CATEGORY ||
filterKey === FILTER_KEYS.CARD_ID ||
filterKey === FILTER_KEYS.TAX_RATE ||
filterKey === FILTER_KEYS.EXPENSE_TYPE ||
filterKey === FILTER_KEYS.TAG ||
filterKey === FILTER_KEYS.CURRENCY ||
filterKey === FILTER_KEYS.PURCHASE_CURRENCY ||
filterKey === FILTER_KEYS.FROM ||
filterKey === FILTER_KEYS.TO ||
filterKey === FILTER_KEYS.FEED ||
filterKey === FILTER_KEYS.IN ||
filterKey === FILTER_KEYS.ASSIGNEE ||
filterKey === FILTER_KEYS.POLICY_ID ||
filterKey === FILTER_KEYS.HAS ||
filterKey === FILTER_KEYS.IS ||
filterKey === FILTER_KEYS.EXPORTER ||
filterKey === FILTER_KEYS.EXPORTED_TO ||
filterKey === FILTER_KEYS.ATTENDEE ||
filterKey === FILTER_KEYS.COLUMNS ||
filterKey === FILTER_KEYS.WITHDRAWAL_STATUS) &&
Array.isArray(filterValue) &&
filterValue.length > 0
) {
const filterValueArray = [...new Set<string>(filterValue)];
const keyInCorrectForm = (Object.keys(CONST.SEARCH.SYNTAX_FILTER_KEYS) as FilterKeys[]).find((key) => CONST.SEARCH.SYNTAX_FILTER_KEYS[key] === filterKey);
if (keyInCorrectForm) {
if (!isNegated && filterKey === FILTER_KEYS.TAG && filterValueArray.length === 1 && filterValueArray.at(0) === CONST.SEARCH.TAG_EMPTY_VALUE) {
return `-${CONST.SEARCH.SYNTAX_FILTER_KEYS.HAS}:${CONST.SEARCH.HAS_VALUES.TAG}`;
}
return `${prefix}${CONST.SEARCH.SYNTAX_FILTER_KEYS[keyInCorrectForm]}:${filterValueArray.map(sanitizeSearchValue).join(',')}`;
}
}
return undefined;
})
.filter((filter): filter is string => !!filter);
filtersString.push(...mappedFilters);
for (const dateKey of DATE_FILTER_KEYS) {
const dateFilter = buildDateFilterQuery(supportedFilterValues, dateKey);
filtersString.push(dateFilter);
}
for (const filterKey of AMOUNT_FILTER_KEYS) {
const amountFilter = buildAmountFilterQuery(filterKey, supportedFilterValues);
filtersString.push(amountFilter);
}
const limitValue = limit ?? options?.limit;
if (limitValue) {
const num = Number(limitValue);
if (Number.isInteger(num) && num > 0) {
filtersString.push(`${CONST.SEARCH.SYNTAX_ROOT_KEYS.LIMIT}:${num}`);
}
}
return filtersString.filter(Boolean).join(' ').trim();
}
function getAllPolicyValues<T extends OnyxCollectionKey>(
policyID: string[] | undefined,
key: T,
policyData: OnyxCollection<OnyxCollectionValuesMapping[T]>,
): Array<OnyxCollectionValuesMapping[T]> {
if (!policyData || !policyID) {
return [];
}