Manejo de Errores

YasuiJS proporciona manejo y formateo automático de errores tanto para el registro como para las respuestas del cliente. Todos los métodos del controlador están automáticamente envueltos con manejo de errores para capturar y procesar cualquier error lanzado.

Descripción General

Cuando ocurre un error en tu aplicación, YasuiJS automáticamente:

• Registra el error con información detallada (URL, método, estado, mensaje)
• Lo formatea y lo envía al cliente como una respuesta JSON
• Incluye código de estado HTTP, detalles del error, información de la solicitud y cualquier dato adicional del error

@Get('/:id')
getUser(@Param('id') id: string) {
  const user = this.userService.findById(id);

  if (!user) {
    // Este error será capturado y formateado automáticamente
    throw new Error('Usuario no encontrado');
  }
  return user;
}

Manejo de Errores Personalizado

Clase HttpError

El estado HTTP predeterminado si lanzas un Error será 500 (Error Interno del Servidor). Para especificar el estado HTTP esperado correspondiente a tu error, lanza un HttpError:

import { HttpError, HttpCode } from 'yasui';

@Controller('/users')
export class UserController {

 @Get('/:id')
 getUser(@Param('id') id: string) {
   const user = this.userService.findById(id);

   if (!user) {
     throw new HttpError(HttpCode.NOT_FOUND, `Usuario ${id} no encontrado`);
   }
   return user;
 }
}

Puedes especificar un código como número (ej. 400) o usar la enumeración proporcionada HttpCode como en el ejemplo. Para una lista completa de códigos de estado HTTP y sus significados, consulta la documentación de códigos de estado de respuesta HTTP.

Clases de Error Personalizadas

Crea errores personalizados con códigos de estado específicos y datos adicionales extendiendo o usando la clase HttpError. Tu error personalizado debe establecer las propiedades status y message llamando al constructor padre, y puede incluir cualquier propiedad adicional.

class ValidationError extends HttpError {
  fields: string[];

  constructor(fields: string[]) {
    super(HttpCode.BAD_REQUEST, 'Faltan campos requeridos');
    this.fields = fields;
  }
}

@Controller('/users')
export class UserController {

  @Post('/')
  createUser(@Body() userData: any) {
    const missingFields = this.validateUserData(userData);

    if (missingFields.length > 0) {
      throw new ValidationError(missingFields);
    }
    return this.userService.createUser(userData);
  }
}

Las propiedades adicionales se incluirán en la respuesta formateada de Yasui.

Formato de Respuesta de Error

Cuando se lanza un error, YasuiJS automáticamente lo formatea en una respuesta JSON consistente:

{
  "url": "http://localhost:3000/api/users/123",
  "path": "/api/users/123",
  "method": "POST",
  "name": "ValidationError", // Nombre de la clase de error
  "message": "Faltan campos requeridos",
  "statusMessage": "Bad Request", // Mensaje de estado HTTP
  "status": 404, // Código de estado HTTP
  "data": {
    "fields": ["nombre", "edad"]
  }
}

Las propiedades de errores personalizados que heredan de HttpError se incluirán en data.

Manejo de Errores en Servicios

Los servicios o cualquier Injectable pueden lanzar errores que serán capturados automáticamente cuando se llamen desde los controladores:

@Injectable()
export class UserService {

  findById(id: string) {
    const user = this.database.findUser(id);
    if (!user) {
      // Esto será capturado por el manejador de errores del controlador
      throw new HttpError(HttpCode.NOT_FOUND, 'Usuario no encontrado');
    }
    return user;
  }
}

Registros de errores

En modo debug (opción debug en la configuración de Yasui), todos los errores devueltos por los endpoints serán registrados. En producción, solo los errores 500 (Error Interno del Servidor) serán registrados, considerando que son inesperados y no son usualmente errores de negocio.

Validación de Decoradores

YasuiJS valida automáticamente tus decoradores al inicio para detectar errores comunes de configuración. Estos errores se reportan después de la inicialización del servidor pero no impiden que el servidor se ejecute:

// Esto será detectado y reportado como un error
@Injectable()
export class ServiceA {
  constructor(private serviceB: ServiceB) {}
}

@Injectable()
export class ServiceB {
  constructor(private serviceA: ServiceA) {} // ¡Dependencia circular detectada!
}

// Se detectará la falta del decorador de parámetro
@Controller('/users')
export class UserController {
  @Get('/:id')
  getUser(id: string) { // Falta el decorador @Param('id')
    return this.userService.findById(id);
  }
}

Puedes deshabilitar la validación de decoradores en la configuración (no recomendado):

yasui.createServer({
  controllers: [UserController],
  enableDecoratorValidation: false // Inseguro - deshabilita la validación
});