blacklight-spotlight 0.31.0 → 0.32.0

data/spec/factories/reindexing_log_entries.rb

@@ -0,0 +1,52 @@
+FactoryGirl.define do
+  factory :unstarted_reindexing_log_entry, class: Spotlight::ReindexingLogEntry do
+    items_reindexed_count 15
+    job_status 'unstarted'
+    exhibit
+    user
+  end
+
+  factory :reindexing_log_entry, class: Spotlight::ReindexingLogEntry do
+    items_reindexed_count 10
+    start_time { Time.zone.parse('2017-01-05 23:00:00') }
+    end_time { Time.zone.parse('2017-01-05 23:05:00') }
+    job_status 'succeeded'
+    exhibit
+    user
+  end
+
+  factory :reindexing_log_entry_no_user, class: Spotlight::ReindexingLogEntry do
+    items_reindexed_count 10
+    start_time { Time.zone.parse('2017-01-05 23:00:00') }
+    end_time { Time.zone.parse('2017-01-05 23:05:00') }
+    job_status 'succeeded'
+    exhibit
+  end
+
+  factory :in_progress_reindexing_log_entry, class: Spotlight::ReindexingLogEntry do
+    items_reindexed_count 100
+    start_time { Time.zone.now - 300 }
+    end_time nil
+    job_status 'in_progress'
+    exhibit
+    user
+  end
+
+  factory :recent_reindexing_log_entry, class: Spotlight::ReindexingLogEntry do
+    sequence(:items_reindexed_count)
+    start_time { Time.zone.now - 86_400 }
+    end_time { Time.zone.now - 86_100 }
+    job_status 'succeeded'
+    exhibit
+    user
+  end
+
+  factory :failed_reindexing_log_entry, class: Spotlight::ReindexingLogEntry do
+    items_reindexed_count 10
+    start_time { Time.zone.parse('2017-01-10 23:00:00') }
+    end_time { Time.zone.parse('2017-01-10 23:05:00') }
+    job_status 'failed'
+    exhibit
+    user
+  end
+end

data/spec/features/javascript/reindex_monitor_spec.rb

@@ -6,7 +6,7 @@ feature 'Reindex Monitor', js: true do
   let(:exhibit_curator) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
 
   before do
-    resources.each(&:waiting!)
+    FactoryGirl.create(:in_progress_reindexing_log_entry, exhibit: exhibit, items_reindexed_estimate: 5)
     login_as exhibit_curator
     visit spotlight.admin_exhibit_catalog_path(exhibit)
   end
@@ -14,8 +14,8 @@ feature 'Reindex Monitor', js: true do
   it 'is rendered on the item admin page' do
     expect(page).to have_css('.panel.index-status', visible: true)
     within('.panel.index-status') do
-      expect(page).to have_css('p', text: /Began reindexing a total of \d items/)
-      expect(page).to have_css('p', text: /Reindexed \d of \d items/)
+      expect(page).to have_css('p', text: /Began reindexing a total of \d+ items/)
+      expect(page).to have_css('p', text: /Reindexed \d+ of \d+ items/)
     end
   end
 end

data/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 @@ describe Spotlight::ReindexJob do
       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,40 @@ describe Spotlight::ReindexJob do
 
       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(:in_progress!)
+        subject.perform_now
+      end
+
+      it 'marks the log entry as successful if there is no error' do
+        expect(log_entry).to receive(: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(:failed!)
+        expect { subject.perform_now }.to raise_error unexpected_error
+      end
+
+      it 'updates the items_reindexed_estimate field on the log entry' do
+        expect(log_entry).to receive(:update).with(items_reindexed_estimate: 1)
+        subject.perform_now
+      end
+
+      it 'passes log_entry to the resource.reindex call' do
+        # ActiveJob will reload the collection, so we go through a little trouble:
+        expect_any_instance_of(Spotlight::Resource).to receive(:reindex).with(log_entry).exactly(:once)
+        # expect(resource).to receive(:reindex).with(log_entry)
+        subject.perform_now
+      end
+    end
   end
 
   context 'with a resource' do

data/spec/models/spotlight/exhibit_spec.rb

@@ -190,10 +190,47 @@ describe Spotlight::Exhibit, type: :model do
 
   describe '#reindex_later' do
     subject { FactoryGirl.create(:exhibit) }
+    let(:log_entry) { Spotlight::ReindexingLogEntry.new(exhibit: subject, user: user, items_reindexed_count: 0) }
 
-    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
+
+  describe '#new_reindexing_log_entry' do
+    let(:user) { FactoryGirl.build(:user) }
+    it 'returns a properly configured Spotlight::ReindexingLogEntry instance' do
+      reindexing_log_entry = subject.send(:new_reindexing_log_entry, user)
+      expect(reindexing_log_entry.exhibit).to eq subject
+      expect(reindexing_log_entry.user).to eq user
+      expect(reindexing_log_entry.items_reindexed_count).to eq 0
+      expect(reindexing_log_entry.unstarted?).to be true
+    end
+
+    it 'does not require user the user parameter' do
+      reindexing_log_entry = subject.send(:new_reindexing_log_entry)
+      expect(reindexing_log_entry.exhibit).to eq subject
+      expect(reindexing_log_entry.user).to be nil
+      expect(reindexing_log_entry.items_reindexed_count).to eq 0
+      expect(reindexing_log_entry.unstarted?).to be true
     end
   end
 
@@ -266,7 +303,9 @@ describe Spotlight::Exhibit, type: :model do
 
   describe '#reindex_progress' do
     it 'returns a Spotlight::ReindexProgress' do
-      expect(subject.reindex_progress).to be_a Spotlight::ReindexProgress
+      reindex_progress = subject.reindex_progress
+      expect(reindex_progress).to be_a Spotlight::ReindexProgress
+      expect(reindex_progress.exhibit).to eq subject
     end
   end
 end

data/spec/models/spotlight/reindex_progress_spec.rb

@@ -1,139 +1,171 @@
 describe Spotlight::ReindexProgress, type: :model do
-  let(:start_time) { 20.minutes.ago.at_beginning_of_minute }
-  let(:finish_time) { 5.minutes.ago.at_beginning_of_minute }
-  let(:updated_time) { 1.minute.ago.at_beginning_of_minute }
-  let!(:first_resource) do
-    FactoryGirl.create(
-      :resource,
-      updated_at: updated_time,
-      indexed_at: start_time,
-      enqueued_at: start_time,
-      last_indexed_finished: start_time,
-      last_indexed_estimate: 7,
-      last_indexed_count: 5,
-      index_status: 1
-    )
-  end
-  let!(:last_resource) do
-    FactoryGirl.create(
-      :resource,
-      updated_at: finish_time,
-      indexed_at: finish_time,
-      enqueued_at: start_time,
-      last_indexed_finished: finish_time,
-      last_indexed_estimate: 3,
-      last_indexed_count: 2,
-      index_status: 1
-    )
+  let(:reindexing_log_entries) do
+    [
+      # failed is the later of the two, and thus the return value for current_log_entry
+      FactoryGirl.create(:reindexing_log_entry, items_reindexed_estimate: 11),
+      FactoryGirl.create(:failed_reindexing_log_entry, items_reindexed_estimate: 12)
+    ]
   end
+  let(:exhibit) { FactoryGirl.create(:exhibit, reindexing_log_entries: reindexing_log_entries) }
 
-  let(:new_resource) do
-    FactoryGirl.create(
-      :resource,
-      last_indexed_count: 10,
-      last_indexed_estimate: 15,
-      index_status: 0
-    )
-  end
+  let(:subject) { described_class.new(exhibit) }
 
-  let(:resources) { [first_resource, last_resource, new_resource] }
-  subject { described_class.new(Spotlight::Resource.all) }
-  let(:json) { JSON.parse(subject.to_json) }
+  describe '#started_at' do
+    it 'returns start_time for current_log_entry' do
+      expect(subject.started_at).to eq(Time.zone.parse('2017-01-10 23:00:00'))
+    end
+  end
 
-  before do
-    allow(subject).to receive_messages(completed_resources: resources)
+  describe '#updated_at' do
+    # disable SkipsModelValidations cop for this test, because it complains about #touch, which is convenient here
+    # rubocop:disable Rails/SkipsModelValidations
+    it 'returns the time of last update for current_log_entry' do
+      lower_bound = Time.zone.now
+      subject.send(:current_log_entry).touch
+      upper_bound = Time.zone.now
+
+      expect(subject.updated_at).to be_between(lower_bound, upper_bound)
+    end
+    # rubocop:enable Rails/SkipsModelValidations
   end
 
-  describe '#recently_in_progress?' do
-    let(:resources) { [first_resource, last_resource] }
-    context 'when the last resource has been updated within the allotted time' do
-      it 'is true' do
-        expect(subject).to be_recently_in_progress
-      end
+  describe '#finished?' do
+    it 'returns true if current_log_entry is succeeded or failed' do
+      expect(subject.finished?).to be true
     end
+  end
 
-    context 'when any of the resources is marked as waiting' do
-      before do
-        first_resource.waiting!
-      end
-      it 'is true' do
-        expect(subject).to be_recently_in_progress
-      end
+  describe '#finished_at' do
+    it 'returns end_time for current_log_entry' do
+      expect(subject.finished_at).to eq(Time.zone.parse('2017-01-10 23:05:00'))
     end
+  end
 
-    context 'when the last resources has been updated outside of the allotted time ' do
-      before do
-        expect(last_resource).to receive_messages(last_indexed_finished: 12.minutes.ago)
-      end
-      it 'is false' do
-        expect(subject).not_to be_recently_in_progress
-      end
+  describe '#total' do
+    it 'returns items_reindexed_estimate for current_log_entry' do
+      expect(subject.total).to be 12
     end
+  end
 
-    it 'is included in the json' do
-      expect(json['recently_in_progress']).to be true
+  describe '#completed' do
+    it 'returns items_reindexed_count for current_log_entry' do
+      expect(subject.completed).to be 10
     end
   end
 
-  describe '#started_at' do
-    it 'returns the indexed_at attribute of the first resource' do
-      expect(subject.started_at).to eq start_time
+  describe '#errored?' do
+    it 'returns true for log entries marked as failed' do
+      expect(subject.errored?).to be true
     end
+  end
 
-    it 'is included in the json as a localized string' do
-      expect(json['started_at']).to eq I18n.l(start_time, format: :short)
+  describe '#as_json' do
+    it 'returns a hash with values for current_log_entry via the various helper methods' do
+      expect(subject.as_json).to eq(
+        recently_in_progress: subject.recently_in_progress?,
+        started_at: subject.send(:localized_start_time),
+        finished_at: subject.send(:localized_finish_time),
+        updated_at: subject.send(:localized_updated_time),
+        total: subject.total,
+        completed: subject.completed,
+        errored: subject.errored?
+      )
     end
+  end
 
-    context 'with unqueued resources' do
-      subject { described_class.new(Spotlight::Resource.where(id: new_resource.id)) }
+  describe '#recently_in_progress?' do
+    context 'there is no end_time for current_log_entry' do
+      let(:current_log_entry) { FactoryGirl.create(:in_progress_reindexing_log_entry) }
+      let(:exhibit) { FactoryGirl.create(:exhibit, reindexing_log_entries: [current_log_entry]) }
 
-      it 'returns the indexed_at attribute of the first resource' do
-        expect(subject.started_at).to be_nil
+      it 'returns true' do
+        expect(subject.recently_in_progress?).to be true
       end
     end
-  end
 
-  describe '#updated_at' do
-    let(:resources) { [first_resource, last_resource] }
+    context 'current_log_entry has an end_time less than Spotlight::Engine.config.reindex_progress_window.minutes.ago' do
+      let(:current_log_entry) { FactoryGirl.create(:recent_reindexing_log_entry, end_time: Time.zone.now) }
+      let(:exhibit) { FactoryGirl.create(:exhibit, reindexing_log_entries: [current_log_entry]) }
 
-    it 'returns the updated_at attribute of the last resource' do
-      expect(subject.updated_at).to eq updated_time
+      it 'returns true' do
+        expect(subject.recently_in_progress?).to be true
+      end
     end
 
-    it 'is included in the json as a localized string under the updated_at attribute' do
-      expect(json['updated_at']).to eq I18n.l(updated_time, format: :short)
+    context 'current_log_entry is unstarted ' do
+      let(:current_log_entry) { FactoryGirl.create(:unstarted_reindexing_log_entry) }
+      let(:exhibit) { FactoryGirl.create(:exhibit, reindexing_log_entries: [current_log_entry]) }
+
+      it 'returns false' do
+        expect(subject.recently_in_progress?).to be false
+      end
     end
   end
 
-  describe '#finished_at' do
-    let(:resources) { [first_resource, last_resource] }
+  describe 'private methods' do
+    describe '#current_log_entry' do
+      let(:reindexing_log_entries) do
+        [
+          FactoryGirl.create(:unstarted_reindexing_log_entry),
+          FactoryGirl.create(:reindexing_log_entry),
+          FactoryGirl.create(:in_progress_reindexing_log_entry),
+          FactoryGirl.create(:failed_reindexing_log_entry),
+          FactoryGirl.create(:unstarted_reindexing_log_entry)
+        ]
+      end
 
-    it 'returns the updated_at attribute of the last resource' do
-      expect(subject.finished_at).to eq finish_time
+      it 'returns the latest log entry that is not unstarted' do
+        expect(subject.send(:current_log_entry)).to eq(reindexing_log_entries[2])
+      end
     end
 
-    it 'is included in the json as a localized string under the updated_at attribute' do
-      expect(json['finished_at']).to eq I18n.l(finish_time, format: :short)
+    describe '#localized_start_time' do
+      it 'returns the short formatted start time' do
+        expect(subject.send(:localized_start_time)).to eq I18n.l(subject.started_at, format: :short)
+      end
     end
-  end
 
-  describe '#total' do
-    it 'sums the resources last_indexed_estimate' do
-      expect(subject.total).to eq 25
+    describe '#localized_finish_time' do
+      it 'returns the short formatted end time' do
+        expect(subject.send(:localized_finish_time)).to eq I18n.l(subject.finished_at, format: :short)
+      end
     end
 
-    it 'is included in the json' do
-      expect(json['total']).to eq 25
+    describe '#localized_updated_time' do
+      it 'returns the short formatted last updated time' do
+        expect(subject.send(:localized_updated_time)).to eq I18n.l(subject.updated_at, format: :short)
+      end
     end
   end
 
-  describe '#completed' do
-    it 'sums the resources last_indexed_count' do
-      expect(subject.completed).to eq 17
-    end
-
-    it 'is included in the json' do
-      expect(json['completed']).to eq 17
+  context 'current_log_entry is nil' do
+    let(:reindexing_log_entries) { [] }
+
+    # rubocop:disable RSpec/MultipleExpectations
+    it 'methods return gracefully' do
+      expect(subject.send(:current_log_entry)).to be nil
+
+      expect(subject.recently_in_progress?).to be false
+      expect(subject.started_at).to be nil
+      expect(subject.updated_at).to be nil
+      expect(subject.finished?).to be false
+      expect(subject.finished_at).to be nil
+      expect(subject.total).to be nil
+      expect(subject.completed).to be nil
+      expect(subject.errored?).to be false
+      expect(subject.send(:localized_start_time)).to be nil
+      expect(subject.send(:localized_finish_time)).to be nil
+      expect(subject.send(:localized_updated_time)).to be nil
+      expect(subject.as_json).to eq(
+        recently_in_progress: false,
+        started_at: nil,
+        finished_at: nil,
+        updated_at: nil,
+        total: nil,
+        completed: nil,
+        errored: false
+      )
     end
+    # rubocop:enable RSpec/MultipleExpectations
   end
 end