synchronised_migration 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1431ba1cc8bb0ad840ba1020723cbefe53e2b88f3e40e80e24a203b7ab8163
-  data.tar.gz: 0faa2082f8cbceefcaa72b566d9ec16b02be2e19b27016ddf47e7a8f5d882659
+  metadata.gz: cc7b4ada6d890ac183de30b375e6ead7de8dde32827aa870808552420637a006
+  data.tar.gz: 1826cd77772547266f1dcf309a52574960aa0fdd6efb96a148264ad995979b08
 SHA512:
-  metadata.gz: 842a04dca6b33503bf50d9563d688ea10c2ac624523b893a6f6314367dbff97c98cfecaf0dd9c82c32d0084323e1231aa81409a5616a6806b2b025b8fee9ffc2
-  data.tar.gz: d0be7428022db07f04c00d6017f29c2988035365c5ce76430cbae5177cd672d77aed79ff850e1a5a93987f25042a141cee384df6fe9ebdfabe7f117c0691fa1c
+  metadata.gz: 5748c0d00c031d6bea8400d598c39f97a6bde99eebfe9273e018fd346ca79186a809ef6f16d9ce6a4213a583e88b7f1fce3e713fd2a9dc40a7adb70340016a0c
+  data.tar.gz: 18442e4f7ddcbdb497af3a05852b59677840871c24844945ddf4da3fca9a5edf2857f6090c5c01067d69c88ee7098a7e5e0ca5f8632e273399c614b537c36de2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Synchronised Migration
 
+## 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

data/lib/synchronised_migration/main.rb

@@ -32,10 +32,11 @@ class SynchronisedMigration::Main
   end
 
   def execute
+    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.fail 'Migration failed.' if migration_failed?
+    migration_success = migrate
+    return Result.fail 'Migration failed.' unless migration_success
     mark_successful
     remove_fail_marker
     return Result.ok
@@ -67,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

data/lib/synchronised_migration/version.rb

@@ -1,3 +1,3 @@
 module SynchronisedMigration
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/spec/synchronised_migration/main_spec.rb

@@ -10,7 +10,8 @@ describe SynchronisedMigration::Main do
     let(:redlock) { double }
     let(:fail_marker_value) { nil }
     let(:success_marker_value) { nil }
-    let(:set_version_suffix) { ENV['REDLOCK_VERSION_SUFFIX'] = 'bork' }
+    let(:version_suffix) { 'bork' }
+    let(:set_version_suffix) { ENV['REDLOCK_VERSION_SUFFIX'] = version_suffix }
     let(:time_value) { double(to_i: 123456789) }
 
     before do
@@ -19,8 +20,24 @@ describe SynchronisedMigration::Main do
       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(success_marker_value, 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)
 
@@ -62,6 +79,24 @@ describe SynchronisedMigration::Main do
           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
 
     context 'when require a clean Bundler environment' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synchronised_migration
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Alvin Yim
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2019-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redlock