mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/server/description/features.rb

@@ -0,0 +1,85 @@
+# Copyright (C) 2014 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 Description
+
+      # Defines behaviour around what features a specific server supports.
+      #
+      # @since 2.0.0
+      class Features
+
+        # List of features and the wire protocol version they appear in.
+        #
+        # @since 2.0.0
+        MAPPINGS = {
+          :list_collections => 3,
+          :list_indexes => 3,
+          :scram_sha_1 => 3,
+          :write_command => 2
+        }.freeze
+
+        # The wire protocol versions that this version of the driver supports.
+        #
+        # @since 2.0.0
+        DRIVER_WIRE_VERSIONS = (0..3).freeze
+
+        # Create the methods for each mapping to tell if they are supported.
+        #
+        # @since 2.0.0
+        MAPPINGS.each do |name, version|
+
+          # Determine whether or not the feature is enabled.
+          #
+          # @example Is a feature enabled?
+          #   features.list_collections_enabled?
+          #
+          # @return [ true, false ] If the feature is enabled.
+          #
+          # @since 2.0.0
+          define_method("#{name}_enabled?") do
+            server_wire_versions.include?(MAPPINGS[name])
+          end
+        end
+
+        # @return [ Range ] server_wire_versions The server's supported wire
+        #   versions.
+        attr_reader :server_wire_versions
+
+        # Initialize the features.
+        #
+        # @example Initialize the features.
+        #   Features.new(0..3)
+        #
+        # @param [ Range ] server_wire_versions The server supported wire
+        #   versions.
+        #
+        # @since 2.0.0
+        def initialize(server_wire_versions)
+          @server_wire_versions = server_wire_versions
+          check_driver_support!
+        end
+
+        private
+
+        def check_driver_support!
+          if DRIVER_WIRE_VERSIONS.max < server_wire_versions.max
+            raise Error::UnsupportedFeatures.new(server_wire_versions)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/description/inspector.rb

@@ -0,0 +1,79 @@
+# 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.
+
+require 'mongo/server/description/inspector/primary_elected'
+require 'mongo/server/description/inspector/server_added'
+require 'mongo/server/description/inspector/server_removed'
+
+module Mongo
+  class Server
+    class Description
+
+      # Handles inspection of an updated server description to determine if
+      # events should be fired.
+      #
+      # @since 2.0.0
+      class Inspector
+
+        # Static list of inspections that are performed on the result of an
+        # ismaster command in order to generate the appropriate events for the
+        # changes.
+        #
+        # @since 2.0.0
+        INSPECTORS = [
+          Inspector::PrimaryElected,
+          Inspector::ServerAdded,
+          Inspector::ServerRemoved
+        ].freeze
+
+        # @return [ Array ] inspectors The description inspectors.
+        attr_reader :inspectors
+
+        # Create the new inspector.
+        #
+        # @example Create the new inspector.
+        #   Inspector.new(listeners)
+        #
+        # @param [ Event::Listeners ] The event listeners.
+        #
+        # @since 2.0.0
+        def initialize(listeners)
+          @inspectors = INSPECTORS.map do |inspector|
+            inspector.new(listeners)
+          end
+        end
+
+        # Run the server description inspector.
+        #
+        # @example Run the inspector.
+        #   inspector.run(description, { 'ismaster' => true })
+        #
+        # @param [ Description ] description The old description.
+        # @param [ Hash ] ismaster The updated ismaster.
+        # @param [ Float ] average_round_trip_time The moving average round trip time (ms).
+        #
+        # @return [ Description ] The new description.
+        #
+        # @since 2.0.0
+        def run(description, ismaster, average_round_trip_time)
+          new_description = Description.new(description.address, ismaster, average_round_trip_time)
+          inspectors.each do |inspector|
+            inspector.run(description, new_description)
+          end
+          new_description
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/description/inspector/primary_elected.rb

@@ -0,0 +1,58 @@
+# 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 Description
+      class Inspector
+
+        # Handles inspecting the result of an ismaster command to check if this
+        # server was elected primary.
+        #
+        # @since 2.0.0
+        class PrimaryElected
+          include Event::Publisher
+
+          # Instantiate the primary elected inspection.
+          #
+          # @example Instantiate the inspection.
+          #   PrimaryElected.new(listeners)
+          #
+          # @param [ Event::Listeners ] event_listeners The event listeners.
+          #
+          # @since 2.0.0
+          def initialize(event_listeners)
+            @event_listeners = event_listeners
+          end
+
+          # Run the primary elected inspection.
+          #
+          # @example Run the inspection.
+          #   PrimaryElected.run(description, {})
+          #
+          # @param [ Description ] description The server description.
+          # @param [ Description ] updated The updated description.
+          #
+          # @since 2.0.0
+          def run(description, updated)
+            if (!description.primary? && updated.primary?) ||
+              (!description.mongos? && updated.mongos?)
+              publish(Event::PRIMARY_ELECTED, updated)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/description/inspector/server_added.rb

@@ -0,0 +1,59 @@
+# 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 Server
+    class Description
+      class Inspector
+
+        # Handles inspecting the result of an ismaster command for servers
+        # added to the cluster.
+        #
+        # @since 2.0.0
+        class ServerAdded
+          include Event::Publisher
+
+          # Instantiate the server added inspection.
+          #
+          # @example Instantiate the inspection.
+          #   ServerAdded.new(listeners)
+          #
+          # @param [ Event::Listeners ] event_listeners The event listeners.
+          #
+          # @since 2.0.0
+          def initialize(event_listeners)
+            @event_listeners = event_listeners
+          end
+
+          # Run the server added inspection.
+          #
+          # @example Run the inspection.
+          #   ServerAdded.run(description, {})
+          #
+          # @param [ Description ] description The server description.
+          # @param [ Description ] updated The updated description.
+          #
+          # @since 2.0.0
+          def run(description, updated)
+            updated.servers.each do |host|
+              unless description.servers.include?(host)
+                publish(Event::SERVER_ADDED, host)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/description/inspector/server_removed.rb

@@ -0,0 +1,59 @@
+# 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 Server
+    class Description
+      class Inspector
+
+        # Handles inspecting the result of an ismaster command for servers
+        # that were removed from the cluster.
+        #
+        # @since 2.0.0
+        class ServerRemoved
+          include Event::Publisher
+
+          # Instantiate the server removed inspection.
+          #
+          # @example Instantiate the inspection.
+          #   ServerRemoved.new(listeners)
+          #
+          # @param [ Event::Listeners ] event_listeners The event listeners.
+          #
+          # @since 2.0.0
+          def initialize(event_listeners)
+            @event_listeners = event_listeners
+          end
+
+          # Run the server added inspection.
+          #
+          # @example Run the inspection.
+          #   ServerAdded.run(description, {})
+          #
+          # @param [ Description ] description The server description.
+          # @param [ Description ] updated The updated description.
+          #
+          # @since 2.0.0
+          def run(description, updated)
+            description.hosts.each do |host|
+              if updated.primary? && !updated.hosts.include?(host)
+                publish(Event::SERVER_REMOVED, host)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/server/monitor.rb

@@ -0,0 +1,160 @@
+# 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 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!
+        @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
+    end
+  end
+end