Skip to content

RUBY-1595 Improve error reporting when symbol/string is passed as read preference #2582

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

Merged
neilshweky merged 3 commits into from
Aug 5, 2022
Merged

RUBY-1595 Improve error reporting when symbol/string is passed as read preference #2582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
542253c
RUBY-1595 Improve error reporting when symbol/string is passed as rea…
neilshweky Aug 3, 2022
45af48c
tweak wording
p Aug 4, 2022
673b46f
RUBY-1595 fix tests
neilshweky Aug 4, 2022
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
2 changes: 1 addition & 1 deletion lib/mongo/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1576,7 +1576,7 @@ def validate_read!(option, opts)
# for custom classes implementing key access ([]).
# Instead reject common cases of strings and symbols.
if read.is_a?(String) || read.is_a?(Symbol)
raise Error::InvalidReadOption.new(read, 'must be a hash')
raise Error::InvalidReadOption.new(read, "the read preference must be specified as a hash: { mode: #{read.inspect} }")
end

if mode = read[:mode]
Expand Down
2 changes: 1 addition & 1 deletion lib/mongo/error/invalid_read_option.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class InvalidReadOption < Error
#
# @since 2.6.0
def initialize(read_option, msg)
super("Invalid read option: #{read_option}: #{msg}")
super("Invalid read preference value: #{read_option.inspect}: #{msg}")
end
end
end
Expand Down
8 changes: 4 additions & 4 deletions spec/mongo/client_construction_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1773,28 +1773,28 @@
expect do
client = new_local_client_nmio(['127.0.0.1:27017'],
:read => {:mode => :bogus})
end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read option: {"mode"=>:bogus}: mode bogus is not one of recognized modes')
end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read preference value: {"mode"=>:bogus}: mode bogus is not one of recognized modes')
end

it 'rejects bogus read preference as string' do
expect do
client = new_local_client_nmio(['127.0.0.1:27017'],
:read => {:mode => 'bogus'})
end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read option: {"mode"=>"bogus"}: mode bogus is not one of recognized modes')
end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read preference value: {"mode"=>"bogus"}: mode bogus is not one of recognized modes')
end

it 'rejects read option specified as a string' do
expect do
client = new_local_client_nmio(['127.0.0.1:27017'],
:read => 'primary')
end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read option: primary: must be a hash')
end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read preference value: "primary": the read preference must be specified as a hash: { mode: "primary" }')
end

it 'rejects read option specified as a symbol' do
expect do
client = new_local_client_nmio(['127.0.0.1:27017'],
:read => :primary)
end.to raise_error(Mongo::Error::InvalidReadOption, 'Invalid read option: primary: must be a hash')
end.to raise_error(Mongo::Error::InvalidReadOption, "Invalid read preference value: :primary: the read preference must be specified as a hash: { mode: :primary }")
end
end
end
Expand Down