Merge pull request #14555 from Budibase/fix/logical-operators-return-none

onEmptyFilter fixes for logical operators
This commit is contained in:
Michael Drury 2024-09-11 12:20:39 +01:00 committed by GitHub
commit 868a802c9c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 83 additions and 10 deletions

View File

@ -2907,6 +2907,28 @@ describe.each([
'Invalid body - "query.$and.conditions[1].$and.conditions" is required' 'Invalid body - "query.$and.conditions[1].$and.conditions" is required'
) )
}) })
it("returns no rows when onEmptyFilter set to none", async () => {
await expectSearch({
query: {
onEmptyFilter: EmptyFilterOption.RETURN_NONE,
$and: {
conditions: [{ equal: { name: "" } }],
},
},
}).toFindNothing()
})
it("returns all rows when onEmptyFilter set to all", async () => {
await expectSearch({
query: {
onEmptyFilter: EmptyFilterOption.RETURN_ALL,
$and: {
conditions: [{ equal: { name: "" } }],
},
},
}).toHaveLength(4)
})
}) })
!isLucene && !isLucene &&
@ -3035,5 +3057,27 @@ describe.each([
}, },
}).toContainExactly([{ age: 1, name: "Jane" }]) }).toContainExactly([{ age: 1, name: "Jane" }])
}) })
it("returns no rows when onEmptyFilter set to none", async () => {
await expectSearch({
query: {
onEmptyFilter: EmptyFilterOption.RETURN_NONE,
$or: {
conditions: [{ equal: { name: "" } }],
},
},
}).toFindNothing()
})
it("returns all rows when onEmptyFilter set to all", async () => {
await expectSearch({
query: {
onEmptyFilter: EmptyFilterOption.RETURN_ALL,
$or: {
conditions: [{ equal: { name: "" } }],
},
},
}).toHaveLength(4)
})
}) })
}) })

View File

@ -27,6 +27,12 @@ import { isPlainObject, isEmpty } from "lodash"
import { decodeNonAscii } from "./helpers/schema" import { decodeNonAscii } from "./helpers/schema"
const HBS_REGEX = /{{([^{].*?)}}/g const HBS_REGEX = /{{([^{].*?)}}/g
const LOGICAL_OPERATORS = Object.values(LogicalOperator)
const SEARCH_OPERATORS = [
...Object.values(BasicOperator),
...Object.values(ArrayOperator),
...Object.values(RangeOperator),
]
/** /**
* Returns the valid operator options for a certain data type * Returns the valid operator options for a certain data type
@ -117,7 +123,7 @@ export function recurseLogicalOperators(
filters: SearchFilters, filters: SearchFilters,
fn: (f: SearchFilters) => SearchFilters fn: (f: SearchFilters) => SearchFilters
) { ) {
for (const logical of Object.values(LogicalOperator)) { for (const logical of LOGICAL_OPERATORS) {
if (filters[logical]) { if (filters[logical]) {
filters[logical]!.conditions = filters[logical]!.conditions.map( filters[logical]!.conditions = filters[logical]!.conditions.map(
condition => fn(condition) condition => fn(condition)
@ -135,7 +141,7 @@ export function recurseSearchFilters(
filters = processFn(filters) filters = processFn(filters)
// Recurse through logical operators // Recurse through logical operators
for (const logical of Object.values(LogicalOperator)) { for (const logical of LOGICAL_OPERATORS) {
if (filters[logical]) { if (filters[logical]) {
filters[logical]!.conditions = filters[logical]!.conditions.map( filters[logical]!.conditions = filters[logical]!.conditions.map(
condition => recurseSearchFilters(condition, processFn) condition => recurseSearchFilters(condition, processFn)
@ -773,12 +779,16 @@ export function runQuery<T extends Record<string, any>>(
return filterFunctions[key as SearchFilterOperator]?.(doc) ?? false return filterFunctions[key as SearchFilterOperator]?.(doc) ?? false
}) })
if (query.allOr) { // there are no filters - logical operators can cover this up
if (!hasFilters(query)) {
return true
} else if (query.allOr) {
return results.some(result => result === true) return results.some(result => result === true)
} else { } else {
return results.every(result => result === true) return results.every(result => result === true)
} }
} }
return docs.filter(docMatch) return docs.filter(docMatch)
} }
@ -841,14 +851,33 @@ export const hasFilters = (query?: SearchFilters) => {
if (!query) { if (!query) {
return false return false
} }
const skipped = ["allOr", "onEmptyFilter"] const check = (filters: SearchFilters): boolean => {
for (let [key, value] of Object.entries(query)) { for (const logical of LOGICAL_OPERATORS) {
if (skipped.includes(key) || typeof value !== "object") { if (filters[logical]) {
for (const condition of filters[logical]?.conditions || []) {
const result = check(condition)
if (result) {
return result
}
}
}
}
for (const search of SEARCH_OPERATORS) {
const searchValue = filters[search]
if (!searchValue || typeof searchValue !== "object") {
continue continue
} }
if (Object.keys(value || {}).length !== 0) { const filtered = Object.entries(searchValue).filter(entry => {
const valueDefined =
entry[1] !== undefined || entry[1] !== null || entry[1] !== ""
// not empty is an edge case, null is allowed for it - this is covered by test cases
return search === BasicOperator.NOT_EMPTY || valueDefined
})
if (filtered.length !== 0) {
return true return true
} }
} }
return false return false
}
return check(query)
} }