server/tests/api/users/users-verification.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import * as chai from 'chai'
   4 import 'mocha'
   5 import {
   6   cleanupTests,
   7   flushAndRunServer,
   8   getMyUserInformation,
   9   getUserInformation,
  10   login,
  11   registerUser,
  12   ServerInfo,
  13   updateCustomSubConfig,
  14   updateMyUser,
  15   userLogin,
  16   verifyEmail
  17 } from '../../../../shared/extra-utils'
  18 import { setAccessTokensToServers } from '../../../../shared/extra-utils/users/login'
  19 import { MockSmtpServer } from '../../../../shared/extra-utils/miscs/email'
  20 import { waitJobs } from '../../../../shared/extra-utils/server/jobs'
  21 import { User } from '../../../../shared/models/users'
  22
  23 const expect = chai.expect
  24
  25 describe('Test users account verification', function () {
  26   let server: ServerInfo
  27   let userId: number
  28   let userAccessToken: string
  29   let verificationString: string
  30   let expectedEmailsLength = 0
  31   const user1 = {
  32     username: 'user_1',
  33     password: 'super password'
  34   }
  35   const user2 = {
  36     username: 'user_2',
  37     password: 'super password'
  38   }
  39   const emails: object[] = []
  40
  41   before(async function () {
  42     this.timeout(30000)
  43
  44     const port = await MockSmtpServer.Instance.collectEmails(emails)
  45
  46     const overrideConfig = {
  47       smtp: {
  48         hostname: 'localhost',
  49         port
  50       }
  51     }
  52     server = await flushAndRunServer(1, overrideConfig)
  53
  54     await setAccessTokensToServers([ server ])
  55   })
  56
  57   it('Should register user and send verification email if verification required', async function () {
  58     this.timeout(30000)
  59
  60     await updateCustomSubConfig(server.url, server.accessToken, {
  61       signup: {
  62         enabled: true,
  63         requiresEmailVerification: true,
  64         limit: 10
  65       }
  66     })
  67
  68     await registerUser(server.url, user1.username, user1.password)
  69
  70     await waitJobs(server)
  71     expectedEmailsLength++
  72     expect(emails).to.have.lengthOf(expectedEmailsLength)
  73
  74     const email = emails[expectedEmailsLength - 1]
  75
  76     const verificationStringMatches = /verificationString=([a-z0-9]+)/.exec(email['text'])
  77     expect(verificationStringMatches).not.to.be.null
  78
  79     verificationString = verificationStringMatches[1]
  80     expect(verificationString).to.have.length.above(2)
  81
  82     const userIdMatches = /userId=([0-9]+)/.exec(email['text'])
  83     expect(userIdMatches).not.to.be.null
  84
  85     userId = parseInt(userIdMatches[1], 10)
  86
  87     const resUserInfo = await getUserInformation(server.url, server.accessToken, userId)
  88     expect(resUserInfo.body.emailVerified).to.be.false
  89   })
  90
  91   it('Should not allow login for user with unverified email', async function () {
  92     const resLogin = await login(server.url, server.client, user1, 400)
  93     expect(resLogin.body.error).to.contain('User email is not verified.')
  94   })
  95
  96   it('Should verify the user via email and allow login', async function () {
  97     await verifyEmail(server.url, userId, verificationString)
  98
  99     const res = await login(server.url, server.client, user1)
 100     userAccessToken = res.body.access_token
 101
 102     const resUserVerified = await getUserInformation(server.url, server.accessToken, userId)
 103     expect(resUserVerified.body.emailVerified).to.be.true
 104   })
 105
 106   it('Should be able to change the user email', async function () {
 107     this.timeout(10000)
 108
 109     let updateVerificationString: string
 110
 111     {
 112       await updateMyUser({
 113         url: server.url,
 114         accessToken: userAccessToken,
 115         email: 'updated@example.com',
 116         currentPassword: user1.password
 117       })
 118
 119       await waitJobs(server)
 120       expectedEmailsLength++
 121       expect(emails).to.have.lengthOf(expectedEmailsLength)
 122
 123       const email = emails[expectedEmailsLength - 1]
 124
 125       const verificationStringMatches = /verificationString=([a-z0-9]+)/.exec(email['text'])
 126       updateVerificationString = verificationStringMatches[1]
 127     }
 128
 129     {
 130       const res = await getMyUserInformation(server.url, userAccessToken)
 131       const me: User = res.body
 132
 133       expect(me.email).to.equal('user_1@example.com')
 134       expect(me.pendingEmail).to.equal('updated@example.com')
 135     }
 136
 137     {
 138       await verifyEmail(server.url, userId, updateVerificationString, true)
 139
 140       const res = await getMyUserInformation(server.url, userAccessToken)
 141       const me: User = res.body
 142
 143       expect(me.email).to.equal('updated@example.com')
 144       expect(me.pendingEmail).to.be.null
 145     }
 146   })
 147
 148   it('Should register user not requiring email verification if setting not enabled', async function () {
 149     this.timeout(5000)
 150     await updateCustomSubConfig(server.url, server.accessToken, {
 151       signup: {
 152         enabled: true,
 153         requiresEmailVerification: false,
 154         limit: 10
 155       }
 156     })
 157
 158     await registerUser(server.url, user2.username, user2.password)
 159
 160     await waitJobs(server)
 161     expect(emails).to.have.lengthOf(expectedEmailsLength)
 162
 163     const accessToken = await userLogin(server, user2)
 164
 165     const resMyUserInfo = await getMyUserInformation(server.url, accessToken)
 166     expect(resMyUserInfo.body.emailVerified).to.be.null
 167   })
 168
 169   it('Should allow login for user with unverified email when setting later enabled', async function () {
 170     await updateCustomSubConfig(server.url, server.accessToken, {
 171       signup: {
 172         enabled: true,
 173         requiresEmailVerification: true,
 174         limit: 10
 175       }
 176     })
 177
 178     await userLogin(server, user2)
 179   })
 180
 181   after(async function () {
 182     MockSmtpServer.Instance.kill()
 183
 184     await cleanupTests([ server ])
 185   })
 186 })