Fix MONGOID-5327 Prohibit using undefined string/symbol types when declaring fields (#5257)

Co-authored-by: Oleg Pudeyev <[email protected]>

Author: p-mongo

lib/config/locales/en.yml

@@ -181,6 +181,13 @@ en:
             \_\_end\n\n
             Refer to:
             https://docs.mongodb.com/mongoid/current/reference/fields/#custom-field-options"
+        invalid_field_type:
+          message: "Invalid field type %{type_inspection} for field '%{field}' on model '%{klass}'."
+          summary: "Model '%{klass}' defines a field '%{field}' with an unknown type value
+            %{type_inspection}."
+          resolution: "Please provide a valid type value for the field.
+            Refer to:
+            https://docs.mongodb.com/mongoid/current/reference/fields/#using-symbols-or-strings-instead-of-classes"
         invalid_includes:
           message: "Invalid includes directive: %{klass}.includes(%{args})"
           summary: "Eager loading in Mongoid only supports providing arguments

lib/mongoid/errors.rb

@@ -15,6 +15,7 @@
 require "mongoid/errors/invalid_dependent_strategy"
 require "mongoid/errors/invalid_field"
 require "mongoid/errors/invalid_field_option"
+require "mongoid/errors/invalid_field_type"
 require "mongoid/errors/invalid_find"
 require "mongoid/errors/invalid_includes"
 require "mongoid/errors/invalid_index"

lib/mongoid/errors/invalid_field_type.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to define a field using a :type option value
+    # that is not present in the field type mapping.
+    class InvalidFieldType < MongoidError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   InvalidFieldType.new('Person', 'first_name', 'stringgy')
+      #
+      # @param [ String ] klass The model class.
+      # @param [ String ] field The field on which the invalid type is used.
+      # @param [ Symbol | String ] type The value of the field :type option.
+      def initialize(klass, field, type)
+        super(
+          compose_message('invalid_field_type',
+            klass: klass, field: field, type_inspection: type.inspect)
+        )
+      end
+    end
+  end
+end

lib/mongoid/fields.rb

@@ -733,6 +733,9 @@ def field_for(name, options)
         opts = options.merge(klass: self)
         type_mapping = TYPE_MAPPINGS[options[:type]]
         opts[:type] = type_mapping || unmapped_type(options)
+        unless opts[:type].is_a?(Class)
+          raise Errors::InvalidFieldType.new(self, name, options[:type])
+        end
         return Fields::Localized.new(name, opts) if options[:localize]
         return Fields::ForeignKey.new(name, opts) if options[:identity]
         Fields::Standard.new(name, opts)

spec/mongoid/errors/invalid_field_type_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Mongoid::Errors::InvalidFieldType do
+
+  describe "#message" do
+
+    let(:error) do
+      described_class.new(Person, :first_name, :stringgy)
+    end
+
+    context 'when type is a symbol' do
+      let(:error) do
+        described_class.new(Person, :first_name, :stringgy)
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          "Invalid field type :stringgy for field 'first_name' on model 'Person'."
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          "Model 'Person' defines a field 'first_name' with an unknown type value :stringgy."
+        )
+      end
+    end
+
+    context 'when type is a string' do
+      let(:error) do
+        described_class.new(Person, :first_name, 'stringgy')
+      end
+
+      it "contains the problem in the message" do
+        expect(error.message).to include(
+          %q,Invalid field type "stringgy" for field 'first_name' on model 'Person'.,
+        )
+      end
+
+      it "contains the summary in the message" do
+        expect(error.message).to include(
+          %q,Model 'Person' defines a field 'first_name' with an unknown type value "stringgy".,
+        )
+      end
+    end
+
+    it "contains the resolution in the message" do
+      expect(error.message).to include(
+        'Please provide a valid type value for the field.'
+      )
+    end
+  end
+end

spec/mongoid/fields_spec.rb

@@ -393,6 +393,22 @@
       it "converts :time to Time" do
         expect(klass.field(:test, type: :time).type).to be(Time)
       end
+
+      context 'when using an unknown symbol' do
+        it 'raises InvalidFieldType' do
+          lambda do
+            klass.field(:test, type:  :bogus)
+          end.should raise_error(Mongoid::Errors::InvalidFieldType, /defines a field 'test' with an unknown type value :bogus/)
+        end
+      end
+
+      context 'when using an unknown string' do
+        it 'raises InvalidFieldType' do
+          lambda do
+            klass.field(:test, type:  'bogus')
+          end.should raise_error(Mongoid::Errors::InvalidFieldType, /defines a field 'test' with an unknown type value "bogus"/)
+        end
+      end
     end
 
     context "when the options are valid" do