Merge branch 'feat-remap-playfabcloudscript-logs-error-code'

Author: thsbrown

Runtime/Models/PlayFabCloudScriptResponse.cs

@@ -1,4 +1,6 @@
-using System;
+using System;
+using System.Collections.Generic;
+using System.Linq;
 using PlayFab;
 using PlayFab.ClientModels;
 using UnityEngine;
@@ -31,12 +33,15 @@ public PlayFabCloudScriptResponseLogsErrorCode LogsErrorCode
                     return PlayFabCloudScriptResponseLogsErrorCode.NoError;
                 }
 
-                if (Result.Logs.Count <= 0)
+                var resultErrorLogs = Result.Logs.Where(x => x.Level == "Error").ToList();
+                if (resultErrorLogs.Count <= 0)
                 {
                     return PlayFabCloudScriptResponseLogsErrorCode.Unknown;
                 }
-
-                if (Result.Logs[0].Data == null)
+                
+                // we look at the last error in logs as that's where error codes thrown via cloud script should be located.
+                var lastResultErrorLog = resultErrorLogs.Last();
+                if (lastResultErrorLog.Data == null)
                 {
                     return PlayFabCloudScriptResponseLogsErrorCode.Unknown;
                 }
@@ -48,8 +53,10 @@ public PlayFabCloudScriptResponseLogsErrorCode LogsErrorCode
                     //explicitly instantiate to fix bug where unity strips out LogsErrorData because it thinks it's not used
                     //see https://community.playfab.com/comments/60164/view.html
                     var logsErrorData = new LogsErrorData();
-                    logsErrorData = serializer.DeserializeObject<LogsErrorData>(Result.Logs[0].Data.ToString());
-                    return logsErrorData.ErrorCode;
+                    logsErrorData = serializer.DeserializeObject<LogsErrorData>(lastResultErrorLog.Data.ToString());
+                    
+                    //if our ErrorCode is == 0 this is likely an error code from PlayFab so just say Unknown
+                    return logsErrorData.ErrorCode == 0 ? PlayFabCloudScriptResponseLogsErrorCode.Unknown : logsErrorData.ErrorCode;
                 }
                 catch (Exception)
                 {
@@ -59,6 +66,51 @@ public PlayFabCloudScriptResponseLogsErrorCode LogsErrorCode
                 return PlayFabCloudScriptResponseLogsErrorCode.Unknown; 
             }
         }
+
+        /// <summary>
+        /// Converts a <see cref="PlayFabError"/> to a <see cref="PlayFabCloudScriptResponse"/> with <see cref="LogsErrorData"/>
+        /// <remarks>This can be useful when relying on <see cref="LogsErrorCode"/> to check cloud scripts errors</remarks>
+        /// </summary>
+        /// <param name="playFabError">The PlayFabError to convert</param>
+        /// <typeparam name="T">The type of reponse we will return, doesn't do much but can be nice for easily returning same return type</typeparam>
+        /// <returns>A "success" cloud script response marked with a "ContainsError" from <see cref="LogsErrorCode"/></returns>
+        public static PlayFabCloudScriptResponse<T> ConvertToLogsError<T>(PlayFabError playFabError)
+        {
+            //prefer this so we are using all PlayFab json deserialization
+            var serializer = PluginManager.GetPlugin<ISerializerPlugin>(PluginContract.PlayFab_Serializer);
+            var errorCode = PlayFabCloudScriptResponseLogsErrorCode.Unknown;
+            try
+            {
+                errorCode = (PlayFabCloudScriptResponseLogsErrorCode)(int)playFabError.Error;
+            }
+            catch (Exception e)
+            {
+                Debug.LogError(
+                    "ConvertToLogsError tried to convert PlayFabErrorCode to PlayFabCloudScriptResponseLogsErrorCode and failed. Unknown error will be used.");
+            }
+            var logsErrorData = new LogsErrorData
+            {
+                ErrorCode = errorCode,
+                ErrorMessage = playFabError.ErrorMessage
+            };
+            return new PlayFabCloudScriptResponse<T>(new ExecuteCloudScriptResult
+            {
+                Error = new ScriptExecutionError
+                {
+                    Error = "ConvertToLogsError",
+                    Message = $"This error was generated by PlayFabCloudScriptResponse.ConvertToLogsError."
+                },
+                Logs = new List<LogStatement>
+                {
+                    new LogStatement
+                    {
+                        Data = serializer.SerializeObject(logsErrorData),
+                        Level = "Error",
+                        Message = playFabError.ErrorMessage
+                    }
+                }
+            }, null);
+        }
     }
 
     public class PlayFabCloudScriptResponse<T> : PlayFabCloudScriptResponse
@@ -85,6 +137,10 @@ public T FunctionResult
 
     /// <summary>
     /// Allows us to map a cloud script error code using log.error(message,object errorCodeDataObject)
+    /// <remarks>
+    /// PlayFab ErrorCodes = 1 - 19999 (Should directly map to <see cref="PlayFabErrorCode"/>.<br/>
+    /// Custom error codes = -1 and 20000+.
+    /// </remarks>
     /// <code>
     /// function throwError(message){
     ///     let errorDataObject = {};
@@ -101,8 +157,11 @@ public enum PlayFabCloudScriptResponseLogsErrorCode
         NoError = -1,
         Unknown = 1,
         InvalidParams = 1000,
-        PlayerStatsNotFoundForLeaderboard = 1001,
-        LeaderboardEmpty = 1002
+        AccountNotFound = 1001,
+        UsersAlreadyFriends = 1183,
+        //--- Our error codes below ---
+        PlayerStatsNotFoundForLeaderboard = 20001,
+        LeaderboardEmpty = 20002
     }
 
     /// <summary>
@@ -111,5 +170,6 @@ public enum PlayFabCloudScriptResponseLogsErrorCode
     public class LogsErrorData
     {
         public PlayFabCloudScriptResponseLogsErrorCode ErrorCode;
+        public string ErrorMessage;
     }
 }

Runtime/PlayFabClientAPIWrapper.cs

@@ -328,6 +328,21 @@ public static Task<PlayFabCommonResponse<ValidateIOSReceiptResult>> ValidateIOSR
             return taskCompletionSource.Task;
         }
 
+        /// <inheritdoc cref="PlayFabClientAPI.GetAccountInfo"/>
+        public static Task<PlayFabCommonResponse<GetAccountInfoResult>> GetAccountInfoAsync(
+            GetAccountInfoRequest request)
+        {
+            var taskCompletionSource = new TaskCompletionSource<PlayFabCommonResponse<GetAccountInfoResult>>();
+            PlayFabClientAPI.GetAccountInfo(request, (result) =>
+            {
+                taskCompletionSource.SetResult(new PlayFabCommonResponse<GetAccountInfoResult>(result,null));
+            }, (error) =>
+            {
+                taskCompletionSource.SetResult(new PlayFabCommonResponse<GetAccountInfoResult>(null, error));
+            });
+            return taskCompletionSource.Task;
+        }
+        
         /// <inheritdoc cref="PlayFabClientAPI.GetTime"/>
         public static Task<PlayFabCommonResponse<GetTimeResult>> GetTimeAsync(
             GetTimeRequest request)