alterity 0.0.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f91f2ad32f8f398432906ae434fb824e9f94a63fc528a73a5c65c034de41ece
-  data.tar.gz: 931ed885773f0070bb68d1b354d6b79f00f7909f84614fc8c7d6f82206f41a53
+  metadata.gz: 61d1573038462b1d92925a95f8b67d8c0d53ffc250c429a742bb9a3e19fe715a
+  data.tar.gz: e6cf943aae6b2ead8e6c04d335a63c1c1438c296381e066c513d0aefb99e6d13
 SHA512:
-  metadata.gz: e8ecad73cb251e6aa10353eb9a6118c44e316fc85075ee8f77e8e5cf6be6d16a583f20783bfbaa7b1d7ce690b0e36f611bbf51e95bf63156588b3161adf880be
-  data.tar.gz: 39e586c77a9e9fa5d60a2e78735839457ba72a063879921d48f4ef31c488567fcf75e1fc09031564c3af0737c6e40974839a8b1cf98bdf9f9352b9bb1c75f529
+  metadata.gz: ea2e19e99394e1cacd831855e509363c4d164dabfe564ef7ac47945c61c9fc94071d965a3bc16efdd80530108fecd50ee582900d962f3fd63571ae1e6d71203f
+  data.tar.gz: bd8f34566ced8252a587804d966c02e850d41a4d0faaf88bd0279886ea58286c4d70a7ca15b7ceafc17934bdce34f69b459b7546a1603acaee4b91ab26f89933

data/lib/alterity.rb

@@ -1,4 +1,80 @@
 # frozen_string_literal: true
 
-module Alterity
+require "rails"
+require "alterity/configuration"
+require "alterity/mysql_client_additions"
+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
+        execute_alter($~[:table], "ADD INDEX #{$~[:index]} #{$~[:updates]}")
+      when /^create unique index (?<index>.+?) on (?<table>.+?) (?<updates>.+)/i
+        execute_alter($~[:table], "ADD UNIQUE INDEX #{$~[:index]} #{$~[:updates]}")
+      when /^drop index (?<index>.+?) on (?<table>.+)/i
+        execute_alter($~[:table], "DROP INDEX #{$~[:index]}")
+      else
+        block.call
+      end
+    end
+
+    # hooks
+    def before_running_migrations
+      state.migrating = true
+      set_database_config
+      prepare_replicas_dsns_table
+    end
+
+    def after_running_migrations
+      state.migrating = false
+    end
+
+    private
+
+    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")
+      puts "[Alterity] Will execute: #{prepared_command}"
+      system(prepared_command)
+    end
+
+    def set_database_config
+      db_config_hash = ActiveRecord::Base.connection_db_config.configuration_hash
+      %i[host port database username password].each do |key|
+        config[key] = db_config_hash[key]
+      end
+    end
+
+    # Optional: Automatically set up table PT-OSC will monitor for replica lag.
+    def prepare_replicas_dsns_table
+      return if config.replicas_dsns_table.blank?
+
+      database = config.replicas_dsns_database
+      table = "#{database}.#{config.replicas_dsns_table}"
+      connection = ActiveRecord::Base.connection
+      connection.execute "CREATE DATABASE IF NOT EXISTS #{database}"
+      connection.execute <<~SQL
+        CREATE TABLE IF NOT EXISTS #{table} (
+          id INT(11) NOT NULL AUTO_INCREMENT,
+          parent_id INT(11) DEFAULT NULL,
+          dsn VARCHAR(255) NOT NULL,
+          PRIMARY KEY (id)
+        ) ENGINE=InnoDB
+      SQL
+      connection.execute "TRUNCATE #{table}"
+      return if config.replicas_dsns.empty?
+
+      connection.execute <<~SQL
+        INSERT INTO #{table} (dsn)
+         #{config.replicas_dsns.map { |dsn| "('#{dsn}')" }.join(',')}
+      SQL
+    end
+  end
+
+  reset_state_and_configuration
 end

data/lib/alterity/configuration.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class Alterity
+  Configuration = Struct.new(
+    :command,
+    :host, :port, :database, :username, :password,
+    :replicas_dsns_database, :replicas_dsns_table, :replicas_dsns
+  )
+  CurrentState = Struct.new(:migrating, :disabled)
+  cattr_accessor :state
+  cattr_accessor :config
+
+  class << self
+    def reset_state_and_configuration
+      self.config = Configuration.new
+      self.state = CurrentState.new
+
+      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
+      }
+    end
+
+    def configure
+      yield self
+    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
+    ensure
+      state.disabled = false
+    end
+  end
+end

data/lib/alterity/mysql_client_additions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Alterity
+  module MysqlClientAdditions
+    def query(sql, options = {})
+      return super(sql, options) unless Alterity.state.migrating
+
+      Alterity.process_sql_query(sql) { super(sql, options) }
+    end
+  end
+end

data/lib/alterity/railtie.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Alterity
+  class Railtie < Rails::Railtie
+    railtie_name :alterity
+
+    rake_tasks do
+      namespace :alterity do
+        task :intercept_table_alterations do
+          Alterity.before_running_migrations
+          Rake::Task["alterity:stop_intercepting_table_alterations"].reenable
+          ::Mysql2::Client.prepend(Alterity::MysqlClientAdditions)
+        end
+
+        task :stop_intercepting_table_alterations do
+          Rake::Task["alterity:intercept_table_alterations"].reenable
+          Alterity.after_running_migrations
+        end
+      end
+
+      unless %w[1 true].include?(ENV["DISABLE_ALTERITY"])
+        ["migrate", "migrate:up", "migrate:down", "migrate:redo", "rollback"].each do |task|
+          Rake::Task["db:#{task}"].enhance(["alterity:intercept_table_alterations"]) do
+            Rake::Task["alterity:stop_intercepting_table_alterations"].invoke
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alterity/version.rb

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

data/spec/alterity_spec.rb

@@ -1,5 +1,39 @@
 # frozen_string_literal: true
 
 RSpec.describe Alterity do
-  # TODO
+  describe ".process_sql_query" do
+    it "executes command on table altering queries" do
+      [
+        ["ALTER TABLE `users` ADD `col` VARCHAR(255)", "`users`", "ADD `col` VARCHAR(255)"],
+        ["ALTER TABLE `users` ADD `col0` INT(11), DROP `col1`", "`users`", "ADD `col0` INT(11), DROP `col1`"],
+        ["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"]
+      ].each do |(query, expected_table, expected_updates)|
+        expected_block = proc {}
+        expect(expected_block).not_to receive(:call)
+        expect(Alterity).to receive(:execute_alter).with(expected_table, expected_updates)
+        Alterity.process_sql_query(query, &expected_block)
+      end
+    end
+
+    it "ignores non-altering queries" do
+      [
+        "select * from users",
+        "insert into users values (1)",
+        "delete from users",
+        "begin",
+        "SHOW CREATE TABLE `users`",
+        "SHOW TABLE STATUS LIKE `users`",
+        "SHOW KEYS FROM `users`",
+        "SHOW FULL FIELDS FROM `users`"
+      ].each do |query|
+        expected_block = proc {}
+        expect(expected_block).to receive(:call)
+        expect(Alterity).not_to receive(:execute_alter)
+        Alterity.process_sql_query(query, &expected_block)
+      end
+    end
+  end
 end

data/spec/bin/rails_app_migration_test.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+printenv
+sudo apt update
+sudo apt install percona-toolkit

data/spec/spec_helper.rb

@@ -15,4 +15,8 @@ RSpec.configure do |config|
   end
 
   config.filter_run_when_matching :focus
+
+  config.before do
+    Alterity.reset_state_and_configuration
+  end
 end

metadata

@@ -1,55 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: alterity
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Chris Maximin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-28 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '5'
 description: Execute your ActiveRecord migrations with Percona's pt-online-schema-change.
 email:
 - gems@chrismaximin.com
@@ -58,8 +46,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/alterity.rb
+- lib/alterity/configuration.rb
+- lib/alterity/mysql_client_additions.rb
+- lib/alterity/railtie.rb
 - lib/alterity/version.rb
 - spec/alterity_spec.rb
+- spec/bin/rails_app_migration_test.sh
 - spec/spec_helper.rb
 homepage: https://github.com/gumroad/alterity
 licenses:
@@ -89,4 +81,5 @@ specification_version: 4
 summary: Execute your ActiveRecord migrations with Percona's pt-online-schema-change.
 test_files:
 - spec/alterity_spec.rb
+- spec/bin/rails_app_migration_test.sh
 - spec/spec_helper.rb