Add PreventReindexFullESDocumentCop (#35)

* Add PreventReindexFullESDocumentCop

* Specs

* Linting fix

* Build fix

Author: adarshaks91

config/default.yml

@@ -72,3 +72,7 @@ Bugcrowd/AvoidSampleInSpecs:
   Enabled: true
   Include:
     - 'spec/**/*.rb'
+BugcrowdCops/PreventReindexFullESDocumentCop:
+  Enabled: true
+  Include:
+    - 'app/**/*.rb'

lib/rubocop/cop/bugcrowd/prevent_reindex_full_es_document_cop.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Bugcrowd
+      class PreventReindexFullESDocumentCop < Cop
+        #
+        # @example
+        #
+        # # bad
+        # ```
+        # Reindexing a full ES document would reindex all the resource ids
+        # ```
+        # ValisCommands::ReindexDocument.call(document_type: 'SubmissionDocument')
+        #
+        # # good
+        # Reindex only a specific resource ID instead
+        # ```
+        # ValisReindexWorker.new.perform([submission.id], Submission.to_s)
+        # ```
+        #
+
+        MSG = 'Avoid reindexing the full Elasticsearch document. ' \
+        'Consider reindexing only specific resource ids.'
+
+        def_node_matcher :valis_reindex_document?, <<-PATTERN
+          (send
+            (const
+              (const nil? :ValisCommands) :ReindexDocument) :call
+              (hash $...))
+        PATTERN
+
+        def on_send(node)
+          if valis_reindex_document?(node)
+            add_offense(node, message: MSG)
+          end
+        end
+      end
+    end
+  end
+end

lib/rubocop/cop/bugcrowd_cops.rb

@@ -37,3 +37,4 @@
 require_relative 'bugcrowd/no_include_run_in_transaction'
 require_relative 'bugcrowd/no_event_deprecated_publish'
 require_relative 'bugcrowd/sidekiq_testing_inline'
+require_relative 'bugcrowd/prevent_reindex_full_es_document_cop.rb'

spec/rubocop/cop/bugcrowd/prevent_reindex_full_es_document_cop_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Bugcrowd::PreventReindexFullESDocumentCop do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  it 'registers an offence when reindexing a full elasticsearch document' do
+    expect_offense(<<~RUBY)
+      ValisCommands::ReindexDocument.call(document_type: 'SubmissionDocument')
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid reindexing the full Elasticsearch document. Consider reindexing only specific resource ids.
+    RUBY
+  end
+
+  it 'does not register an offense when reindexing only a specific resource ID' do
+    expect_no_offenses(<<~RUBY)
+      ValisReindexWorker.new.perform([submission.id], Submission.to_s)
+    RUBY
+  end
+end