circuit_switch 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9281021c31b4e885f3e8c8ca7fbd1fd83e713202950776c910f9b0951891a5c6
-  data.tar.gz: 8f4969657c64c2016724fabadd8d2cbddf063e6ffc3dd0298fb2e9e0b06e688a
+  metadata.gz: 4359ba3c58190ee7f16780a8475a9fe81051823faeaddf5b220d342ab9e9c294
+  data.tar.gz: ad985994dc31cb34e4090b9b45ebad4067e30b1b91d0419389867091d596ca37
 SHA512:
-  metadata.gz: 94cc63d4de19ffdc4cea5a5e331af21ab458f26f5333a6ceb4b84c7b3ba13edb44ebee7c0379c555d1ea7f390e8a31cb159c35c8d181cd8dec4a16cb049507ab
-  data.tar.gz: 2f490f1e01f4e05351cbde8ee6fe328e200c020dcbb0d83a1f627983a47c192f4c4ab8f5c3b3878bd58e7a026003d0bd79a5995044987b275b59b6d9902f478b
+  metadata.gz: 2517c69a923bb7739e6a5c0409b949b41ec624e5915c9fef7fae7e9e16be267983357f4e6c106702382c4157e81e9dae443159de70723bb66fe62247928096ad
+  data.tar.gz: 815d01eb8cc81480558f3eca996158f0174b59bab6a97985399ef0184b3890dd39d283df213ca014f2855939a2253e55918ad9790b51ed7ffcb14ce2891c290d

data/CHANGELOG.md

@@ -1,3 +1,48 @@
+## 0.4.1
+
+* Fix bug `if` `stop_report_if_reach_limit` options don't receive `false`.
+* Fix to report error with stacktrace.
+* Fix not to update run count when run isn't executable.
+
+## 0.4.0
+
+### Breaking Changes
+
+* Be able to choice to notify `CircuitSwitch::CalledNotification` or `String`.  
+Improve `config/initializers/circuit_switch.rb` like following.
+
+```diff
+CircuitSwitch.configure do |config|
+-  config.reporter = ->(message) { Bugsnag.notify(message) }
++  config.reporter = ->(message, error) { Bugsnag.notify(error) }
+```
+
+## 0.3.0
+
+### Breaking Changes
+
+* Modify `key` to unique by default.
+To migrate, run next.
+
+```
+rails generate circuit_switch:migration circuit_switch make_key_unique
+rails db:migrate
+```
+
+### Changes
+
+* Fix to save switch when block for `CircuitSwitch.run` raises error.
+
+## 0.2.2
+
+### New features
+
+* Add `key_column_name` to configuration for aliasing `circuit_switches.key`.
+
+### Changes
+
+* Declare dependent on ActiveSupport instead of implicitly dependent.
+
 ## 0.2.1
 
 ### New features
@@ -7,7 +52,7 @@
 To migrate, run next.
 
 ```
-rails generate circuit_switch:migration add_key
+rails generate circuit_switch:migration circuit_switch add_key
 rails db:migrate
 ```
 

data/README.md

@@ -56,24 +56,30 @@ CircuitSwitch.run do
 end
 ```
 
-`run` calls received proc, and when conditions are met, closes it's circuit.  
-To switch circuit opening and closing, some conditions can be set. By default, the circuit is always opened.  
-You can also set `limit_count` to close circuit when reached the specified count. Default limit_count is 10. To change this default value, modify `circuit_switches.run_limit_count` default value in the migration file.  
-`run` receives optional arguments.
-
-- `key`: [String] Named key to find switch instead of caller  
-  If no key passed, use caller.
-- `if`: [Boolean, Proc] Call proc when `if` is truthy (default: true)
-- `close_if`: [Boolean, Proc] Call proc when `close_if` is falsy (default: false)
-- `close_if_reach_limit`: [Boolean] Stop calling proc when run count reaches limit (default: false)
-- `limit_count`: [Integer] Limit count. Use `run_limit_count` default value if it's nil (default: nil)  
-  Can't be set 0 when `close_if_reach_limit` is true
-- `initially_closed`: [Boolean] Create switch with terminated mode (default: false)
-
-To close the circuit at specific date or when called 1000 times, code goes like:
+`run` basically calls the received proc. But when a condition is met, it closes the circuit and does not evaluate the proc.  
+To switch circuit opening and closing, a set of options can be set. Without options, the circuit is always open.  
+You can set `close_if_reach_limit: true` so that the circuit is only open for 10 invocations. The constant 10 comes from the table definition we have arbitrarily chosen. In case you need a larger number, specify it in the `limit_count` option in combination with `close_if_reach_limit: true`, or alter default constraint on `circuit_switches.run_limit_count`.
+
+- `key`: [String] The identifier to find record by. If `key` has not been passed, `circuit_switches.caller` is chosen as an alternative.
+- `if`: [Boolean, Proc] Calls proc when the value of `if` is evaluated truthy (default: true)
+- `close_if`: [Boolean, Proc] Calls proc when the value of `close_if` is evaluated falsy (default: false)
+- `close_if_reach_limit`: [Boolean] Stops calling proc when `circuit_switches.run_count` has reached `circuit_switches.run_limit_count` (default: false)
+- `limit_count`: [Integer] Mutates `circuit_switches.run_limit_count` whose value defined in schema is 10 by default. (default: nil)  
+  Can't be set to 0 when `close_if_reach_limit` is true. This option is only relevant when `close_if_reach_limit` is set to true.
+- `initially_closed`: [Boolean] Creates switch with terminated mode (default: false)
+
+To close the circuit at a specific date, code goes like:
+
+```ruby
+CircuitSwitch.run(close_if: -> { Date.today >= some_day }) do
+  # testing codes
+end
+```
+
+Or when the code of concern has been called 1000 times:
 
 ```ruby
-CircuitSwitch.run(close_if: -> { Date.today >= some_day }, limit_count: 1_000) do
+CircuitSwitch.run(close_if_reach_limit: true, limit_count: 1_000) do
   # testing codes
 end
 ```
@@ -105,19 +111,17 @@ When you just want to report, set your `reporter` to initializer and then call `
 CircuitSwitch.report(if: some_condition)
 ```
 
-`report` just reports the line of code is called. It doesn't receive proc. It's useful for refactoring or removing dead codes.  
-Same as `run`, some conditions can be set. By default, reporting is stopped when reached the specified count. The default count is 10. To change this default value, modify `circuit_switches.report_limit_count` default value in the migration file.  
-`report` receives optional arguments.
+`report` just reports which line of code is called. It doesn't receive proc. It's useful for refactoring or removing dead codes.  
+Same as `run`, a set of options can be set. By default, this method does not send reports more than 10 times. The constant 10 comes from the table definition we have arbitrarily chosen. In case you need a larger number, specify it in the `limit_count` option, or alter default constraint on `circuit_switches.report_limit_count`.
 
-- `key`: [String] Named key to find switch instead of caller  
-  If no key passed, use caller.
-- `if`: [Boolean, Proc] Report when `if` is truthy (default: true)
-- `stop_report_if`: [Boolean, Proc] Report when `close_if` is falsy (default: false)
-- `stop_report_if_reach_limit`: [Boolean] Stop reporting when reported count reaches limit (default: true)
-- `limit_count`: [Integer] Limit count. Use `report_limit_count` default value if it's nil (default: nil)  
-  Can't be set 0 when `stop_report_if_reach_limit` is true
+- `key`: [String] The identifier to find record by. If `key` has not been passed, `circuit_switches.caller` is chosen as an alternative.
+- `if`: [Boolean, Proc] Reports when the value of `if` is evaluated truthy (default: true)
+- `stop_report_if`: [Boolean, Proc] Reports when the value of `stop_report_if` is evaluated falsy (default: false)
+- `stop_report_if_reach_limit`: [Boolean] Stops reporting when `circuit_switches.report_count` has reached `circuit_switches.report_limit_count` (default: true)
+- `limit_count`: [Integer] Mutates `circuit_switches.report_limit_count` whose value defined in schema is 10 by default. (default: nil)  
+  Can't be set to 0 when `stop_report_if_reach_limit` is true.
 
-To know about report is executed or not, you can get through `report?`.  
+To know if `report` has already been executed or not, you can get through `reported?`.  
 Of course you can chain `report` and `run` or `open?`.
 
 #### `with_backtrace`
@@ -134,6 +138,24 @@ called_path: /app/services/greetings_service:21 block in validate
 /app/controllers/greetings_controller.rb:93 create
 ```
 
+## Test
+
+To test, FactoryBot will look like this;
+
+```ruby
+FactoryBot.define do
+  factory :circuit_switch, class: 'CircuitSwitch::CircuitSwitch' do
+    sequence(:key) { |n| "/path/to/file:#{n}" }
+    sequence(:caller) { |n| "/path/to/file:#{n}" }
+    due_date { Date.tomorrow }
+
+    trait :initially_closed do
+      run_is_terminated { true }
+    end
+  end
+end
+```
+
 ## Task
 
 When find a problem and you want to terminate running or reporting right now, execute a task with it's caller.  

data/circuit_switch.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activejob'
   spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'test-unit'

data/lib/circuit_switch/builder.rb

@@ -46,7 +46,7 @@ module CircuitSwitch
         close_if_reach_limit: close_if_reach_limit,
         limit_count: limit_count,
         initially_closed: initially_closed,
-      }.select { |_, v| v }
+      }.reject { |_, v| v.nil? }
       assign_runner(**arguments)
       execute_run(&block)
     end
@@ -58,7 +58,7 @@ module CircuitSwitch
         stop_report_if: stop_report_if,
         stop_report_if_reach_limit: stop_report_if_reach_limit,
         limit_count: limit_count
-      }.select { |_, v| v }
+      }.reject { |_, v| v.nil? }
       assign_reporter(**arguments)
       execute_report
     end

data/lib/circuit_switch/configuration.rb

@@ -25,6 +25,10 @@ module CircuitSwitch
       report_if.respond_to?(:call) ? report_if.call : !!report_if
     end
 
+    def key_column_name=(key)
+      ::CircuitSwitch::CircuitSwitch.alias_attribute :key, key
+    end
+
     def due_date
       @due_date ||= Date.today + 10
     end

data/lib/circuit_switch/core.rb

@@ -9,6 +9,7 @@ module CircuitSwitch
       :report_if, :stop_report_if, :stop_report_if_reach_limit, :report_limit_count
 
     def execute_run(&block)
+      run_executable = false
       if close_if_reach_limit && run_limit_count == 0
         raise CircuitSwitchError.new('Can\'t set limit_count to 0 when close_if_reach_limit is true')
       end
@@ -21,24 +22,31 @@ module CircuitSwitch
       return self if close_if_reach_limit && switch.reached_run_limit?(run_limit_count)
       return self if switch.run_is_terminated?
 
+      run_executable = true
       unless switch.new_record? && initially_closed
         yield
         @run = true
       end
-      RunCountUpdater.perform_later(
-        key: key,
-        limit_count: run_limit_count,
-        called_path: called_path,
-        reported: reported?,
-        initially_closed: initially_closed
-      )
       self
+    ensure
+      if run_executable
+        RunCountUpdater.perform_later(
+          key: key,
+          limit_count: run_limit_count,
+          called_path: called_path,
+          reported: reported?,
+          initially_closed: initially_closed
+        )
+      end
     end
 
     def execute_report
       if config.reporter.nil?
         raise CircuitSwitchError.new('Set config.reporter.')
       end
+      if config.reporter.arity == 1
+        Logger.new($stdout).info('config.reporter now receives 2 arguments. Improve your `config/initialzers/circuit_switch.rb`.')
+      end
       if stop_report_if_reach_limit && report_limit_count == 0
         raise CircuitSwitchError.new('Can\'t set limit_count to 0 when stop_report_if_reach_limit is true')
       end
@@ -51,6 +59,7 @@ module CircuitSwitch
         key: key,
         limit_count: report_limit_count,
         called_path: called_path,
+        stacktrace: StacktraceModifier.call(backtrace: caller),
         run: run?
       )
       @reported = true

data/lib/circuit_switch/notification.rb

@@ -10,7 +10,7 @@ module CircuitSwitch
   class CalledNotification < CircuitSwitchNotification
     def to_message(called_path:)
       if ::CircuitSwitch.config.with_backtrace
-        "#{message}\ncalled_path: #{called_path}\n#{StacktraceModifier.call(backtrace: backtrace)}"
+        "#{message}\ncalled_path: #{called_path}\n#{backtrace.join("\n")}"
       else
         message
       end

data/lib/circuit_switch/orm/active_record/circuit_switch.rb

@@ -2,6 +2,8 @@ require 'active_record'
 
 module CircuitSwitch
   class CircuitSwitch < ::ActiveRecord::Base
+    validates :key, uniqueness: true
+
     after_initialize do |switch|
       switch.key ||= switch.caller
     end
@@ -28,11 +30,11 @@ module CircuitSwitch
       end
     end
 
-    def increment_run_count
+    def increment_run_count!
       with_writable { update!(run_count: run_count + 1) }
     end
 
-    def increment_report_count
+    def increment_report_count!
       with_writable { update!(report_count: report_count + 1) }
     end
 

data/lib/circuit_switch/stacktrace_modifier.rb

@@ -6,10 +6,14 @@ module CircuitSwitch
       delegate :config, to: ::CircuitSwitch
 
       def call(backtrace:)
-        backtrace
-          .select { |path| /(#{config.allowed_backtrace_paths.join('|')})/.match?(path) }
-          .map { |path| path.sub(/(#{config.strip_paths.join('|')})/, '') }
-          .join("\n")
+        if config.with_backtrace
+          backtrace
+            .select { |path| /(#{config.allowed_backtrace_paths.join('|')})/.match?(path) }
+            .map { |path| path.sub(/(#{config.strip_paths.join('|')})/, '') }
+        else
+          backtrace
+            .select { |path| /(#{config.allowed_backtrace_paths.join('|')})/.match?(path) }
+        end
       end
     end
   end

data/lib/circuit_switch/version.rb

@@ -1,3 +1,3 @@
 module CircuitSwitch
-  VERSION = '0.2.1'
+  VERSION = '0.4.1'
 end

data/lib/circuit_switch/workers/reporter.rb

@@ -5,21 +5,35 @@ module CircuitSwitch
   class Reporter < ::ActiveJob::Base
     delegate :config, to: ::CircuitSwitch
 
-    def perform(key:, limit_count:, called_path:, run:)
+    def perform(key:, limit_count:, called_path:, stacktrace:, run:)
       # Wait for RunCountUpdater saves circuit_switch
       sleep(3) if run
 
-      circuit_switch = key ? CircuitSwitch.find_by(key: key) : CircuitSwitch.find_by(caller: called_path)
-      if run && circuit_switch.nil?
-        raise ActiveRecord::RecordNotFound.new('Couldn\'t find CircuitSwitch::CircuitSwitch')
-      end
+      first_raise = true
+      begin
+        circuit_switch = key ? CircuitSwitch.find_by(key: key) : CircuitSwitch.find_by(caller: called_path)
+        if run && circuit_switch.nil?
+          raise ActiveRecord::RecordNotFound.new('Couldn\'t find CircuitSwitch::CircuitSwitch')
+        end
+
+        circuit_switch ||= CircuitSwitch.new(key: key, caller: called_path)
+        circuit_switch.due_date ||= config.due_date
+        circuit_switch.assign(report_limit_count: limit_count).increment_report_count!
+        raise CalledNotification.new(circuit_switch.message)
+      rescue ActiveRecord::RecordInvalid => e
+        raise e unless first_raise
 
-      circuit_switch ||= CircuitSwitch.new(key: key, caller: called_path)
-      circuit_switch.due_date ||= config.due_date
-      circuit_switch.assign(report_limit_count: limit_count).increment_report_count
-      raise CalledNotification.new(circuit_switch.message)
-    rescue CalledNotification => notification
-      config.reporter.call(notification.to_message(called_path: called_path))
+        first_raise = false
+        sleep(2)
+        retry
+      rescue CalledNotification => notification
+        notification.set_backtrace(stacktrace)
+        if config.reporter.arity == 1
+          config.reporter.call(notification.to_message(called_path: called_path))
+        else
+          config.reporter.call(notification.to_message(called_path: called_path), notification)
+        end
+      end
     end
   end
 end

data/lib/circuit_switch/workers/run_count_updater.rb

@@ -9,14 +9,23 @@ module CircuitSwitch
       # Wait for Reporter saves circuit_switch
       sleep(3) if reported
 
-      circuit_switch = key ? CircuitSwitch.find_by(key: key) : CircuitSwitch.find_by(caller: called_path)
-      if reported && circuit_switch.nil?
-        raise ActiveRecord::RecordNotFound.new('Couldn\'t find CircuitSwitch::CircuitSwitch')
-      end
+      first_raise = true
+      begin
+        circuit_switch = key ? CircuitSwitch.find_by(key: key) : CircuitSwitch.find_by(caller: called_path)
+        if reported && circuit_switch.nil?
+          raise ActiveRecord::RecordNotFound.new('Couldn\'t find CircuitSwitch::CircuitSwitch')
+        end
+
+        circuit_switch ||= CircuitSwitch.new(key: key, caller: called_path, run_is_terminated: initially_closed)
+        circuit_switch.due_date ||= config.due_date
+        circuit_switch.assign(run_limit_count: limit_count).increment_run_count!
+      rescue ActiveRecord::RecordInvalid => e
+        raise e unless first_raise
 
-      circuit_switch ||= CircuitSwitch.new(key: key, caller: called_path, run_is_terminated: initially_closed)
-      circuit_switch.due_date ||= config.due_date
-      circuit_switch.assign(run_limit_count: limit_count).increment_run_count
+        first_raise = false
+        sleep(2)
+        retry
+      end
     end
   end
 end

data/lib/circuit_switch.rb

@@ -31,7 +31,7 @@ module CircuitSwitch
         close_if_reach_limit: close_if_reach_limit,
         limit_count: limit_count,
         initially_closed: initially_closed,
-      }.select { |_, v| v }
+      }.reject { |_, v| v.nil? }
       Builder.new.run(**arguments, &block)
     end
 
@@ -52,7 +52,7 @@ module CircuitSwitch
         stop_report_if: stop_report_if,
         stop_report_if_reach_limit: stop_report_if_reach_limit,
         limit_count: limit_count
-      }.select { |_, v| v }
+      }.reject { |_, v| v.nil? }
       Builder.new.report(**arguments)
     end
 
@@ -76,7 +76,7 @@ module CircuitSwitch
         close_if_reach_limit: close_if_reach_limit,
         limit_count: limit_count,
         initially_closed: initially_closed,
-      }.select { |_, v| v }
+      }.reject { |_, v| v.nil? }
       Builder.new.run(**arguments) {}.run?
     end
   end

data/lib/generators/circuit_switch/migration_generator.rb

@@ -5,12 +5,15 @@ module CircuitSwitch
     desc 'Create a migration to manage circuit switches state'
     source_root File.expand_path('templates', __dir__)
     argument :migration_type, required: false, type: :array, default: ['create'],
-      desc: 'Type of migration to create or add key column. By default to create.',
+      desc: 'Type of migration to create or add key column or make key unique. By default to create.',
       banner: 'create or add_key'
 
     def generate_migration
-      if migration_type == ['add_key']
+      case migration_type
+      when ['add_key']
         migration_template 'add_key.rb.erb', 'db/migrate/add_key_to_circuit_switches.rb', migration_version: migration_version
+      when ['make_key_unique']
+        migration_template 'make_key_unique.rb.erb', 'db/migrate/make_key_unique_for_circuit_switches.rb', migration_version: migration_version
       else
         migration_template 'migration.rb.erb', 'db/migrate/create_circuit_switches.rb', migration_version: migration_version
       end

data/lib/generators/circuit_switch/templates/initializer.rb

@@ -2,7 +2,8 @@
 
 CircuitSwitch.configure do |config|
   # Specify proc to call your report tool: like;
-  # config.reporter = -> (message) { Bugsnag.notify(message) }
+  # config.reporter = -> (message, error) { Bugsnag.notify(error) }
+  # config.reporter = -> (message, error) { Sentry::Rails.capture_message(message) }
   config.reporter = nil
 
   # Condition to report
@@ -16,6 +17,9 @@ CircuitSwitch.configure do |config|
   # Excluded paths to report
   # config.silent_paths =  [CIRCUIT_SWITCH]
 
+  # Alias column name for circuit_switches.key through alias_attribute
+  # config.key_column_name = :key
+
   # Notifier to notify circuit_switch's due_date come and it's time to clean code!
   # Specify proc to call your report tool: like;
   # config.due_date_notifier = -> (message) { Slack::Web::Client.new.chat_postMessage(channel: '#your_channel', text: message) }
@@ -26,11 +30,10 @@ CircuitSwitch.configure do |config|
 
   # Option to contain error backtrace for report
   # You don't need backtrace when you report to some bug report tool.
-  # You may be want backtrace when report to plain feed; e.g. Slack or email.
+  # You may want backtrace when reporting to a plain feed; e.g. Slack or email.
   # config.with_backtrace = false
 
   # Allowed backtrace paths to report
-  # Specify with `with_backtrace` option.
   # Allowed all paths when set `[]`.
   # config.allowed_backtrace_paths = [Dir.pwd]
 

data/lib/generators/circuit_switch/templates/make_key_unique.rb.erb

@@ -0,0 +1,11 @@
+class MakeKeyUniqueForCircuitSwitches < ActiveRecord::Migration<%= migration_version %>
+  def up
+    remove_index :circuit_switches, :key
+    add_index :circuit_switches, :key, unique: true
+  end
+
+  def down
+    remove_index :circuit_switches, :key
+    add_index :circuit_switches, :key
+  end
+end

data/lib/generators/circuit_switch/templates/migration.rb.erb

@@ -1,7 +1,7 @@
 class CreateCircuitSwitches < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :circuit_switches do |t|
-      t.string :key, null: false, index: true
+      t.string :key, null: false
       t.string :caller, null: false
       t.integer :run_count, default: 0, null: false
       t.integer :run_limit_count, default: 10, null: false
@@ -12,5 +12,7 @@ class CreateCircuitSwitches < ActiveRecord::Migration<%= migration_version %>
       t.date :due_date, null: false
       t.timestamps
     end
+
+    add_index :circuit_switches, [:key], unique: true
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit_switch
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.1
 platform: ruby
 authors:
 - makicamel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +145,7 @@ files:
 - lib/generators/circuit_switch/migration_generator.rb
 - lib/generators/circuit_switch/templates/add_key.rb.erb
 - lib/generators/circuit_switch/templates/initializer.rb
+- lib/generators/circuit_switch/templates/make_key_unique.rb.erb
 - lib/generators/circuit_switch/templates/migration.rb.erb
 homepage: https://github.com/makicamel/circuit_switch
 licenses: