@gecosuy/angular-error-handle v17.0.1

Angular Error Handle

Librería Angular para el manejo de errores.

Funcionalidades

AngularGlobalErrorHandler

ErrorHandler para utilizar como el manejador de errores global seteado a Angular.
Una vez realizada la configuración anterior, los errores llegan a este handler en estos casos:

• Automáticamente siempre que no son catcheados explícitamente en el código
• Manualmente si el handler es utilizado para ser invocado explícitamente en el código para manejar un determinado error si corresponde.

Este manejador realiza el siguiente procesamiento sobre los errores capturados:

• determinar su mensaje y stacktrace
• loguear/registrar el mismo
• notificar al usuario del error si corresponde

La forma de loguear y de notificar es configurable y se explicará en la siguiente sección.
Ver más en la documentación de la clase AngularGlobalErrorHandler.

UnauthorizedServerErrorInterceptor

Interceptor HTTP para manejar los casos de Unauthorized. El mismo está disponible y puede utilizarse o no según lo requiera la app que usa la librería.
La idea es que si la app requiere manejar los casos de unauthorized (401) para por ejemplo redirigir al login y/o desloguear al usuario, entonces puede hacer uso de este interceptor configurando la condición de unauthorized y las acciones que quiere realizar una vez detectado el caso. Se explica como realziar esta configuración en la siguiente sección.

Ver más en la documentación de la clase UnauthorizedServerErrorInterceptor.

Uso

Se debe importar el módulo en el AppModule y se debe incluir la configuración para definirle a Angular el error handler a utilziar mediante { provide: ErrorHandler, useClass: AngularGlobalErrorHandler }.

Además se debe incluir un Provider para el token ANGULAR_ERROR_HANDLE_CONFIG el cual debe proveer un objeto AngularErrorHandleConfig con toda la configuración para el módulo. La forma de definir este Provider puede ser cualquiera, dependiendo de las necesidades de cada app. En el ejemplo mostrado se realiza mediante una factory porque se representa que se tiene una dependencia con un AuthService que es usado para desloguear al usuario en caso de 401, y se requiere hacer de esta forma para tener acceso al mismo. Pero si por ejemplo se trata de una app simple donde no se requiere de ninguna dependencia para ese hanldr entonces se puede definir directamente el provider mediante useValue o useClass sin requerir una factory.

Si además se quiere hacer uso del interceptor para el manejo de requiest unauthorized entonces también se debe agregar la definición del provider para el mismo mediante { provide: HTTP_INTERCEPTORS, useClass: UnauthorizedServerErrorInterceptor, multi: true }.

import { AngularLoggingModule, AngularLoggingService, LogLevel } from 'angular-logging';

export function getErrorHandleConfig(auth: AuthService): AngularErrorHandleConfig {
    // Ver más detalles de cada campo en la documentación de la clase AngularErrorHandleConfig
    return {
        // función con la que loguear los errores
        loggingFunction: (msg: string, trace: string, rawError: any, externalData: any) => ...,
        // función con la que notificar al usuario de los errores
        notifyFunction: (msg: string, metadata: NotificationMetadata, options?: NotifierOptions) => ...,
        // página a la que redirigir en caso de que la notificación de un error sea en modo ERROR_PAGE
        errorPage: 'error',
        // configuraciones para el interceptor (solo necesarias si se está usando el mismo)
        unauthorizedInterceptor: {
            // forma de chequear si el error correpsonde a un caso de unauthorized (si no se pasa por defecto chequea error.status === 401)
            checker: (error) => error.status === 401 && ...,
            // función invocada cuando se detecta el caso de una repsonse unauthorized, es donde se debe agregar la lógica de acciones necesarias
            action: (error) => this.auth.logout()
        },
        // configuraciones del manejo de errores de validacion del servidor
        validationServerError: {
            // forma de chequear si el error correpsonde a un caso de error de validacion en servidor
            checker: (error) => error.status === 409,
            // funcion que extrae el error de validacion desde la HttpErrorResponse
            messageExtractor: (error) => error.message
        }
    };
}

@NgModule({
  imports: [AngularLoggingModule]
  providers: [
    { provide: ErrorHandler, useClass: AngularGlobalErrorHandler },
    {
        provide: ANGULAR_ERROR_HANDLE_CONFIG,
        useFactory: getErrorHandleConfig,
        deps: [AuthService]
    },
    // Opcional si se quiere también hacer uso del interceptor
    { provide: HTTP_INTERCEPTORS, useClass: UnauthorizedServerErrorInterceptor, multi: true },
  ],
})
export class AppModule {}