wire up reindexing job logging

* add backwards compatible log updating to ReindexJob
* use new logging functionality in Exhibit#reindex_later with optional user, update ResourceController#reindex_all to pass user into @exhibit.reindex_later
* tests
  * rubocop RSpec/SubjectStub exception for reindex_job_spec.rb

.rubocop_todo.yml

@@ -66,6 +66,7 @@ RSpec/NotToNot:
 # Offense count: 42
 RSpec/SubjectStub:
   Exclude:
+    - 'spec/jobs/spotlight/reindex_job_spec.rb'
     - 'spec/lib/spotlight/controller_spec.rb'
     - 'spec/models/solr_document_spec.rb'
     - 'spec/models/spotlight/access_controls_enforcement_search_builder_spec.rb'

app/controllers/spotlight/resources_controller.rb

@@ -35,7 +35,7 @@ def monitor
     end
 
     def reindex_all
-      @exhibit.reindex_later
+      @exhibit.reindex_later current_user
 
       redirect_to admin_exhibit_catalog_path(@exhibit), notice: t(:'spotlight.resources.reindexing_in_progress')
     end

app/jobs/spotlight/reindex_job.rb

@@ -8,7 +8,20 @@ class ReindexJob < ActiveJob::Base
       resource_list(job.arguments.first).each(&:waiting!)
     end
 
-    def perform(exhibit_or_resources)
+    around_perform do |job, block|
+      log_entry(job).reindexing_started! if log_entry(job)
+
+      begin
+        block.call
+      rescue
+        log_entry(job).reindexing_failed! if log_entry(job)
+        raise
+      end
+
+      log_entry(job).reindexing_succeeded! if log_entry(job)
+    end
+
+    def perform(exhibit_or_resources, _log_entry = nil)
       resource_list(exhibit_or_resources).each(&:reindex)
     end
 
@@ -23,5 +36,9 @@ def resource_list(exhibit_or_resources)
         Array(exhibit_or_resources)
       end
     end
+
+    def log_entry(job)
+      job.arguments.second if job.arguments.second.is_a?(Spotlight::ReindexingLogEntry)
+    end
   end
 end

app/models/spotlight/exhibit.rb

@@ -80,8 +80,8 @@ def solr_data
       end
     end
 
-    def reindex_later
-      Spotlight::ReindexJob.perform_later(self)
+    def reindex_later(user = nil)
+      Spotlight::ReindexJob.perform_later(self, new_reindexing_log_entry(user))
     end
 
     def uploaded_resource_fields
@@ -109,5 +109,9 @@ def reindex_progress
     def sanitize_description
       self.description = ::Rails::Html::FullSanitizer.new.sanitize(description)
     end
+
+    def new_reindexing_log_entry(user = nil)
+      Spotlight::ReindexingLogEntry.create(exhibit: self, user: user, items_reindexed_count: resources.size)
+    end
   end
 end

spec/jobs/spotlight/reindex_job_spec.rb

@@ -2,6 +2,8 @@
 describe Spotlight::ReindexJob do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
   let(:resource) { FactoryGirl.create(:resource) }
+  let(:user) { FactoryGirl.create(:user) }
+  let(:log_entry) { Spotlight::ReindexingLogEntry.create(exhibit: exhibit, user: user) }
 
   before do
     allow_any_instance_of(Spotlight::Resource).to receive(:reindex)
@@ -14,6 +16,7 @@
       exhibit.resources << resource
       exhibit.save
     end
+
     it 'attempts to reindex every resource in the exhibit' do
       # ActiveJob will reload the collection, so we go through a little trouble:
       expect_any_instance_of(Spotlight::Resource).to receive(:reindex) do |thingy|
@@ -22,6 +25,28 @@
 
       subject.perform_now
     end
+
+    context 'with a log_entry' do
+      subject { described_class.new(exhibit, log_entry) }
+
+      it 'marks the log entry as started' do
+        expect(log_entry).to receive(:reindexing_started!)
+        subject.perform_now
+      end
+
+      it 'marks the log entry as successful if there is no error' do
+        expect(log_entry).to receive(:reindexing_succeeded!)
+        subject.perform_now
+      end
+
+      it 'marks the log entry as failed if there is an error' do
+        unexpected_error = StandardError.new
+        # it'd be more realistic to raise on resource#reindex, but that's already stubbed above, so this'll have to do
+        expect(subject).to receive(:perform).with(exhibit, log_entry).and_raise unexpected_error
+        expect(log_entry).to receive(:reindexing_failed!)
+        expect { subject.perform_now }.to raise_error unexpected_error
+      end
+    end
   end
 
   context 'with a resource' do

spec/models/spotlight/exhibit_spec.rb

@@ -190,10 +190,28 @@
 
   describe '#reindex_later' do
     subject { FactoryGirl.create(:exhibit) }
+    let(:log_entry) { Spotlight::ReindexingLogEntry.new(exhibit: subject, user: user, items_reindexed_count: subject.resources.size) }
 
-    it 'queues a reindex job for the exhibit' do
-      expect(Spotlight::ReindexJob).to receive(:perform_later).with(subject)
-      subject.reindex_later
+    context 'user is omitted' do
+      let(:user) { nil }
+
+      it 'queues a reindex job for the exhibit, with nil user for the log entry' do
+        expect(subject).to receive(:new_reindexing_log_entry).with(nil).and_return(log_entry)
+        expect(Spotlight::ReindexJob).to receive(:perform_later).with(subject, log_entry)
+        subject.reindex_later
+        expect(log_entry.user).to be nil
+      end
+    end
+
+    context 'non-nil user is provided' do
+      let(:user) { FactoryGirl.build(:user) }
+
+      it 'queues a reindex job for the exhibit, with actual user for the log entry' do
+        expect(subject).to receive(:new_reindexing_log_entry).with(user).and_return(log_entry)
+        expect(Spotlight::ReindexJob).to receive(:perform_later).with(subject, log_entry)
+        subject.reindex_later user
+        expect(log_entry.user).to eq user
+      end
     end
   end