MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Respond to PR feedback.

This commit is contained in:
Sam Rose 2024-07-10 11:05:16 +01:00
parent 114edc8954
commit 093579a341
No known key found for this signature in database
2 changed files with 58 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
packages/shared-core/src/filters.ts
View File

@ -6,6 +6,7 @@ import {
SearchFilter,
SearchFilters,
SearchQueryFields,
ArrayOperator,
SearchFilterOperator,
SortType,
FieldConstraints,
@ -14,11 +15,13 @@ import {
EmptyFilterOption,
SearchResponse,
Table,
BasicOperator,
RangeOperator,
} from "@budibase/types"
import dayjs from "dayjs"
import { OperatorOptions, SqlNumberTypeRangeMap } from "./constants"
import { deepGet, schema } from "./helpers"
import { isPlainObject, isEmpty, isArray } from "lodash"
import { isPlainObject, isEmpty } from "lodash"
const HBS_REGEX = /{{([^{].*?)}}/g
@ -327,13 +330,7 @@ export const buildQuery = (filter: SearchFilter[]) => {
// this we convert them to arrays at the controller level so that nothing below
// this has to worry about the non-array values.
export function fixupFilterArrays(filters: SearchFilters) {
const arrayFields = [
SearchFilterOperator.ONE_OF,
SearchFilterOperator.CONTAINS,
SearchFilterOperator.NOT_CONTAINS,
SearchFilterOperator.CONTAINS_ANY,
]
for (const searchField of arrayFields) {
for (const searchField of Object.values(ArrayOperator)) {
const field = filters[searchField]
if (field == null || !isPlainObject(field)) {
continue
@ -341,10 +338,12 @@ export function fixupFilterArrays(filters: SearchFilters) {
for (const key of Object.keys(field)) {
if (!Array.isArray(field[key])) {
if (typeof field[key] !== "string") {
field[key] = [field[key]]
if (typeof field[key] === "string") {
field[key] = (field[key] as string)
.split(",")
.map((x: string) => x.trim())
} else {
field[key] = field[key].split(",").map((x: string) => x.trim())
field[key] = [field[key]]
}
}
}
@ -412,7 +411,7 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
}
const stringMatch = match(
SearchFilterOperator.STRING,
BasicOperator.STRING,
(docValue: any, testValue: any) => {
if (!(typeof docValue === "string")) {
return false
@ -425,7 +424,7 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
)
const fuzzyMatch = match(
SearchFilterOperator.FUZZY,
BasicOperator.FUZZY,
(docValue: any, testValue: any) => {
if (!(typeof docValue === "string")) {
return false
@ -438,7 +437,7 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
)
const rangeMatch = match(
SearchFilterOperator.RANGE,
RangeOperator.RANGE,
(docValue: any, testValue: any) => {
if (docValue == null || docValue === "") {
return false
@ -527,11 +526,8 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
(...args: T): boolean =>
!f(...args)
const equalMatch = match(SearchFilterOperator.EQUAL, _valueMatches)
const notEqualMatch = match(
SearchFilterOperator.NOT_EQUAL,
not(_valueMatches)
)
const equalMatch = match(BasicOperator.EQUAL, _valueMatches)
const notEqualMatch = match(BasicOperator.NOT_EQUAL, not(_valueMatches))
const _empty = (docValue: any) => {
if (typeof docValue === "string") {
@ -546,12 +542,10 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
return docValue == null
}
const emptyMatch = match(SearchFilterOperator.EMPTY, _empty)
const notEmptyMatch = match(SearchFilterOperator.NOT_EMPTY, not(_empty))
const emptyMatch = match(BasicOperator.EMPTY, _empty)
const notEmptyMatch = match(BasicOperator.NOT_EMPTY, not(_empty))
const oneOf = match(
SearchFilterOperator.ONE_OF,
(docValue: any, testValue: any) => {
const oneOf = match(ArrayOperator.ONE_OF, (docValue: any, testValue: any) => {
if (typeof testValue === "string") {
testValue = testValue.split(",")
}
@ -565,8 +559,7 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
}
return testValue.some(item => _valueMatches(docValue, item))
}
)
})
const _contains =
(f: "some" | "every") => (docValue: any, testValue: any) => {
@ -593,7 +586,7 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
}
const contains = match(
SearchFilterOperator.CONTAINS,
ArrayOperator.CONTAINS,
(docValue: any, testValue: any) => {
if (Array.isArray(testValue) && testValue.length === 0) {
return true
@ -602,7 +595,7 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
}
)
const notContains = match(
SearchFilterOperator.NOT_CONTAINS,
ArrayOperator.NOT_CONTAINS,
(docValue: any, testValue: any) => {
// Not sure if this is logically correct, but at the time this code was
// written the search endpoint behaved this way and we wanted to make this
@ -613,10 +606,7 @@ export const runQuery = (docs: Record<string, any>[], query: SearchFilters) => {
return not(_contains("every"))(docValue, testValue)
}
)
const containsAny = match(
SearchFilterOperator.CONTAINS_ANY,
_contains("some")
)
const containsAny = match(ArrayOperator.CONTAINS_ANY, _contains("some"))
const docMatch = (doc: Record<string, any>) => {
const filterFunctions = {

40
packages/types/src/sdk/search.ts
View File

@ -3,20 +3,28 @@ import { Row, Table, DocumentType } from "../documents"
import { SortOrder, SortType } from "../api"
import { Knex } from "knex"
export enum SearchFilterOperator {
STRING = "string",
FUZZY = "fuzzy",
RANGE = "range",
export enum BasicOperator {
EQUAL = "equal",
NOT_EQUAL = "notEqual",
EMPTY = "empty",
NOT_EMPTY = "notEmpty",
ONE_OF = "oneOf",
FUZZY = "fuzzy",
STRING = "string",
}
export enum ArrayOperator {
CONTAINS = "contains",
NOT_CONTAINS = "notContains",
CONTAINS_ANY = "containsAny",
ONE_OF = "oneOf",
}
export enum RangeOperator {
RANGE = "range",
}
export type SearchFilterOperator = BasicOperator | ArrayOperator | RangeOperator
export enum InternalSearchFilterOperator {
COMPLEX_ID_OPERATOR = "_complexIdOperator",
}
@ -52,17 +60,17 @@ export interface SearchFilters {
// allows just fuzzy to be or - all the fuzzy/like parameters
fuzzyOr?: boolean
onEmptyFilter?: EmptyFilterOption
[SearchFilterOperator.STRING]?: BasicFilter<string>
[SearchFilterOperator.FUZZY]?: BasicFilter<string>
[SearchFilterOperator.RANGE]?: RangeFilter
[SearchFilterOperator.EQUAL]?: BasicFilter
[SearchFilterOperator.NOT_EQUAL]?: BasicFilter
[SearchFilterOperator.EMPTY]?: BasicFilter
[SearchFilterOperator.NOT_EMPTY]?: BasicFilter
[SearchFilterOperator.ONE_OF]?: ArrayFilter
[SearchFilterOperator.CONTAINS]?: ArrayFilter
[SearchFilterOperator.NOT_CONTAINS]?: ArrayFilter
[SearchFilterOperator.CONTAINS_ANY]?: ArrayFilter
[BasicOperator.STRING]?: BasicFilter<string>
[BasicOperator.FUZZY]?: BasicFilter<string>
[RangeOperator.RANGE]?: RangeFilter
[BasicOperator.EQUAL]?: BasicFilter
[BasicOperator.NOT_EQUAL]?: BasicFilter
[BasicOperator.EMPTY]?: BasicFilter
[BasicOperator.NOT_EMPTY]?: BasicFilter
[ArrayOperator.ONE_OF]?: ArrayFilter
[ArrayOperator.CONTAINS]?: ArrayFilter
[ArrayOperator.NOT_CONTAINS]?: ArrayFilter
[ArrayOperator.CONTAINS_ANY]?: ArrayFilter
// specific to SQS/SQLite search on internal tables this can be used
// to make sure the documents returned are always filtered down to a
// specific document type (such as just rows)