alterity 0.9.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d1573038462b1d92925a95f8b67d8c0d53ffc250c429a742bb9a3e19fe715a
-  data.tar.gz: e6cf943aae6b2ead8e6c04d335a63c1c1438c296381e066c513d0aefb99e6d13
+  metadata.gz: 5f4e8e6c49bdb9df63ae315e6f010823a6f0f0eff52a6e7a8650a71217ed51b9
+  data.tar.gz: c20ae01f25ebc0b93abcbf4634e2a66e2b7978184409000677fdd77ad6750101
 SHA512:
-  metadata.gz: ea2e19e99394e1cacd831855e509363c4d164dabfe564ef7ac47945c61c9fc94071d965a3bc16efdd80530108fecd50ee582900d962f3fd63571ae1e6d71203f
-  data.tar.gz: bd8f34566ced8252a587804d966c02e850d41a4d0faaf88bd0279886ea58286c4d70a7ca15b7ceafc17934bdce34f69b459b7546a1603acaee4b91ab26f89933
+  metadata.gz: f18b1dc05a88537b96525e04caa763b6442eacc1da1696a13f93bcd0f3d0bdac22ddee19d4aa0f11e45fbd7326a51508c1928f4641bb831b0da6645ad79b1522
+  data.tar.gz: a93f02e048fa0f1970123c504040219113497d214e78c806031c3df065e8e14bf628d45d2972b4c2fecd1930e1fd8b933e3845221b6ef45f74335b05ebbd1d59

data/lib/alterity.rb

@@ -8,14 +8,25 @@ require "alterity/railtie"
 class Alterity
   class << self
     def process_sql_query(sql, &block)
-      case sql.strip
-      when /^alter table (?<table>.+?) (?<updates>.+)/i
-        execute_alter($~[:table], $~[:updates])
-      when /^create index (?<index>.+?) on (?<table>.+?) (?<updates>.+)/i
+      case sql.tr("\n", " ").strip
+      when /^alter\s+table\s+(?<table>.+?)\s+(?<updates>.+)/i
+        table = $~[:table]
+        updates = $~[:updates]
+        if updates.split(",").all? { |s| s =~ /^\s*drop\s+foreign\s+key/i } ||
+           updates.split(",").all? { |s| s =~ /^\s*add\s+constraint/i }
+          block.call
+        elsif updates =~ /drop\s+foreign\s+key/i || updates =~ /add\s+constraint/i
+          # ADD CONSTRAINT / DROP FOREIGN KEY have to go to the original table,
+          # other alterations need to got to the new table.
+          raise "[Alterity] Can't change a FK and do something else in the same query. Split it."
+        else
+          execute_alter(table, updates)
+        end
+      when /^create\s+index\s+(?<index>.+?)\s+on\s+(?<table>.+?)\s+(?<updates>.+)/i
         execute_alter($~[:table], "ADD INDEX #{$~[:index]} #{$~[:updates]}")
-      when /^create unique index (?<index>.+?) on (?<table>.+?) (?<updates>.+)/i
+      when /^create\s+unique\s+index\s+(?<index>.+?)\s+on\s+(?<table>.+?)\s+(?<updates>.+)/i
         execute_alter($~[:table], "ADD UNIQUE INDEX #{$~[:index]} #{$~[:updates]}")
-      when /^drop index (?<index>.+?) on (?<table>.+)/i
+      when /^drop\s+index\s+(?<index>.+?)\s+on\s+(?<table>.+)/i
         execute_alter($~[:table], "DROP INDEX #{$~[:index]}")
       else
         block.call
@@ -24,6 +35,7 @@ class Alterity
 
     # hooks
     def before_running_migrations
+      require "open3"
       state.migrating = true
       set_database_config
       prepare_replicas_dsns_table
@@ -38,9 +50,20 @@ class Alterity
     def execute_alter(table, updates)
       altered_table = table.delete("`")
       alter_argument = %("#{updates.gsub('"', '\\"').gsub('`', '\\\`')}")
-      prepared_command = config.command.call(config, altered_table, alter_argument).gsub(/\n/, "\\\n")
+      prepared_command = config.command.call(altered_table, alter_argument).to_s.gsub(/\n/, "\\\n")
       puts "[Alterity] Will execute: #{prepared_command}"
-      system(prepared_command)
+
+      result_str = +""
+      exit_status = nil
+      Open3.popen2e(prepared_command) do |_stdin, stdout_and_stderr, wait_thr|
+        stdout_and_stderr.each do |line|
+          puts line
+          result_str << line
+        end
+        exit_status = wait_thr.value
+      end
+
+      raise("[Alterity] Command failed. Full output: #{result_str}") unless exit_status.success?
     end
 
     def set_database_config
@@ -54,6 +77,10 @@ class Alterity
     def prepare_replicas_dsns_table
       return if config.replicas_dsns_table.blank?
 
+      dsns = config.replicas_dsns.dup
+      # Automatically remove master
+      dsns.reject! { |dsn| dsn.split(",").include?("h=#{config.host}") }
+
       database = config.replicas_dsns_database
       table = "#{database}.#{config.replicas_dsns_table}"
       connection = ActiveRecord::Base.connection
@@ -67,11 +94,11 @@ class Alterity
         ) ENGINE=InnoDB
       SQL
       connection.execute "TRUNCATE #{table}"
-      return if config.replicas_dsns.empty?
+      return if dsns.empty?
 
       connection.execute <<~SQL
-        INSERT INTO #{table} (dsn)
-         #{config.replicas_dsns.map { |dsn| "('#{dsn}')" }.join(',')}
+        INSERT INTO #{table} (dsn) VALUES
+         #{dsns.map { |dsn| "('#{dsn}')" }.join(',')}
       SQL
     end
   end

data/lib/alterity/configuration.rb

@@ -13,46 +13,33 @@ class Alterity
   class << self
     def reset_state_and_configuration
       self.config = Configuration.new
-      self.state = CurrentState.new
+      class << config
+        def replicas(database:, table:, dsns:)
+          return ArgumentError.new("database & table must be present") if database.blank? || table.blank?
+
+          self.replicas_dsns_database = database
+          self.replicas_dsns_table = table
+          self.replicas_dsns = dsns.uniq.map do |dsn|
+            parts = dsn.split(",")
+            # automatically add default port
+            parts << "P=3306" unless parts.any? { |part| part.start_with?("P=") }
+            parts.join(",")
+          end.compact
+        end
+      end
 
-      config.command = lambda { |config, altered_table, alter_argument|
-        <<~SHELL.squish
-          pt-online-schema-change
-            -h #{config.host}
-            -P #{config.port}
-            -u #{config.username}
-            --password=#{config.password}
-            --execute
-            D=#{config.database},t=#{altered_table}
-            --alter #{alter_argument}
-        SHELL
-      }
+      self.state = CurrentState.new
+      load "#{__dir__}/default_configuration.rb"
     end
 
     def configure
-      yield self
+      yield config
     end
 
     def command=(new_command)
       config.command = new_command
     end
 
-    def replicas_dsns_table(database:, table:, dsns:)
-      return ArgumentError.new("database & table must be present") if database.blank? || table.blank?
-
-      config.replicas_dsns_database = database
-      config.replicas_dsns_table = table
-      config.replicas_dsns = dsns.uniq.map do |dsn|
-        parts = dsn.split(",")
-        # automatically add default port
-        parts << "P=3306" unless parts.any? { |part| part.start_with?("P=") }
-        # automatically remove master
-        next if parts.include?("h=#{config.host}") && parts.include?("P=#{config.port}")
-
-        parts.join(",")
-      end.compact
-    end
-
     def disable
       state.disabled = true
       yield

data/lib/alterity/default_configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+Alterity.configure do |config|
+  config.command = lambda { |altered_table, alter_argument|
+    parts = ["pt-online-schema-change"]
+    parts << %(-h "#{config.host}") if config.host.present?
+    parts << %(-P "#{config.port}") if config.port.present?
+    parts << %(-u "#{config.username}") if config.username.present?
+    parts << %(--password "#{config.password.gsub('"', '\\"')}") if config.password.present?
+    parts << "--execute"
+    parts << "D=#{config.database},t=#{altered_table}"
+    parts << "--alter #{alter_argument}"
+    parts.join(" ")
+  }
+end

data/lib/alterity/mysql_client_additions.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "mysql2"
+
 class Alterity
   module MysqlClientAdditions
     def query(sql, options = {})

data/lib/alterity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Alterity
-  VERSION = "0.9.0"
+  VERSION = "1.3.1"
 end

data/spec/alterity_spec.rb

@@ -9,8 +9,10 @@ RSpec.describe Alterity do
         ["CREATE INDEX `idx_users_on_col` ON `users` (col)", "`users`", "ADD INDEX `idx_users_on_col` (col)"],
         ["CREATE UNIQUE INDEX `idx_users_on_col` ON `users` (col)", "`users`", "ADD UNIQUE INDEX `idx_users_on_col` (col)"],
         ["DROP INDEX `idx_users_on_col` ON `users`", "`users`", "DROP INDEX `idx_users_on_col`"],
-        ["alter table users drop col", "users", "drop col"]
+        ["alter table users drop col", "users", "drop col"],
+        ["  ALTER TABLE\n   users\n   DROP col", "users", "DROP col"],
       ].each do |(query, expected_table, expected_updates)|
+        puts query.inspect
         expected_block = proc {}
         expect(expected_block).not_to receive(:call)
         expect(Alterity).to receive(:execute_alter).with(expected_table, expected_updates)
@@ -27,7 +29,11 @@ RSpec.describe Alterity do
         "SHOW CREATE TABLE `users`",
         "SHOW TABLE STATUS LIKE `users`",
         "SHOW KEYS FROM `users`",
-        "SHOW FULL FIELDS FROM `users`"
+        "SHOW FULL FIELDS FROM `users`",
+        "ALTER TABLE `installment_events` DROP FOREIGN KEY _fk_rails_0123456789",
+        "ALTER TABLE `installment_events` DROP FOREIGN KEY _fk_rails_0123456789, DROP FOREIGN KEY _fk_rails_9876543210",
+        "ALTER TABLE `installment_events` ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)",
+        "ALTER TABLE `installment_events` ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`) ON DELETE CASCADE",
       ].each do |query|
         expected_block = proc {}
         expect(expected_block).to receive(:call)
@@ -35,5 +41,19 @@ RSpec.describe Alterity do
         Alterity.process_sql_query(query, &expected_block)
       end
     end
+
+    it "raises an error if mixing FK change and other things" do
+      expected_block = proc {}
+      expect(expected_block).not_to receive(:call)
+      expect(Alterity).not_to receive(:execute_alter)
+      query = "ALTER TABLE `installment_events` ADD `col` VARCHAR(255), DROP FOREIGN KEY _fk_rails_0123456789"
+      expect do
+        Alterity.process_sql_query(query, &expected_block)
+      end.to raise_error(/FK/)
+      query = "ALTER TABLE `installment_events` ADD `col` VARCHAR(255), ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)"
+      expect do
+        Alterity.process_sql_query(query, &expected_block)
+      end.to raise_error(/FK/)
+    end
   end
 end

data/spec/bin/custom_config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Alterity.configure do |config|
+  config.command = lambda { |altered_table, alter_argument|
+    string = config.to_h.slice(
+      *%i[host port username database replicas_dsns_database replicas_dsns_table replicas_dsns]
+    ).to_s
+    system("echo '#{string}' > /tmp/custom_command_result.txt")
+    system("echo '#{altered_table}' >> /tmp/custom_command_result.txt")
+    system("echo '#{alter_argument}' >> /tmp/custom_command_result.txt")
+  }
+
+  config.replicas(
+    database: "percona",
+    table: "replicas_dsns",
+    dsns: [
+      "h=host1",
+      "h=host2",
+      # we may encounter an app where the replica host is actually pointing to master;
+      # pt-osc doesn't deal well with this and will wait forever.
+      # So we're testing here that Alterity will detect that this is master (same as config.host),
+      # and will not insert it into the `replicas_dsns` table.
+      "h=#{ENV['MYSQL_HOST']}"
+    ]
+  )
+end

data/spec/bin/rails_app_migration_test.sh

@@ -1,7 +1,71 @@
 #!/usr/bin/env bash
 
-set -euo pipefail
+set -euox pipefail
+
+unset BUNDLE_GEMFILE # because we're going to create a new rails app here and use bundler
 
-printenv
-sudo apt update
 sudo apt install percona-toolkit
+
+# Fixes: `Cannot connect to MySQL: Cannot get MySQL var character_set_server: DBD::mysql::db selectrow_array failed: Table 'performance_schema.session_variables' doesn't exist [for Statement "SHOW VARIABLES LIKE 'character_set_server'"] at /usr/local/Cellar/percona-toolkit/3.3.0/libexec/bin/pt-online-schema-change line 2415.`
+mysql -h $MYSQL_HOST -u $MYSQL_USERNAME -e 'set @@global.show_compatibility_56=ON'
+
+gem install rails -v $RAILS_VERSION
+
+rails new testapp \
+  --skip-action-mailer \
+  --skip-action-mailbox \
+  --skip-action-text \
+  --skip-active-job \
+  --skip-active-storage \
+  --skip-puma \
+  --skip-action-cable \
+  --skip-sprockets \
+  --skip-spring \
+  --skip-listen--skip-javascript \
+  --skip-turbolinks \
+  --skip-jbuilder--skip-test \
+  --skip-system-test \
+  --skip-bootsnap \
+  --skip-javascript \
+  --skip-webpack-install
+
+cd testapp
+
+# Sanity check:
+# echo 'gem "mysql2"' >> Gemfile
+
+echo 'gem "alterity", path: "../"' >> Gemfile
+
+bundle
+
+# Local machine test
+# echo 'development:
+#   adapter: mysql2
+#   database: alterity_test' > config/database.yml
+# bundle e rails db:drop db:create
+
+echo 'development:
+  adapter: mysql2
+  database: <%= ENV.fetch("MYSQL_DATABASE") %>
+  host: <%= ENV.fetch("MYSQL_HOST") %>
+  username: <%= ENV.fetch("MYSQL_USERNAME") %>' > config/database.yml
+
+bundle e rails g model shirt
+
+bundle e rails g migration add_color_to_shirts color:string
+
+# Test default configuration works as expected
+bundle e rails db:migrate --trace
+bundle e rails runner 'Shirt.columns.map(&:name).include?("color") || exit(1)'
+
+# Now test custom command and replication setup
+cp ../spec/bin/custom_config.rb config/initializers/alterity.rb
+
+bundle e rails g migration add_color2_to_shirts color2:string
+
+bundle e rails db:migrate --trace
+
+ruby ../spec/bin/test_custom_config_result.rb
+
+# Also testing what's in replicas_dsns, also checking that master was detected and removed.
+bundle e rails runner 'res=ActiveRecord::Base.connection.execute("select dsn from percona.replicas_dsns").to_a.flatten;p(res); res == ["h=host1,P=3306", "h=host2,P=3306"] || exit(1)'

data/spec/bin/test_custom_config_result.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+result = File.read("/tmp/custom_command_result.txt").downcase.strip
+
+expected_result = %({:host=>"127.0.0.1", :port=>nil, :username=>"root", :database=>"alterity_test", :replicas_dsns_database=>"percona", :replicas_dsns_table=>"replicas_dsns", :replicas_dsns=>["h=host1,P=3306", "h=host2,P=3306", "h=127.0.0.1,P=3306"]}
+shirts
+"ADD \\`color2\\` VARCHAR(255)").downcase.strip
+
+puts "Expected custom config result:"
+puts expected_result
+p expected_result.chars.map(&:hex)
+
+puts "Custom config result:"
+puts result
+p result.chars.map(&:hex)
+
+if result != expected_result
+  puts "=> mismatch"
+  exit(1)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alterity
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Chris Maximin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6.1'
 description: Execute your ActiveRecord migrations with Percona's pt-online-schema-change.
 email:
 - gems@chrismaximin.com
@@ -47,11 +47,14 @@ extra_rdoc_files: []
 files:
 - lib/alterity.rb
 - lib/alterity/configuration.rb
+- lib/alterity/default_configuration.rb
 - lib/alterity/mysql_client_additions.rb
 - lib/alterity/railtie.rb
 - lib/alterity/version.rb
 - spec/alterity_spec.rb
+- spec/bin/custom_config.rb
 - spec/bin/rails_app_migration_test.sh
+- spec/bin/test_custom_config_result.rb
 - spec/spec_helper.rb
 homepage: https://github.com/gumroad/alterity
 licenses:
@@ -81,5 +84,7 @@ specification_version: 4
 summary: Execute your ActiveRecord migrations with Percona's pt-online-schema-change.
 test_files:
 - spec/alterity_spec.rb
+- spec/bin/custom_config.rb
 - spec/bin/rails_app_migration_test.sh
+- spec/bin/test_custom_config_result.rb
 - spec/spec_helper.rb