strong_migrations 0.7.0 → 2.2.0

data/lib/generators/strong_migrations/install_generator.rb

@@ -12,6 +12,31 @@ module StrongMigrations
       def start_after
         Time.now.utc.strftime("%Y%m%d%H%M%S")
       end
+
+      def pgbouncer_message
+        if postgresql?
+          "\n# If you use PgBouncer in transaction mode, delete these lines and set timeouts on the database user"
+        end
+      end
+
+      def target_version
+        case adapter
+        when /mysql|trilogy/
+          # could try to connect to database and check for MariaDB
+          # but this should be fine
+          "8.0"
+        else
+          "10"
+        end
+      end
+
+      def adapter
+        ActiveRecord::Base.connection_db_config.adapter.to_s
+      end
+
+      def postgresql?
+        adapter =~ /postg/
+      end
     end
   end
 end

data/lib/generators/strong_migrations/templates/initializer.rb.tt

@@ -1,8 +1,7 @@
 # Mark existing migrations as safe
 StrongMigrations.start_after = <%= start_after %>
 
-# Set timeouts for migrations
-# If you use PgBouncer in transaction mode, delete these lines and set timeouts on the database user
+# Set timeouts for migrations<%= pgbouncer_message %>
 StrongMigrations.lock_timeout = 10.seconds
 StrongMigrations.statement_timeout = 1.hour
 
@@ -10,9 +9,17 @@ StrongMigrations.statement_timeout = 1.hour
 # Outdated statistics can sometimes hurt performance
 StrongMigrations.auto_analyze = true
 
+# Set the version of the production database
+# so the right checks are run in development
+# StrongMigrations.target_version = <%= target_version %>
+
 # Add custom checks
 # StrongMigrations.add_check do |method, args|
 #   if method == :add_index && args[0].to_s == "users"
 #     stop! "No more indexes on the users table"
 #   end
-# end
+# end<% if postgresql? %>
+
+# Make some operations safe by default
+# See https://github.com/ankane/strong_migrations#safe-by-default
+# StrongMigrations.safe_by_default = true<% end %>

data/lib/strong_migrations/adapters/abstract_adapter.rb

@@ -0,0 +1,76 @@
+module StrongMigrations
+  module Adapters
+    class AbstractAdapter
+      def initialize(checker)
+        @checker = checker
+      end
+
+      def name
+        "Unknown"
+      end
+
+      def min_version
+      end
+
+      def set_statement_timeout(timeout)
+        # do nothing
+      end
+
+      def set_lock_timeout(timeout)
+        # do nothing
+      end
+
+      def check_lock_timeout(limit)
+        # do nothing
+      end
+
+      def add_column_default_safe?
+        false
+      end
+
+      def change_type_safe?(table, column, type, options, existing_column, existing_type)
+        false
+      end
+
+      def rewrite_blocks
+        "reads and writes"
+      end
+
+      def auto_incrementing_types
+        ["primary_key"]
+      end
+
+      def max_constraint_name_length
+      end
+
+      private
+
+      def connection
+        @checker.send(:connection)
+      end
+
+      def select_all(statement)
+        connection.select_all(statement)
+      end
+
+      def target_version(target_version)
+        target_version ||= StrongMigrations.target_version
+        version =
+          if target_version && StrongMigrations.developer_env?
+            if target_version.is_a?(Hash)
+              db_config_name = connection.pool.db_config.name
+              target_version.stringify_keys.fetch(db_config_name) do
+                # error class is not shown in db:migrate output so ensure message is descriptive
+                raise StrongMigrations::Error, "StrongMigrations.target_version is not configured for :#{db_config_name} database"
+              end.to_s
+            else
+              target_version.to_s
+            end
+          else
+            yield
+          end
+        Gem::Version.new(version)
+      end
+    end
+  end
+end

data/lib/strong_migrations/adapters/mariadb_adapter.rb

@@ -0,0 +1,32 @@
+module StrongMigrations
+  module Adapters
+    class MariaDBAdapter < MySQLAdapter
+      def name
+        "MariaDB"
+      end
+
+      def min_version
+        "10.5"
+      end
+
+      def server_version
+        @server_version ||= begin
+          target_version(StrongMigrations.target_mariadb_version) do
+            select_all("SELECT VERSION()").first["VERSION()"].split("-").first
+          end
+        end
+      end
+
+      def set_statement_timeout(timeout)
+        # fix deprecation warning with Active Record 7.1
+        timeout = timeout.value if timeout.is_a?(ActiveSupport::Duration)
+
+        select_all("SET max_statement_time = #{connection.quote(timeout)}")
+      end
+
+      def add_column_default_safe?
+        true
+      end
+    end
+  end
+end

data/lib/strong_migrations/adapters/mysql_adapter.rb

@@ -0,0 +1,112 @@
+# note: MariaDB inherits from this adapter
+# when making changes, be sure to see how it affects it
+module StrongMigrations
+  module Adapters
+    class MySQLAdapter < AbstractAdapter
+      def name
+        "MySQL"
+      end
+
+      def min_version
+        "8.0"
+      end
+
+      def server_version
+        @server_version ||= begin
+          target_version(StrongMigrations.target_mysql_version) do
+            select_all("SELECT VERSION()").first["VERSION()"].split("-").first
+          end
+        end
+      end
+
+      def set_statement_timeout(timeout)
+        # use ceil to prevent no timeout for values under 1 ms
+        select_all("SET max_execution_time = #{connection.quote((timeout.to_f * 1000).ceil)}")
+      end
+
+      def set_lock_timeout(timeout)
+        # fix deprecation warning with Active Record 7.1
+        timeout = timeout.value if timeout.is_a?(ActiveSupport::Duration)
+
+        select_all("SET lock_wait_timeout = #{connection.quote(timeout)}")
+      end
+
+      def check_lock_timeout(limit)
+        lock_timeout = connection.select_all("SHOW VARIABLES LIKE 'lock_wait_timeout'").first["Value"]
+        # lock timeout is an integer
+        if lock_timeout.to_i > limit
+          warn "[strong_migrations] DANGER: Lock timeout is longer than #{limit} seconds: #{lock_timeout}"
+        end
+      end
+
+      def analyze_table(table)
+        connection.execute "ANALYZE TABLE #{connection.quote_table_name(table.to_s)}"
+      end
+
+      def add_column_default_safe?
+        true
+      end
+
+      def change_type_safe?(table, column, type, options, existing_column, existing_type)
+        safe = false
+
+        case type.to_s
+        when "string"
+          limit = options[:limit] || 255
+          if ["varchar"].include?(existing_type) && limit >= existing_column.limit
+            # https://dev.mysql.com/doc/refman/5.7/en/innodb-online-ddl-operations.html
+            # https://mariadb.com/kb/en/innodb-online-ddl-operations-with-the-instant-alter-algorithm/#changing-the-data-type-of-a-column
+            # increased limit, but doesn't change number of length bytes
+            # 1-255 = 1 byte, 256-65532 = 2 bytes, 65533+ = too big for varchar
+
+            # account for charset
+            # https://dev.mysql.com/doc/refman/8.0/en/charset-mysql.html
+            # https://mariadb.com/kb/en/supported-character-sets-and-collations/
+            sql = <<~SQL
+              SELECT cs.MAXLEN
+              FROM INFORMATION_SCHEMA.CHARACTER_SETS cs
+              INNER JOIN INFORMATION_SCHEMA.COLUMNS c ON c.CHARACTER_SET_NAME = cs.CHARACTER_SET_NAME
+              WHERE c.TABLE_SCHEMA = database() AND
+              c.TABLE_NAME = #{connection.quote(table)} AND
+              c.COLUMN_NAME = #{connection.quote(column)}
+            SQL
+            row = connection.select_all(sql).first
+            if row
+              threshold = 255 / row["MAXLEN"]
+              safe = limit <= threshold || existing_column.limit > threshold
+            else
+              warn "[strong_migrations] Could not determine charset"
+            end
+          end
+        end
+
+        safe
+      end
+
+      def strict_mode?
+        sql_modes = sql_modes()
+        sql_modes.include?("STRICT_ALL_TABLES") || sql_modes.include?("STRICT_TRANS_TABLES")
+      end
+
+      def rewrite_blocks
+        "writes"
+      end
+
+      def max_constraint_name_length
+        64
+      end
+
+      private
+
+      # do not memoize
+      # want latest value
+      def sql_modes
+        if StrongMigrations.target_sql_mode && StrongMigrations.developer_env?
+          StrongMigrations.target_sql_mode.split(",")
+        else
+          select_all("SELECT @@SESSION.sql_mode").first["@@SESSION.sql_mode"].split(",")
+        end
+      end
+    end
+  end
+end

data/lib/strong_migrations/adapters/postgresql_adapter.rb

@@ -0,0 +1,232 @@
+module StrongMigrations
+  module Adapters
+    class PostgreSQLAdapter < AbstractAdapter
+      def name
+        "PostgreSQL"
+      end
+
+      def min_version
+        "12"
+      end
+
+      def server_version
+        @version ||= begin
+          target_version(StrongMigrations.target_postgresql_version) do
+            version = select_all("SHOW server_version_num").first["server_version_num"].to_i
+            # major and minor version
+            "#{version / 10000}.#{(version % 10000)}"
+          end
+        end
+      end
+
+      def set_statement_timeout(timeout)
+        set_timeout("statement_timeout", timeout)
+      end
+
+      def set_lock_timeout(timeout)
+        set_timeout("lock_timeout", timeout)
+      end
+
+      def check_lock_timeout(limit)
+        lock_timeout = connection.select_all("SHOW lock_timeout").first["lock_timeout"]
+        lock_timeout_sec = timeout_to_sec(lock_timeout)
+        if lock_timeout_sec == 0
+          warn "[strong_migrations] DANGER: No lock timeout set"
+        elsif lock_timeout_sec > limit
+          warn "[strong_migrations] DANGER: Lock timeout is longer than #{limit} seconds: #{lock_timeout}"
+        end
+      end
+
+      def analyze_table(table)
+        connection.execute "ANALYZE #{connection.quote_table_name(table.to_s)}"
+      end
+
+      def add_column_default_safe?
+        true
+      end
+
+      def change_type_safe?(table, column, type, options, existing_column, existing_type)
+        safe = false
+
+        case type.to_s
+        when "string"
+          # safe to increase limit or remove it
+          # not safe to decrease limit or add a limit
+          case existing_type
+          when "character varying"
+            safe = !options[:limit] || (existing_column.limit && options[:limit] >= existing_column.limit)
+          when "text"
+            safe = !options[:limit]
+          when "citext"
+            safe = !options[:limit] && !indexed?(table, column)
+          end
+        when "text"
+          # safe to change varchar to text (and text to text)
+          safe =
+            ["character varying", "text"].include?(existing_type) ||
+            (existing_type == "citext" && !indexed?(table, column))
+        when "citext"
+          safe = ["character varying", "text"].include?(existing_type) && !indexed?(table, column)
+        when "varbit"
+          # increasing length limit or removing the limit is safe
+          # but there doesn't seem to be a way to set/modify it
+          # https://wiki.postgresql.org/wiki/What%27s_new_in_PostgreSQL_9.2#Reduce_ALTER_TABLE_rewrites
+        when "numeric", "decimal"
+          # numeric and decimal are equivalent and can be used interchangeably
+          safe = ["numeric", "decimal"].include?(existing_type) &&
+            (
+              (
+                # unconstrained
+                !options[:precision] && !options[:scale]
+              ) || (
+                # increased precision, same scale
+                options[:precision] && existing_column.precision &&
+                options[:precision] >= existing_column.precision &&
+                options[:scale] == existing_column.scale
+              )
+            )
+        when "datetime", "timestamp", "timestamptz"
+          # precision for datetime
+          # limit for timestamp, timestamptz
+          precision = (type.to_s == "datetime" ? options[:precision] : options[:limit]) || 6
+          existing_precision = existing_column.limit || existing_column.precision || 6
+
+          type_map = {
+            "timestamp" => "timestamp without time zone",
+            "timestamptz" => "timestamp with time zone"
+          }
+          maybe_safe = type_map.value?(existing_type) && precision >= existing_precision
+
+          if maybe_safe
+            new_type = type.to_s == "datetime" ? datetime_type : type.to_s
+
+            # resolve with fallback
+            new_type = type_map[new_type] || new_type
+
+            safe = new_type == existing_type || time_zone == "UTC"
+          end
+        when "time"
+          precision = options[:precision] || options[:limit] || 6
+          existing_precision = existing_column.precision || existing_column.limit || 6
+
+          safe = existing_type == "time without time zone" && precision >= existing_precision
+        when "timetz"
+          # increasing precision is safe
+          # but there doesn't seem to be a way to set/modify it
+        when "interval"
+          # https://wiki.postgresql.org/wiki/What%27s_new_in_PostgreSQL_9.2#Reduce_ALTER_TABLE_rewrites
+          # Active Record uses precision before limit
+          precision = options[:precision] || options[:limit] || 6
+          existing_precision = existing_column.precision || existing_column.limit || 6
+
+          safe = existing_type == "interval" && precision >= existing_precision
+        when "inet"
+          safe = existing_type == "cidr"
+        end
+
+        safe
+      end
+
+      # TODO remove when Active Record < 7.1 is no longer supported
+      def index_invalid?(table_name, index_name)
+        query = <<~SQL
+          SELECT
+            indisvalid
+          FROM
+            pg_index
+          WHERE
+            indrelid = to_regclass(#{connection.quote(connection.quote_table_name(table_name))}) AND
+            indexrelid = to_regclass(#{connection.quote(connection.quote_table_name(index_name))}) AND
+            indisvalid = false
+        SQL
+        select_all(query.squish).any?
+      end
+
+      def writes_blocked?
+        query = <<~SQL
+          SELECT
+            relation::regclass::text
+          FROM
+            pg_locks
+          WHERE
+            mode IN ('ShareRowExclusiveLock', 'AccessExclusiveLock') AND
+            pid = pg_backend_pid()
+        SQL
+        select_all(query.squish).any?
+      end
+
+      # only check in non-developer environments (where actual server version is used)
+      def index_corruption?
+        server_version >= Gem::Version.new("14.0") &&
+          server_version < Gem::Version.new("14.4") &&
+          !StrongMigrations.developer_env?
+      end
+
+      # default to true if unsure
+      def default_volatile?(default)
+        name = default.to_s.delete_suffix("()")
+        rows = select_all("SELECT provolatile FROM pg_proc WHERE proname = #{connection.quote(name)}").to_a
+        rows.empty? || rows.any? { |r| r["provolatile"] == "v" }
+      end
+
+      def auto_incrementing_types
+        ["primary_key", "serial", "bigserial"]
+      end
+
+      def max_constraint_name_length
+        63
+      end
+
+      private
+
+      def set_timeout(setting, timeout)
+        # use ceil to prevent no timeout for values under 1 ms
+        timeout = (timeout.to_f * 1000).ceil unless timeout.is_a?(String)
+
+        select_all("SET #{setting} TO #{connection.quote(timeout)}")
+      end
+
+      # units: https://www.postgresql.org/docs/current/config-setting.html
+      def timeout_to_sec(timeout)
+        units = {
+          "us" => 0.001,
+          "ms" => 1,
+          "s" => 1000,
+          "min" => 1000 * 60,
+          "h" => 1000 * 60 * 60,
+          "d" => 1000 * 60 * 60 * 24
+        }
+        timeout_ms = timeout.to_i
+        units.each do |k, v|
+          if timeout.end_with?(k)
+            timeout_ms *= v
+            break
+          end
+        end
+        timeout_ms / 1000.0
+      end
+
+      # columns is array for column index and string for expression index
+      # the current approach can yield false positives for expression indexes
+      # but prefer to keep it simple for now
+      def indexed?(table, column)
+        connection.indexes(table).any? { |i| i.columns.include?(column.to_s) }
+      end
+
+      def datetime_type
+        # https://github.com/rails/rails/pull/41084
+        # no need to support custom datetime_types
+        key = connection.class.datetime_type
+
+        # could be timestamp, timestamp without time zone, timestamp with time zone, etc
+        connection.class.const_get(:NATIVE_DATABASE_TYPES).fetch(key).fetch(:name)
+      end
+
+      # do not memoize
+      # want latest value
+      def time_zone
+        select_all("SHOW timezone").first["TimeZone"]
+      end
+    end
+  end
+end