resque-await-migration 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56f8cf84358b4fa5c1773af7645d46f62acda79aefc2fb25563f5d3258dd974f
+  data.tar.gz: bea23dd7eb4a03147d68b4885900032603089352e8bb1a8d32481c9989da66aa
+SHA512:
+  metadata.gz: a58901ba51c76227b186bd1da0b5d8eaa5c7c13d854ecfc35a843a2478a4c1570403325774e9db7d5168afe9da029123e985078ce6ed75a5322ecadedc6c4189
+  data.tar.gz: 73edfa5ead862a4d008d7867772353832106ecd3e377de05e2e047a99e4ac5156d861f7119bf09f8514596e32efd88345e1a8b1c03b8207ce33547c6409592d4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 sera
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Resque::Await::Migration
+
+This is a Resque Plugin that allows the Resque Worker to wait until the ActiveRecord's migration has done.
+
+## Installation & Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-await-migration'
+```
+
+Just do this, your application's Resque Worker will wait for the migration to complete.
+
+## How it works
+
+Resque::Await::Migration monitors whether ActiveRecord migration has been applied or not in a child process.
+
+The child process is forked from the ResqueWorker process in the before_first_fork hook of Resque.
+And, terminated when it is confirmed that the migration has been applied.
+
+### Monitoring
+
+If the migration has not yet been applied, it sends a USR2 signal to the Resque Worker to stop the process.
+When the migration has been applied, it sends a CONT signal and resumes processing.
+
+The monitoring interval and time limit can be specified by the following environment variables.
+
+* INTERVAL ... monitoring interval seconds. default: 5(sec)
+* AWAIT_MIGRATION_LIMIT ... Time limit waiting for migration to be applied. default: 3600(sec)
+
+### Logging
+
+The execution log is output to Resque.logger.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/resque/await/migration/controller.rb

@@ -0,0 +1,67 @@
+require 'active_record'
+require 'resque'
+
+module Resque
+  module Await
+    module Migration
+
+      class Controller
+        class << self
+
+          def start
+
+            return unless (ActiveRecord::Base.connection rescue false)
+            return unless ActiveRecord::Base.connection.migration_context.needs_migration?
+
+            parent_pid = Process.pid
+            @_child_pid = fork { self.check_in_forked(parent_pid) }
+            @_thread = Process.detach(@_child_pid)
+          end
+
+          def stop_if_alive
+            if @_thread && @_thread.alive?
+              Process.kill(:KILL, @_child_pid)
+            end
+          end
+
+          def check_in_forked(parent_pid)
+
+            interval         = ENV['INTERVAL'] || 5
+            timeout_limit    = ENV['AWAIT_MIGRATION_LIMIT'] || 60 * 60 # 60 minutes
+            usr2_was_sent_at = Time.now.to_i
+
+            _info_log "Migration is needed. Send signal:USR2 to PID:#{parent_pid}"
+            Process.kill(:USR2, parent_pid)
+
+            begin
+              while ActiveRecord::Base.connection.migration_context.needs_migration?
+                sleep interval
+
+                if Time.now.to_i - usr2_was_sent_at > timeout_limit
+                  _info_log "Time limit for awaiting migration has been exceeded. LIMIT:#{timeout_limit}"
+                  _info_log "So, abort resque worker."
+
+                  _info_log "Send signal:TERM to PID:#{parent_pid}"
+                  Process.kill(:TERM, parent_pid)
+                  return
+                end
+              end
+              _info_log "Migration has finished. Send signal:CONT to PID:#{parent_pid}"
+              Process.kill(:CONT, parent_pid)
+
+            rescue => e
+              _info_log "Caught Error: #{e}\n" + e.backtrace.join("\n")
+              _info_log "Send signal:CONT to PID:#{parent_pid}"
+              Process.kill(:CONT, parent_pid)
+            end
+          end
+
+          def _info_log(msg)
+            Resque.logger.info msg
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/resque/await/migration/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Await
+    module Migration
+      VERSION = '0.1.1'
+    end
+  end
+end

data/lib/resque/await/migration.rb

@@ -0,0 +1,23 @@
+require "resque"
+require 'resque/await/migration/controller'
+
+module Resque
+  module Await
+    module Migration
+
+      def setup
+        Resque.before_first_fork do
+          Resque::Await::Migration::Controller.start
+        end
+
+        Resque.worker_exit do
+          Resque::Await::Migration::Controller.stop_if_alive
+        end
+      end
+      module_function :setup
+
+    end
+  end
+end
+
+Resque::Await::Migration.setup

data/lib/tasks/check_migration.rake

@@ -0,0 +1,17 @@
+
+namespace :resque_await_migration do
+  desc "マイグレーションチェックする処理を実行します"
+  task :check_migration => :environment  do
+    pid = ENV['ORIGIN_PID']
+    helper = Resque::Await::Migration::ResqueHelper.new
+    helper.check_migration(pid)
+  end
+
+  task :beforeJob => :environment  do
+    puts "バックグラウンド処理を実行します"
+    sh "ORIGIN_PID=#{$$} bundle exec rake resque_await_migration:check_migration &"
+    puts "バックグラウンド処理を実行しました"
+  end
+end
+
+Rake::Task[:'resque:work'].enhance([:'resque_await_migration:beforeJob'])

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: resque-await-migration
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- bizside-developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: add rake task for resque to await DB migration of activerecord
+email:
+- bizside-developers@lab.acs-jp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/resque/await/migration.rb
+- lib/resque/await/migration/controller.rb
+- lib/resque/await/migration/version.rb
+- lib/tasks/check_migration.rake
+homepage: https://github.com/maedadev/resque-await-migration
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: resque await migration
+test_files: []