ajuste no command

This commit is contained in:
unknown
2025-03-31 15:12:33 -03:00
parent 69e10717e8
commit 4522575701
11 changed files with 145 additions and 105 deletions

View File

@@ -5,28 +5,26 @@ import {
HttpStatus,
Post,
} from '@nestjs/common';
import { AuthService } from './auth.service';
import { UsersService } from '../users/users.service';
import { LoginDto } from '../auth/dto/login.dto';
import { ResultModel } from 'src/core/models/result.model';
import { ApiBody, ApiOkResponse, ApiUnauthorizedResponse } from '@nestjs/swagger';
import { ApiTags } from '@nestjs/swagger';
import { ApiResponse } from '@nestjs/swagger';
import { ApiOperation } from '@nestjs/swagger';
import { ApiBearerAuth } from '@nestjs/swagger';
import { ApiCreatedResponse } from '@nestjs/swagger';
import { ApiBadRequestResponse } from '@nestjs/swagger';
import { ApiNotFoundResponse } from '@nestjs/swagger';
import { ApiInternalServerErrorResponse } from '@nestjs/swagger';
import { ApiForbiddenResponse } from '@nestjs/swagger';
import { CommandBus } from '@nestjs/cqrs';
import { CqrsModule } from '@nestjs/cqrs';
import { AuthenticateUserCommand } from './authenticate-user.command';
import { LoginResponseDto } from './dto/LoginResponseDto';
import { LoginDto } from './dto/login.dto';
import { ResultModel } from 'src/core/models/result.model';
import { AuthService } from './auth.service';
import {
ApiTags,
ApiOperation,
ApiBody,
ApiOkResponse,
ApiUnauthorizedResponse,
} from '@nestjs/swagger';
@ApiTags('Auth')
@Controller('api/v1/auth')
export class AuthController {
constructor(
private readonly usersService: UsersService,
private readonly commandBus: CommandBus,
private readonly authService: AuthService,
) {}
@@ -38,11 +36,9 @@ export class AuthController {
type: LoginResponseDto,
})
@ApiUnauthorizedResponse({ description: 'Usuário ou senha inválidos' })
async login(@Body() model: LoginDto): Promise<LoginResponseDto> {
const result = await this.usersService.authenticate({
userName: model.username,
password: model.password,
});
async login(@Body() dto: LoginDto): Promise<LoginResponseDto> {
const command = new AuthenticateUserCommand(dto.username, dto.password);
const result = await this.commandBus.execute(command);
if (!result.success) {
throw new HttpException(
@@ -52,7 +48,6 @@ export class AuthController {
}
const user = result.data;
const token = await this.authService.createToken(
user.id,
user.sellerId,
@@ -71,4 +66,4 @@ export class AuthController {
token: token,
};
}
}
}

View File

@@ -6,20 +6,30 @@ import { JwtStrategy } from '../strategies/jwt-strategy';
import { RedisModule } from 'src/core/configs/cache/redis.module';
import { UsersModule } from '../users/users.module';
import { AuthController } from './auth.controller';
import { CqrsModule } from '@nestjs/cqrs';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { AuthenticateUserHandler } from './authenticate-user.service';
@Module({
imports: [
JwtModule.register({
secret: '4557C0D7-DFB0-40DA-BF83-91A75103F7A9',
signOptions: { expiresIn: '8h' },
CqrsModule,
ConfigModule,
JwtModule.registerAsync({
imports: [ConfigModule],
useFactory: async (configService: ConfigService) => ({
secret: configService.get<string>('JWT_SECRET'),
signOptions: {
expiresIn: configService.get<string>('JWT_EXPIRES_IN'),
},
}),
inject: [ConfigService],
}),
PassportModule.register({ defaultStrategy: 'jwt' }),
RedisModule,
UsersModule,
],
controllers: [AuthController],
providers: [AuthService, JwtStrategy],
providers: [AuthService, JwtStrategy, AuthenticateUserHandler],
exports: [AuthService],
})
export class AuthModule {}

View File

@@ -1,12 +1,8 @@
/* eslint-disable prettier/prettier */
/* eslint-disable @typescript-eslint/no-unused-vars */
import { Injectable } from '@nestjs/common';
import { JwtService, JwtSignOptions } from '@nestjs/jwt';
import { UsersService } from '../users/users.service';
import { JwtPayload } from '../models/jwt-payload.model';
import Redis from 'ioredis';
import { UserRepository } from '../users/UserRepository';
@Injectable()
@@ -14,6 +10,7 @@ export class AuthService {
constructor(
private readonly usersService: UsersService,
private readonly jwtService: JwtService,
private readonly userRepository: UserRepository,
) {}
async createToken(id: number, sellerId: number, username: string, email: string, storeId: string) {
@@ -29,6 +26,15 @@ export class AuthService {
}
async validateUser(payload: JwtPayload): Promise<JwtPayload | null> {
return payload;
const user = await this.userRepository.findById(payload.id);
if (!user || !user.active) return null;
return {
id: user.id,
sellerId: user.sellerId,
storeId: user.storeId,
username: user.username,
email: user.email,
};
}
}

View File

@@ -1,4 +1,4 @@
export class AuthenticateUserCommand {
export class AuthenticateUserCommand {
constructor(
public readonly username: string,
public readonly password: string,

View File

@@ -1,13 +1,16 @@
import { Injectable, ForbiddenException } from '@nestjs/common';
import { UserRepository } from '../users/UserRepository';
import { CommandHandler, ICommandHandler } from '@nestjs/cqrs';
import { AuthenticateUserCommand } from './authenticate-user.command';
import { UserRepository } from '../users/UserRepository';
import { Result } from '../models/result';
import { Injectable } from '@nestjs/common';
import { UserModel } from 'src/core/models/user.model';
@CommandHandler(AuthenticateUserCommand)
@Injectable()
export class AuthenticateUserService {
export class AuthenticateUserHandler implements ICommandHandler<AuthenticateUserCommand> {
constructor(private readonly userRepository: UserRepository) {}
async execute(command: AuthenticateUserCommand): Promise<Result<any>> {
async execute(command: AuthenticateUserCommand): Promise<Result<UserModel>> {
const { username, password } = command;
const user = await this.userRepository.findByUsernameAndPassword(username, password);
@@ -17,13 +20,18 @@ export class AuthenticateUserService {
}
if (user.dataDesligamento !== null) {
return Result.fail('Usuário desligado da empresa, login não permitido, Procure o setor de RH!');
return Result.fail('Usuário desligado da empresa, login não permitido!');
}
if (user.situacao === 'I') {
return Result.fail('Usuário inativo, login não permitido!');
}
return Result.ok(user);
if (user.situacao === 'B') {
return Result.fail('Usuário bloqueado, login não permitido!');
}
return Result.ok(user);
}
}

View File

@@ -1,46 +1,53 @@
Controller
↓ recebe LoginDto
UsersService
↓ monta o AuthenticateUserCommand
AuthenticateUserService
// Documentação atualizada da funcionalidade de autenticação usando Command + Microservice
/*
Fluxo atualizado:
Client (HTTP POST /api/v1/auth/login)
↓ envia LoginRequestDto
AuthController
↓ envia AuthenticateUserCommand para CommandBus
AuthenticateUserHandler (CommandHandler)
↓ executa regras de negócio
UserRepository
↓ executa query no banco
Result<User>
← resposta encapsulada
AuthController
↓ gera JWT com AuthService
Resposta final: LoginResponseDto com token
*/
// 1. AuthController
// Entrada da requisição HTTP (POST /api/v1/auth/login)
// - Recebe LoginRequestDto com username e password
// - Cria AuthenticateUserCommand
// - Envia para CommandBus
// - Se sucesso, gera JWT via AuthService e retorna LoginResponseDto
1. LoginController
Entrada da requisição HTTP (POST /auth/login)
// 2. AuthenticateUserCommand
// Representa a intenção de autenticação
// - Dados: username, password
Recebe LoginDto com email e password
// 3. AuthenticateUserHandler
// Executa o caso de uso de autenticação
// - Busca usuário no UserRepository
// - Verifica se o usuário está desligado ou inativo
// - Retorna Result<User>
Encaminha para o UsersService
// 4. UserRepository
// Camada de persistência (interface com o banco de dados)
// - Executa query findByUsernameAndPassword(username, password)
2. UsersService
Cria e valida o comando AuthenticateUserCommand
// 5. Result<T>
// Objeto genérico de retorno que encapsula:
// - Sucesso (success = true, data: User)
// - Falha (success = false, error: string)
Chama o serviço de autenticação de domínio (AuthenticateUserService)
// 6. AuthService
// Gera token JWT com base nos dados do usuário
// - Pode gerar access token e refresh token (se necessário)
3. AuthenticateUserService
Lógica de negócio da autenticação:
Busca usuário pelo e-mail
Verifica se o usuário está ativo
Valida a senha com hash
Retorna Result<User>
4. UserRepository
Camada de persistência (interface com o banco de dados)
Executa a query findByEmail(email: string)
5. Result<T>
Objeto genérico de retorno que encapsula:
Sucesso (success = true, com data: User)
Falha (success = false, com error: string)
// Estrutura atual suporta futura extração do AuthModule como microserviço
// - Usando @MessagePattern('auth.login') no AuthController do microserviço
// - Consumo via ClientProxy na aplicação principal com ClientModule

View File

@@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Documentação - Fluxo de Login</title>
<title>Documentação - Fluxo de Login com Microserviço</title>
<style>
body {
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
@@ -47,12 +47,11 @@
</style>
</head>
<body>
<h1>🔐 Fluxo de Login - Portal Juru API</h1>
<h1>🔐 Fluxo de Login com Microserviço - Portal Juru API</h1>
<h2>📌 Rota de Login</h2>
<p><strong>URL:</strong> <code>POST /api/v1/auth/login</code></p>
<p><strong>Descrição:</strong> Autentica o usuário, valida regras de negócio e retorna um token JWT.</p>
<p><strong>Acesso:</strong> Público</p>
<p><strong>Descrição:</strong> Autentica o usuário via microserviço e retorna um token JWT.</p>
<h3>📤 Body (JSON)</h3>
<pre>{
@@ -79,40 +78,40 @@
"error": "Usuário ou senha inválidos."
}</pre>
<h2>🧱 Camadas e Responsabilidades</h2>
<h2>🧱 Camadas e Responsabilidades (CQRS + Microservice)</h2>
<table>
<tr><th>Camada</th><th>Responsabilidade</th></tr>
<tr><td>AuthController</td><td>Recebe requisição e coordena autenticação</td></tr>
<tr><td>UsersService</td><td>Orquestra os casos de uso (login, reset, troca senha)</td></tr>
<tr><td>AuthenticateUserService</td><td>Executa lógica de autenticação e validações</td></tr>
<tr><td>UserRepository</td><td>Executa SQL diretamente no Oracle</td></tr>
<tr><td>AuthService</td><td>Gera o token JWT com os dados do usuário</td></tr>
<tr><td>JwtStrategy</td><td>Valida o token em rotas protegidas, usando Redis como cache</td></tr>
<tr><td>RedisClientAdapter</td><td>Wrapper de acesso ao Redis com interface genérica e TTL</td></tr>
<tr><th>Componente</th><th>Responsabilidade</th></tr>
<tr><td>AuthController</td><td>Recebe requisição HTTP e envia AuthenticateUserCommand ao CommandBus</td></tr>
<tr><td>AuthenticateUserCommand</td><td>Representa a intenção de autenticar um usuário</td></tr>
<tr><td>AuthenticateUserHandler</td><td>Executa regras de autenticação com base no comando</td></tr>
<tr><td>UserRepository</td><td>Consulta o banco para obter dados do usuário</td></tr>
<tr><td>Result&lt;T&gt;</td><td>Encapsula sucesso ou falha com mensagens claras</td></tr>
<tr><td>AuthService</td><td>Gera token JWT e/ou Refresh Token</td></tr>
<tr><td>Auth Microservice</td><td>Escuta o evento 'auth.login' e executa a autenticação</td></tr>
<tr><td>ClientProxy</td><td>Faz chamada ao microserviço de autenticação</td></tr>
</table>
<h2>🧊 Redis na Autenticação</h2>
<h2>🔗 Comunicação via Microserviço</h2>
<ul>
<li><strong>Chave:</strong> <code>session:{userId}</code></li>
<li><strong>Valor:</strong> JSON serializado do usuário autenticado</li>
<li><strong>TTL:</strong> 8 horas</li>
<li><strong>Fallback:</strong> Se o cache não existir, consulta ao banco</li>
<li><strong>Auditoria:</strong> espaço reservado para log de acesso</li>
<li><strong>Protocolo:</strong> TCP</li>
<li><strong>Evento:</strong> <code>auth.login</code></li>
<li><strong>Porta:</strong> 3001</li>
<li><strong>Formato:</strong> <code>{ username, password }</code></li>
<li><strong>Resposta:</strong> <code>Result&lt;User&gt;</code></li>
</ul>
<h2>🔐 Proteção de Rotas</h2>
<p>Rotas protegidas utilizam <code>@UseGuards(JwtAuthGuard)</code> e <code>@ApiBearerAuth()</code>.</p>
<p><strong>Header necessário:</strong></p>
<h2>🛡️ Proteção com JWT</h2>
<p>Após o login, o token JWT é retornado e deve ser enviado em todas as requisições protegidas.</p>
<code>Authorization: Bearer &lt;token&gt;</code>
<h2>🚀 Melhorias Futuras</h2>
<ul>
<li>[ ] Blacklist de tokens para logout</li>
<li>[ ] Log de auditoria</li>
<li>[ ] Blacklist de tokens</li>
<li>[ ] Refresh Token</li>
<li>[ ] Controle de permissões/roles</li>
<li>[ ] Log de auditoria</li>
<li>[ ] Controle de permissões e roles</li>
</ul>
<p><strong>Última atualização:</strong> 28/03/2025</p>
<p><strong>Última atualização:</strong> 31/03/2025</p>
</body>
</html>

View File

@@ -3,7 +3,7 @@ import { TypeOrmModule } from '@nestjs/typeorm'; // <-- importe aqui
import { UsersService } from './users.service';
import { UserRepository } from './UserRepository';
import { AuthenticateUserService } from '../auth/authenticate-user.service';
import { AuthenticateUserHandler } from '../auth/authenticate-user.service';
import { ResetPasswordService } from './reset-password.service';
import { ChangePasswordService } from './change-password.service';
import { EmailService } from './email.service';
@@ -16,7 +16,7 @@ import { EmailService } from './email.service';
providers: [
UsersService,
UserRepository,
AuthenticateUserService,
AuthenticateUserHandler,
ResetPasswordService,
ChangePasswordService,
EmailService,

View File

@@ -1,5 +1,5 @@
import { Injectable } from '@nestjs/common';
import { AuthenticateUserService } from '../auth/authenticate-user.service';
import { AuthenticateUserHandler } from '../auth/authenticate-user.service';
import { ResetPasswordService } from './reset-password.service';
import { ChangePasswordService } from './change-password.service';
import { AuthenticateUserCommand } from '../auth/authenticate-user.command';
@@ -9,7 +9,7 @@ import { AuthenticateUserCommand } from '../auth/authenticate-user.command';
@Injectable()
export class UsersService {
constructor(
private readonly authenticateUserService: AuthenticateUserService,
private readonly authenticateUserService: AuthenticateUserHandler,
private readonly resetPasswordService: ResetPasswordService,
private readonly changePasswordService: ChangePasswordService,
) {}