mongo 1.12.5 → 2.0.0

data/lib/mongo/server_selector/secondary.rb

@@ -0,0 +1,91 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+
+  module ServerSelector
+
+    # Encapsulates specifications for selecting secondary servers given a list
+    #   of candidates.
+    #
+    # @since 2.0.0
+    class Secondary
+      include Selectable
+
+      # Get the name of the server mode type.
+      #
+      # @example Get the name of the server mode for this preference.
+      #   preference.name
+      #
+      # @return [ Symbol ] :secondary
+      #
+      # @since 2.0.0
+      def name
+        :secondary
+      end
+
+      # Whether the slaveOk bit should be set on wire protocol messages.
+      #   I.e. whether the operation can be performed on a secondary server.
+      #
+      # @return [ true ] true
+      #
+      # @since 2.0.0
+      def slave_ok?
+        true
+      end
+
+      # Whether tag sets are allowed to be defined for this server preference.
+      #
+      # @return [ true ] true
+      #
+      # @since 2.0.0
+      def tags_allowed?
+        true
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for a mongos server.
+      #
+      # @example Convert this server preference definition into a format
+      #   for mongos.
+      #   preference = Mongo::ServerSelector::Secondary.new
+      #   preference.to_mongos
+      #
+      # @return [ Hash ] The server preference formatted for a mongos server.
+      #
+      # @since 2.0.0
+      def to_mongos
+        preference = { :mode => 'secondary' }
+        preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+        preference
+      end
+
+      private
+
+      # Select the secondary servers taking into account any defined tag sets and
+      #   local threshold between the nearest secondary and other secondaries.
+      #
+      # @example Select secondary servers given a list of candidates.
+      #   preference = Mongo::ServerSelector::Secondary.new
+      #   preference.select([candidate_1, candidate_2])
+      #
+      # @return [ Array ] The secondary servers from the list of candidates.
+      #
+      # @since 2.0.0
+      def select(candidates)
+        near_servers(secondaries(candidates))
+      end
+    end
+  end
+end

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -0,0 +1,96 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+
+  module ServerSelector
+
+    # Encapsulates specifications for selecting servers, with
+    #   secondaries preferred, given a list of candidates.
+    #
+    # @since 2.0.0
+    class SecondaryPreferred
+      include Selectable
+
+      # Get the name of the server mode type.
+      #
+      # @example Get the name of the server mode for this preference.
+      #   preference.name
+      #
+      # @return [ Symbol ] :secondary_preferred
+      #
+      # @since 2.0.0
+      def name
+        :secondary_preferred
+      end
+
+      # Whether the slaveOk bit should be set on wire protocol messages.
+      #   I.e. whether the operation can be performed on a secondary server.
+      #
+      # @return [ true ] true
+      #
+      # @since 2.0.0
+      def slave_ok?
+        true
+      end
+
+      # Whether tag sets are allowed to be defined for this server preference.
+      #
+      # @return [ true ] true
+      #
+      # @since 2.0.0
+      def tags_allowed?
+        true
+      end
+
+      # Convert this server preference definition into a format appropriate
+      #   for a mongos server.
+      # Note that the server preference is not sent to mongos as part of the query
+      #   selector if there are no tag sets, for maximum backwards compatibility.
+      #
+      # @example Convert this server preference definition into a format
+      #   for mongos.
+      #   preference = Mongo::ServerSelector::SecondaryPreferred.new
+      #   preference.to_mongos
+      #
+      # @return [ Hash ] The server preference formatted for a mongos server.
+      #
+      # @since 2.0.0
+      def to_mongos
+        return nil if tag_sets.empty?
+        preference = { mode: 'secondaryPreferred' }
+        preference.merge!({ tags: tag_sets })
+        preference
+      end
+
+      private
+
+      # Select servers taking into account any defined tag sets and
+      #   local threshold, with secondaries.
+      #
+      # @example Select servers given a list of candidates,
+      #   with secondaries preferred.
+      #   preference = Mongo::ServerSelector::SecondaryPreferred.new
+      #   preference.select([candidate_1, candidate_2])
+      #
+      # @return [ Array ] A list of servers matching tag sets and acceptable
+      #   latency with secondaries preferred.
+      #
+      # @since 2.0.0
+      def select(candidates)
+        near_servers(secondaries(candidates)) + primary(candidates)
+      end
+    end
+  end
+end

data/lib/mongo/server_selector/selectable.rb

@@ -0,0 +1,209 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  module ServerSelector
+
+    # Provides common behavior for filtering a list of servers by server mode or tag set.
+    #
+    # @since 2.0.0
+    module Selectable
+
+      # The max latency in seconds between the closest server and other servers
+      # considered for selection.
+      #
+      # @since 2.0.0
+      LOCAL_THRESHOLD = 0.015.freeze
+
+      # How long to block for server selection before throwing an exception.
+      #
+      # @since 2.0.0
+      SERVER_SELECTION_TIMEOUT = 30.freeze
+
+      # @return [ Hash ] options The options.
+      attr_reader :options
+
+      # @return [ Array ] tag_sets The tag sets used to select servers.
+      attr_reader :tag_sets
+
+      # Check equality of two server selector.
+      #
+      # @example Check server selector equality.
+      #   preference == other
+      #
+      # @param [ Object ] other The other preference.
+      #
+      # @return [ true, false ] Whether the objects are equal.
+      #
+      # @since 2.0.0
+      def ==(other)
+        name == other.name && tag_sets == other.tag_sets
+      end
+
+      # Initialize the server selector.
+      #
+      # @example Initialize the preference with tag sets.
+      #   Mongo::ServerSelector::Secondary.new([{ 'tag' => 'set' }])
+      #
+      # @example Initialize the preference with no options.
+      #   Mongo::ServerSelector::Secondary.new
+      #
+      # @param [ Array ] tag_sets The tag sets used to select servers.
+      #
+      # @todo: document specific error
+      # @raise [ Exception ] If tag sets are specified but not allowed.
+      #
+      # @since 2.0.0
+      def initialize(tag_sets = [], options = {})
+        if !tag_sets.all? { |set| set.empty? } && !tags_allowed?
+          raise ServerSelector::InvalidServerPreference.new(name)
+        end
+        @tag_sets = tag_sets
+        @options = options
+      end
+
+      # Select a server from eligible candidates.
+      #
+      # @example Select a server from the cluster.
+      #   selector.select_server(cluster)
+      #
+      # @param [ Mongo::Cluster ] cluster The cluster from which to select an eligible server.
+      #
+      # @return [ Mongo::Server ] A server matching the server preference.
+      #
+      # @since 2.0.0
+      def select_server(cluster)
+        deadline = Time.now + server_selection_timeout
+        while (deadline - Time.now) > 0
+          if cluster.standalone?
+            servers = cluster.servers
+          elsif cluster.sharded?
+            servers = near_servers(cluster.servers)
+          else
+            servers = select(cluster.servers)
+          end
+          return servers.first if servers && !servers.compact.empty?
+          cluster.scan!
+        end
+        raise NoServerAvailable.new(self)
+      end
+
+      # Get the timeout for server selection.
+      #
+      # @example Get the server selection timeout, in seconds.
+      #   selector.server_selection_timeout
+      #
+      # @return [ Float ] The timeout.
+      #
+      # @since 2.0.0
+      def server_selection_timeout
+        @server_selection_timeout ||=
+          (options[:server_selection_timeout] || SERVER_SELECTION_TIMEOUT)
+      end
+
+      # Get the local threshold boundary for nearest selection in seconds.
+      #
+      # @example Get the local threshold.
+      #   selector.local_threshold
+      #
+      # @return [ Float ] The local threshold.
+      #
+      # @since 2.0.0
+      def local_threshold
+        @local_threshold ||= (options[:local_threshold] || LOCAL_THRESHOLD)
+      end
+
+      private
+
+      # Select the primary from a list of provided candidates.
+      #
+      # @param [ Array ] candidates List of candidate servers to select the
+      #   primary from.
+      #
+      # @return [ Array ] The primary.
+      #
+      # @since 2.0.0
+      def primary(candidates)
+        candidates.select do |server|
+          server.primary? || server.standalone?
+        end
+      end
+
+      # Select the secondaries from a list of provided candidates.
+      #
+      # @param [ Array ] candidates List of candidate servers to select the
+      #   secondaries from.
+      #
+      # @return [ Array ] The secondary servers.
+      #
+      # @since 2.0.0
+      def secondaries(candidates)
+        matching_servers = candidates.select(&:secondary?)
+        matching_servers = match_tag_sets(matching_servers) unless tag_sets.empty?
+        matching_servers
+      end
+
+      # Select the near servers from a list of provided candidates, taking the
+      #   local threshold into account.
+      #
+      # @param [ Array ] candidates List of candidate servers to select the
+      #   near servers from.
+      #
+      # @return [ Array ] The near servers.
+      #
+      # @since 2.0.0
+      def near_servers(candidates = [])
+        return candidates if candidates.empty?
+        nearest_server = candidates.min_by(&:average_round_trip_time)
+        threshold = nearest_server.average_round_trip_time + (local_threshold * 1000)
+        candidates.select { |server| server.average_round_trip_time <= threshold }.shuffle!
+      end
+
+      # Select the servers matching the defined tag sets.
+      #
+      # @param [ Array ] candidates List of candidate servers from which those
+      #   matching the defined tag sets should be selected.
+      #
+      # @return [ Array ] The servers matching the defined tag sets.
+      #
+      # @since 2.0.0
+      def match_tag_sets(candidates)
+        matches = []
+        tag_sets.find do |tag_set|
+          matches = candidates.select { |server| server.matches_tag_set?(tag_set) }
+          !matches.empty?
+        end
+        matches || []
+      end
+    end
+
+    # Raised when an invalid server preference is provided.
+    #
+    # @since 2.0.0
+    class InvalidServerPreference < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::ServerSelector::InvalidServerPreference.new
+      #
+      # @param [ String ] name The preference name.
+      #
+      # @since 2.0.0
+      def initialize(name)
+        super("This server preference #{name} cannot be combined with tags.")
+      end
+    end
+  end
+end

data/lib/mongo/server_selector.rb

@@ -0,0 +1,81 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'mongo/server_selector/selectable'
+require 'mongo/server_selector/nearest'
+require 'mongo/server_selector/primary'
+require 'mongo/server_selector/primary_preferred'
+require 'mongo/server_selector/secondary'
+require 'mongo/server_selector/secondary_preferred'
+
+module Mongo
+
+  # Functionality for getting an object able to select a server, given a preference.
+  #
+  # @since 2.0.0
+  module ServerSelector
+    extend self
+
+    # Hash lookup for the selector classes based off the symbols
+    #   provided in configuration.
+    #
+    # @since 2.0.0
+    PREFERENCES = {
+        nearest: Nearest,
+        primary: Primary,
+        primary_preferred: PrimaryPreferred,
+        secondary: Secondary,
+        secondary_preferred: SecondaryPreferred
+    }.freeze
+
+    # Create a server selector object.
+    #
+    # @example Get a server selector object for selecting a secondary with
+    #   specific tag sets.
+    #   Mongo::ServerSelector.get({ :mode => :secondary, :tag_sets => [{'dc' => 'nyc'}] })
+    #
+    # @param [ Hash ] preference The server preference.
+    # @param [ Hash ] options The preference options.
+    #
+    # @option preference :mode [ Symbol ] The preference mode.
+    # @option preference :tag_sets [ Array<Hash> ] The tag sets.
+    #
+    # @since 2.0.0
+    def get(preference = {}, options = {})
+      PREFERENCES.fetch(preference[:mode] || :primary).new(
+        preference[:tag_sets] || [],
+        options
+      )
+    end
+
+    # Exception raised if there are no servers available matching the preference.
+    #
+    # @since 2.0.0
+    class NoServerAvailable < Error
+
+      # Instantiate the new exception.
+      #
+      # @example Instantiate the exception.
+      #   Mongo::ServerSelector::NoServerAvailable.new(server_selector)
+      #
+      # @param [ Hash ] server_selector The server preference that could not be
+      #   satisfied.
+      #
+      # @since 2.0.0
+      def initialize(server_selector)
+        super("No server is available matching preference: #{server_selector.inspect}")
+      end
+    end
+  end
+end

data/lib/mongo/socket/ssl.rb

@@ -0,0 +1,130 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'openssl'
+
+module Mongo
+  class Socket
+
+    # Wrapper for SSL sockets.
+    #
+    # @since 2.0.0
+    class SSL < Socket
+      include OpenSSL
+
+      # @return [ SSLContext ] context The ssl context.
+      attr_reader :context
+
+      # @return [ String ] host The host to connect to.
+      attr_reader :host
+
+      # @return [ Hash ] The ssl options.
+      attr_reader :options
+
+      # @return [ Integer ] port The port to connect to.
+      attr_reader :port
+
+      # @return [ Float ] timeout The connection timeout.
+      attr_reader :timeout
+
+      # Establishes a socket connection.
+      #
+      # @example Connect the socket.
+      #   sock.connect!
+      #
+      # @note This method mutates the object by setting the socket
+      #   internally.
+      #
+      # @return [ SSL ] The connected socket instance.
+      #
+      # @since 2.0.0
+      def connect!
+        Timeout.timeout(timeout, Error::SocketTimeoutError) do
+          @tcp_socket.connect(::Socket.pack_sockaddr_in(port, host))
+          @socket = OpenSSL::SSL::SSLSocket.new(@tcp_socket, context)
+          @socket.sync_close = true
+          @socket.connect
+          verify_certificate!(@socket)
+          self
+        end
+      end
+
+      # Initializes a new SSL socket.
+      #
+      # @example Create the SSL socket.
+      #   SSL.new('::1', 27017, 30)
+      #
+      # @param [ String ] host The hostname or IP address.
+      # @param [ Integer ] port The port number.
+      # @param [ Float ] timeout The socket timeout value.
+      # @param [ Integer ] family The socket family.
+      # @param [ Hash ] options The ssl options.
+      #
+      # @since 2.0.0
+      def initialize(host, port, timeout, family, options = {})
+        @host, @port, @timeout, @options = host, port, timeout, options
+        @context = create_context(options)
+        @family = family
+        @tcp_socket = ::Socket.new(family, SOCK_STREAM, 0)
+        @tcp_socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1)
+        encoded_timeout = [ timeout, 0 ].pack(TIMEOUT_PACK)
+        @tcp_socket.set_encoding(BSON::BINARY)
+        @tcp_socket.setsockopt(SOL_SOCKET, SO_RCVTIMEO, encoded_timeout)
+        @tcp_socket.setsockopt(SOL_SOCKET, SO_SNDTIMEO, encoded_timeout)
+      end
+
+      # Read a single byte from the socket.
+      #
+      # @example Read a single byte.
+      #   socket.readbyte
+      #
+      # @return [ Object ] The read byte.
+      #
+      # @since 2.0.0
+      def readbyte
+        handle_errors { socket.read(1) }
+      end
+
+      private
+
+      def create_context(options)
+        context = OpenSSL::SSL::SSLContext.new
+        if options[:ssl_cert]
+          context.cert = OpenSSL::X509::Certificate.new(File.open(options[:ssl_cert]))
+        end
+        if options[:ssl_key]
+          if options[:ssl_key_pass_phrase]
+            context.key = OpenSSL::PKey::RSA.new(File.open(options[:ssl_key]),
+                                                           options[:ssl_key_pass_phrase])
+          else
+            context.key = OpenSSL::PKey::RSA.new(File.open(options[:ssl_key]))
+          end
+        end
+        if options[:ssl_verify] || options[:ssl_ca_cert]
+          context.ca_file = options[:ssl_ca_cert]
+          context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
+        context
+      end
+
+      def verify_certificate!(socket)
+        if context.verify_mode == OpenSSL::SSL::VERIFY_PEER
+          unless OpenSSL::SSL.verify_certificate_identity(socket.peer_cert, host)
+            raise Error::SocketError, 'SSL handshake failed due to a hostname mismatch.'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/socket/tcp.rb

@@ -0,0 +1,69 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+  class Socket
+
+    # Wrapper for TCP sockets.
+    #
+    # @since 2.0.0
+    class TCP < Socket
+
+      # @return [ String ] host The host to connect to.
+      attr_reader :host
+
+      # @return [ Integer ] port The port to connect to.
+      attr_reader :port
+
+      # @return [ Float ] timeout The connection timeout.
+      attr_reader :timeout
+
+      # Establishes a socket connection.
+      #
+      # @example Connect the socket.
+      #   sock.connect!
+      #
+      # @note This method mutates the object by setting the socket
+      #   internally.
+      #
+      # @return [ TCP ] The connected socket instance.
+      #
+      # @since 2.0.0
+      def connect!
+        Timeout.timeout(timeout, Error::SocketTimeoutError) do
+          socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1)
+          socket.connect(::Socket.pack_sockaddr_in(port, host))
+          self
+        end
+      end
+
+      # Initializes a new TCP socket.
+      #
+      # @example Create the TCP socket.
+      #   TCP.new('::1', 27017, 30)
+      #   TCP.new('127.0.0.1', 27017, 30)
+      #
+      # @param [ String ] host The hostname or IP address.
+      # @param [ Integer ] port The port number.
+      # @param [ Float ] timeout The socket timeout value.
+      # @param [ Integer ] family The socket family.
+      #
+      # @since 2.0.0
+      def initialize(host, port, timeout, family)
+        @host, @port, @timeout = host, port, timeout
+        super(family)
+      end
+    end
+  end
+end