synchronised_migration 1.0.2.pre.alpha.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 46137a7221280e53c8a46dffc717f940e94cf02e
-  data.tar.gz: bfacb7b23898da580e100d53eb1fbc0d7b641cdc
+SHA256:
+  metadata.gz: 9881480f34d86d8a177756df3a12e3ec54d1f6b9cfa80d2847084101749bca5a
+  data.tar.gz: e79ad9a4ceddcd69a1936789d485c50daa3bbdc95ef74f2052eac8aef08d65b2
 SHA512:
-  metadata.gz: ee2658296ac508f679c42af3e18031ff860aba20f07f9a7f89342ea710565ff6afa477d42007f73dbd265090c9724d60ba34907e6636aa3cbb00efe5a787faad
-  data.tar.gz: fc49da8ca250dd9a5fa0b0769c4c343a60a4cdb95b556bdc7b622b15e4c2df81b2f3286b165c0cdd76ddfd791a3eca3b4b68cbbe89225981694875897dbcf30c
+  metadata.gz: b921a8a53758ec6a7654c3decd2b86b2e60baf58336ce31a1eaded4cf7a266ad35e1603c2bc81547b94fc4617f7e5175e5bae7e052013c68004c410d6f410263
+  data.tar.gz: 2f934aebd9d2c5978fe368be30e606622861480ed2fd61d1a422c70d33ad8a391b7d19802743c29c3e16cff9e61972bc80051a3a460928d0f195169ce0c8d0de

data/.gitignore

@@ -2,3 +2,4 @@
 /vendor
 /coverage
 /*.gem
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-2.2.7
+2.6.3

data/.travis.yml

@@ -1,3 +1,10 @@
----
 language: ruby
-script: bundle && bundle exec rspec
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+script: bundle exec rspec
+sudo: false
+cache: bundler
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Synchronised Migration
 
+## 2.1.2
+
+* [TT-7511] Use the correct `ex` option for key value expiry times instead of `ttl`
+
+## 2.1.1
+
+* [TT-5896] Early exit from migration inside lock if already completed
+
+## 2.1.0
+
+* [TT-5827] Add "success key" when REDLOCK_VERSION_SUFFIX is set, preventing repeat runs
+* [TT-5830] Add rake and Rakefile for 'rake release'
+
+## 2.0.0
+
+* [DO-168] Removed requirement for defining RedisConfig, now set on
+  SynchronisedMigration module
+
+## 1.0.2
+
+* [DO-105] Use the `original` environment instead
+
 ## 1.0.1
 
 * [DO-100] Address the Travis issue

data/README.md

@@ -15,14 +15,19 @@ Docker](https://github.com/sealink/craft-docker) project.
 
 ## Usage
 
-Class `RedisConfig` needs to be provided as follow.
+Module `SynchronisedMigration` needs to be configured as below.
 
 ```
-RedisConfig.get[:host] # example.com
-RedisConfig.get[:port] # 6379
-RedisConfig.get[:db] # 0
+  SynchronisedMigration.configure do |config|
+    config.host = 'example.com'
+    config.port = 6379
+    config.db = 0
+  end
 ```
 
+Configuration can be called by using
+```SynchronisedMigration.redis_config.host``` or similar.
+
 You may override these settings through environment variables.
 
 ```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'

data/lib/synchronised_migration.rb

@@ -1,4 +1,22 @@
 module SynchronisedMigration
+  class << self
+    attr_accessor :redis_config
+  end
+
+  def self.configure
+    self.redis_config ||= Configuration.new
+    yield(redis_config)
+  end
+
+  class Configuration
+    attr_accessor :host, :port, :db
+
+    def initialize
+      @host = ''
+      @port = 0
+      @db   = 0
+    end
+  end
 end
 
 require 'synchronised_migration/railtie' if defined?(Rails)

data/lib/synchronised_migration/main.rb

@@ -15,11 +15,16 @@ class SynchronisedMigration::Main
   end
 
   def call
-    lock_and_execute
+    done_or_execute
   end
 
   private
 
+  def done_or_execute
+    return Result.ok if migration_already_completed?
+    lock_and_execute
+  end
+
   def lock_and_execute
     redlock.lock! lock_key, timeout do
       execute
@@ -27,12 +32,26 @@ class SynchronisedMigration::Main
   end
 
   def execute
-    return Result.new 'Halting the script because the previous migration failed.' if previous_failed?
+    return Result.ok if migration_already_completed?
+    return Result.fail 'Halting the script because the previous migration failed.' if previous_failed?
     mark_failed
-    migrate
-    return Result.new 'Migration failed.' if migration_failed?
+    migration_success = migrate
+    return Result.fail 'Migration failed.' unless migration_success
+    mark_successful
     remove_fail_marker
-    Result.new
+    return Result.ok
+  end
+
+  def migration_already_completed?
+    return false if !success_key
+    value = redis.get(success_key)
+    not value.nil? and not value.empty?
+  end
+
+  def mark_successful
+    if success_key
+      redis.set success_key, timestamp, ex: 3600*24*30
+    end
   end
 
   def previous_failed?
@@ -41,7 +60,7 @@ class SynchronisedMigration::Main
   end
 
   def mark_failed
-    redis.set fail_key, 1
+    redis.set fail_key, timestamp, ex: 3600
   end
 
   def remove_fail_marker
@@ -49,20 +68,20 @@ class SynchronisedMigration::Main
   end
 
   def migrate
-    return Kernel.system target_command unless with_clean_env?
-    Bundler.with_original_env do
-      Kernel.system target_command
+    if with_clean_env?
+      Bundler.with_original_env do
+        Kernel.system target_command
+      end
+    else
+       Kernel.system target_command
     end
+    $?.success?
   end
 
   def with_clean_env?
     not ENV.fetch('WITH_CLEAN_BUNDLER_ENV', '').empty?
   end
 
-  def migration_failed?
-    not $?.success?
-  end
-
   def target_command
     ENV.fetch 'SYNCHRONISED_COMMAND', 'bin/launch/migrate'
   end
@@ -83,18 +102,22 @@ class SynchronisedMigration::Main
   def redis_url
     sprintf(
       'redis://%s:%s/%s',
-      RedisConfig.get[:host],
-      RedisConfig.get[:port],
-      RedisConfig.get[:db]
+      SynchronisedMigration.redis_config.host,
+      SynchronisedMigration.redis_config.port,
+      SynchronisedMigration.redis_config.db
     )
   end
 
+  def timestamp
+    Time.now.to_i
+  end
+
   def timeout
     ENV.fetch('REDLOCK_TIMEOUT_MS', 3_600_000).to_i
   end
 
   def retry_delay
-    ENV.fetch('REDLOCK_RETRY_DELAY_MS', 200).to_i
+    ENV.fetch('REDLOCK_RETRY_DELAY_MS', 3000).to_i
   end
 
   def retry_count
@@ -106,6 +129,16 @@ class SynchronisedMigration::Main
   end
 
   def fail_key
-    ENV.fetch 'REDLOCK_FAIL_KEY', 'migration-failed'
+    ENV.fetch 'REDLOCK_FAIL_KEY', 'migration-failed' + version_suffix
+  end
+
+  def success_key
+    return false if version_suffix.empty?
+    'migration-success' + version_suffix
+  end
+
+  def version_suffix
+    suffix = ENV.fetch 'REDLOCK_VERSION_SUFFIX', false
+    suffix ? '-' + suffix : ''
   end
 end

data/lib/synchronised_migration/result.rb

@@ -10,4 +10,12 @@ class SynchronisedMigration::Result
   def success?
     error.nil?
   end
+
+  def self.ok
+    self.new
+  end
+
+  def self.fail(error)
+    self.new error
+  end
 end

data/lib/synchronised_migration/version.rb

@@ -1,3 +1,3 @@
 module SynchronisedMigration
-  VERSION = '1.0.2-alpha.1'
+  VERSION = '2.1.2'
 end

data/spec/synchronised_migration/main_spec.rb

@@ -9,19 +9,43 @@ describe SynchronisedMigration::Main do
     let(:redis) { double }
     let(:redlock) { double }
     let(:fail_marker_value) { nil }
+    let(:success_marker_value) { nil }
+    let(:version_suffix) { 'bork' }
+    let(:set_version_suffix) { ENV['REDLOCK_VERSION_SUFFIX'] = version_suffix }
+    let(:time_value) { double(to_i: 123456789) }
 
     before do
+      set_version_suffix
+
       subject.instance.instance_variable_set :@redis, nil
       subject.instance.instance_variable_set :@redlock, nil
 
+      allow(subject.instance).to receive(:execute).and_call_original
+      allow(subject.instance).to receive(:migrate).and_call_original
+
       allow(Redis).to receive(:new).and_return(redis)
-      allow(redis).to receive(:get).and_return(fail_marker_value)
+      allow(redis).to receive(:get) { |key|
+        case key
+        when "migration-failed-#{version_suffix}"
+          fail_marker_value
+        when "migration-failed"
+          fail_marker_value
+        when "migration-success-#{version_suffix}"
+          success_marker_value
+        when "migration-success"
+          success_marker_value
+        else
+          raise "invalid key for redis get: #{key}"
+        end
+      }
       allow(redis).to receive(:set)
       allow(redis).to receive(:del)
 
       allow(Redlock::Client).to receive(:new).and_return(redlock)
       allow(redlock).to receive(:lock!) { |lock_key, timeout, &block| block.call }
 
+      allow(Time).to receive(:now).and_return(time_value)
+
       allow(Kernel).to receive(:system).and_wrap_original { |method, *args|
         next if args == [ 'bin/launch/migrate' ]
         method.call *args
@@ -29,26 +53,49 @@ describe SynchronisedMigration::Main do
 
       allow(Bundler).to receive(:with_original_env).and_call_original
 
-      stub_const(
-        'RedisConfig', double(
-          get: {
-            host: 'example.com',
-            port: 6379,
-            db: 0
-          }
-        )
-      )
+      SynchronisedMigration.configure do |config|
+        config.host = 'example.com'
+        config.port = 6379
+        config.db = 0
+      end
     end
 
     context 'in the happy path' do
       it 'executes the migration successfully' do
         expect(result).to be_success
         expect(redlock).to have_received(:lock!)
-        expect(redis).to have_received(:get).with('migration-failed')
-        expect(redis).to have_received(:set).with('migration-failed', 1)
+        expect(redis).to have_received(:get).with('migration-failed-bork')
+        expect(redis).to have_received(:set).with('migration-failed-bork', 123456789, ex: 3600)
+        expect(redis).to have_received(:set).with('migration-success-bork', 123456789, ex: 3600*24*30)
         expect(Kernel).to have_received(:system)
         expect(Bundler).not_to have_received(:with_original_env)
-        expect(redis).to have_received(:del).with('migration-failed')
+        expect(redis).to have_received(:del).with('migration-failed-bork')
+      end
+
+      context 'and migration completed previously' do
+        let(:success_marker_value) { '1' }
+        it 'contines without executing' do
+          expect(result).to be_success
+          expect(redlock).not_to have_received(:lock!)
+        end
+      end
+
+      context 'executing in lock waiter' do
+        let(:result2) { subject.call }
+
+        before do
+          # Note: bypasses the first success flag check so it can enter lock.
+          expect(result).to be_success
+          allow(redis).to receive(:get).and_return(nil, '1')
+        end
+
+        it 'early exits and does not execute again', :aggregate_failures do
+          expect(result2).to be_success
+          expect(redlock).to have_received(:lock!).exactly(2).times
+          expect(Kernel).to have_received(:system).exactly(1).times
+          expect(subject.instance).to have_received(:execute).exactly(2).times
+          expect(subject.instance).to have_received(:migrate).exactly(1).times
+        end
       end
     end
 
@@ -81,9 +128,37 @@ describe SynchronisedMigration::Main do
 
       it 'marks the failure in Redis' do
         expect(result).not_to be_success
-        expect(redis).to have_received(:set).with('migration-failed', 1)
+        expect(redis).to have_received(:set).with('migration-failed-bork', 123456789, ex: 3600)
         expect(redis).not_to have_received(:del)
       end
     end
+
+    context 'without version suffix' do
+      let(:set_version_suffix) { ENV.delete 'REDLOCK_VERSION_SUFFIX' }
+
+      context 'in the happy path' do
+        it 'executes the migration successfully' do
+          expect(result).to be_success
+          expect(redlock).to have_received(:lock!)
+          expect(redis).to have_received(:get).with('migration-failed')
+          expect(redis).to have_received(:set).with('migration-failed', 123456789, ex: 3600)
+          expect(Kernel).to have_received(:system)
+          expect(Bundler).not_to have_received(:with_original_env)
+          expect(redis).to have_received(:del).with('migration-failed')
+        end
+      end
+
+      context 'when the task crashed' do
+        before do
+          allow_any_instance_of(Process::Status).to receive(:success?).and_return(false)
+        end
+
+        it 'marks the failure in Redis' do
+          expect(result).not_to be_success
+          expect(redis).to have_received(:set).with('migration-failed', 123456789, ex: 3600)
+          expect(redis).not_to have_received(:del)
+        end
+      end
+    end
   end
 end

data/synchronised_migration.gemspec

@@ -5,7 +5,7 @@ require 'synchronised_migration/version'
 Gem::Specification.new do |spec|
   spec.name          = 'synchronised_migration'
   spec.version       = SynchronisedMigration::VERSION
-  spec.authors       = ['Alvin Yim']
+  spec.authors       = ['Alvin Yim', 'Stefan Cooper']
   spec.email         = 'support@travellink.com.au'
   spec.description   = 'Use Redis to record the data migration status'
   spec.summary       = 'For deploying to multiple instances simultaneously'
@@ -16,8 +16,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'redlock', '~> 0.2'
-  spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
-  spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_development_dependency 'pry-byebug', '~> 3.5'
+  spec.add_dependency 'redlock', '>= 0.2'
+  spec.add_dependency 'redis'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'simplecov-rcov', '>= 0.2'
+  spec.add_development_dependency 'rspec', '>= 3.6'
+  spec.add_development_dependency 'pry-byebug', '>= 3.5'
 end

metadata

@@ -1,69 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: synchronised_migration
 version: !ruby/object:Gem::Version
-  version: 1.0.2.pre.alpha.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Alvin Yim
-autorequire: 
+- Stefan Cooper
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redlock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: 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'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
 description: Use Redis to record the data migration status
@@ -77,9 +106,9 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - lib/synchronised_migration.rb
 - lib/synchronised_migration/main.rb
 - lib/synchronised_migration/railtie.rb
@@ -92,7 +121,7 @@ files:
 homepage: https://github.com/sealink/synchronised-migration-rb
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,13 +132,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: For deploying to multiple instances simultaneously
 test_files:

data/Gemfile.lock

@@ -1,58 +0,0 @@
-PATH
-  remote: .
-  specs:
-    synchronised_migration (1.0.1)
-      redlock (~> 0.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (9.1.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    json (2.1.0)
-    method_source (0.8.2)
-    pry (0.10.4)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.5.0)
-      byebug (~> 9.1)
-      pry (~> 0.10)
-    redis (3.3.5)
-    redlock (0.2.0)
-      redis (~> 3, >= 3.0.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    simplecov (0.15.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    simplecov-rcov (0.2.3)
-      simplecov (>= 0.4.1)
-    slop (3.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  pry-byebug (~> 3.5)
-  rspec (~> 3.6)
-  simplecov-rcov (~> 0.2)
-  synchronised_migration!
-
-BUNDLED WITH
-   1.16.0