Skip to content

Stop looking in the Solr response to determine the request params #3632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Stop looking in the Solr response to determine the request params #3632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions lib/blacklight/solr/response/params.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,7 @@ def params
header['params'] || request_params
end

def start
search_builder&.start || single_valued_param(:start).to_i
end

def rows
search_builder&.rows || single_valued_param(:rows).to_i
end

def sort
search_builder&.sort || single_valued_param(:sort)
end
delegate :start, :rows, :sort, to: :search_builder
Copy link
Contributor

@barmintor barmintor Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this require search_builder to exist? I think it can still be nil. Should the initializer for B::S::Response create one if it's missing from the params (ie, if a hash or nil is passed as second arg)?

Copy link
Member Author

@jcoyne jcoyne Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does require search_builder to exist. Can you explain which case it would not exist? The search builder is initialized in the initializer for Blacklight::Solr::Response.

Copy link
Contributor

@cgalarza cgalarza Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The search_builder is only initialized if the request_params are a Blacklight::SearchBuilder. I didn't see another place where the search_builder is created in Blacklight::Solr::Response. https://github.com/projectblacklight/blacklight/blob/main/lib/blacklight/solr/response.rb#L19


def facet_field_aggregation_options(facet_field_name)
defaults = {
Expand Down
45 changes: 7 additions & 38 deletions spec/models/blacklight/solr/response_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,19 @@
RSpec.describe Blacklight::Solr::Response, :api do
subject(:r) do
described_class.new(raw_response,
request_params,
search_builder,
blacklight_config: config)
end

let(:raw_response) { eval(mock_query_response) }

let(:config) { Blacklight::Configuration.new }
let(:request_params) { raw_response['params'] }
let(:search_builder) do
Blacklight::SearchBuilder.new(view_context).tap { |b| b.rows = 11 }
end
let(:view_context) do
double("View context", blacklight_config: config)
end

it 'creates a valid response' do
expect(r).to respond_to(:header)
Expand Down Expand Up @@ -147,42 +152,13 @@
end
end

context 'with json params' do
let(:raw_response) do
eval(mock_response_with_spellcheck).tap do |resp|
resp['responseHeader']['params']['test'] = 'from query'
resp['responseHeader']['params'].delete('rows')
resp['responseHeader']['params']['json'] = { limit: 5, params: { test: 'from json params' } }.to_json
end
end

it 'extracts json params' do
expect(r.params['test']).to eq 'from query'
expect(r.rows).to eq 5
end
end

it 'provides the solr-returned params and "rows" should be 11' do
expect(r.params[:rows].to_s).to eq '11'
expect(r.params[:sort]).to eq 'title_si asc, pub_date_si desc'
end

context 'when responseHeader["params"] does not exist' do
before do
raw_response.delete 'responseHeader'
end

let(:request_params) { { rows: 999, sort: 'score desc, pub_date_si desc, title_si asc' } }

it 'provides the ruby request params' do
expect(r.params[:rows].to_s).to eq '999'
expect(r.params[:sort]).to eq 'score desc, pub_date_si desc, title_si asc'
end
end

context 'with regular spellcheck results' do
let(:raw_response) { eval(mock_response_with_spellcheck) }
let(:request_params) { {} }

it 'provides spelling suggestions' do
expect(r.spelling.words).to include("dell")
Expand All @@ -192,7 +168,6 @@

context 'with extended spellcheck results' do
let(:raw_response) { eval(mock_response_with_spellcheck_extended) }
let(:request_params) { {} }

it 'provides spelling suggestions' do
expect(r.spelling.words).to include("dell")
Expand All @@ -202,7 +177,6 @@

context 'when extended results and suggestion frequency is the same as original query frequency' do
let(:raw_response) { eval(mock_response_with_spellcheck_same_frequency) }
let(:request_params) { {} }

it 'provides no spelling suggestions' do
expect(r.spelling.words).to eq []
Expand All @@ -211,7 +185,6 @@

context "with pre solr 5 spellcheck collation syntax" do
let(:raw_response) { eval(mock_response_with_spellcheck_collation) }
let(:request_params) { {} }

it 'provides spelling suggestions for a regular spellcheck results with a collation' do
expect(r.spelling.words).to include("dell")
Expand All @@ -225,7 +198,6 @@

context "with solr 5 spellcheck collation syntax" do
let(:raw_response) { eval(mock_response_with_spellcheck_collation_solr5) }
let(:request_params) { {} }

it 'provides spelling suggestions for a regular spellcheck results with a collation' do
expect(r.spelling.words).to include("dell")
Expand All @@ -239,7 +211,6 @@

context 'with solr 6.5 spellcheck collation syntax' do
let(:raw_response) { eval(mock_response_with_spellcheck_collation_solr65) }
let(:request_params) { {} }

it 'provides spelling suggestions for a regular spellcheck results with a collation' do
expect(r.spelling.words).to include("dell")
Expand All @@ -249,7 +220,6 @@

context 'with moreLikeThis suggstions' do
let(:raw_response) { eval(mock_response_with_more_like_this) }
let(:request_params) { {} }

it "provides MoreLikeThis suggestions" do
expect(r.more_like(double(id: '79930185'))).to have(2).items
Expand All @@ -258,7 +228,6 @@

context 'with no results' do
let(:raw_response) { {} }
let(:request_params) { {} }

it "is empty when the response has no results" do
expect(r).to be_empty
Expand Down