angular-invocation-handler

1.5.1 • Public • Published

Angular Invocation Handler

Build Status Build status Bower version npm version Code Climate  NPM devDependency Status

A module for collecting errors, stack traces and other information globally from within your Angular app e.g. for saving to a remote service or for displaying

NPM

Feel free to donate

Click here to lend your support to: NPM packages and make a donation at pledgie.com ! Or donate Bitcoins: Bitcoin

Also via greenaddress

Reasons to use

It's anyoing to handle all errors in controller and service and also very defective. So instead of surfacing the log it would be cool to manage them at a central place and maybe store them via on a backend service

WIP

  • Library core
  • Write unit tests
  • NPM package
  • Write e2e-tests
  • Write an API doc
  • Provide complete examples

Usage

Install this module:

bower install angular-invocation-handler --save

Add the dependencies

/*global app: true*/
var app = angular.module('resourcesApp', [
...
'ngIH.core',
'ngIH.ui' /* optional */,
'ngIH.exceptionHandler' /* optional */
]);

If you like to display the error message within your app, also include the ui module.

Configure the service to be handled:

app.config(function ($provide, ngIHServiceProvider, ngIHConfig) {
  'use strict';
 
  // enable UI feedback attach, default false
  ngIHConfig.feedbackAttach = true;
  // enable clearing of feedback
  ngIHConfig.feedbackClear = true;
  // set custom selector for appending UI error display element
  ngIHConfig.uiSelector = '.navbar';
  // enable scrolling to error display element
  ngIHConfig.scrollToError = true;
  // redirect to static error pages, e.g. 404 --> /404.html, default false
  ngIHConfig.redirect = true;
  // adding custom error handler, default is disabled
  ngIHConfig.customErrorHandler = 'errorHandlingService';
  // decorate the mentioned [services] with automatic error handling.
  ngIHServiceProvider.decorate($provide, ['eventService']);
});
 

The customized error handling service looks like this:

app.factory('errorHandlingService', function ($log, $translate, blockUI) {
    'use strict';
 
    function buildValidationMessages(error, msg, callback, i) {
        var errorDetails = error.data[i];
        $translate('VALIDATION_ERROR_' + errorDetails.messageTemplate).then(function (translatedValue) {
            msg = msg + ' ' + translatedValue;
 
            // replace placeholder if set
            if (errorDetails.propertyList) {
                msg = msg.format(errorDetails.propertyList);
            }
 
            // callback when complete
            if (=== error.data.length - 1) {
                $log.debug(error.status + '=>' + msg);
                callback(msg);
            }
        }, function (err) {
            $log.error(err);
            callback(msg);
        });
    }
 
    return {
        resolve: function (details, callback) {
            if (details.error) {
                var error = details.error;
                // read by http code
                $translate('HTTP_STATUS_CODE_' + error.status).then(function (translatedValue) {
                    var msg = translatedValue;
                    // handle violation errors
                    if (error.status === 400 && error.data && error.data.length) {
                        for (var i = 0; i < error.data.length; i++) {
                            blockUI.stop();
                            buildValidationMessages(error, msg, callback, i);
                        }
                    } else {
                        blockUI.stop();
                        $log.debug(error.status + '=>' + msg);
                        callback(msg);
                    }
                });
            }
        }
    };
});

About

This module instruments Angular's interceptors to invoke a configurable set for the error handling.

Package Sidebar

Install

npm i angular-invocation-handler

Weekly Downloads

1

Version

1.5.1

License

MIT

Last publish

Collaborators

  • hypery2k