rcb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b7b710d6681c43cbe7b7d538d0eeda7199ee7e7c892e3aa2b0ddd1455a5a08
-  data.tar.gz: 18449ecc9021e6dace52a8b07834544564234d1fe06170d81830a0c36aca5021
+  metadata.gz: '029e8ceda425ad3aea544142ab9307fd74ebff19fa98e359d791d820528f5638'
+  data.tar.gz: daf71c637318058ef6647531544c4fbe77404e08e0e705778ea77623f53d461d
 SHA512:
-  metadata.gz: 263813bdacad4713d2cf411aa6f5caae798166290142e96aabce52c2b1bd95220fd008fbbd46188afd3f59834c58edcacc43d0537865cd0e7e0b90260829966f
-  data.tar.gz: 95c4afc987cef799fbf40dbb29bbcaf08a94110d5b7996d076560951430975894bb2f35fa29a69b1cc24a6022ca54ff25f4587ff39e0d7b525cfff055651f67a
+  metadata.gz: 79cf1a6056c40f5abf501905ea0a3ac12e98eaaafd86a45e537b4db66ce343b6bc7c759c5ba74a7c7a0f1c7d66ec4e4c4f881c8e02f6627cbb89acab426fba29
+  data.tar.gz: b268096b37b3a3d13f7a7367ad5491b02dd65bbf21aa47637caa7f7afb67586470917b984913cf016e23d0d0c8020cddc0a4dbce16067189a2a79b95b4bc8df3

data/.github/workflows/action.yaml

@@ -0,0 +1,22 @@
+name: test
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Set up Ruby 2.7
+      uses: clupprich/ruby-build-action@master
+      with:
+        ruby-version: 2.7.0
+
+    - name: Bundle install
+      run: |
+        bundle -j 4 --path vendor/bundle
+
+    - name: Run Tests
+      run: |
+        bundle exec rake test

data/README.md

@@ -1,10 +1,13 @@
 # Rcb - Ruby Circuit Breaker
 
+[![rcb](https://badge.fury.io/rb/rcb.svg)](https://badge.fury.io/rb/rcb)
+[![Actions Status](https://github.com/petitviolet/rcb/workflows/test/badge.svg)](https://github.com/petitviolet/rcb/actions)
+
 [Circuit Breaker](https://martinfowler.com/bliki/CircuitBreaker.html) implementation for/by Ruby.  
 CircuitBreaker is a great pattern to build robust system consists of bunch of microservices.
 
 - Close
-    - A operational state
+    - An operational state
 - Open
     - A not operational state
 - Half Open

data/lib/rcb.rb

@@ -3,9 +3,9 @@ require_relative "./rcb/configuration"
 
 module Rcb
   module ClassMethods
-    def for(tag, max_failure_count: nil, reset_timeout_msec: nil)
+    def for(tag, open_condition: nil, reset_timeout_msec: nil)
       config = Rcb::Configurations.for(tag,
-                                       max_failure_count: max_failure_count,
+                                       open_condition: open_condition,
                                        reset_timeout_msec: reset_timeout_msec)
       Instance.new(config)
     end

data/lib/rcb/configuration.rb

@@ -1,53 +1,83 @@
 require 'logger'
+require 'rstructural'
 
 module Rcb
-  Config = Struct.new(:tag, :max_failure_count, :reset_timeout_msec)do
-    MAX_FAILURE_COUNT = 0.freeze
-    RESET_TIMEOUT_MSEC = 0.freeze
+  OpenCondition = Rstruct.new(:max_failure_count, :window_msec) do
+    self::DEFAULT = new(3, 1000).freeze
+  end
+
+  Config = Rstruct.new(:tag, :open_condition, :reset_timeout_msec) do
+    self::RESET_TIMEOUT_MSEC = 1000.freeze
 
     @logger = Logger.new($stderr)
 
-    def self.create(tag, max_failure_count: nil, reset_timeout_msec: nil)
+    def self.create(tag, open_condition: nil, reset_timeout_msec: nil)
       raise 'Rcb tag must not be nil' if tag.nil?
 
-      if max_failure_count.nil? && reset_timeout_msec.nil?
+      if open_condition.nil? && reset_timeout_msec.nil?
         @logger.warn("Rcb for '#{tag}' is not configured!")
       end
 
       Config.new(
         tag.to_s.to_sym,
-        max_failure_count || MAX_FAILURE_COUNT,
-        reset_timeout_msec || RESET_TIMEOUT_MSEC
+        open_condition || OpenCondition::DEFAULT,
+        reset_timeout_msec || Config::RESET_TIMEOUT_MSEC
       )
     end
   end
 
-  class ConfigBuilder
-    def initialize(tag)
-      @tag = tag
-      @max_failure_count = nil
-      @reset_timeout_msec = nil
-    end
+  module DSL
+    class OpenConditionBuilder
+      def initialize
+        @max_failure_count = nil
+        @window_msec = nil
+      end
 
-    def max_failure_count(num)
-      @max_failure_count = num
-    end
+      def max_failure_count(count)
+        @max_failure_count = count
+      end
+
+      def window_msec(msec)
+        @window_msec = msec
+      end
 
-    def reset_timeout_msec(msec)
-      @reset_timeout_msec = msec
+      def build
+        Rcb::OpenCondition.new(@max_failure_count, @window_msec)
+      end
     end
 
-    def build
-      Config.create(
-        @tag,
-        max_failure_count:@max_failure_count,
-        reset_timeout_msec: @reset_timeout_msec
-      ).freeze
+    class ConfigBuilder
+      def initialize(tag)
+        @tag = tag
+        @open_condition_builder = OpenConditionBuilder.new
+        @reset_timeout_msec = nil
+      end
+
+      def open_condition(hash = nil)
+        if hash
+          @open_condition_builder.max_failure_count hash[:max_failure_count]
+          @open_condition_builder.window_msec hash[:window_msec]
+        else
+          @open_condition_builder
+        end
+      end
+
+      def reset_timeout_msec(msec)
+        @reset_timeout_msec = msec
+      end
+
+      def build
+        Rcb::Config.create(
+          @tag,
+          open_condition: @open_condition_builder.build,
+          reset_timeout_msec: @reset_timeout_msec
+        ).freeze
+      end
     end
   end
 
   def Rcb.configure(tag, &block)
-    c = ConfigBuilder.new(tag.to_s.to_sym)
+    c = DSL::ConfigBuilder.new(tag.to_s.to_sym)
           .tap { |cb| block.call(cb) }
           .build
 
@@ -57,9 +87,9 @@ module Rcb
   module Configurations
     @configs = {}
 
-    def self.for(tag, max_failure_count: nil, reset_timeout_msec: nil)
+    def self.for(tag, open_condition: nil, reset_timeout_msec: nil)
       @configs[tag.to_s.to_sym] || Config.create(tag,
-                                                 max_failure_count: max_failure_count,
+                                                 open_condition: open_condition,
                                                  reset_timeout_msec: reset_timeout_msec)
     end
 

data/lib/rcb/instance.rb

@@ -1,4 +1,3 @@
-require 'byebug'
 require 'rstructural'
 require_relative './state'
 require_relative './configuration'

data/lib/rcb/state.rb

@@ -5,18 +5,20 @@ require_relative './error'
 module Rcb::State
   extend ADT
 
-  Close = data :failure_count do
-    def self.create(failure_count = 0)
-      new(failure_count)
+  Close = data :failure_times do
+    def self.create
+      new([])
     end
 
-    def run(config, &block)
+    def run(config, now: Time.now.utc, &block)
       case try_call(&block)
       in Either::Right[result]
         Rcb::Result::Ok.new(self, result)
       in Either::Left[e]
-        if config.max_failure_count > failure_count
-          Rcb::Result::Ng.new(Close.create(failure_count + 1), e)
+        old_limit = now - (config.open_condition.window_msec / 1000.0)
+        refreshed_failure_times = failure_times.filter { |ft| old_limit <= ft } + [now]
+        if refreshed_failure_times.size < config.open_condition.max_failure_count
+          Rcb::Result::Ng.new(Close.new(refreshed_failure_times), e)
         else
           Rcb::Result::Ng.new(Open.create, e)
         end

data/rcb.gemspec

@@ -1,8 +1,6 @@
-require_relative 'lib/rcb/version'
-
 Gem::Specification.new do |spec|
   spec.name          = "rcb"
-  spec.version       = Rcb::VERSION
+  spec.version       = '0.2.0'
   spec.authors       = ["petitviolet"]
   spec.email         = ["violethero0820@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - petitviolet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-22 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rstructural
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/action.yaml"
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -87,7 +88,6 @@ files:
 - lib/rcb/instance.rb
 - lib/rcb/result.rb
 - lib/rcb/state.rb
-- lib/rcb/version.rb
 - rcb.gemspec
 homepage: https://github.com/petitviolet/rcb
 licenses:

data/lib/rcb/version.rb

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