simple_data_migrations 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4275c5b1c6f081913056bd954e294c64db0affb8b3d673c0e8e54794dd35e5
-  data.tar.gz: 37b99f86b67e80b8c176a1b401a8a7fbeaf6a266b55cc4661544c070006ca65e
+  metadata.gz: 921613636477da12bf615c10012a25b94d2f3929e22c6959688de8325d6bc209
+  data.tar.gz: 5e2c9e1a1cee5b69303c1cf01e18603a530fcf913b92ae1f248a40305dfffd9f
 SHA512:
-  metadata.gz: 5731d1a108dcd09d60ca1d9749fe3a449cb08bf6711c5bb3b9662e539135dbf4db8f11e14f5f9705e6d3b0bb81940248699e8818981edf44eac4a55bd9d88b73
-  data.tar.gz: da8566add2d9d89fc44cf52b62913ef318902a8dba6fec2373ac128b193d358dedc1d7e826d28726131ec822ac582ea272b2fa4de926c908f029f0e1e7795461
+  metadata.gz: 5a79a24b40aa650d434154ff9072e39e46192de666f70847a5cd984095a82c69f8cf8252bd743cdc1a7269c5ead89c5b0aab37b663a6884f46d4dc7e9dee82f5
+  data.tar.gz: dd95745c38e08e4ea18332cab21ac32a8148d97257a7b0c2bd63f5055407719e441a24561746079437e7370f9e08a7d4b5f4adcebb5d14280cb52bf4311a392f

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [0.2.0] - 2022-01-11
+
+- Add support for locked migrations to ensure script is run only once in the app.
 
 ## [0.1.0] - 2022-01-06
 

data/README.md

@@ -21,6 +21,12 @@ Generate sample data migration file by `bin/rails generate simple_data_migration
 Status can be displayed by `bin/rails data:migrate:status`
 And executed by `bin/rails data:migrate`
 
+### Locked Migrations
+
+To ensure that migration script is run only once during deploy to multiple machines, one can use `bin/rails data:migrate_with_lock` task.
+It will use database advisory lock, in similar manner to how the Rails database migrations are run.
+In case of multiple concurrent task invocations, the first run will succeed but the others will raise `SimpleDataMigrations::ConcurrentRun::Error`.
+
 ## Development
 
 TODO: add configuration

data/lib/generators/simple_data_migrations/install_generator.rb

@@ -7,7 +7,7 @@ module SimpleDataMigrations
   class InstallGenerator < Rails::Generators::Base
     include ActiveRecord::Generators::Migration
 
-    source_paths << File.expand_path("../templates", __FILE__)
+    source_paths << File.expand_path("templates", __dir__)
 
     def create_migration_file
       migration_template "install.rb.erb", "db/migrate/create_simple_data_migrations_table.rb"

data/lib/simple_data_migrations/concurrent_run.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SimpleDataMigrations
+  module ConcurrentRun
+    class Error < StandardError; end
+
+    MIGRATOR_SALT = 3053462845
+    private_constant :MIGRATOR_SALT
+
+    def self.with_advisory_lock
+      with_advisory_lock_connection do |connection|
+        lock_id = MIGRATOR_SALT * Zlib.crc32(connection.current_database)
+
+        got_lock = connection.get_advisory_lock(lock_id)
+        raise Error unless got_lock
+
+        yield
+      ensure
+        got_lock && connection.release_advisory_lock(lock_id)
+      end
+    end
+
+    # Caused by multi db specific connection flow. More on https://github.com/rails/rails/pull/38235
+    def self.with_advisory_lock_connection
+      pool = ActiveRecord::ConnectionAdapters::ConnectionHandler.new.establish_connection(
+        ActiveRecord::Base.connection_db_config
+      )
+
+      pool.with_connection { |connection| yield(connection) }
+    end
+    private_class_method :with_advisory_lock_connection
+  end
+end

data/lib/simple_data_migrations/railtie.rb

@@ -2,7 +2,6 @@
 
 module SimpleDataMigrations
   class Railtie < ::Rails::Railtie
-
     rake_tasks do
       load File.expand_path("../tasks/data.rake", __dir__)
     end

data/lib/simple_data_migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleDataMigrations
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/simple_data_migrations.rb

@@ -4,6 +4,7 @@ require "benchmark"
 require "thor/shell/basic"
 
 require_relative "simple_data_migrations/version"
+require_relative "simple_data_migrations/concurrent_run"
 require_relative "simple_data_migrations/entry"
 require_relative "simple_data_migrations/utils"
 require_relative "simple_data_migrations/railtie" if defined?(Rails::Railtie)
@@ -44,6 +45,10 @@ module SimpleDataMigrations
     end
   end
 
+  def self.run_with_lock
+    ConcurrentRun.with_advisory_lock { run }
+  end
+
   def self.bootstrap
     attributes = Utils.script_files.map { |filename| {version: Utils.version(filename)} }
     Entry.insert_all!(attributes)

data/lib/tasks/data.rake

@@ -8,6 +8,12 @@ namespace :data do
     SimpleDataMigrations.run
   end
 
+  task migrate_with_lock: :environment do
+    require "simple_data_migrations"
+
+    SimpleDataMigrations.run_with_lock
+  end
+
   namespace :migrate do
     desc "Display status of data migration scripts"
     task status: :environment do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_data_migrations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wojciech Wnętrzak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -56,6 +56,7 @@ files:
 - lib/generators/simple_data_migrations/template_generator.rb
 - lib/generators/simple_data_migrations/templates/install.rb.erb
 - lib/simple_data_migrations.rb
+- lib/simple_data_migrations/concurrent_run.rb
 - lib/simple_data_migrations/entry.rb
 - lib/simple_data_migrations/railtie.rb
 - lib/simple_data_migrations/utils.rb