Flash message assertion fails on login test

[danielh-official]

In my auth controller, I have the following login method:

export default class AuthController {
  public async login({ request, auth, response, session }: HttpContextContract) {
    const userSchema = schema.create({
      email: schema.string([rules.email()]),
      password: schema.string([
        rules.minLength(6),
        rules.alphaNum({ allow: ['dash', 'underscore'] }),
        rules.required(),
      ]),
      remember: schema.boolean(),
    })

    try {
      const payload = await request.validate({ schema: userSchema })

      await auth.use('web').attempt(payload.email, payload.password, payload.remember)

      session.flash('message', 'Login successful!')

      response.redirect('/')
    } catch (e) {
      return response.badRequest(e ?? 'Invalid credentials')
    }
  }
}

I'm testing a successful login:

import { test } from '@japa/runner'
import { UserFactory } from 'Database/factories'

test.group('Auth login', () => {
  // Write your test here
  test('successful login', async ({ client }) => {
    const user = await UserFactory.merge({
      password: 'password1',
    }).create()

    const form = {
      email: user.email,
      password: 'password1',
      remember: false,
    }

    const response = await client.post('/login').form(form)

    response.assertStatus(200)
    response.assertFlashMessage('message')
  })
})

When running yarn test or node ace test, I get the following error:

✖ successful login

  Assertion Error: expected {} to have nested property 'message'


   at Object.executor tests/functional/auth/login.spec.ts:20
   15|      }
   16|  
   17|      const response = await client.post('/login').form(form)
   18|  
   19|      response.assertStatus(200)
 ❯ 20|      response.assertFlashMessage('message')
   21|    })
   22|  
   23|    test('failed login', async ({ client }) => {
   24|      const user = await UserFactory.merge({
   25|        password: 'password1',

Why is the flash messages object empty?

[thetutlage]

Because you are catching the exception and not letting the AuthException convert itself to a response. Simply remove the try/catch block in your controller

[danielh-official]

I don’t understand. A successful login means no exception will be thrown. Which means the flash message should be activated in the “try” block. And I’ve also tried doing it by moving the flash message outside of and before the try/catch block.

Are you saying that the existence of the try/catch itself is causing this? That in order to make flash messages work, I have to remove try/catch completely?

[danielh-official]

  public async login({ request, auth, response, session }: HttpContextContract) {
    const userSchema = schema.create({
      email: schema.string([rules.email()]),
      password: schema.string([
        rules.minLength(6),
        rules.alphaNum({ allow: ['dash', 'underscore'] }),
        rules.required(),
      ]),
      remember: schema.boolean(),
    })

    const payload = await request.validate({ schema: userSchema })

    // try {
    //   await auth.use('web').attempt(payload.email, payload.password, payload.remember)
    // } catch (e) {
    //   return response.badRequest(e ?? 'Invalid credentials')
    // }

    await auth.use('web').attempt(payload.email, payload.password, payload.remember)

    session.flash('message', 'Login successful!')

    response.redirect('/')
  }

Is this what you mean? Still the same issues.

[aayush123]

@danielh-official I think the problem lies in the fact that when you're creating the user, you're overwriting the password column to literally contain 'password1' and not the hashed form of 'password1'. I may be wrong here but I believe your controller doesn't successfully login at all