Adding support for oneOf ID search of users, today the relationship picker attempts to use this for the users table, but it was not supported.
This commit is contained in:
parent
89e081271f
commit
8c326b501b
|
@ -14,16 +14,16 @@ import {
|
||||||
} from "../db"
|
} from "../db"
|
||||||
import {
|
import {
|
||||||
BulkDocsResponse,
|
BulkDocsResponse,
|
||||||
|
ContextUser,
|
||||||
|
CouchFindOptions,
|
||||||
|
DatabaseQueryOpts,
|
||||||
SearchQuery,
|
SearchQuery,
|
||||||
SearchQueryOperators,
|
SearchQueryOperators,
|
||||||
SearchUsersRequest,
|
SearchUsersRequest,
|
||||||
User,
|
User,
|
||||||
ContextUser,
|
|
||||||
DatabaseQueryOpts,
|
|
||||||
CouchFindOptions,
|
|
||||||
} from "@budibase/types"
|
} from "@budibase/types"
|
||||||
import { getGlobalDB } from "../context"
|
|
||||||
import * as context from "../context"
|
import * as context from "../context"
|
||||||
|
import { getGlobalDB } from "../context"
|
||||||
import { isCreator } from "./utils"
|
import { isCreator } from "./utils"
|
||||||
import { UserDB } from "./db"
|
import { UserDB } from "./db"
|
||||||
|
|
||||||
|
@ -48,6 +48,7 @@ export function isSupportedUserSearch(query: SearchQuery) {
|
||||||
const allowed = [
|
const allowed = [
|
||||||
{ op: SearchQueryOperators.STRING, key: "email" },
|
{ op: SearchQueryOperators.STRING, key: "email" },
|
||||||
{ op: SearchQueryOperators.EQUAL, key: "_id" },
|
{ op: SearchQueryOperators.EQUAL, key: "_id" },
|
||||||
|
{ op: SearchQueryOperators.ONE_OF, key: "_id" },
|
||||||
]
|
]
|
||||||
for (let [key, operation] of Object.entries(query)) {
|
for (let [key, operation] of Object.entries(query)) {
|
||||||
if (typeof operation !== "object") {
|
if (typeof operation !== "object") {
|
||||||
|
@ -285,6 +286,10 @@ export async function paginatedUsers({
|
||||||
} else if (query?.string?.email) {
|
} else if (query?.string?.email) {
|
||||||
userList = await searchGlobalUsersByEmail(query?.string?.email, opts)
|
userList = await searchGlobalUsersByEmail(query?.string?.email, opts)
|
||||||
property = "email"
|
property = "email"
|
||||||
|
} else if (query?.oneOf?._id) {
|
||||||
|
userList = await bulkGetGlobalUsersById(query?.oneOf?._id, {
|
||||||
|
cleanup: true,
|
||||||
|
})
|
||||||
} else {
|
} else {
|
||||||
// no search, query allDocs
|
// no search, query allDocs
|
||||||
const response = await db.allDocs(getGlobalUserParams(null, opts))
|
const response = await db.allDocs(getGlobalUserParams(null, opts))
|
||||||
|
|
|
@ -229,7 +229,7 @@ export const search = async (ctx: Ctx<SearchUsersRequest>) => {
|
||||||
}
|
}
|
||||||
// Validate we aren't trying to search on any illegal fields
|
// Validate we aren't trying to search on any illegal fields
|
||||||
if (!userSdk.core.isSupportedUserSearch(body.query)) {
|
if (!userSdk.core.isSupportedUserSearch(body.query)) {
|
||||||
ctx.throw(400, "Can only search by string.email or equal._id")
|
ctx.throw(400, "Can only search by string.email, equal._id or oneOf._id")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -649,6 +649,24 @@ describe("/api/global/users", () => {
|
||||||
expect(response.body.data[0]._id).toBe(user._id)
|
expect(response.body.data[0]._id).toBe(user._id)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it("should be able to search by oneOf _id", async () => {
|
||||||
|
const [user, user2, user3] = await Promise.all([
|
||||||
|
config.createUser(),
|
||||||
|
config.createUser(),
|
||||||
|
config.createUser(),
|
||||||
|
])
|
||||||
|
const response = await config.api.users.searchUsers({
|
||||||
|
query: { oneOf: { _id: [user._id, user2._id] } },
|
||||||
|
})
|
||||||
|
expect(response.body.data.length).toBe(2)
|
||||||
|
const foundUserIds = response.body.data.map((user: User) => user._id)
|
||||||
|
expect(foundUserIds).toContain(user._id)
|
||||||
|
expect(foundUserIds).toContain(user2._id)
|
||||||
|
expect(
|
||||||
|
response.body.data.find((user: User) => user._id === user3._id)
|
||||||
|
).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
it("should be able to search by _id with numeric prefixing", async () => {
|
it("should be able to search by _id with numeric prefixing", async () => {
|
||||||
const user = await config.createUser()
|
const user = await config.createUser()
|
||||||
const response = await config.api.users.searchUsers({
|
const response = await config.api.users.searchUsers({
|
||||||
|
|
Loading…
Reference in New Issue