mongo 2.3.1 → 2.16.0

data/lib/mongo/event/subscriber.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 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.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -12,29 +15,36 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mongo/event/listeners'
-require 'mongo/event/publisher'
-require 'mongo/event/subscriber'
-require 'mongo/event/primary_elected'
-require 'mongo/event/description_changed'
-require 'mongo/event/standalone_discovered'
-
 module Mongo
   module Event
 
     # When a standalone is discovered.
     #
     # @since 2.0.6
+    # @deprecated Will be removed in 3.0
     STANDALONE_DISCOVERED = 'standalone_discovered'.freeze
 
     # When a server is elected primary.
     #
     # @since 2.0.0
+    # @deprecated Will be removed in 3.0
     PRIMARY_ELECTED = 'primary_elected'.freeze
 
+    # When a server is discovered to be a member of a topology.
+    #
+    # @since 2.4.0
+    # @deprecated Will be removed in 3.0
+    MEMBER_DISCOVERED = 'member_discovered'.freeze
+
     # When a server is to be removed from a cluster.
     #
     # @since 2.0.6
+    # @deprecated Will be removed in 3.0
     DESCRIPTION_CHANGED = 'description_changed'.freeze
   end
 end
+
+require 'mongo/event/base'
+require 'mongo/event/listeners'
+require 'mongo/event/publisher'
+require 'mongo/event/subscriber'

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,13 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'stringio'
-
 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
@@ -153,8 +154,9 @@ module Mongo
           # @return [ String ] The assembled data.
           #
           # @since 2.0.0
+          # @api private
           def assemble(chunks)
-            chunks.reduce(''){ |data, chunk| data << chunk.data.data }
+            chunks.reduce(+''){ |data, chunk| data << chunk.data.data }
           end
 
           # Split the provided data into multiple chunks.
@@ -169,15 +171,16 @@ module Mongo
           # @return [ Array<Chunk> ] The chunks of the data.
           #
           # @since 2.0.0
+          # @api private
           def split(io, file_info, offset = 0)
             io = StringIO.new(io) if io.is_a?(String)
             parts = Enumerator.new { |y| y << io.read(file_info.chunk_size) until io.eof? }
             parts.map.with_index do |bytes, n|
-              file_info.md5.update(bytes)
+              file_info.update_md5(bytes)
               Chunk.new(
                 data: BSON::Binary.new(bytes),
                 files_id: file_info.id,
-                n: n + offset,
+                n: n + offset
               )
             end
           end

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 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 +19,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
       #
@@ -134,8 +137,14 @@ 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))
-          @client_md5 = Digest::MD5.new
         end
 
         # Get a readable inspection for the object.
@@ -184,10 +193,31 @@ module Mongo
         # @return [ String ] The md5 hash as a string.
         #
         # @since 2.0.0
+        #
+        # @deprecated as of 2.6.0
         def md5
           document[:md5] || @client_md5
         end
 
+        # Update the md5 hash if there is one.
+        #
+        # @example Update the md5 hash.
+        #   file_info.update_md5(bytes)
+        #
+        # @note This method is transitional and is provided for backwards compatibility.
+        # It will be removed when md5 support is deprecated entirely.
+        #
+        # @param [ String ] bytes The bytes to use to update the digest.
+        #
+        # @return [ Digest::MD5 ] The md5 hash object.
+        #
+        # @since 2.6.0
+        #
+        # @deprecated as of 2.6.0
+        def update_md5(bytes)
+          md5.update(bytes) if md5
+        end
+
         # Convert the file information document to BSON for storage.
         #
         # @note If no md5 exists in the file information document (it was loaded
@@ -203,7 +233,9 @@ module Mongo
         #
         # @since 2.0.0
         def to_bson(buffer = BSON::ByteBuffer.new, validating_keys = BSON::Config.validating_keys?)
-          document[:md5] ||= @client_md5.hexdigest
+          if @client_md5 && !document[:md5]
+            document[:md5] = @client_md5.hexdigest
+          end
           document.to_bson(buffer)
         end
 
@@ -225,7 +257,8 @@ module Mongo
           BSON::Document.new(
             :_id => BSON::ObjectId.new,
             :chunkSize => Chunk::DEFAULT_SIZE,
-            :uploadDate => Time.now.utc,
+            # MongoDB stores times with millisecond precision
+            :uploadDate => Time.now.utc.round(3),
             :contentType => DEFAULT_CONTENT_TYPE
           )
         end

data/lib/mongo/grid/file.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -104,6 +107,11 @@ module Mongo
       #   chunk objects and assemble the data. If we have an IO object, then
       #   it's the original file data and we must split it into chunks and set
       #   the original data itself.
+      #
+      # @param [ IO, String, Array<BSON::Document> ] value The file object,
+      #   file contents or chunk documents.
+      #
+      # @return [ Array<Grid::File::Chunk> ] Array of chunks.
       def initialize_chunks!(value)
         if value.is_a?(Array)
           @chunks = value.map{ |doc| Chunk.new(doc) }

data/lib/mongo/grid/fs_bucket.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2016 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -36,6 +39,49 @@ module Mongo
       # @since 2.1.0
       FILES_INDEX = { filename: 1, uploadDate: 1 }.freeze
 
+      # Create the GridFS.
+      #
+      # @example Create the GridFS.
+      #   Grid::FSBucket.new(database)
+      #
+      # @param [ Database ] database The database the files reside in.
+      # @param [ Hash ] options The GridFS options.
+      #
+      # @option options [ String ] :bucket_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ Integer ] :chunk_size Override the default chunk
+      #   size.
+      # @option options [ String ] :fs_name The prefix for the files and chunks
+      #   collections.
+      # @option options [ Hash ] :read The read preference options. The hash
+      #   may have the following items:
+      #   - *:mode* -- read preference specified as a symbol; valid values are
+      #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
+      #     and *:nearest*.
+      #   - *:tag_sets* -- an array of hashes.
+      #   - *:local_threshold*.
+      # @option options [ Session ] :session The session to use.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
+      #
+      # @since 2.0.0
+      def initialize(database, options = {})
+        @database = database
+        @options = options.dup
+=begin WriteConcern object support
+        if @options[:write_concern].is_a?(WriteConcern::Base)
+          # Cache the instance so that we do not needlessly reconstruct it.
+          @write_concern = @options[:write_concern]
+          @options[:write_concern] = @write_concern.options
+        end
+=end
+        @options.freeze
+        @chunks_collection = database[chunks_name]
+        @files_collection = database[files_name]
+      end
+
       # @return [ Collection ] chunks_collection The chunks collection.
       #
       # @since 2.0.0
@@ -70,6 +116,8 @@ module Mongo
       # @param [ Hash ] selector The selector to use in the find.
       # @param [ Hash ] options The options for the find.
       #
+      # @option options [ true, false ] :allow_disk_use Whether the server can
+      #   write temporary data to disk while executing the find operation.
       # @option options [ Integer ] :batch_size The number of documents returned in each batch
       #   of results from MongoDB.
       # @option options [ Integer ] :limit The max number of docs to return from the query.
@@ -84,7 +132,8 @@ module Mongo
       #
       # @since 2.1.0
       def find(selector = nil, options = {})
-        files_collection.find(selector, options.merge(read: read_preference))
+        opts = options.merge(read: read_preference) if read_preference
+        files_collection.find(selector, opts || options)
       end
 
       # Find a file in the GridFS.
@@ -130,31 +179,6 @@ module Mongo
         file.id
       end
 
-      # Create the GridFS.
-      #
-      # @example Create the GridFS.
-      #   Grid::FSBucket.new(database)
-      #
-      # @param [ Database ] database The database the files reside in.
-      # @param [ Hash ] options The GridFS options.
-      #
-      # @option options [ String ] :fs_name The prefix for the files and chunks
-      #   collections.
-      # @option options [ String ] :bucket_name The prefix for the files and chunks
-      #   collections.
-      # @option options [ Integer ] :chunk_size Override the default chunk
-      #   size.
-      # @option options [ String ] :write The write concern.
-      # @option options [ String ] :read The read preference.
-      #
-      # @since 2.0.0
-      def initialize(database, options = {})
-        @database = database
-        @options = options
-        @chunks_collection = database[chunks_name]
-        @files_collection = database[files_name]
-      end
-
       # Get the prefix for the GridFS
       #
       # @example Get the prefix.
@@ -164,7 +188,7 @@ module Mongo
       #
       # @since 2.0.0
       def prefix
-        @options[:fs_name] || @options[:bucket_name]|| DEFAULT_ROOT
+        @options[:fs_name] || @options[:bucket_name] || DEFAULT_ROOT
       end
 
       # Remove a single file from the GridFS.
@@ -194,8 +218,8 @@ module Mongo
       #
       # @since 2.1.0
       def delete(id)
-        result = files_collection.find(:_id => id).delete_one
-        chunks_collection.find(:files_id => id).delete_many
+        result = files_collection.find({ :_id => id }, @options).delete_one
+        chunks_collection.find({ :files_id => id }, @options).delete_many
         raise Error::FileNotFound.new(id, :id) if result.n == 0
         result
       end
@@ -206,17 +230,25 @@ module Mongo
       #   fs.open_download_stream(id)
       #
       # @param [ BSON::ObjectId, Object ] id The id of the file to read.
+      # @param [ Hash ] options The options.
+      #
+      # @option options [ BSON::Document ] :file_info_doc For internal
+      #   driver use only. A BSON document to use as file information.
       #
       # @return [ Stream::Read ] The stream to read from.
       #
       # @yieldparam [ Hash ] The read stream.
       #
       # @since 2.1.0
-      def open_download_stream(id)
-        read_stream(id).tap do |stream|
+      def open_download_stream(id, options = nil)
+        options = Utils.shallow_symbolize_keys(options || {})
+        read_stream(id, **options).tap do |stream|
           if block_given?
-            yield stream
-            stream.close
+            begin
+              yield stream
+            ensure
+              stream.close
+            end
           end
         end
       end
@@ -282,16 +314,15 @@ module Mongo
           skip = revision
           sort = { 'uploadDate' => Mongo::Index::ASCENDING }
         end
-        file_doc = files_collection.find({ filename: filename} ,
-                                           projection: { _id: 1 },
+        file_info_doc = files_collection.find({ filename: filename} ,
                                            sort: sort,
                                            skip: skip,
                                            limit: -1).first
-        unless file_doc
+        unless file_info_doc
           raise Error::FileNotFound.new(filename, :filename) unless opts[:revision]
           raise Error::InvalidFileRevision.new(filename, opts[:revision])
         end
-        open_download_stream(file_doc[:_id], &block)
+        open_download_stream(file_info_doc[:_id], file_info_doc: file_info_doc, &block)
       end
 
       # Downloads the contents of the stored file specified by filename and by the
@@ -329,23 +360,26 @@ module Mongo
         download_to_stream(open_download_stream_by_name(filename, opts).file_id, io)
       end
 
-      # Opens an upload stream to GridFS to which the contents of a user file came be written.
+      # Opens an upload stream to GridFS to which the contents of a file or
+      # blob can be written.
       #
-      # @example Open a stream to which the contents of a file came be written.
-      #   fs.open_upload_stream('a-file.txt')
-      #
-      # @param [ String ] filename The filename of the file to upload.
+      # @param [ String ] filename The name of the file in GridFS.
       # @param [ Hash ] opts The options for the write stream.
       #
-      # @option opts [ Object ] :file_id An optional unique file id. An ObjectId is generated otherwise.
+      # @option opts [ Object ] :file_id An optional unique file id.
+      #   A BSON::ObjectId is automatically generated if a file id is not
+      #   provided.
       # @option opts [ Integer ] :chunk_size Override the default chunk size.
-      # @option opts [ Hash ] :write The write concern.
       # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
       #   collection document.
       # @option opts [ String ] :content_type The content type of the file.
       #   Deprecated, please use the metadata document instead.
       # @option opts [ Array<String> ] :aliases A list of aliases.
       #   Deprecated, please use the metadata document instead.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
       #
       # @return [ Stream::Write ] The write stream.
       #
@@ -353,10 +387,14 @@ module Mongo
       #
       # @since 2.1.0
       def open_upload_stream(filename, opts = {})
-        write_stream(filename, opts).tap do |stream|
+        opts = Utils.shallow_symbolize_keys(opts)
+        write_stream(filename, **opts).tap do |stream|
           if block_given?
-            yield stream
-            stream.close
+            begin
+              yield stream
+            ensure
+              stream.close
+            end
           end
         end
       end
@@ -375,13 +413,16 @@ module Mongo
       #
       # @option opts [ Object ] :file_id An optional unique file id. An ObjectId is generated otherwise.
       # @option opts [ Integer ] :chunk_size Override the default chunk size.
-      # @option opts [ Hash ] :write The write concern.
       # @option opts [ Hash ] :metadata User data for the 'metadata' field of the files
       #   collection document.
       # @option opts [ String ] :content_type The content type of the file. Deprecated, please
       #   use the metadata document instead.
       # @option opts [ Array<String> ] :aliases A list of aliases. Deprecated, please use the
       #   metadata document instead.
+      # @option options [ Hash ] :write Deprecated. Equivalent to :write_concern
+      #   option.
+      # @option options [ Hash ] :write_concern The write concern options.
+      #   Can be :w => Integer|String, :fsync => Boolean, :j => Boolean.
       #
       # @return [ BSON::ObjectId ] The ObjectId file id.
       #
@@ -390,7 +431,10 @@ module Mongo
         open_upload_stream(filename, opts) do |stream|
           begin
             stream.write(io)
-          rescue IOError
+          # IOError and SystemCallError are for errors reading the io.
+          # Error::SocketError and Error::SocketTimeoutError are for
+          # writing to MongoDB.
+          rescue IOError, SystemCallError, Error::SocketError, Error::SocketTimeoutError
             begin
               stream.abort
             rescue Error::OperationFailure
@@ -402,14 +446,26 @@ module Mongo
 
       # Get the read preference.
       #
-      # @example Get the read preference.
-      #   fs.read_preference
-      #
-      # @return [ Mongo::ServerSelector ] The read preference.
-      #
-      # @since 2.1.0
+      # @note This method always returns a BSON::Document instance, even though
+      #   the FSBucket constructor specifies the type of :read as a Hash, not
+      #   as a BSON::Document.
+      #
+      # @return [ BSON::Document ] The read preference.
+      #   The document may have the following fields:
+      #   - *:mode* -- read preference specified as a symbol; valid values are
+      #     *:primary*, *:primary_preferred*, *:secondary*, *:secondary_preferred*
+      #     and *:nearest*.
+      #   - *:tag_sets* -- an array of hashes.
+      #   - *:local_threshold*.
       def read_preference
-        @read_preference ||= ServerSelector.get(@options[:read] || database.read_preference)
+        @read_preference ||= begin
+          pref = options[:read] || database.read_preference
+          if BSON::Document === pref
+            pref
+          else
+            BSON::Document.new(pref)
+          end
+        end
       end
 
       # Get the write concern.
@@ -421,18 +477,25 @@ module Mongo
       #
       # @since 2.1.0
       def write_concern
-        @write_concern ||= @options[:write] ? WriteConcern.get(@options[:write]) :
-            database.write_concern
+        @write_concern ||= if wco = @options[:write_concern] || @options[:write]
+          WriteConcern.get(wco)
+        else
+          database.write_concern
+        end
       end
 
       private
 
-      def read_stream(id)
-        Stream.get(self, Stream::READ_MODE, { file_id: id }.merge!(options))
+      # @param [ Hash ] opts The options.
+      #
+      # @option opts [ BSON::Document ] :file_info_doc For internal
+      #   driver use only. A BSON document to use as file information.
+      def read_stream(id, **opts)
+        Stream.get(self, Stream::READ_MODE, { file_id: id }.update(options).update(opts))
       end
 
-      def write_stream(filename, opts)
-        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.merge!(options).merge!(opts))
+      def write_stream(filename, **opts)
+        Stream.get(self, Stream::WRITE_MODE, { filename: filename }.update(options).update(opts))
       end
 
       def chunks_name
@@ -445,8 +508,27 @@ module Mongo
 
       def ensure_indexes!
         if files_collection.find({}, limit: 1, projection: { _id: 1 }).first.nil?
-          chunks_collection.indexes.create_one(FSBucket::CHUNKS_INDEX, :unique => true)
-          files_collection.indexes.create_one(FSBucket::FILES_INDEX)
+          create_index_if_missing!(files_collection, FSBucket::FILES_INDEX)
+        end
+
+        if chunks_collection.find({}, limit: 1, projection: { _id: 1 }).first.nil?
+          create_index_if_missing!(chunks_collection, FSBucket::CHUNKS_INDEX, :unique => true)
+        end
+      end
+
+      def create_index_if_missing!(collection, index_spec, options = {})
+        indexes_view = collection.indexes
+        begin
+          if indexes_view.get(index_spec).nil?
+            indexes_view.create_one(index_spec, options)
+          end
+        rescue Mongo::Error::OperationFailure => e
+          # proceed with index creation if a NamespaceNotFound error is thrown
+          if e.code == 26
+            indexes_view.create_one(index_spec, options)
+          else
+            raise
+          end
         end
       end
     end