mongo 2.1.0.beta → 2.2.0

data/lib/mongo/monitoring/event/command_succeeded.rb

@@ -20,6 +20,7 @@ module Mongo
       #
       # @since 2.1.0
       class CommandSucceeded
+        include Secure
 
         # @return [ Server::Address ] address The server address.
         attr_reader :address
@@ -61,7 +62,7 @@ module Mongo
           @address = address
           @request_id = request_id
           @operation_id = operation_id
-          @reply = reply
+          @reply = redacted(command_name, reply)
           @duration = duration
         end
 
@@ -86,10 +87,31 @@ module Mongo
             address,
             command_payload[:request_id],
             operation_id,
-            reply_payload ? reply_payload[:reply] : nil,
+            generate_reply(command_payload, reply_payload),
             duration
           )
         end
+
+        private
+
+        def self.generate_reply(command_payload, reply_payload)
+          if reply_payload
+            reply = reply_payload[:reply]
+            if cursor = reply[:cursor]
+              if !cursor.key?(Collection::NS)
+                cursor.merge!(Collection::NS => namespace(command_payload))
+              end
+            end
+            reply
+          else
+            BSON::Document.new(Operation::Result::OK => 1)
+          end
+        end
+
+        def self.namespace(payload)
+          command = payload[:command]
+          "#{payload[:database_name]}.#{command[:collection] || command.values.first}"
+        end
       end
     end
   end

data/lib/mongo/monitoring/event/secure.rb

@@ -0,0 +1,58 @@
+# 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.
+
+module Mongo
+  class Monitoring
+    module Event
+
+      # Provides behaviour to redact sensitive information from commands and
+      # replies.
+      #
+      # @since 2.1.0
+      module Secure
+
+        # The list of commands that has the data redacted for security.
+        #
+        # @since 2.1.0
+        REDACTED_COMMANDS = [
+          'authenticate',
+          'saslStart',
+          'saslContinue',
+          'getnonce',
+          'createUser',
+          'updateUser',
+          'copydbgetnonce',
+          'copydbsaslstart',
+          'copydb'
+        ].freeze
+
+        # Redact secure information from the document if it's command is in the
+        # list.
+        #
+        # @example Get the redacted document.
+        #   secure.redacted(command_name, document)
+        #
+        # @param [ String, Symbol ] command_name The command name.
+        # @param [ BSON::Document ] document The document.
+        #
+        # @return [ BSON::Document ] The redacted document.
+        #
+        # @since 2.1.0
+        def redacted(command_name, document)
+          REDACTED_COMMANDS.include?(command_name.to_s) ? BSON::Document.new : document
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/monitoring/event/secure'
 require 'mongo/monitoring/event/command_started'
 require 'mongo/monitoring/event/command_succeeded'
 require 'mongo/monitoring/event/command_failed'

data/lib/mongo/monitoring/publishable.rb

@@ -37,14 +37,20 @@ module Mongo
       # @since 2.1.0
       def publish_command(messages, operation_id = Monitoring.next_operation_id)
         start = Time.now
-        payload = messages.first.payload
+        message = messages.first
+        message.set_request_id
+        payload = message.payload
+        send_duration = duration(start)
         command_started(address, operation_id, payload)
+        receive_start = Time.now
         begin
           result = yield(messages)
-          command_completed(result, address, operation_id, payload, start)
+          total_duration = duration(receive_start) + send_duration
+          command_completed(result, address, operation_id, payload, total_duration)
           result
         rescue Exception => e
-          command_failed(address, operation_id, payload, e.message, start)
+          total_duration = duration(receive_start) + send_duration
+          command_failed(address, operation_id, payload, e.message, total_duration)
           raise e
         end
       end
@@ -58,17 +64,17 @@ module Mongo
         )
       end
 
-      def command_completed(result, address, operation_id, payload, start)
+      def command_completed(result, address, operation_id, payload, duration)
         document = result ? (result.documents || []).first : nil
-        parser = Error::Parser.new(document)
-        if parser.message.empty?
-          command_succeeded(result, address, operation_id, payload, start)
+        if error?(document)
+          parser = Error::Parser.new(document)
+          command_failed(address, operation_id, payload, parser.message, duration)
         else
-          command_failed(address, operation_id, payload, parser.message, start)
+          command_succeeded(result, address, operation_id, payload, duration)
         end
       end
 
-      def command_succeeded(result, address, operation_id, payload, start)
+      def command_succeeded(result, address, operation_id, payload, duration)
         monitoring.succeeded(
           Monitoring::COMMAND,
           Event::CommandSucceeded.generate(
@@ -76,21 +82,25 @@ module Mongo
             operation_id,
             payload,
             result ? result.payload : nil,
-            duration(start)
+            duration
           )
         )
       end
 
-      def command_failed(address, operation_id, payload, message, start)
+      def command_failed(address, operation_id, payload, message, duration)
         monitoring.failed(
           Monitoring::COMMAND,
-          Event::CommandFailed.generate(address, operation_id, payload, message, duration(start))
+          Event::CommandFailed.generate(address, operation_id, payload, message, duration)
         )
       end
 
       def duration(start)
         Time.now - start
       end
+
+      def error?(document)
+        document && (document['ok'] == 0 || document.key?('$err'))
+      end
     end
   end
 end

data/lib/mongo/monitoring.rb

@@ -83,11 +83,6 @@ module Mongo
       end
     end
 
-    # Adds our internal command logging to the global subscribers.
-    #
-    # @since 2.1.0
-    Global.subscribe(COMMAND, CommandLogSubscriber.new)
-
     # Initialize the monitoring.
     #
     # @api private
@@ -105,6 +100,7 @@ module Mongo
             subscribe(topic, subscriber)
           end
         end
+        subscribe(COMMAND, CommandLogSubscriber.new(options))
       end
     end
 

data/lib/mongo/operation/commands/aggregate/result.rb

@@ -0,0 +1,89 @@
+# 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
+  module Operation
+    module Commands
+
+      # Aggregate result wrapper.
+      #
+      # @since 2.0.0
+      class Aggregate
+
+        # Defines custom behaviour of results in an aggregation context.
+        #
+        # @since 2.0.0
+        class Result < Operation::Result
+
+          # The field name for the aggregation explain information.
+          #
+          # @since 2.0.5
+          EXPLAIN = 'stages'.freeze
+
+          # The legacy field name for the aggregation explain information.
+          #
+          # @since 2.0.5
+          EXPLAIN_LEGACY = 'serverPipeline'.freeze
+
+          # Get the cursor id for the result.
+          #
+          # @example Get the cursor id.
+          #   result.cursor_id
+          #
+          # @note Even though the wire protocol has a cursor_id field for all
+          #   messages of type reply, it is always zero when using the
+          #   aggregation framework and must be retrieved from the cursor
+          #   document itself. Wahnsinn!
+          #
+          # @return [ Integer ] The cursor id.
+          #
+          # @since 2.0.0
+          def cursor_id
+            cursor_document ? cursor_document[CURSOR_ID] : super
+          end
+
+          # Get the documents for the aggregation result. This is either the
+          # first document's 'result' field, or if a cursor option was selected
+          # it is the 'firstBatch' field in the 'cursor' field of the first
+          # document returned.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.0.0
+          def documents
+            reply.documents[0][RESULT] || explain_document ||
+                cursor_document[FIRST_BATCH]
+          end
+
+          private
+
+          def explain_document
+            first_document[EXPLAIN] || first_document[EXPLAIN_LEGACY]
+          end
+
+          def cursor_document
+            @cursor_document ||= reply.documents[0][CURSOR]
+          end
+
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/commands/aggregate.rb

@@ -0,0 +1,64 @@
+# 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
+  module Operation
+    module Commands
+
+      # A MongoDB aggregate operation.
+      #
+      # @note An aggregate operation can behave like a read and return a 
+      #   result set, or can behave like a write operation and
+      #   output results to a user-specified collection.
+      #
+      # @example Create the aggregate operation.
+      #   Aggregate.new({
+      #     :selector => {
+      #       :aggregate => 'test_coll', :pipeline => [{ '$out' => 'test-out' }]
+      #     },
+      #     :db_name => 'test_db'
+      #   })
+      #
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the operation.
+      #
+      #   option spec :selector [ Hash ] The aggregate selector.
+      #   option spec :db_name [ String ] The name of the database on which
+      #     the operation should be executed.
+      #   option spec :options [ Hash ] Options for the aggregate command.
+      #
+      # @since 2.0.0
+      class Aggregate < Command
+
+        private
+
+        def filter_selector(context)
+          return selector if context.features.write_command_enabled?
+          selector.reject{ |option, value| option.to_s == 'cursor' }
+        end
+
+        def update_selector(context)
+          if context.mongos? && read_pref = read.to_mongos
+            sel = selector[:$query] ? filter_selector(context) : { :$query => filter_selector(context) }
+            sel.merge(:$readPreference => read_pref)
+          else
+            filter_selector(context)
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'mongo/operation/commands/aggregate/result'

data/lib/mongo/operation/commands/collections_info/result.rb

@@ -0,0 +1,41 @@
+# 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
+  module Operation
+    module Commands
+      class CollectionsInfo
+
+        # Defines custom behaviour of results when query the system.namespaces
+        # collection.
+        #
+        # @since 2.1.0
+        class Result < Operation::Result
+
+          # Get the namespace for the cursor.
+          #
+          # @example Get the namespace.
+          #   result.namespace
+          #
+          # @return [ String ] The namespace.
+          #
+          # @since 2.1.0
+          def namespace
+            Database::NAMESPACES
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/{read → commands}/collections_info.rb

@@ -12,9 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/operation/commands/collections_info/result'
+
 module Mongo
   module Operation
-    module Read
+    module Commands
 
       # A MongoDB operation to get a list of collection names in a database.
       #
@@ -30,9 +32,9 @@ module Mongo
       #
       # @since 2.0.0
       class CollectionsInfo
-        include Executable
         include Specifiable
-        include ReadPreferrable
+        include ReadPreference
+        include Executable
 
         # Execute the operation.
         # The context gets a connection on which the operation

data/lib/mongo/operation/commands/command.rb

@@ -0,0 +1,47 @@
+# 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
+  module Operation
+    module Commands
+
+      # A MongoDB command operation.
+      #
+      # @example Create the command operation.
+      #   Mongo::Operation::Command.new({ :selector => { :isMaster => 1 } })
+      #
+      # Initialization:
+      #   param [ Hash ] spec The specifications for the command.
+      #
+      #   option spec :selector [ Hash ] The command selector.
+      #   option spec :db_name [ String ] The name of the database on which
+      #   the command should be executed.
+      #   option spec :options [ Hash ] Options for the command.
+      #
+      # @since 2.0.0
+      class Command
+        include Specifiable
+        include Limited
+        include ReadPreference
+        include Executable
+
+        private
+
+        def query_coll
+          Database::COMMAND
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/commands/find/result.rb

@@ -0,0 +1,62 @@
+# 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.
+
+module Mongo
+  module Operation
+    module Commands
+      class Find
+
+        # Defines custom behaviour of results in find command.
+        #
+        # @since 2.2.0
+        class Result < Operation::Result
+
+          # Get the cursor id.
+          #
+          # @example Get the cursor id.
+          #   result.cursor_id
+          #
+          # @return [ Integer ] The cursor id.
+          #
+          # @since 2.2.0
+          def cursor_id
+            cursor_document ? cursor_document[CURSOR_ID] : super
+          end
+
+          # Get the documents in the result.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.2.0
+          def documents
+            cursor_document[FIRST_BATCH]
+          end
+
+          private
+
+          def cursor_document
+            @cursor_document ||= reply.documents[0][CURSOR]
+          end
+
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/commands/find.rb

@@ -0,0 +1,27 @@
+# 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.
+
+module Mongo
+  module Operation
+    module Commands
+
+      # Encapsulates behaviour for executing a find command.
+      #
+      # @since 2.2.0
+      class Find < Command; end
+    end
+  end
+end
+
+require 'mongo/operation/commands/find/result'

data/lib/mongo/operation/commands/get_more/result.rb

@@ -0,0 +1,62 @@
+# 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.
+
+module Mongo
+  module Operation
+    module Commands
+      class GetMore
+
+        # Defines custom behaviour of results for the get more command.
+        #
+        # @since 2.2.0
+        class Result < Operation::Result
+
+          # Get the cursor id.
+          #
+          # @example Get the cursor id.
+          #   result.cursor_id
+          #
+          # @return [ Integer ] The cursor id.
+          #
+          # @since 2.2.0
+          def cursor_id
+            cursor_document ? cursor_document[CURSOR_ID] : super
+          end
+
+          # Get the documents in the result.
+          #
+          # @example Get the documents.
+          #   result.documents
+          #
+          # @return [ Array<BSON::Document> ] The documents.
+          #
+          # @since 2.2.0
+          def documents
+            cursor_document[NEXT_BATCH]
+          end
+
+          private
+
+          def cursor_document
+            @cursor_document ||= reply.documents[0][CURSOR]
+          end
+
+          def first_document
+            @first_document ||= reply.documents[0]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo/operation/commands/get_more.rb

@@ -0,0 +1,27 @@
+# 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.
+
+module Mongo
+  module Operation
+    module Commands
+
+      # Encapsulates behaviour for executing a getmore command.
+      #
+      # @since 2.2.0
+      class GetMore < Command; end
+    end
+  end
+end
+
+require 'mongo/operation/commands/get_more/result'