SlidingWindowCounter spec completed, some functionality copied over from token bucket

[jondeweydev]

Summary

Just like the title says, this is just a spec layout of the functionality to come.

Type of Change

• New feature (non-breaking change which adds functionality)

Issues

closes #68

[evanmcneely]

You created interface RedisWindow which looks the same as the interface RedisBucket. Any reason you can't use RedisBucket?

[evanmcneely]

Or rename RedisBucket to a name that works for both buckets and windows?

[jondeweydev]

going to add more values in the future to track the rolling and fixed window timestamps

[shalarewicz]

In that case the new type should extend RedisBucket to keep things DRY.

At a higher level, what data does Redis need to track? My understanding is the complexity of all requests in the previous window along with the complexity of all requests in the current window. In each case the timestamp could just represent the beginning of the window. I don't think we need to track the timestamp of each request in Redis.

If we don't need anything else then for each user we just need to store two RedisBuckets either under to separate keys or both as an array. In the latter case then we would just need to type something as [RedisBucket, RedisBucket]

Thoughts?

[shalarewicz]

Discussed offline

[evanmcneely]

Approved pending the resolution of my one comment about the new interface created.

[shalarewicz]

Just want to discuss high-level approach before approving. See comments for more details

[shalarewicz]

In that case the new type should extend RedisBucket to keep things DRY.

At a higher level, what data does Redis need to track? My understanding is the complexity of all requests in the previous window along with the complexity of all requests in the current window. In each case the timestamp could just represent the beginning of the window. I don't think we need to track the timestamp of each request in Redis.

If we don't need anything else then for each user we just need to store two RedisBuckets either under to separate keys or both as an array. In the latter case then we would just need to type something as [RedisBucket, RedisBucket]

Thoughts?

[jondeweydev]

updated RedisWindow interface to include fixedWindowStart and currentTokens as well as previousTokens