mongo 2.3.1 → 2.4.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2d9e9f00a79f50cd0a8acbfde72ceb13993a77d
-  data.tar.gz: 90cea8a2fe4251801c0cc40fdca77856c1c6b153
+  metadata.gz: 19ae8d6c4e2881b28ba15899b6f928e5f050ad5b
+  data.tar.gz: 7addb2834adeaaaf441891f34f58660faeead9d9
 SHA512:
-  metadata.gz: c39d5f4e21bf2ce5390f3cd9baab0dd67f350794b33f41f0deb08a65993b9c669cdbfbe7d2008d8a8105cfcf319da526e557848580f41c1e7c78ac63a40267f9
-  data.tar.gz: 55be4b7a6f20d2ed52dfd15d010391112927925bd3261c8c7d14a468460151a5dba91197983061004c600cf40b84b402a8d5227a670bdae1495fa845951b8a9c
+  metadata.gz: ad67bd7b0d541f6f97645004c983bd73183001fcd5ece022d3294d81ebaa8bb693bf96c3da944fbfdddde4064bfb23aa2503b82766326258dac53ebdafab4e36
+  data.tar.gz: 0d2a4a97d7a2b9ba1e8d40ccc19685336cf75c405558fae2db8e19e3b850ca7f4eb3e7cf81a6507fc2f35c2104e7604659e6e3afac3348ef67525806533ebcae

data.tar.gz.sig

@@ -1,3 +1,2 @@
-��V+f�ӱAbc��F�>��NRή��{�#2�%�S!����!TKV�ض�x�	�*�9�z+2�c�;�`v_��o�>�/��C،Ve�J��pH�AL��I�{�m8���r3��m%��Y��$0ρ_ií�X�o�:*�����0����l��u�\j͎h]�-���7]4fy�����a.t#�Q'��mR�2/�/{����
-z+|79��3(���C�����P�����-
-�\E�zݝ���"��Y�
+"d��"'�̑��(�w�0K_�u�4��1*�^���	�@�?�ȣ��h���r����@]=t�E��Z
�a`��;-�稓C=p��\떃�4�r�x�7+QIy\B
+�=.WX��E�:J4z�bc�x\=��jp)��y�s���ڬW)e �|wBos�ͬ���G-Xx��AOfj�`巪Z�`���z{���Wl�P"��J���͏˷P�HHO�2��ftz�h��,g�\hc

data/lib/mongo/bulk_write.rb

@@ -35,7 +35,10 @@ module Mongo
     attr_reader :options
 
     # Delegate various methods to the collection.
-    def_delegators :@collection, :database, :cluster, :next_primary
+    def_delegators :@collection,
+                   :database,
+                   :cluster,
+                   :next_primary
 
     def_delegators :database, :client
 
@@ -51,7 +54,9 @@ module Mongo
       operation_id = Monitoring.next_operation_id
       result_combiner = ResultCombiner.new
       write_with_retry do
+        operations = op_combiner.combine
         server = next_primary
+        raise Error::UnsupportedCollation.new if op_combiner.has_collation && !server.features.collation_enabled?
         operations.each do |operation|
           execute_operation(
             operation.keys.first,
@@ -153,12 +158,8 @@ module Mongo
       end
     end
 
-    def operations
-      if ordered?
-        OrderedCombiner.new(requests).combine
-      else
-        UnorderedCombiner.new(requests).combine
-      end
+    def op_combiner
+      @op_combiner ||= ordered? ? OrderedCombiner.new(requests) : UnorderedCombiner.new(requests)
     end
 
     def split_execute(name, values, server, operation_id, combiner)

data/lib/mongo/bulk_write/combineable.rb

@@ -25,6 +25,9 @@ module Mongo
       # @return [ Array<Hash, BSON::Document> ] requests The provided requests.
       attr_reader :requests
 
+      # @return [ true, false ] has_collation Whether one or more operations has a collation defined.
+      attr_reader :has_collation
+
       # Create the ordered combiner.
       #
       # @api private
@@ -37,6 +40,7 @@ module Mongo
       # @since 2.1.0
       def initialize(requests)
         @requests = requests
+        @has_collation = false
       end
 
       private

data/lib/mongo/bulk_write/transformable.rb

@@ -56,14 +56,20 @@ module Mongo
       #
       # @since 2.1.0
       DELETE_MANY_TRANSFORM = ->(doc){
-        { Operation::Q => doc[:filter], Operation::LIMIT => 0 }
+        { Operation::Q => doc[:filter],
+          Operation::LIMIT => 0 }.tap do |d|
+          d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+        end
       }
 
       # Proc to transform delete one ops.
       #
       # @since 2.1.0
       DELETE_ONE_TRANSFORM = ->(doc){
-        { Operation::Q => doc[:filter], Operation::LIMIT => 1 }
+        { Operation::Q => doc[:filter],
+          Operation::LIMIT => 1 }.tap do |d|
+          d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+        end
       }
 
       # Proc to transform insert one ops.
@@ -82,7 +88,9 @@ module Mongo
           Operation::U => doc[:replacement],
           Operation::MULTI => false,
           Operation::UPSERT => doc.fetch(:upsert, false)
-        }
+        }.tap do |d|
+          d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+        end
       }
 
       # Proc to transform update many ops.
@@ -94,7 +102,9 @@ module Mongo
           Operation::U => doc[:update],
           Operation::MULTI => true,
           Operation::UPSERT => doc.fetch(:upsert, false)
-        }
+        }.tap do |d|
+          d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+        end
       }
 
       # Proc to transform update one ops.
@@ -106,7 +116,9 @@ module Mongo
           Operation::U => doc[:update],
           Operation::MULTI => false,
           Operation::UPSERT => doc.fetch(:upsert, false)
-        }
+        }.tap do |d|
+          d[Operation::COLLATION] = doc[:collation] if doc[:collation]
+        end
       }
 
       # Document mappers from the bulk api input into proper commands.

data/lib/mongo/bulk_write/validatable.rb

@@ -40,6 +40,7 @@ module Mongo
       def validate(name, document)
         validate_operation(name)
         validate_document(name, document)
+        @has_collation = true if document.respond_to?(:keys) && document[:collation]
       end
 
       private

data/lib/mongo/client.rb

@@ -32,6 +32,7 @@ module Mongo
     #
     # @since 2.1.2
     VALID_OPTIONS = [
+      :app_name,
       :auth_mech,
       :auth_mech_properties,
       :auth_source,
@@ -192,6 +193,8 @@ module Mongo
     #   in which reads on a mongos are retried.
     # @option options [ Object ] :id_generator A custom object to generate ids
     #   for documents. Must respond to #generate.
+    # @option options [ String, Symbol ] :app_name Application name that is printed to the
+    #   mongod logs upon establishing a connection in server versions >= 3.4.
     #
     # @since 2.0.0
     def initialize(addresses_or_uri, options = Options::Redacted.new)

data/lib/mongo/cluster.rb

@@ -14,6 +14,7 @@
 
 require 'mongo/cluster/topology'
 require 'mongo/cluster/cursor_reaper'
+require 'mongo/cluster/app_metadata'
 
 module Mongo
 
@@ -42,6 +43,12 @@ module Mongo
     # @return [ Object ] The cluster topology.
     attr_reader :topology
 
+    # @return [ Mongo::Cluster::AppMetadata ] The application metadata, used for connection
+    #   handshakes.
+    #
+    # @since 2.4.0
+    attr_reader :app_metadata
+
     def_delegators :topology, :replica_set?, :replica_set_name, :sharded?, :single?, :unknown?
     def_delegators :@cursor_reaper, :register_cursor, :schedule_kill_cursor, :unregister_cursor
 
@@ -106,6 +113,7 @@ module Mongo
       @monitoring = monitoring
       @event_listeners = Event::Listeners.new
       @options = options.freeze
+      @app_metadata ||= AppMetadata.new(self)
       @topology = Topology.initial(seeds, options)
       @update_lock = Mutex.new
       @pool_lock = Mutex.new

data/lib/mongo/cluster/app_metadata.rb

@@ -0,0 +1,135 @@
+# Copyright (C) 2016 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 'rbconfig'
+
+module Mongo
+  class Cluster
+
+    # Application metadata that is sent to the server in an ismaster command,
+    #   when a new connection is established.
+    #
+    # @api private
+    #
+    # @since 2.4.0
+    class AppMetadata
+      extend Forwardable
+
+      # The max application metadata document byte size.
+      #
+      # @since 2.4.0
+      MAX_DOCUMENT_SIZE = 512.freeze
+
+      # The max application name byte size.
+      #
+      # @ since 2.4.0
+      MAX_APP_NAME_SIZE = 128.freeze
+
+      # Instantiate the new AppMetadata object.
+      #
+      # @api private
+      #
+      # @example Instantiate the app metadata.
+      #   Mongo::Cluster.AppMetadata.new(cluster)
+      #
+      # @param [ Mongo::Cluster ] cluster The cluster.
+      #
+      # @since 2.4.0
+      def initialize(cluster)
+        @app_name = cluster.options[:app_name]
+      end
+
+      # Get the bytes of the ismaster message including this metadata.
+      #
+      # @api private
+      #
+      # @example Get the ismaster message bytes.
+      #   metadata.ismaster_bytes
+      #
+      # @return [ String ] The raw bytes.
+      #
+      # @since 2.4.0
+      def ismaster_bytes
+        @ismaster_bytes ||= validate! && serialize.to_s
+      end
+
+      private
+
+      def validate!
+        if @app_name && @app_name.bytesize > MAX_APP_NAME_SIZE
+          raise Error::InvalidApplicationName.new(@app_name, MAX_APP_NAME_SIZE)
+        end
+        true
+      end
+
+      def full_client_document
+        BSON::Document.new.tap do |doc|
+          doc[:application] = { name: @app_name } if @app_name
+          doc[:driver] = driver_doc
+          doc[:os] = os_doc
+          doc[:platform] = platform
+        end
+      end
+
+      def serialize
+        client_document = full_client_document
+        while client_document.to_bson.to_s.size > MAX_DOCUMENT_SIZE do
+          if client_document[:os][:name] || client_document[:os][:architecture]
+            client_document[:os].delete(:name)
+            client_document[:os].delete(:architecture)
+          elsif client_document[:platform]
+            client_document.delete(:platform)
+          else
+            client_document = nil
+          end
+        end
+        document = Server::Monitor::Connection::ISMASTER
+        document = document.merge(client: client_document) if client_document
+        Protocol::Query.new(Database::ADMIN, Database::COMMAND, document, :limit => -1).serialize
+      end
+
+      def driver_doc
+        {
+          name: :'mongo-ruby-driver',
+          version: Mongo::VERSION
+        }
+      end
+
+      def os_doc
+        {
+          type: type,
+          name: name,
+          architecture: architecture
+        }
+      end
+
+      def type
+        (RbConfig::CONFIG && RbConfig::CONFIG['host_os']) ?
+          RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase.to_sym : :unknown
+      end
+
+      def name
+        RbConfig::CONFIG['host_os']
+      end
+
+      def architecture
+        RbConfig::CONFIG['target_cpu']
+      end
+
+      def platform
+        [RUBY_VERSION, RUBY_PLATFORM, RbConfig::CONFIG['build']].join(', ')
+      end
+    end
+  end
+end

data/lib/mongo/collection.rb

@@ -124,8 +124,7 @@ module Mongo
     #
     # @since 2.0.0
     def write_concern
-      @write_concern ||= options[:write] ? WriteConcern.get(options[:write]) :
-        database.write_concern
+      @write_concern ||= WriteConcern.get(options[:write] || database.write_concern)
     end
 
     # Provides a new collection with either a new read preference or new write concern
@@ -170,7 +169,15 @@ module Mongo
     #
     # @since 2.0.0
     def create
-      database.command({ :create => name }.merge(options))
+      operation = { :create => name }.merge(options)
+      operation.delete(:write)
+      server = next_primary
+      raise Error::UnsupportedCollation.new if options[:collation] && !server.features.collation_enabled?
+      Operation::Commands::Create.new({
+                                        selector: operation,
+                                        db_name: database.name,
+                                        write_concern: write_concern
+                                      }).execute(server)
     end
 
     # Drop the collection. Will also drop all indexes associated with the
@@ -185,7 +192,12 @@ module Mongo
     #
     # @since 2.0.0
     def drop
-      database.command(:drop => name)
+      Operation::Commands::Drop.new({
+                                      selector: { :drop => name },
+                                      db_name: database.name,
+                                      write_concern: write_concern
+                                    }).execute(next_primary)
+
     rescue Error::OperationFailure => ex
       raise ex unless ex.message =~ /ns not found/
       false
@@ -223,6 +235,7 @@ module Mongo
     # @option options [ Integer ] :skip The number of docs to skip before returning results.
     # @option options [ Hash ] :sort The key and direction pairs by which the result set
     #   will be sorted.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ CollectionView ] The collection view.
     #
@@ -248,6 +261,7 @@ module Mongo
     #   provide results using a cursor.
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ Aggregation ] The aggregation object.
     #
@@ -269,6 +283,7 @@ module Mongo
     # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command to run.
     # @option options [ Integer ] :skip The number of documents to skip before counting.
     # @option options [ Hash ] :read The read preference options.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ Integer ] The document count.
     #
@@ -288,6 +303,7 @@ module Mongo
     #
     # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command to run.
     # @option options [ Hash ] :read The read preference options.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ Array<Object> ] The list of distinct values.
     #
@@ -392,12 +408,15 @@ module Mongo
     #   collection.delete_one
     #
     # @param [ Hash ] filter The filter to use.
+    # @param [ Hash ] options The options.
+    #
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ Result ] The response from the database.
     #
     # @since 2.1.0
-    def delete_one(filter = nil)
-      find(filter).delete_one
+    def delete_one(filter = nil, options = {})
+      find(filter).delete_one(options)
     end
 
     # Remove documents from the collection.
@@ -406,12 +425,15 @@ module Mongo
     #   collection.delete_many
     #
     # @param [ Hash ] filter The filter to use.
+    # @param [ Hash ] options The options.
+    #
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ Result ] The response from the database.
     #
     # @since 2.1.0
-    def delete_many(filter = nil)
-      find(filter).delete_many
+    def delete_many(filter = nil, options = {})
+      find(filter).delete_many(options)
     end
 
     # Execute a parallel scan on the collection view.
@@ -424,12 +446,16 @@ module Mongo
     #   collection.parallel_scan(2)
     #
     # @param [ Integer ] cursor_count The max number of cursors to return.
+    # @param [ Hash ] options The parallel scan command options.
+    #
+    # @option options [ Integer ] :max_time_ms The maximum amount of time to allow the command
+    #   to run in milliseconds.
     #
     # @return [ Array<Cursor> ] An array of cursors.
     #
     # @since 2.1
-    def parallel_scan(cursor_count)
-      find.send(:parallel_scan, cursor_count)
+    def parallel_scan(cursor_count, options = {})
+      find.send(:parallel_scan, cursor_count, options)
     end
 
     # Replaces a single document in the collection with the new document.
@@ -445,6 +471,7 @@ module Mongo
     #   document doesn't exist.
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ Result ] The response from the database.
     #
@@ -466,6 +493,7 @@ module Mongo
     #   document doesn't exist.
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ Result ] The response from the database.
     #
@@ -487,6 +515,7 @@ module Mongo
     #   document doesn't exist.
     # @option options [ true, false ] :bypass_document_validation Whether or
     #   not to skip document level validation.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ Result ] The response from the database.
     #
@@ -511,6 +540,7 @@ module Mongo
     #   will be sorted.
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ BSON::Document, nil ] The document, if found.
     #
@@ -543,6 +573,7 @@ module Mongo
     #   not to skip document level validation.
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ BSON::Document ] The document.
     #
@@ -575,6 +606,7 @@ module Mongo
     #   not to skip document level validation.
     # @option options [ Hash ] :write_concern The write concern options.
     #   Defaults to the collection's write concern.
+    # @option options [ Hash ] :collation The collation to use.
     #
     # @return [ BSON::Document ] The document.
     #