MONGOID-5077 DocumentNotFound message fails to account for shard key (#5292)

* MONGOID-5077 DocumentNotFound message fails to account for shard key

* MONGOID-5077 change some language

* MONGOID-5077 slice by shard key

* MONGOID-5077 remove unnecessary code

Author: neilshweky

lib/config/locales/en.yml

@@ -72,6 +72,16 @@ en:
           resolution: "Search for attributes that are in the database or set
             the Mongoid.raise_not_found_error configuration option to false,
             which will cause a nil to be returned instead of raising this error."
+        document_with_shard_key_not_found:
+          message: "Document not found for class %{klass} with id %{missing} and
+            shard key %{shard_key}."
+          summary: "When calling %{klass}.find with an id and a shard key, each
+            parameter must match a document in the database or this error will
+            be raised. The search was for the id: %{missing} with
+            shard_key: %{shard_key} and it was not found."
+          resolution: "Search for an id/shard key that is in the database or set
+            the Mongoid.raise_not_found_error configuration option to false,
+            which will cause a nil to be returned instead of raising this error."
         empty_config_file:
           message: "Empty configuration file: %{path}."
           summary: "Your mongoid.yml configuration file appears to be empty."

lib/mongoid/errors/document_not_found.rb

@@ -20,7 +20,8 @@ class DocumentNotFound < MongoidError
       #
       # @param [ Class ] klass The model class.
       # @param [ Hash, Array, Object ] params The attributes or ids.
-      # @param [ Array ] unmatched The unmatched ids, if appropriate
+      # @param [ Array, Hash ] unmatched The unmatched ids, if appropriate. If
+      #   there is a shard key this will be a hash.
       def initialize(klass, params, unmatched = nil)
         if !unmatched && !params.is_a?(Hash)
           unmatched = Array(params)
@@ -29,13 +30,14 @@ def initialize(klass, params, unmatched = nil)
         @klass, @params = klass, params
         super(
           compose_message(
-            message_key(params),
+            message_key(params, unmatched),
             {
               klass: klass.name,
               searched: searched(params),
               attributes: params,
               total: total(params),
-              missing: missing(unmatched)
+              missing: missing(unmatched),
+              shard_key: shard_key(unmatched)
             }
           )
         )
@@ -54,6 +56,8 @@ def initialize(klass, params, unmatched = nil)
       def missing(unmatched)
         if unmatched.is_a?(::Array)
           unmatched.join(", ")
+        elsif unmatched.is_a?(::Hash)
+          unmatched[:_id] || unmatched["_id"]
         else
           unmatched
         end
@@ -93,10 +97,25 @@ def total(params)
       #   error.problem
       #
       # @return [ String ] The problem.
-      def message_key(params)
-        case params
-          when Hash then "document_with_attributes_not_found"
-          else "document_not_found"
+      def message_key(params, unmatched)
+        if Hash === params
+          "document_with_attributes_not_found"
+        elsif Hash === unmatched && unmatched.size >= 2
+          "document_with_shard_key_not_found"
+        else
+          "document_not_found"
+        end
+      end
+
+      # Get the shard key from the unmatched hash.
+      #
+      # @return [ String ] the shard key and value.
+      def shard_key(unmatched)
+        if Hash === unmatched
+          h = unmatched.dup
+          h.delete("_id")
+          h.delete(:_id)
+          h.map{|k,v| "#{k}: #{v}" }.join(", ")
         end
       end
     end

lib/mongoid/reloadable.rb

@@ -23,7 +23,8 @@ def reload
 
       reloaded = _reload
       if Mongoid.raise_not_found_error && (reloaded.nil? || reloaded.empty?)
-        raise Errors::DocumentNotFound.new(self.class, _id, _id)
+        shard_keys = atomic_selector.with_indifferent_access.slice(*shard_key_fields, :_id)
+        raise Errors::DocumentNotFound.new(self.class, _id, shard_keys)
       end
       @attributes = reloaded
       @attributes_before_type_cast = {}

spec/mongoid/errors/document_not_found_spec.rb

@@ -80,6 +80,58 @@
         )
       end
     end
+
+    context "when providing an _id and a shard key" do
+
+      let(:id) { BSON::ObjectId.new }
+      let(:doc) { { _id: id, a: "syd" } }
+      let(:error) do
+        described_class.new(Person, id, doc)
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          "Document not found for class Person with id #{id.to_s} and shard key a: syd."
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          "When calling Person.find with an id and a shard key"
+        )
+      end
+
+      it "contains the resolution in the message" do
+        expect(error.message).to include(
+          "Search for an id/shard key that is in the database or set"
+        )
+      end
+    end
+
+    context "when providing an id in a hash without a shard key" do
+
+      let(:error) do
+        described_class.new(Person, 1, { _id: 1 })
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          "Document(s) not found for class Person with id(s) 1."
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          "When calling Person.find with an id or array of ids"
+        )
+      end
+
+      it "contains the resolution in the message" do
+        expect(error.message).to include(
+          "Search for an id that is in the database or set the"
+        )
+      end
+    end
   end
 
   describe "#params" do