tooling/danger/bulk_database_actions.rb


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

# frozen_string_literal: true

require_relative 'suggestion'

module Tooling
  module Danger
    class BulkDatabaseActions < Suggestion
      MATCH = %r{\A\+\s+(\S*\.)?((update|upsert|delete|destroy)(_all)?)\b}
      REPLACEMENT = nil
      DOCUMENTATION_LINK = 'https://docs.gitlab.com/ee/development/database_review.html#preparation-when-using-bulk-update-operations'

      SUGGESTION = <<~MESSAGE_MARKDOWN.freeze
        When using `update`, `upsert`, `delete`, `update_all`, `upsert_all`, `delete_all` or `destroy_all`
        you must include the full database query and query execution plan in the merge request description,
        and request a ~database review.

        This comment can be ignored if the object is not an ActiveRecord class, since no database query would be generated.

        ----

        For more information, see [Database Review documentation](#{DOCUMENTATION_LINK}).
      MESSAGE_MARKDOWN
    end
  end
end