async_storage 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add79afe0dfa294abeee5fb5102e05f5d5fbecfc70d700c5b25fc4f17cf9881f
-  data.tar.gz: e0a8841f106ac58f7146938749732c43d99e0f56dacfcc4816d62c251bf34d2a
+  metadata.gz: a6066c81131bf563929ebf745a0025e424aade1c2c85cae099bbf0052bd43423
+  data.tar.gz: 750940e2dab1347fc3fb61825b5a9fbf5d0094b5ae53d30a99fdcb18676913d0
 SHA512:
-  metadata.gz: 28800339448b6668b3da60bb5ad80d5e998c26ef42ebd3c06c881d49b09bfe7a8aed7893323578f3c0171183f705a5ca58fc9b871aa420425f161896e0e02d2a
-  data.tar.gz: dff1ad907077f87c95977f14b56c4a8c9d49f394f781a1c164a53266c5a0ee3cae45078728b41b1020d47b3bb9c7949bf9e5286f83c21fc8e39c49735a286c36
+  metadata.gz: 5fd978fe08f9a6bf521480a7025899eb58d15b26b0312e2cd80c8dd7beb79db677056d6a6083fb375af1fcea48228a9f3aa005311f0adbe014d63c0529d1ffde
+  data.tar.gz: 6679f8603e517b2df74e5abbce7a8c6d6bc3c6bd69eab48c6b36bef7bf3c0219c6bd422ff4ef7e00f3d4ec0afd17ced001a18bd216ebf41269379fd5cf234182

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    async_storage (0.0.1)
+    async_storage (0.0.3)
       multi_json (> 0.0.0)
       redis (> 0.0.0)
 

data/README.md

@@ -33,6 +33,7 @@ AsyncStorage.configuration do |config|
   end
   config.namespace = 'async_storage'  # Default to 'async_storage'
   config.expires_in = 3_600           # Default to nil
+  config.circuit_breaker = true       # Call the resolver instead of thrown redis connection error when the redis service is down. Default to true
 end
 ```
 

data/lib/async_storage/allocator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'async_storage/naming'
+require 'async_storage/circuit_breaker'
 
 module AsyncStorage
   class Allocator
@@ -31,19 +32,21 @@ module AsyncStorage
     #
     # @return [Object, NilClass] Return both stale or fresh object. If does not exist async call the retriever and return nil
     def get
-      connection do |redis|
-        raw_head = redis.get(naming.head)
-        case raw_head
-        when CTRL[:executed], CTRL[:enqueued]
-          read_body(redis) # Try to deliver stale content
-        when CTRL[:missing]
-          return update!(redis) unless async?
-
-          perform_async(redis) # Enqueue background job to resolve content
-          redis.set(naming.head, CTRL[:enqueued])
-          read_body(redis) # Try to deliver stale content
-        else
-          raise AsyncStorage::Error, format('the key %<k>s have an invalid value. Only "1" or "0" values are expected. And we got %<v>p', v: raw_head, k: naming.head)
+      breaker.run(fallback: -> { fetch! }) do
+        connection do |redis|
+          raw_head = redis.get(naming.head)
+          case raw_head
+          when CTRL[:executed], CTRL[:enqueued]
+            read_body(redis) # Try to deliver stale content
+          when CTRL[:missing]
+            return update!(redis) unless async?
+
+            perform_async(redis) # Enqueue background job to resolve content
+            redis.set(naming.head, CTRL[:enqueued])
+            read_body(redis) # Try to deliver stale content
+          else
+            raise AsyncStorage::Error, format('the key %<k>s have an invalid value. Only "1" or "0" values are expected. And we got %<v>p', v: raw_head, k: naming.head)
+          end
         end
       end
     end
@@ -52,17 +55,19 @@ module AsyncStorage
     #
     # @return [Object] Return the result from resolver
     def get!
-      connection do |redis|
-        raw_head = redis.get(naming.head)
-        case raw_head
-        when CTRL[:executed]
-          read_body(redis) || begin
-            update!(redis) unless redis.exists?(naming.body)
+      breaker.run(fallback: -> { fetch! }) do
+        connection do |redis|
+          raw_head = redis.get(naming.head)
+          case raw_head
+          when CTRL[:executed]
+            read_body(redis) || begin
+              update!(redis) unless redis.exists?(naming.body)
+            end
+          when CTRL[:missing], CTRL[:enqueued]
+            update!(redis)
+          else
+            raise AsyncStorage::Error, format('the key %<k>s have an invalid value. Only "1" or "0" values are expected. And we got %<v>p', v: raw_head, k: naming.head)
           end
-        when CTRL[:missing], CTRL[:enqueued]
-          update!(redis)
-        else
-          raise AsyncStorage::Error, format('the key %<k>s have an invalid value. Only "1" or "0" values are expected. And we got %<v>p', v: raw_head, k: naming.head)
         end
       end
     end
@@ -71,8 +76,10 @@ module AsyncStorage
     #
     # @return [Boolean] True or False according to the object existence
     def invalidate
-      connection do |redis|
-        redis.del(naming.head) == 1
+      breaker.run(fallback: -> { false }) do
+        connection do |redis|
+          redis.del(naming.head) == 1
+        end
       end
     end
 
@@ -80,11 +87,13 @@ module AsyncStorage
     #
     # @return [Boolean] True or False according to the object existence
     def invalidate!
-      connection do |redis|
-        redis.multi do |cli|
-          cli.del(naming.body)
-          cli.del(naming.head)
-        end.include?(1)
+      breaker.run(fallback: -> { false }) do
+        connection do |redis|
+          redis.multi do |cli|
+            cli.del(naming.body)
+            cli.del(naming.head)
+          end.include?(1)
+        end
       end
     end
 
@@ -92,37 +101,45 @@ module AsyncStorage
     #
     # @return [Object, NilClass] Stale object or nil when it does not exist
     def refresh
-      value = get(*@args)
-      invalidate(*@args)
-      value
+      breaker.run(fallback: -> { fetch! }) do
+        get.tap { invalidate }
+      end
     end
 
     # Fetch data from resolver and store it into redis
     #
     # @return [Object] Return the result from resolver
     def refresh!
-      connection { |redis| update!(redis) }
+      breaker.run(fallback: -> { fetch! }) do
+        connection { |redis| update!(redis) }
+      end
     end
 
     # Check if a fresh value exist.
     #
     # @return [Boolean] True or False according the object existence
     def exist?
-      connection { |redis| redis.exists?(naming.head) && redis.exists?(naming.body) }
+      breaker.run(fallback: -> { false }) do
+        connection { |redis| redis.exists?(naming.head) && redis.exists?(naming.body) }
+      end
     end
 
     # Check if object with a given key is stale
     #
     # @return [NilClass, Boolean] Return nil if the object does not exist or true/false according to the object freshness state
     def stale?
-      connection { |redis| redis.exists?(naming.body) && redis.ttl(naming.head) < 0 }
+      breaker.run(fallback: -> { false }) do
+        connection { |redis| redis.exists?(naming.body) && redis.ttl(naming.head) < 0 }
+      end
     end
 
     # Check if a fresh object exists into the storage
     #
     # @return [Boolean] true/false according to the object existence and freshness
     def fresh?
-      connection { |redis| redis.exists?(naming.body) && redis.ttl(naming.head) > 0 }
+      breaker.run(fallback: -> { false }) do
+        connection { |redis| redis.exists?(naming.body) && redis.ttl(naming.head) > 0 }
+      end
     end
 
     private
@@ -138,7 +155,7 @@ module AsyncStorage
     end
 
     def update!(redis)
-      payload = resolver_class.new.(*@args)
+      payload = fetch!
 
       json = AsyncStorage::JSON.dump(payload, mode: :compat)
       redis.multi do |cli|
@@ -149,6 +166,10 @@ module AsyncStorage
       AsyncStorage::JSON.load(json)
     end
 
+    def fetch!
+      resolver_class.new.(*@args)
+    end
+
     def read_body(redis)
       raw = redis.get(naming.body)
       return unless raw
@@ -161,5 +182,9 @@ module AsyncStorage
 
       AsyncStorage.redis_pool.with { |redis| yield(redis) }
     end
+
+    def breaker
+      CircuitBreaker.new(self, exceptions: [Redis::BaseConnectionError])
+    end
   end
 end

data/lib/async_storage/circuit_breaker.rb

@@ -0,0 +1,32 @@
+# frizen_string_literal: true
+
+module AsyncStorage
+  # This is not a real circuit breaker. We can improve it later.
+  # Basicaly only call the fallback function when some known exception is thrown
+  #
+  # @see https://martinfowler.com/bliki/CircuitBreaker.html
+  class CircuitBreaker
+    def initialize(context, exceptions: [])
+      @context = context
+      @exceptions = exceptions || []
+    end
+
+    def run(fallback: nil)
+      func = fallback.is_a?(Proc) ? fallback : Proc.new { fallback }
+      yield
+    rescue => err
+      if exception?(err)
+        func.arity == 0 ? @context.instance_exec(&func) : func.call(@context)
+      else
+        raise(err)
+      end
+    end
+
+    private
+
+    def exception?(error)
+      AsyncStorage.config.circuit_breaker? && \
+        (@exceptions.empty? || @exceptions.any? { |known_error| error.is_a?(known_error) })
+    end
+  end
+end

data/lib/async_storage/config.rb

@@ -43,6 +43,10 @@ module AsyncStorage
     # The global TTL for the redis storage. Keep nil if you don't want to expire objects.
     attribute_accessor :expires_in, default: nil
 
+    # When enabled it automatically calls the resolver when there is an issue with RedisConnection
+    attribute_accessor :circuit_breaker, default: true, normalizer: :normalizer_boolean, validator: :validate_boolean
+    alias circuit_breaker? circuit_breaker
+
     def config_path=(value)
       @config_from_yaml = nil
       @config_path = value
@@ -50,6 +54,23 @@ module AsyncStorage
 
     private
 
+    def normalizer_boolean(_attr, value)
+      return true if [1, '1', true, 'true'].include?(value)
+      return false if [nil, 0, '0', false, 'false'].include?(value)
+
+      value
+    end
+
+    def validate_boolean(attribute, value)
+      return if [true, false].include?(value)
+
+      raise InvalidConfig, format(
+        "The value %<value>p for %<attr>s is not valid. It must be a boolean",
+        value: value,
+        attr: attribute,
+      )
+    end
+
     def normalize_namespace(_attribute, value)
       return value.to_s if value.is_a?(Symbol)
 

data/lib/async_storage/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AsyncStorage
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async_storage
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -59,6 +59,7 @@ files:
 - lib/async_storage.rb
 - lib/async_storage/allocator.rb
 - lib/async_storage/bath_actions.rb
+- lib/async_storage/circuit_breaker.rb
 - lib/async_storage/config.rb
 - lib/async_storage/json.rb
 - lib/async_storage/naming.rb