https://github.com/nflaig/loopback4-cosmosdb-retry
LoopBack 4 Azure Cosmos DB data source retry mixin
https://github.com/nflaig/loopback4-cosmosdb-retry
cosmosdb datasource loopback-4 mixin retry
Last synced: over 1 year ago
JSON representation
LoopBack 4 Azure Cosmos DB data source retry mixin
- Host: GitHub
- URL: https://github.com/nflaig/loopback4-cosmosdb-retry
- Owner: nflaig
- License: mit
- Created: 2020-09-05T12:30:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T13:51:40.000Z (about 2 years ago)
- Last Synced: 2025-03-24T10:11:52.315Z (over 1 year ago)
- Topics: cosmosdb, datasource, loopback-4, mixin, retry
- Language: TypeScript
- Homepage:
- Size: 654 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# loopback4-cosmosdb-retry
[![Actions Status][build-badge]][actions]
[![Coverage Status][coveralls-badge]][coveralls]
[![Latest version][npm-version-badge]][npm-package]
[![License][license-badge]][license]
[![Downloads][npm-downloads-badge]][npm-package]
[![Total Downloads][npm-total-downloads-badge]][npm-package]
LoopBack 4 data source mixin to handle database operation retries in case of Azure Cosmos DB request
limit errors caused by exceeding the available [Request Units][request-units].
## Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Debug](#debug)
- [Related resources](#related-resources)
- [Contributing](#contributing)
- [License](#license)
## Prerequisites
Some dependencies need to be installed as peer dependencies
```shell
@loopback/repository
```
## Installation
```shell
npm install loopback4-cosmosdb-retry
```
## Usage
The mixin just needs to added to the data source
```ts
import { juggler } from "@loopback/repository";
import { RetryMixin } from "loopback4-cosmosdb-retry";
class CosmosdbDataSource extends RetryMixin(juggler.DataSource) {}
```
## Configuration
The [default values][default-values] can be directly overwritten in the data source class
```ts
class CosmosdbDataSource extends RetryMixin(juggler.DataSource) {
constructor(args) {
super(args);
// do 19 retries after the first request (default: 9)
this.maxRetries = 19;
// default delay if no suggested delay is in error response (default: 1000)
this.retryAfterInMs = 2000;
// additional delay to add to the suggested delay in error response (default: 0)
this.retryAfterPaddingInMs = 200;
// always use fixed retry interval based on retryAfterInMs (default: false)
this.useFixedRetryInterval = false;
}
}
```
or by using environment variables
> .env
```sh
MAX_RETRIES=19
RETRY_AFTER_IN_MS=2000
RETRY_AFTER_PADDING_IN_MS=200
USE_FIXED_RETRY_INTERVAL=false
```
**Note:** The values you are setting directly in your code will have precedence over the environment variables.
If you want to be able to set values in your code while also having the options to overwrite with environment variables
you need to manually handle this.
```ts
// ...
constructor(args) {
super(args);
this.maxRetries = Number(process.env.MAX_RETRIES) ?? 19;
}
// ...
```
## Debug
To enable debug logs set the `DEBUG` environment variable to `loopback:cosmosdb-retry`, see
[Setting debug strings][lb4-debug-strings] for further details.
## Related resources
- [LoopBack 4 Mixins][lb4-mixins]
- [Request Units in Azure Cosmos DB][request-units]
## Contributing
[![contributions welcome][contributions-welcome-badge]][issues]
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.
[actions]: https://github.com/nflaig/loopback4-cosmosdb-retry/actions
[license]: https://github.com/nflaig/loopback4-cosmosdb-retry/blob/master/LICENSE
[issues]: https://github.com/nflaig/loopback4-cosmosdb-retry/issues
[coveralls]: https://coveralls.io/github/nflaig/loopback4-cosmosdb-retry?branch=refs/heads/master
[npm-package]: https://www.npmjs.com/package/loopback4-cosmosdb-retry
[build-badge]: https://github.com/nflaig/loopback4-cosmosdb-retry/workflows/build/badge.svg
[coveralls-badge]: https://coveralls.io/repos/github/nflaig/loopback4-cosmosdb-retry/badge.svg?branch=refs/heads/master
[npm-version-badge]: https://img.shields.io/npm/v/loopback4-cosmosdb-retry.svg?style=flat-square
[npm-downloads-badge]: https://img.shields.io/npm/dw/loopback4-cosmosdb-retry.svg?label=Downloads&style=flat-square&color=blue
[npm-total-downloads-badge]: https://img.shields.io/npm/dt/loopback4-cosmosdb-retry.svg?label=Total%20Downloads&style=flat-square&color=blue
[license-badge]: https://img.shields.io/github/license/nflaig/loopback4-cosmosdb-retry.svg?color=blue&label=License&style=flat-square
[contributions-welcome-badge]: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
[request-units]: http://aka.ms/cosmosdb-error-429
[lb4-mixins]: https://loopback.io/doc/en/lb4/Mixin.html
[lb4-debug-strings]: https://loopback.io/doc/en/lb4/Setting-debug-strings.html
[default-values]: https://github.com/nflaig/loopback4-cosmosdb-retry/blob/master/src/retry.ts#L4