File: change_column_default.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (31 lines) | stat: -rw-r--r-- 1,161 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# frozen_string_literal: true

require_relative 'suggestor'

module Tooling
  module Danger
    module ChangeColumnDefault
      include ::Tooling::Danger::Suggestor

      METHODS = %w[change_column_default remove_column_default].freeze
      MIGRATION_METHODS_REGEX = /^\+\s*(.*\.)?(#{METHODS.join('|')})[(\s]/
      MIGRATION_FILES_REGEX = %r{^db/(post_)?migrate}

      DOCUMENTATION = 'https://docs.gitlab.com/ee/development/database/avoiding_downtime_in_migrations.html#changing-column-defaults'
      COMMENT =
        "Changing column default is difficult because of how Rails handles values that are equal to the default. " \
        "Please make sure all columns are declared as `columns_changing_default`. " \
        "For more information, see [Avoiding downtime in migrations documentation](#{DOCUMENTATION}).".freeze

      def add_comment_for_change_column_default
        migration_files.each do |filename|
          add_suggestion(filename: filename, regex: MIGRATION_METHODS_REGEX, comment_text: COMMENT)
        end
      end

      def migration_files
        helper.all_changed_files.grep(MIGRATION_FILES_REGEX)
      end
    end
  end
end