Refactor SearchBuilder search logic customizations for Blacklight 9.0.0.beta8

This seems to be what it requires of us. Under discussion in projectblacklight/blacklight#3762 it is somewhat possible it will change before 9.0.0 final, although some people strongly prefer it this way.

Author: jrochkind

app/controllers/collection_show_controller.rb

@@ -40,7 +40,11 @@ def blacklight_config
   configure_blacklight do |config|
     # Our custom sub-class to limit just to docs in collection, with collection id
     # taken from params[:collection_id]
+    #
+    # Blacklight 9 requires this logic to be duplicated in two parallel search builder
+    # classes, see https://github.com/projectblacklight/blacklight/pull/3762
     config.search_builder_class = ::SearchBuilder::WithinCollectionBuilder
+    config.facet_search_builder_class = ::SearchBuilder::WithinCollectionFacetBuilder
 
     # and we need to make sure collection_id is allowed by BL, don't totally
     # understand this, as of BL 7.25

app/controllers/featured_topic_controller.rb

@@ -4,7 +4,9 @@ class FeaturedTopicController < CatalogController
 
   configure_blacklight do |config|
     # Limit just to items in the featured topic.
+    # For Blacklight 9, we need to do this in two classes.
     config.search_builder_class = ::SearchBuilder::WithinFeaturedTopicBuilder
+    config.facet_search_builder_class = ::SearchBuilder::WithinFeaturedTopicFacetBuilder
 
     # And we need to make sure the :slug param is allowed by blacklight,
     # don't totally understand why, as of BL 7.25

app/models/concerns/search_builder_behavior.rb

@@ -0,0 +1,28 @@
+# Blacklight 9 requires all local custom SearchBuilder logic to be duplicated in two
+# places, also into a corresponding FacetSearchBuilder class. So we do it here, so
+# it can be done in two places DRY.  Sorry for increase of complexity.
+#
+# See https://github.com/projectblacklight/blacklight/pull/3762
+module SearchBuilderBehavior
+  extend ActiveSupport::Concern
+
+  # For blacklight_range_limit plugin
+  include BlacklightRangeLimit::RangeLimitBuilder
+
+  # Scihist SearchBuilder extensions
+  include SearchBuilder::AccessControlFilter
+  include SearchBuilder::AdminOnlySearchFields
+  include SearchBuilder::CustomSortLogic
+  include SearchBuilder::AllSearchResultIdsBuilder
+
+  ##
+  # @example Adding a new step to the processor chain
+  #
+  #   included do
+  #     self.default_processor_chain += [:add_custom_data_to_query]
+  #   end
+  #
+  #   def add_custom_data_to_query(solr_parameters)
+  #     solr_parameters[:custom] = blacklight_params[:user_value]
+  #   end
+end

app/models/concerns/within_collection_builder_behavior.rb

@@ -0,0 +1,53 @@
+# Applies a limit to search just within a given collection, filtering on solr
+# field where we've stored the containing collection ids.
+#
+# :collection_id needs to be provided in context, the actual UUID pk of collection,
+# since that's what we index.
+#
+# Used on CollectionShowController search within a collection
+#
+# Blacklight 9 requires all custom search builder logic to be duplicated in a FacetSearchBuilder,
+# so it lives here to keep it DRY.
+# See https://github.com/projectblacklight/blacklight/pull/3762
+module WithinCollectionBuilderBehavior
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :collection_id_solr_field, default: "collection_id_ssim"
+    class_attribute :box_id_solr_field,        default: "box_tsi"
+    class_attribute :folder_id_solr_field,     default: "folder_tsi"
+
+    self.default_processor_chain += [:within_collection]
+  end
+
+  def within_collection(solr_parameters)
+    solr_parameters[:fq] ||= []
+    solr_parameters[:fq] << "{!term f=#{collection_id_solr_field}}#{collection_id}"
+    solr_parameters[:fq] << "#{box_id_solr_field}:(#{box_id})" if box_id.present?
+    solr_parameters[:fq] << "#{folder_id_solr_field}:(#{folder_id})" if folder_id.present?
+  end
+
+  private
+
+  # Overrides CustomSortLogic#default_sort_order
+  def default_sort_order
+    scope.context.dig(:collection_default_sort_order) || super
+  end
+
+  def collection_id
+    scope.context.fetch(:collection_id)
+  end
+
+  def box_id
+    safe_solr_escape scope.context.fetch :box_id
+  end
+
+  def folder_id
+    safe_solr_escape scope.context.fetch :folder_id
+  end
+
+  def safe_solr_escape str
+    RSolr.solr_escape str unless str.nil?
+  end
+
+end

app/models/concerns/within_featured_topic_builder_behavior.rb

@@ -0,0 +1,22 @@
+# Applies a limit to search just within a given featured topic.
+#
+# :slug needs to be provided in context.
+#
+# Used on FeaturedTopicController.
+# Blacklight 9 requires all custom search builder logic to be duplicated in a FacetSearchBuilder,
+# so it lives here to keep it DRY.
+#
+# See https://github.com/projectblacklight/blacklight/pull/3762
+module WithinFeaturedTopicBuilderBehavior
+  extend ActiveSupport::Concern
+
+  included do
+    self.default_processor_chain += [:within_featured_topic]
+  end
+
+  def within_featured_topic(solr_parameters)
+    featured_topic = FeaturedTopic.from_slug(blacklight_params[:slug])
+    solr_parameters[:fq] ||= []
+    solr_parameters[:fq] << featured_topic.solr_fq
+  end
+end

app/models/search_builder.rb

@@ -1,25 +1,10 @@
 # frozen_string_literal: true
 #
-# TODO: chf_sufia mixin's or equivalents for:
-# * SearchBuilder::RestrictAdminSearchFields => Makes sure admin notes are only searchable if logged in
-# * SearchBuilder::SyntheticCategoryLimit => something with making our 'topics'/synthetic categories
-#   work as limits, probably just for showing the main page for a 'topic'
+# Blacklight 9 requires all custom search builder logic to be duplicated in a FacetSearchBuilder,
+# so please do all customization in the `SearchBuilderBehavior` module so it can be kept DRY.
+# See https://github.com/projectblacklight/blacklight/pull/3762
 class SearchBuilder < Blacklight::SearchBuilder
   include Blacklight::Solr::SearchBuilderBehavior
-  include BlacklightRangeLimit::RangeLimitBuilder
 
-
-  # Scihist SearchBuilder extensions
-  include SearchBuilder::AccessControlFilter
-  include SearchBuilder::AdminOnlySearchFields
-  include SearchBuilder::CustomSortLogic
-  include SearchBuilder::AllSearchResultIdsBuilder
-
-  ##
-  # @example Adding a new step to the processor chain
-  #   self.default_processor_chain += [:add_custom_data_to_query]
-  #
-  #   def add_custom_data_to_query(solr_parameters)
-  #     solr_parameters[:custom] = blacklight_params[:user_value]
-  #   end
+  include SearchBuilderBehavior
 end

app/models/search_builder/within_collection_builder.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class SearchBuilder
   # Applies a limit to search just within a given collection, filtering on solr
   # field where we've stored the containing collection ids.
@@ -7,42 +8,12 @@ class SearchBuilder
   # since that's what we index.
   #
   # Used on CollectionShowController search within a collection
+  #
+  # Blacklight 9 requires all custom search builder logic to be duplicated in a FacetSearchBuilder,
+  # so all logic is located in the `WithinCollectionBuilderBehavior` module so it can be kept DRY.
+  # See https://github.com/projectblacklight/blacklight/pull/3762
+  #
   class WithinCollectionBuilder < ::SearchBuilder
-    class_attribute :collection_id_solr_field, default: "collection_id_ssim"
-    class_attribute :box_id_solr_field,        default: "box_tsi"
-    class_attribute :folder_id_solr_field,     default: "folder_tsi"
-
-    self.default_processor_chain += [:within_collection]
-
-    def within_collection(solr_parameters)
-      solr_parameters[:fq] ||= []
-      solr_parameters[:fq] << "{!term f=#{collection_id_solr_field}}#{collection_id}"
-      solr_parameters[:fq] << "#{box_id_solr_field}:(#{box_id})" if box_id.present?
-      solr_parameters[:fq] << "#{folder_id_solr_field}:(#{folder_id})" if folder_id.present?
-    end
-
-    private
-
-    # Overrides CustomSortLogic#default_sort_order
-    def default_sort_order
-      scope.context.dig(:collection_default_sort_order) || super
-    end
-
-    def collection_id
-      scope.context.fetch(:collection_id)
-    end
-
-    def box_id
-      safe_solr_escape scope.context.fetch :box_id
-    end
-
-    def folder_id
-      safe_solr_escape scope.context.fetch :folder_id
-    end
-
-    def safe_solr_escape str
-      RSolr.solr_escape str unless str.nil?
-    end
-
+    include WithinCollectionBuilderBehavior
   end
 end

app/models/search_builder/within_featured_topic_builder.rb

@@ -4,15 +4,8 @@ class SearchBuilder
   # :slug needs to be provided in context.
   #
   # Used on FeaturedTopicController.
+  #
   class WithinFeaturedTopicBuilder < ::SearchBuilder
-    extend ActiveSupport::Concern
-
-    self.default_processor_chain += [:within_featured_topic]
-
-    def within_featured_topic(solr_parameters)
-      featured_topic = FeaturedTopic.from_slug(blacklight_params[:slug])
-      solr_parameters[:fq] ||= []
-      solr_parameters[:fq] << featured_topic.solr_fq
-    end
+    include WithinFeaturedTopicBuilderBehavior
   end
 end