Make error handling consistent for Rails 5+ and 6+

Author: johvet

lib/jsonapi/active_model_error_serializer.rb

@@ -50,12 +50,12 @@ def status_code(params)
         message = errors_object.generate_message(
           error_key, nil, error_hash[:error]
         )
-      elsif error_hash[:error].present?
+      elsif error_hash[:error].present? && error_hash[:error].is_a?(Symbol)
         message = errors_object.generate_message(
           error_key, error_hash[:error], error_hash
         )
       else
-        message = error_hash[:message]
+        message = error_hash[:message] || error_hash[:error]
       end
 
       errors_object.full_message(error_key, message)

lib/jsonapi/rails.rb

@@ -62,8 +62,21 @@ def self.add_errors_renderer!
             details[attr] ||= []
             details[attr] << error.detail.merge(message: error.message)
           end
-        elsif resource.respond_to?(:details)
-          details = resource.details
+        elsif resource.respond_to?(:details) && resource.respond_to?(:messages)
+          resource.details.each do |attr, problems|
+            problems.each_with_index do |error, index|
+              details[attr] ||= []
+
+              if error[:error].is_a?(Hash)
+                current = error[:error].dup
+                current[:error] ||= :invalid
+
+                details[attr] << current
+              else
+                details[attr] << error.merge(message: resource.messages[attr][index])
+              end
+            end
+          end
         else
           details = resource.messages
         end

spec/dummy.rb

@@ -57,7 +57,7 @@ def self.ransackable_attributes(auth_object = nil)
 
   # Provide a validation adding an error to the model's base
   def title_check
-    errors.add(:base, :invalid) if title == 'n/a'
+    errors.add(:base, :model_invalid, errors: 'The record has an unacceptable title.') if title == 'n/a'
   end
 
   def deletable?

spec/errors_spec.rb

@@ -61,13 +61,8 @@
           .to eq(Rack::Utils::HTTP_STATUS_CODES[422])
         expect(response_json['errors'][0]['source'])
           .to eq('pointer' => '/data/relationships/user')
-        if Rails.gem_version >= Gem::Version.new('6.1')
-          expect(response_json['errors'][0]['detail'])
-            .to eq('User must exist')
-        else
-          expect(response_json['errors'][0]['detail'])
-            .to eq('User can\'t be blank')
-        end
+        expect(response_json['errors'][0]['detail'])
+          .to eq('User must exist')
       end
 
       context 'required by validations' do
@@ -156,7 +151,7 @@
           expect(response_json['errors'][0]['source'])
               .to eq('pointer' => '/data')
           expect(response_json['errors'][0]['detail'])
-            .to eq('is invalid')
+            .to eq('Validation failed: The record has an unacceptable title.')
         end
       end
     end