@budibase/worker 2.11.32 → 2.11.34

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@budibase/worker",
   "email": "hi@budibase.com",
-  "version": "2.11.32",
+  "version": "2.11.34",
   "description": "Budibase background service",
   "main": "src/index.ts",
   "repository": {
@@ -38,10 +38,10 @@
   "author": "Budibase",
   "license": "GPL-3.0",
   "dependencies": {
-    "@budibase/backend-core": "2.11.32",
-    "@budibase/pro": "2.11.32",
-    "@budibase/string-templates": "2.11.32",
-    "@budibase/types": "2.11.32",
+    "@budibase/backend-core": "2.11.34",
+    "@budibase/pro": "2.11.34",
+    "@budibase/string-templates": "2.11.34",
+    "@budibase/types": "2.11.34",
     "@koa/router": "8.0.8",
     "@sentry/node": "6.17.7",
     "@techpass/passport-openidconnect": "0.3.2",
@@ -110,5 +110,5 @@
       }
     }
   },
-  "gitHead": "c78678f641ef364c15f56af29b9f1f77733e8e79"
+  "gitHead": "8f27e106f79c936f0f40de5b1f2dbf59c6d3b367"
 }

package/src/api/controllers/global/users.ts

@@ -197,7 +197,12 @@ export const getAppUsers = async (ctx: Ctx<SearchUsersRequest>) => {
 export const search = async (ctx: Ctx<SearchUsersRequest>) => {
   const body = ctx.request.body
 
-  if (body.paginated === false) {
+  // TODO: for now only one supported search key, string.email
+  if (body?.query && !userSdk.core.isSupportedUserSearch(body.query)) {
+    ctx.throw(501, "Can only search by string.email or equal._id")
+  }
+
+  if (body.paginate === false) {
     await getAppUsers(ctx)
   } else {
     const paginated = await userSdk.core.paginatedUsers(body)

package/src/api/routes/global/tests/users.spec.ts

@@ -544,6 +544,36 @@ describe("/api/global/users", () => {
     })
   })
 
+  describe("POST /api/global/users/search", () => {
+    it("should be able to search by email", async () => {
+      const user = await config.createUser()
+      const response = await config.api.users.searchUsers({
+        query: { string: { email: user.email } },
+      })
+      expect(response.body.data.length).toBe(1)
+      expect(response.body.data[0].email).toBe(user.email)
+    })
+
+    it("should be able to search by _id", async () => {
+      const user = await config.createUser()
+      const response = await config.api.users.searchUsers({
+        query: { equal: { _id: user._id } },
+      })
+      expect(response.body.data.length).toBe(1)
+      expect(response.body.data[0]._id).toBe(user._id)
+    })
+
+    it("should throw an error when unimplemented options used", async () => {
+      const user = await config.createUser()
+      await config.api.users.searchUsers(
+        {
+          query: { equal: { firstName: user.firstName } },
+        },
+        501
+      )
+    })
+  })
+
   describe("DELETE /api/global/users/:userId", () => {
     it("should be able to destroy a basic user", async () => {
       const user = await config.createUser()

package/src/tests/api/users.ts

@@ -4,6 +4,7 @@ import {
   InviteUsersRequest,
   User,
   CreateAdminUserRequest,
+  SearchQuery,
 } from "@budibase/types"
 import structures from "../structures"
 import { generator } from "@budibase/backend-core/tests"
@@ -133,6 +134,15 @@ export class UserAPI extends TestAPI {
       .expect(status ? status : 200)
   }
 
+  searchUsers = ({ query }: { query?: SearchQuery }, status = 200) => {
+    return this.request
+      .post("/api/global/users/search")
+      .set(this.config.defaultHeaders())
+      .send({ query })
+      .expect("Content-Type", /json/)
+      .expect(status ? status : 200)
+  }
+
   getUser = (userId: string, opts?: TestAPIOpts) => {
     return this.request
       .get(`/api/global/users/${userId}`)