patches 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee9d2a7ad9476606358ef1f9d07d4357c51257a2553677310191b0969980ef1b
-  data.tar.gz: bd02a484a3814d0a6ef0eb10b9f391e17c6ea0dfbd84ad83ff3bb18aab514e26
+  metadata.gz: 31f20fe803ffb8762b4ebdbdacb5b33564d67eaa24505ffb8fdd25fc88a6198c
+  data.tar.gz: c7fbbb497911d30dd73555a77f8ea946788de6b43110df7afcf6e680f9a349a3
 SHA512:
-  metadata.gz: 240517aa974013c588bbda1f94dcd387ba4bc4175c8c875cec6a640bc22169ed7e6ef73177d1fc449923f5216c90705fcf1abcad06c7f035ad52aa0e79dcceb9
-  data.tar.gz: bf675bf446a70b10796e4484cdbd69d0e79ef4e1d9c203851fced9b7089a633fedfabbd3ca26c67361fa3acde9da40560c0f8849e80447552f0586f2a4d7c07a
+  metadata.gz: 2b2674ce8e4f2deb2f856e67c32d381bf4007729fad286179b89c0c982c8991b58072c59de133485ea7d9a40071df36778198037569a496a60fa25f4371ce6e1
+  data.tar.gz: 5fee7f04b02862424097a26e51fe6ad376e885637e67aa90f3986942457494900646426a393f3b1a8946fc3fbb748a8bed89619a9cd7e28a2278151a0eefbc34

data/CHANGELOG.md

@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [3.3.0] - 2020-07-20
+### Added
+- Application version constraints
+
 ## [3.2.0] - 2020-07-16
 ### Added
 - Added `Patches::Worker` extra parameters to support forward compatibility with the upcoming releases

data/docs/usage.md

@@ -26,7 +26,7 @@ If you would like to run the patches asynchronously, or would like them to notif
 your Slack channel when they fail or succeed, you need to set up
 an initializer to set those options.
 
-```Ruby
+```ruby
 Patches::Config.configure do |config|
   config.use_sidekiq = true
 
@@ -44,7 +44,7 @@ end
 If you are using the Apartment gem, you can run the patches for each tenant in parallel.
 Just set the config ```sidekiq_parallel``` to ```true``` and you're good to go.
 
-```
+```ruby
 Patches::Config.configure do |config|
   config.use_sidekiq = true
   config.sidekiq_parallel = true
@@ -54,6 +54,23 @@ end
 *Note:* Make sure your sidekiq queue is able to process concurrent jobs.
 You can use ```config.sidekiq_options``` to customise it.
 
+### Application version verification
+
+In environments where a rolling update of sidekiq workers is performed during the deployment, multiple versions of the application run at the same time. If a Patches job is scheduled by the new application version during the rolling update, there is a possibility that it can be executed by the old application version, which will not have all the required patch files.
+
+To prevent this case, set the application version in the config:
+
+```ruby
+Patches::Config.configure do |config|
+  revision_file_path = Rails.root.join('REVISION')
+
+  if File.exist?(revision_file_path)
+    config.application_version = File.read(revision_file_path)
+    config.retry_after_version_mismatch_in = 1.minute
+  end
+end
+```
+
 ## Creating Patches
 
 Generate a patch
@@ -76,7 +93,7 @@ update the run method and then execute
 
 Generate patch with specs
 
-```
+```bash
 bundle exec rails g patches:patch PreferenceUpdate --specs=true
 ```
 
@@ -108,7 +125,7 @@ after sidekiq restarts, otherwise there is no guarentee the tasks will run.
 If a patch requires data assets, you could use S3 to store the file.
 If credentials are defined in env vars, as per https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#id1
 
-```
+```ruby
 require 'aws-sdk-s3'
 Aws::S3::Client.new.get_object(bucket: @bucket_name, key: filename, response_target: destination)
 ```

data/lib/patches/config.rb

@@ -14,8 +14,15 @@ module Patches
       end
 
       class Configuration
-        attr_accessor :use_sidekiq, :sidekiq_queue, :sidekiq_options,
-          :sidekiq_parallel, :use_slack, :slack_options
+        attr_accessor \
+          :application_version,
+          :retry_after_version_mismatch_in,
+          :sidekiq_options,
+          :sidekiq_parallel,
+          :sidekiq_queue,
+          :slack_options,
+          :use_sidekiq,
+          :use_slack
 
         def initialize
           @sidekiq_queue = 'default'
@@ -25,6 +32,10 @@ module Patches
           @sidekiq_options ||= { retry: false, queue: sidekiq_queue }
         end
 
+        def retry_after_version_mismatch_in
+          @retry_after_version_mismatch_in ||= 1.minute
+        end
+
         def slack_channel
           slack_options[:channel]
         end

data/lib/patches/version.rb

@@ -1,6 +1,6 @@
 module Patches
   MAJOR = 3
-  MINOR = 2
+  MINOR = 3
   PATCH = 0
   VERSION = [MAJOR, MINOR, PATCH].compact.join(".").freeze
 end

data/lib/patches/worker.rb

@@ -6,6 +6,18 @@ class Patches::Worker
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
   def perform(runner, params = {})
-    runner.constantize.new.perform
+    if valid_application_version?(params)
+      runner.constantize.new.perform
+    else
+      self.class.perform_in(Patches::Config.configuration.retry_after_version_mismatch_in, runner, params)
+    end
+  end
+
+  private
+
+  def valid_application_version?(params)
+    return true unless params['application_version']
+    return true unless Patches::Config.configuration.application_version
+    Patches::Config.configuration.application_version == params['application_version']
   end
 end

data/lib/tasks/patches.rake

@@ -8,7 +8,10 @@ namespace :patches do
     end
 
     if defined?(Sidekiq) && Patches::Config.configuration.use_sidekiq
-      Patches::Worker.perform_async(runner)
+      Patches::Worker.perform_async(
+        runner,
+        application_version: Patches::Config.configuration.application_version
+      )
     else
       runner.new.perform
     end

data/patches.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "sqlite3", "~> 1.3.5"
-  spec.add_development_dependency "rspec-rails", "~> 3.2.0"
+  spec.add_development_dependency "rspec-rails", "~> 4.0.0"
   spec.add_development_dependency "capybara", "~> 2.3.0"
   spec.add_development_dependency "generator_spec", "~> 0.9.0"
   spec.add_development_dependency "simplecov", "~> 0.10"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: patches
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - JobReady
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement