mongo 1.12.5 → 2.0.0

data/lib/mongo/server/monitor/connection.rb

@@ -0,0 +1,89 @@
+# Copyright (C) 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 Server
+    class Monitor
+
+      # This class models the monitor connections and their behavior.
+      #
+      # @since 2.0.0
+      class Connection
+        include Connectable
+
+        # Tell the underlying socket to establish a connection to the host.
+        #
+        # @example Connect to the host.
+        #   connection.connect!
+        #
+        # @note This method mutates the connection class by setting a socket if
+        #   one previously did not exist.
+        #
+        # @return [ true ] If the connection succeeded.
+        #
+        # @since 2.0.0
+        def connect!
+          unless socket
+            @socket = address.socket(timeout, ssl_options)
+            @socket.connect!
+          end
+          true
+        end
+
+        # Disconnect the connection.
+        #
+        # @example Disconnect from the host.
+        #   connection.disconnect!
+        #
+        # @note This method mutates the connection by setting the socket to nil
+        #   if the closing succeeded.
+        #
+        # @return [ true ] If the disconnect succeeded.
+        #
+        # @since 2.0.0
+        def disconnect!
+          if socket
+            socket.close
+            @socket = nil
+          end
+          true
+        end
+
+        # Initialize a new socket connection from the client to the server.
+        #
+        # @example Create the connection.
+        #   Connection.new(address)
+        #
+        # @param [ Mongo::Address ] address The address the connection is for.
+        # @param [ Hash ] options The connection options.
+        #
+        # @since 2.0.0
+        def initialize(address, options = {})
+          @address = address
+          @options = options.freeze
+          @ssl_options = options.reject { |k, v| !k.to_s.start_with?('ssl') }
+          @socket = nil
+          @pid = Process.pid
+        end
+
+        private
+
+        def write(messages, buffer = '')
+          messages.each{ |message| message.serialize(buffer) }
+          ensure_connected{ |socket| socket.write(buffer) }
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/monitor.rb

@@ -0,0 +1,176 @@
+# 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/monitor/connection'
+
+module Mongo
+  class Server
+
+    # This object is responsible for keeping server status up to date, running in
+    # a separate thread as to not disrupt other operations.
+    #
+    # @since 2.0.0
+    class Monitor
+      include Loggable
+
+      # The default time for a server to refresh its status is 10 seconds.
+      #
+      # @since 2.0.0
+      HEARTBEAT_FREQUENCY = 10.freeze
+
+      # The minimum time between forced server scans. Is
+      # minHeartbeatFrequencyMS in the SDAM spec.
+      #
+      # @since 2.0.0
+      MIN_SCAN_FREQUENCY = 0.5.freeze
+
+      # The command used for determining server status.
+      #
+      # @since 2.0.0
+      STATUS = { :ismaster => 1 }.freeze
+
+      # The constant for the ismaster command.
+      #
+      # @since 2.0.0
+      ISMASTER = Protocol::Query.new(Database::ADMIN, Database::COMMAND, STATUS, :limit => -1)
+
+      # The weighting factor (alpha) for calculating the average moving round trip time.
+      #
+      # @since 2.0.0
+      RTT_WEIGHT_FACTOR = 0.2.freeze
+
+      # @return [ Mongo::Connection ] connection The connection to use.
+      attr_reader :connection
+
+      # @return [ Server::Description ] description The server
+      #   description the monitor refreshes.
+      attr_reader :description
+
+      # @return [ Description::Inspector ] inspector The description inspector.
+      attr_reader :inspector
+
+      # @return [ Hash ] options The server options.
+      attr_reader :options
+
+      # Force the monitor to immediately do a check of its server.
+      #
+      # @example Force a scan.
+      #   monitor.scan!
+      #
+      # @return [ Description ] The updated description.
+      #
+      # @since 2.0.0
+      def scan!
+        throttle_scan_frequency!
+        @description = inspector.run(description, *ismaster)
+      end
+
+      # Get the refresh interval for the server. This will be defined via an option
+      # or will default to 5.
+      #
+      # @example Get the refresh interval.
+      #   server.heartbeat_frequency
+      #
+      # @return [ Integer ] The heartbeat frequency, in seconds.
+      #
+      # @since 2.0.0
+      def heartbeat_frequency
+        @heartbeat_frequency ||= options[:heartbeat_frequency] || HEARTBEAT_FREQUENCY
+      end
+
+      # Create the new server monitor.
+      #
+      # @example Create the server monitor.
+      #   Mongo::Server::Monitor.new(address, listeners)
+      #
+      # @param [ Address ] address The address to monitor.
+      # @param [ Event::Listeners ] listeners The event listeners.
+      # @param [ Hash ] options The options.
+      #
+      # @since 2.0.0
+      def initialize(address, listeners, options = {})
+        @description = Description.new(address, {})
+        @inspector = Description::Inspector.new(listeners)
+        @options = options.freeze
+        @connection = Connection.new(address, options)
+        @last_round_trip_time = nil
+        @mutex = Mutex.new
+      end
+
+      # Runs the server monitor. Refreshing happens on a separate thread per
+      # server.
+      #
+      # @example Run the monitor.
+      #   monito.run
+      #
+      # @return [ Thread ] The thread the monitor runs on.
+      #
+      # @since 2.0.0
+      def run!
+        @thread = Thread.new(heartbeat_frequency) do |i|
+          loop do
+            sleep(i)
+            scan!
+          end
+        end
+      end
+
+      # Stops the server monitor. Kills the thread so it doesn't continue
+      # taking memory and sending commands to the connection.
+      #
+      # @example Stop the monitor.
+      #   monitor.stop!
+      #
+      # @return [ Boolean ] Is the Thread stopped?
+      #
+      # @since 2.0.0
+      def stop!
+        @thread.kill && @thread.stop?
+      end
+
+      private
+
+      def average_round_trip_time(start)
+        new_rtt = Time.now - start
+        RTT_WEIGHT_FACTOR * new_rtt + (1 - RTT_WEIGHT_FACTOR) * (@last_round_trip_time || new_rtt)
+      end
+
+      def calculate_average_round_trip_time(start)
+        @last_round_trip_time = average_round_trip_time(start)
+      end
+
+      def ismaster
+        @mutex.synchronize do
+          start = Time.now
+          begin
+            result = connection.dispatch([ ISMASTER ]).documents[0]
+            return result, calculate_average_round_trip_time(start)
+          rescue Exception => e
+            log_debug([ e.message ])
+            return {}, calculate_average_round_trip_time(start)
+          end
+        end
+      end
+
+      def throttle_scan_frequency!
+        if @last_scan
+          difference = (Time.now - @last_scan)
+          throttle_time = (MIN_SCAN_FREQUENCY - difference)
+          sleep(throttle_time) if throttle_time > 0
+        end
+        @last_scan = Time.now
+      end
+    end
+  end
+end

data/lib/mongo/server.rb

@@ -0,0 +1,163 @@
+# 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/connectable'
+require 'mongo/server/connection'
+require 'mongo/server/connection_pool'
+require 'mongo/server/context'
+require 'mongo/server/description'
+require 'mongo/server/monitor'
+
+module Mongo
+
+  # Represents a single server on the server side that can be standalone, part of
+  # a replica set, or a mongos.
+  #
+  # @since 2.0.0
+  class Server
+    extend Forwardable
+
+    # @return [ String ] The configured address for the server.
+    attr_reader :address
+
+    # @return [ Monitor ] monitor The server monitor.
+    attr_reader :monitor
+
+    # @return [ Hash ] The options hash.
+    attr_reader :options
+
+    # Get the description from the monitor and scan on monitor.
+    def_delegators :monitor, :description, :scan!
+
+    # Delegate convenience methods to the monitor description.
+    def_delegators :description,
+                   :arbiter?,
+                   :features,
+                   :ghost?,
+                   :max_wire_version,
+                   :max_write_batch_size,
+                   :max_bson_object_size,
+                   :max_message_size,
+                   :tags,
+                   :average_round_trip_time,
+                   :mongos?,
+                   :other?,
+                   :primary?,
+                   :replica_set_name,
+                   :secondary?,
+                   :standalone?,
+                   :unknown?
+
+    # Is this server equal to another?
+    #
+    # @example Is the server equal to the other?
+    #   server == other
+    #
+    # @param [ Object ] other The object to compare to.
+    #
+    # @return [ true, false ] If the servers are equal.
+    #
+    # @since 2.0.0
+    def ==(other)
+      return false unless other.is_a?(Server)
+      address == other.address
+    end
+
+    # Get a new context for this server in which to send messages.
+    #
+    # @example Get the server context.
+    #   server.context
+    #
+    # @return [ Mongo::Server::Context ] context The server context.
+    #
+    # @since 2.0.0
+    def context
+      Context.new(self)
+    end
+
+    # Disconnect the server from the connection.
+    #
+    # @example Disconnect the server.
+    #   server.disconnect!
+    #
+    # @return [ true ] Always tru with no exception.
+    #
+    # @since 2.0.0
+    def disconnect!
+      context.with_connection do |connection|
+        connection.disconnect!
+      end
+      monitor.stop! and true
+    end
+
+    # Instantiate a new server object. Will start the background refresh and
+    # subscribe to the appropriate events.
+    #
+    # @example Initialize the server.
+    #   Mongo::Server.new('127.0.0.1:27017', listeners)
+    #
+    # @param [ Address ] address The host:port address to connect to.
+    # @param [ Event::Listeners ] event_listeners The event listeners.
+    # @param [ Hash ] options The server options.
+    #
+    # @since 2.0.0
+    def initialize(address, event_listeners, options = {})
+      @address = address
+      @options = options.freeze
+      @monitor = Monitor.new(address, event_listeners, options)
+      monitor.scan!
+      monitor.run!
+    end
+
+    # Get a pretty printed server inspection.
+    #
+    # @example Get the server inspection.
+    #   server.inspec
+    #
+    # @return [ String ] The nice inspection string.
+    #
+    # @since 2.0.0
+    def inspect
+      "#<Mongo::Server:0x#{object_id} address=#{address.host}:#{address.port}>"
+    end
+
+    # Get the connection pool for this server.
+    #
+    # @example Get the connection pool for the server.
+    #   server.pool
+    #
+    # @return [ Mongo::Pool ] The connection pool.
+    #
+    # @since 2.0.0
+    def pool
+      @pool ||= ConnectionPool.get(self)
+    end
+
+    # Determine if the provided tags are a subset of the server's tags.
+    #
+    # @example Are the provided tags a subset of the server's tags.
+    #   server.matches_tag_set?({ 'rack' => 'a', 'dc' => 'nyc' })
+    #
+    # @param [ Hash ] tag_set The tag set to compare to the server's tags.
+    #
+    # @return [ true, false ] If the provided tags are a subset of the server's tags.
+    #
+    # @since 2.0.0
+    def matches_tag_set?(tag_set)
+      tag_set.keys.all? do |k|
+        tags[k] && tags[k] == tag_set[k]
+      end
+    end
+  end
+end

data/lib/mongo/server_selector/nearest.rb

@@ -0,0 +1,94 @@
+# 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 near servers given a list
+    #   of candidates.
+    #
+    # @since 2.0.0
+    class Nearest
+      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 ] :nearest
+      #
+      # @since 2.0.0
+      def name
+        :nearest
+      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::Nearest.new
+      #   preference.to_mongos
+      #
+      # @return [ Hash ] The server preference formatted for a mongos server.
+      #
+      # @since 2.0.0
+      def to_mongos
+        preference = { :mode => 'nearest' }
+        preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+        preference
+      end
+
+      private
+
+      # Select the near servers taking into account any defined tag sets and
+      #   local threshold between the nearest server and other servers.
+      #
+      # @example Select nearest servers given a list of candidates.
+      #   preference = Mongo::Serverreference::Nearest.new
+      #   preference.select_server(cluster)
+      #
+      # @return [ Array ] The nearest servers from the list of candidates.
+      #
+      # @since 2.0.0
+      def select(candidates)
+        if tag_sets.empty?
+          near_servers(candidates)
+        else
+          near_servers(match_tag_sets(candidates))
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server_selector/primary.rb

@@ -0,0 +1,88 @@
+# 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 the primary server given a list
+    #   of candidates.
+    #
+    # @since 2.0.0
+    class Primary
+      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 ] :primary
+      #
+      # @since 2.0.0
+      def name
+        :primary
+      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 [ false ] false
+      #
+      # @since 2.0.0
+      def slave_ok?
+        false
+      end
+
+      # Whether tag sets are allowed to be defined for this server preference.
+      #
+      # @return [ false ] false
+      #
+      # @since 2.0.0
+      def tags_allowed?
+        false
+      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::Primary.new
+      #   preference.to_mongos
+      #
+      # @return [ nil ] nil
+      #
+      # @since 2.0.0
+      def to_mongos
+        nil
+      end
+
+      private
+
+      # Select the primary server from a list of candidates.
+      #
+      # @example Select the primary server given a list of candidates.
+      #   preference = Mongo::ServerSelector::Primary.new
+      #   preference.select([candidate_1, candidate_2])
+      #
+      # @return [ Array ] The primary server from the list of candidates.
+      #
+      # @since 2.0.0
+      def select(candidates)
+        primary(candidates)
+      end
+    end
+  end
+end

data/lib/mongo/server_selector/primary_preferred.rb

@@ -0,0 +1,94 @@
+# 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 the
+    #   primary preferred, given a list of candidates.
+    #
+    # @since 2.0.0
+    class PrimaryPreferred
+      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 ] :primary_preferred
+      #
+      # @since 2.0.0
+      def name
+        :primary_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.
+      #
+      # @example Convert this server preference definition into a format
+      #   for mongos.
+      #   preference = Mongo::ServerSelector::PrimaryPreferred.new
+      #   preference.to_mongos
+      #
+      # @return [ Hash ] The server preference formatted for a mongos server.
+      #
+      # @since 2.0.0
+      def to_mongos
+        preference = { :mode => 'primaryPreferred' }
+        preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
+        preference
+      end
+
+      private
+
+      # Select servers taking into account any defined tag sets and
+      #   local threshold, with the primary preferred.
+      #
+      # @example Select servers given a list of candidates,
+      #   with the primary preferred.
+      #   preference = Mongo::ServerSelector::PrimaryPreferred.new
+      #   preference.select([candidate_1, candidate_2])
+      #
+      # @return [ Array ] A list of servers matching tag sets and acceptable
+      #   latency with the primary preferred.
+      #
+      # @since 2.0.0
+      def select(candidates)
+        primary = primary(candidates)
+        primary.first ? primary : near_servers(secondaries(candidates))
+      end
+    end
+  end
+end