circuit_switch 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 948143d874eac4049767af92dacd5f8175ad016a951b93e95e05e3a3585eaf70
-  data.tar.gz: 98981a823c9fa4dd0c20259003766ecf789dd44f7ad0e7bd8983223338f5a550
+  metadata.gz: 6a00a04ad121a8f40a84f78a55e769aaa8f3fc185ac58fab51ddff11a0678e28
+  data.tar.gz: '06189169b6959b97e8a33617f2d9e054f9acf3d55bce2833b39a5f6567a061c6'
 SHA512:
-  metadata.gz: 317208a17b15dfcc29e333c217ee7320b0133a721a918d2917cd3d172615a86ffe73394e74d407454b9ff8e16fa2be702d6d22cc91467793a9260a84bae792ad
-  data.tar.gz: 3ec9b0893cca1eaee59e1aa40c7c3be95348b90760aff1a5fef59053e7dbeb72c627b93940e04b14d0b3c2c2d5159beb00dc13b6b6145b340871734346138428
+  metadata.gz: b63203a04cb3a37e4c6ac265eb8283fdde5b5cb5990c4234bb57876d72c5c26e48ade13907373046dc9f4b8f943f8c6a34e8c6957bceae9ba3857ca087c9c033
+  data.tar.gz: ff59240799e6841334eaffcaa76706cd78268804f8dc263da2c57dfd2bdc480264768ba614fb4102186fa483750ff36eb7c2c0bcc87eb6836f70c0025bcd0361

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 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

data/README.md

@@ -134,6 +134,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/lib/circuit_switch/configuration.rb

@@ -1,5 +1,3 @@
-require 'active_support/core_ext/module/aliasing'
-
 module CircuitSwitch
   class Configuration
     CIRCUIT_SWITCH = 'circuit_switch'.freeze

data/lib/circuit_switch/core.rb

@@ -25,6 +25,8 @@ module CircuitSwitch
         yield
         @run = true
       end
+      self
+    ensure
       RunCountUpdater.perform_later(
         key: key,
         limit_count: run_limit_count,
@@ -32,7 +34,6 @@ module CircuitSwitch
         reported: reported?,
         initially_closed: initially_closed
       )
-      self
     end
 
     def execute_report

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/version.rb

@@ -1,3 +1,3 @@
 module CircuitSwitch
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/circuit_switch/workers/reporter.rb

@@ -9,17 +9,26 @@ module CircuitSwitch
       # 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
+        config.reporter.call(notification.to_message(called_path: called_path))
+      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/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

@@ -29,7 +29,7 @@ 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

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.2
+  version: 0.3.0
 platform: ruby
 authors:
 - makicamel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-31 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -145,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: