@rxap/ngx-error
Version:
This package provides a comprehensive error handling solution for Angular applications, including interceptors, services, and UI components to display different types of errors in a user-friendly dialog. It supports handling of generic errors, HTTP errors
739 lines (614 loc) • 27.6 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-error</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">angular-error</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content injectable">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Injectables</li>
<li class="breadcrumb-item" >RxapErrorHandler</li>
</ol>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>src/lib/error-handler.ts</code>
</p>
<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<h6><b>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Protected</span>
<span class="modifier">Readonly</span>
<a href="#injector" >injector</a>
</li>
<li>
<span class="modifier">Protected</span>
<span class="modifier">Readonly</span>
<a href="#options" >options</a>
</li>
</ul>
</td>
</tr>
<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Public</span>
<a href="#handleError" >handleError</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#showAngularErrorDialog" >showAngularErrorDialog</a>
</li>
<li>
<span class="modifier">Protected</span>
<a href="#showOpenApiHttpResponseErrorDialog" >showOpenApiHttpResponseErrorDialog</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-methods">
<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="handleError"></a>
<span class="name">
<span class="modifier">Public</span>
<span ><b>handleError</b></span>
<a href="#handleError"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>handleError(errorCandidate)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="69"
class="link-to-prism">src/lib/error-handler.ts:69</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Method called for every value captured through the ErrorHandler</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>errorCandidate</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="showAngularErrorDialog"></a>
<span class="name">
<span class="modifier">Protected</span>
<span ><b>showAngularErrorDialog</b></span>
<a href="#showAngularErrorDialog"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>showAngularErrorDialog(data: <a href="../interfaces/AngularErrorDialogData.html" target="_self">AngularErrorDialogData</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="157"
class="link-to-prism">src/lib/error-handler.ts:157</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>data</td>
<td>
<code><a href="../interfaces/AngularErrorDialogData.html" target="_self" >AngularErrorDialogData</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="showOpenApiHttpResponseErrorDialog"></a>
<span class="name">
<span class="modifier">Protected</span>
<span ><b>showOpenApiHttpResponseErrorDialog</b></span>
<a href="#showOpenApiHttpResponseErrorDialog"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>showOpenApiHttpResponseErrorDialog(data: <a href="../interfaces/OpenApiHttpResponseErrorDialogData.html" target="_self">OpenApiHttpResponseErrorDialogData</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="151"
class="link-to-prism">src/lib/error-handler.ts:151</a></div>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>data</td>
<td>
<code><a href="../interfaces/OpenApiHttpResponseErrorDialogData.html" target="_self" >OpenApiHttpResponseErrorDialogData</a></code>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
</div>
<div class="io-description">
</div>
</td>
</tr>
</tbody>
</table>
</section>
<section data-compodoc="block-properties">
<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="injector"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Readonly</span>
<span ><b>injector</b></span>
<a href="#injector"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>inject(INJECTOR)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="64" class="link-to-prism">src/lib/error-handler.ts:64</a></div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="options"></a>
<span class="name">
<span class="modifier">Protected</span>
<span class="modifier">Readonly</span>
<span ><b>options</b></span>
<a href="#options"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/ErrorHandlerOptions.html" target="_self" >ErrorHandlerOptions</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(() => {
const options = inject(RXAP_ERROR_HANDLER_OPTIONS);
const environment = inject(RXAP_ENVIRONMENT);
const config = inject(ConfigService);
options.logErrors ??= true;
options.sentry ??= {};
options.sentry.showDialog ??= config.get('sentry.showDialog', false);
// enforce sentry showDialog to false in dev mode
options.sentry.showDialog = !isDevMode() && options.sentry.showDialog;
options.showDialog ??= IsNotReleaseVersion(environment);
options.sentry.dialogOptions ??= config.get('sentry.dialogOptions', {});
options.sentry.dialogOptions.user ??= {};
return options;
})()</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="49" class="link-to-prism">src/lib/error-handler.ts:49</a></div>
</td>
</tr>
</tbody>
</table>
</section>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { HttpErrorResponse } from '@angular/common/http';
import {
ErrorHandler,
inject,
Injectable,
InjectionToken,
INJECTOR,
isDevMode,
runInInjectionContext,
StaticProvider,
} from '@angular/core';
import { ConfigService } from '@rxap/config';
import {
IsNotReleaseVersion,
RXAP_ENVIRONMENT,
} from '@rxap/environment';
import { OpenApiHttpResponseError } from '@rxap/open-api';
import * as Sentry from '@sentry/angular';
import { AngularErrorDialogData } from './error/angular-error-dialog-data';
import { AngularErrorService } from './error/angular-error.service';
import { OpenApiHttpResponseErrorDialogData } from './open-api-http-response-error/open-api-http-response-error-dialog-data';
import { OpenApiHttpResponseErrorService } from './open-api-http-response-error/open-api-http-response-error.service';
import {
ExtractContextFromError,
ExtractError,
ExtractExtraFromError,
ExtractTagsFromError,
PrintError,
SimplifyHttpErrorResponse,
} from './utilities';
export interface ErrorHandlerOptions {
logErrors?: boolean;
showDialog?: boolean;
sentry?: {
showDialog?: boolean;
dialogOptions?: Sentry.ReportDialogOptions;
};
}
export const RXAP_ERROR_HANDLER_OPTIONS = new InjectionToken<ErrorHandlerOptions>('rxap-error-handler-options', {
providedIn: 'root',
factory: () => ({ logErrors: true }),
});
@Injectable()
export class RxapErrorHandler implements ErrorHandler {
protected readonly options: ErrorHandlerOptions = (() => {
const options = inject(RXAP_ERROR_HANDLER_OPTIONS);
const environment = inject(RXAP_ENVIRONMENT);
const config = inject(ConfigService);
options.logErrors ??= true;
options.sentry ??= {};
options.sentry.showDialog ??= config.get('sentry.showDialog', false);
// enforce sentry showDialog to false in dev mode
options.sentry.showDialog = !isDevMode() && options.sentry.showDialog;
options.showDialog ??= IsNotReleaseVersion(environment);
options.sentry.dialogOptions ??= config.get('sentry.dialogOptions', {});
options.sentry.dialogOptions.user ??= {};
return options;
})();
protected readonly injector = inject(INJECTOR);
/**
* Method called for every value captured through the ErrorHandler
*/
public handleError(errorCandidate: unknown): void {
let error = errorCandidate;
// Try to unwrap zone.js error.
// https://github.com/angular/angular/blob/master/packages/core/src/util/errors.ts
if (error && (error as { ngOriginalError: Error }).ngOriginalError) {
error = (error as { ngOriginalError: Error }).ngOriginalError;
}
const extractedError = ExtractError(error);
const contexts = ExtractContextFromError(error);
const extra = ExtractExtraFromError(error);
const tags = ExtractTagsFromError(error);
let eventId: string;
// Capture handled exception and send it to Sentry.
if (typeof extractedError === 'string') {
eventId = Sentry.captureMessage(extractedError, {
level: 'error',
contexts,
extra,
tags,
});
} else {
eventId = Sentry.captureException(extractedError, {
level: 'error',
contexts,
extra,
tags,
});
}
if (this.options.logErrors) {
PrintError(error);
}
if (this.options.sentry?.showDialog) {
if (!(error instanceof HttpErrorResponse)) {
Sentry.showReportDialog({
...(this.options.sentry.dialogOptions ?? {}),
eventId,
});
}
} else if (this.options.showDialog) {
const nonMessage = 'unsupported error type for angular error dialog';
const data: AngularErrorDialogData = {
message: nonMessage,
contexts,
extra,
tags,
};
if (typeof extractedError === 'string') {
data.message = extractedError;
} else if (!(extractedError instanceof HttpErrorResponse)) {
data.message = extractedError.message;
data.stack = extractedError.stack;
data.name = extractedError.name;
}
if (extractedError instanceof OpenApiHttpResponseError) {
this.showOpenApiHttpResponseErrorDialog({
...data,
...SimplifyHttpErrorResponse(extractedError.httpErrorResponse),
timestamp: Date.now(),
metadata: extractedError.metadata,
method: !extractedError.metadata.operation || typeof extractedError.metadata.operation === 'string' ? 'unknown' : extractedError.metadata.operation.method,
operationId: extractedError.operationId,
serverId: extractedError.serverId
});
} else {
if (data.message !== nonMessage) {
this.showAngularErrorDialog(data);
}
}
}
}
protected showOpenApiHttpResponseErrorDialog(data: OpenApiHttpResponseErrorDialogData): void {
runInInjectionContext(this.injector, () => {
inject(OpenApiHttpResponseErrorService).push(data);
});
}
protected showAngularErrorDialog(data: AngularErrorDialogData): void {
runInInjectionContext(this.injector, () => {
inject(AngularErrorService).push(data);
});
}
}
export function ProvideErrorHandler(): StaticProvider {
return {
provide: ErrorHandler,
useClass: RxapErrorHandler,
};
}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable';
var COMPODOC_CURRENT_PAGE_URL = 'RxapErrorHandler.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>