blacklight-spotlight 3.0.0.rc3 → 3.0.1

data/app/services/spotlight/etl/solr_loader.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module Etl
+    # Solr data loader with a built-in buffer to combine document updates into batches
+    class SolrLoader
+      attr_reader :queue, :batch_size
+
+      delegate :size, to: :queue
+
+      def initialize(batch_size: Spotlight::Engine.config.solr_batch_size, solr_connection: nil)
+        @queue = Queue.new
+        @batch_size = batch_size
+        @blacklight_solr = solr_connection
+      end
+
+      def call(data, pipeline = nil)
+        @queue << data
+
+        write_to_index(pipeline) if @queue.size >= @batch_size
+      end
+
+      def finalize(pipeline = nil)
+        write_to_index(pipeline)
+
+        commit! if pipeline.nil? || pipeline.context.additional_parameters[:commit]
+      end
+
+      private
+
+      def write_to_index(pipeline)
+        batch = drain_queue
+
+        return unless write? && batch.any?
+
+        send_batch(batch, pipeline)
+      end
+
+      def send_batch(documents, pipeline)
+        blacklight_solr.update params: { commitWithin: 500 },
+                               data: documents.to_json,
+                               headers: { 'Content-Type' => 'application/json' }
+      rescue StandardError => e
+        logger.warn "Error sending a batch of documents to solr: #{e}"
+
+        documents.each do |doc|
+          send_one(doc, pipeline)
+        end
+      end
+
+      def send_one(document, pipeline)
+        blacklight_solr.update params: { commitWithin: 500 },
+                               data: [document].to_json,
+                               headers: { 'Content-Type' => 'application/json' }
+      rescue StandardError => e
+        pipeline&.on_error(self, e, document.to_json)
+      end
+
+      def blacklight_solr
+        @blacklight_solr ||= RSolr.connect(connection_config.merge(adapter: connection_config[:http_adapter]))
+      end
+
+      def connection_config
+        Blacklight.connection_config
+      end
+
+      def drain_queue
+        arr = []
+
+        begin
+          arr << @queue.deq(true) while arr.length < @batch_size && !@queue.empty?
+        rescue ThreadError
+          # @queue throws a ThreadError if it is empty...
+        end
+
+        arr
+      end
+
+      def commit!
+        return unless write?
+
+        blacklight_solr.commit
+      rescue StandardError => e
+        logger.warn "Unable to commit to solr: #{e}"
+      end
+
+      def write?
+        Spotlight::Engine.config.writable_index
+      end
+
+      def logger
+        Rails.logger
+      end
+    end
+  end
+end

data/app/services/spotlight/etl/sources.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module Etl
+    # Basic ETL source implementations
+    module Sources
+      # A simple source that just returns the original resource(s)
+      IdentitySource = lambda do |context|
+        Array.wrap(context.resource)
+      end
+
+      # A transform step that calls a method on the resource to generate a source
+      def self.SourceMethodSource(method) # rubocop:disable Naming/MethodName
+        lambda do |context|
+          context.resource.public_send(method)
+        end
+      end
+
+      # A simple source that retrieves the stored data from a Spotlight::Resource
+      StoredData = lambda do |context, **|
+        Array.wrap(context.resource.data)
+      end
+    end
+  end
+end

data/app/services/spotlight/etl/step.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module Etl
+    # ETL pipeline step
+    class Step
+      attr_reader :definition, :context, :executor
+
+      # @param [Class, Proc] definition the step to run
+      # @param [String] label
+      # @param [Spotlight::Etl::Executor] executor the execution environment
+      def initialize(definition, label: nil, executor: nil)
+        @definition = definition
+        @executor = executor
+        @label = label
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def call(*args)
+        with_logger do |logger|
+          logger.debug { "Called with #{transform_data_for_debugging(args.first)}" }
+
+          catch :skip do
+            return action.call(*args).tap do |result|
+              logger.debug { "   => Returning #{transform_data_for_debugging(result)}" } if $VERBOSE
+            end
+          end
+
+          logger.debug '  => Caught skip.'
+          throw :skip
+        end
+      rescue StandardError => e
+        with_logger do |logger|
+          logger.error("Caught exception #{e}")
+        end
+        raise(e)
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def finalize(*args)
+        action.finalize(*args) if action.respond_to? :finalize
+      end
+
+      private
+
+      # @return [#call]
+      def action
+        case definition
+        when Class
+          # memoize the class' instance for the lifetime of the step
+          @memoized_action ||= definition.new
+        else # Proc, etc
+          definition
+        end
+      end
+
+      # @return [#to_string]
+      def label
+        @label || definition
+      end
+
+      # NOTE: this is super weird to support Rails 5.2
+      # @return [Logger]
+      def with_logger
+        yield(Rails.logger) && return unless executor
+
+        executor.with_logger do |logger|
+          logger.tagged(label) do
+            yield logger
+          end
+        end
+      end
+
+      ##
+      # @param [Hash] data
+      # @return [String] a simplified + truncated version of the data hash for debugging
+      def transform_data_for_debugging(data)
+        executor&.transform_data_for_debugging(data) || data.inspect.truncate(100)
+      end
+    end
+  end
+end

data/app/services/spotlight/etl/transforms.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module Etl
+    # Basic + default transform steps
+    module Transforms
+      # A transform step that "transforms" the source into the data element
+      IdentityTransform = lambda do |data, pipeline|
+        data.merge(pipeline.source)
+      end
+
+      # A transform step that calls a method on the source to generate a document
+      def self.SourceMethodTransform(method) # rubocop:disable Naming/MethodName
+        lambda do |data, pipeline|
+          data.merge(pipeline.source.public_send(method))
+        end
+      end
+
+      # A transform step that throws away blank data
+      RejectBlank = lambda do |data, _|
+        throw :skip if data.blank?
+        data
+      end
+
+      # A trasnform step that ensures data has a unique key attribute
+      RejectMissingUniqueId = lambda do |data, pipeline|
+        id = pipeline.context.unique_key(data)
+
+        throw :skip if id.blank?
+        data
+      end
+
+      # A transform that adds exhibit-specific metadata (like Spotlight sidecar data)
+      # to the document
+      ApplyExhibitMetadata = lambda do |data, pipeline|
+        resource = pipeline.context.resource
+        document_model = pipeline.context.document_model
+        id = pipeline.context.unique_key(data)
+
+        next data unless document_model && id.present?
+
+        exhibit_metadata = document_model.build_for_exhibit(id, resource.exhibit, resource: (resource if resource.persisted?))
+
+        data.reverse_merge(exhibit_metadata.to_solr)
+      end
+
+      # A transform that adds application-specific metadata (like what resource generated the solr document)
+      ApplyApplicationMetadata = lambda do |data, pipeline|
+        resource = pipeline.context.resource
+        document_model = pipeline.context.document_model
+
+        data.reverse_merge(
+          Spotlight::Engine.config.resource_global_id_field => (resource.to_global_id.to_s if resource.persisted?),
+          document_model.resource_type_field => resource.class.to_s.tableize
+        )
+      end
+
+      # A transform that adds externally-provided metadata to the document
+      ApplyPipelineMetadata = lambda do |data, pipeline|
+        data.reverse_merge(pipeline.context.additional_metadata)
+      end
+    end
+  end
+end

data/app/services/spotlight/iiif_resource_resolver.rb

@@ -57,7 +57,7 @@ module Spotlight
 
     def response
       @response ||= begin
-                      Faraday.get(iiif_manifest_url).body
+                      Spotlight::Resources::IiifService.http_client.get(iiif_manifest_url).body
                     rescue Faraday::Error => e
                       Rails.logger.warn("#{self.class.name} failed to fetch #{iiif_manifest_url} with: #{e}")
                       '{}'

data/app/services/spotlight/validity_checker.rb

@@ -5,16 +5,16 @@ module Spotlight
   # check if a delayed job still needs to run
   class ValidityChecker
     # Return a validity token
-    # @param [ActiveModel::Model]
+    # @param [ActiveJob::Base]
     # @return [Object] any serializable object
-    def mint(_model); end
+    def mint(_job); end
 
     # Check if the token is still valid for the model
-    # @param [ActiveModel::Model]
+    # @param [ActiveJob::Base]
     # @param [Object] the serializable token minted by #mint
     # @return [boolean]
-    def check(_model, _token)
-      true
+    def check(_job, validity_token: nil)
+      validity_token || true
     end
   end
 end

data/app/uploaders/spotlight/bulk_updates_uploader.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Spotlight
+  class BulkUpdatesUploader < CarrierWave::Uploader::Base
+    storage Spotlight::Engine.config.uploader_storage
+  end
+end

data/app/uploaders/spotlight/featured_image_uploader.rb

@@ -6,7 +6,7 @@ module Spotlight
   class FeaturedImageUploader < CarrierWave::Uploader::Base
     storage Spotlight::Engine.config.uploader_storage
 
-    def extension_whitelist
+    def extension_allowlist
       Spotlight::Engine.config.allowed_upload_extensions
     end
 

data/app/views/catalog/_add_tags.html.erb

@@ -0,0 +1,28 @@
+<div class="modal fade" id="add-tags-modal" tabindex="-1" role="dialog" aria-labelledby="add-tag-modal" aria-hidden="true">
+  <div class="modal-dialog">
+  <%= bootstrap_form_for([:visibility, current_exhibit], url: add_tags_exhibit_bulk_actions_path(current_exhibit), method: 'post') do |f| %>
+    <div class="modal-content">
+      <div class="modal-header">
+        <h4 class="modal-title" id="add-tag-modal"><%= t(:'spotlight.bulk_actions.add_tags.heading') %></h4>
+        <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+      <div class="modal-body">
+        <p>
+          <%= t(:'spotlight.bulk_actions.add_tags.description', count: @response.total) %>
+        </p>
+        <div class="form-group">
+          <%= label_tag :tags, t(:'spotlight.bulk_actions.add_tags.label') %>
+          <%= text_field_tag :tags, '', class: 'form-control', data: { autocomplete_tag: true, autocomplete_url: exhibit_tags_path(current_exhibit, format: 'json')} %>
+        </div>
+        <%= render Blacklight::HiddenSearchStateComponent.new(params: search_state.params_for_search) %>
+      </div>
+      <div class="modal-footer d-flex flex-row-reverse justify-content-start">
+        <%= f.submit t(:'spotlight.bulk_actions.add'), class: 'btn btn-primary', data: { confirm: t(:'spotlight.bulk_actions.confirm') } %>
+        <button type="button" class="btn btn-link" data-dismiss="modal"><%= t :cancel %></button>
+      </div>
+    </div>
+    <% end %>
+  </div>
+</div>

data/app/views/catalog/_bulk_actions.html.erb

@@ -0,0 +1,12 @@
+<div class="dropdown bulk-actions-dropdown">
+  <button class="btn btn-secondary dropdown-toggle" type="button" id="bulk-actions-button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+    <%= t(:'spotlight.bulk_actions.label') %>
+  </button>
+  <div class="dropdown-menu" aria-labelledby="bulk-actions-button">
+    <% blacklight_config.bulk_actions.each do |key, _config| %>
+      <%= link_to t("spotlight.bulk_actions.#{key}.heading"), '#', class: 'dropdown-item', data: {toggle:"modal", target:"##{key.to_s.dasherize}-modal"} %>
+    <% end %>
+  </div>
+</div>
+
+<%= render_filtered_partials(blacklight_config.bulk_actions) %>

data/app/views/catalog/_change_visibility.html.erb

@@ -0,0 +1,35 @@
+<div class="modal fade" id="change-visibility-modal" tabindex="-1" role="dialog" aria-labelledby="save-modal-label" aria-hidden="true">
+  <div class="modal-dialog">
+  <%= bootstrap_form_for([:change_visibility, current_exhibit], url: change_visibility_exhibit_bulk_actions_path(current_exhibit), method: 'post') do |f| %>
+    <div class="modal-content">
+      <div class="modal-header">
+        <h4 class="modal-title" id="save-modal-label"><%= t(:'spotlight.bulk_actions.change_visibility.heading') %></h4>
+        <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+      <div class="modal-body">
+        <p>
+          <%= t(:'spotlight.bulk_actions.change_visibility.description', count: @response.total) %>
+        </p>
+        <div class="form-check-label">
+          <%= t(:'spotlight.bulk_actions.change_visibility.label') %>
+        </div>
+        <% ['public', 'private'].each do |key| %>
+          <div class="form-check">
+            <%= label_tag "visibility_#{key}", class: 'form-check-label'  do %>
+              <%= radio_button_tag :visibility, key, {}, class: 'form-check-input' %>
+              <%= t(:"spotlight.bulk_actions.change_visibility.#{key}") %>
+            <% end %>
+          </div>
+        <% end %>
+        <%= render Blacklight::HiddenSearchStateComponent.new(params: search_state.params_for_search) %>
+      </div>
+      <div class="modal-footer d-flex flex-row-reverse justify-content-start">
+        <%= f.submit t(:'spotlight.bulk_actions.change'), class: 'btn btn-primary', data: { confirm: t(:'spotlight.bulk_actions.confirm') } %>
+        <button type="button" class="btn btn-link" data-dismiss="modal"><%= t :cancel %></button>
+      </div>
+    </div>
+    <% end %>
+  </div>
+</div>

data/app/views/catalog/_curator_actions.html.erb

@@ -0,0 +1,3 @@
+<div class="curator-actions">
+  <%= render_filtered_partials(blacklight_config.curator_actions) %>
+</div>

data/app/views/catalog/_remove_tags.html.erb

@@ -0,0 +1,37 @@
+<div class="modal fade" id="remove-tags-modal" tabindex="-1" role="dialog" aria-labelledby="remove-tag-modal" aria-hidden="true">
+  <div class="modal-dialog">
+  <%= bootstrap_form_for([:visibility, current_exhibit], url: remove_tags_exhibit_bulk_actions_path(current_exhibit), method: 'post') do |f| %>
+    <div class="modal-content">
+      <div class="modal-header">
+        <h4 class="modal-title" id="remove-tag-modal"><%= t(:'spotlight.bulk_actions.remove_tags.heading') %></h4>
+        <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+          <span aria-hidden="true">&times;</span>
+        </button>
+      </div>
+      <div class="modal-body">
+        <%= t(:'spotlight.bulk_actions.remove_tags.description_html', count: @response.total) %>
+        <% facet = @response.aggregations[blacklight_config.facet_fields['exhibit_tags'].field] %>
+
+        <% if facet.items.any? %>
+          <h5><%= t(:'spotlight.bulk_actions.remove_tags.assigned') %></h5>
+        <% end %>
+        <% facet.items.each do |facet_item| %>
+          <div class="badge badge-info">
+            <%= "#{facet_item.value} (#{facet_item.hits})" %>
+          </div>
+        <% end %>
+
+        <div class="form-group mt-4">
+          <%= label_tag :tags, t(:'spotlight.bulk_actions.remove_tags.label') %>
+          <%= text_field_tag :tags, '', class: 'form-control', data: { autocomplete_tag: true, autocomplete_url: exhibit_tags_path(current_exhibit, format: 'json')} %>
+        </div>
+        <%= render Blacklight::HiddenSearchStateComponent.new(params: search_state.params_for_search) %>
+      </div>
+      <div class="modal-footer d-flex flex-row-reverse justify-content-start">
+        <%= f.submit t(:'spotlight.bulk_actions.remove'), class: 'btn btn-primary', data: { confirm: t(:'spotlight.bulk_actions.confirm') } %>
+        <button type="button" class="btn btn-link" data-dismiss="modal"><%= t :cancel %></button>
+      </div>
+    </div>
+    <% end %>
+  </div>
+</div>