blacklight-spotlight 3.0.0.rc4 → 3.0.2

data/app/helpers/spotlight/application_helper.rb

@@ -92,7 +92,7 @@ module Spotlight
     # Helper to turn tag data into facets
     def url_to_tag_facet(tag)
       if current_exhibit
-        search_action_url(search_state.reset.add_facet_params(blacklight_config.document_model.solr_field_for_tagger(current_exhibit), tag))
+        search_action_url(search_state.reset.filter(:exhibit_tags).add(tag).params)
       else
         search_action_url(q: tag)
       end

data/app/helpers/spotlight/job_trackers_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # HTML <meta> tag helpers
+  module JobTrackersHelper
+    def job_status_icon(job_tracker)
+      content_tag :span, title: t(job_tracker.status || 'missing', scope: 'spotlight.job_trackers.status') do # rubocop:disable Rails/ContentTag
+        if job_tracker.enqueued? || job_tracker.in_progress?
+          '⏱'
+        elsif job_tracker.completed?
+          '✅'
+        elsif job_tracker.failed?
+          '🟥'
+        else
+          ''
+        end
+      end
+    end
+
+    def job_tracker_event_table_row_class(event)
+      case event.type
+      when 'error'
+        'table-danger'
+      when 'info', 'summary'
+        ''
+      else
+        "table-#{event.type}"
+      end
+    end
+  end
+end

data/app/helpers/spotlight/main_app_helpers.rb

@@ -28,12 +28,11 @@ module Spotlight
       super
     end
 
-    def presenter(document)
-      case action_name
-      when 'index'
+    def document_presenter_class(_document)
+      if action_name == 'index'
         super
       else
-        show_presenter(document)
+        blacklight_config.view_config(action_name: :show).document_presenter_class
       end
     end
 

data/app/helpers/spotlight/meta_helper.rb

@@ -81,7 +81,7 @@ module Spotlight
     end
 
     def document_twitter_card_content(document)
-      presenter = show_presenter(document)
+      presenter = document_presenter(document)
 
       twitter_card('summary_large_image') do |card|
         card.title presenter.heading
@@ -90,7 +90,7 @@ module Spotlight
     end
 
     def document_opengraph_content(document)
-      presenter = show_presenter(document)
+      presenter = document_presenter(document)
 
       opengraph do |graph|
         graph.site_name application_name

data/app/helpers/spotlight/pages_helper.rb

@@ -29,13 +29,6 @@ module Spotlight
       render_markdown(clean_text)
     end
 
-    def available_index_fields
-      fields = blacklight_config.index_fields.map { |k, _v| { key: k, label: index_field_label(blacklight_config.document_model.new, k) } }
-      fields.unshift(key: document_show_link_field, label: t(:'spotlight.pages.form.title_placeholder')) unless index_fields.include? document_show_link_field
-
-      fields
-    end
-
     def disable_save_pages_button?
       page_collection_name == 'about_pages' && @pages.empty?
     end

data/app/helpers/spotlight/roles_helper.rb

@@ -7,7 +7,7 @@ module Spotlight
     ##
     # Format the available roles for a select_tag
     def roles_for_select
-      Spotlight::Role::ROLES.each_with_object({}) do |key, object|
+      Spotlight::Engine.config.exhibit_roles.each_with_object({}) do |key, object|
         object[t("spotlight.role.#{key}")] = key
       end
     end

data/app/helpers/spotlight/searches_helper.rb

@@ -4,7 +4,7 @@ module Spotlight
   # Saved search helpers
   module SearchesHelper
     def available_document_index_views
-      blacklight_config.view.to_h.reject { |_k, v| v.if == false }.keys
+      blacklight_config.view.to_h.reject { |_k, v| v.if == false }
     end
   end
 end

data/app/jobs/concerns/spotlight/gather_documents.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Gather documents by a given query that can be used in a job
+  # Will also increment job tracking total
+  module GatherDocuments
+    extend ActiveSupport::Concern
+
+    # rubocop:disable Metrics/MethodLength
+    def each_document(solr_params, exhibit, &block)
+      return to_enum(:each_document, solr_params, exhibit) unless block_given?
+
+      cursor_mark = nil
+      next_cursor_mark = '*'
+
+      until next_cursor_mark == cursor_mark || next_cursor_mark.nil?
+        cursor_mark = next_cursor_mark
+        response = exhibit.blacklight_config.repository.search(
+          solr_params.merge(
+            'rows' => Spotlight::Engine.config.bulk_actions_batch_size,
+            'cursorMark' => cursor_mark,
+            'sort' => "#{exhibit.blacklight_config.document_model.unique_key} asc"
+          )
+        )
+        progress.total = response.total
+        response.documents.each do |document|
+          block.call(document)
+        end
+
+        next_cursor_mark = response['nextCursorMark']
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/app/jobs/concerns/spotlight/job_tracking.rb

@@ -6,42 +6,59 @@ module Spotlight
     extend ActiveSupport::Concern
     include ActiveJob::Status
 
-    def self.with_job_tracking
-      before_perform :find_or_initialize_job_tracker
-      after_perform :finalize_job_tracker
+    class_methods do
+      # @param resource [Proc] receives the job and returns the resource connect to the job tracking status
+      # @param reports_on [Proc] optional, receives the job and returns a Spotlight::JobTracker to "roll up" statuses to
+      # @param user [Proc] optional, receives the job and returns the User that initiated the job
+      def with_job_tracking(
+        resource:,
+        reports_on: ->(job) { job.arguments.last[:reports_on] if job.arguments.last.is_a?(Hash) },
+        user: ->(job) { job.arguments.last[:user] if job.arguments.last.is_a?(Hash) }
+      )
+        around_perform do |job, block|
+          resource_object = resource&.call(job)
+
+          job.initialize_job_tracker!(
+            resource: resource_object,
+            on: reports_on&.call(job) || resource_object,
+            user: user&.call(job)
+          )
+
+          block.call
+        ensure
+          job.finalize_job_tracker!
+        end
+      end
+    end
+
+    def mark_job_as_failed!
+      @failed = true
     end
 
     def job_tracker
       @job_tracker ||= find_or_initialize_job_tracker
     end
 
+    def initialize_job_tracker!(**params)
+      job_tracker.update(params.merge(status: 'in_progress').compact)
+    end
+
+    def finalize_job_tracker!
+      return unless job_tracker.status == 'in_progress' || job_tracker.status == 'enqueued'
+
+      job_tracker.update(
+        status: @failed ? 'failed' : 'completed',
+        data: { progress: progress.progress, total: progress.total }
+      )
+    end
+
     private
 
     def find_or_initialize_job_tracker
       JobTracker.find_or_create_by(job_id: job_id) do |tracker|
         tracker.job_class = self.class.name
         tracker.status = 'enqueued'
-        update_job_tracker_properties(tracker)
       end
     end
-
-    def finalize_job_tracker
-      job_tracker.update(status: 'completed') if job_tracker.status == 'enqueued'
-    end
-
-    def update_job_tracker_properties(tracker)
-      tracker.resource = job_tracking_resource
-      tracker.on = reports_on_resource || tracker.resource
-
-      tracker.user = arguments.last[:user] if arguments.last.is_a?(Hash)
-    end
-
-    def job_tracking_resource
-      arguments.first
-    end
-
-    def reports_on_resource
-      arguments.last[:reports_on] if arguments.last.is_a?(Hash)
-    end
   end
 end

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