Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix:allow to only override elevated limits but merging with original config #71

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,45 @@ overrides: {
}
```

We can also override the elevated_limits configuration:
```js
buckets = {
ip: {
size: 10,
per_second: 5,
overrides: {
'awesome-key': {
elevated_limits: {
size: 200,
per_second: 200,
}
}
}
}
}
```

If elevated_limits is provided within the override and no size, per_interval, or unlimited is overridden, limitd-redis
will copy them from the base bucket configuration. Thus, the configuration above after being processed will look like:
```js
buckets = {
ip: {
size: 10,
per_second: 5,
overrides: {
'awesome-key': {
size: 10,
per_second: 5,
elevated_limits: {
size: 200,
per_second: 200,
}
}
}
}
}
```

## ERL (Elevated Rate Limits)
### Prerequisites
Redis 6.2+ is required to use ERL.
Expand Down
22 changes: 18 additions & 4 deletions lib/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,7 @@ function normalizeType(params) {
override.match = new RegExp(overrideDef.match, 'i');
}

// If the override doesn't provide elevated_limits use the ones defined in the upper level (if any)
if (!override.elevated_limits && type.elevated_limits) {
override.elevated_limits = type.elevated_limits;
}
normalizeElevatedOverrides(type, override);

if (!override.until || override.until >= new Date()) {
if (override.match) {
Expand All @@ -100,6 +97,23 @@ function normalizeType(params) {
return type;
}

function normalizeElevatedOverrides(type, override) {
LeweyM marked this conversation as resolved.
Show resolved Hide resolved
// If the override doesn't provide elevated_limits use the ones defined in the upper level (if any)
LeweyM marked this conversation as resolved.
Show resolved Hide resolved
if (!override.elevated_limits) {
override.elevated_limits = type.elevated_limits;
return;
}

// If size, per_interval, and unlimited are undefined for the override, and it contains elevated_limits,
// copy the size, per_interval, and unlimited from the base type configuration.
if (typeof override.unlimited === 'undefined'
&& typeof override.size === 'undefined'
&& typeof override.per_interval === 'undefined') {
let { overrides, overridesMatch, ...baseType } = type;
Object.assign(override, baseType, {elevated_limits: override.elevated_limits})
}
}

/**
* Load the buckets configuration.
*
Expand Down
124 changes: 84 additions & 40 deletions test/utils.tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,52 +58,96 @@ describe('utils', () => {
expect(elevated_limits).to.be.undefined;
});


it('should add overrides', () => {
const bucket = {
size: 100,
per_second: 100,
elevated_limits: {
size: 200,
per_second: 200,
erl_activation_period_seconds: 300,
quota_per_calendar_month: 5
},
overrides: {
'127.0.0.1': {
describe('when overrides are provided', () => {
it('should add overrides', () => {
const bucket = {
size: 100,
per_second: 100,
elevated_limits: {
size: 200,
per_second: 200,
elevated_limits: {
size: 400,
per_second: 400,
erl_activation_period_seconds: 900,
quota_per_calendar_month: 10,
},
erl_activation_period_seconds: 300,
quota_per_calendar_month: 5
},
overrides: {
'127.0.0.1': {
size: 200,
per_second: 200,
elevated_limits: {
size: 400,
per_second: 400,
erl_activation_period_seconds: 900,
quota_per_calendar_month: 10,
},
}
}
}
};
const response = normalizeType(bucket);
const { elevated_limits, overrides, overridesMatch, overridesCache, ...rest } = response;
expect(overrides['127.0.0.1']).to.not.be.null;
expect(overrides['127.0.0.1']).excluding('drip_interval').excluding('elevated_limits').to.deep.equal({
size: 200,
interval: 1000,
per_interval: 200,
ttl: 1,
ms_per_interval: 0.2,
name: "127.0.0.1",
until: undefined
};
const response = normalizeType(bucket);
const { elevated_limits, overrides, overridesMatch, overridesCache, ...rest } = response;
expect(overrides['127.0.0.1']).to.not.be.null;
expect(overrides['127.0.0.1']).excluding('drip_interval').excluding('elevated_limits').to.deep.equal({
LeweyM marked this conversation as resolved.
Show resolved Hide resolved
size: 200,
interval: 1000,
per_interval: 200,
ttl: 1,
ms_per_interval: 0.2,
name: "127.0.0.1",
until: undefined
});
expect(overrides['127.0.0.1'].elevated_limits).excluding('drip_interval').to.deep.equal({
size: 400,
interval: 1000,
per_interval: 400,
ttl: 1,
ms_per_interval: 0.4,
erl_configured_for_bucket: true,
});
});
expect(overrides['127.0.0.1'].elevated_limits).excluding('drip_interval').to.deep.equal({
size: 400,
interval: 1000,
per_interval: 400,
ttl: 1,
ms_per_interval: 0.4,
erl_configured_for_bucket: true,



it('should allow to only override elevated_limits', () => {
const bucket = {
size: 100,
per_second: 100,
elevated_limits: {
size: 200,
per_second: 200,
},
overrides: {
'127.0.0.1': {
elevated_limits: {
size: 400,
per_second: 400,
},
}
}
};
const response = normalizeType(bucket);
const { elevated_limits, overrides, overridesMatch, overridesCache, ...rest } = response;
expect(overrides['127.0.0.1']).to.not.be.null;
expect(overrides['127.0.0.1']).excluding('drip_interval').excluding('elevated_limits').to.deep.equal({
LeweyM marked this conversation as resolved.
Show resolved Hide resolved
size: 100,
interval: 1000,
per_interval: 100,
ttl: 1,
ms_per_interval: 0.1,
name: "127.0.0.1",
until: undefined
});
expect(overrides['127.0.0.1'].elevated_limits).excluding('drip_interval').to.deep.equal({
size: 400,
interval: 1000,
per_interval: 400,
ttl: 1,
ms_per_interval: 0.4,
erl_configured_for_bucket: true,
});

});
});
});
})


describe('quotaExpiration', () => {
const tests = [{
Expand Down