patches 2.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a726ce30a4830757598e3c8e1a418ae177496782f61b2863709389be96c4d086
-  data.tar.gz: 83c927ddd30bf534d0925c9962faea4a1b8ae384ed0f726997eb0c595a0f8312
+  metadata.gz: 00a5a2af4415f00b094e7a41da3c17ddb61d17c9e23987aa16dddf789aec7794
+  data.tar.gz: 3125f98fb50e54c658a2be70a369f2627c138fb50c1ba8f9c417c5139a144f56
 SHA512:
-  metadata.gz: 5ca1c096b455735c6ac1dd2b2bd246126fb1fc45d0d253d099234b3fd4bc3f22f13dec67d1c2708efea16afdbe7d25d4b57c61743540803c9bb7097122e7d8f4
-  data.tar.gz: e6495c336cc87c106e7943ec7fbd2798aaa8010bda3a024357f7bbf4b4fcac1b5c703db81e166fc3451bac96e699614118eda1027306dfb4462b97540700d21c
+  metadata.gz: d57ccb9aca3ab7c179dce484a7e2021631ef0c70d86bc00f73c921636184d42e372a85a6ab321e599731c72dfcf40716b52a234d7c33bebb9ba8d102d64ba212
+  data.tar.gz: ed55b40b2ebb05dc6db25c7ccc07a09f774360816fe39a21e1b79903c306bcdd4a4a5b82b2db262966224e1f712656b8eac7bb423f93db004d59d63af26a6763

data/CHANGELOG.md

@@ -6,6 +6,34 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.5.0] - 2020-07-22
+### Added
+- Enable application version constraint support on `Patches::TenantWorker`
+
+## [3.4.0] - 2020-07-22
+### Added
+- `Patches::TenantWorker` application version constraint forward compatibility
+
+## [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
+
+## [3.1.0] - 2019-11-25
+### Fixed
+- Gem compatibility with Apartment 2
+
+## [3.0.1] - 2018-11-19
+### Added
+- Set icon_emoji of posted slack message to :dog:
+
+## [3.0.0] - 2018-11-19
+### Removed
+- Hipchat is no longer supported
+
 ## [2.4.1] - 2018-09-19
 ### Changed
 - Corrected gem ownership and authors.

data/docs/usage.md

@@ -23,21 +23,13 @@ bundle exec rake db:migrate
 ## Configuration
 
 If you would like to run the patches asynchronously, or would like them to notify
-your hipchat room or Slack channel when they fail or succeed, you need to set up
+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
 
-  config.use_hipchat = true
-  config.hipchat_options = {
-    api_token: ENV['HIPCHAT_TOKEN'],
-    room: ENV['HIPCHAT_ROOM'],
-    user: ENV['HIPCHAT_USERNAME'], # maximum of 15 characters
-    api_version: 'v1', # optional
-  }
-
   config.use_slack = true
   config.slack_options = {
     webhook_url: ENV['SLACK_WEBHOOK_URL'],
@@ -52,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
@@ -62,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
@@ -84,7 +93,7 @@ update the run method and then execute
 
 Generate patch with specs
 
-```
+```bash
 bundle exec rails g patches:patch PreferenceUpdate --specs=true
 ```
 
@@ -116,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.rb

@@ -22,6 +22,7 @@ end
 require "patches/base"
 require "patches/config"
 require "patches/tenant_run_concern"
+require "patches/application_version_validation"
 require "patches/tenant_worker" if defined?(Sidekiq)
 require "patches/engine" if defined?(Rails)
 require "patches/patch"

data/lib/patches/application_version_validation.rb

@@ -0,0 +1,9 @@
+module Patches
+  module ApplicationVersionValidation
+    def valid_application_version?(application_version)
+      return true unless application_version
+      return true unless Patches::Config.configuration.application_version
+      Patches::Config.configuration.application_version == application_version
+    end
+  end
+end

data/lib/patches/config.rb

@@ -14,8 +14,15 @@ module Patches
       end
 
       class Configuration
-        attr_accessor :use_sidekiq, :sidekiq_queue, :sidekiq_options, :use_hipchat,
-          :hipchat_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,20 +32,8 @@ module Patches
           @sidekiq_options ||= { retry: false, queue: sidekiq_queue }
         end
 
-        def hipchat_api_token
-          hipchat_options[:api_token]
-        end
-
-        def hipchat_init_options
-          hipchat_options.except(:api_token, :room, :user)
-        end
-
-        def hipchat_room
-          hipchat_options[:room]
-        end
-
-        def hipchat_user
-          hipchat_options[:user]
+        def retry_after_version_mismatch_in
+          @retry_after_version_mismatch_in ||= 1.minute
         end
 
         def slack_channel

data/lib/patches/notifier.rb

@@ -3,12 +3,10 @@ require 'slack-notifier'
 class Patches::Notifier
   class << self
     def notify_success(patches)
-      send_hipchat_message(success_message(patches), color: 'green')
       send_slack_message(success_message(patches), 'good')
     end
 
     def notify_failure(patch_path, error)
-      send_hipchat_message(failure_message(patch_path, error), color: 'red')
       send_slack_message(failure_message(patch_path, error), 'danger')
     end
 
@@ -32,14 +30,6 @@ class Patches::Notifier
       message
     end
 
-    def send_hipchat_message(message, options)
-      return unless defined?(HipChat) && config.use_hipchat
-
-      client = HipChat::Client.new(config.hipchat_api_token, config.hipchat_init_options)
-      room = client[config.hipchat_room]
-      room.send(config.hipchat_user, message, options)
-    end
-
     def send_slack_message(message, color)
       return unless defined?(Slack) && config.use_slack
 
@@ -48,7 +38,7 @@ class Patches::Notifier
         channel: config.slack_channel,
         username: config.slack_username)
 
-      payload = { attachments: [{ color: color, text: message }] }
+      payload = { icon_emoji: ":dog:", attachments: [{ color: color, text: message }] }
 
       notifier.post payload
     end

data/lib/patches/tenant_run_concern.rb

@@ -1,8 +1,9 @@
 module Patches
   module TenantRunConcern
     def run(tenant_name, path = nil)
-      Apartment::Tenant.switch(tenant_name)
-      Patches::Runner.new(path).perform
+      Apartment::Tenant.switch(tenant_name) do
+        Patches::Runner.new(path).perform
+      end
     end
   end
 end

data/lib/patches/tenant_runner.rb

@@ -11,7 +11,11 @@ class Patches::TenantRunner
     Patches.logger.info("Patches tenant runner for: #{tenants.join(',')}")
     tenants.each do |tenant|
       if parallel?
-        Patches::TenantWorker.perform_async(tenant, path)
+        Patches::TenantWorker.perform_async(
+          tenant,
+          path,
+          application_version: Patches::Config.configuration.application_version
+        )
       else
         run(tenant, path)
       end

data/lib/patches/tenant_worker.rb

@@ -3,10 +3,15 @@ require 'sidekiq'
 class Patches::TenantWorker
   include Sidekiq::Worker
   include Patches::TenantRunConcern
+  include Patches::ApplicationVersionValidation
 
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
-  def perform(tenant_name, path)
-    run(tenant_name, path)
+  def perform(tenant_name, path, params = {})
+    if valid_application_version?(params['application_version'])
+      run(tenant_name, path)
+    else
+      self.class.perform_in(Patches::Config.configuration.retry_after_version_mismatch_in, tenant_name, path, params)
+    end
   end
 end

data/lib/patches/version.rb

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

data/lib/patches/worker.rb

@@ -2,10 +2,15 @@ require 'sidekiq'
 
 class Patches::Worker
   include Sidekiq::Worker
+  include Patches::ApplicationVersionValidation
 
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
-  def perform(runner)
-    runner.constantize.new.perform
+  def perform(runner, params = {})
+    if valid_application_version?(params['application_version'])
+      runner.constantize.new.perform
+    else
+      self.class.perform_in(Patches::Config.configuration.retry_after_version_mismatch_in, runner, params)
+    end
   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"
@@ -34,7 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "database_cleaner", "~> 1.3.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "sidekiq", "~> 3.4.1"
-  spec.add_development_dependency "hipchat"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patches
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - JobReady
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -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
@@ -206,20 +206,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.1
-- !ruby/object:Gem::Dependency
-  name: hipchat
-  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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +261,7 @@ files:
 - lib/generators/patches/templates/patch.rb.erb
 - lib/generators/patches/templates/patch_spec.rb.erb
 - lib/patches.rb
+- lib/patches/application_version_validation.rb
 - lib/patches/base.rb
 - lib/patches/capistrano.rb
 - lib/patches/capistrano/tasks.rake
@@ -291,7 +278,6 @@ files:
 - lib/patches/worker.rb
 - lib/tasks/patches.rake
 - patches.gemspec
-- script/buildkite.sh
 homepage: http://github.com/jobready/patches
 licenses:
 - MIT
@@ -311,8 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple gem for one off tasks

data/script/buildkite.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-set -e
-
-echo '--- setting ruby version'
-cd /var/lib/buildkite-agent/.rbenv/plugins/ruby-build && git pull && cd -
-rbenv install 2.3.7 -s
-rbenv local 2.3.7
-
-echo '--- setting up env'
-REVISION=https://github.com/$BUILDBOX_PROJECT_SLUG/commit/$BUILDBOX_COMMIT
-
-echo '--- bundling'
-bundle install -j $(nproc) --without production --quiet
-
-echo '--- running specs'
-if bundle exec rspec; then
-  echo "[Successful] $BUILDBOX_PROJECT_SLUG - Build - $BUILDBOX_BUILD_URL - Commit - $REVISION" | hipchat_room_message -t $HIPCHAT_TOKEN -r $HIPCHAT_ROOM -f "Buildbox" -c "green"
-else
-  echo "[Failed] Build $BUILDBOX_PROJECT_SLUG - Build - $BUILDBOX_BUILD_URL - Commit - $REVISION" | hipchat_room_message -t $HIPCHAT_TOKEN -r $HIPCHAT_ROOM -f "Buildbox" -c "red"
-  exit 1;
-fi