mongo 2.6.4 → 2.7.0.rc0

data/lib/mongo/event/base.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018 MongoDB, Inc.
+# Copyright (C) 2018-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -24,8 +24,11 @@ module Mongo
       #
       # @return [ String ] String summary of the event.
       #
-      # @since 2.6.0
-      def inspect
+      # @note This method is experimental and subject to change.
+      #
+      # @since 2.7.0
+      # @api experimental
+      def summary
         "#<#{self.class}>"
       end
     end

data/lib/mongo/event/description_changed.rb

@@ -1,5 +1,4 @@
-
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,17 +19,10 @@ module Mongo
     #
     # @since 2.0.6
     class DescriptionChanged < Base
-      include Monitoring::Publishable
 
       # @return [ Mongo::Cluster ] cluster The cluster.
       attr_reader :cluster
 
-      # @return [ Hash ] options The options.
-      attr_reader :options
-
-      # @return [ Monitoring ] monitoring The monitoring.
-      attr_reader :monitoring
-
       # Initialize the new host added event handler.
       #
       # @example Create the new handler.
@@ -41,31 +33,19 @@ module Mongo
       # @since 2.0.0
       def initialize(cluster)
         @cluster = cluster
-        @options = cluster.options
-        @monitoring = cluster.monitoring
       end
 
       # This event publishes an event to add the cluster and logs the
       # configuration change.
       #
-      # @example Handle the event.
-      #   server_added.handle('127.0.0.1:27018')
-      #
-      # @param [ Server::Description ] updated The changed description.
+      # @param [ Server::Description ] previous_desc Previous server description.
+      # @param [ Server::Description ] updated_desc The changed description.
       #
       # @since 2.0.0
-      def handle(previous, updated)
-        publish_sdam_event(
-          Monitoring::SERVER_DESCRIPTION_CHANGED,
-          Monitoring::Event::ServerDescriptionChanged.new(
-            updated.address,
-            cluster.topology,
-            previous,
-            updated
-          )
-        )
-        cluster.add_hosts(updated)
-        cluster.remove_hosts(updated)
+      def handle(previous_desc, updated_desc)
+        cluster.sdam_flow_lock.synchronize do
+          Mongo::Cluster::SdamFlow.new(cluster, previous_desc, updated_desc).server_description_changed
+        end
       end
     end
   end

data/lib/mongo/event/listeners.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/event/publisher.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/event/subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/file.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/file/chunk.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,7 +18,7 @@ module Mongo
   module Grid
     class File
 
-      # Encapsulates behaviour around GridFS chunks of file data.
+      # Encapsulates behavior around GridFS chunks of file data.
       #
       # @since 2.0.0
       class Chunk

data/lib/mongo/grid/file/info.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@ module Mongo
   module Grid
     class File
 
-      # Encapsulates behaviour around GridFS files collection file document.
+      # Encapsulates behavior around GridFS files collection file document.
       #
       # @since 2.0.0
       #
@@ -135,6 +135,12 @@ module Mongo
         # @since 2.0.0
         def initialize(document)
           @client_md5 = Digest::MD5.new unless document[:disable_md5] == true
+          # document contains a mix of user options and keys added
+          # internally by the driver, like session.
+          # Remove the keys that driver adds but keep user options.
+          document = document.reject do |key, value|
+            key.to_s == 'session'
+          end
           @document = default_document.merge(Options::Mapper.transform(document, MAPPINGS))
         end
 

data/lib/mongo/grid/fs_bucket.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/stream.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/stream/read.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/grid/stream/write.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/id.rb

@@ -0,0 +1,64 @@
+# Copyright (C) 2016-2019  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
+  # This module abstracts the functionality for generating sequential unique integer IDs for
+  # instances of the class. It defines the method #next_id on the class that includes it. The
+  # implementation ensures that the IDs will be unique even when called from multiple threads.
+  #
+  # @example Include the Id module.
+  #   class Foo
+  #     include Mongo::Id
+  #   end
+  #
+  #   f = Foo.new
+  #   foo.next_id # => 1
+  #   foo.next_id # => 2
+  #
+  # Classes which include Id should _not_ access `@@id` or `@@id_lock` directly; instead, they
+  # should call `#next_id` in `#initialize` and save the result in the instance being created.
+  #
+  # @example Save the ID in the instance of the including class.
+  #   class Bar
+  #     include Mongo::Id
+  #
+  #     attr_reader :id
+  #
+  #     def initialize
+  #       @id = self.class.next_id
+  #     end
+  #   end
+  #
+  #   a = Bar.new
+  #   a.id # => 1
+  #   b = Bar.new
+  #   b.id # => 2
+  #
+  # @since 2.7.0
+  # @api private
+  module Id
+    def self.included(klass)
+      klass.class_variable_set(:@@id, 0)
+      klass.class_variable_set(:@@id_lock, Mutex.new)
+
+      klass.define_singleton_method(:next_id) do
+        klass.class_variable_get(:@@id_lock).synchronize do
+          id = class_variable_get(:@@id)
+          klass.class_variable_set(:@@id, id + 1)
+          klass.class_variable_get(:@@id)
+        end
+      end
+    end
+  end
+end

data/lib/mongo/index.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/index/view.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/lint.rb

@@ -3,9 +3,11 @@ module Mongo
   module Lint
     def validate_underscore_read_preference(read_pref)
       return unless enabled?
-      if read_pref
-        validate_underscore_read_preference_mode(read_pref[:mode] || read_pref['mode'])
+      return if read_pref.nil?
+      unless read_pref.is_a?(Hash)
+        raise Error::LintError, "Read preference is not a hash: #{read_pref}"
       end
+      validate_underscore_read_preference_mode(read_pref[:mode] || read_pref['mode'])
     end
     module_function :validate_underscore_read_preference
 
@@ -21,9 +23,11 @@ module Mongo
 
     def validate_camel_case_read_preference(read_pref)
       return unless enabled?
-      if read_pref
-        validate_camel_case_read_preference_mode(read_pref[:mode] || read_pref['mode'])
+      return if read_pref.nil?
+      unless read_pref.is_a?(Hash)
+        raise Error::LintError, "Read preference is not a hash: #{read_pref}"
       end
+      validate_camel_case_read_preference_mode(read_pref[:mode] || read_pref['mode'])
     end
     module_function :validate_camel_case_read_preference
 
@@ -37,8 +41,43 @@ module Mongo
     end
     module_function :validate_camel_case_read_preference_mode
 
+    # Validates the provided hash as a read concern object, per the
+    # read/write concern specification
+    # (https://github.com/mongodb/specifications/blob/master/source/read-write-concern/read-write-concern.rst#read-concern).
+    #
+    # This method also accepts nil as input for convenience.
+    #
+    # The read concern document as sent to the server may include
+    # additional fields, for example afterClusterTime. These fields
+    # are generated internally by the driver and cannot be specified by
+    # the user (and would potentially lead to incorrect behavior if they
+    # were specified by the user), hence this method prohibits them.
+    #
+    # @param [ Hash ] read_concern The read concern options hash,
+    #   with the following optional keys:
+    #   - *:level* -- the read preference level as a symbol; valid values
+    #      are *:local*, *:majority*, and *:snapshot*
+    #
+    # @raise [ Error::LintError ] If the validation failed.
+    def validate_read_concern_option(read_concern)
+      return unless enabled?
+      return if read_concern.nil?
+      unless read_concern.is_a?(Hash)
+        raise Error::LintError, "Read concern is not a hash: #{read_concern}"
+      end
+      return if read_concern.empty?
+      keys = read_concern.keys
+      if keys != [:level]
+        raise Error::LintError, "Read concern has invalid keys: #{keys.inspect}"
+      end
+      level = read_concern[:level]
+      return if [:local, :majority, :snapshot].include?(level)
+      raise Error::LintError, "Read concern level is invalid: #{level.inspect}"
+    end
+    module_function :validate_read_concern_option
+
     def enabled?
-      ENV['MONGO_RUBY_DRIVER_LINT'] && %w(1 yes true).include?(ENV['MONGO_RUBY_DRIVER_LINT'].downcase)
+      ENV['MONGO_RUBY_DRIVER_LINT'] && %w(1 yes true on).include?(ENV['MONGO_RUBY_DRIVER_LINT'].downcase)
     end
     module_function :enabled?
   end

data/lib/mongo/loggable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/logger.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/mongo/monitoring.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -14,10 +14,11 @@
 
 module Mongo
 
-  # The class defines behaviour for the performance monitoring API.
+  # The class defines behavior for the performance monitoring API.
   #
   # @since 2.1.0
   class Monitoring
+    include Id
 
     # The command topic.
     #
@@ -54,8 +55,10 @@ module Mongo
     # @since 2.4.0
     TOPOLOGY_OPENING = 'TopologyOpening'.freeze
 
-    @@operation_id = 0
-    @@operation_id_lock = Mutex.new
+    # Server heartbeat started topic.
+    #
+    # @since 2.7.0
+    SERVER_HEARTBEAT = 'ServerHeartbeat'.freeze
 
     # Used for generating unique operation ids to link events together.
     #
@@ -66,9 +69,7 @@ module Mongo
     #
     # @since 2.1.0
     def self.next_operation_id
-      @@operation_id_lock.synchronize do
-        @@operation_id += 1
-      end
+      self.next_id
     end
 
     # Contains subscription methods common between monitoring and
@@ -189,17 +190,27 @@ module Mongo
 
     # Initialize the monitoring.
     #
-    # @api private
-    #
     # @example Create the new monitoring.
     #   Monitoring.new(:monitoring => true)
     #
     # @param [ Hash ] options Options. Client constructor forwards its
     #   options to Monitoring constructor, although Monitoring recognizes
     #   only a subset of the options recognized by Client.
+    # @option options [ true, false ] :monitoring If false is given, the
+    #   Monitoring instance is initialized without global monitoring event
+    #   subscribers and will not publish SDAM events. Command monitoring events
+    #   will still be published, and the driver will still perform SDAM and
+    #   monitor its cluster in order to perform server selection. Built-in
+    #   driver logging of SDAM events will be disabled because it is
+    #   implemented through SDAM event subscription. Client#subscribe will
+    #   succeed for all event types, but subscribers to SDAM events will
+    #   not be invoked. Values other than false result in default behavior
+    #   which is to perform normal SDAM event publication.
     #
     # @since 2.1.0
+    # @api private
     def initialize(options = {})
+      @options = options
       if options[:monitoring] != false
         Global.subscribers.each do |topic, subscribers|
           subscribers.each do |subscriber|
@@ -212,9 +223,18 @@ module Mongo
         subscribe(SERVER_DESCRIPTION_CHANGED, ServerDescriptionChangedLogSubscriber.new(options))
         subscribe(TOPOLOGY_OPENING, TopologyOpeningLogSubscriber.new(options))
         subscribe(TOPOLOGY_CHANGED, TopologyChangedLogSubscriber.new(options))
+        subscribe(TOPOLOGY_CLOSED, TopologyClosedLogSubscriber.new(options))
       end
     end
 
+    # @api private
+    attr_reader :options
+
+    # @api private
+    def monitoring?
+      options[:monitoring] != false
+    end
+
     # Publish a started event.
     #
     # @example Publish a started event.
@@ -257,7 +277,10 @@ module Mongo
     private
 
     def initialize_copy(original)
-      @subscribers = original.subscribers.dup
+      @subscribers = {}
+      original.subscribers.each do |k, v|
+        @subscribers[k] = v.dup
+      end
     end
   end
 end
@@ -271,3 +294,4 @@ require 'mongo/monitoring/server_closed_log_subscriber'
 require 'mongo/monitoring/server_opening_log_subscriber'
 require 'mongo/monitoring/topology_changed_log_subscriber'
 require 'mongo/monitoring/topology_opening_log_subscriber'
+require 'mongo/monitoring/topology_closed_log_subscriber'