online_migrations 0.1.0

data/lib/online_migrations/utils.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module OnlineMigrations
+  # @private
+  module Utils
+    class << self
+      def ar_version
+        ActiveRecord.version.to_s.to_f
+      end
+
+      def developer_env?
+        defined?(Rails) && (Rails.env.development? || Rails.env.test?)
+      end
+
+      def say(message)
+        message = "[online_migrations] #{message}"
+        if (migration = OnlineMigrations.current_migration)
+          migration.say(message)
+        elsif (logger = ActiveRecord::Base.logger)
+          logger.info(message)
+        end
+      end
+
+      def warn(message)
+        Kernel.warn("[online_migrations] #{message}")
+      end
+
+      def migration_parent
+        if ar_version <= 4.2
+          ActiveRecord::Migration
+        else
+          ActiveRecord::Migration[ar_version]
+        end
+      end
+
+      def migration_parent_string
+        if ar_version <= 4.2
+          "ActiveRecord::Migration"
+        else
+          "ActiveRecord::Migration[#{ar_version}]"
+        end
+      end
+
+      def model_parent_string
+        if ar_version >= 5.0
+          "ApplicationRecord"
+        else
+          "ActiveRecord::Base"
+        end
+      end
+
+      def define_model(connection, table_name)
+        Class.new(ActiveRecord::Base) do
+          self.table_name = table_name
+          self.inheritance_column = :_type_disabled
+
+          @online_migrations_connection = connection
+
+          def self.connection
+            @online_migrations_connection
+          end
+        end
+      end
+
+      def to_bool(value)
+        value.to_s.match?(/^(true|t|yes|y|1|on)$/i)
+      end
+
+      def foreign_table_name(ref_name, options)
+        options.fetch(:to_table) do
+          ActiveRecord::Base.pluralize_table_names ? ref_name.to_s.pluralize : ref_name
+        end
+      end
+
+      def ar_partial_writes?
+        ActiveRecord::Base.public_send(ar_partial_writes_setting)
+      end
+
+      def ar_partial_writes_setting
+        if Utils.ar_version >= 7.0
+          "partial_inserts"
+        else
+          "partial_writes"
+        end
+      end
+
+      # Returns estimated rows count for a table.
+      # https://www.citusdata.com/blog/2016/10/12/count-performance/
+      def estimated_count(connection, table_name)
+        quoted_table = connection.quote(table_name)
+
+        count = connection.select_value(<<~SQL)
+          SELECT
+            (reltuples / COALESCE(NULLIF(relpages, 0), 1)) *
+            (pg_relation_size(#{quoted_table}) / (current_setting('block_size')::integer))
+          FROM pg_catalog.pg_class
+          WHERE relname = #{quoted_table}
+            AND relnamespace = current_schema()::regnamespace
+        SQL
+        count.to_i if count
+      end
+
+      def ar_where_not_multiple_conditions(relation, conditions)
+        if Utils.ar_version >= 6.1
+          relation.where.not(conditions)
+        else
+          # In Active Record < 6.1, NOT with multiple conditions behaves as NOR,
+          # which should really behave as NAND.
+          # https://www.bigbinary.com/blog/rails-6-deprecates-where-not-working-as-nor-and-will-change-to-nand-in-rails-6-1
+          arel_table = relation.arel_table
+          conditions = conditions.map { |column, value| arel_table[column].not_eq(value) }
+          conditions = conditions.inject(:or)
+          relation.where(conditions)
+        end
+      end
+
+      FUNCTION_CALL_RE = /(\w+)\s*\(/
+      private_constant :FUNCTION_CALL_RE
+
+      def volatile_default?(connection, type, value)
+        return false unless value.is_a?(Proc) || (type.to_s == "uuid" && value.is_a?(String))
+
+        value = value.call if value.is_a?(Proc)
+        return false if !value.is_a?(String)
+
+        value.scan(FUNCTION_CALL_RE).any? { |(function_name)| volatile_function?(connection, function_name.downcase) }
+      end
+
+      def volatile_function?(connection, function_name)
+        query = <<~SQL
+          SELECT provolatile
+          FROM pg_catalog.pg_proc
+          WHERE proname = #{connection.quote(function_name)}
+        SQL
+
+        connection.select_value(query) == "v"
+      end
+    end
+  end
+end

data/lib/online_migrations/version.rb

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

data/lib/online_migrations.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+require "online_migrations/utils"
+require "online_migrations/error_messages"
+require "online_migrations/config"
+require "online_migrations/batch_iterator"
+require "online_migrations/migration"
+require "online_migrations/migrator"
+require "online_migrations/database_tasks"
+require "online_migrations/foreign_key_definition"
+require "online_migrations/foreign_keys_collector"
+require "online_migrations/indexes_collector"
+require "online_migrations/command_checker"
+require "online_migrations/schema_cache"
+require "online_migrations/background_migration"
+require "online_migrations/background_migrations/config"
+require "online_migrations/background_migrations/migration_status_validator"
+require "online_migrations/background_migrations/migration_job_status_validator"
+require "online_migrations/background_migrations/background_migration_class_validator"
+require "online_migrations/background_migrations/backfill_column"
+require "online_migrations/background_migrations/copy_column"
+require "online_migrations/background_migrations/migration_job"
+require "online_migrations/background_migrations/migration"
+require "online_migrations/background_migrations/migration_job_runner"
+require "online_migrations/background_migrations/migration_runner"
+require "online_migrations/background_migrations/migration_helpers"
+require "online_migrations/background_migrations/advisory_lock"
+require "online_migrations/background_migrations/scheduler"
+require "online_migrations/lock_retrier"
+require "online_migrations/command_recorder"
+require "online_migrations/copy_trigger"
+require "online_migrations/change_column_type_helpers"
+require "online_migrations/schema_statements"
+require "online_migrations/version"
+
+module OnlineMigrations
+  class Error < StandardError; end
+  class UnsafeMigration < Error; end
+
+  class << self
+    # @private
+    attr_accessor :current_migration
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def load
+      require "active_record/connection_adapters/postgresql_adapter"
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(OnlineMigrations::SchemaStatements)
+
+      ActiveRecord::Migration.prepend(OnlineMigrations::Migration)
+      ActiveRecord::Migrator.prepend(OnlineMigrations::Migrator)
+
+      ActiveRecord::Tasks::DatabaseTasks.singleton_class.prepend(OnlineMigrations::DatabaseTasks)
+      ActiveRecord::ConnectionAdapters::SchemaCache.prepend(OnlineMigrations::SchemaCache)
+      ActiveRecord::Migration::CommandRecorder.include(OnlineMigrations::CommandRecorder)
+
+      if OnlineMigrations::Utils.ar_version <= 5.1
+        ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.prepend(OnlineMigrations::ForeignKeyDefinition)
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  OnlineMigrations.load
+end

data/online_migrations.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/online_migrations/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "online_migrations"
+  spec.version       = OnlineMigrations::VERSION
+  spec.authors       = ["fatkodima"]
+  spec.email         = ["fatkodima123@gmail.com"]
+
+  spec.summary       = "Catch unsafe PostgreSQL migrations in development and run them easier in production"
+  spec.homepage      = "https://github.com/fatkodima/online_migrations"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.1.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 4.2"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: online_migrations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fatkodima
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description:
+email:
+- fatkodima123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".yardopts"
+- BACKGROUND_MIGRATIONS.md
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/activerecord_42.gemfile
+- gemfiles/activerecord_50.gemfile
+- gemfiles/activerecord_51.gemfile
+- gemfiles/activerecord_52.gemfile
+- gemfiles/activerecord_60.gemfile
+- gemfiles/activerecord_61.gemfile
+- gemfiles/activerecord_70.gemfile
+- gemfiles/activerecord_head.gemfile
+- lib/generators/online_migrations/background_migration_generator.rb
+- lib/generators/online_migrations/install_generator.rb
+- lib/generators/online_migrations/templates/background_migration.rb.tt
+- lib/generators/online_migrations/templates/initializer.rb.tt
+- lib/generators/online_migrations/templates/migration.rb.tt
+- lib/online_migrations.rb
+- lib/online_migrations/background_migration.rb
+- lib/online_migrations/background_migrations/advisory_lock.rb
+- lib/online_migrations/background_migrations/backfill_column.rb
+- lib/online_migrations/background_migrations/background_migration_class_validator.rb
+- lib/online_migrations/background_migrations/config.rb
+- lib/online_migrations/background_migrations/copy_column.rb
+- lib/online_migrations/background_migrations/migration.rb
+- lib/online_migrations/background_migrations/migration_helpers.rb
+- lib/online_migrations/background_migrations/migration_job.rb
+- lib/online_migrations/background_migrations/migration_job_runner.rb
+- lib/online_migrations/background_migrations/migration_job_status_validator.rb
+- lib/online_migrations/background_migrations/migration_runner.rb
+- lib/online_migrations/background_migrations/migration_status_validator.rb
+- lib/online_migrations/background_migrations/scheduler.rb
+- lib/online_migrations/batch_iterator.rb
+- lib/online_migrations/change_column_type_helpers.rb
+- lib/online_migrations/command_checker.rb
+- lib/online_migrations/command_recorder.rb
+- lib/online_migrations/config.rb
+- lib/online_migrations/copy_trigger.rb
+- lib/online_migrations/database_tasks.rb
+- lib/online_migrations/error_messages.rb
+- lib/online_migrations/foreign_key_definition.rb
+- lib/online_migrations/foreign_keys_collector.rb
+- lib/online_migrations/indexes_collector.rb
+- lib/online_migrations/lock_retrier.rb
+- lib/online_migrations/migration.rb
+- lib/online_migrations/migrator.rb
+- lib/online_migrations/schema_cache.rb
+- lib/online_migrations/schema_statements.rb
+- lib/online_migrations/utils.rb
+- lib/online_migrations/version.rb
+- online_migrations.gemspec
+homepage: https://github.com/fatkodima/online_migrations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fatkodima/online_migrations
+  source_code_uri: https://github.com/fatkodima/online_migrations
+  changelog_uri: https://github.com/fatkodima/online_migrations/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Catch unsafe PostgreSQL migrations in development and run them easier in
+  production
+test_files: []