blacklight-spotlight 3.0.0.rc4 → 3.0.0.rc5

data/app/jobs/spotlight/add_tags_job.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ###
+  class AddTagsJob < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+    include Spotlight::GatherDocuments
+    with_job_tracking(resource: ->(job) { job.arguments.last[:exhibit] })
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def perform(solr_params:, exhibit:, tags:, **)
+      @errors = 0
+
+      each_document(solr_params, exhibit) do |document|
+        sidecar = document.sidecar(exhibit)
+        all_tags = sidecar.all_tags_list
+        all_tags += tags
+        exhibit.tag(document.sidecar(exhibit), with: all_tags, on: :tags)
+        document.reindex(update_params: {})
+        progress&.increment
+      rescue StandardError => e
+        job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+        @errors += 1
+        mark_job_as_failed!
+      end
+      exhibit.blacklight_config.repository.connection.commit
+      job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress.progress} of #{progress.total} (#{@errors} errors)")
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -5,6 +5,8 @@ module Spotlight
   # Process a CSV upload into new Spotlight::Resource::Upload objects
   class AddUploadsFromCsv < Spotlight::ApplicationJob
     include Spotlight::JobTracking
+    with_job_tracking(resource: ->(job) { job.arguments[1] })
+
     attr_reader :count
     attr_reader :errors
 
@@ -58,9 +60,5 @@ module Spotlight
         end.compact.to_h
       end.compact
     end
-
-    def job_tracking_resource
-      arguments[1]
-    end
   end
 end

data/app/jobs/spotlight/change_visibility_job.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ###
+  class ChangeVisibilityJob < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+    include Spotlight::GatherDocuments
+    with_job_tracking(resource: ->(job) { job.arguments.last[:exhibit] })
+
+    # rubocop:disable Metrics/MethodLength
+    def perform(solr_params:, exhibit:, visibility:, **)
+      @errors = 0
+
+      each_document(solr_params, exhibit) do |document|
+        case visibility
+        when 'public'
+          document.make_public!(exhibit)
+        when 'private'
+          document.make_private!(exhibit)
+        end
+        document.reindex(update_params: {})
+        progress&.increment
+      rescue StandardError => e
+        job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+        @errors += 1
+        mark_job_as_failed!
+      end
+      exhibit.blacklight_config.repository.connection.commit
+      job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress.progress} of #{progress.total} (#{@errors} errors)")
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/app/jobs/spotlight/process_bulk_updates_csv_job.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module Spotlight
+  ###
+  class ProcessBulkUpdatesCsvJob < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+    with_job_tracking(resource: ->(job) { job.arguments.first })
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def perform(exhibit, bulk_update)
+      errors = 0
+      header_converter = ->(header) { header } # Use raw header for columns (since they are configured)
+      csv_path = bulk_update.file.current_path
+      File.open(csv_path) do |f|
+        progress&.total = f.each_line.count(&:present?) - 1 # ignore the header
+
+        ::CSV.table(f, header_converters: header_converter).each do |row|
+          process_row(exhibit, row)
+          progress&.increment
+        rescue StandardError => e
+          job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+          errors += 1
+          mark_job_as_failed!
+        end
+
+        exhibit.blacklight_config.repository.connection.commit
+        job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress&.progress} of #{progress&.total} (#{errors} errors)")
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    private
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def process_row(exhibit, row)
+      document = exhibit.blacklight_config.document_model.find(row[config.csv_id])
+      sidecar = document.sidecar(exhibit)
+
+      raise 'Unable to locate document' if document.blank?
+
+      needs_reindex = false
+
+      begin
+        if sidecar.public != to_bool(row[config.csv_visibility])
+          sidecar.update(public: to_bool(row[config.csv_visibility]))
+          needs_reindex = true
+        end
+
+        tag_cols = row.headers.select { |k| k =~ /^#{config.csv_tags_prefix}/ }
+
+        if tag_cols.any?
+          all_tags = sidecar.all_tags_list
+
+          added_tags_cols, removed_tags_cols = tag_cols.partition do |k|
+            to_bool(row[k])
+          end
+
+          existing_or_added_tags = added_tags_cols.map { |x| x.sub(/#{config.csv_tags_prefix}\s/, '') }
+          removed_tags = removed_tags_cols.map { |x| x.sub(/#{config.csv_tags_prefix}\s/, '') }
+
+          if all_tags.difference(existing_or_added_tags).any? || existing_or_added_tags.difference(all_tags).any?
+            exhibit.tag(sidecar, with: all_tags - removed_tags + existing_or_added_tags, on: :tags)
+            needs_reindex = true
+          end
+        end
+      ensure
+        document.reindex(update_params: {}) if needs_reindex
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
+    def to_bool(value)
+      ActiveModel::Type::Boolean.new.cast(value.to_s.strip)
+    end
+
+    def config
+      Spotlight::Engine.config.bulk_updates
+    end
+  end
+end

data/app/jobs/spotlight/reindex_exhibit_job.rb

@@ -5,11 +5,11 @@ module Spotlight
   # Reindex an exhibit by parallelizing resource indexing into multiple batches of reindex jobs
   class ReindexExhibitJob < Spotlight::ApplicationJob
     include Spotlight::JobTracking
+    with_job_tracking(resource: ->(job) { job.arguments.first })
+
     include Spotlight::LimitConcurrency
 
     def perform(exhibit, batch_size: Spotlight::Engine.config.reindexing_batch_size, batch_count: Spotlight::Engine.config.reindexing_batch_count, **)
-      job_tracker.update(status: 'in_progress')
-
       count = exhibit.resources.count
 
       # Use the provided batch size, or calculate a reasonable default
@@ -21,6 +21,9 @@ module Spotlight
       batch_size ||= (count.to_f / batch_count).ceil
 
       perform_later_in_batches(exhibit, of: batch_size)
+
+      # mark the job as 'pending' and let the UpdateJobTrackersJob finalize this status after the ReindexJobs finish
+      job_tracker.update(status: 'pending')
     end
 
     def perform_later_in_batches(exhibit, of:)

data/app/jobs/spotlight/reindex_job.rb

@@ -5,6 +5,8 @@ module Spotlight
   # Reindex the given resources or exhibits
   class ReindexJob < Spotlight::ApplicationJob
     include Spotlight::JobTracking
+    with_job_tracking(resource: ->(job) { job.exhibit })
+
     include Spotlight::LimitConcurrency
 
     before_perform do |job|
@@ -22,12 +24,17 @@ module Spotlight
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def perform(exhibit_or_resources, start: nil, finish: nil, **)
-      job_tracker.update(status: 'in_progress')
-
       errors = 0
 
-      error_handler = lambda do |pipeline, _error_context, exception, _data|
-        job_tracker.append_log_entry(type: :error, message: exception.to_s, resource_id: pipeline.source&.id)
+      error_handler = lambda do |pipeline, exception, _data|
+        job_tracker.append_log_entry(
+          type: :error,
+          exhibit: exhibit,
+          message: exception.to_s,
+          backtrace: exception.backtrace.first(5).join("\n"),
+          resource_id: (pipeline.source.id if pipeline.source.respond_to?(:id))
+        )
+        mark_job_as_failed!
         errors += 1
       end
 
@@ -36,14 +43,34 @@ module Spotlight
           progress&.increment
         end
       rescue StandardError => e
-        error_handler.call(Struct.new(:source).new(resource), self, e, nil)
+        error_handler.call(Struct.new(:source).new(resource), e, nil)
       end
 
-      job_tracker.append_log_entry(type: :info, message: "#{progress.progress} of #{progress.total} (#{errors} errors)")
-      job_tracker.update(status: errors.zero? ? 'completed' : 'failed', data: { progress: progress.progress, total: progress.total })
+      job_tracker.append_log_entry(
+        type: :summary,
+        exhibit: exhibit,
+        message: I18n.t(
+          'spotlight.job_trackers.show.messages.status.in_progress',
+          progress: progress.progress,
+          total: progress.total,
+          errors: (I18n.t('spotlight.job_trackers.show.messages.errors', count: errors) if errors.positive?)
+        ),
+        progress: progress.progress, total: progress.total, errors: errors
+      )
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
+    def exhibit
+      exhibit_or_resources = arguments.first
+
+      case exhibit_or_resources
+      when Spotlight::Exhibit
+        exhibit_or_resources
+      when Spotlight::Resource
+        exhibit_or_resources.exhibit
+      end
+    end
+
     private
 
     def commit
@@ -53,7 +80,7 @@ module Spotlight
     def job_data
       return unless job_tracker
 
-      { Spotlight::Engine.config.job_tracker_id_field => job_tracker.top_level_job_tracker.job_id }
+      @job_data ||= { Spotlight::Engine.config.job_tracker_id_field => job_tracker.top_level_job_tracker.job_id }
     end
 
     def resource_list(exhibit_or_resources, start: nil, finish: nil)
@@ -63,20 +90,5 @@ module Spotlight
         Array(exhibit_or_resources)
       end
     end
-
-    def job_tracking_resource
-      exhibit
-    end
-
-    def exhibit
-      exhibit_or_resources = arguments.first
-
-      case exhibit_or_resources
-      when Spotlight::Exhibit
-        exhibit_or_resources
-      when Spotlight::Resource
-        exhibit_or_resources.exhibit
-      end
-    end
   end
 end

data/app/jobs/spotlight/remove_tags_job.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ###
+  class RemoveTagsJob < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+    include Spotlight::GatherDocuments
+    with_job_tracking(resource: ->(job) { job.arguments.last[:exhibit] })
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def perform(solr_params:, exhibit:, tags:, **)
+      @errors = 0
+
+      each_document(solr_params, exhibit) do |document|
+        sidecar = document.sidecar(exhibit)
+        all_tags = sidecar.all_tags_list
+        all_tags -= tags
+        exhibit.tag(document.sidecar(exhibit), with: all_tags, on: :tags)
+        document.reindex(update_params: {})
+        progress&.increment
+      rescue StandardError => e
+        job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+        @errors += 1
+        mark_job_as_failed!
+      end
+      exhibit.blacklight_config.repository.connection.commit
+      job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress.progress} of #{progress.total} (#{@errors} errors)")
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/app/jobs/spotlight/rename_sidecar_field_job.rb

@@ -6,6 +6,7 @@ module Spotlight
   # need to update the sidecars that may contain that field
   class RenameSidecarFieldJob < Spotlight::ApplicationJob
     include Spotlight::JobTracking
+    with_job_tracking(resource: ->(job) { job.arguments.first })
 
     def perform(exhibit, old_field, new_field, old_slug = nil, new_slug = nil)
       exhibit.solr_document_sidecars.find_each do |s|

data/app/jobs/spotlight/rename_tags_job.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ###
+  class RenameTagsJob < Spotlight::ApplicationJob
+    include Spotlight::JobTracking
+
+    with_job_tracking(resource: ->(job) { job.arguments.first })
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def perform(exhibit, tag, to: nil, **)
+      @errors = 0
+
+      tag.taggings.owned_by(exhibit).find_each do |tagging|
+        sidecar = tagging.taggable
+        all_tags = sidecar.all_tags_list
+        all_tags -= [tag.name]
+        all_tags += [to] unless to.nil?
+
+        exhibit.tag(sidecar, with: all_tags, on: :tags)
+        sidecar.document.reindex(update_params: {})
+      rescue StandardError => e
+        job_tracker.append_log_entry(type: :error, exhibit: exhibit, message: e.to_s)
+        @errors += 1
+        mark_job_as_failed!
+      end
+
+      exhibit.blacklight_config.repository.connection.commit
+      job_tracker.append_log_entry(type: :info, exhibit: exhibit, message: "#{progress.progress} of #{progress.total} (#{@errors} errors)")
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/app/models/concerns/spotlight/exhibit_analytics.rb

@@ -8,18 +8,14 @@ module Spotlight
       return OpenStruct.new unless analytics_provider&.enabled?
 
       @analytics ||= {}
-      @analytics[start_date] ||= begin
-        analytics_provider.exhibit_data(path || self, start_date: start_date.ago)
-      end
+      @analytics[start_date] ||= analytics_provider.exhibit_data(path || self, start_date: start_date.ago)
     end
 
     def page_analytics(start_date = 1.month, path = nil)
       return [] unless analytics_provider&.enabled?
 
       @page_analytics ||= {}
-      @page_analytics[start_date] ||= begin
-        analytics_provider.page_data(path || self, start_date: start_date.ago)
-      end
+      @page_analytics[start_date] ||= analytics_provider.page_data(path || self, start_date: start_date.ago)
     end
 
     def analytics_provider

data/app/models/concerns/spotlight/exhibit_documents.rb

@@ -23,12 +23,12 @@ module Spotlight
       end
     end
 
-    private
-
     def exhibit_search_builder
       blacklight_config.search_builder_class.new(exhibit_search_builder_context).except(:apply_permissive_visibility_filter)
     end
 
+    private
+
     def exhibit_search_builder_context
       OpenStruct.new(blacklight_config: blacklight_config.tap { |x| x.current_exhibit = self })
     end

data/app/models/concerns/spotlight/resources/web.rb

@@ -30,7 +30,7 @@ module Spotlight
       def self.fetch(url)
         Faraday.new(url) do |b|
           b.use FaradayMiddleware::FollowRedirects
-          b.adapter :net_http
+          b.adapter Faraday.default_adapter
         end.get
       end
     end

data/app/models/concerns/spotlight/solr_document.rb

@@ -24,7 +24,7 @@ module Spotlight
 
       def reindex(id)
         find(id).reindex
-      rescue Blacklight::Exceptions::InvalidSolrID => e
+      rescue Blacklight::Exceptions::RecordNotFound => e
         Rails.logger.debug "Unable to find document #{id}: #{e}"
       end
 

data/app/models/concerns/spotlight/solr_document/atomic_updates.rb

@@ -5,12 +5,12 @@ module Spotlight
     ##
     # Solr indexing strategy using Solr's Atomic Updates
     module AtomicUpdates
-      def reindex
+      def reindex(update_params: { commitWithin: 500 })
         return unless write?
 
         data = hash_for_solr_update(to_solr)
 
-        blacklight_solr.update params: { commitWithin: 500 }, data: data.to_json, headers: { 'Content-Type' => 'application/json' } unless data.empty?
+        blacklight_solr.update params: update_params, data: data.to_json, headers: { 'Content-Type' => 'application/json' } unless data.empty?
       end
 
       def write?

data/app/models/concerns/spotlight/user.rb

@@ -19,7 +19,11 @@ module Spotlight
     end
 
     def exhibit_roles
-      roles.where(resource_type: 'Spotlight::Exhibit')
+      roles.where(resource_type: 'Spotlight::Exhibit').where.not(role: 'viewer')
+    end
+
+    def viewer_roles
+      roles.where(resource_type: 'Spotlight::Exhibit', role: 'viewer')
     end
 
     def admin_roles