rate_throttle_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a98e4aae0d6770a20d784d63888ac487ad537bc27c2cb00127498a4afd41fb20
+  data.tar.gz: 9c6b04db20202345cbe2c9995c09fbd3b1f79521e5c33d5337851f0c93455d5e
+SHA512:
+  metadata.gz: 5a32f254cb2c857c4e50cf83fdbece7e9c60c8031f9ffa1d5957e7778899e68e2ccc4565cf6a6cc96ef685a8af05681527de61ea7b0c80ac59077e904850b88a
+  data.tar.gz: 8a8e0cd1b0809ff00c51c2bd986e4f270a054c6ae1f99ef67ef2634b0e2cb8c659bb02727f9179c9767ad4bc22d3bd28f84333f559d140404b44ab93d0db3012

data/.circleci/config.yml

@@ -0,0 +1,81 @@
+version: 2
+references:
+  unit: &unit
+    run:
+      name: Run test suite
+      command: bundle exec rake
+  restore: &restore
+    restore_cache:
+      keys:
+        - v1-dependencies-{{ checksum "Gemfile.lock" }}
+        # fallback to using the latest cache if no exact match is found
+        - v1-dependencies-
+  bundle: &bundle
+    run:
+      name: install dependencies
+      command: |
+        bundle install --jobs=4 --retry=3 --path vendor/bundle
+  save: &save
+    save_cache:
+      paths:
+        - ./vendor/bundle
+      key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+jobs:
+  "ruby-2.3":
+    docker:
+      - image: circleci/ruby:2.5
+    steps:
+      - checkout
+      - <<: *bundle
+      - <<: *save
+      - <<: *unit
+  "ruby-2.4":
+    docker:
+      - image: circleci/ruby:2.5
+    steps:
+      - checkout
+      - <<: *bundle
+      - <<: *save
+      - <<: *unit
+  "ruby-2.5":
+    docker:
+      - image: circleci/ruby:2.5
+    steps:
+      - checkout
+      - <<: *bundle
+      - <<: *save
+      - <<: *unit
+  "ruby-2.6":
+    docker:
+      - image: circleci/ruby:2.6
+    steps:
+      - checkout
+      - <<: *bundle
+      - <<: *save
+      - <<: *unit
+  "ruby-2.7":
+    docker:
+      - image: circleci/ruby:2.7
+    steps:
+      - checkout
+      - <<: *bundle
+      - <<: *save
+      - <<: *unit
+  "jruby":
+    docker:
+      - image: circleci/jruby:latest
+    steps:
+      - checkout
+      - <<: *bundle
+      - <<: *save
+      - <<: *unit
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - "ruby-2.3"
+      - "ruby-2.4"
+      - "ruby-2.5"
+      - "ruby-2.6"
+      - "ruby-2.7"

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,10 @@
+name: Check Changelog
+on: [pull_request]
+jobs:
+ build:
+   runs-on: ubuntu-latest
+   steps:
+   - uses: actions/checkout@v1
+   - name: Check that CHANGELOG is touched
+     run: |
+       cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+logs/*/**

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Master (Unreleased)
+
+## 0.1.0
+
+- First

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at richard.schneeman+foo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rate_throttle_client.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 schneems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,156 @@
+# RateThrottleClient
+
+Rate limiting is for servers, rate throttling is for clients. This library implements a number of strategies for handling rate throttling on the client and a methodology for comparing performance of those clients in simulated environments. Essentially, we don't just give you the code to rate throttle, we also give you the information to help you figure out the best strategy to rate throttle as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rate_throttle_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rate_throttle_client
+
+## Usage
+
+Wrap requests to an API endpoint using one of the provided rate throttling classes:
+
+```ruby
+throttle = RateThrottleClient::ExponentialIncreaseProportionalRemainingDecrease.new
+
+response = throttle.call do
+  Excon.get("https://api.example.com")
+end
+```
+
+If the server returns a `429` status (the HTTP code indicating that a server side rate limit has been reached) then the request will be retried according to the classes' strategy.
+
+If you're not using Excon to build your API client, then you'll need to make sure the object returned to the block responds to `status` (returning the status code) and a `headers` method.
+
+### Config
+
+```ruby
+RateThrottleClient.config do |config|
+  config.log_block = ->(info){ puts "I get called when rate limiting is triggered #{info.sleep_for} #{info.request}" }
+  config.max_limit = 4500.to_f # Maximum number of requests per hour
+  config.multiplier = 1.2 # When rate limiting happens, this is amount to the sleep value is increased by
+end
+```
+
+## Strategies
+
+This library has a few strategies you can choose between:
+
+- RateThrottleClient::ExponentialBackoff
+- RateThrottleClient::ExponentialIncreaseGradualDecrease
+- RateThrottleClient::ExponentialIncreaseProportionalDecrease
+- RateThrottleClient::ExponentialIncreaseProportionalRemainingDecrease
+
+To choose, you need to understand what makes a "good" throttling algorithm, and then you need some benchmarks.
+
+## What Makes a Good Rate Throttle strategy?
+
+- Minimize retry ratio: For example if every 50 successful requests, the client hits a rate limited request the ratio of retries is 1/50 or 2%. Why minimize this value? It takes CPU and Network resources to make requests that fail, if the client is making requests that are being limited, it's using resources that could be better spent somewhere else. The server also benefits as it spends less time dealing with rate limiting.
+- Minimize standard deviation of request count across the system: If there are two clients and one client is throttling by sleeping for 100 seconds and the other is throttling for 1 second, the distribution of requests are not equitable. Ideally over time each client might go up or down, but both would see a median of 50 seconds of sleep time. Why? If processes in a system have a high variance, one process is starved for API resources. It then becomes difficult to balance or optimize otherworkloads. When a client is stuck waiting on the API, ideally it can perform other operations (for example in other threads). If one process is using 100% of CPU and slamming the API and other is using 1% of CPU and barely touching the API, it is difficult to balance the workloads.
+- Minimize sleep/wait time: Retry ratio can be improved artificially by choosing high sleep times. In the real world consumers don't want to wait longer than absolutely necessarry. While a client might be able to "work steal" while it is sleeping/waiting, there's not guarantee that's the case. Essentially assume that any amount of time spent sleeping over the minimum amount of time required is wasted. This value is calculateable, but that calculation requires complete information of the distributed system.
+  - At high workload it should be able to consume all available requests: If a server allows 100,000 requests in a day then a client should be capable of making 100,000 requests. If the rate limiting algorithm only allows it to make 100 requests it would have low retry ratio but high wait time.
+  - Handle a change in work load to either slow down or speed up rate throttling: If the workload is light, then clients should not wait/sleep much. If workload is heavy, then clients should sleep/wait enough. The algorithm should adjust to a changing workload as quickly as possible.
+
+## Benchmarks
+
+These benchmarks are generated by running `rake bench` against the simulated "GCRA" rate limiting server. Which throttle strategy you use depends on your needs.
+
+**Lower values are better**
+
+### RateThrottleClient::ExponentialBackoff results (duration: 30.0 minutes, multiplier: 1.2)
+
+```
+Avg retry rate:      80.41 %
+Max sleep time:      46.72 seconds
+Stdev Request Count: 147.84
+
+Raw max_sleep_vals: [46.72, 46.72, 46.72, 46.72, 46.72, 46.50, 46.50, 46.50, 46.50, 46.50]
+Raw retry_ratios: [0.79, 0.79, 0.81, 0.82, 0.80, 0.80, 0.79, 0.81, 0.82, 0.81]
+Raw request_counts: [1317.00, 1314.00, 1015.00, 963.00, 1254.00, 1133.00, 1334.00, 1025.00, 1024.00, 1036.00]
+```
+
+```
+Time to clear workload (4500 requests, starting_sleep: 1s):
+76.18 seconds
+```
+
+### RateThrottleClient::ExponentialIncreaseGradualDecrease results (duration: 30.0 minutes, multiplier: 1.2)
+
+```
+Avg retry rate:      40.56 %
+Max sleep time:      139.91 seconds
+Stdev Request Count: 867.73
+
+Raw max_sleep_vals: [110.25, 110.25, 110.25, 110.25, 110.25, 139.91, 139.91, 139.91, 139.91, 139.91]
+Raw retry_ratios: [0.46, 0.37, 0.38, 0.37, 0.39, 0.40, 0.41, 0.35, 0.37, 0.57]
+Raw request_counts: [48.00, 57.00, 56.00, 49.00, 282.00, 85.00, 83.00, 79.00, 2821.00, 37.00]
+```
+
+```
+Time to clear workload (4500 requests, starting_sleep: 1s):
+65.50 seconds
+```
+
+### RateThrottleClient::ExponentialIncreaseProportionalDecrease results (duration: 30.0 minutes, multiplier: 1.2)
+
+```
+Avg retry rate:      3.66 %
+Max sleep time:      17.31 seconds
+Stdev Request Count: 101.94
+
+Raw max_sleep_vals: [17.31, 17.31, 17.31, 17.31, 17.31, 17.21, 17.21, 17.21, 17.21, 17.21]
+Raw retry_ratios: [0.01, 0.07, 0.03, 0.05, 0.06, 0.01, 0.07, 0.01, 0.03, 0.03]
+Raw request_counts: [343.00, 123.00, 223.00, 144.00, 128.00, 348.00, 116.00, 383.00, 194.00, 203.00]
+```
+
+```
+Time to clear workload (4500 requests, starting_sleep: 1s):
+489.24 seconds
+```
+
+### RateThrottleClient::ExponentialIncreaseProportionalRemainingDecrease results (duration: 30.0 minutes, multiplier: 1.2)
+
+```
+Avg retry rate:      3.07 %
+Max sleep time:      17.32 seconds
+Stdev Request Count: 78.44
+
+Raw max_sleep_vals: [12.14, 12.14, 12.14, 12.14, 12.14, 17.32, 17.32, 17.32, 17.32, 17.32]
+Raw retry_ratios: [0.03, 0.02, 0.01, 0.02, 0.03, 0.03, 0.02, 0.05, 0.04, 0.07]
+Raw request_counts: [196.00, 269.00, 386.00, 302.00, 239.00, 197.00, 265.00, 150.00, 187.00, 118.00]
+```
+
+```
+Time to clear workload (4500 requests, starting_sleep: 1s):
+66.92 seconds
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rate_throttle_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rate_throttle_client/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RateThrottleClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rate_throttle_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,58 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "rate_throttle_client"
+require 'rate_throttle_client/demo'
+
+RateThrottleClient.config do |config|
+  config.log_block = ->(info){ }
+end
+
+MINUTE = 60
+task :bench do
+  duration = 30 * MINUTE
+  clients = [
+    RateThrottleClient::ExponentialBackoff,
+    RateThrottleClient::ExponentialIncreaseGradualDecrease,
+    RateThrottleClient::ExponentialIncreaseProportionalDecrease,
+    RateThrottleClient::ExponentialIncreaseProportionalRemainingDecrease
+  ]
+  clients.each do |klass|
+    begin
+      client = klass.new
+      demo = RateThrottleClient::Demo.new(client: client, duration: duration, time_scale: 10)
+      demo.call
+    ensure
+      demo.print_results
+    end
+
+    begin
+      workload = 4500
+      starting_sleep = 1
+      before_time = Time.now
+      rackup_file = Pathname.new(__dir__).join("lib/rate_throttle_client/servers/decrease_only/config.ru")
+
+      client = klass.new(starting_sleep_for: starting_sleep)
+      demo = RateThrottleClient::Demo.new(client: client, time_scale: 10, starting_limit: 4500, duration: duration, remaining_stop_under: 10, rackup_file: rackup_file)
+      demo.call
+      diff = Time.now - before_time
+    ensure
+      puts
+      puts "```"
+      puts "Time to clear workload (#{workload} requests, starting_sleep: #{starting_sleep}s):"
+      puts "#{"%.2f" % diff} seconds"
+      puts "```"
+      puts
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rate_throttle_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rate_throttle_client.rb

@@ -0,0 +1,22 @@
+require "rate_throttle_client/version"
+require "rate_throttle_client/info"
+
+require 'thread'
+
+module RateThrottleClient
+  class Error < StandardError; end
+  class << self
+    attr_accessor :multiplier, :min_sleep, :max_limit, :log_block
+  end
+  self.log_block = ->(info) { puts "RateThrottleClient: sleep_for=#{info.sleep_for}" }
+  self.max_limit = 4500.to_f
+  self.min_sleep = 3600/max_limit
+  self.multiplier = 1.2
+
+  def self.config
+    yield self
+  end
+end
+
+require_relative 'rate_throttle_client/clients/base.rb'
+Dir[File.dirname(__FILE__) + '/rate_throttle_client/clients/*.rb'].each { |file| require file }

data/lib/rate_throttle_client/clients/base.rb

@@ -0,0 +1,18 @@
+module RateThrottleClient
+  # Standard interface for Client classes
+  # Don't abuse this power
+  class Base
+    attr_accessor :log, :min_sleep, :multiplier, :sleep_for
+
+    def initialize(log: nil, min_sleep: nil, starting_sleep_for: 0, multiplier: nil)
+      @log = log || RateThrottleClient.log_block
+      @min_sleep = min_sleep || RateThrottleClient.min_sleep
+      @multiplier = multiplier || RateThrottleClient.multiplier
+      @sleep_for = starting_sleep_for
+    end
+
+    def jitter(val)
+      val * rand(0.0..0.1)
+    end
+  end
+end

data/lib/rate_throttle_client/clients/exponential_backoff.rb

@@ -0,0 +1,26 @@
+module RateThrottleClient
+  # Actual exponential backoff class with some extra jazz so it reports
+  # when sleep goes back to zero
+  #
+  # Essentially it doesn't throttle at all until it hits a 429 then it exponentially
+  # throttles every repeatedly limited request. When it hits a successful request it stops
+  # rate throttling again.
+  class ExponentialBackoff < Base
+    def call(&block)
+      sleep_for = @min_sleep
+
+      while (req = yield) && req.status == 429
+        @log.call(Info.new(sleep_for: sleep_for, request: req))
+        sleep(sleep_for + jitter(sleep_for))
+
+        sleep_for *= @multiplier
+      end
+
+      # This no-op is needed to record that we've come out of a
+      # retry state for the Demo class.
+      sleep(0)
+
+      req
+    end
+  end
+end

data/lib/rate_throttle_client/clients/exponential_increase_gradual_decrease.rb

@@ -0,0 +1,34 @@
+module RateThrottleClient
+  class ExponentialIncreaseGradualDecrease < Base
+    attr_accessor :decrease
+
+    def initialize(*args, decrease: nil, **kargs)
+      super(*args, **kargs)
+      @decrease = decrease || @min_sleep
+    end
+
+    def call(&block)
+      sleep_for = @sleep_for
+      sleep(sleep_for + jitter(sleep_for))
+
+      while (req = yield) && req.status == 429
+        sleep_for += @min_sleep
+
+        @log.call(Info.new(sleep_for: sleep_for, request: req))
+        sleep(sleep_for + jitter(sleep_for))
+
+        sleep_for *= @multiplier
+      end
+
+      if sleep_for >= @decrease
+        sleep_for -= @decrease
+      else
+        sleep_for = 0
+      end
+
+      @sleep_for = sleep_for
+
+      req
+    end
+  end
+end

data/lib/rate_throttle_client/clients/exponential_increase_proportional_decrease.rb

@@ -0,0 +1,36 @@
+module RateThrottleClient
+  class ExponentialIncreaseProportionalDecrease < Base
+    attr_accessor :decrease_divisor
+
+    def initialize(*args, decrease_divisor: nil, **kargs)
+      super(*args, **kargs)
+      @decrease_divisor = (decrease_divisor || RateThrottleClient.max_limit).to_f
+    end
+
+    def call(&block)
+      sleep_for = @sleep_for
+      sleep(sleep_for + jitter(sleep_for))
+
+      while (req = yield) && req.status == 429
+        sleep_for += @min_sleep
+
+        @log.call(Info.new(sleep_for: sleep_for, request: req))
+        sleep(sleep_for + jitter(sleep_for))
+
+        sleep_for *= @multiplier
+      end
+
+      decrease_value = sleep_for / @decrease_divisor
+
+      if sleep_for >= decrease_value
+        sleep_for -= decrease_value
+      else
+        sleep_for = 0
+      end
+
+      @sleep_for = sleep_for
+
+      req
+    end
+  end
+end

data/lib/rate_throttle_client/clients/exponential_increase_proportional_remaining_decrease.rb

@@ -0,0 +1,43 @@
+module RateThrottleClient
+  class ExponentialIncreaseProportionalRemainingDecrease < Base
+    attr_accessor :decrease_divisor, :remaining_block
+
+    def initialize(*args, decrease_divisor: nil, remaining_block: nil, **kargs)
+      super(*args, **kargs)
+      @decrease_divisor = (decrease_divisor || RateThrottleClient.max_limit).to_f
+      @remaining_block = remaining_block || ->(req) {
+        req.headers["RateLimit-Remaining"].to_i
+      }
+    end
+
+    def call(&block)
+      sleep_for = @sleep_for
+      sleep(sleep_for + jitter(sleep_for))
+
+      while (req = yield) && req.status == 429
+        sleep_for += @min_sleep
+
+        @log.call(Info.new(sleep_for: sleep_for, request: req))
+        sleep(sleep_for + jitter(sleep_for))
+
+        sleep_for *= @multiplier
+      end
+
+      decrease_value = sleep_for * @remaining_block.call(req)
+      decrease_value /= @decrease_divisor
+
+      if sleep_for >= decrease_value
+        sleep_for -= decrease_value
+      else
+        sleep_for = 0
+      end
+
+      @sleep_for = sleep_for
+
+      req
+    end
+
+    def sleep_and_log(sleep_for: , request: )
+    end
+  end
+end

data/lib/rate_throttle_client/clients/null.rb

@@ -0,0 +1,11 @@
+module RateThrottleClient
+  class Null < Base
+    def initialize(*_, **_)
+    end
+
+    def call
+      yield
+    end
+  end
+end
+

data/lib/rate_throttle_client/demo.rb

@@ -0,0 +1,292 @@
+require 'excon'
+require 'pathname'
+require 'fileutils'
+require 'date'
+require 'json'
+require 'timecop'
+require 'wait_for_it'
+require 'enumerable/statistics'
+
+Thread.abort_on_exception = true
+
+# A class for simulating or "demoing" a rate throttle client
+#
+# Example:
+#
+#   duration = 3600 # seconds in one hour
+#   client = ExponentialIncreaseSleepAndRemainingDecrease.new
+#   demo = RateThrottleDemo.new(client: client, stream_requests: true, duration: duration)
+#   demo.call
+#   demo.print_results
+#     # => max_sleep_val: [59.05, 80.58, 80.58, 80.58, 56.18, 56.18, 56.18, 59.05, 70.05, 70.05, 70.05, 59.15, 59.15, 59.15, 59.15, 70.05, 70.05, 59.15, 56.18, 80.58, 80.58, 59.05, 59.05, 59.05, 56.18]
+#     # => retry_ratio: [0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.02, 0.01, 0.01, 0.01, 0.00, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01]
+#     # => request_count: [3321.00, 1551.00, 2167.00, 2197.00, 1628.00, 1709.00, 1484.00, 3512.00, 1722.00, 2816.00, 3182.00, 2137.00, 4398.00, 2154.00, 2418.00, 2868.00, 2492.00, 2982.00, 1731.00, 2278.00, 1988.00, 4221.00, 3160.00, 2927.00, 2635.00]
+#
+# Arguments:
+#
+# Thread count can be controlled via the `thread_count` arguement, or the THREAD_COUNT env var (default is below).
+# Process count can be controlled via the `process_count` arguement, or the PROCESS_COUNT env var (default is below).
+# total number of clients is thread_count * process_count.
+#
+# Time scale can be controlled via the `time_scale` arguement, or the TIME_SCALE env var (default is below).
+# The time scale value will speed up the simulation, for example `TIME_SCALE=10` means a 60 second simulation
+# will complete in 6 minutes.
+#
+# The simulation will stop after `duration:` seconds.
+# Outputting request logs to stdout can be enabled/disabled by setting `stream_requests`.
+# The other way to stop a simulation is to specify `remaining_stop_under` when this value is set, the simulation
+# will stop when the "remaining" limit count from the server is under this value.
+#
+# The starting "remaining" limit count in the server can be set via passing in the `starting_limit`, default is 0
+# requests.
+#
+# Outputs:
+#
+# - Writes log outputs to stdout if `stream_requests` is true
+# - Writes aggregate metrics of each client to an intermediate json file every @json_duration seconds. This is then later used to
+#   produce the data for `print_results`
+# - Writes the last value the client slept for to a newline separated file every 1 (real time, not simulated) second. This is used to
+#   generate the charts using the `chart.rb` script.
+module RateThrottleClient
+  class Demo
+    MINUTE = 60
+    THREAD_COUNT = ENV.fetch("THREAD_COUNT") { 5 }.to_i
+    PROCESS_COUNT = ENV.fetch("PROCESS_COUNT") { 2 }.to_i
+    DURATION=ENV.fetch("DURATION") { 30 }.to_i * MINUTE #
+    TIME_SCALE = ENV.fetch("TIME_SCALE", 1).to_f
+    RACKUP_FILE = Pathname.new(__dir__).join("servers/gcra/config.ru")
+
+    attr_reader :log_dir, :rackup_file
+
+    def initialize(client:,thread_count: THREAD_COUNT, process_count: PROCESS_COUNT, duration: DURATION, log_dir: nil, time_scale: TIME_SCALE, stream_requests: false, json_duration: 30, rackup_file: RACKUP_FILE, starting_limit: 0, remaining_stop_under: nil)
+      @client = client
+      @thread_count = thread_count
+      @process_count = process_count
+      @duration = duration
+      @time_scale = time_scale.to_f
+      @stream_requests = stream_requests
+      @rackup_file = rackup_file
+      @starting_limit = starting_limit
+      @remaining_stop_under = remaining_stop_under
+
+      if log_dir
+        @log_dir = Pathname.new(log_dir)
+      else
+        @log_dir = Pathname.new(__dir__).join("../../logs/clients/#{Time.now.strftime('%Y-%m-%d-%H-%M-%s-%N')}-#{client.class}")
+      end
+
+      @mutex = Mutex.new
+      @json_duration = 30 # seconds
+      @port = UniquePort.call
+      @threads = []
+      @pids = []
+      Timecop.scale(@time_scale)
+
+      FileUtils.mkdir_p(@log_dir)
+    end
+
+    def print_results(io = STDOUT)
+      result_hash = self.results
+      io.puts
+      io.puts "### #{@client.class} results (duration: #{@duration/60.0} minutes, multiplier: #{@client.multiplier})"
+      io.puts
+      io.puts "```"
+      io.puts "Avg retry rate:      #{"%.2f" % (result_hash["retry_ratio"].mean * 100)} %"
+      io.puts "Max sleep time:      #{"%.2f" % result_hash["max_sleep_val"].max} seconds"
+      io.puts "Stdev Request Count: #{"%.2f" % result_hash["request_count"].stdev}"
+      io.puts
+      result_hash.each do |key, value|
+        io.puts "Raw #{key}s: [#{ value.map {|x| "%.2f" % x}.join(", ")}]"
+      end
+      io.puts "```"
+    end
+
+    def results
+      result_hash = {}
+
+      @log_dir.entries.map do |entry|
+        @log_dir.join(entry)
+      end.select do |file|
+        file.file? && file.extname == ".json"
+      end.sort.map do |file|
+        JSON.parse(file.read)
+      end.each do |json|
+        json.each_key do |key|
+          result_hash[key] ||= []
+          result_hash[key] << json[key]
+        end
+      end
+
+      result_hash
+    end
+
+    def call
+      WaitForIt.new("bundle exec puma #{@rackup_file.to_s} -p #{@port}", env: {"TIME_SCALE" => @time_scale.to_i.to_s, "STARTING_LIMIT" => @starting_limit.to_s}, wait_for: "Use Ctrl-C to stop") do |spawn|
+        @process_count.times.each do
+          boot_process
+        end
+
+        @pids.map { |pid| Process.wait(pid) }
+      end
+    end
+
+    private def boot_process
+      @pids << fork do
+        run_threads
+      end
+    end
+
+    private def run_threads
+      @thread_count.times.each do
+        @threads << Thread.new do
+          run_client_single
+        end
+      end
+
+      # Chart support, print out the sleep value in 1 second increments to a file
+      Thread.new do
+        loop do
+          @threads.each do |thread|
+            sleep_for = thread.thread_variable_get("last_sleep_value") || 0
+
+            File.open(@log_dir.join("#{Process.pid}:#{thread.object_id}-chart-data.txt"), 'a') do |f|
+              f.puts(sleep_for)
+            end
+          end
+          sleep 1 # time gets adjusted via TIME_SCALE later in time.rb
+        end
+      end
+
+      @threads.map(&:join)
+    end
+
+    class TimeIsUpError < StandardError; end
+
+    private def run_client_single
+      end_at_time = Time.now + @duration
+      json_at_time = Time.now + @json_duration
+      request_count = 0
+      retry_count = 0
+
+      monkey_patch_client_sleep
+      loop do
+        begin_time = Time.now
+        break if begin_time > end_at_time
+
+        if begin_time > json_at_time
+          write_json_value(retry_count: retry_count, request_count: request_count, max_sleep_val: @client.max_sleep_val)
+          json_at_time = begin_time + @json_duration
+        end
+
+        req = nil
+        @client.call do
+          request_count += 1
+
+          req = make_request
+
+          retry_count += 1 if req.status == 429
+
+          stream_requests(req, retry_count: retry_count, request_count: request_count) if @stream_requests
+          req
+        end
+
+        if @remaining_stop_under
+          break if (req.headers["RateLimit-Remaining"].to_i <= @remaining_stop_under)
+        end
+      end
+      stop_all_theads!
+
+    rescue Excon::Error::Socket => e
+      raise e
+    rescue TimeIsUpError
+      # Since the sleep time can be very high, we need a way to notify sleeping threads they can stop
+      # When this exception is raised, do nothing and exit
+    ensure
+      write_json_value(retry_count: retry_count, request_count: request_count, max_sleep_val: @client.max_sleep_val)
+    end
+
+    private def monkey_patch_client_sleep
+      @mutex.synchronize do
+        if !@client.instance_variables.include?(:"@time_scale")
+          def @client.sleep(val)
+            @max_sleep_val = val if val > @max_sleep_val
+            Thread.current.thread_variable_set("last_sleep_value", val)
+
+            super val/@time_scale
+          end
+
+          def @client.max_sleep_val
+            @max_sleep_val
+          end
+
+          def @client.last_sleep
+            @last_sleep || 0
+          end
+        end
+
+        @client.instance_variable_set(:"@time_scale", @time_scale)
+        @client.instance_variable_set(:"@max_sleep_val", 0)
+      end
+    end
+
+    private def make_request
+      req = Excon.get("http://localhost:#{@port}")
+
+      raise "Got unexpected reponse #{req.status}. #{req.inspect}" if req.status != 200 &&  req.status != 429
+      req
+    rescue Excon::Error::Timeout => e
+      puts e.inspect
+      puts "retrying"
+      retry
+    end
+
+    private def stream_requests(request, retry_count:, request_count:)
+      status_string = String.new
+      status_string << "#{Process.pid}##{Thread.current.object_id}: "
+      status_string << "status=#{request.status} "
+      status_string << "remaining=#{request.headers["RateLimit-Remaining"]} "
+      status_string << "retry_count=#{retry_count} "
+      status_string << "request_count=#{request_count} "
+      status_string << "max_sleep_val=#{ sprintf("%.2f", @client.max_sleep_val) } "
+
+      puts status_string
+    end
+
+    # Even though all clients might have reached their `end_time` they might be stuck in a long `sleep`.
+    # This method signals to any threads that might be stuck in a `sleep` to stop via an exception that we raise
+    # and catch
+    private def stop_all_theads!
+      @threads.each do |t|
+        next if @remaining_stop_under
+
+        if t != Thread.current && t.backtrace_locations && t.backtrace_locations.first.label == "sleep"
+          t.raise(TimeIsUpError)
+        end
+      end
+    end
+
+    private def write_json_value(retry_count:, request_count:, max_sleep_val:)
+      results = {
+        max_sleep_val: max_sleep_val,
+        retry_ratio: retry_count / request_count.to_f,
+        request_count: request_count
+      }
+
+      File.open(@log_dir.join("#{Process.pid}:#{Thread.current.object_id}.json"), 'w+') do |f|
+        f.puts(results.to_json)
+      end
+    rescue TimeIsUpError
+      retry
+    end
+  end
+
+  require 'socket'
+
+  module UniquePort
+    def self.call
+      TCPServer.open('127.0.0.1', 0) do |server|
+        server.connect_address.ip_port
+      end
+    end
+  end
+end

data/lib/rate_throttle_client/info.rb

@@ -0,0 +1,12 @@
+module RateThrottleClient
+
+  # Class used for reporting
+  class Info
+    attr_reader :sleep_for, :request
+
+    def initialize(sleep_for: , request: )
+      @sleep_for = sleep_for
+      @request = request
+    end
+  end
+end

data/lib/rate_throttle_client/servers/decrease_only/config.ru

@@ -0,0 +1,49 @@
+require 'timecop'
+require 'rate_throttle_client'
+
+if ENV["TIME_SCALE"]
+  require 'timecop'
+  Timecop.scale(ENV["TIME_SCALE"].to_f)
+end
+
+module RateThrottleClient
+  # This server does not gain new requests over time
+  # it's main purpose is to benchmark how long it takes to
+  # clear a fixed sized workload
+  class NullFakeServer
+
+    def initialize(starting_limit: 0)
+      @limit_left = starting_limit.to_f
+      @mutex = Mutex.new
+    end
+
+    def call(_)
+      headers = nil
+      successful_request = false
+
+      @mutex.synchronize do
+        if @limit_left >= 1
+          @limit_left -= 1
+          successful_request = true
+        end
+
+        headers = { "RateLimit-Remaining" => [@limit_left.floor, 0].max, "RateLimit-Multiplier" => 1, "Content-Type" => "text/plain".freeze }
+      end
+
+
+      if !successful_request
+        status = 429
+        body = "!!!!! Nope !!!!!".freeze
+      else
+        status = 200
+        body = "<3<3<3 Hello world <3<3<3".freeze
+      end
+
+      return [status, headers, [body]]
+    end
+  end
+end
+
+starting_limit = ENV.fetch("STARTING_LIMIT", 0).to_i
+run RateThrottleClient::NullFakeServer.new(starting_limit: starting_limit)
+

data/lib/rate_throttle_client/servers/gcra/config.ru

@@ -0,0 +1,11 @@
+require_relative "gcra_fake_server.rb"
+
+require 'timecop'
+
+if ENV["TIME_SCALE"]
+  require 'timecop'
+  Timecop.scale(ENV["TIME_SCALE"].to_f)
+end
+starting_limit = ENV.fetch("STARTING_LIMIT", 0).to_i
+
+run RateThrottleClient::GcraFakeServer.new(starting_limit: starting_limit)

data/lib/rate_throttle_client/servers/gcra/gcra_fake_server.rb

@@ -0,0 +1,52 @@
+require 'thread'
+require 'rate_throttle_client'
+
+if ENV["TIME_SCALE"]
+  require 'timecop'
+  Timecop.scale(ENV["TIME_SCALE"].to_f)
+end
+
+module RateThrottleClient
+  class GcraFakeServer
+    def initialize(starting_limit: 0)
+      @limit_left = starting_limit.to_f
+      @mutex = Mutex.new
+      @rate_of_gain = RateThrottleClient.max_limit / 3600.to_f
+      @max_requests = RateThrottleClient.max_limit
+    end
+
+    def call(_)
+      @last_request ||= Time.now
+      headers = nil
+      successful_request = false
+
+      @mutex.synchronize do
+        if @limit_left < @max_requests
+          current_request = Time.now
+          time_diff = current_request - @last_request
+          @last_request = current_request
+
+          @limit_left = [@limit_left + time_diff * @rate_of_gain, @max_requests].min
+        end
+
+        if @limit_left >= 1
+          @limit_left -= 1
+          successful_request = true
+        end
+
+        headers = { "RateLimit-Remaining" => [@limit_left.floor, 0].max, "RateLimit-Multiplier" => 1, "Content-Type" => "text/plain".freeze }
+      end
+
+
+      if !successful_request
+        status = 429
+        body = "!!!!! Nope !!!!!".freeze
+      else
+        status = 200
+        body = "<3<3<3 Hello world <3<3<3".freeze
+      end
+
+      return [status, headers, [body]]
+    end
+  end
+end

data/lib/rate_throttle_client/version.rb

@@ -0,0 +1,3 @@
+module RateThrottleClient
+  VERSION = "0.1.0"
+end

data/rate_throttle_client.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/rate_throttle_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rate_throttle_client"
+  spec.version       = RateThrottleClient::VERSION
+  spec.authors       = ["schneems"]
+  spec.email         = ["richard.schneeman+foo@gmail.com"]
+
+  spec.summary       = %q{Don't error, instead, sleep, and retry}
+  spec.description   = %q{https://twitter.com/schneems/status/1138899094137651200}
+  spec.homepage      = "https://github.com/zombocom/rate_throttle_client"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/zombocom/rate_throttle_client"
+  spec.metadata["changelog_uri"] = "https://github.com/zombocom/rate_throttle_client/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "wait_for_it"
+  spec.add_development_dependency "m"
+  spec.add_development_dependency "puma"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "excon"
+  spec.add_development_dependency "enumerable-statistics"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rate_throttle_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- schneems
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wait_for_it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: enumerable-statistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: https://twitter.com/schneems/status/1138899094137651200
+email:
+- richard.schneeman+foo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/workflows/check_changelog.yml"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rate_throttle_client.rb
+- lib/rate_throttle_client/.DS_Store
+- lib/rate_throttle_client/clients/base.rb
+- lib/rate_throttle_client/clients/exponential_backoff.rb
+- lib/rate_throttle_client/clients/exponential_increase_gradual_decrease.rb
+- lib/rate_throttle_client/clients/exponential_increase_proportional_decrease.rb
+- lib/rate_throttle_client/clients/exponential_increase_proportional_remaining_decrease.rb
+- lib/rate_throttle_client/clients/null.rb
+- lib/rate_throttle_client/demo.rb
+- lib/rate_throttle_client/info.rb
+- lib/rate_throttle_client/servers/.DS_Store
+- lib/rate_throttle_client/servers/decrease_only/config.ru
+- lib/rate_throttle_client/servers/gcra/config.ru
+- lib/rate_throttle_client/servers/gcra/gcra_fake_server.rb
+- lib/rate_throttle_client/version.rb
+- rate_throttle_client.gemspec
+homepage: https://github.com/zombocom/rate_throttle_client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zombocom/rate_throttle_client
+  source_code_uri: https://github.com/zombocom/rate_throttle_client
+  changelog_uri: https://github.com/zombocom/rate_throttle_client/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Don't error, instead, sleep, and retry
+test_files: []