Convert user.spec.js to user.spec.ts

packages/server/src/api/controllers/row/internal.ts

@@ -2,7 +2,6 @@ import * as linkRows from "../../../db/linkedRows"
 import {
   generateRowID,
   getMultiIDParams,
-  getTableIDFromRowID,
   InternalTables,
 } from "../../../db/utils"
 import * as userController from "../user"
@@ -89,7 +88,7 @@ export async function patch(ctx: UserCtx<PatchRowRequest, PatchRowResponse>) {
   if (isUserTable) {
     // the row has been updated, need to put it into the ctx
     ctx.request.body = row as any
-    await userController.updateMetadata(ctx)
+    await userController.updateMetadata(ctx as any)
     return { row: ctx.body as Row, table }
   }
 

packages/server/src/api/controllers/user.ts

@@ -1,14 +1,26 @@
 import { generateUserFlagID, InternalTables } from "../../db/utils"
 import { getFullUser } from "../../utilities/users"
 import { context } from "@budibase/backend-core"
-import { Ctx, FetchUserMetadataResponse, UserCtx } from "@budibase/types"
+import {
+  ContextUserMetadata,
+  Ctx,
+  FetchUserMetadataResponse,
+  FindUserMetadataResponse,
+  Flags,
+  SetFlagRequest,
+  UserCtx,
+  UserMetadata,
+} from "@budibase/types"
 import sdk from "../../sdk"
+import { DocumentInsertResponse } from "@budibase/nano"
 
-export async function fetchMetadata(ctx: Ctx<null, FetchUserMetadataResponse>) {
+export async function fetchMetadata(ctx: Ctx<void, FetchUserMetadataResponse>) {
   ctx.body = await sdk.users.fetchMetadata()
 }
 
-export async function updateSelfMetadata(ctx: UserCtx) {
+export async function updateSelfMetadata(
+  ctx: UserCtx<UserMetadata, DocumentInsertResponse>
+) {
   // overwrite the ID with current users
   ctx.request.body._id = ctx.user?._id
   // make sure no stale rev
@@ -18,19 +30,21 @@ export async function updateSelfMetadata(ctx: UserCtx) {
   await updateMetadata(ctx)
 }
 
-export async function updateMetadata(ctx: UserCtx) {
+export async function updateMetadata(
+  ctx: UserCtx<UserMetadata, DocumentInsertResponse>
+) {
   const db = context.getAppDB()
   const user = ctx.request.body
-  // this isn't applicable to the user
+  const metadata: ContextUserMetadata = {
-  delete user.roles
-  const metadata = {
     tableId: InternalTables.USER_METADATA,
     ...user,
   }
+  // this isn't applicable to the user
+  delete metadata.roles
   ctx.body = await db.put(metadata)
 }
 
-export async function destroyMetadata(ctx: UserCtx) {
+export async function destroyMetadata(ctx: UserCtx<void, { message: string }>) {
   const db = context.getAppDB()
   try {
     const dbUser = await sdk.users.get(ctx.params.id)
@@ -43,11 +57,15 @@ export async function destroyMetadata(ctx: UserCtx) {
   }
 }
 
-export async function findMetadata(ctx: UserCtx) {
+export async function findMetadata(
+  ctx: UserCtx<void, FindUserMetadataResponse>
+) {
   ctx.body = await getFullUser(ctx.params.id)
 }
 
-export async function setFlag(ctx: UserCtx) {
+export async function setFlag(
+  ctx: UserCtx<SetFlagRequest, { message: string }>
+) {
   const userId = ctx.user?._id
   const { flag, value } = ctx.request.body
   if (!flag) {
@@ -55,9 +73,9 @@ export async function setFlag(ctx: UserCtx) {
   }
   const flagDocId = generateUserFlagID(userId!)
   const db = context.getAppDB()
-  let doc
+  let doc: Flags
   try {
-    doc = await db.get<any>(flagDocId)
+    doc = await db.get<Flags>(flagDocId)
   } catch (err) {
     doc = { _id: flagDocId }
   }
@@ -66,13 +84,13 @@ export async function setFlag(ctx: UserCtx) {
   ctx.body = { message: "Flag set successfully" }
 }
 
-export async function getFlags(ctx: UserCtx) {
+export async function getFlags(ctx: UserCtx<void, Flags>) {
   const userId = ctx.user?._id
   const docId = generateUserFlagID(userId!)
   const db = context.getAppDB()
-  let doc
+  let doc: Flags
   try {
-    doc = await db.get(docId)
+    doc = await db.get<Flags>(docId)
   } catch (err) {
     doc = { _id: docId }
   }

packages/server/src/api/routes/tests/user.spec.ts

@@ -1,6 +1,7 @@
 import { roles, utils } from "@budibase/backend-core"
 import { checkPermissionsEndpoint } from "./utilities/TestFunctions"
 import * as setup from "./utilities"
+import { UserMetadata } from "@budibase/types"
 
 jest.setTimeout(30000)
 
@@ -28,15 +29,13 @@ describe("/users", () => {
     it("returns a list of users from an instance db", async () => {
       await config.createUser({ id: "uuidx" })
       await config.createUser({ id: "uuidy" })
-      const res = await request
-        .get(`/api/users/metadata`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
 
-      expect(res.body.length).toBe(3)
+      const res = await config.api.user.fetch()
-      expect(res.body.find(u => u._id === `ro_ta_users_us_uuidx`)).toBeDefined()
+      expect(res.length).toBe(3)
-      expect(res.body.find(u => u._id === `ro_ta_users_us_uuidy`)).toBeDefined()
+
+      const ids = res.map(u => u._id)
+      expect(ids).toContain(`ro_ta_users_us_uuidx`)
+      expect(ids).toContain(`ro_ta_users_us_uuidy`)
     })
 
     it("should apply authorization to endpoint", async () => {
@@ -54,86 +53,61 @@ describe("/users", () => {
 
   describe("update", () => {
     it("should be able to update the user", async () => {
-      const user = await config.createUser({ id: `us_update${utils.newid()}` })
+      const user: UserMetadata = await config.createUser({
+        id: `us_update${utils.newid()}`,
+      })
       user.roleId = roles.BUILTIN_ROLE_IDS.BASIC
       delete user._rev
-      const res = await request
+      const res = await config.api.user.update(user)
-        .put(`/api/users/metadata`)
+      expect(res.ok).toEqual(true)
-        .set(config.defaultHeaders())
-        .send(user)
-        .expect(200)
-        .expect("Content-Type", /json/)
-      expect(res.body.ok).toEqual(true)
     })
 
     it("should be able to update the user multiple times", async () => {
       const user = await config.createUser()
       delete user._rev
 
-      const res1 = await request
+      const res1 = await config.api.user.update({
-        .put(`/api/users/metadata`)
+        ...user,
-        .set(config.defaultHeaders())
+        roleId: roles.BUILTIN_ROLE_IDS.BASIC,
-        .send({ ...user, roleId: roles.BUILTIN_ROLE_IDS.BASIC })
+      })
-        .expect(200)
+      const res2 = await config.api.user.update({
-        .expect("Content-Type", /json/)
+        ...user,
-
+        _rev: res1.rev,
-      const res = await request
+        roleId: roles.BUILTIN_ROLE_IDS.POWER,
-        .put(`/api/users/metadata`)
+      })
-        .set(config.defaultHeaders())
+      expect(res2.ok).toEqual(true)
-        .send({
-          ...user,
-          _rev: res1.body.rev,
-          roleId: roles.BUILTIN_ROLE_IDS.POWER,
-        })
-        .expect(200)
-        .expect("Content-Type", /json/)
-
-      expect(res.body.ok).toEqual(true)
     })
 
     it("should require the _rev field for multiple updates", async () => {
       const user = await config.createUser()
       delete user._rev
 
-      await request
+      await config.api.user.update({
-        .put(`/api/users/metadata`)
+        ...user,
-        .set(config.defaultHeaders())
+        roleId: roles.BUILTIN_ROLE_IDS.BASIC,
-        .send({ ...user, roleId: roles.BUILTIN_ROLE_IDS.BASIC })
+      })
-        .expect(200)
+      await config.api.user.update(
-        .expect("Content-Type", /json/)
+        { ...user, roleId: roles.BUILTIN_ROLE_IDS.POWER },
-
+        { expectStatus: 409 }
-      await request
+      )
-        .put(`/api/users/metadata`)
-        .set(config.defaultHeaders())
-        .send({ ...user, roleId: roles.BUILTIN_ROLE_IDS.POWER })
-        .expect(409)
-        .expect("Content-Type", /json/)
     })
   })
 
   describe("destroy", () => {
     it("should be able to delete the user", async () => {
       const user = await config.createUser()
-      const res = await request
+      const res = await config.api.user.destroy(user._id!)
-        .delete(`/api/users/metadata/${user._id}`)
+      expect(res.message).toBeDefined()
-        .set(config.defaultHeaders())
-        .expect(200)
-        .expect("Content-Type", /json/)
-      expect(res.body.message).toBeDefined()
     })
   })
 
   describe("find", () => {
     it("should be able to find the user", async () => {
       const user = await config.createUser()
-      const res = await request
+      const res = await config.api.user.find(user._id!)
-        .get(`/api/users/metadata/${user._id}`)
+      expect(res._id).toEqual(user._id)
-        .set(config.defaultHeaders())
+      expect(res.roleId).toEqual(roles.BUILTIN_ROLE_IDS.ADMIN)
-        .expect(200)
+      expect(res.tableId).toBeDefined()
-        .expect("Content-Type", /json/)
-      expect(res.body._id).toEqual(user._id)
-      expect(res.body.roleId).toEqual(roles.BUILTIN_ROLE_IDS.ADMIN)
-      expect(res.body.tableId).toBeDefined()
     })
   })
 
@@ -153,59 +127,18 @@ describe("/users", () => {
 
     it("should be able to set a flag on the user", async () => {
       await config.createUser()
-      const res = await request
+      const res = await config.api.user.setFlag("test", true)
-        .post(`/api/users/flags`)
+      expect(res.message).toEqual("Flag set successfully")
-        .set(config.defaultHeaders())
-        .send({ value: "test", flag: "test" })
-        .expect(200)
-        .expect("Content-Type", /json/)
-      expect(res.body.message).toEqual("Flag set successfully")
     })
   })
 
   describe("getFlags", () => {
     it("should get flags for a specific user", async () => {
-      let flagData = { value: "test", flag: "test" }
       await config.createUser()
-      await request
+      await config.api.user.setFlag("test", "test")
-        .post(`/api/users/flags`)
-        .set(config.defaultHeaders())
-        .send(flagData)
-        .expect(200)
-        .expect("Content-Type", /json/)
 
-      const res = await request
+      const res = await config.api.user.getFlags()
-        .get(`/api/users/flags`)
+      expect(res.test).toEqual("test")
-        .set(config.defaultHeaders())
-        .expect(200)
-        .expect("Content-Type", /json/)
-      expect(res.body[flagData.value]).toEqual(flagData.flag)
-    })
-  })
-
-  describe("setFlag", () => {
-    it("should throw an error if a flag is not provided", async () => {
-      await config.createUser()
-      const res = await request
-        .post(`/api/users/flags`)
-        .set(config.defaultHeaders())
-        .send({ value: "test" })
-        .expect(400)
-        .expect("Content-Type", /json/)
-      expect(res.body.message).toEqual(
-        "Must supply a 'flag' field in request body."
-      )
-    })
-
-    it("should be able to set a flag on the user", async () => {
-      await config.createUser()
-      const res = await request
-        .post(`/api/users/flags`)
-        .set(config.defaultHeaders())
-        .send({ value: "test", flag: "test" })
-        .expect(200)
-        .expect("Content-Type", /json/)
-      expect(res.body.message).toEqual("Flag set successfully")
     })
   })
 })

packages/server/src/tests/utilities/TestConfiguration.ts

@@ -264,7 +264,7 @@ class TestConfiguration {
     admin = false,
     email = this.defaultUserValues.email,
     roles,
-  }: any = {}) {
+  }: any = {}): Promise<User> {
     const db = tenancy.getTenantDB(this.getTenantId())
     let existing
     try {

packages/server/src/tests/utilities/api/user.ts

@@ -1,6 +1,12 @@
-import { FetchUserMetadataResponse } from "@budibase/types"
+import {
+  FetchUserMetadataResponse,
+  FindUserMetadataResponse,
+  Flags,
+  UserMetadata,
+} from "@budibase/types"
 import TestConfiguration from "../TestConfiguration"
 import { TestAPI } from "./base"
+import { DocumentInsertResponse } from "@budibase/nano"
 
 export class UserAPI extends TestAPI {
   constructor(config: TestConfiguration) {
@@ -26,10 +32,10 @@ export class UserAPI extends TestAPI {
     return res.body
   }
 
-  get = async (
+  find = async (
     id: string,
     { expectStatus } = { expectStatus: 200 }
-  ): Promise<GetUserMetadataResponse> => {
+  ): Promise<FindUserMetadataResponse> => {
     const res = await this.request
       .get(`/api/users/metadata/${id}`)
       .set(this.config.defaultHeaders())
@@ -45,4 +51,107 @@ export class UserAPI extends TestAPI {
 
     return res.body
   }
+
+  update = async (
+    user: UserMetadata,
+    { expectStatus } = { expectStatus: 200 }
+  ): Promise<DocumentInsertResponse> => {
+    const res = await this.request
+      .put(`/api/users/metadata`)
+      .set(this.config.defaultHeaders())
+      .send(user)
+      .expect("Content-Type", /json/)
+
+    if (res.status !== expectStatus) {
+      throw new Error(
+        `Expected status ${expectStatus} but got ${
+          res.status
+        } with body ${JSON.stringify(res.body)}`
+      )
+    }
+
+    return res.body as DocumentInsertResponse
+  }
+
+  updateSelf = async (
+    user: UserMetadata,
+    { expectStatus } = { expectStatus: 200 }
+  ): Promise<DocumentInsertResponse> => {
+    const res = await this.request
+      .post(`/api/users/metadata/self`)
+      .set(this.config.defaultHeaders())
+      .send(user)
+      .expect("Content-Type", /json/)
+
+    if (res.status !== expectStatus) {
+      throw new Error(
+        `Expected status ${expectStatus} but got ${
+          res.status
+        } with body ${JSON.stringify(res.body)}`
+      )
+    }
+
+    return res.body as DocumentInsertResponse
+  }
+
+  destroy = async (
+    id: string,
+    { expectStatus } = { expectStatus: 200 }
+  ): Promise<{ message: string }> => {
+    const res = await this.request
+      .delete(`/api/users/metadata/${id}`)
+      .set(this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+
+    if (res.status !== expectStatus) {
+      throw new Error(
+        `Expected status ${expectStatus} but got ${
+          res.status
+        } with body ${JSON.stringify(res.body)}`
+      )
+    }
+
+    return res.body as { message: string }
+  }
+
+  setFlag = async (
+    flag: string,
+    value: any,
+    { expectStatus } = { expectStatus: 200 }
+  ): Promise<{ message: string }> => {
+    const res = await this.request
+      .post(`/api/users/flags`)
+      .set(this.config.defaultHeaders())
+      .send({ flag, value })
+      .expect("Content-Type", /json/)
+
+    if (res.status !== expectStatus) {
+      throw new Error(
+        `Expected status ${expectStatus} but got ${
+          res.status
+        } with body ${JSON.stringify(res.body)}`
+      )
+    }
+
+    return res.body as { message: string }
+  }
+
+  getFlags = async (
+    { expectStatus } = { expectStatus: 200 }
+  ): Promise<Flags> => {
+    const res = await this.request
+      .get(`/api/users/flags`)
+      .set(this.config.defaultHeaders())
+      .expect("Content-Type", /json/)
+
+    if (res.status !== expectStatus) {
+      throw new Error(
+        `Expected status ${expectStatus} but got ${
+          res.status
+        } with body ${JSON.stringify(res.body)}`
+      )
+    }
+
+    return res.body as Flags
+  }
 }

packages/types/src/api/web/app/user.ts

@@ -1,3 +1,9 @@
-import { ContextUserMetadata } from "src/documents"
+import { ContextUserMetadata } from "../../../"
 
 export type FetchUserMetadataResponse = ContextUserMetadata[]
+export type FindUserMetadataResponse = ContextUserMetadata
+
+export interface SetFlagRequest {
+  flag: string
+  value: any
+}

packages/types/src/documents/account/flag.ts

@@ -0,0 +1,5 @@
+import { Document } from "../../"
+
+export interface Flags extends Document {
+  [key: string]: any
+}

packages/types/src/documents/account/index.ts

@@ -1,2 +1,3 @@
 export * from "./account"
 export * from "./user"
+export * from "./flag"