reworked tag rename errors & improved QPixel#handleJSONResponse's error parsing

Author: Oaphi

app/assets/javascripts/qpixel_api.js

@@ -433,12 +433,22 @@ window.QPixel = {
     const isFailed = data.status === 'failed';
 
     if(isFailed) {
-      if (data.message) {
-        QPixel.createNotification('danger', data.message);
-      }
+      const { errors = [], message } = data;
+
+      if (message) {
+        const fullMessage =
+          errors.length > 1
+            ? `${message}:<ul>${errors.map((e) => `<li>${e.trim()}</li>`).join('')}</ul>`
+            : errors.length === 1
+              ? `${message} (${errors[0].toLowerCase().trim()})`
+              : message;
 
-      for (const error of data.errors ?? []) {
-        QPixel.createNotification('danger', error);
+          QPixel.createNotification('danger', fullMessage);
+      }
+      else {
+        for (const error of errors) {
+          QPixel.createNotification('danger', error);
+        }
       }
     }
     else {

app/controllers/tags_controller.rb

@@ -155,7 +155,8 @@ def rename
       render json: { status: 'success', tag: @tag }
     else
       render json: { status: 'failed',
-                     errors: @tag.errors.messages.values.flatten,
+                     message: I18n.t('tags.errors.rename_generic'),
+                     errors: @tag.errors.full_messages,
                      tag: @tag },
              status: :bad_request
     end

app/models/tag.rb

@@ -13,19 +13,19 @@ class Tag < ApplicationRecord
   validates :excerpt, length: { maximum: 600 }, allow_blank: true
   validates :wiki_markdown, length: { maximum: 30_000 }, allow_blank: true
   validates :name, presence: {
-    message: I18n.t('tags.errors.no_blank_name')
+    message: I18n.t('tags.validation.errors.no_blank_name')
   }
   validates :name, format: {
     with: /\A[^\s]+\Z/, # https://regex101.com/r/7BxgIn/1
-    message: I18n.t('tags.errors.no_spaces_in_name')
+    message: I18n.t('tags.validation.errors.no_spaces_in_name')
   }
   validate :parent_not_self
   validate :parent_not_own_child
   validate :synonym_unique
   validates :name, uniqueness: {
     scope: [:tag_set_id],
     case_sensitive: false,
-    message: I18n.t('tags.errors.no_duplicate_names')
+    message: I18n.t('tags.validation.errors.no_duplicate_names')
   }
 
   # scopes

config/locales/strings/en.tags.yml

@@ -1,11 +1,13 @@
 en:
   tags:
+    validation:
+      errors:
+        no_blank_name: >
+          should contain at least 1 character
+        no_duplicate_names: >
+          cannot match an already existing tag
+        no_spaces_in_name: >
+          should not contain spaces
     errors:
-      no_blank_name: >
-        Tag name should contain at least 1 character.
-      no_duplicate_names: >
-        A tag with that name already exists.
-      no_spaces_in_name: >
-        Tag names may not contain spaces.
       rename_generic: >
-        Failed to rename the tag.
+        Failed to rename the tag

test/controllers/tags_controller_test.rb

@@ -213,18 +213,22 @@ class TagsControllerTest < ActionController::TestCase
     tag = tags(:base)
     old_name = tag.name
 
-    [
-      ['', I18n.t('tags.errors.no_blank_name')],
-      ['name with spaces', I18n.t('tags.errors.no_spaces_in_name')],
-      [tags(:discussion).name, I18n.t('tags.errors.no_duplicate_names')]
-    ].each do |test_case|
-      new_name, error_message = test_case
-
+    {
+      '' => 'no_blank_name',
+      'name with spaces' => 'no_spaces_in_name',
+      tags(:discussion).name => 'no_duplicate_names'
+    }.each do |new_name, error_key|
       try_rename_tag(categories(:main), tag, new_name)
 
       assert_json_failure(:bad_request)
       res_body = JSON.parse(response.body)
-      assert res_body['errors'].include?(error_message)
+      error_message = I18n.t("tags.validation.errors.#{error_key}")
+
+      Rails.logger.warn(res_body['errors'])
+
+      assert res_body['errors'].any? { |msg| msg.include?(error_message) },
+             "Expected '#{error_message}' to be among the errors"
+
       tag.reload
       assert_equal tag.name, old_name
     end