resilient-http-client
Version:
This is an augmented [Angular HttpClient][angular-http-client] which overrides the get method to enrich resilience behaviour.
470 lines (403 loc) • 19.4 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>resilient-http-client</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">resilient-http-client</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 miscellaneous-variables">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Miscellaneous</li>
<li class="breadcrumb-item">Variables</li>
</ol>
<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">
<ul class="index-list">
<li>
<a href="#applyResilience" title="projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.ts" ><b>applyResilience</b> (projects/.../resilience.rx-operator.ts)</a>
</li>
<li>
<a href="#DEFAULT_RESILIENCE_CONFIG" title="projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.config.ts" ><b>DEFAULT_RESILIENCE_CONFIG</b> (projects/.../resilience.rx-operator.config.ts)</a>
</li>
<li>
<a href="#getTopicSpecificBooleanOrDefault" title="projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.ts" ><b>getTopicSpecificBooleanOrDefault</b> (projects/.../resilience.rx-operator.ts)</a>
</li>
<li>
<a href="#isRetryDisabled" title="projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.ts" ><b>isRetryDisabled</b> (projects/.../resilience.rx-operator.ts)</a>
</li>
<li>
<a href="#shouldLogResult" title="projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.ts" ><b>shouldLogResult</b> (projects/.../resilience.rx-operator.ts)</a>
</li>
<li>
<a href="#shouldTrace" title="projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.ts" ><b>shouldTrace</b> (projects/.../resilience.rx-operator.ts)</a>
</li>
<li>
<a href="#waitForUserDecision" title="projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.ts" ><b>waitForUserDecision</b> (projects/.../resilience.rx-operator.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.ts</h3>
<section data-compodoc="block-properties">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="applyResilience"></a>
<span class="name">
<span ><b>applyResilience</b></span>
<a href="#applyResilience"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code><T>(config: IResilienceConfig, uuid: string): MonoTypeOperatorFunction<T> => {
const userRetryOrCancelSubject = new Subject<boolean>();
let retryCount = 0;
return retry<T>({
delay: (error) =>
of(error).pipe(
concatMap((err) => {
if (isRetryDisabled(config) || !config.retryOnStatusCodeList.includes(err.status)) {
const topicSpecificMessageOrEmpty = config.topicToConfigDict[config.topic]?.failMessage || '';
config.onFail(config.topic, uuid, topicSpecificMessageOrEmpty);
throw err;
}
retryCount = retryCount + 1;
const retries = retryCount;
if (retryCount <= config.retryIntervalInMillisList.length) {
return of(err).pipe(
tap(() =>
config.onRequestRetry(
config.topic,
uuid,
retries,
config.retryIntervalInMillisList[retries - 1],
err.status,
),
),
delay(config.retryIntervalInMillisList[retryCount - 1]),
);
} else {
retryCount = 0;
if (waitForUserDecision(config)) {
config.onWaitingForUserDecision(
config.topic,
uuid,
retries,
err.status,
userRetryOrCancelSubject,
);
return userRetryOrCancelSubject.asObservable().pipe(
take(1),
map((shouldRetry) => {
if (shouldRetry) {
config.onRequestRetry(
config.topic,
uuid,
retries,
config.retryIntervalInMillisList[retries - 1],
err.status,
);
return of(err);
}
const topicSpecificMessageOrEmpty =
config.topicToConfigDict[config.topic]?.failMessage || '';
config.onFail(config.topic, uuid, topicSpecificMessageOrEmpty);
throw err;
}),
);
} else {
const topicSpecificMessageOrEmpty =
config.topicToConfigDict[config.topic]?.failMessage || '';
config.onFail(config.topic, uuid, topicSpecificMessageOrEmpty);
throw err;
}
}
}),
),
});
}</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getTopicSpecificBooleanOrDefault"></a>
<span class="name">
<span ><b>getTopicSpecificBooleanOrDefault</b></span>
<a href="#getTopicSpecificBooleanOrDefault"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(config: IResilienceConfig, propertyName: TTopicPropName): boolean => {
const topicConfig = config.topicToConfigDict[config.topic];
const isDefinedByTopicConfig = topicConfig && topicConfig[propertyName] !== undefined;
return isDefinedByTopicConfig ? (topicConfig[propertyName] as boolean) : config[propertyName];
}</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isRetryDisabled"></a>
<span class="name">
<span ><b>isRetryDisabled</b></span>
<a href="#isRetryDisabled"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(config: IResilienceConfig): boolean =>
getTopicSpecificBooleanOrDefault(config, 'disableRetry')</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="shouldLogResult"></a>
<span class="name">
<span ><b>shouldLogResult</b></span>
<a href="#shouldLogResult"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(config: IResilienceConfig): boolean =>
getTopicSpecificBooleanOrDefault(config, 'logResult')</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="shouldTrace"></a>
<span class="name">
<span ><b>shouldTrace</b></span>
<a href="#shouldTrace"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(config: IResilienceConfig): boolean => getTopicSpecificBooleanOrDefault(config, 'trace')</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="waitForUserDecision"></a>
<span class="name">
<span ><b>waitForUserDecision</b></span>
<a href="#waitForUserDecision"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(config: IResilienceConfig): boolean =>
getTopicSpecificBooleanOrDefault(config, 'waitForUserDecision')</code>
</td>
</tr>
</tbody>
</table>
</section>
<h3>projects/resilient-http-client/src/lib/util/rx/resilience.rx-operator.config.ts</h3>
<section data-compodoc="block-properties">
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="DEFAULT_RESILIENCE_CONFIG"></a>
<span class="name">
<span ><b>DEFAULT_RESILIENCE_CONFIG</b></span>
<a href="#DEFAULT_RESILIENCE_CONFIG"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/IResilienceConfig.html" target="_self" >Partial<IResilienceConfig></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>{
isDelayedAfterMs: 3000,
disableRetry: false,
logResult: false,
trace: false,
waitForUserDecision: false,
retryOnStatusCodeList: [
HttpStatusCode.RequestTimeout,
HttpStatusCode.TooManyRequests,
HttpStatusCode.InternalServerError,
HttpStatusCode.BadGateway,
HttpStatusCode.ServiceUnavailable,
HttpStatusCode.GatewayTimeout,
],
retryIntervalInMillisList: [0, 200, 500, 1000, 1000],
topicToConfigDict: {},
onWaitingForUserDecision: (): void => {},
onFail: (): void => {},
onRequestDelayed: (): void => {},
onRequestRetry: (): void => {},
onRequestStart: (): void => {},
onRequestFinalize: (): void => {},
}</code>
</td>
</tr>
</tbody>
</table>
</section>
</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 = 'miscellaneous-variables';
var COMPODOC_CURRENT_PAGE_URL = 'variables.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/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>