faraday_throttler 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f579e07afd3e9eaef5e05bfad056a6334cf5f32
-  data.tar.gz: 0d714c032c901eb44c75974a6fdfe7ab69946e4c
+  metadata.gz: 0751994072b42e01e211a07884eed4e8e1e3a2e9
+  data.tar.gz: 8591da828d84bf43b0bccff3df9785819529d999
 SHA512:
-  metadata.gz: a401855bca195c3b855b31160df610490395238ad6f626b5561d93db05ed616c5bf922f70cd994a83043b7c10bf690c7f676e15fc5d1ad9065912028eb10c43e
-  data.tar.gz: 274a82b0fed4d985b230298725b0e3ef10aa8c0634a986294d7c5b92228e594074d816d1b8a4bc0f757ba359a10da02731d0384290df09b333f383ed655a5dc2
+  metadata.gz: 6393d8dc8915d6a9434ec83f85df65e19baff9d430da5ac0aed2be0383b5b5432e3d7c8f1566a63d54725d2a6e2f7d1b1b5fd4aac78cf120aed4a1f61e1ed06b
+  data.tar.gz: eaebf1976fcb54977e419f012f475de3ee0f2a7ec1b21b58e29a4afbb4827ec9635a5b20aa63e908b0716702acb355f6668b5ca784537e0ed81fb7e36dcb9628

data/lib/faraday_throttler/middleware.rb

@@ -1,5 +1,6 @@
 require 'timeout'
 require 'faraday'
+require 'logger'
 require 'faraday_throttler/key_resolver'
 require 'faraday_throttler/mem_lock'
 require 'faraday_throttler/cache'
@@ -89,7 +90,18 @@ module FaradayThrottler
         # Otherwise the fallback response will be returned.
         # The main difference is that, when async: false, a fresh request will block until it gets data from the server.
         # When async: true, a fresh request will try to respond with (possibly stale) cached data ASAP while the new response is cached in the background.
-        async: false
+        async: false,
+
+        # Pass your own Logger instance (for example Rails.logger in a Rails app).
+        # Defaults to STDOUT.
+        # http://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html
+        # Interface:
+        #   #debug(msg String, &block)
+        #   #warn(msg String, &block)
+        #   #error(msg String, &block)
+        #   #info(msg String, &block)
+        #   #fatal(msg String, &block)
+        logger: Logger.new(STDOUT)
     )
 
       validate_dep! lock, :lock, :set
@@ -97,6 +109,7 @@ module FaradayThrottler
       validate_dep! lock_key_resolver, :lock_key_resolver, :call
       validate_dep! cache_key_resolver, :cache_key_resolver, :call
       validate_dep! fallbacks, :fallbacks, :call
+      validate_dep! logger, :info, :error, :warn, :debug
 
       @lock = lock
       @cache = cache
@@ -108,6 +121,7 @@ module FaradayThrottler
       @fallbacks = fallbacks
       @gauge = gauge || Gauge.new(rate: @rate, wait: @wait)
       @async = async
+      @logger = logger
       validate_dep! @gauge, :gauge, :start, :update, :finish
 
       super app
@@ -124,28 +138,32 @@ module FaradayThrottler
       gauge.start cache_key, start
 
       if lock.set(lock_key, gauge.rate(cache_key))
+        logger.debug logline(cache_key, "A.1. start backend request. async: #{async?}")
         if async?
           handle_async(request_env, cache_key, start)
         else
           handle_sync(request_env, cache_key, start)
         end
       else
+        logger.debug logline(cache_key, "A.2. lock already set. Wait for cache.")
         serve_from_cache_or_fallback request_env, cache_key, start
       end
     end
 
     private
-    attr_reader :app, :lock, :cache, :lock_key_resolver, :cache_key_resolver, :rate, :wait, :timeout, :fallbacks, :gauge
+    attr_reader :app, :lock, :cache, :lock_key_resolver, :cache_key_resolver, :rate, :wait, :timeout, :fallbacks, :gauge, :logger
 
     def async?
       @async
     end
 
     def handle_sync(request_env, cache_key, start)
+      logger.debug logline(cache_key, "B.1.1. handle sync. Timeout: #{timeout}")
       with_timeout(timeout) {
         fetch_and_cache(request_env, cache_key, start)
       }
     rescue ::Timeout::Error => e
+      logger.error logline(cache_key, "B.1.2. timeout error. Timeout: #{timeout}. Message: #{e.message}")
       gauge.update cache_key, :timeout
       serve_from_cache_or_fallback request_env, cache_key, start
     end
@@ -153,6 +171,7 @@ module FaradayThrottler
     def handle_async(request_env, cache_key, start)
       Thread.new do
         fetch_and_cache(request_env, cache_key, start)
+        logger.debug logline(cache_key, "B.2.1. finished async fetch and cache")
       end
       serve_from_cache_or_fallback request_env, cache_key, start
     end
@@ -161,15 +180,18 @@ module FaradayThrottler
       app.call(request_env).on_complete do |response_env|
         cache.set cache_key, response_env
         gauge.finish cache_key, :fresh
+        logger.debug logline(cache_key, "C.1.1. finished fetch and cache. Took #{Time.now - start}")
         debug_headers response_env, :fresh, start
       end
     end
 
     def serve_from_cache_or_fallback(request_env, cache_key, start)
       if cached_response = cache.get(cache_key, gauge.wait(cache_key))
+        logger.debug logline(cache_key, "C.2.1. serving cached response. Took #{Time.now - start}")
         gauge.finish cache_key, :cached
         resp cached_response, :cached, start
       else
+        logger.debug logline(cache_key, "C.2.2. no cached response. Serving fallback response")
         gauge.finish cache_key, :fallback
         resp fallbacks.call(request_env), :fallback, start
       end
@@ -201,6 +223,10 @@ module FaradayThrottler
         ::Timeout.timeout(seconds, &block)
       end
     end
+
+    def logline(cache_key, line)
+      "[Throttler:#{cache_key}] #{line}"
+    end
   end
 
   Faraday::Middleware.register_middleware throttler: ->{ Middleware }

data/lib/faraday_throttler/version.rb

@@ -1,3 +1,3 @@
 module FaradayThrottler
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_throttler
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday