blacklight-spotlight 3.0.0.rc4 → 3.0.0.rc5

data/spec/jobs/spotlight/change_visibility_job_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+describe Spotlight::ChangeVisibilityJob do
+  subject { described_class.new(solr_params: solr_params, exhibit: exhibit, visibility: visibility) }
+
+  let(:solr_params) { { q: 'map' } }
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:visibility) { 'private' }
+
+  before do
+    allow(Spotlight::Engine.config).to receive_messages(bulk_actions_batch_size: 5)
+  end
+
+  it 'sets the items based off of the visibility' do
+    subject.perform_now
+    response = exhibit.blacklight_config.repository.search(solr_params.merge('rows' => 999_999_999))
+    expect(response.total).to eq 55
+    expect(Spotlight::JobTracker.last).to have_attributes(
+      status: 'completed',
+      total: 55,
+      progress: 55,
+      job_class: 'Spotlight::ChangeVisibilityJob'
+    )
+    response.documents.each do |document|
+      expect(document.private?(exhibit)).to be true
+      document.make_public!(exhibit)
+      document.reindex
+    end
+  end
+end

data/spec/jobs/spotlight/process_bulk_updates_csv_job_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+def tag_names(exhibit, id)
+  exhibit.blacklight_config.repository.find(id).documents.first.sidecar(exhibit).taggings.includes(:tag).map { |tagging| tagging&.tag&.name }
+end
+
+describe Spotlight::ProcessBulkUpdatesCsvJob do
+  subject { described_class.new(exhibit, bulk_update) }
+
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+
+  describe 'visibility' do
+    let(:bulk_update) { FactoryBot.create(:bulk_update, exhibit: exhibit) }
+
+    it 'is updated' do
+      allow(SolrDocument.index.connection).to receive(:update).and_call_original
+      expect(exhibit.blacklight_config.repository.find('dq287tq6352').documents.first).not_to be_private(exhibit)
+
+      subject.perform_now
+
+      expect(exhibit.blacklight_config.repository.find('dq287tq6352').documents.first).to be_private(exhibit)
+      expect(SolrDocument.index.connection).to have_received(:update)
+    end
+
+    context 'with a row that does not change visibility' do
+      before do
+        sidecar = exhibit.solr_document_sidecars.find_or_create_by(document_type: 'SolrDocument', document_id: 'dq287tq6352')
+        sidecar.private!
+      end
+
+      it 'does not update solr' do
+        allow(SolrDocument.index.connection).to receive(:update)
+
+        subject.perform_now
+
+        expect(SolrDocument.index.connection).not_to have_received(:update)
+      end
+    end
+  end
+
+  describe 'tags' do
+    let(:bulk_update) { FactoryBot.create(:tagged_bulk_update, exhibit: exhibit) }
+
+    before do
+      document = exhibit.blacklight_config.repository.find('cz507zk0531').documents.first
+      exhibit.tag(document.sidecar(exhibit), with: 'CSV Tag1', on: :tags)
+    end
+
+    it 'are added/removed' do
+      allow(SolrDocument.index.connection).to receive(:update).and_call_original
+      expect(tag_names(exhibit, 'bm387cy2596')).to be_empty
+      expect(tag_names(exhibit, 'cz507zk0531')).to eq(['CSV Tag1'])
+      expect(tag_names(exhibit, 'dq287tq6352')).to be_empty
+      subject.perform_now
+      expect(tag_names(exhibit, 'bm387cy2596')).to eq(['CSV Tag1', 'CSV Tag2'])
+      expect(tag_names(exhibit, 'cz507zk0531')).to eq(['CSV Tag2'])
+      expect(tag_names(exhibit, 'dq287tq6352')).to eq(['CSV Tag1', 'CSV Tag2'])
+
+      # 3 updates plus the final commit
+      expect(SolrDocument.index.connection).to have_received(:update).exactly(4).times
+    end
+
+    context 'with a row that does not change visibility' do
+      before do
+        # set up the documents to match what's the in the spreadsheet already
+        subject.perform_now
+      end
+
+      it 'does not update solr' do
+        allow(SolrDocument.index.connection).to receive(:update)
+
+        subject.perform_now
+
+        expect(SolrDocument.index.connection).not_to have_received(:update)
+      end
+    end
+  end
+end

data/spec/jobs/spotlight/reindex_job_spec.rb

@@ -8,7 +8,6 @@ describe Spotlight::ReindexJob do
   let(:user) { FactoryBot.create(:user) }
 
   before do
-    ActiveJob::Base.queue_adapter = :test
     allow_any_instance_of(Spotlight::Resource).to receive(:reindex)
   end
 
@@ -19,6 +18,10 @@ describe Spotlight::ReindexJob do
       expect(resource).to receive(:reindex)
       subject.perform_now
     end
+
+    it 'adds some job tracking events' do
+      expect { subject.perform_now }.to change(Spotlight::Event, :count).by(1)
+    end
   end
 
   describe 'validity' do

data/spec/jobs/spotlight/remove_tags_job_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+describe Spotlight::RemoveTagsJob do
+  subject { described_class.new(solr_params: solr_params, exhibit: exhibit, tags: tags) }
+
+  let(:solr_params) { { q: 'map' } }
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:tags) { %w[hello world] }
+
+  before do
+    allow(Spotlight::Engine.config).to receive_messages(bulk_actions_batch_size: 5)
+  end
+
+  it 'removes tags from SolrDocumentSidecar objects' do
+    response = exhibit.blacklight_config.repository.search(solr_params.merge('rows' => 999_999_999))
+    expect(response.total).to eq 55
+    response.documents.each do |document|
+      exhibit.tag(document.sidecar(exhibit), with: %w[hello world], on: :tags)
+      document.reindex
+    end
+    subject.perform_now
+    response = exhibit.blacklight_config.repository.search(solr_params.merge('rows' => 999_999_999))
+    expect(response.total).to eq 55
+    expect(Spotlight::JobTracker.last).to have_attributes(
+      status: 'completed',
+      total: 55,
+      progress: 55,
+      job_class: 'Spotlight::RemoveTagsJob'
+    )
+    response.documents.each do |document|
+      expect(document.sidecar(exhibit).all_tags_list).to eq []
+    end
+    exhibit.owned_tags.destroy_all
+    response.documents.each do |document|
+      document.sidecar(exhibit).destroy
+      document.reindex
+    end
+  end
+end

data/spec/lib/migration/iiif_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe Migration::IIIF do
     context "when it's any FeaturedImage" do
       it 'updates the iiif_tilesource attribute based on the given host and image resource' do
         instance.run
-        expect(updated_thumb.iiif_tilesource).to eq "http://test.host/images/#{updated_thumb.id}/info.json"
+        expect(updated_thumb.iiif_tilesource).to match %r{http://test.host/images/#{updated_thumb.id}-.*/info.json}
       end
 
       it 'returns a nil region if one was not set' do

data/spec/models/spotlight/ability_spec.rb

@@ -80,6 +80,7 @@ describe Spotlight::Ability, type: :model do
     it { is_expected.to be_able_to(:destroy, translation) }
 
     it { is_expected.to be_able_to(:tag, exhibit) }
+    it { is_expected.to be_able_to(:bulk_update, exhibit) }
 
     it { is_expected.to be_able_to(:edit, contact) }
     it { is_expected.to be_able_to(:new, contact) }
@@ -88,4 +89,30 @@ describe Spotlight::Ability, type: :model do
     it { is_expected.not_to be_able_to(:manage, language) }
     it { is_expected.to be_able_to(:read, language) }
   end
+
+  context 'with an unpublished exhibit' do
+    before do
+      exhibit.update(published: false)
+    end
+
+    context 'with a user with a viewer role' do
+      let(:user) { FactoryBot.create(:user, :with_exhibit_role, role: 'viewer', exhibit: exhibit) }
+
+      it { is_expected.not_to be_able_to(:create, exhibit) }
+      it { is_expected.to be_able_to(:read, exhibit) }
+      it { is_expected.to be_able_to(:read, page) }
+      it { is_expected.not_to be_able_to(:create, Spotlight::Page.new(exhibit: exhibit)) }
+      it { is_expected.to be_able_to(:read, search) }
+      it { is_expected.to be_able_to(:read, public_language) }
+      it { is_expected.not_to be_able_to(:read, language) }
+      it { is_expected.not_to be_able_to(:read, unpublished_search) }
+      it { is_expected.not_to be_able_to(:tag, exhibit) }
+    end
+
+    context 'with an anonymous user' do
+      let(:user) { FactoryBot.create(:exhibit_visitor) }
+
+      it { is_expected.not_to be_able_to(:read, exhibit) }
+    end
+  end
 end

data/spec/models/spotlight/{reindex_progress_spec.rb → background_job_progress_spec.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-describe Spotlight::ReindexProgress, type: :model do
-  subject(:progress) { described_class.new(exhibit) }
+describe Spotlight::BackgroundJobProgress, type: :model do
+  subject(:progress) { described_class.new(exhibit, job_class: Spotlight::ReindexExhibitJob) }
 
   let(:exhibit) { FactoryBot.create(:exhibit) }
   let!(:job_tracker) do
@@ -44,6 +44,19 @@ describe Spotlight::ReindexProgress, type: :model do
   end
 
   context 'with an in-progress job' do
+    let(:job_tracker_args) { { status: 'in_progress', data: { progress: 32, total: 50 } } }
+
+    it 'reports on reindexing progress' do
+      expect(progress.as_json).to include(
+        completed: 32,
+        total: 50,
+        finished: false,
+        errored: false
+      )
+    end
+  end
+
+  context 'with an in-progress job with subtasks' do
     before do
       FactoryBot.create(:job_tracker, on: job_tracker, resource: exhibit, data: { progress: 32, total: 32 }, status: 'completed')
       FactoryBot.create(:job_tracker, on: job_tracker, resource: exhibit, data: { progress: 16, total: 50 }, status: 'in_progress')

data/spec/models/spotlight/blacklight_configuration_spec.rb

@@ -449,11 +449,16 @@ describe Spotlight::BlacklightConfiguration, type: :model do
 
       expect(subject.blacklight_config.per_page).to eq [10, 50]
     end
+  end
 
-    it 'prepends the default per page' do
-      blacklight_config.per_page = [1, 10, 50, 100]
+  describe '#default_per_page' do
+    it 'is the first per page option by default' do
+      expect(subject.blacklight_config.default_per_page).to eq 10
+    end
+
+    it "is set from the model's default_per_page" do
       subject.default_per_page = 50
-      expect(subject.blacklight_config.per_page.first).to eq 50
+      expect(subject.blacklight_config.default_per_page).to eq 50
     end
   end
 

data/spec/models/spotlight/exhibit_spec.rb

@@ -329,7 +329,7 @@ describe Spotlight::Exhibit, type: :model do
   describe '#reindex_progress' do
     it 'returns the latest log entry that is not unstarted' do
       reindex_progress = subject.reindex_progress
-      expect(reindex_progress).to be_a Spotlight::ReindexProgress
+      expect(reindex_progress).to be_a Spotlight::BackgroundJobProgress
     end
   end
 

data/spec/models/spotlight/featured_image_spec.rb

@@ -41,7 +41,7 @@ describe Spotlight::FeaturedImage do
         end
 
         it 'points at the RIIIF endpoint' do
-          expect(subject.iiif_url).to match(%r{^/images/\d+/})
+          expect(subject.iiif_url).to match(%r{^/images/\d+-.+/})
         end
       end
     end

data/spec/models/spotlight/resource_spec.rb

@@ -22,6 +22,12 @@ describe Spotlight::Resource, type: :model do
       subject.save_and_index
     end
 
+    it 'passes through reindexing options' do
+      expect(subject).to receive(:save).and_return(true)
+      expect(subject).to receive(:reindex_later).with(a: 1)
+      subject.save_and_index(reindex_options: { a: 1 })
+    end
+
     context 'if the save fails' do
       it 'does not reindex' do
         expect(subject).to receive(:save).and_return(false)
@@ -31,6 +37,23 @@ describe Spotlight::Resource, type: :model do
     end
   end
 
+  describe '#reindex_later' do
+    around do |block|
+      old = ActiveJob::Base.queue_adapter
+      begin
+        ActiveJob::Base.queue_adapter = :test
+
+        block.call
+      ensure
+        ActiveJob::Base.queue_adapter = old
+      end
+    end
+
+    it 'passes through reindexing options' do
+      expect { subject.reindex_later(whatever: true) }.to have_enqueued_job(Spotlight::ReindexJob).with(subject, whatever: true, 'validity_token' => nil)
+    end
+  end
+
   describe '#reindex' do
     before do
       # sneak some data into the pipeline

data/spec/models/spotlight/solr_document/atomic_updates_spec.rb

@@ -37,6 +37,16 @@ describe Spotlight::SolrDocument::AtomicUpdates, type: :model do
       subject.reindex
     end
 
+    it 'update parameters can be specified to modify commitWithin' do
+      expected = {
+        params: { commitWithin: 5001 },
+        data: [{ id: 'doc_id', a: { set: 1 }, b: { set: 2 }, timestamp: { set: nil } }].to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      }
+      expect(blacklight_solr).to receive(:update).with(expected)
+      subject.reindex(update_params: { commitWithin: 5001 })
+    end
+
     it 'cowardlies refuse to index a document if the only value is an id' do
       allow(subject).to receive_messages(to_solr: { id: 'doc_id' }, timestamp: { set: nil })
       expect(blacklight_solr).not_to receive(:update)

data/spec/services/spotlight/bulk_updates_csv_template_service_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spotlight::BulkUpdatesCsvTemplateService do
+  subject(:service) { described_class.new(exhibit: exhibit) }
+
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let!(:tag1) { FactoryBot.create(:tagging, tagger: exhibit, taggable: exhibit) }
+  let!(:tag2) { FactoryBot.create(:tagging, tagger: exhibit, taggable: exhibit) }
+
+  describe '#template' do
+    let(:view_context) { double('ViewContext', document_presenter: double('DocumentPresenter', heading: 'Document Title')) }
+
+    it 'has a row for every document (+ the header)' do
+      template = CSV.parse(service.template(view_context: view_context).to_a.join)
+      expect(template).to have_at_least(56).items
+      expect(template[0].join(',')).to match(/Item ID,Item Title,Visibility,Tag: tagging\d,Tag: tagging\d/)
+    end
+
+    it 'only has requested columns' do
+      template = CSV.parse(service.template(view_context: view_context, tags: false).to_a.join)
+      expect(template[0].join(',')).to eq 'Item ID,Item Title,Visibility'
+    end
+  end
+end

data/spec/test_app_templates/Gemfile.extra

@@ -1 +1,2 @@
 gem 'sprockets', '< 4' if ENV['RAILS_VERSION'] && ENV['RAILS_VERSION'] < '6'
+gem 'view_component', '!= 2.26.0'

data/spec/uploaders/spotlight/featured_image_uploader_spec.rb

@@ -5,9 +5,9 @@ describe Spotlight::FeaturedImageUploader do
 
   let(:mounter) { FactoryBot.create(:featured_image) }
 
-  describe '#extension_whitelist' do
+  describe '#extension_allowlist' do
     it 'is the configured array of approved extension to be uploaded' do
-      expect(featured_image_uploader.extension_whitelist).to eq Spotlight::Engine.config.allowed_upload_extensions
+      expect(featured_image_uploader.extension_allowlist).to eq Spotlight::Engine.config.allowed_upload_extensions
     end
   end
 

data/spec/views/spotlight/catalog/_edit_default.html.erb_spec.rb

@@ -25,7 +25,7 @@ describe 'spotlight/catalog/_edit_default.html.erb', type: :view do
   it 'has a edit tag form' do
     render
     expect(rendered).to have_field 'solr_document_exhibit_tag_list'
-    expect(rendered).to have_selector '#solr_document_exhibit_tag_list[@data-autocomplete_url="autocomplete-path.json"]'
+    expect(rendered).to have_selector '#solr_document_exhibit_tag_list[@data-autocomplete-url="autocomplete-path.json"]'
   end
 
   it 'does not have special metadata editing fields for non-uploaded resources' do

data/spec/views/spotlight/dashboards/_reindexing_activity.html.erb_spec.rb

@@ -2,9 +2,11 @@
 
 describe 'spotlight/dashboards/_reindexing_activity.html.erb', type: :view do
   let(:p) { 'spotlight/dashboards/reindexing_activity' }
+  let(:exhibit) { FactoryBot.build(:exhibit) }
 
   before do
     assign(:recent_reindexing, recent_reindexing)
+    allow(view).to receive(:current_exhibit).and_return(exhibit)
   end
 
   context 'the reindexing log is empty' do

data/spec/views/spotlight/job_trackers/show.html.erb_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+describe 'spotlight/job_trackers/show', type: :view do
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:job_tracker) { FactoryBot.create(:job_tracker, job_class: 'Spotlight::ReindexExhibitJob', on: exhibit, user: user) }
+  let(:user) { FactoryBot.create(:user) }
+
+  before do
+    assign(:exhibit, exhibit)
+    assign(:job_tracker, job_tracker)
+
+    allow(view).to receive_messages(current_exhibit: exhibit)
+  end
+
+  it 'displays the type of job' do
+    render
+    expect(rendered).to have_selector 'h2', text: 'Spotlight::ReindexExhibitJob'
+  end
+
+  it 'displays the job status for enqueued jobs' do
+    job_tracker.update(status: 'enqueued')
+    render
+    expect(rendered).to have_content '⏱'
+  end
+
+  it 'displays the job status for failed jobs' do
+    job_tracker.update(status: 'failed')
+    render
+    expect(rendered).to have_content '🟥'
+    expect(rendered).to have_content 'job failed'
+  end
+
+  it 'displays the job status for successful jobs' do
+    job_tracker.update(status: 'completed')
+    render
+    expect(rendered).to have_content '✅'
+    expect(rendered).to have_content 'job completed'
+  end
+
+  it 'display job started events' do
+    render
+    expect(rendered).to have_selector 'tr', text: '1 job started', normalize_ws: true
+  end
+
+  it 'records who started the job' do
+    render
+    expect(rendered).to have_selector 'tr', text: "2 job created by #{user.email}", normalize_ws: true
+  end
+
+  it 'displays logged messages' do
+    job_tracker.events.create(data: { message: 'this is a useful log message' })
+    job_tracker.events.create(data: { message: 'and so is this' })
+
+    render
+    expect(rendered).to have_selector 'tr', text: 'this is a useful log message'
+    expect(rendered).to have_selector 'tr', text: 'and so is this'
+  end
+
+  it 'displays job progress information' do
+    allow(job_tracker).to receive_messages(progress: 37, total: 51)
+
+    render
+    expect(rendered).to have_content 'processed 37 / 51'
+  end
+end