freno-client 0.3.0 → 0.8.1

data/lib/freno/throttler/circuit_breaker.rb

@@ -0,0 +1,39 @@
+module Freno
+  class Throttler
+
+    # A CircuitBreaker is the entry point of the pattern with same name.
+    # (see https://martinfowler.com/bliki/CircuitBreaker.html)
+    #
+    # Clients that use circuit breakers to add resiliency to their processes
+    # send `failure` or `sucess` messages to the CircuitBreaker depending on the
+    # results of the last requests made.
+    #
+    # With that information, the circuit breaker determines whether or not to
+    # allow the next request (`allow_request?`). A circuit is said to be open
+    # when the next request is not allowed; and it's said to be closed when the
+    # next request is allowed.
+    #
+    module CircuitBreaker
+
+      # The Noop circuit breaker is the `:circuit_breaker` used by default in
+      # the Throttler
+      #
+      # It always allows requests, and does nothing when given `success` or
+      # `failure` messages. For that reason it doesn't provide any resiliency
+      # guarantee.
+      #
+      # See https://github.com/jnunemaker/resilient for a real ruby implementation
+      # of the CircuitBreaker pattern.
+      #
+      class Noop
+        def self.allow_request?
+          true
+        end
+
+        def self.success; end
+
+        def self.failure; end
+      end
+    end
+  end
+end

data/lib/freno/throttler/errors.rb

@@ -0,0 +1,23 @@
+require "freno/client"
+
+module Freno
+  class Throttler
+
+    # Any throttler-related error.
+    class Error < Freno::Error; end
+
+    # Raised if the throttler has waited too long for replication delay
+    # to catch up.
+    class WaitedTooLong < Error
+      def initialize(waited_seconds: DEFAULT_WAIT_SECONDS, max_wait_seconds: DEFAULT_MAX_WAIT_SECONDS)
+        super("Waited #{waited_seconds} seconds. Max allowed was #{max_wait_seconds} seconds")
+      end
+    end
+
+    # Raised if the circuit breaker is open and didn't allow latest request
+    class CircuitOpen < Error; end
+
+    # Raised if the freno client errored.
+    class ClientError < Error; end
+  end
+end

data/lib/freno/throttler/instrumenter.rb

@@ -0,0 +1,27 @@
+module Freno
+  class Throttler
+
+    # An Instrumenter is an object that responds to
+    # `instrument(event_name, payload = {})` to receive events from the
+    # throttler.
+    #
+    # As an example, in a rails app one could use ActiveSupport::Notifications
+    # as an instrumenter and subscribe to the "freno.*" events somewhere else in
+    # the application.
+    #
+    module Instrumenter
+
+      # The Noop instrumenter is the `:instrumenter` used by default in the
+      # Throttler
+      #
+      # It does nothing but yielding the control to the block given if it is
+      # provided.
+      #
+      class Noop
+        def self.instrument(event_name, payload = {})
+          yield payload if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/freno/throttler/mapper.rb

@@ -0,0 +1,45 @@
+module Freno
+  class Throttler
+
+    # A Mapper is any object that responds to `call`, by receiving a context
+    # object and returning a list of strings, each of which corresponds to the
+    # store_name that will be checked in freno.
+    #
+    # See https://github.com/github/freno/blob/master/doc/http.md#client-requests
+    # for more context.
+    #
+    # As an example we could use a mapper that will receive as a context a set
+    # of [table, shard_id] tuples, and could return the list of all the stores
+    # where that shards exist.
+    #
+    module Mapper
+
+      # The Identity mapper is the one used by default in the Throttler.
+      #
+      # It works by informing the throttler to check exact same stores that it
+      # receives as context, without any translation.
+      #
+      # Let's use the following throttler, which uses Mapper::Identity
+      # implicitly.
+      #
+      # ```ruby
+      # throttler = Throttler.new(client: freno_client, app: :my_app)
+      # data.find_in_batches do |batch|
+      #   throttler.throttle([:mysqla, :mysqlb]) do
+      #     update(batch)
+      #   end
+      # end
+      # ```
+      #
+      # Before each call to `update(batch)` the throttler will call freno to
+      # check the health of `mysqla` and `mysqlb`. And sleep if any of them is
+      # not ok.
+      #
+      class Identity
+        def self.call(context)
+          Array(context)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: freno-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.8.1
 platform: ruby
 authors:
-- Miguel Fernández
+- GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -59,24 +17,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: |-
-  freno-client is a ruby library that interacts with
-                                    Freno using HTTP. Freno is a throttling service and its
-                                    source code is available at https://github.com/github/freno
-email:
-- opensource+freno-client@github.com
+description: 'freno-client is a Ruby library that interacts with Freno using HTTP.
+  Freno is a throttling service and its source code is available at https://github.com/github/freno '
+email: opensource+freno-client@github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -84,10 +40,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - freno-client.gemspec
 - lib/freno/client.rb
+- lib/freno/client/errors.rb
 - lib/freno/client/preconditions.rb
 - lib/freno/client/request.rb
 - lib/freno/client/requests/check.rb
@@ -95,14 +50,15 @@ files:
 - lib/freno/client/requests/replication_delay.rb
 - lib/freno/client/result.rb
 - lib/freno/client/version.rb
-- script/bootstrap
-- script/cibuild
-- script/console
+- lib/freno/throttler.rb
+- lib/freno/throttler/circuit_breaker.rb
+- lib/freno/throttler/errors.rb
+- lib/freno/throttler/instrumenter.rb
+- lib/freno/throttler/mapper.rb
 homepage: https://github.com/github/freno-client
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -111,16 +67,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A library for interacting with freno, the throttler service
+summary: A library for interacting with Freno, the throttler service
 test_files: []

data/script/bootstrap

@@ -1,9 +0,0 @@
-#!/bin/sh
-
-set -e
-
-cd "$(dirname "$0")/.."
-
-bundle config --local path vendor/gems
-
-bundle check > /dev/null 2>&1 || bundle install

data/script/cibuild

@@ -1,19 +0,0 @@
-#!/bin/sh
-
-set -eu
-
-test -d "/usr/share/rbenv/shims" && {
-  export PATH="/usr/share/rbenv/shims:$PATH"
-  export RBENV_VERSION="2.4.1"
-}
-
-set -x
-git log -n 1 HEAD | cat
-ruby -v
-bundle -v
-set +x
-
-git clean -fd
-
-script/bootstrap
-bundle exec rake

data/script/console

@@ -1,2 +0,0 @@
-#!/bin/sh
-exec bundle exec irb -r "freno/client" "$@"