Merge branch 'ab/bulk-insert-cop' into 'master'

Deprecate `Gitlab::Database.bulk_insert`

See merge request gitlab-org/gitlab!32429

app/models/design_management/version.rb

@@ -88,7 +88,7 @@ module DesignManagement
 
         rows = design_actions.map { |action| action.row_attrs(version) }
 
-        Gitlab::Database.bulk_insert(::DesignManagement::Action.table_name, rows)
+        Gitlab::Database.bulk_insert(::DesignManagement::Action.table_name, rows) # rubocop:disable Gitlab/BulkInsert
         version.designs.reset
         version.validate!
         design_actions.each(&:performed)

app/models/merge_request_context_commit.rb

@@ -20,7 +20,7 @@ class MergeRequestContextCommit < ApplicationRecord
 
   # create MergeRequestContextCommit by given commit sha and it's diff file record
   def self.bulk_insert(*args)
-    Gitlab::Database.bulk_insert('merge_request_context_commits', *args)
+    Gitlab::Database.bulk_insert('merge_request_context_commits', *args) # rubocop:disable Gitlab/BulkInsert
   end
 
   def to_commit

app/models/merge_request_context_commit_diff_file.rb

@@ -12,6 +12,6 @@ class MergeRequestContextCommitDiffFile < ApplicationRecord
 
   # create MergeRequestContextCommitDiffFile by given diff file record(s)
   def self.bulk_insert(*args)
-    Gitlab::Database.bulk_insert('merge_request_context_commit_diff_files', *args)
+    Gitlab::Database.bulk_insert('merge_request_context_commit_diff_files', *args) # rubocop:disable Gitlab/BulkInsert
   end
 end

app/models/merge_request_diff.rb

@@ -437,7 +437,7 @@ class MergeRequestDiff < ApplicationRecord
 
     transaction do
       MergeRequestDiffFile.where(merge_request_diff_id: id).delete_all
-      Gitlab::Database.bulk_insert('merge_request_diff_files', rows)
+      Gitlab::Database.bulk_insert('merge_request_diff_files', rows) # rubocop:disable Gitlab/BulkInsert
       update!(stored_externally: false)
     end
 
@@ -495,7 +495,7 @@ class MergeRequestDiff < ApplicationRecord
     rows = build_external_merge_request_diff_files(rows) if use_external_diff?
 
     # Faster inserts
-    Gitlab::Database.bulk_insert('merge_request_diff_files', rows)
+    Gitlab::Database.bulk_insert('merge_request_diff_files', rows) # rubocop:disable Gitlab/BulkInsert
   end
 
   def build_external_diff_tempfile(rows)

app/models/merge_request_diff_commit.rb

@@ -27,6 +27,6 @@ class MergeRequestDiffCommit < ApplicationRecord
       )
     end
 
-    Gitlab::Database.bulk_insert(self.table_name, rows)
+    Gitlab::Database.bulk_insert(self.table_name, rows) # rubocop:disable Gitlab/BulkInsert
   end
 end

app/services/ci/extract_sections_from_build_trace_service.rb

@@ -5,7 +5,7 @@ module Ci
     def execute(build)
       return false unless build.trace_sections.empty?
 
-      Gitlab::Database.bulk_insert(BuildTraceSection.table_name, extract_sections(build))
+      Gitlab::Database.bulk_insert(BuildTraceSection.table_name, extract_sections(build)) # rubocop:disable Gitlab/BulkInsert
       true
     end
 

app/services/issuable/clone/attributes_rewriter.rb

@@ -105,7 +105,7 @@ module Issuable
             yield(event)
           end.compact
 
-          Gitlab::Database.bulk_insert(table_name, events)
+          Gitlab::Database.bulk_insert(table_name, events) # rubocop:disable Gitlab/BulkInsert
         end
       end
 

app/services/projects/detect_repository_languages_service.rb

@@ -21,7 +21,7 @@ module Projects
             .update_all(share: update[:share])
         end
 
-        Gitlab::Database.bulk_insert(
+        Gitlab::Database.bulk_insert( # rubocop:disable Gitlab/BulkInsert
           RepositoryLanguage.table_name,
           detection.insertions(matching_programming_languages)
         )

app/services/projects/lfs_pointers/lfs_link_service.rb

@@ -38,7 +38,7 @@ module Projects
           rows = existent_lfs_objects
                    .not_linked_to_project(project)
                    .map { |existing_lfs_object| { project_id: project.id, lfs_object_id: existing_lfs_object.id } }
-          Gitlab::Database.bulk_insert(:lfs_objects_projects, rows)
+          Gitlab::Database.bulk_insert(:lfs_objects_projects, rows) # rubocop:disable Gitlab/BulkInsert
           iterations += 1
 
           linked_existing_objects += existent_lfs_objects.map(&:oid)

app/services/resource_events/change_labels_service.rb

@@ -22,7 +22,7 @@ module ResourceEvents
         label_hash.merge(label_id: label.id, action: ResourceLabelEvent.actions['remove'])
       end
 
-      Gitlab::Database.bulk_insert(ResourceLabelEvent.table_name, labels)
+      Gitlab::Database.bulk_insert(ResourceLabelEvent.table_name, labels) # rubocop:disable Gitlab/BulkInsert
       resource.expire_note_etag_cache
     end
 

app/services/suggestions/create_service.rb

@@ -25,7 +25,7 @@ module Suggestions
         end
 
       rows.in_groups_of(100, false) do |rows|
-        Gitlab::Database.bulk_insert('suggestions', rows)
+        Gitlab::Database.bulk_insert('suggestions', rows) # rubocop:disable Gitlab/BulkInsert
       end
     end
   end

app/workers/gitlab/jira_import/import_issue_worker.rb

@@ -48,7 +48,7 @@ module Gitlab
 
         label_link_attrs << build_label_attrs(issue_id, import_label_id.to_i)
 
-        Gitlab::Database.bulk_insert(LabelLink.table_name, label_link_attrs)
+        Gitlab::Database.bulk_insert(LabelLink.table_name, label_link_attrs) # rubocop:disable Gitlab/BulkInsert
       end
 
       def assign_issue(project_id, issue_id, assignee_ids)
@@ -56,7 +56,7 @@ module Gitlab
 
         assignee_attrs = assignee_ids.map { |user_id| { issue_id: issue_id, user_id: user_id } }
 
-        Gitlab::Database.bulk_insert(IssueAssignee.table_name, assignee_attrs)
+        Gitlab::Database.bulk_insert(IssueAssignee.table_name, assignee_attrs) # rubocop:disable Gitlab/BulkInsert
       end
 
       def build_label_attrs(issue_id, label_id)

db/post_migrate/20200310215714_migrate_saml_identities_to_scim_identities.rb

@@ -20,7 +20,7 @@ class MigrateSamlIdentitiesToScimIdentities < ActiveRecord::Migration[6.0]
           record.attributes.extract!("extern_uid", "user_id", "group_id", "active", "created_at", "updated_at")
         end
 
-        Gitlab::Database.bulk_insert(:scim_identities, data_to_insert, on_conflict: :do_nothing)
+        Gitlab::Database.bulk_insert(:scim_identities, data_to_insert, on_conflict: :do_nothing) # rubocop:disable Gitlab/BulkInsert
       end
   end
 

ee/app/models/elasticsearch_indexed_namespace.rb

@@ -37,7 +37,7 @@ class ElasticsearchIndexedNamespace < ApplicationRecord
         { created_at: now, updated_at: now, namespace_id: id }
       end
 
-      Gitlab::Database.bulk_insert(table_name, insert_rows)
+      Gitlab::Database.bulk_insert(table_name, insert_rows) # rubocop:disable Gitlab/BulkInsert
       invalidate_elasticsearch_indexes_project_cache!
 
       jobs = batch_ids.map { |id| [id, :index] }

ee/lib/ee/gitlab/background_migration/generate_gitlab_subscriptions.rb

@@ -49,7 +49,7 @@ module EE
                     }
                   end
 
-          Gitlab::Database.bulk_insert(:gitlab_subscriptions, rows)
+          Gitlab::Database.bulk_insert(:gitlab_subscriptions, rows) # rubocop:disable Gitlab/BulkInsert
         end
       end
     end

lib/gitlab/background_migration/backfill_project_repositories.rb

@@ -189,7 +189,7 @@ module Gitlab
       end
 
       def perform(start_id, stop_id)
-        Gitlab::Database.bulk_insert(:project_repositories, project_repositories(start_id, stop_id))
+        Gitlab::Database.bulk_insert(:project_repositories, project_repositories(start_id, stop_id)) # rubocop:disable Gitlab/BulkInsert
       end
 
       private

lib/gitlab/background_migration/migrate_fingerprint_sha256_within_keys.rb

@@ -34,7 +34,7 @@ module Gitlab
             end
           end
 
-          Gitlab::Database.bulk_insert(TEMP_TABLE, fingerprints)
+          Gitlab::Database.bulk_insert(TEMP_TABLE, fingerprints) # rubocop:disable Gitlab/BulkInsert
 
           execute("ANALYZE #{TEMP_TABLE}")
 

lib/gitlab/background_migration/migrate_issue_trackers_sensitive_data.rb

@@ -65,7 +65,7 @@ module Gitlab
           next if service_ids.empty?
 
           migrated_ids += service_ids
-          Gitlab::Database.bulk_insert(table, data)
+          Gitlab::Database.bulk_insert(table, data) # rubocop:disable Gitlab/BulkInsert
         end
 
         return if migrated_ids.empty?

lib/gitlab/background_migration/populate_cluster_kubernetes_namespace_table.rb

@@ -73,7 +73,7 @@ module Gitlab
       end
 
       def insert_into_cluster_kubernetes_namespace(rows)
-        Gitlab::Database.bulk_insert(Migratable::KubernetesNamespace.table_name,
+        Gitlab::Database.bulk_insert(Migratable::KubernetesNamespace.table_name, # rubocop:disable Gitlab/BulkInsert
                                      rows,
                                      disable_quote: [:created_at, :updated_at])
       end

lib/gitlab/background_migration/populate_untracked_uploads.rb

@@ -95,7 +95,7 @@ module Gitlab
           file.to_h.merge(created_at: 'NOW()')
         end
 
-        Gitlab::Database.bulk_insert('uploads',
+        Gitlab::Database.bulk_insert('uploads', # rubocop:disable Gitlab/BulkInsert
                                      rows,
                                      disable_quote: :created_at)
       end

lib/gitlab/background_migration/user_mentions/create_resource_user_mention.rb

@@ -25,7 +25,7 @@ module Gitlab
               mentions << mention_record unless mention_record.blank?
             end
 
-            Gitlab::Database.bulk_insert(
+            Gitlab::Database.bulk_insert( # rubocop:disable Gitlab/BulkInsert
               resource_user_mention_model.table_name,
               mentions,
               return_ids: true,

lib/gitlab/github_import/bulk_importing.rb

@@ -17,7 +17,7 @@ module Gitlab
       # Bulk inserts the given rows into the database.
       def bulk_insert(model, rows, batch_size: 100)
         rows.each_slice(batch_size) do |slice|
-          Gitlab::Database.bulk_insert(model.table_name, slice)
+          Gitlab::Database.bulk_insert(model.table_name, slice) # rubocop:disable Gitlab/BulkInsert
         end
       end
     end

lib/gitlab/github_import/importer/diff_note_importer.rb

@@ -47,7 +47,7 @@ module Gitlab
           # To work around this we're using bulk_insert with a single row. This
           # allows us to efficiently insert data (even if it's just 1 row)
           # without having to use all sorts of hacks to disable callbacks.
-          Gitlab::Database.bulk_insert(LegacyDiffNote.table_name, [attributes])
+          Gitlab::Database.bulk_insert(LegacyDiffNote.table_name, [attributes]) # rubocop:disable Gitlab/BulkInsert
         rescue ActiveRecord::InvalidForeignKey
           # It's possible the project and the issue have been deleted since
           # scheduling this job. In this case we'll just skip creating the note.

lib/gitlab/github_import/importer/issue_importer.rb

@@ -75,7 +75,7 @@ module Gitlab
             end
           end
 
-          Gitlab::Database.bulk_insert(IssueAssignee.table_name, assignees)
+          Gitlab::Database.bulk_insert(IssueAssignee.table_name, assignees) # rubocop:disable Gitlab/BulkInsert
         end
       end
     end

lib/gitlab/github_import/importer/label_links_importer.rb

@@ -40,7 +40,7 @@ module Gitlab
             }
           end
 
-          Gitlab::Database.bulk_insert(LabelLink.table_name, rows)
+          Gitlab::Database.bulk_insert(LabelLink.table_name, rows) # rubocop:disable Gitlab/BulkInsert
         end
 
         def find_target_id

lib/gitlab/github_import/importer/note_importer.rb

@@ -38,7 +38,7 @@ module Gitlab
           # We're using bulk_insert here so we can bypass any validations and
           # callbacks. Running these would result in a lot of unnecessary SQL
           # queries being executed when importing large projects.
-          Gitlab::Database.bulk_insert(Note.table_name, [attributes])
+          Gitlab::Database.bulk_insert(Note.table_name, [attributes]) # rubocop:disable Gitlab/BulkInsert
         rescue ActiveRecord::InvalidForeignKey
           # It's possible the project and the issue have been deleted since
           # scheduling this job. In this case we'll just skip creating the note.

lib/gitlab/import/database_helpers.rb

@@ -11,7 +11,7 @@ module Gitlab
         # We use bulk_insert here so we can bypass any queries executed by
         # callbacks or validation rules, as doing this wouldn't scale when
         # importing very large projects.
-        result = Gitlab::Database
+        result = Gitlab::Database # rubocop:disable Gitlab/BulkInsert
                  .bulk_insert(relation.table_name, [attributes], return_ids: true)
 
         result.first

rubocop/cop/gitlab/bulk_insert.rb

+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gitlab
+      # Cop that disallows the use of `Gitlab::Database.bulk_insert`, in favour of using
+      # the `BulkInsertSafe` module.
+      class BulkInsert < RuboCop::Cop::Cop
+        MSG = 'Use the `BulkInsertSafe` concern, instead of using `Gitlab::Database.bulk_insert`. See https://docs.gitlab.com/ee/development/insert_into_tables_in_batches.html'
+
+        def_node_matcher :raw_union?, <<~PATTERN
+          (send (const (const nil? :Gitlab) :Database) :bulk_insert ...)
+        PATTERN
+
+        def on_send(node)
+          return unless raw_union?(node)
+
+          add_offense(node, location: :expression)
+        end
+      end
+    end
+  end
+end

spec/factories/design_management/designs.rb

@@ -35,7 +35,7 @@ FactoryBot.define do
           sha = commit_version[action]
           version = DesignManagement::Version.new(sha: sha, issue: issue, author: evaluator.author)
           version.save(validate: false) # We need it to have an ID, validate later
-          Gitlab::Database.bulk_insert(dv_table_name, [action.row_attrs(version)])
+          Gitlab::Database.bulk_insert(dv_table_name, [action.row_attrs(version)]) # rubocop:disable Gitlab/BulkInsert
         end
 
         # always a creation

spec/rubocop/cop/gitlab/bulk_insert_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'rubocop'
+require 'rubocop/rspec/support'
+require_relative '../../../../rubocop/cop/gitlab/bulk_insert'
+
+describe RuboCop::Cop::Gitlab::BulkInsert do
+  include CopHelper
+
+  subject(:cop) { described_class.new }
+
+  it 'flags the use of Gitlab::Database.bulk_insert' do
+    expect_offense(<<~SOURCE)
+    Gitlab::Database.bulk_insert('merge_request_diff_files', rows)
+    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use the `BulkInsertSafe` concern, instead of using `Gitlab::Database.bulk_insert`. See https://docs.gitlab.com/ee/development/insert_into_tables_in_batches.html
+    SOURCE
+  end
+end