blacklight-spotlight 3.0.0.alpha.9 → 3.0.0.rc4

data/app/models/spotlight/feature_page.rb

@@ -5,7 +5,9 @@ module Spotlight
   # Feature pages
   class FeaturePage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale]
+    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
+      config.reserved_words&.concat(%w[update_all])
+    end
 
     has_many :child_pages, class_name: 'Spotlight::FeaturePage', inverse_of: :parent_page, foreign_key: 'parent_page_id'
     belongs_to :parent_page, class_name: 'Spotlight::FeaturePage', optional: true

data/app/models/spotlight/featured_image.rb

@@ -6,6 +6,24 @@ module Spotlight
   class FeaturedImage < ActiveRecord::Base
     mount_uploader :image, Spotlight::FeaturedImageUploader
 
+    before_validation do
+      next unless upload_id.present? && source == 'remote'
+
+      # copy the image from the temp upload
+      temp_image = Spotlight::TemporaryImage.find(upload_id)
+      self.image = CarrierWave::SanitizedFile.new tempfile: StringIO.new(temp_image.image.read),
+                                                  filename: temp_image.image.filename || temp_image.image.identifier,
+                                                  content_type: temp_image.image.content_type
+
+      # Unset the incoming iiif_tilesource, which points at the temp image
+      self.iiif_tilesource = nil
+    end
+
+    after_commit do
+      # Clean up the temporary image
+      Spotlight::TemporaryImage.find(upload_id).delete if upload_id.present?
+    end
+
     after_save do
       if image.present?
         image.cache! unless image.cached?
@@ -13,7 +31,7 @@ module Spotlight
       end
     end
 
-    after_create :set_tilesource_from_uploaded_resource
+    attr_accessor :upload_id
 
     def iiif_url
       return unless iiif_service_base.present?
@@ -45,24 +63,23 @@ module Spotlight
       image.file.present?
     end
 
-    private
-
-    def set_tilesource_from_uploaded_resource
-      return if iiif_tilesource
-
-      riiif = Riiif::Engine.routes.url_helpers
-      self.iiif_tilesource = riiif.info_path(id)
-      save
+    def iiif_tilesource
+      if self[:iiif_tilesource]
+        self[:iiif_tilesource]
+      elsif file_present?
+        riiif = Riiif::Engine.routes.url_helpers
+        riiif.info_path(id)
+      end
     end
 
+    private
+
     def image_size
       Spotlight::Engine.config.featured_image_thumb_size
     end
 
     def iiif_service_base
-      return unless iiif_tilesource
-
-      iiif_tilesource.sub('/info.json', '')
+      iiif_tilesource&.sub('/info.json', '')
     end
   end
 end

data/app/models/spotlight/group.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Exhibit saved searches
+  class Group < ActiveRecord::Base
+    include Spotlight::Translatables
+
+    extend FriendlyId
+    friendly_id :title, use: %i[slugged scoped finders history], scope: [:exhibit]
+    translates :title
+
+    self.table_name = 'spotlight_groups'
+    belongs_to :exhibit
+    has_many :group_members
+    has_many :searches, through: :group_members, source: :member, source_type: 'Spotlight::Search'
+    default_scope { order('weight ASC') }
+    scope :published, -> { where(published: true) }
+    accepts_nested_attributes_for :group_members
+    accepts_nested_attributes_for :searches
+  end
+end

data/app/models/spotlight/group_member.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Exhibit saved searches
+  class GroupMember < ActiveRecord::Base
+    self.table_name = 'spotlight_groups_members'
+    belongs_to :group
+    belongs_to :member, polymorphic: true
+  end
+end

data/app/models/spotlight/home_page.rb

@@ -5,7 +5,9 @@ module Spotlight
   # Exhibit home page
   class HomePage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: %i[slugged scoped finders], scope: %i[exhibit locale]
+    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
+      config.reserved_words&.concat(%w[update_all])
+    end
 
     before_save :publish
     before_create :default_content

data/app/models/spotlight/job_tracker.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Associate background jobs with records
+  class JobTracker < ActiveRecord::Base
+    scope :recent, -> { order('updated_at DESC').limit(5) }
+    scope :in_progress, -> { where.not(status: %w[completed failed]) }
+    scope :completed, -> { where(status: %w[completed failed]) }
+
+    belongs_to :on, polymorphic: true
+    belongs_to :resource, polymorphic: true
+    belongs_to :user, optional: true, class_name: Spotlight::Engine.config.user_class # rubocop:disable Rails/ReflectionClassName
+    has_many :events, as: :resource, dependent: :delete_all
+    has_many :job_trackers, as: :on, dependent: Rails.version > '6.1' ? :destroy_async : :destroy
+
+    serialize :data
+
+    after_initialize do
+      self.data ||= {}
+    end
+
+    after_commit do
+      next unless on.is_a? Spotlight::JobTracker
+
+      UpdateJobTrackersJob.perform_later(self)
+    end
+
+    def label
+      "[#{job_class.titleize}] #{resource_label}"
+    end
+
+    def resource_label
+      return resource.filename if resource.is_a? ActiveStorage::Blob
+      return resource.name if resource.is_a? Upload
+
+      resource_id
+    end
+
+    def job_status
+      return {} unless job_id
+
+      @job_status ||= ActiveJob::Status.get(job_id)
+    end
+
+    def progress_label
+      return number_with_delimiter(progress) unless total?
+
+      "#{number_with_delimiter(progress)} / #{number_with_delimiter(total)}"
+    end
+
+    def progress
+      data[:progress] || job_status[:progress] || 0
+    end
+
+    def total(default: progress)
+      [progress, data[:total] || job_status[:total] || default].max
+    end
+
+    def total?
+      total(default: 0).positive?
+    end
+
+    def percent
+      return nil unless total?
+
+      (100.0 * progress) / total
+    end
+
+    def enqueued?
+      status == 'enqueued'
+    end
+
+    def in_progress?
+      status == 'in_progress'
+    end
+
+    def completed?
+      status == 'completed'
+    end
+
+    def failed?
+      status == 'failed'
+    end
+
+    def append_log_entry(type:, **args)
+      events.create(type: type, data: args)
+    rescue StandardError => e
+      Rails.logger.error("Unable to create log entry for job tracker #{id}: #{e}")
+    end
+
+    def top_level_job_tracker
+      if on.is_a?(Spotlight::JobTracker)
+        on.top_level_job_tracker
+      else
+        self
+      end
+    end
+
+    private
+
+    def number_with_delimiter(*args)
+      ActiveSupport::NumberHelper.number_to_delimited(*args)
+    end
+  end
+end

data/app/models/spotlight/main_navigation.rb

@@ -26,8 +26,8 @@ module Spotlight
       end
     end
 
-    def default_label
-      I18n.t(:"spotlight.main_navigation.#{nav_type}")
+    def default_label(**options)
+      I18n.t(:"spotlight.main_navigation.#{nav_type}", **options)
     end
 
     private

data/app/models/spotlight/masthead.rb

@@ -11,7 +11,7 @@ module Spotlight
     private
 
     def image_size
-      [1800, 180]
+      Spotlight::Engine.config.featured_image_masthead_size
     end
   end
 end

data/app/models/spotlight/page.rb

@@ -7,7 +7,11 @@ module Spotlight
     MAX_PAGES = Spotlight::Engine.config.max_pages
 
     extend FriendlyId
-    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale]
+    # Note: This configuration also needs to be duplicated on the
+    # STI models ({Spotlight::AboutPage}, {Spotlight::FeaturePage}, {Spotlight::HomePage})
+    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale], treat_reserved_as_conflict: true do |config|
+      config.reserved_words&.concat(%w[update_all contacts])
+    end
 
     belongs_to :exhibit, touch: true
     belongs_to :created_by, class_name: Spotlight::Engine.config.user_class, optional: true

data/app/models/spotlight/page_configurations.rb

@@ -27,6 +27,7 @@ module Spotlight
              to: :context
 
     attr_reader :context, :page
+
     def initialize(context:, page:)
       @context = context
       @page = page
@@ -39,6 +40,7 @@ module Spotlight
         'attachment-endpoint': attachment_endpoint,
         'autocomplete-exhibit-catalog-path': exhibit_autocomplete_endpoint,
         'autocomplete-exhibit-pages-path': page_autocomplete_endpoint,
+        'autocomplete-exhibit-browse-groups-path': browse_groups_autocomplete_endpoint,
         'autocomplete-exhibit-searches-path': search_autocomplete_endpoint,
         'preview-url': page_preview_url
       }.merge(downstream_parameters)
@@ -61,6 +63,10 @@ module Spotlight
       spotlight.exhibit_attachments_path(current_exhibit)
     end
 
+    def browse_groups_autocomplete_endpoint
+      spotlight.exhibit_groups_path(current_exhibit)
+    end
+
     def exhibit_autocomplete_endpoint
       spotlight.autocomplete_exhibit_catalog_path(current_exhibit, q: '%QUERY', format: 'json')
     end

data/app/models/spotlight/page_content.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'spotlight/page_content/sir_trevor'
+
 module Spotlight
   # Factory for picking the right page content renderer
   module PageContent

data/app/models/spotlight/reindex_progress.rb

@@ -4,59 +4,76 @@ module Spotlight
   ##
   # ReindexProgress is a class that models the progress of reindexing a list of resources
   class ReindexProgress
-    attr_reader :current_log_entry
+    attr_reader :exhibit
 
-    delegate :updated_at, to: :current_log_entry
+    delegate :updated_at, to: :most_relevant_job_tracker
 
-    def initialize(current_log_entry)
-      @current_log_entry = current_log_entry
+    def initialize(exhibit)
+      @exhibit = exhibit
+    end
+
+    def as_json(*)
+      {
+        recently_in_progress: recently_in_progress?,
+        started_at: localized_start_time,
+        finished_at: localized_finish_time,
+        updated_at: localized_updated_time,
+        total: [total, completed].max,
+        completed: completed,
+        finished: finished?,
+        errored: errored?
+      }
+    end
+
+    private
+
+    def job_trackers
+      @job_trackers ||= exhibit.job_trackers.where(job_class: 'Spotlight::ReindexExhibitJob').recent
+    end
+
+    def most_relevant_job_tracker
+      return @most_relevant_job_tracker if @most_relevant_job_tracker
+
+      @most_relevant_job_tracker ||= job_trackers.in_progress.first || job_trackers.completed.first || job_trackers.first || Spotlight::JobTracker.new
     end
 
     def recently_in_progress?
-      return true if current_log_entry.in_progress?
+      return false unless most_relevant_job_tracker.persisted?
+      return true if most_relevant_job_tracker.in_progress?
 
-      current_log_entry.end_time.present? && (current_log_entry.end_time > Spotlight::Engine.config.reindex_progress_window.minutes.ago)
+      finished? && most_relevant_job_tracker.updated_at >= Spotlight::Engine.config.reindex_progress_window.ago
     end
 
     def started_at
-      current_log_entry.start_time
+      most_relevant_job_tracker.created_at
     end
 
     def finished?
-      current_log_entry.succeeded? || current_log_entry.failed?
+      most_relevant_job_tracker.completed? || (errored? && most_relevant_job_tracker.job_trackers.none?(&:in_progress?))
     end
 
     def finished_at
-      current_log_entry.end_time
+      return unless finished?
+
+      most_relevant_job_tracker.updated_at
     end
 
     def total
-      current_log_entry.items_reindexed_estimate
+      return most_relevant_job_tracker.total if finished?
+
+      most_relevant_job_tracker.job_trackers.sum(&:total)
     end
 
     def completed
-      current_log_entry.items_reindexed_count
-    end
+      return most_relevant_job_tracker.progress if finished?
 
-    def errored?
-      current_log_entry.failed?
+      most_relevant_job_tracker.job_trackers.sum(&:progress)
     end
 
-    def as_json(*)
-      {
-        recently_in_progress: recently_in_progress?,
-        started_at: localized_start_time,
-        finished_at: localized_finish_time,
-        updated_at: localized_updated_time,
-        total: total,
-        completed: completed,
-        finished: finished?,
-        errored: errored?
-      }
+    def errored?
+      most_relevant_job_tracker.failed?
     end
 
-    private
-
     def localized_start_time
       return unless started_at
 

data/app/models/spotlight/resource.rb

@@ -4,10 +4,17 @@ module Spotlight
   ##
   # Exhibit resources
   class Resource < ActiveRecord::Base
-    include ActiveSupport::Benchmarkable
-
-    class_attribute :document_builder_class
-    self.document_builder_class = SolrDocumentBuilder
+    class_attribute :indexing_pipeline, default: (Spotlight::Etl::Pipeline.new do |pipeline|
+      pipeline.sources = [Spotlight::Etl::Sources::IdentitySource]
+      pipeline.transforms = [
+        reject_blank: Spotlight::Etl::Transforms::RejectBlank,
+        reject_missing: Spotlight::Etl::Transforms::RejectMissingUniqueId,
+        apply_exhibit_metadata: Spotlight::Etl::Transforms::ApplyExhibitMetadata,
+        apply_application_metadata: Spotlight::Etl::Transforms::ApplyApplicationMetadata,
+        apply_pipeline_metadata: Spotlight::Etl::Transforms::ApplyPipelineMetadata
+      ]
+      pipeline.loaders = [Spotlight::Etl::SolrLoader]
+    end)
 
     extend ActiveModel::Callbacks
     define_model_callbacks :index
@@ -16,12 +23,10 @@ module Spotlight
 
     belongs_to :exhibit
     has_many :solr_document_sidecars
+    has_many :events, as: :resource
 
     serialize :data, Hash
 
-    after_index :commit
-    after_index :touch_exhibit!
-
     ##
     # Persist the record to the database, and trigger a reindex to solr
     #
@@ -45,67 +50,28 @@ module Spotlight
       # Index the result of {#to_solr} into the index in batches of {#batch_size}
       #
       # @return [Integer] number of records indexed
-      def reindex(reindexing_log_entry = nil)
-        benchmark "Reindexing #{self} (batch size: #{batch_size})" do
-          count = 0
-
-          run_callbacks :index do
-            document_builder.documents_to_index.each_slice(batch_size) do |batch|
-              write_to_index(batch)
-              count += batch.length
-              reindexing_log_entry&.update(items_reindexed_count: count)
-            end
-
-            count
+      def reindex(touch: true, **args, &block)
+        i = 0
+        run_callbacks :index do
+          indexing_pipeline.call(Spotlight::Etl::Context.new(self, commit: true, **args)) do |data|
+            i += 1
+            block&.call(data)
           end
         end
-      end
-
-      def document_builder
-        @document_builder ||= document_builder_class.new(self)
-      end
-
-      private
-
-      def blacklight_solr
-        @solr ||= RSolr.connect(connection_config.merge(adapter: connection_config[:http_adapter]))
-      end
 
-      def connection_config
-        Blacklight.connection_config
-      end
+        touch_exhibit! if touch
 
-      def batch_size
-        Spotlight::Engine.config.solr_batch_size
+        i
       end
 
-      def write_to_index(batch)
-        documents = documents_that_have_ids(batch)
-        return unless write? && documents.present?
-
-        blacklight_solr.update params: { commitWithin: 500 },
-                               data: documents.to_json,
-                               headers: { 'Content-Type' => 'application/json' }
+      def estimated_size(**args)
+        indexing_pipeline.estimated_size(Spotlight::Etl::Context.new(self, **args))
       end
 
-      def commit
-        return unless write?
-
-        blacklight_solr.commit
-      rescue StandardError => e
-        Rails.logger.warn "Unable to commit to solr: #{e}"
-      end
+      private
 
       def touch_exhibit!
-        exhibit.touch
-      end
-
-      def write?
-        Spotlight::Engine.config.writable_index
-      end
-
-      def documents_that_have_ids(document_list)
-        document_list.reject { |d| d[document_builder.document_model.unique_key.to_sym].blank? }
+        exhibit&.touch
       end
     end
   end