Remove LoginAction dependency on AlertStream

Author: lcharette

packages/sprinkle-account/app/assets/interfaces/LoginApi.ts

@@ -0,0 +1,18 @@
+import type { UserInterface } from './models/userInterface'
+
+/**
+ * API Interfaces - What the API expects and what it returns
+ *
+ * This interface is tied to the `LoginAction` API, accessed at the
+ * POST `/account/login` endpoint.
+ */
+export interface LoginRequest {
+    user_name: string
+    password: string
+}
+
+export interface LoginResponse {
+    user: UserInterface
+    message: string
+    redirect: string
+}

packages/sprinkle-account/app/assets/interfaces/forms/loginForm.ts

@@ -1,4 +1,3 @@
-export type { LoginForm } from './forms/loginForm'
 export type { UserInterface } from './models/userInterface'
 export type { GroupInterface } from './models/groupInterface'
 export type { RoleInterface } from './models/roleInterface'
@@ -8,3 +7,4 @@ export type { ProfileEditRequest } from './ProfileEditApi'
 export type { PasswordEditRequest } from './PasswordEditApi'
 export type { EmailEditRequest } from './EmailEditApi'
 export type { RegisterRequest, RegisterResponse } from './RegisterApi'
+export type { LoginRequest, LoginResponse } from './LoginApi'

packages/sprinkle-account/app/assets/interfaces/index.ts

@@ -1,6 +1,6 @@
 import { defineStore } from 'pinia'
 import axios from 'axios'
-import type { UserInterface, LoginForm } from '../interfaces'
+import type { UserInterface, LoginRequest, LoginResponse } from '../interfaces'
 import { type AlertInterface, Severity } from '@userfrosting/sprinkle-core/interfaces'
 import { useTranslator } from '@userfrosting/sprinkle-core/stores'
 
@@ -26,16 +26,16 @@ export const useAuthStore = defineStore('auth', {
         unsetUser(): void {
             this.user = null
         },
-        async login(form: LoginForm) {
+        async login(form: LoginRequest) {
             return axios
-                .post<UserInterface>('/account/login', form)
+                .post<LoginResponse>('/account/login', form)
                 .then((response) => {
-                    this.setUser(response.data)
+                    this.setUser(response.data.user)
 
                     // Reload the translator dictionary to reflect the user's language
                     useTranslator().load()
 
-                    return this.user
+                    return response.data
                 })
                 .catch((err) => {
                     const error: AlertInterface = {

packages/sprinkle-account/app/assets/stores/auth.ts

@@ -2,7 +2,7 @@ import { setActivePinia, createPinia } from 'pinia'
 import { beforeEach, describe, expect, test, vi } from 'vitest'
 import { useAuthStore } from '../../stores/auth'
 import axios from 'axios'
-import type { LoginForm, UserInterface } from 'app/assets/interfaces'
+import type { LoginRequest, LoginResponse, UserInterface } from 'app/assets/interfaces'
 import { Severity } from '@userfrosting/sprinkle-core/interfaces'
 
 const testUser: UserInterface = {
@@ -22,7 +22,7 @@ const testUser: UserInterface = {
     deleted_at: null
 }
 
-const form: LoginForm = {
+const form: LoginRequest = {
     user_name: 'john',
     password: 'password'
 }
@@ -62,8 +62,12 @@ describe('authStore', () => {
     test('should login successfully', async () => {
         // Arrange
         const authStore = useAuthStore()
-        const response = { data: testUser }
-        vi.spyOn(axios, 'post').mockResolvedValue(response as any)
+        const response: LoginResponse = {
+            user: testUser,
+            message: 'Welcome back John Doe!',
+            redirect: '/dashboard'
+        }
+        vi.spyOn(axios, 'post').mockResolvedValue({ data: response })
 
         // Assert initial state
         expect(authStore.user).toBeNull()
@@ -73,7 +77,7 @@ describe('authStore', () => {
 
         // Assert
         expect(axios.post).toHaveBeenCalledWith('/account/login', form)
-        expect(result).toStrictEqual(testUser)
+        expect(result).toStrictEqual(response)
         expect(authStore.user).toStrictEqual(testUser)
         expect(loadTranslator).toHaveBeenCalled()
     })

packages/sprinkle-account/app/assets/tests/stores/auth.test.ts

@@ -15,13 +15,14 @@
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
-use UserFrosting\Alert\AlertStream;
 use UserFrosting\Config\Config;
 use UserFrosting\Fortress\RequestSchema;
 use UserFrosting\Fortress\RequestSchema\RequestSchemaInterface;
 use UserFrosting\Fortress\Transformer\RequestDataTransformer;
 use UserFrosting\Fortress\Validator\ServerSideValidator;
+use UserFrosting\I18n\Translator;
 use UserFrosting\Sprinkle\Account\Authenticate\Authenticator;
+use UserFrosting\Sprinkle\Account\Database\Models\Interfaces\UserInterface;
 use UserFrosting\Sprinkle\Account\Event\UserRedirectedAfterLoginEvent;
 use UserFrosting\Sprinkle\Account\Exceptions\AccountException;
 use UserFrosting\Sprinkle\Account\Exceptions\InvalidCredentialsException;
@@ -57,7 +58,7 @@ class LoginAction
      * @param \UserFrosting\Event\EventDispatcher $eventDispatcher
      */
     public function __construct(
-        protected AlertStream $alert,
+        protected Translator $translator,
         protected Authenticator $authenticator,
         protected Config $config,
         protected EventDispatcherInterface $eventDispatcher,
@@ -76,29 +77,37 @@ public function __construct(
      */
     public function __invoke(Request $request, Response $response): Response
     {
-        $this->handle($request);
-        $response = $this->writeResponse($response);
+        $user = $this->handle($request);
+        $response = $this->writeResponse($response, $user);
 
         return $response->withHeader('Content-Type', 'application/json');
     }
 
     /**
      * Write to the response object.
      *
-     * @param Response $response
+     * @param Response      $response
+     * @param UserInterface $user
      *
      * @return Response
      */
-    protected function writeResponse(Response $response): Response
+    protected function writeResponse(Response $response, UserInterface $user): Response
     {
         // Get redirect target and add Header
         $event = $this->eventDispatcher->dispatch(new UserRedirectedAfterLoginEvent());
         if ($event->getRedirect() !== null) {
             $response = $response->withHeader('UF-Redirect', $event->getRedirect());
         }
 
+        // Define payload
+        $data = [
+            'user'     => $user,
+            'message'  => $this->translator->translate('WELCOME', $user->toArray()),
+            'redirect' => $event->getRedirect() ?? '',
+        ];
+
         // Write response with the user info in it
-        $payload = json_encode($this->authenticator->user(), JSON_THROW_ON_ERROR);
+        $payload = json_encode($data, JSON_THROW_ON_ERROR);
         $response->getBody()->write($payload);
 
         return $response;
@@ -108,8 +117,10 @@ protected function writeResponse(Response $response): Response
      * Handle the request and return the payload.
      *
      * @param Request $request
+     *
+     * @return UserInterface
      */
-    protected function handle(Request $request): void
+    protected function handle(Request $request): UserInterface
     {
         // Get POST parameters
         $params = (array) $request->getParsedBody();
@@ -156,8 +167,7 @@ protected function handle(Request $request): void
             throw new InvalidCredentialsException();
         }
 
-        // Add success message
-        $this->alert->addMessage('success', 'WELCOME', $currentUser->toArray());
+        return $currentUser;
     }
 
     /**

packages/sprinkle-account/app/src/Controller/LoginAction.php

@@ -14,7 +14,6 @@
 
 use Mockery;
 use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
-use UserFrosting\Alert\AlertStream;
 use UserFrosting\Config\Config;
 use UserFrosting\Sprinkle\Account\Account;
 use UserFrosting\Sprinkle\Account\Authenticate\Authenticator;
@@ -59,18 +58,14 @@ public function testLogin(): void
         $response = $this->handleRequest($request);
 
         // Assert response status & body
-        $this->assertJsonResponse($user->toArray(), $response);
+        $this->assertJsonResponse($user->toArray(), $response, 'user');
+        $this->assertJsonResponse('Welcome back, ' . $user->full_name . '!', $response, 'message');
+        $this->assertJsonResponse('/home', $response, 'redirect');
         $this->assertResponseStatus(200, $response);
 
         // Assert Event Redirect
         $this->assertSame('/home', $response->getHeaderLine('UF-Redirect'));
 
-        // Test message
-        /** @var AlertStream */
-        $ms = $this->ci->get(AlertStream::class);
-        $messages = $ms->getAndClearMessages();
-        $this->assertSame('success', array_reverse($messages)[0]['type']);
-
         // We have to logout the user to avoid problem
         /** @var Authenticator */
         $authenticator = $this->ci->get(Authenticator::class);
@@ -93,7 +88,7 @@ public function testLoginWithEmail(): void
         $response = $this->handleRequest($request);
 
         // Assert response status & body
-        $this->assertJsonResponse($user->toArray(), $response);
+        $this->assertJsonResponse($user->toArray(), $response, 'user');
         $this->assertResponseStatus(200, $response);
 
         // We have to logout the user to avoid problem
@@ -215,7 +210,7 @@ public function testLoginThrottlerDoesNotCountSuccessfulLogins(): void
         $response = $this->handleRequest($request);
 
         // Assert response status & body
-        $this->assertJsonResponse($user->toArray(), $response);
+        $this->assertJsonResponse($user->toArray(), $response, 'user');
         $this->assertResponseStatus(200, $response);
 
         // We have to logout the user to avoid problem

packages/sprinkle-account/app/tests/Controller/LoginActionTest.php

@@ -2,14 +2,13 @@
 import { ref } from 'vue'
 import UIkit from 'uikit'
 import type { AlertInterface } from '@userfrosting/sprinkle-core/interfaces'
-import type { LoginForm } from '@userfrosting/sprinkle-account/interfaces'
+import type { LoginRequest } from '@userfrosting/sprinkle-account/interfaces'
 import { useAuthStore } from '@userfrosting/sprinkle-account/stores'
-import { useTranslator } from '@userfrosting/sprinkle-core/stores'
 
 // Variables
 const loading = ref(false)
 const error = ref<AlertInterface | null>()
-let form: LoginForm = {
+let form: LoginRequest = {
     user_name: '',
     password: ''
 }
@@ -21,17 +20,19 @@ async function sendLogin() {
     const auth = useAuthStore()
     await auth
         .login(form)
-        .then((user) => {
-            // TODO : If the notification can be defined in sprinkle-core, and
-            // implemented in the theme, this notification could be moved to the
-            // API directly.
-            const { translate } = useTranslator()
+        .then((response) => {
             UIkit.notification({
-                message: translate('WELCOME', user ?? {}), // TODO : Same error as before, the locale is not updated yet and this is not a reactive variable.
+                message: response.message,
                 status: 'primary',
                 pos: 'top-right',
                 timeout: 4000
             })
+
+            // If a redirect is set, redirect to it
+            // TODO : Dilemma, should we redirect using VueRouter or not?
+            // if (response.redirect) {
+            //     window.location.href = response.redirect
+            // }
         })
         .catch((err: AlertInterface) => {
             error.value = err

packages/theme-pink-cupcake/src/components/Pages/Account/FormLogin.vue

@@ -4,7 +4,7 @@ import FormLogin from '../../../components/Pages/Account/FormLogin.vue'
 import { useAuthStore } from '@userfrosting/sprinkle-account/stores'
 import UFAlert from '../../../components/UFAlert.vue'
 import UIkit from 'uikit'
-import type { LoginForm } from '@userfrosting/sprinkle-account/interfaces'
+import type { LoginRequest } from '@userfrosting/sprinkle-account/interfaces'
 import type { AlertInterface } from '@userfrosting/sprinkle-core/interfaces'
 
 // Register the UFAlert component stub globally
@@ -18,7 +18,7 @@ const mockUseAuthStore = {
 }
 
 // Login form data
-const form: LoginForm = {
+const form: LoginRequest = {
     user_name: 'john.doe',
     password: 'password'
 }
@@ -42,20 +42,13 @@ describe('FormLogin.vue', () => {
     })
 
     test('handles successful login', async () => {
-        mockUseAuthStore.login.mockResolvedValueOnce({ full_name: 'John Doe' })
+        mockUseAuthStore.login.mockResolvedValueOnce({ message: 'Welcome back John Doe!' })
         vi.mocked(useAuthStore).mockReturnValue(mockUseAuthStore as any)
         vi.spyOn(UIkit, 'notification')
 
         const wrapper = mount(FormLogin)
         await (wrapper.vm as any).sendLogin(form)
 
-        // Mock the useTranslator store
-        vi.mock('@userfrosting/sprinkle-core/stores', () => ({
-            useTranslator: () => ({
-                translate: vi.fn(() => 'Welcome back John Doe!')
-            })
-        }))
-
         // Spy on the authStore & UIkit notification method
         expect(useAuthStore).toHaveBeenCalled()
         expect(mockUseAuthStore.login).toHaveBeenCalledTimes(1)
@@ -93,17 +86,10 @@ describe('FormLogin.vue', () => {
     })
 
     test('Handle login using the v-model', async () => {
-        mockUseAuthStore.login.mockResolvedValueOnce({ full_name: 'John Doe' })
+        mockUseAuthStore.login.mockResolvedValueOnce({ message: 'Welcome back John Doe!' })
         vi.mocked(useAuthStore).mockReturnValue(mockUseAuthStore as any)
         vi.spyOn(UIkit, 'notification')
 
-        // Mock the useTranslator store
-        vi.mock('@userfrosting/sprinkle-core/stores', () => ({
-            useTranslator: () => ({
-                translate: vi.fn(() => 'Welcome back John Doe!')
-            })
-        }))
-
         const wrapper = mount(FormLogin)
         wrapper.find('[data-test="username"]').setValue('john.doe')
         wrapper.find('[data-test="password"]').setValue('password')