mongo 2.14.0 → 2.16.0

data/lib/mongo/server_selector/nearest.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,13 +41,12 @@ module Mongo
         :nearest
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk 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?
+      # @api private
+      def secondary_ok?
         true
       end
 

data/lib/mongo/server_selector/primary.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,13 +42,12 @@ module Mongo
         :primary
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk 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?
+      # @api private
+      def secondary_ok?
         false
       end
 

data/lib/mongo/server_selector/primary_preferred.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,13 +42,12 @@ module Mongo
         :primary_preferred
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk 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?
+      # @api private
+      def secondary_ok?
         true
       end
 

data/lib/mongo/server_selector/secondary.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,13 +42,12 @@ module Mongo
         :secondary
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk 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?
+      # @api private
+      def secondary_ok?
         true
       end
 

data/lib/mongo/server_selector/secondary_preferred.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,13 +42,12 @@ module Mongo
         :secondary_preferred
       end
 
-      # Whether the slaveOk bit should be set on wire protocol messages.
+      # Whether the secondaryOk 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?
+      # @api private
+      def secondary_ok?
         true
       end
 
@@ -86,13 +88,8 @@ module Mongo
       #
       # @since 2.0.0
       def to_mongos
-        if tag_sets.empty? && max_staleness.nil? && hedge.nil?
-          # The server preference is not sent to mongos as part of the query
-          # selector if there are no tag sets, for maximum backwards compatibility.
-          nil
-        else
-          to_doc
-        end
+        # Always send the read preference to mongos: DRIVERS-1642.
+        to_doc
       end
 
       private

data/lib/mongo/server_selector.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/session/server_session.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/session/session_pool.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -119,8 +122,10 @@ module Mongo
             },
             db_name: Database::ADMIN,
           )
-          # end_sessions does not take a client as an argument
-          op.execute(server, client: nil)
+          context = Operation::Context.new(options: {
+            server_api: server.options[:server_api],
+          })
+          op.execute(server, context: context)
         end
       rescue Mongo::Error, Error::AuthError
       end
@@ -128,6 +133,13 @@ module Mongo
       private
 
       def about_to_expire?(session)
+        # Load balancers spec explicitly requires to ignore the logical session
+        # timeout value.
+        # No rationale is provided as of the time of this writing.
+        if @cluster.load_balanced?
+          return false
+        end
+
         logical_session_timeout = @cluster.logical_session_timeout
 
         if logical_session_timeout
@@ -137,6 +149,10 @@ module Mongo
       end
 
       def prune!
+        # Load balancers spec explicitly requires not to prune sessions.
+        # No rationale is provided as of the time of this writing.
+        return if @cluster.load_balanced?
+
         while !@queue.empty?
           if about_to_expire?(@queue[-1])
             @queue.pop

data/lib/mongo/session.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -205,6 +208,12 @@ module Mongo
     # @api private
     attr_reader :pinned_server
 
+    # @return [ Object | nil ] The service id that this session is pinned to,
+    #   if any.
+    #
+    # @api private
+    attr_reader :pinned_service_id
+
     # @return [ BSON::Document | nil ] Recovery token for the sharded
     #   transaction being executed on this session, if any.
     #
@@ -366,7 +375,7 @@ module Mongo
     # @since 2.7.0
     def with_transaction(options=nil)
       # Non-configurable 120 second timeout for the entire operation
-      deadline = Time.now + 120
+      deadline = Utils.monotonic_time + 120
       transaction_in_progress = false
       loop do
         commit_options = {}
@@ -384,7 +393,7 @@ module Mongo
             transaction_in_progress = false
           end
 
-          if Time.now >= deadline
+          if Utils.monotonic_time >= deadline
             transaction_in_progress = false
             raise
           end
@@ -406,7 +415,7 @@ module Mongo
             return rv
           rescue Mongo::Error => e
             if e.label?('UnknownTransactionCommitResult')
-              if Time.now >= deadline ||
+              if Utils.monotonic_time >= deadline ||
                 e.is_a?(Error::OperationFailure) && e.max_time_ms_expired?
               then
                 transaction_in_progress = false
@@ -423,10 +432,11 @@ module Mongo
               commit_options[:write_concern] = wc_options.merge(w: :majority)
               retry
             elsif e.label?('TransientTransactionError')
-              if Time.now >= deadline
+              if Utils.monotonic_time >= deadline
                 transaction_in_progress = false
                 raise
               end
+              @state = NO_TRANSACTION_STATE
               next
             else
               transaction_in_progress = false
@@ -582,7 +592,7 @@ module Mongo
               txn_num: txn_num,
               write_concern: write_concern,
             }
-            Operation::Command.new(spec).execute(server, client: @client)
+            Operation::Command.new(spec).execute(server, context: Operation::Context.new(client: @client, session: self))
           end
         end
       ensure
@@ -624,12 +634,16 @@ module Mongo
         unless starting_transaction?
           @aborting_transaction = true
           write_with_retry(self, txn_options[:write_concern], true) do |server, txn_num|
-            Operation::Command.new(
-              selector: { abortTransaction: 1 },
-              db_name: 'admin',
-              session: self,
-              txn_num: txn_num
-            ).execute(server, client: @client)
+            begin
+              Operation::Command.new(
+                selector: { abortTransaction: 1 },
+                db_name: 'admin',
+                session: self,
+                txn_num: txn_num
+              ).execute(server, context: Operation::Context.new(client: @client, session: self))
+            ensure
+              unpin
+            end
           end
         end
 
@@ -688,7 +702,7 @@ module Mongo
     # @param [ Server ] server The server to pin this session to.
     #
     # @api private
-    def pin(server)
+    def pin_to_server(server)
       if server.nil?
         raise ArgumentError, 'Cannot pin to a nil server'
       end
@@ -700,11 +714,24 @@ module Mongo
       @pinned_server = server
     end
 
+    # Pins this session to the specified service.
+    #
+    # @param [ Object ] service_id The service id to pin this session to.
+    #
+    # @api private
+    def pin_to_service(service_id)
+      if service_id.nil?
+        raise ArgumentError, 'Cannot pin to a nil service id'
+      end
+      @pinned_service_id = service_id
+    end
+
     # Unpins this session from the pinned server, if the session was pinned.
     #
     # @api private
     def unpin
       @pinned_server = nil
+      @pinned_service_id = nil
     end
 
     # Unpins this session from the pinned server, if the session was pinned

data/lib/mongo/socket/ocsp_cache.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/socket/ocsp_verifier.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -216,7 +219,12 @@ module Mongo
           break
         end
 
-        resp = OpenSSL::OCSP::Response.new(http_response.body).basic
+        resp = OpenSSL::OCSP::Response.new(http_response.body)
+        unless resp.basic
+          @resp_errors << "OCSP response from #{report_uri(original_uri, uri)} is #{resp.status}: #{resp.status_string}"
+          return false
+        end
+        resp = resp.basic
         unless resp.verify([ca_cert], cert_store)
           # Ruby's OpenSSL binding discards error information - see
           # https://github.com/ruby/openssl/issues/395
@@ -229,43 +237,12 @@ module Mongo
           return false
         end
 
-        if resp.respond_to?(:find_response)
-          # Ruby 2.4+
-          resp = resp.find_response(cert_id)
-          # TODO make a new class instead of patching the stdlib one?
-          resp.instance_variable_set('@uri', uri)
-          resp.instance_variable_set('@original_uri', original_uri)
-          class << resp
-            attr_reader :uri, :original_uri
-          end
-        else
-          # Ruby 2.3
-          found = nil
-          resp.status.each do |_cert_id, cert_status, revocation_reason, revocation_time, this_update, next_update, extensions|
-            if _cert_id.cmp(cert_id)
-              found = OpenStruct.new(
-                cert_status: cert_status,
-                certid: _cert_id,
-                next_update: next_update,
-                this_update: this_update,
-                revocation_reason: revocation_reason,
-                revocation_time: revocation_time,
-                extensions: extensions,
-                uri: uri,
-                original_uri: original_uri,
-              )
-              class << found
-                # Unlike the stdlib method, this one doesn't accept
-                # any arguments.
-                def check_validity
-                  now = Time.now
-                  this_update <= now && next_update >= now
-                end
-              end
-              break
-            end
-          end
-          resp = found
+        resp = resp.find_response(cert_id)
+        # TODO make a new class instead of patching the stdlib one?
+        resp.instance_variable_set('@uri', uri)
+        resp.instance_variable_set('@original_uri', original_uri)
+        class << resp
+          attr_reader :uri, :original_uri
         end
 
         unless resp

data/lib/mongo/socket/ssl.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -106,6 +109,8 @@ module Mongo
         begin
           @tcp_socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, 1)
           set_socket_options(@tcp_socket)
+          run_tls_context_hooks
+
           connect!
         rescue
           @tcp_socket.close
@@ -379,6 +384,12 @@ module Mongo
       def human_address
         "#{host}:#{port} (#{host_name}:#{port}, TLS)"
       end
+
+      def run_tls_context_hooks
+        Mongo.tls_context_hooks.each do |hook|
+          hook.call(@context)
+        end
+      end
     end
   end
 end

data/lib/mongo/socket/tcp.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/socket/unix.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/socket.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,6 +33,7 @@ module Mongo
     # Error message for TLS related exceptions.
     #
     # @since 2.0.0
+    # @deprecated
     SSL_ERROR = 'MongoDB may not be configured with TLS support'.freeze
 
     # Error message for timeouts on socket calls.
@@ -154,7 +158,14 @@ module Mongo
     #
     # @since 2.0.0
     def close
-      @socket.close rescue nil
+      begin
+        # Sometimes it seems the close call can hang for a long time
+        ::Timeout.timeout(5) do
+          @socket.close
+        end
+      rescue
+        # Silence all errors
+      end
       true
     end
 
@@ -225,6 +236,8 @@ module Mongo
     #
     # @return [ Integer ] The length of bytes written to the socket.
     #
+    # @raise [ Error::SocketError | Error::SocketTimeoutError ] When there is a network error during the write.
+    #
     # @since 2.0.0
     def write(*args)
       map_exceptions do
@@ -261,7 +274,7 @@ module Mongo
       _timeout = timeout || self.timeout
       if _timeout
         if _timeout > 0
-          deadline = Time.now + _timeout
+          deadline = Utils.monotonic_time + _timeout
         elsif _timeout < 0
           raise Errno::ETIMEDOUT, "Negative timeout #{_timeout} given to socket"
         end
@@ -316,7 +329,7 @@ module Mongo
       # reading from a TLS socket may require writing which may raise WaitWritable
       rescue IO::WaitReadable, IO::WaitWritable => exc
         if deadline
-          select_timeout = deadline - Time.now
+          select_timeout = deadline - Utils.monotonic_time
           if select_timeout <= 0
             raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data"
           end
@@ -326,8 +339,21 @@ module Mongo
         else
           select_args = [nil, [@socket], [@socket], select_timeout]
         end
-        unless Kernel::select(*select_args)
-          raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data"
+        rv = Kernel.select(*select_args)
+        if BSON::Environment.jruby?
+          # Ignore the return value of Kernel.select.
+          # On JRuby, select appears to return nil prior to timeout expiration
+          # (apparently due to a EAGAIN) which then causes us to fail the read
+          # even though we could have retried it.
+          # Check the deadline ourselves.
+          if deadline
+            select_timeout = deadline - Utils.monotonic_time
+            if select_timeout <= 0
+              raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data"
+            end
+          end
+        elsif rv.nil?
+          raise Errno::ETIMEDOUT, "Took more than #{_timeout} seconds to receive data (select call timed out)"
         end
         retry
       end
@@ -398,6 +424,10 @@ module Mongo
       set_option(sock, :TCP_KEEPCNT, DEFAULT_TCP_KEEPCNT)
       set_option(sock, :TCP_KEEPIDLE, DEFAULT_TCP_KEEPIDLE)
     rescue
+      # JRuby 9.2.13.0 and lower do not define TCP_KEEPINTVL etc. constants.
+      # JRuby 9.2.14.0 defines the constants but does not allow to get or
+      # set them with this error:
+      # Errno::ENOPROTOOPT: Protocol not available - Protocol not available
     end
 
     def set_option(sock, option, default)
@@ -422,7 +452,7 @@ module Mongo
       rescue IOError, SystemCallError => e
         raise Error::SocketError, "#{e.class}: #{e} (for #{human_address})"
       rescue OpenSSL::SSL::SSLError => e
-        raise Error::SocketError, "#{e.class}: #{e} (for #{human_address}) (#{SSL_ERROR})"
+        raise Error::SocketError, "#{e.class}: #{e} (for #{human_address})"
       end
     end
 

data/lib/mongo/srv/monitor.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -59,11 +62,6 @@ module Mongo
       #   records' TTL values.
       attr_reader :last_result
 
-      def start!
-        super
-        ObjectSpace.define_finalizer(self, self.class.finalize(@thread))
-      end
-
       private
 
       def do_work
@@ -97,12 +95,6 @@ module Mongo
         @cluster.set_server_list(last_result.address_strs)
       end
 
-      def self.finalize(thread)
-        Proc.new do
-          thread.kill
-        end
-      end
-
       def scan_interval
         if last_result.empty?
           [cluster.heartbeat_interval, MIN_SCAN_INTERVAL].min

data/lib/mongo/srv/resolver.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/srv/result.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/srv.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2019-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');

data/lib/mongo/timeout.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo/topology_version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,7 +17,7 @@
 
 module Mongo
   # TopologyVersion encapsulates the topologyVersion document obtained from
-  # ismaster responses and not master-like OperationFailure errors.
+  # hello responses and not master-like OperationFailure errors.
   #
   # @api private
   class TopologyVersion < BSON::Document

data/lib/mongo/uri/options_mapper.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -82,6 +85,44 @@ module Mongo
         end
       end
 
+      def smc_to_ruby(opts)
+        uri_options = {}
+
+        opts.each do |key, value|
+          strategy = URI_OPTION_MAP[key.downcase]
+          if strategy.nil?
+            log_warn("Unsupported URI option '#{key}' on URI '#{@string}'. It will be ignored.")
+            return
+          end
+
+          group = strategy[:group]
+          target = if group
+            uri_options[group] || {}
+          else
+            uri_options
+          end
+
+          if key == 'readConcernLevel'
+            value = value.to_sym
+          end
+
+          #value = apply_transform(key, value, strategy[:type])
+          # Sometimes the value here would be nil, for example if we are processing
+          # read preference tags or auth mechanism properties and all of the
+          # data within is invalid. Ignore such options.
+          unless value.nil?
+            merge_uri_option(target, value, strategy[:name])
+          end
+
+          if group && !target.empty? && !uri_options.key?(group)
+            uri_options[group] = target
+          end
+        end
+
+        #p uri_options
+        uri_options
+      end
+
       # Converts Ruby options provided to "standardized MongoClient options".
       #
       # @param [ Hash ] opts Ruby options to convert.
@@ -227,6 +268,7 @@ module Mongo
       # Topology options
       uri_option 'directConnection', :direct_connection, type: :bool
       uri_option 'connect', :connect, type: :symbol
+      uri_option 'loadBalanced', :load_balanced, type: :bool
 
       # Auth Options
       uri_option 'authSource', :auth_source