blacklight 7.41.0 → 7.43.0

data/lib/generators/blacklight/assets/sprockets_generator.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Assets
+    class SprocketsGenerator < Rails::Generators::Base
+      class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 4.0'), desc: "Set the generated app's bootstrap version"
+
+      def replace_propshaft_with_sprockets
+        return if defined?(Sprockets)
+
+        # Rails 8+ defaults to Propshaft, but Blacklight 7.x JS requires Sprockets
+        gsub_file 'Gemfile', /^gem ['"]propshaft['"].*$/, '# \0'
+        gem 'sprockets-rails'
+      end
+
+      def add_javascript_dependencies
+        gem 'bootstrap', options[:'bootstrap-version'].presence
+        gem 'jquery-rails'
+        gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
+      end
+
+      def add_sass_support
+        gem "sassc-rails", "~> 2.1" if Rails.version > '7'
+      end
+
+      def setup_sprockets_manifest
+        if !defined?(Sprockets)
+          # Rails 8+ with Propshaft replaced: create Sprockets config from scratch
+          directory = File.expand_path('app/assets/config', destination_root)
+          FileUtils.mkdir_p(directory)
+          create_file 'app/assets/config/manifest.js' do
+            <<~CONTENT
+              //= link_tree ../images
+              //= link_directory ../stylesheets .css
+              //= link application.js
+            CONTENT
+          end
+          empty_directory 'app/assets/images'
+        elsif defined?(Sprockets::VERSION) && Sprockets::VERSION >= '4'
+          append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
+          empty_directory 'app/assets/images'
+        end
+      end
+
+      def assets # rubocop:disable Metrics/MethodLength
+        create_file 'app/assets/stylesheets/blacklight.scss' do
+          <<~CONTENT
+            @import 'bootstrap';
+            @import 'blacklight/blacklight';
+          CONTENT
+        end
+
+        # Ensure application.css is a proper Sprockets manifest that loads blacklight styles
+        application_css = File.expand_path('app/assets/stylesheets/application.css', destination_root)
+        if File.exist?(application_css)
+          content = File.read(application_css)
+          unless content.include?('require blacklight')
+            create_file 'app/assets/stylesheets/application.css', force: true do
+              <<~CONTENT
+                /*
+                 *= require blacklight
+                 *= require_self
+                 */
+              CONTENT
+            end
+          end
+        end
+
+        # Ensure this method is idempotent
+        return if has_blacklight_assets?
+
+        create_file 'app/assets/javascripts/application.js' do
+          <<~CONTENT
+            //= require jquery3
+            //= require rails-ujs
+
+            // Required by Blacklight
+            //= require popper
+            // Twitter Typeahead for autocomplete
+            //= require twitter/typeahead
+            //= require bootstrap
+            //= require blacklight/blacklight
+          CONTENT
+        end
+      end
+
+      private
+
+      def has_blacklight_assets?
+        application_js.include?('blacklight/blacklight')
+      end
+
+      def application_js
+        path = File.expand_path("app/assets/javascripts/application.js", destination_root)
+
+        File.exist?(path) ? File.read(path) : ''
+      end
+    end
+  end
+end

data/lib/generators/blacklight/assets_generator.rb

@@ -1,94 +1,17 @@
 # frozen_string_literal: true
-module Blacklight
-  class Assets < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-
-    class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 4.0'), desc: "Set the generated app's bootstrap version"
-
-    # This could be skipped if you want to use webpacker
-    def add_javascript_dependencies
-      gem 'bootstrap', options[:'bootstrap-version']
-      gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
-    end
-
-    def appease_rails7
-      return unless Rails.version > '7'
-
-      gem "sassc-rails", "~> 2.1"
-    end
-
-    # Add sprockets javascript if needed
-    def create_sprockets_javascript
-      create_file 'app/assets/javascripts/application.js' do
-        <<~CONTENT
-          //= require jquery3
-          //= require rails-ujs
-          #{'//= require turbolinks' if Rails.version < '7'}
-        CONTENT
-      end
-    end
-
-    ##
-    # Remove the empty generated app/assets/images directory. Without doing this,
-    # the default Sprockets 4 manifest will raise an exception.
-    def appease_sprockets4
-      return if !defined?(Sprockets::VERSION) || Sprockets::VERSION < '4' || using_importmap?
-
-      append_to_file 'app/assets/config/manifest.js', "\n//= link application.js\n"
-      empty_directory 'app/assets/images'
-    end
-
-    def assets
-      copy_file "blacklight.scss", "app/assets/stylesheets/blacklight.scss"
-
-      # Ensure this method is idempotent
-      return if has_blacklight_assets?
 
-      gem 'jquery-rails'
-      contents = "\n//\n// Required by Blacklight\n"
-      contents += "//= require popper\n"
-      contents += "// Twitter Typeahead for autocomplete\n"
-      contents += "//= require twitter/typeahead\n"
-      contents += "//= require bootstrap\n"
-      contents += "//= require blacklight/blacklight\n"
+require 'shellwords'
 
-      marker = if turbolinks?
-                 '//= require turbolinks'
-               else
-                 '//= require rails-ujs'
-               end
-
-      insert_into_file "app/assets/javascripts/application.js", after: marker do
-        contents
-      end
-
-      insert_into_file "app/assets/javascripts/application.js", before: '//= require rails-ujs' do
-        "//= require jquery3\n"
-      end
-    end
-
-    private
-
-    def root
-      @root ||= Pathname(destination_root)
-    end
-
-    def using_importmap?
-      @using_importmap ||= root.join('config/importmap.rb').exist?
-    end
-
-    def turbolinks?
-      @turbolinks ||= application_js.include?('turbolinks')
-    end
-
-    def has_blacklight_assets?
-      application_js.include?('blacklight/blacklight')
-    end
+module Blacklight
+  class AssetsGenerator < Rails::Generators::Base
+    class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 4.0'), desc: "Set the generated app's bootstrap version"
 
-    def application_js
-      path = File.expand_path("app/assets/javascripts/application.js", destination_root)
+    def run_asset_pipeline_specific_generator
+      generated_options = "--bootstrap-version='#{Shellwords.escape(options[:'bootstrap-version'])}'" if options[:'bootstrap-version']
 
-      File.exist?(path) ? File.read(path) : ''
+      # Blacklight 7.x JS is distributed via Sprockets (//= require directives, jQuery, etc.)
+      # so we always use the sprockets generator regardless of what Rails defaulted to.
+      generate 'blacklight:assets:sprockets', generated_options
     end
   end
 end

data/lib/generators/blacklight/install_generator.rb

@@ -11,7 +11,7 @@ module Blacklight
     class_option :devise, type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
     class_option :marc, type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo."
     class_option :'bootstrap-version', type: :string, default: nil, desc: "Set the generated app's bootstrap version"
-    class_option :'skip-assets', type: :boolean, default: !defined?(Sprockets), desc: "Skip generating javascript and css assets into the application"
+    class_option :'skip-assets', type: :boolean, default: false, desc: "Skip generating javascript and css assets into the application"
     class_option :'skip-solr', type: :boolean, default: false, desc: "Skip generating solr configurations."
 
     desc <<-EOS
@@ -41,7 +41,7 @@ module Blacklight
 
     def bundle_install
       inside destination_root do
-        Bundler.with_clean_env do
+        Bundler.with_unbundled_env do
           run "bundle install"
         end
       end

data/lib/generators/blacklight/templates/solr/conf/solrconfig.xml

@@ -23,7 +23,7 @@
 
   <dataDir>${solr.data.dir:}</dataDir>
 
-  <requestHandler name="search" class="solr.SearchHandler" default="true">
+  <requestHandler name="/select" class="solr.SearchHandler" default="true">
     <!-- default values for query parameters can be specified, these
          will be overridden by parameters in the request
       -->
@@ -47,7 +47,6 @@
           full_title_tsim
           short_title_tsim
           alternative_title_tsim
-          active_fedora_model_ssi
           title_tsim
           author_tsim
           subject_tsim
@@ -84,7 +83,6 @@
        <str name="facet">true</str>
        <str name="facet.mincount">1</str>
        <str name="facet.limit">10</str>
-       <str name="facet.field">active_fedora_model_ssi</str>
        <str name="facet.field">subject_ssim</str>
 
        <str name="spellcheck">true</str>
@@ -116,7 +114,6 @@
           full_title_tsim
           short_title_tsim
           alternative_title_tsim
-          active_fedora_model_ssi
           title_tsim
           author_tsim
           subject_tsim
@@ -153,7 +150,6 @@
        <str name="facet">true</str>
        <str name="facet.mincount">1</str>
        <str name="facet.limit">10</str>
-       <str name="facet.field">active_fedora_model_ssi</str>
        <str name="facet.field">subject_ssim</str>
 
        <str name="spellcheck">true</str>
@@ -257,8 +253,8 @@
 
   <requestHandler name="/replication" class="solr.ReplicationHandler" startup="lazy" />
 
-  <requestDispatcher handleSelect="true" >
-    <requestParsers enableRemoteStreaming="true" multipartUploadLimitInKB="2048" />
+  <requestDispatcher>
+    <requestParsers multipartUploadLimitInKB="2048" />
   </requestDispatcher>
 
   <requestHandler name="/analysis/field" startup="lazy" class="solr.FieldAnalysisRequestHandler" />

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.41.0",
+  "version": "7.43.0",
   "description": "The frontend code and styles for Blacklight",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {

data/spec/controllers/application_controller_spec.rb

@@ -1,6 +1,29 @@
 # frozen_string_literal: true
 
 RSpec.describe ApplicationController do
+  describe ".log_process_action" do
+    it "appends Solr runtime to the messages ActiveRecord/ActionController already log" do
+      messages = described_class.log_process_action(solr_runtime: 45.3, solr_query_count: 2)
+      expect(messages).to include("Solr: 45.3ms (2 queries)")
+    end
+
+    it "uses singular 'query' for a single Solr request" do
+      messages = described_class.log_process_action(solr_runtime: 12.0, solr_query_count: 1)
+      expect(messages).to include("Solr: 12.0ms (1 query)")
+    end
+
+    it "does not add a message when no Solr request was made" do
+      messages = described_class.log_process_action({})
+      expect(messages.grep(/Solr/)).to be_empty
+    end
+
+    it "does not add a message when the payload reports zero Solr queries" do
+      # Stats#solr_runtime defaults to 0.0 (truthy, never nil) - query count is the real "did Solr get queried" signal.
+      messages = described_class.log_process_action(solr_runtime: 0.0, solr_query_count: 0)
+      expect(messages.grep(/Solr/)).to be_empty
+    end
+  end
+
   describe "#blacklight_config" do
     it "provides a default blacklight_config everywhere" do
       expect(controller.blacklight_config).to eq CatalogController.blacklight_config

data/spec/controllers/blacklight/base_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe Blacklight::Base do
   subject { controller }
 
-  let(:controller) { Deprecation.silence(described_class) { (Class.new(ApplicationController) { include Blacklight::Base }).new } }
+  let(:controller) { Deprecation.silence(described_class) { Class.new(ApplicationController) { include Blacklight::Base }.new } }
 
   describe "#search_state" do
     subject { controller.send(:search_state) }

data/spec/helpers/blacklight/facets_helper_behavior_spec.rb

@@ -231,8 +231,7 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
     context "when one of the facet items is rendered as nil" do
       # An app may override render_facet_item to filter out some undesired facet items by returning nil.
       before do
-        allow(helper.method(:render_facet_item)).to receive(:owner).and_return(self.class)
-        # allow_any_instance_of(Blacklight::FacetItemComponent).to receive(:overridden_helper_methods?).and_return(true)
+        allow_any_instance_of Blacklight::FacetItemComponent.to receive(:overridden_helper_methods?).and_return(true) # rubocop:disable RSpec/AnyInstance
         allow(helper).to receive(:render_facet_item).and_return('<a class="facet-select">Book</a>'.html_safe, nil)
       end
 

data/spec/lib/blacklight/runtime_registry_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::RuntimeRegistry do
+  before { described_class.stats.reset }
+
+  describe ".call" do
+    it "accumulates the event's duration into stats.solr_runtime" do
+      described_class.call("solr_request.blacklight", 0.0, 0.0125, nil, {})
+
+      expect(described_class.stats.solr_runtime).to eq 12.5
+    end
+
+    it "increments stats.solr_query_count" do
+      described_class.call("solr_request.blacklight", 0.0, 0.0125, nil, {})
+      described_class.call("solr_request.blacklight", 0.0, 0.0125, nil, {})
+
+      expect(described_class.stats.solr_query_count).to eq 2
+    end
+  end
+
+  describe ".stats" do
+    it "is thread-local" do
+      described_class.call("solr_request.blacklight", 0.0, 0.0125, nil, {})
+
+      Thread.new { expect(described_class.stats.solr_runtime).to eq 0.0 }.join
+    end
+  end
+
+  describe "Stats#reset" do
+    it "clears the accumulated runtime and query count" do
+      stats = described_class.stats
+      described_class.call("solr_request.blacklight", 0.0, 0.0125, nil, {})
+
+      stats.reset
+
+      expect(stats.solr_runtime).to eq 0.0
+      expect(stats.solr_query_count).to eq 0
+    end
+  end
+
+  describe "subscribed to solr_request.blacklight notifications" do
+    it "fires without raising (Blacklight::Engine subscribes this at boot)" do
+      expect { ActiveSupport::Notifications.instrument("solr_request.blacklight") }.not_to raise_error
+    end
+  end
+end

data/spec/models/blacklight/document/dublin_core_spec.rb

@@ -25,8 +25,8 @@ RSpec.describe "Blacklight::Document::DublinCore" do
   it "includes 'dc:'-prefixed semantic fields" do
     data = { 'id' => '123456', 'title_tsim' => ['654321'] }
     document = @mock_class.new(data)
-    expect(document.export_as_oai_dc_xml).to match  'xmlns:dc="http://purl.org/dc/elements/1.1/"'
-    expect(document.export_as_oai_dc_xml).to match  '<dc:title>654321</dc:title>'
+    expect(document.export_as_oai_dc_xml).to match 'xmlns:dc="http://purl.org/dc/elements/1.1/"'
+    expect(document.export_as_oai_dc_xml).to match '<dc:title>654321</dc:title>'
   end
 
   it "works with multi-value fields" do

data/spec/models/blacklight/solr/repository_spec.rb

@@ -135,6 +135,31 @@ RSpec.describe Blacklight::Solr::Repository, api: true do
       end.and_return('response' => { 'docs' => [] })
       subject.search(input_params)
     end
+
+    it "instruments the request with ActiveSupport::Notifications" do
+      allow(subject.connection).to receive(:send_and_receive).and_return(mock_response)
+
+      payload = nil
+      callback = ->(event) { payload = event.payload }
+      ActiveSupport::Notifications.subscribed(callback, "solr_request.blacklight") do
+        subject.search(params: {})
+      end
+
+      expect(payload).to include(path: 'select', method: :get)
+    end
+
+    it "instruments a json query dsl request as post, regardless of http_method configuration" do
+      blacklight_config.http_method = :get
+      allow(subject.connection).to receive(:send_and_receive).and_return(mock_response)
+
+      payload = nil
+      callback = ->(event) { payload = event.payload }
+      ActiveSupport::Notifications.subscribed(callback, "solr_request.blacklight") do
+        subject.search(params: { json: { query: 'foo' } })
+      end
+
+      expect(payload).to include(method: :post)
+    end
   end
 
   describe "#build_solr_request" do
@@ -214,5 +239,49 @@ RSpec.describe Blacklight::Solr::Repository, api: true do
     subject { repository.ping }
 
     it { is_expected.to be true }
+
+    it "instruments the request with ActiveSupport::Notifications" do
+      payload = nil
+      callback = ->(event) { payload = event.payload }
+      ActiveSupport::Notifications.subscribed(callback, "solr_request.blacklight") do
+        repository.ping
+      end
+
+      expect(payload).to include(path: 'admin/ping', method: :get)
+    end
+  end
+
+  describe "debug logging" do
+    let(:io) { StringIO.new }
+    let(:test_logger) { Logger.new(io, level: Logger::DEBUG) }
+
+    before do
+      allow(Blacklight).to receive(:logger).and_return(test_logger)
+      allow(subject.connection).to receive(:send_and_receive).and_return(mock_response)
+    end
+
+    it "logs the solr query at debug, never at info" do
+      subject.search(params: { q: 'test' })
+
+      expect(io.string).to include("test")
+      expect(io.string).not_to include("INFO")
+    end
+
+    it "does not log the full response by default" do
+      subject.search(params: { q: 'test' })
+
+      expect(io.string).not_to include("Solr response")
+    end
+
+    context "when BLACKLIGHT_VERBOSE_LOGGING is set" do
+      before { stub_const('BLACKLIGHT_VERBOSE_LOGGING', true) }
+
+      it "logs the full response at debug, never at info" do
+        subject.search(params: { q: 'test' })
+
+        expect(io.string).to include("Solr response")
+        expect(io.string).not_to include("INFO")
+      end
+    end
   end
 end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -11,7 +11,7 @@ class TestAppGenerator < Rails::Generators::Base
   def run_blacklight_generator
     say_status("warning", "GENERATING BL", :yellow)
 
-    Bundler.with_clean_env do
+    Bundler.with_unbundled_env do
       run "bundle install"
     end
     options = '--devise'

data/tasks/blacklight.rake

@@ -24,7 +24,7 @@ def with_solr
   # We're being invoked by the app entrypoint script and solr is already up via docker compose
   if ENV['SOLR_ENV'] == 'docker-compose'
     yield
-  elsif system('docker compose -v')
+  elsif system('docker compose version')
     # We're not running `docker compose up' but still want to use a docker instance of solr.
     begin
       puts "Starting Solr"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.41.0
+  version: 7.43.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -14,10 +14,9 @@ authors:
 - Dan Funk
 - Naomi Dushay
 - Justin Coyne
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,7 +27,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,7 +37,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -440,7 +453,10 @@ files:
 - app/assets/images/blacklight/logo.png
 - app/assets/images/blacklight/search.svg
 - app/assets/images/favicon.ico
+- app/assets/javascripts/blacklight/blacklight.esm.js
+- app/assets/javascripts/blacklight/blacklight.esm.js.map
 - app/assets/javascripts/blacklight/blacklight.js
+- app/assets/javascripts/blacklight/blacklight.js.map
 - app/assets/stylesheets/blacklight/_balanced_list.scss
 - app/assets/stylesheets/blacklight/_blacklight_base.scss
 - app/assets/stylesheets/blacklight/_bookmark.scss
@@ -729,6 +745,7 @@ files:
 - app/views/shared/_user_util_links.html.erb
 - blacklight.gemspec
 - config/i18n-tasks.yml
+- config/importmap.rb
 - config/locales/blacklight.ar.yml
 - config/locales/blacklight.ca.yml
 - config/locales/blacklight.de.yml
@@ -762,10 +779,12 @@ files:
 - lib/blacklight/configuration/sort_field.rb
 - lib/blacklight/configuration/tool_config.rb
 - lib/blacklight/configuration/view_config.rb
+- lib/blacklight/controller_runtime.rb
 - lib/blacklight/deprecations/engine_configuration.rb
 - lib/blacklight/deprecations/search_state_normalization.rb
 - lib/blacklight/engine.rb
 - lib/blacklight/exceptions.rb
+- lib/blacklight/log_subscriber.rb
 - lib/blacklight/nested_open_struct_with_hash_access.rb
 - lib/blacklight/open_struct_with_hash_access.rb
 - lib/blacklight/parameters.rb
@@ -792,6 +811,9 @@ files:
 - lib/blacklight/solr/response/spelling.rb
 - lib/blacklight/solr/search_builder_behavior.rb
 - lib/blacklight/version.rb
+- lib/generators/blacklight/assets/importmap_generator.rb
+- lib/generators/blacklight/assets/propshaft_generator.rb
+- lib/generators/blacklight/assets/sprockets_generator.rb
 - lib/generators/blacklight/assets_generator.rb
 - lib/generators/blacklight/controller_generator.rb
 - lib/generators/blacklight/document_generator.rb
@@ -904,6 +926,7 @@ files:
 - spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb
 - spec/lib/blacklight/open_struct_with_hash_access_spec.rb
 - spec/lib/blacklight/parameters_spec.rb
+- spec/lib/blacklight/runtime_registry_spec.rb
 - spec/lib/blacklight/search_state/filter_field_spec.rb
 - spec/lib/blacklight/search_state_spec.rb
 - spec/lib/blacklight_spec.rb
@@ -997,7 +1020,6 @@ homepage: http://projectblacklight.org/
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -1012,8 +1034,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
   index.
@@ -1094,6 +1115,7 @@ test_files:
 - spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb
 - spec/lib/blacklight/open_struct_with_hash_access_spec.rb
 - spec/lib/blacklight/parameters_spec.rb
+- spec/lib/blacklight/runtime_registry_spec.rb
 - spec/lib/blacklight/search_state/filter_field_spec.rb
 - spec/lib/blacklight/search_state_spec.rb
 - spec/lib/blacklight_spec.rb