Scala algorithm: Token Bucket Rate Limiter

Published

Algorithm goal

While similar to LeakyBucketRateLimiter, it works a bit differently, and is specifically useful as a network layer algorithm in order rate-limit packets:

Each packet consumes a number of tokens; tokens are added to the bucket at a particular rate, up to a limit and any overflow is discarded.If there are not enough tokens for a packet to consume, then the packet is discarded; otherwise it is passed on.

Design an algorithm to model this, in pure-functional immutable Scala.

Test cases in Scala

assert(
  sampleRefillRate.checkPossibleFills(java.time.Duration.ofSeconds(4)) ==
    None
)
assert(
  sampleRefillRate.checkPossibleFills(java.time.Duration.ofSeconds(5)) ==
    Some(5)
)
assert(
  sampleRefillRate.checkPossibleFills(java.time.Duration.ofSeconds(10)) ==
    Some(10)
)
assert(
  sampleRefillRate.checkPossibleFills(java.time.Duration.ofSeconds(11)) ==
    Some(10)
)
assert(
  sample.requestTokens(1).isEmpty,
  "Initially there is no capacity, so we cannot request anything"
)
assert(
  sample
    .maybeRefill(sampleStartTime.plusSeconds(4))
    .flatMap(_.requestTokens(1))
    .isEmpty,
  "After 4 seconds, we have not refilled, so we cannot request tokens"
)
assert(
  sample
    .maybeRefill(sampleStartTime.plusSeconds(5))
    .flatMap(_.requestTokens(1))
    .nonEmpty,
  "After 5 seconds, we have refilled, so we can request tokens"
)
assert(
  sample
    .maybeRefill(sampleStartTime.plusSeconds(5))
    .flatMap(_.requestTokens(6))
    .isEmpty,
  "After 5 seconds, we have only 5 tokens, so cannot request 6"
)
assert(
  sample
    .maybeRefill(sampleStartTime.plusSeconds(10))
    .flatMap(_.requestTokens(6))
    .nonEmpty,
  "After 10 seconds, we have 10 tokens, so can request 6"
)
assert(
  sample
    .maybeRefill(sampleStartTime.plusSeconds(10))
    .flatMap(_.requestTokens(6))
    .flatMap(_.requestTokens(4))
    .nonEmpty,
  "After 10 seconds, we have 10 tokens, so can request 6, and then 4"
)
assert(
  sample
    .maybeRefill(sampleStartTime.plusSeconds(10))
    .flatMap(_.requestTokens(6))
    .flatMap(_.requestTokens(4))
    .flatMap(_.requestTokens(1))
    .isEmpty,
  "After 10 seconds, we have 10 tokens, so can request 6, and then 4, but not 1 more"
)

Algorithm in Scala

41 lines of Scala (compatible versions 2.13 & 3.0).

Get the full algorithm Scala algorithms logo, maze part, which looks quirky!

or

'Unlimited Scala Algorithms' gives you access to all the 94 published & 6 upcoming Scala Algorithms (100 total)!

Upon purchase, you will be able to Register an account to access all the algorithms on multiple devices.

Stripe logo

Explanation

This solution was developed through test-driven development (TDD).

The token bucket is fully described by a combination of the rate, capacity and the time there was a last refill. (this is © from www.scala-algorithms.com)

Using immutable programming, it is even possible to have the rate and capacities vary across time very easily.

Scala concepts & Hints

  1. Drop, Take, dropRight, takeRight

    Scala's `drop` and `take` methods typically remove or select `n` items from a collection.

    assert(List(1, 2, 3).drop(2) == List(3))

assert(List(1, 2, 3).take(2) == List(1, 2))

assert(List(1, 2, 3).dropRight(2) == List(1))

assert(List(1, 2, 3).takeRight(2) == List(2, 3))

assert((1 to 5).take(2) == (1 to 2))

  2. Option Type

    The 'Option' type is used to describe a computation that either has a result or does not. In Scala, you can 'chain' Option processing, combine with lists and other data structures. For example, you can also turn a pattern-match into a function that return an Option, and vice-versa!

    assert(Option(1).flatMap(x => Option(x + 2)) == Option(3))

assert(Option(1).flatMap(x => None) == None)

Scala Algorithms: The most comprehensive library of algorithms in standard pure-functional Scala

How our 100 algorithms look

  1. A description/goal of the algorithm.
  2. An explanation with both Scala and logical parts.
  3. A proof or a derivation, where appropriate.
  4. Links to Scala concepts used in this specific algorithm, also unit-tested.
  5. An implementation in pure-functional immutable Scala, with efficiency in mind (for most algorithms, this is for paid subscribers only).
  6. Unit tests, with a button to run them immediately in our in-browser IDE.
Screenshot of an example algorithm demonstrating the listed features

Study our 100 Scala Algorithms: 6 fully free, 94 published & 6 upcoming

Fully unit-tested, with explanations and relevant concepts; new algorithms published about once a week.

  1. Compute the length of longest valid parentheses
  2. Check a binary tree is balanced
  3. Print a binary tree
  4. Remove duplicates from an unsorted List
  5. Make a queue using stacks (Lists in Scala)
  6. Find height of binary tree
  7. Single-elimination tournament tree
  8. Reverse Polish Notation calculator
  9. Quick Sort sorting algorithm in pure immutable Scala
  10. Maximum wait at a fuel station
  11. Find minimum missing positive number in a sequence
  12. Least-recently used cache (LRU)
  13. Count pairs of a given expected sum
  14. Binary heap (min-heap)
  15. Compute a Roman numeral for an Integer, and vice-versa
  16. Compute keypad possibilities
  17. Matching parentheses algorithm with foldLeft and a state machine
  18. Traverse a tree Breadth-First, immutably
  19. Read a matrix as a spiral
  20. Remove duplicates from a sorted list (state machine)
  21. Token Bucket Rate Limiter
  22. Leaky Bucket Rate Limiter
  23. Merge Sort: stack-safe, tail-recursive, in pure immutable Scala, N-way
  24. Longest increasing sub-sequence length
  25. Reverse first n elements of a queue
  26. Binary search a generic Array
  27. Game of Life
  28. Merge Sort: in pure immutable Scala
  29. Make a queue using Maps
  30. Is an Array a permutation?
  31. Count number of contiguous countries by colors
  32. Add numbers without using addition (plus sign)
  33. Tic Tac Toe MinMax solve
  34. Run-length encoding (RLE) Encoder
  35. Print Alphabet Diamond
  36. Find kth largest element in a List
  37. Balanced parentheses algorithm with tail-call recursion optimisation
  38. Reverse a String's words efficiently
  39. Count number of changes (manipulations) needed to make an anagram with an efficient foldLeft
  40. Count passing cars
  41. Count dist intersections
  42. Establish execution order from dependencies
  43. Counting inversions of a sequence (array) using a Merge Sort
  44. Longest common prefix of strings
  45. Check if an array is a palindrome
  46. Compute missing ranges
  47. Check a directed graph has a routing between two nodes (depth-first search)
  48. Compute nth row of Pascal's triangle
  49. Run-length encoding (RLE) Decoder
  50. Check if a number is a palindrome
  51. In a range of numbers, count the numbers divisible by a specific integer
  52. Compute minimum number of Fibonacci numbers to reach sum
  53. Find the longest palindrome within a string
  54. Find the index of a substring ('indexOf')
  55. Reshape a matrix
  56. Compute the steps to transform an anagram only using swaps
  57. Compute modulo of an exponent without exponentiation
  58. Closest pair of coordinates in a 2D plane
  59. Find the contiguous slice with the minimum average
  60. Compute maximum sum of subarray (Kadane's algorithm)
  61. Pure-functional double linked list
  62. Binary search in a rotated sorted array
  63. Check if a directed graph has cycles
  64. Rotate Array right in pure-functional Scala - using an unusual immutable efficient approach
  65. Check a binary tree is a search tree
  66. Length of the longest common substring
  67. Sliding Window Rate Limiter
  68. Tic Tac Toe board check
  69. Find an unpaired number in an array
  70. Check if a String is a palindrome
  71. Count binary gap size of a number using tail recursion
  72. Remove duplicates from a sorted list (Sliding)
  73. Monitor success rate of a process that may fail
  74. Least-recently used cache (MRU)
  75. Find sub-array with the maximum sum
  76. Find the minimum absolute difference of two partitions
  77. Find maximum potential profit from an array of stock price
  78. Fibonacci in purely functional immutable Scala
  79. Fizz Buzz in purely functional immutable Scala
  80. Find triplets that sum to a target ('3Sum')
  81. Find combinations adding up to N (non-unique)
  82. Find the minimum item in a rotated sorted array
  83. Make a binary search tree (Red-Black tree)
  84. Mars Rover
  85. Find combinations adding up to N (unique)
  86. Find indices of tuples that sum to a target (Two Sum)
  87. Count factors/divisors of an integer
  88. Compute single-digit sum of digits
  89. Fixed Window Rate Limiter
  90. Traverse a tree Depth-First
  91. Reverse bits of an integer
  92. Find k closest elements to a value in a sorted Array
  93. QuickSelect Selection Algorithm (kth smallest item/order statistic)
  94. Rotate a matrix by 90 degrees clockwise

Explore the 21 most useful Scala concepts

To save you going through various tutorials, we cherry-picked the most useful Scala concepts in a consistent form.

  1. Class Inside Class
  2. Class Inside Def
  3. Collect
  4. Def Inside Def
  5. Drop, Take, dropRight, takeRight
  6. foldLeft and foldRight
  7. For-comprehension
  8. Lazy List
  9. Option Type
  10. Ordering
  11. Partial Function
  12. Pattern Matching
  13. Range
  14. scanLeft and scanRight
  15. Sliding / Sliding Window
  16. Stack Safety
  17. State machine
  18. Tail Recursion
  19. Type Class
  20. View
  21. Zip

Subscribe to Scala Algorithms

Maximize your Scala with disciplined and consistently unit-tested solutions to 100+ algorithms.

Use it from improving your day-to-day data structures and Scala; all the way to interviewing.

'Unlimited Scala Algorithms' gives you access to all the 94 published & 6 upcoming Scala Algorithms (100 total)!

Upon purchase, you will be able to Register an account to access all the algorithms on multiple devices.

Stripe logo