# budgeteer

> Cost-based request rate limiter, scheduler, and deduplicator. Uses a Redis backend by default.

Latest version **0.1.1** (published 2017-09-22) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install budgeteer
pnpm add budgeteer
yarn add budgeteer
bun add budgeteer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2017-09-22 |
| First published | 2017-09-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Wikimedia Services Team |
| Maintainers | gwicke |
| Keywords | REST, API, Kafka, queuing, EventBus |

## Links

- npm: https://www.npmjs.com/package/budgeteer
- Repository: https://github.com/wikimedia/budgeteer
- Issues: https://phabricator.wikimedia.org/tag/services/
- npm.io page: https://npm.io/package/budgeteer

## Dependencies (2)

- [redis](https://npm.io/package/redis.md) ^2.7.1
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2017-09-22
- 0.1.0 — 2017-09-14

## README

# budgeteer
Cost-based event rate limiter, scheduler, and deduplicator. Uses a Redis
backend. Provides the "brain" of a simple job scheduling system.

Features:

- Event deduplication: Events that have already been processed, or are
    scheduled for delayed processing, are dropped.
- Cost based accounting, giving each key a token budget per day. Clients 
    are free to model costs any way they like. Typically, execution time (in
    seconds) is a major input into the cost function.
- Delay and retry scheduling: An execution delay is calculated once an event's
    budget turns negative. The delay is proportional to the time it takes to
    even out the budget, based on the `token_budget_per_day` configuration
    option.

## Usage example

```javascript
const budgeteer = new Budgeteer({ 
    store: {
        type: 'redis', // Default & only supported storage type so far.
        host: 'redishost', 
        port: 12345,
        ttl: 86400 * 7 // Store rate limiting / dedup information for 7 days
    }
});
const key = 'someName';

// Token budget configuration, typically differs per event type.
const token_budget = {
    tokens_per_day: 24, // Steady state token rate.
    max_balance: 36   // Maximum balance available for bursts, when a job is
                      // new or has not been executed in a long time.
};

return budgeteer.check(key, token_budget, req.startTime)
.then(res => {
    if (res.isDuplicate) {
        // Duplicate. Drop the event.
        return;
    }
    if (res.delay) {
        // add event to a (Kafka) delay queue, based on the suggested delay.
        return enqueueToDelayQueue(event, delay)
        // Redis read / write.
        .then(() => budgeteer.reportScheduled(key, token_budget, 0);
    } else {
        const startTime = Date.now();
        // execute event
        return process_event(event)
        // Redis read / write.
        .then(() => budgeteer.reportSuccess(key, token_budget, startTime, (Date.now() - startTime) / 1000))
        .catch(e => {
            // Time plus some failure penalty
            const cost = (Date.now() - startTime) / 1000 + 1;
            return budgeteer.check(key, token_budget, req.startTime, cost)
            .then(res => {
                if (!res.isDuplicate) {
                    // We choose to enforce a minimum retry delay of 200 seconds.
                    delay = Math.max(delay, 200);
                    return enqueueToDelayQueue(event, delay)
                    // Redis read / write.
                    .then(() => budgeteer.reportScheduled(key, token_budget, cost));
                }
            });
        })
    }
})
```

---
_Source: https://npm.io/package/budgeteer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._