Merge pull request #13094 from Budibase/fix-flaky-user-test

Fix flaky user test

packages/server/src/sdk/users/tests/utils.spec.ts

@@ -84,7 +84,8 @@ describe("syncGlobalUsers", () => {
         await syncGlobalUsers()
 
         const metadata = await rawUserMetadata()
-        expect(metadata).toHaveLength(2)
+
+        expect(metadata).toHaveLength(2 + 1) // ADMIN user created in test bootstrap still in the application
         expect(metadata).toContainEqual(
           expect.objectContaining({
             _id: db.generateUserMetadataID(user1._id!),
@@ -121,7 +122,7 @@ describe("syncGlobalUsers", () => {
         await syncGlobalUsers()
 
         const metadata = await rawUserMetadata()
-        expect(metadata).toHaveLength(1) //ADMIN user created in test bootstrap still in the application
+        expect(metadata).toHaveLength(1) // ADMIN user created in test bootstrap still in the application
       })
     })
   })

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

@@ -76,14 +76,6 @@ mocks.licenses.useUnlimited()
 
 dbInit()
 
-type DefaultUserValues = {
-  globalUserId: string
-  email: string
-  firstName: string
-  lastName: string
-  csrfToken: string
-}
-
 export interface TableToBuild extends Omit<Table, "sourceId" | "sourceType"> {
   sourceId?: string
   sourceType?: TableSourceType
@@ -99,14 +91,17 @@ export default class TestConfiguration {
   prodApp: any
   prodAppId: any
   user: any
-  globalUserId: any
   userMetadataId: any
   table?: Table
   automation: any
   datasource?: Datasource
   tenantId?: string
-  defaultUserValues: DefaultUserValues
   api: API
+  csrfToken?: string
+
+  private get globalUserId() {
+    return this.user._id
+  }
 
   constructor(openServer = true) {
     if (openServer) {
@@ -121,21 +116,10 @@ export default class TestConfiguration {
     }
     this.appId = null
     this.allApps = []
-    this.defaultUserValues = this.populateDefaultUserValues()
 
     this.api = new API(this)
   }
 
-  populateDefaultUserValues(): DefaultUserValues {
-    return {
-      globalUserId: `us_${newid()}`,
-      email: generator.email(),
-      firstName: generator.first(),
-      lastName: generator.last(),
-      csrfToken: generator.hash(),
-    }
-  }
-
   getRequest() {
     return this.request
   }
@@ -162,10 +146,10 @@ export default class TestConfiguration {
 
   getUserDetails() {
     return {
-      globalId: this.defaultUserValues.globalUserId,
+      globalId: this.globalUserId,
-      email: this.defaultUserValues.email,
+      email: this.user.email,
-      firstName: this.defaultUserValues.firstName,
+      firstName: this.user.firstName,
-      lastName: this.defaultUserValues.lastName,
+      lastName: this.user.lastName,
     }
   }
 
@@ -300,15 +284,27 @@ export default class TestConfiguration {
   }
 
   // USER / AUTH
-  async globalUser({
+  async globalUser(
-    id = this.defaultUserValues.globalUserId,
+    config: {
-    firstName = this.defaultUserValues.firstName,
+      id?: string
-    lastName = this.defaultUserValues.lastName,
+      firstName?: string
-    builder = true,
+      lastName?: string
-    admin = false,
+      builder?: boolean
-    email = this.defaultUserValues.email,
+      admin?: boolean
-    roles,
+      email?: string
-  }: any = {}): Promise<User> {
+      roles?: any
+    } = {}
+  ): Promise<User> {
+    const {
+      id = `us_${newid()}`,
+      firstName = generator.first(),
+      lastName = generator.last(),
+      builder = true,
+      admin = false,
+      email = generator.email(),
+      roles,
+    } = config
+
     const db = tenancy.getTenantDB(this.getTenantId())
     let existing
     try {
@@ -327,7 +323,7 @@ export default class TestConfiguration {
     await sessions.createASession(id, {
       sessionId: "sessionid",
       tenantId: this.getTenantId(),
-      csrfToken: this.defaultUserValues.csrfToken,
+      csrfToken: this.csrfToken,
     })
     if (builder) {
       user.builder = { global: true }
@@ -358,9 +354,9 @@ export default class TestConfiguration {
     } = {}
   ): Promise<User> {
     let { id, firstName, lastName, email, builder, admin, roles } = user
-    firstName = firstName || this.defaultUserValues.firstName
+    ;(firstName = firstName || generator.first()),
-    lastName = lastName || this.defaultUserValues.lastName
+      (lastName = lastName || generator.last()),
-    email = email || this.defaultUserValues.email
+      (email = email || generator.email())
     roles = roles || {}
     if (builder == null) {
       builder = true
@@ -448,7 +444,7 @@ export default class TestConfiguration {
   defaultHeaders(extras = {}, prodApp = false) {
     const tenantId = this.getTenantId()
     const authObj: AuthToken = {
-      userId: this.defaultUserValues.globalUserId,
+      userId: this.globalUserId,
       sessionId: "sessionid",
       tenantId,
     }
@@ -457,7 +453,7 @@ export default class TestConfiguration {
     const headers: any = {
       Accept: "application/json",
       Cookie: [`${constants.Cookie.Auth}=${authToken}`],
-      [constants.Header.CSRF_TOKEN]: this.defaultUserValues.csrfToken,
+      [constants.Header.CSRF_TOKEN]: this.csrfToken,
       Host: this.tenantHost(),
       ...extras,
     }
@@ -487,7 +483,7 @@ export default class TestConfiguration {
 
   async basicRoleHeaders() {
     return await this.roleHeaders({
-      email: this.defaultUserValues.email,
+      email: generator.email(),
       builder: false,
       prodApp: true,
       roleId: roles.BUILTIN_ROLE_IDS.BASIC,
@@ -495,7 +491,7 @@ export default class TestConfiguration {
   }
 
   async roleHeaders({
-    email = this.defaultUserValues.email,
+    email = generator.email(),
     roleId = roles.BUILTIN_ROLE_IDS.ADMIN,
     builder = false,
     prodApp = true,
@@ -519,11 +515,12 @@ export default class TestConfiguration {
   }
 
   async newTenant(appName = newid()): Promise<App> {
-    this.defaultUserValues = this.populateDefaultUserValues()
+    this.csrfToken = generator.hash()
+
     this.tenantId = structures.tenant.id()
     this.user = await this.globalUser()
-    this.globalUserId = this.user._id
+    this.userMetadataId = generateUserMetadataID(this.user._id)
-    this.userMetadataId = generateUserMetadataID(this.globalUserId)
+
     return this.createApp(appName)
   }
 
@@ -533,7 +530,7 @@ export default class TestConfiguration {
 
   // API
 
-  async generateApiKey(userId = this.defaultUserValues.globalUserId) {
+  async generateApiKey(userId = this.user._id) {
     const db = tenancy.getTenantDB(this.getTenantId())
     const id = dbCore.generateDevInfoID(userId)
     let devInfo: any