mongo 1.12.5 → 2.0.0

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/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 ] 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.rb

@@ -0,0 +1,450 @@
+# 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/description/features'
+require 'mongo/server/description/inspector'
+
+module Mongo
+  class Server
+
+    # Represents a description of the server, populated by the result of the
+    # ismaster command.
+    #
+    # @since 2.0.0
+    class Description
+
+      # Constant for reading arbiter info from config.
+      #
+      # @since 2.0.0
+      ARBITER = 'arbiterOnly'.freeze
+
+      # Constant for reading arbiters info from config.
+      #
+      # @since 2.0.0
+      ARBITERS = 'arbiters'.freeze
+
+      # Constant for reading hidden info from config.
+      #
+      # @since 2.0.0
+      HIDDEN = 'hidden'.freeze
+
+      # Constant for reading hosts info from config.
+      #
+      # @since 2.0.0
+      HOSTS = 'hosts'.freeze
+
+      # Constant for the key for the message value.
+      #
+      # @since 2.0.0
+      MESSAGE = 'msg'.freeze
+
+      # Constant for the message that indicates a sharded cluster.
+      #
+      # @since 2.0.0
+      MONGOS_MESSAGE = 'isdbgrid'.freeze
+
+      # Constant for determining ghost servers.
+      #
+      # @since 2.0.0
+      REPLICA_SET = 'isreplicaset'.freeze
+
+      # Constant for reading max bson size info from config.
+      #
+      # @since 2.0.0
+      MAX_BSON_OBJECT_SIZE = 'maxBsonObjectSize'.freeze
+
+      # Constant for reading max message size info from config.
+      #
+      # @since 2.0.0
+      MAX_MESSAGE_BYTES = 'maxMessageSizeBytes'.freeze
+
+      # Constant for the max wire version.
+      #
+      # @since 2.0.0
+      MAX_WIRE_VERSION = 'maxWireVersion'.freeze
+
+      # Constant for min wire version.
+      #
+      # @since 2.0.0
+      MIN_WIRE_VERSION = 'minWireVersion'.freeze
+
+      # Constant for reading max write batch size.
+      #
+      # @since 2.0.0
+      MAX_WRITE_BATCH_SIZE = 'maxWriteBatchSize'.freeze
+
+      # Default max write batch size.
+      #
+      # @since 2.0.0
+      DEFAULT_MAX_WRITE_BATCH_SIZE = 1000.freeze
+
+      # The legacy wire protocol version.
+      #
+      # @since 2.0.0
+      LEGACY_WIRE_VERSION = 0.freeze
+
+      # Constant for reading passive info from config.
+      #
+      # @since 2.0.0
+      PASSIVE = 'passive'.freeze
+
+      # Constant for reading the passive server list.
+      #
+      # @since 2.0.0
+      PASSIVES = 'passives'.freeze
+
+      # Constant for reading primary info from config.
+      #
+      # @since 2.0.0
+      PRIMARY = 'ismaster'.freeze
+
+      # Constant for reading secondary info from config.
+      #
+      # @since 2.0.0
+      SECONDARY = 'secondary'.freeze
+
+      # Constant for reading replica set name info from config.
+      #
+      # @since 2.0.0
+      SET_NAME = 'setName'.freeze
+
+      # Constant for reading tags info from config.
+      #
+      # @since 2.0.0
+      TAGS = 'tags'.freeze
+
+      # @return [ Address ] address The server's address.
+      attr_reader :address
+
+      # @return [ Hash ] The actual result from the ismaster command.
+      attr_reader :config
+
+      # @return [ Features ] features The features for the server.
+      attr_reader :features
+
+      # @return [ Float ] The moving average time the ismaster call took to complete.
+      attr_reader :average_round_trip_time
+
+      # Will return true if the server is an arbiter.
+      #
+      # @example Is the server an arbiter?
+      #   description.arbiter?
+      #
+      # @return [ true, false ] If the server is an arbiter.
+      #
+      # @since 2.0.0
+      def arbiter?
+        !!config[ARBITER] && !replica_set_name.nil?
+      end
+
+      # Get a list of all arbiters in the replica set.
+      #
+      # @example Get the arbiters in the replica set.
+      #   description.arbiters
+      #
+      # @return [ Array<String> ] The arbiters in the set.
+      #
+      # @since 2.0.0
+      def arbiters
+        config[ARBITERS] || []
+      end
+
+      # Is the server a ghost in a replica set?
+      #
+      # @example Is the server a ghost?
+      #   description.ghost?
+      #
+      # @return [ true, false ] If the server is a ghost.
+      #
+      # @since 2.0.0
+      def ghost?
+        !!config[REPLICA_SET]
+      end
+
+      # Will return true if the server is hidden.
+      #
+      # @example Is the server hidden?
+      #   description.hidden?
+      #
+      # @return [ true, false ] If the server is hidden.
+      #
+      # @since 2.0.0
+      def hidden?
+        !!config[HIDDEN]
+      end
+
+      # Get a list of all servers in the replica set.
+      #
+      # @example Get the servers in the replica set.
+      #   description.hosts
+      #
+      # @return [ Array<String> ] The servers in the set.
+      #
+      # @since 2.0.0
+      def hosts
+        config[HOSTS] || []
+      end
+
+      # Instantiate the new server description from the result of the ismaster
+      # command.
+      #
+      # @example Instantiate the new description.
+      #   Description.new(address, { 'ismaster' => true }, 0.5)
+      #
+      # @param [ Address ] address The server address.
+      # @param [ Hash ] config The result of the ismaster command.
+      # @param [ Float ] average_round_trip_time The moving average time (ms) the ismaster
+      #   call took to complete.
+      #
+      # @since 2.0.0
+      def initialize(address, config = {}, average_round_trip_time = 0)
+        @address = address
+        @config = config
+        @features = Features.new(wire_versions)
+        @average_round_trip_time = average_round_trip_time
+      end
+
+      # Inspect the server description.
+      #
+      # @example Inspect the server description
+      #   description.inspect
+      #
+      # @return [ String ] The inspection.
+      #
+      # @since 2.0.0
+      def inspect
+        "#<Mongo::Server:Description:0x#{object_id} config=#{config} average_round_trip_time=#{average_round_trip_time}>"
+      end
+
+      # Get the max BSON object size for this server version.
+      #
+      # @example Get the max BSON object size.
+      #   description.max_bson_object_size
+      #
+      # @return [ Integer ] The maximum object size in bytes.
+      #
+      # @since 2.0.0
+      def max_bson_object_size
+        config[MAX_BSON_OBJECT_SIZE]
+      end
+
+      # Get the max message size for this server version.
+      #
+      # @example Get the max message size.
+      #   description.max_message_size
+      #
+      # @return [ Integer ] The maximum message size in bytes.
+      #
+      # @since 2.0.0
+      def max_message_size
+        config[MAX_MESSAGE_BYTES]
+      end
+
+      # Get the maximum batch size for writes.
+      #
+      # @example Get the max batch size.
+      #   description.max_write_batch_size
+      #
+      # @return [ Integer ] The max batch size.
+      #
+      # @since 2.0.0
+      def max_write_batch_size
+        config[MAX_WRITE_BATCH_SIZE] || DEFAULT_MAX_WRITE_BATCH_SIZE
+      end
+
+      # Get the maximum wire version.
+      #
+      # @example Get the max wire version.
+      #   description.max_wire_version
+      #
+      # @return [ Integer ] The max wire version supported.
+      #
+      # @since 2.0.0
+      def max_wire_version
+        config[MAX_WIRE_VERSION] || LEGACY_WIRE_VERSION
+      end
+
+      # Get the minimum wire version.
+      #
+      # @example Get the min wire version.
+      #   description.min_wire_version
+      #
+      # @return [ Integer ] The min wire version supported.
+      #
+      # @since 2.0.0
+      def min_wire_version
+        config[MIN_WIRE_VERSION] || LEGACY_WIRE_VERSION
+      end
+
+      # Get the tags configured for the server.
+      #
+      # @example Get the tags.
+      #   description.tags
+      #
+      # @return [ Hash ] The tags of the server.
+      #
+      # @since 2.0.0
+      def tags
+        config[TAGS] || {}
+      end
+
+      # Is the server a mongos?
+      #
+      # @example Is the server a mongos?
+      #   description.mongos?
+      #
+      # @return [ true, false ] If the server is a mongos.
+      #
+      # @since 2.0.0
+      def mongos?
+        config[MESSAGE] == MONGOS_MESSAGE
+      end
+
+      # Is the description of type other.
+      #
+      # @example Is the description of type other.
+      #   description.other?
+      #
+      # @return [ true, false ] If the description is other.
+      #
+      # @since 2.0.0
+      def other?
+        !primary? && !secondary? && !passive? && !arbiter?
+      end
+
+      # Will return true if the server is passive.
+      #
+      # @example Is the server passive?
+      #   description.passive?
+      #
+      # @return [ true, false ] If the server is passive.
+      #
+      # @since 2.0.0
+      def passive?
+        !!config[PASSIVE]
+      end
+
+      # Get a list of the passive servers in the cluster.
+      #
+      # @example Get the passives.
+      #   description.passives
+      #
+      # @return [ Array<String> ] The list of passives.
+      #
+      # @since 2.0.0
+      def passives
+        config[PASSIVES] || []
+      end
+
+      # Will return true if the server is a primary.
+      #
+      # @example Is the server a primary?
+      #   description.primary?
+      #
+      # @return [ true, false ] If the server is a primary.
+      #
+      # @since 2.0.0
+      def primary?
+        !!config[PRIMARY] && !replica_set_name.nil?
+      end
+
+      # Get the name of the replica set the server belongs to, returns nil if
+      # none.
+      #
+      # @example Get the replica set name.
+      #   description.replica_set_name
+      #
+      # @return [ String, nil ] The name of the replica set.
+      #
+      # @since 2.0.0
+      def replica_set_name
+        config[SET_NAME]
+      end
+
+      # Get a list of all servers known to the cluster.
+      #
+      # @example Get all servers.
+      #   description.servers
+      #
+      # @return [ Array<String> ] The list of all servers.
+      #
+      # @since 2.0.0
+      def servers
+        hosts + arbiters + passives
+      end
+
+      # Will return true if the server is a secondary.
+      #
+      # @example Is the server a secondary?
+      #   description.secondary?
+      #
+      # @return [ true, false ] If the server is a secondary.
+      #
+      # @since 2.0.0
+      def secondary?
+        !!config[SECONDARY] && !replica_set_name.nil?
+      end
+
+      # Is this server a standalone server?
+      #
+      # @example Is the server standalone?
+      #   description.standalone?
+      #
+      # @return [ true, false ] If the server is standalone.
+      #
+      # @since 2.0.0
+      def standalone?
+        replica_set_name.nil? && !mongos? && !ghost? && !unknown?
+      end
+
+      # Is the server description currently unknown?
+      #
+      # @example Is the server description unknown?
+      #   description.unknown?
+      #
+      # @return [ true, false ] If the server description is unknown.
+      #
+      # @since 2.0.0
+      def unknown?
+        config.empty? || config[Operation::Result::OK] != 1
+      end
+
+      # A result from another server's ismaster command before this server has
+      # refreshed causes the need for this description to become unknown before
+      # the next refresh.
+      #
+      # @example Force an unknown state.
+      #   description.unknown!
+      #
+      # @return [ true ] Always true.
+      #
+      # @since 2.0.0
+      def unknown!
+        @config = {} and true
+      end
+
+      # Get the range of supported wire versions for the server.
+      #
+      # @example Get the wire version range.
+      #   description.wire_versions
+      #
+      # @return [ Range ] The wire version range.
+      #
+      # @since 2.0.0
+      def wire_versions
+        min_wire_version..max_wire_version
+      end
+    end
+  end
+end