Correctly handle multiple user errors (#64)

* Correctly handle multiple user errors

* refactor: bring `error_code` back

* test: add multiple user errors test

Author: BaggioGiacomo

lib/shopify_graphql/client.rb

@@ -114,34 +114,61 @@ def handle_graphql_errors(response)
           ConnectionError.new(response: response)
         end
       exception.error_code = error_code
+      exception.error_codes = [ error_code ]
+      exception.messages = [ error.message ]
       raise exception, error_message
     end
 
     def handle_user_errors(response)
       return response if response.userErrors.blank?
 
       error = response.userErrors.first
-      error_code = error.code
-      error_message = generate_error_message(
-        message: error.message,
-        code: error_code,
-        fields: error.field,
+      errors = response.userErrors
+      error_message = generate_user_errors_message(
+        messages: errors.map(&:message),
+        codes: errors.map(&:code),
+        fields: errors.map(&:field),
       )
 
       exception = UserError.new(response: response)
-      exception.error_code = error_code
-      exception.fields = error.field
+      exception.error_code = error.code
+      exception.error_codes = errors.map(&:code)
+      exception.fields = errors.map(&:field)
+      exception.messages = errors.map(&:message)
       raise exception, error_message
     end
 
-    def generate_error_message(message: nil, code: nil, doc: nil, fields: nil)
+    def generate_error_message(message: nil, code: nil, doc: nil)
       string = "Failed.".dup
       string << " Response code = #{code}." if code
       string << " Response message = #{message}.".gsub("..", ".") if message
       string << " Documentation = #{doc}." if doc
-      string << " Fields = #{fields}." if fields
       string
     end
+
+    def generate_user_errors_message(messages: nil, codes: nil, fields: [])
+      if fields.any?
+        field_count = fields.size
+        result = ["#{field_count} #{"field".pluralize(field_count)} have failed:"]
+        
+        fields.each.with_index do |field, index|
+          field_details = ["\n-"]
+          field_details << "Response code = #{codes[index]}." if codes&.at(index)
+          field_details << "Response message = #{messages[index]}.".gsub("..", ".") if messages&.at(index)
+          field_details << "Field = #{field}." if field
+
+          result << field_details.join(" ")
+        end
+        
+        result.join("\n")
+      else
+        result = ["Failed."]
+        result << "Response code = #{codes.join(", ")}." if codes&.any?
+        result << "Response message = #{messages&.join(", ")}.".gsub("..", ".") if messages&.any?
+        
+        result.join(" ")
+      end
+    end
   end
 
   class << self

lib/shopify_graphql/exceptions.rb

@@ -1,6 +1,6 @@
 module ShopifyGraphql
   class ConnectionError < ShopifyAPI::Errors::HttpResponseError
-    attr_accessor :error_code, :fields
+    attr_accessor :error_code, :error_codes, :fields, :messages
 
     def initialize(response: nil)
       unless response

test/error_handling_test.rb

@@ -44,11 +44,32 @@ class ErrorHandlingTest < ActiveSupport::TestCase
     rescue ShopifyGraphql::UserError => error
       assert_equal 200, error.code
       assert_equal "TAKEN", error.error_code
+      assert error.error_codes.include?("TAKEN")
       assert_includes error.message, "Key is in use for Product metafields"
-      assert_equal ["definition", "key"], error.fields
+      assert_includes error.messages, "Key is in use for Product metafields on the 'xxx' namespace."
+      assert error.fields.include?(["definition", "key"])
     end
   end
 
+  test "multiple user errors" do
+    fake("mutations/multiple_user_errors.json", SIMPLE_QUERY)
+
+    begin
+      response = ShopifyGraphql.execute(SIMPLE_QUERY)
+      ShopifyGraphql::Client.new.handle_user_errors(response.data.metafieldsSet)
+    rescue ShopifyGraphql::UserError => error
+      assert_equal 200, error.code
+      assert_equal "INVALID_VALUE", error.error_code
+      assert error.error_codes.include?("INVALID_VALUE")
+      assert_equal error.error_codes, ["INVALID_VALUE", "INVALID_VALUE"]
+      assert_includes error.messages, "Value does not exist in provided choices: [\"Male\", \"Female\", \"Other\"]."
+      assert_includes error.message, "2 fields have failed"
+      assert_includes error.message, "Value has a maximum length of 10."
+      assert_equal error.fields, [["metafields", "0", "value"], ["metafields", "1", "value"]]
+    end
+  end
+
+
   test "server error" do
     fake("mutations/server_error.json", SIMPLE_QUERY)
 
@@ -57,7 +78,8 @@ class ErrorHandlingTest < ActiveSupport::TestCase
     rescue ShopifyGraphql::ServerError => error
       assert_equal 200, error.code
       assert_equal "INTERNAL_SERVER_ERROR", error.error_code
-      assert_includes error.message, "Looks like something went wrong on our end"
+      assert_equal ["INTERNAL_SERVER_ERROR"], error.error_codes
+      assert_includes error.messages, "Internal error. Looks like something went wrong on our end.\nRequest ID: XXXXX (include this in support requests)."
     end
   end
 

test/fixtures/mutations/multiple_user_errors.json

@@ -0,0 +1,38 @@
+{
+  "data": {
+    "metafieldsSet": {
+      "metafields": [],
+      "userErrors": [
+        {
+          "field": [
+            "metafields",
+            "0",
+            "value"
+          ],
+          "message": "Value does not exist in provided choices: [\"Male\", \"Female\", \"Other\"].",
+          "code": "INVALID_VALUE"
+        },
+        {
+          "field": [
+            "metafields",
+            "1",
+            "value"
+          ],
+          "message": "Value has a maximum length of 10.",
+          "code": "INVALID_VALUE"
+        }
+      ]
+    }
+  },
+  "extensions": {
+    "cost": {
+      "requestedQueryCost": 10,
+      "actualQueryCost": 10,
+      "throttleStatus": {
+        "maximumAvailable": 2000,
+        "currentlyAvailable": 1990,
+        "restoreRate": 100
+      }
+    }
+  }
+}