RUBY-1021 Ensure options merged with client options are Options::Redacted instances

Author: estolfo

lib/mongo/client.rb

@@ -185,7 +185,7 @@ def inspect
     #
     # @since 2.0.0
     def read_preference
-      @read_preference ||= ServerSelector.get((options[:read] || {}).merge(options))
+      @read_preference ||= ServerSelector.get(Options::Redacted.new(options[:read] || {}).merge(options))
     end
 
     # Use the database with the provided name. This will switch the current

lib/mongo/cluster.rb

@@ -125,7 +125,7 @@ def inspect
     #
     # @since 2.0.0
     def next_primary
-      ServerSelector.get({ mode: :primary }.merge(options)).select_server(self)
+      ServerSelector.get(Options::Redacted.new({ mode: :primary }.merge(options))).select_server(self)
     end
 
     # Elect a primary server from the description that has just changed to a

lib/mongo/collection/view/readable.rb

@@ -298,7 +298,8 @@ def projection(document = nil)
         # @since 2.0.0
         def read(value = nil)
           return default_read if value.nil?
-          configure(:read, value.is_a?(Hash) ? ServerSelector.get(value) : value)
+          selector = value.is_a?(Hash) ? ServerSelector.get(Options::Redacted.new(value.merge(client.options))) : value
+          configure(:read, selector)
         end
 
         # Set whether to return only the indexed field or fields.

lib/mongo/database.rb

@@ -148,12 +148,7 @@ def collections
     #
     # @return [ Hash ] The result of the command execution.
     def command(operation, opts = {})
-      if opts[:read]
-        preference = ServerSelector.get(Options::Redacted.new(
-                                            opts[:read]).merge(options))
-      else
-        preference = read_preference
-      end
+      preference = opts[:read] ? ServerSelector.get(Options::Redacted.new(opts[:read].merge(options))) : read_preference
       server = preference.select_server(cluster)
       Operation::Command.new({
         :selector => operation,

lib/mongo/grid/fs_bucket.rb

@@ -395,7 +395,7 @@ def upload_from_stream(filename, io, opts = {})
       # @since 2.1.0
       def read_preference
         @read_preference ||= @options[:read] ?
-            ServerSelector.get((@options[:read] || {}).merge(database.options)) :
+            ServerSelector.get(Options::Redacted.new((@options[:read] || {}).merge(database.options))) :
             database.read_preference
       end
 

lib/mongo/grid/stream/read.rb

@@ -134,7 +134,7 @@ def closed?
           # @since 2.1.0
           def read_preference
             @read_preference ||= @options[:read] ?
-                ServerSelector.get((@options[:read] || {}).merge(fs.options)) :
+                ServerSelector.get(Options::Redacted.new((@options[:read] || {}).merge(fs.options))) :
                 fs.read_preference
           end
 

lib/mongo/server_selector/selectable.rb

@@ -61,10 +61,10 @@ def ==(other)
       #
       # @since 2.0.0
       def initialize(options = {})
+        @options = (options || {}).freeze
         tag_sets = options[:tag_sets] || []
         validate_tag_sets!(tag_sets)
-        @tag_sets = tag_sets
-        @options = options
+        @tag_sets = tag_sets.freeze
       end
 
       # Select a server from eligible candidates.

spec/mongo/client_spec.rb

@@ -167,15 +167,15 @@
         ['127.0.0.1:27017'],
         :read => { :mode => :primary },
         :local_threshold_ms => 10,
-        :server_selection_timeout_ms => 10000,
+        :server_selection_timeout => 10000,
         :database => TEST_DB
       )
     end
 
     let(:options) do
       Mongo::Options::Redacted.new(:read => { :mode => :primary },
                                     :local_threshold_ms => 10,
-                                    :server_selection_timeout_ms => 10000,
+                                    :server_selection_timeout => 10000,
                                     :database => TEST_DB)
     end
 
@@ -364,7 +364,8 @@
     let(:client) do
       described_class.new(['127.0.0.1:27017'],
                           :database => TEST_DB,
-                          :read => mode)
+                          :read => mode,
+                          :server_selection_timeout => 2)
     end
 
     let(:preference) do
@@ -382,7 +383,7 @@
       end
 
       it 'passes the options to the read preference' do
-        expect(preference.options[:database]).to eq(TEST_DB)
+        expect(preference.options[:server_selection_timeout]).to eq(2)
       end
     end
 
@@ -440,6 +441,33 @@
         expect(preference).to be_a(Mongo::ServerSelector::Primary)
       end
     end
+
+    context 'when the read preference is printed' do
+
+      let(:client) do
+        described_class.new([ DEFAULT_ADDRESS ], options)
+      end
+
+      let(:options) do
+        { user: 'Emily', password: 'sensitive_data', server_selection_timeout: 0.1 }
+      end
+
+      before do
+        allow(client.database.cluster).to receive(:single?).and_return(false)
+      end
+
+      let(:error) do
+        begin
+          client.database.command(ping: 1)
+        rescue => e
+          e
+        end
+      end
+
+      it 'redacts sensitive client options' do
+        expect(error.message).not_to match(options[:password])
+      end
+    end
   end
 
   describe '#use' do

spec/mongo/grid/fs_bucket_spec.rb

@@ -55,7 +55,7 @@
         end
 
         let(:read_pref) do
-          Mongo::ServerSelector.get(options[:read].merge(authorized_client.options))
+          Mongo::ServerSelector.get(Mongo::Options::Redacted.new(options[:read].merge(authorized_client.options)))
         end
 
         it 'sets the read preference' do