ready-for-migration 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0594c87355e8056fb15067e0aab39c234d56f603e10377f86fde0b65d48e3fdf'
-  data.tar.gz: c140de4c6b325e2655bffb64abdc3fc3b6eb95cc85ae49053679275baad3e78c
+  metadata.gz: 2bbd767ff83942c2a4350e319b1e5bde3e89f2367020b0dec977b20a5471be94
+  data.tar.gz: 2acef1d15ecdddc72940d2c6fd59d146637f3311a5f67c07aa40a545543459f9
 SHA512:
-  metadata.gz: affa9b3b0aa6def18e31f46876232f96b6497b7c48528fa13f9059950a1a063606ba053d6996da3beec1e2cf51743ae72cdcbb7ee571787655a740229a9ae6fb
-  data.tar.gz: 3fee0628bb2f9192fb508986dfcb346c519e3ab08b989cbca07442fc0285366c8ba4d69f8b7ede426f404fe45de6d9330f527ba0a13f70a1dca8d9b854a16ecd
+  metadata.gz: 03e072cff695d1913c05116d78372dc84b673569328b6de0a25f2c83fd8d073fc39f3e42dc730635234627b0ccf0329ce07de1670597b417da995c4794b70078
+  data.tar.gz: ebe49ef79d0bafbd7f6fcc42243e91eeae3902f61e9380ae058fc00cc59c3c835db5220f56b90a9406551fd16eba89d4a645c716aeba04930556b2457a3fae6a

data/README.md

@@ -29,5 +29,23 @@ Or install it yourself as:
 $ gem install ready-for-migration
 ```
 
+## Simulate Health Check Response
+
+You can simulate health check response by adding specific query parameters to your health check requests.
+
+Here's the pattern we're providing. (values are just an example)
+
+|pattern|behavior|
+|--|--|
+|No query parameters|health check as usual.|
+|`?status=503`|respond with specified status code.|
+|`?status=503&after=60`|respond with specified status code once specified seconds have passed since the first access with `after`.|
+|`?status=503&sleep=60`|respond with specified status code after sleeping specified seconds.|
+|`?status=503&random=10` |randomly respond with specified status code, once in a specified number as `random`.|
+|`?sleep=60` |health check after sleeping specified seconds.|
+
+NOTE: Other patterns than listed in the above example will be ignored.  
+NOTE: "sleep" parameter is disabled in default for avoiding DoS attack. To enabling this, you set environment variables "RFM_ENABLE_SLEEP" as "1".
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/concerns/ready/for/migration/health_action_inspectable.rb

@@ -0,0 +1,112 @@
+require 'active_support/cache/file_store'
+
+module Ready
+  module For
+    module Migration
+      module HealthActionInspectable
+
+        def self.cache
+          @cache ||= ActiveSupport::Cache::MemoryStore.new
+        end
+
+        def self.sleep_enabled?
+          return false if ENV['RFM_ENABLE_SLEEP'].nil?
+          b = [ false, 0,
+                "0", :"0",
+                "f", :f,
+                "F", :F,
+                "false", :false,
+                "FALSE", :FALSE,
+                "off", :off,
+                "OFF", :OFF,
+              ].include?(ENV['RFM_ENABLE_SLEEP'])
+          return !b
+        end
+
+        def readiness
+          if params.has_key?(:status)
+            case
+            when params.has_key?(:after)
+              perform_inspection_with_status_and_after
+            when params.has_key?(:sleep)
+              perform_inspection_with_status_and_sleep
+            when params.has_key?(:random)
+              perform_inspection_with_status_and_random
+            else
+              perform_inspection_with_status
+            end
+          elsif params.has_key?(:sleep)
+            perform_inspection_with_sleep
+          end
+
+          super unless performed?
+        end
+
+        private
+
+          def get_status_value
+            raw = params.dig(:status)
+            status = raw.to_i if raw && /^\d{3}$/.match?(raw)
+            status
+          end
+
+          def get_after_value
+            raw = params.dig(:after)
+            value = raw.to_i if raw && /^\d+$/.match?(raw)
+            value
+          end
+
+          def get_random_value
+            raw = params.dig(:random)
+            value = raw.to_i if raw && /^\d+$/.match?(raw)
+            value
+          end
+
+          def get_sleep_value
+            raw = params.dig(:sleep)
+            value = raw.to_i if raw && /^\d+$/.match?(raw)
+            value
+          end
+
+          def perform_inspection_with_status_and_after
+            return unless status = get_status_value
+            return unless value = get_after_value
+
+            first_access_time = Ready::For::Migration::HealthActionInspectable.cache.fetch(:first_access_time) { Time.now }
+            if first_access_time + value < Time.now
+              head status
+            end
+          end
+
+          def perform_inspection_with_status_and_sleep
+            return unless status = get_status_value
+            return unless value = get_sleep_value
+
+            sleep(value) if Ready::For::Migration::HealthActionInspectable.sleep_enabled?
+            head status
+          end
+
+          def perform_inspection_with_status_and_random
+            return unless status = get_status_value
+            return unless value = get_random_value
+
+            if value == 1 || rand(value - 1) == 0
+              head status
+            end
+          end
+
+          def perform_inspection_with_status
+            return unless status = get_status_value
+            head status
+          end
+
+          def perform_inspection_with_sleep
+            return unless value = get_sleep_value
+
+            sleep(value) if Ready::For::Migration::HealthActionInspectable.sleep_enabled?
+          end
+
+      end
+    end
+  end
+end

data/app/controllers/ready/for/migration/health_controller.rb

@@ -2,6 +2,7 @@ module Ready
   module For
     module Migration
       class HealthController < ::ActionController::Base
+        prepend HealthActionInspectable
 
         def readiness
           if ApplicationRecord.connection.migration_context.needs_migration?

data/lib/ready/for/migration/engine.rb

@@ -2,6 +2,10 @@ module Ready
   module For
     module Migration
       class Engine < ::Rails::Engine
+
+        initializer 'ready-for-migration.initialize_cache' do
+          Ready::For::Migration::HealthActionInspectable.cache.write(:first_access_time, Time.now)
+        end
       end
     end
   end

data/lib/ready/for/migration/version.rb

@@ -1,7 +1,7 @@
 module Ready
   module For
     module Migration
-      VERSION = '0.1.1'
+      VERSION = '0.1.3'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ready-for-migration
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - bizside-developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -60,6 +60,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/concerns/ready/for/migration/health_action_inspectable.rb
 - app/controllers/ready/for/migration/health_controller.rb
 - config/routes.rb
 - lib/ready/for/migration.rb
@@ -84,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: ready for migration