import jwtDecode from 'jwt-decode' import type { User } from '../../packages/payload/src/auth/index.js' import type { Payload } from '../../packages/payload/src/index.js' import { getPayload } from '../../packages/payload/src/index.js' import { devUser } from '../credentials.js' import { NextRESTClient } from '../helpers/NextRESTClient.js' import { startMemoryDB } from '../startMemoryDB.js' import configPromise from './config.js' import { namedSaveToJWTValue, saveToJWTKey, slug } from './shared.js' let restClient: NextRESTClient let payload: Payload const { email, password } = devUser describe('Auth', () => { beforeAll(async () => { const config = await startMemoryDB(configPromise) payload = await getPayload({ config }) restClient = new NextRESTClient(payload.config) }) afterAll(async () => { if (typeof payload.db.destroy === 'function') { await payload.db.destroy(payload) } }) describe('GraphQL - admin user', () => { let token let user beforeAll(async () => { const { data } = await restClient .GRAPHQL_POST({ body: JSON.stringify({ query: `mutation { loginUser(email: "${devUser.email}", password: "${devUser.password}") { token user { id email } } }`, }), }) .then((res) => res.json()) user = data.loginUser.user token = data.loginUser.token }) it('should login', async () => { expect(user.id).toBeDefined() expect(user.email).toEqual(devUser.email) expect(token).toBeDefined() }) it('should have fields saved to JWT', async () => { const decoded = jwtDecode(token) const { collection, email: jwtEmail, exp, iat, roles } = decoded expect(jwtEmail).toBeDefined() expect(collection).toEqual('users') expect(Array.isArray(roles)).toBeTruthy() expect(iat).toBeDefined() expect(exp).toBeDefined() }) }) describe('REST - admin user', () => { it('should prevent registering a new first user', async () => { const response = await restClient.POST(`/${slug}/first-register`, { body: JSON.stringify({ email, password, }), }) expect(response.status).toBe(403) }) it('should login a user successfully', async () => { const response = await restClient.POST(`/${slug}/login`, { body: JSON.stringify({ email, password, }), }) const data = await response.json() expect(response.status).toBe(200) expect(data.token).toBeDefined() }) describe('logged in', () => { let token: string | undefined let loggedInUser: User | undefined beforeAll(async () => { const response = await restClient.POST(`/${slug}/login`, { body: JSON.stringify({ email, password, }), }) const data = await response.json() token = data.token loggedInUser = data.user }) it('should allow a user to change password without returning password', async () => { const result = await payload.update({ id: loggedInUser.id, collection: slug, data: { password: 'test', }, }) expect(result.id).toStrictEqual(loggedInUser.id) expect(result.password).toBeUndefined() }) it('should return a logged in user from /me', async () => { const response = await restClient.GET(`/${slug}/me`, { headers: { Authorization: `JWT ${token}`, }, }) const data = await response.json() expect(response.status).toBe(200) expect(data.user.email).toBeDefined() }) it('should have fields saved to JWT', async () => { const decoded = jwtDecode(token) const { collection, email: jwtEmail, exp, iat, roles, [saveToJWTKey]: customJWTPropertyKey, tabLiftedSaveToJWT, unnamedTabSaveToJWTFalse, 'x-lifted-from-group': liftedFromGroup, 'x-tab-field': unnamedTabSaveToJWTString, } = decoded const group = decoded['x-group'] as Record const tab = decoded.saveToJWTTab as Record const tabString = decoded['tab-test'] as Record expect(jwtEmail).toBeDefined() expect(collection).toEqual('users') expect(collection).toEqual('users') expect(Array.isArray(roles)).toBeTruthy() // 'x-custom-jwt-property-name': 'namedSaveToJWT value' expect(customJWTPropertyKey).toEqual(namedSaveToJWTValue) expect(group).toBeDefined() expect(group['x-test']).toEqual('nested property') expect(group.saveToJWTFalse).toBeUndefined() expect(liftedFromGroup).toEqual('lifted from group') expect(tabLiftedSaveToJWT).toEqual('lifted from unnamed tab') expect(tab['x-field']).toEqual('yes') expect(tabString.includedByDefault).toEqual('yes') expect(unnamedTabSaveToJWTString).toEqual('text') expect(unnamedTabSaveToJWTFalse).toBeUndefined() expect(iat).toBeDefined() expect(exp).toBeDefined() }) it('should allow authentication with an API key with useAPIKey', async () => { const apiKey = '0123456789ABCDEFGH' const user = await payload.create({ collection: slug, data: { apiKey, email: 'dev@example.com', password: 'test', }, }) const response = await restClient.GET(`/${slug}/me`, { headers: { Authorization: `${slug} API-Key ${user?.apiKey}`, }, }) const data = await response.json() expect(response.status).toBe(200) expect(data.user.email).toBeDefined() expect(data.user.apiKey).toStrictEqual(apiKey) }) it('should refresh a token and reset its expiration', async () => { const response = await restClient.POST(`/${slug}/refresh-token`, { headers: { Authorization: `JWT ${token}`, }, }) const data = await response.json() expect(response.status).toBe(200) expect(data.refreshedToken).toBeDefined() }) it('should refresh a token and receive an up-to-date user', async () => { expect(loggedInUser?.custom).toBe('Hello, world!') await payload.update({ id: loggedInUser?.id || '', collection: slug, data: { custom: 'Goodbye, world!', }, }) const response = await restClient.POST(`/${slug}/refresh-token`, { headers: { Authorization: `JWT ${token}`, }, }) const data = await response.json() expect(response.status).toBe(200) expect(data.user.custom).toBe('Goodbye, world!') }) it('should allow a user to be created', async () => { const response = await restClient.POST(`/${slug}`, { body: JSON.stringify({ email: 'name@test.com', password, roles: ['editor'], }), headers: { Authorization: `JWT ${token}`, }, }) const data = await response.json() expect(response.status).toBe(201) expect(data).toHaveProperty('message') expect(data).toHaveProperty('doc') const { doc } = data expect(doc).toHaveProperty('email') expect(doc).toHaveProperty('createdAt') expect(doc).toHaveProperty('roles') }) it('should allow verification of a user', async () => { const emailToVerify = 'verify@me.com' const response = await restClient.POST(`/public-users`, { body: JSON.stringify({ email: emailToVerify, password, roles: ['editor'], }), headers: { Authorization: `JWT ${token}`, }, }) expect(response.status).toBe(201) const userResult = await payload.find({ collection: 'public-users', limit: 1, showHiddenFields: true, where: { email: { equals: emailToVerify, }, }, }) const { _verificationToken, _verified } = userResult.docs[0] expect(_verified).toBe(false) expect(_verificationToken).toBeDefined() const verificationResponse = await restClient.POST( `/public-users/verify/${_verificationToken}`, ) expect(verificationResponse.status).toBe(200) const afterVerifyResult = await payload.find({ collection: 'public-users', limit: 1, showHiddenFields: true, where: { email: { equals: emailToVerify, }, }, }) const { _verificationToken: afterToken, _verified: afterVerified } = afterVerifyResult.docs[0] expect(afterVerified).toBe(true) expect(afterToken).toBeNull() }) describe('User Preferences', () => { const key = 'test' const property = 'store' let data beforeAll(async () => { const response = await restClient.POST(`/payload-preferences/${key}`, { body: JSON.stringify({ value: { property }, }), headers: { Authorization: `JWT ${token}`, }, }) data = await response.json() }) it('should create', async () => { expect(data.doc.key).toStrictEqual(key) expect(data.doc.value.property).toStrictEqual(property) }) it('should read', async () => { const response = await restClient.GET(`/payload-preferences/${key}`, { headers: { Authorization: `JWT ${token}`, }, }) data = await response.json() expect(data.key).toStrictEqual(key) expect(data.value.property).toStrictEqual(property) }) it('should update', async () => { const response = await restClient.POST(`/payload-preferences/${key}`, { body: JSON.stringify({ value: { property: 'updated', property2: 'test' }, }), headers: { Authorization: `JWT ${token}`, }, }) data = await response.json() const result = await payload.find({ collection: 'payload-preferences', depth: 0, where: { key: { equals: key }, }, }) expect(data.doc.key).toStrictEqual(key) expect(data.doc.value.property).toStrictEqual('updated') expect(data.doc.value.property2).toStrictEqual('test') expect(result.docs).toHaveLength(1) }) it('should delete', async () => { const response = await restClient.DELETE(`/payload-preferences/${key}`, { headers: { Authorization: `JWT ${token}`, }, }) data = await response.json() const result = await payload.find({ collection: 'payload-preferences', depth: 0, where: { key: { equals: key }, }, }) expect(result.docs).toHaveLength(0) }) }) describe('Account Locking', () => { const userEmail = 'lock@me.com' const tryLogin = async () => { await restClient.POST(`/${slug}/login`, { body: JSON.stringify({ email: userEmail, password: 'bad', }), }) } beforeAll(async () => { const response = await restClient.POST(`/${slug}/login`, { body: JSON.stringify({ email, password, }), }) const data = await response.json() token = data.token // New user to lock await restClient.POST(`/${slug}`, { body: JSON.stringify({ email: userEmail, password, }), headers: { Authorization: `JWT ${token}`, }, }) }) it('should lock the user after too many attempts', async () => { await tryLogin() await tryLogin() await tryLogin() // Let it call multiple times, therefore the unlock condition has no bug. const userResult = await payload.find({ collection: slug, limit: 1, showHiddenFields: true, where: { email: { equals: userEmail, }, }, }) const { lockUntil, loginAttempts } = userResult.docs[0] expect(loginAttempts).toBe(2) expect(lockUntil).toBeDefined() }) it('should unlock account once lockUntil period is over', async () => { // Lock user await tryLogin() await tryLogin() await payload.update({ collection: slug, data: { lockUntil: Date.now() - 605 * 1000, }, where: { email: { equals: userEmail, }, }, }) // login await restClient.POST(`/${slug}/login`, { body: JSON.stringify({ email: userEmail, password, }), headers: { Authorization: `JWT ${token}`, }, }) const userResult = await payload.find({ collection: slug, limit: 1, showHiddenFields: true, where: { email: { equals: userEmail, }, }, }) const { lockUntil, loginAttempts } = userResult.docs[0] expect(loginAttempts).toBe(0) expect(lockUntil).toBeNull() }) }) }) it('should allow forgot-password by email', async () => { // TODO: Spy on payload sendEmail function const response = await restClient.POST(`/${slug}/forgot-password`, { body: JSON.stringify({ email, }), }) // expect(mailSpy).toHaveBeenCalled(); expect(response.status).toBe(200) }) it('should allow reset password', async () => { const token = await payload.forgotPassword({ collection: 'users', data: { email: devUser.email, }, disableEmail: true, }) const result = await payload .resetPassword({ collection: 'users', data: { password: devUser.password, token, }, overrideAccess: true, }) .catch((e) => console.error(e)) expect(result).toBeTruthy() }) it('should enforce access control on the me route', async () => { const user = await payload.create({ collection: slug, data: { adminOnlyField: 'admin secret', email: 'insecure@me.com', password: 'test', roles: ['admin'], }, }) const response = await restClient.POST(`/${slug}/login`, { body: JSON.stringify({ email: 'insecure@me.com', password: 'test', }), }) const data = await response.json() const adminMe = await restClient .GET(`/${slug}/me`, { headers: { Authorization: `JWT ${data.token}`, }, }) .then((res) => res.json()) expect(adminMe.user.adminOnlyField).toEqual('admin secret') await payload.update({ id: user?.id || '', collection: slug, data: { roles: ['editor'], }, }) const editorMe = await restClient .GET(`/${slug}/me`, { headers: { Authorization: `JWT ${data.token}`, }, }) .then((res) => res.json()) expect(editorMe.user.adminOnlyField).toBeUndefined() }) it('should not allow refreshing an invalid token', async () => { const response = await restClient.POST(`/${slug}/refresh-token`, { body: JSON.stringify({ token: 'INVALID', }), }) const data = await response.json() expect(response.status).toBe(403) expect(data.token).toBeUndefined() }) }) describe('API Key', () => { it('should authenticate via the correct API key user', async () => { const usersQuery = await payload.find({ collection: 'api-keys', }) const [user1, user2] = usersQuery.docs const success = await restClient .GET(`/api-keys/${user2.id}`, { headers: { Authorization: `api-keys API-Key ${user2.apiKey}`, }, }) .then((res) => res.json()) expect(success.apiKey).toStrictEqual(user2.apiKey) const fail = await restClient.GET(`/api-keys/${user1.id}`, { headers: { Authorization: `api-keys API-Key ${user2.apiKey}`, }, }) expect(fail.status).toStrictEqual(404) }) }) })