Simply setting errorData | calling error messages

Author: Mikkel Sørensen

Runtime/Client/LootLockerServerApi.cs

@@ -131,14 +131,7 @@ IEnumerator coroutine()
                         text = webRequest.downloadHandler.text
                     };
 
-                    LootLockerErrorData errorData =
-                        LootLockerJson.DeserializeObject<LootLockerErrorData>(webRequest.downloadHandler.text);
-                    if (ErrorIsPreErrorCodes(errorData))
-                    {
-                        errorData = ExpandErrorInformation(webRequest.responseCode, webRequest.downloadHandler.text);
-                    }
-
-                    response.errorData = errorData;
+                    response.errorData = LootLockerJson.DeserializeObject<LootLockerErrorData>(webRequest.downloadHandler.text);
                     LootLockerLogger.GetForLogLevel(LootLockerLogger.LogLevel.Error)(response.errorData.message +
                         (!string.IsNullOrEmpty(response.errorData.doc_url) ? " -- " + response.errorData.doc_url : ""));
                     OnServerResponse?.Invoke(response);
@@ -149,76 +142,6 @@ IEnumerator coroutine()
 
 #region Private Methods
 
-        private static LootLockerErrorData ExpandErrorInformation(long statusCode, string responseBody)
-        {
-            var errorData = new LootLockerErrorData();
-            switch (statusCode)
-            {
-                case 400:
-                    errorData.message = "Bad Request -- Your request has an error.";
-                    errorData.code = "bad_request";
-                    break;
-                case 401:
-                    errorData.message = "Unauthorized -- Your session_token is invalid.";
-                    errorData.code = "unauthorized";
-                    break;
-                case 402:
-                    errorData.message = "Payment Required -- Payment failed. Insufficient funds, etc.";
-                    errorData.code = "payment_required";
-                    break;
-                case 403:
-                    errorData.message = "Forbidden -- You do not have access to this resource.";
-                    errorData.code = "forbidden";
-                    break;
-                case 404:
-                    errorData.message = "Not Found -- The requested resource could not be found.";
-                    errorData.code = "not_found";
-                    break;
-                case 405:
-                    errorData.message =
-                        "Method Not Allowed -- The selected http method is invalid for this resource.";
-                    errorData.code = "method_not_allowed";
-                    break;
-                case 406:
-                    errorData.message = "Not Acceptable -- Purchasing is disabled.";
-                    errorData.code = "not_acceptable";
-                    break;
-                case 409:
-                    errorData.message =
-                        "Conflict -- Your state is most likely not aligned with the servers.";
-                    errorData.code = "conflict";
-                    break;
-                case 429:
-                    errorData.message =
-                        "Too Many Requests -- You're being limited for sending too many requests too quickly.";
-                    errorData.code = "too_many_requests";
-                    break;
-                case 500:
-                    errorData.message =
-                        "Internal Server Error -- We had a problem with our server. Try again later.";
-                    errorData.code = "internal_server_error";
-                    break;
-                case 503:
-                    errorData.message =
-                        "Service Unavailable -- We're either offline for maintenance, or an error that should be solvable by calling again later was triggered.";
-                    errorData.code = "service_unavailable";
-                    break;
-                default:
-                    errorData.message = "Unknown error.";
-                    break;
-            }
-
-            errorData.message +=
-                " " + LootLockerObfuscator.ObfuscateJsonStringForLogging(responseBody);
-            return errorData;
-        }
-
-        private static bool ErrorIsPreErrorCodes(LootLockerErrorData errorData)
-        {
-            // Check if the error uses the "old" error style, not the "new" (https://docs.lootlocker.com/reference/error-codes)
-            return errorData == null || string.IsNullOrEmpty(errorData.code);
-        }
-
         private static bool ShouldRetryRequest(long statusCode, int timesRetried)
         {
             return (statusCode == 401 || statusCode == 403) && LootLockerConfig.current.allowTokenRefresh && CurrentPlatform.Get() != Platforms.Steam && timesRetried < MaxRetries;

Runtime/Client/LootLockerServerRequest.cs

@@ -116,6 +116,15 @@ public class LootLockerErrorData
         /// If the request was not a success this property will hold any error messages
         /// </summary>
         public string message { get; set; }
+
+        /// <summary>
+        /// An easy way of debugging LootLockerErrorData class, example: Debug.Log(onComplete.errorData);
+        /// </summary>
+        /// <returns>string used to debug errors</returns>
+        public override string ToString()
+        {
+            return $"We encountered an unexpected server error. Please try again later.\n If the issue persists, please contact LootLocker support and reference the following error details:\n trace ID - {trace_id},\n request ID - {request_id},\n message - {message}.";
+        }
     }
 
     /// <summary>
@@ -174,9 +183,12 @@ public static T Deserialize<T>(LootLockerResponse serverResponse,
             {
                 return LootLockerResponseFactory.Error<T>("Unknown error, please check your internet connection.");
             }
-            else if (serverResponse.errorData != null && !string.IsNullOrEmpty(serverResponse.errorData.code))
+            else if (serverResponse.errorData != null)
             {
-                return new T() { success = false, errorData = serverResponse.errorData, statusCode = serverResponse.statusCode };
+                if(!string.IsNullOrEmpty(serverResponse.errorData.code)) {
+                    return new T() { success = false, errorData = serverResponse.errorData, statusCode = serverResponse.statusCode };
+                }
+                return new T() { success = false, errorData = serverResponse.errorData };
             }
 
             var response = LootLockerJson.DeserializeObject<T>(serverResponse.text, options ?? LootLockerJsonSettings.Default) ?? new T();