Class: StrongMigrations::Checker

Inherits:
Object
  • Object
show all
Defined in:
lib/strong_migrations/checker.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(migration) ⇒ Checker

Returns a new instance of Checker.



5
6
7
8
9
10
 
# File 'lib/strong_migrations/checker.rb', line 5

def initialize(migration)
  @migration = migration
  @new_tables = []
  @safe = false
  @timeouts_set = false
end

Instance Attribute Details

#direction ⇒ Object

Returns the value of attribute direction.



3
4
5
 
# File 'lib/strong_migrations/checker.rb', line 3

def direction
  @direction
end

Instance Method Details

#perform(method, *args) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/strong_migrations/checker.rb', line 22

def perform(method, *args)
  set_timeouts

  unless safe?
    case method
    when :remove_column, :remove_columns, :remove_timestamps, :remove_reference, :remove_belongs_to
      columns =
        case method
        when :remove_timestamps
          ["created_at", "updated_at"]
        when :remove_column
          [args[1].to_s]
        when :remove_columns
          args[1..-1].map(&:to_s)
        else
          options = args[2] || {}
          reference = args[1]
          cols = []
          cols << "#{reference}_type" if options[:polymorphic]
          cols << "#{reference}_id"
          cols
        end

      code = "self.ignored_columns = #{columns.inspect}"

      raise_error :remove_column,
        model: args[0].to_s.classify,
        code: code,
        command: command_str(method, args),
        column_suffix: columns.size > 1 ? "s" : ""
    when :change_table
      raise_error :change_table, header: "Possibly dangerous operation"
    when :rename_table
      raise_error :rename_table
    when :rename_column
      raise_error :rename_column
    when :add_index
      table, columns, options = args
      options ||= {}

      if columns.is_a?(Array) && columns.size > 3 && !options[:unique]
        raise_error :add_index_columns, header: "Best practice"
      end
      if postgresql? && options[:algorithm] != :concurrently && !new_table?(table)
        raise_error :add_index, command: command_str("add_index", [table, columns, options.merge(algorithm: :concurrently)])
      end
    when :remove_index
      table, options = args
      unless options.is_a?(Hash)
        options = {column: options}
      end
      options ||= {}

      if postgresql? && options[:algorithm] != :concurrently && !new_table?(table)
        raise_error :remove_index, command: command_str("remove_index", [table, options.merge(algorithm: :concurrently)])
      end
    when :add_column
      table, column, type, options = args
      options ||= {}
      default = options[:default]

      if !default.nil? && !((postgresql? && postgresql_version >= Gem::Version.new("11")) || (mysql? && mysql_version >= Gem::Version.new("8.0.12")) || (mariadb? && mariadb_version >= Gem::Version.new("10.3.2")))

        if options[:null] == false
          options = options.except(:null)
          append = "

Then add the NOT NULL constraint."
        end

        raise_error :add_column_default,
          add_command: command_str("add_column", [table, column, type, options.except(:default)]),
          change_command: command_str("change_column_default", [table, column, default]),
          remove_command: command_str("remove_column", [table, column]),
          code: backfill_code(table, column, default),
          append: append
      end

      if type.to_s == "json" && postgresql?
        raise_error :add_column_json
      end
    when :change_column
      table, column, type = args

      safe = false
      # assume Postgres 9.1+ since previous versions are EOL
      if postgresql? && type.to_s == "text"
        found_column = connection.columns(table).find { |c| c.name.to_s == column.to_s }
        safe = found_column && found_column.type == :string
      end
      raise_error :change_column unless safe
    when :create_table
      table, options = args
      options ||= {}

      raise_error :create_table if options[:force]

      # keep track of new tables of add_index check
      @new_tables << table.to_s
    when :add_reference, :add_belongs_to
      table, reference, options = args
      options ||= {}

      index_value = options.fetch(:index, true)
      concurrently_set = index_value.is_a?(Hash) && index_value[:algorithm] == :concurrently

      if postgresql? && index_value && !concurrently_set
        columns = options[:polymorphic] ? [:"#{reference}_type", :"#{reference}_id"] : :"#{reference}_id"

        if index_value.is_a?(Hash)
          options[:index] = options[:index].merge(algorithm: :concurrently)
        else
          options = options.merge(index: {algorithm: :concurrently})
        end

        raise_error :add_reference, command: command_str(method, [table, reference, options])
      end
    when :execute
      raise_error :execute, header: "Possibly dangerous operation"
    when :change_column_null
      table, column, null, default = args
      if !null
        if postgresql?
          if helpers?
            raise_error :change_column_null_postgresql_helper,
              command: command_str(:add_null_constraint_safely, [table, column])
          else
            # match https://github.com/nullobject/rein
            constraint_name = "#{table}_#{column}_null"

            raise_error :change_column_null_postgresql,
              add_constraint_code: constraint_str("ALTER TABLE %s ADD CONSTRAINT %s CHECK (%s IS NOT NULL) NOT VALID", [table, constraint_name, column]),
              validate_constraint_code: constraint_str("ALTER TABLE %s VALIDATE CONSTRAINT %s", [table, constraint_name])
          end
        elsif mysql? || mariadb?
          raise_error :change_column_null_mysql
        elsif !default.nil?
          raise_error :change_column_null,
            code: backfill_code(table, column, default)
        end
      end
    when :add_foreign_key
      from_table, to_table, options = args
      options ||= {}

      # always validated before 5.2
      validate = options.fetch(:validate, true) || ActiveRecord::VERSION::STRING < "5.2"

      if postgresql? && validate
        if helpers?
          raise_error :add_foreign_key_helper,
            command: command_str(:add_foreign_key_safely, [from_table, to_table, options])
        elsif ActiveRecord::VERSION::STRING < "5.2"
          # fk name logic from rails
          primary_key = options[:primary_key] || "id"
          column = options[:column] || "#{to_table.to_s.singularize}_id"
          hashed_identifier = Digest::SHA256.hexdigest("#{from_table}_#{column}_fk").first(10)
          fk_name = options[:name] || "fk_rails_#{hashed_identifier}"

          raise_error :add_foreign_key,
            add_foreign_key_code: constraint_str("ALTER TABLE %s ADD CONSTRAINT %s FOREIGN KEY (%s) REFERENCES %s (%s) NOT VALID", [from_table, fk_name, column, to_table, primary_key]),
            validate_foreign_key_code: constraint_str("ALTER TABLE %s VALIDATE CONSTRAINT %s", [from_table, fk_name])
        else
          raise_error :add_foreign_key,
            add_foreign_key_code: command_str("add_foreign_key", [from_table, to_table, options.merge(validate: false)]),
            validate_foreign_key_code: command_str("validate_foreign_key", [from_table, to_table])
        end
      end
    end

    StrongMigrations.checks.each do |check|
      @migration.instance_exec(method, args, &check)
    end
  end

  result = yield

  if StrongMigrations.auto_analyze && direction == :up && method == :add_index
    if postgresql?
      connection.execute "ANALYZE VERBOSE #{connection.quote_table_name(args[0].to_s)}"
    elsif mariadb? || mysql?
      connection.execute "ANALYZE TABLE #{connection.quote_table_name(args[0].to_s)}"
    end
  end

  result
end

#safety_assured ⇒ Object 



12
13
14
15
16
17
18
19
20
 
# File 'lib/strong_migrations/checker.rb', line 12

def safety_assured
  previous_value = @safe
  begin
    @safe = true
    yield
  ensure
    @safe = previous_value
  end
end

#set_timeouts ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/strong_migrations/checker.rb', line 210

def set_timeouts
  if !@timeouts_set
    if StrongMigrations.statement_timeout
      statement =
        if postgresql?
          "SET statement_timeout TO #{connection.quote(StrongMigrations.statement_timeout.to_i * 1000)}"
        elsif mysql?
          "SET max_execution_time = #{connection.quote(StrongMigrations.statement_timeout.to_i * 1000)}"
        elsif mariadb?
          "SET max_statement_time = #{connection.quote(StrongMigrations.statement_timeout)}"
        else
          raise StrongMigrations::Error, "Statement timeout not supported for this database"
        end

      connection.select_all(statement)
    end

    if StrongMigrations.lock_timeout
      statement =
        if postgresql?
          "SET lock_timeout TO #{connection.quote(StrongMigrations.lock_timeout.to_i * 1000)}"
        elsif mysql? || mariadb?
          "SET lock_wait_timeout = #{connection.quote(StrongMigrations.lock_timeout)}"
        else
          raise StrongMigrations::Error, "Lock timeout not supported for this database"
        end

      connection.select_all(statement)
    end

    @timeouts_set = true
  end
end