HTTP Execution Queue

.github/workflows/run-tests-and-package.yml

@@ -352,6 +352,8 @@ jobs:
         run: |
           if [[ ${{ github.event_name == 'workflow_dispatch' }} == true ]]; then echo "LOOTLOCKER_URL=${{ INPUTS.LL_URL }}" | sed -e 's/https:\/\///g' >> $GITHUB_ENV; elif [ ${{ vars.LL_USE_STAGE }} == 'true' ]; then echo "LOOTLOCKER_URL=${{ SECRETS.LOOTLOCKER_API_STAGE_URL }}" | sed -e 's/https:\/\///g' >> $GITHUB_ENV; else echo "LOOTLOCKER_URL=${{ SECRETS.LOOTLOCKER_API_PRODUCTION_URL }}" | sed -e 's/https:\/\///g' >> $GITHUB_ENV; fi
           if [[ ${{ github.event_name == 'workflow_dispatch' }} == true ]]; then echo "TARGET_ENVIRONMENT=CUSTOM" >> $GITHUB_ENV; echo "USE_TAILSCALE=true" >> $GITHUB_ENV; elif [ ${{ vars.LL_USE_STAGE }} == 'true' ]; then echo "TARGET_ENVIRONMENT=STAGE" >> $GITHUB_ENV; echo "USE_TAILSCALE=true" >> $GITHUB_ENV; else echo "TARGET_ENVIRONMENT=PRODUCTION" >> $GITHUB_ENV; echo "USE_TAILSCALE=false" >> $GITHUB_ENV; fi
+          COINFLIP=$(($RANDOM%${{ vars.LL_USE_LEGACY_HTTP_ONE_IN }}))
+          if [[ $COINFLIP -lt 1 ]]; then echo "USE_HTTP_EXECUTION_QUEUE=false" >> $GITHUB_ENV; else echo "USE_HTTP_EXECUTION_QUEUE=true"; fi
       - name: Checkout this repository
         uses: actions/checkout@v4
         with:
@@ -361,7 +363,7 @@ jobs:
           mkdir TestProject
           mkdir TestProject/Packages
           DEPENDENCY_STRING=$'{\n  "dependencies": {\n    "com.lootlocker.lootlockersdk": "file:../../sdk"'
-          if [[ ${{ matrix.jsonLibrary == 'newtonsoft' }} ]]; then DEPENDENCY_STRING=$DEPENDENCY_STRING$',\n    "com.unity.nuget.newtonsoft-json": "3.0.2"'; fi
+          if [[ ${{ matrix.jsonLibrary == 'newtonsoft' }} ]]; then DEPENDENCY_STRING=$DEPENDENCY_STRING$',\n    "com.unity.nuget.newtonsoft-json": "3.2.1"'; fi
           DEPENDENCY_STRING=$DEPENDENCY_STRING$'\n  },\n  "testables": ["com.lootlocker.lootlockersdk"]\n}'
           echo $DEPENDENCY_STRING >> TestProject/Packages/manifest.json
           mkdir TestProject/Assets/
@@ -385,7 +387,12 @@ jobs:
         if: ${{ matrix.jsonLibrary == 'newtonsoft' }}
         run: |
           mkdir TestProject/ProjectSettings
-          echo $'%YAML 1.1\n%TAG !u! tag:unity3d.com,2011:\n--- !u!129 &1\nPlayerSettings:\n  scriptingDefineSymbols:\n    1: LOOTLOCKER_USE_NEWTONSOFTJSON;LOOTLOCKER_COMMANDLINE_SETTINGS' >> TestProject/ProjectSettings/ProjectSettings.asset
+          echo $'%YAML 1.1\n%TAG !u! tag:unity3d.com,2011:\n--- !u!129 &1\nPlayerSettings:\n  scriptingDefineSymbols:\n    1: LOOTLOCKER_COMMANDLINE_SETTINGS;LOOTLOCKER_USE_NEWTONSOFTJSON' >> TestProject/ProjectSettings/ProjectSettings.asset
+          sed -i -e 's/"nunit.framework.dll"/"nunit.framework.dll",\n\t\t"Newtonsoft.Json.dll"/g' sdk/Tests/LootLockerTests/PlayMode/PlayModeTests.asmdef
+      - name: Use HTTP Execution Queue
+        if: ${{ ENV.USE_HTTP_EXECUTION_QUEUE != 'true' }}
+        run: |
+          sed -i -e 's/1: LOOTLOCKER_COMMANDLINE_SETTINGS/1: LOOTLOCKER_BETA_HTTP_QUEUE;LOOTLOCKER_TARGET_STAGE_ENV/g' TestProject/ProjectSettings/ProjectSettings.asset
       - name: Set user information command line arguments
         if: ${{ ENV.USE_TAILSCALE != 'true' }}
         run: |

Runtime/Client/EndPointClass.cs

@@ -1,8 +1,10 @@
 using System;
-using LootLocker;
-using System.Collections;
-using System.Collections.Generic;
-using UnityEngine;
+using LootLocker.LootLockerEnums;
+
+namespace LootLocker.LootLockerEnums
+{
+    public enum LootLockerCallerRole { User, Admin, Player, Base };
+}
 
 namespace LootLocker
 {
@@ -11,13 +13,15 @@ public class EndPointClass
     {
         public string endPoint { get; set; }
         public LootLockerHTTPMethod httpMethod { get; set; }
+        public LootLockerCallerRole callerRole { get; set; }
 
         public EndPointClass() { }
 
-        public EndPointClass(string endPoint, LootLockerHTTPMethod httpMethod)
+        public EndPointClass(string endPoint, LootLockerHTTPMethod httpMethod, LootLockerCallerRole callerRole = LootLockerCallerRole.User)
         {
             this.endPoint = endPoint;
             this.httpMethod = httpMethod;
+            this.callerRole = callerRole;
         }
     }
 }

Runtime/Client/LootLockerEndPoints.cs

@@ -1,4 +1,5 @@
-using System.Collections;
+using System;
+using System.Collections;
 using System.Collections.Generic;
 using UnityEngine;
 
@@ -37,12 +38,12 @@ public class LootLockerEndPoints
 
         // White Label Login
         [Header("White Label Login")]
-        public static EndPointClass whiteLabelSignUp = new EndPointClass("white-label-login/sign-up", LootLockerHTTPMethod.POST);
-        public static EndPointClass whiteLabelLogin = new EndPointClass("white-label-login/login", LootLockerHTTPMethod.POST);
-        public static EndPointClass whiteLabelVerifySession = new EndPointClass("white-label-login/verify-session", LootLockerHTTPMethod.POST);
-        public static EndPointClass whiteLabelRequestPasswordReset = new EndPointClass("white-label-login/request-reset-password", LootLockerHTTPMethod.POST);
+        public static EndPointClass whiteLabelSignUp = new EndPointClass("white-label-login/sign-up", LootLockerHTTPMethod.POST, LootLockerEnums.LootLockerCallerRole.Base);
+        public static EndPointClass whiteLabelLogin = new EndPointClass("white-label-login/login", LootLockerHTTPMethod.POST, LootLockerEnums.LootLockerCallerRole.Base);
+        public static EndPointClass whiteLabelVerifySession = new EndPointClass("white-label-login/verify-session", LootLockerHTTPMethod.POST, LootLockerEnums.LootLockerCallerRole.Base);
+        public static EndPointClass whiteLabelRequestPasswordReset = new EndPointClass("white-label-login/request-reset-password", LootLockerHTTPMethod.POST, LootLockerEnums.LootLockerCallerRole.Base);
         public static EndPointClass whiteLabelRequestAccountVerification = new EndPointClass("white-label-login/request-verification", LootLockerHTTPMethod.POST);
-        public static EndPointClass whiteLabelLoginSessionRequest = new EndPointClass("v2/session/white-label", LootLockerHTTPMethod.POST);
+        public static EndPointClass whiteLabelLoginSessionRequest = new EndPointClass("v2/session/white-label", LootLockerHTTPMethod.POST, LootLockerEnums.LootLockerCallerRole.Base);
 
         // Player
         [Header("Player")]
@@ -322,6 +323,20 @@ public class LootLockerEndPoints
         public static EndPointClass ListNotifications = new EndPointClass("notifications/v1", LootLockerHTTPMethod.GET);
         public static EndPointClass ReadNotifications = new EndPointClass("notifications/v1/read", LootLockerHTTPMethod.PUT);
         public static EndPointClass ReadAllNotifications = new EndPointClass("notifications/v1/read/all", LootLockerHTTPMethod.PUT);
+    }
 
+    [Serializable]
+    public enum LootLockerHTTPMethod
+    {
+        GET = 0,
+        POST = 1,
+        DELETE = 2,
+        PUT = 3,
+        HEAD = 4,
+        CREATE = 5,
+        OPTIONS = 6,
+        PATCH = 7,
+        UPLOAD_FILE = 8,
+        UPDATE_FILE = 9
     }
-}
+}

Runtime/Client/LootLockerErrorData.cs

@@ -0,0 +1,95 @@
+namespace LootLocker
+{
+    public class LootLockerErrorData
+    {
+        public LootLockerErrorData(int httpStatusCode, string errorMessage)
+        {
+            code = $"HTTP{httpStatusCode}";
+            doc_url = $"https://developer.mozilla.org/docs/Web/HTTP/Status/{httpStatusCode}";
+            message = errorMessage;
+        }
+
+        public LootLockerErrorData() { }
+
+        /// <summary>
+        /// A descriptive code identifying the error.
+        /// </summary>
+        public string code { get; set; }
+
+        /// <summary>
+        /// A link to further documentation on the error.
+        /// </summary>
+        public string doc_url { get; set; }
+
+        /// <summary>
+        /// A unique identifier of the request to use in contact with support.
+        /// </summary>
+        public string request_id { get; set; }
+
+        /// <summary>
+        /// A unique identifier for tracing the request through LootLocker systems, use this in contact with support.
+        /// </summary>
+        public string trace_id { get; set; }
+
+        /// <summary>
+        /// If the request was not a success this property will hold any error messages
+        /// </summary>
+        public string message { get; set; }
+
+        /// <summary>
+        /// If the request was rate limited (status code 429) or the servers were temporarily unavailable (status code 503) you can use this value to determine how many seconds to wait before retrying
+        /// </summary>
+        public int? retry_after_seconds { get; set; } = null;
+
+        /// <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()
+        {
+            // Empty error, make sure we print something
+            if (string.IsNullOrEmpty(message) && string.IsNullOrEmpty(trace_id) && string.IsNullOrEmpty(request_id))
+            {
+                return $"An unexpected LootLocker error without error data occurred. Please try again later.\n If the issue persists, please contact LootLocker support.";
+            }
+
+            //Print the most important info first
+            string prettyError = $"LootLocker Error: \"{message ?? ""}\"";
+
+            // Look for intermittent, non user errors
+            if (!string.IsNullOrEmpty(code) && code.StartsWith("HTTP5"))
+            {
+                prettyError +=
+                    $"\nTry again later. If the issue persists, please contact LootLocker support and provide the following error details:\n trace ID - \"{trace_id ?? ""}\",\n request ID - \"{request_id ?? ""}\",\n message - \"{message ?? ""}\".";
+                if (!string.IsNullOrEmpty(doc_url))
+                {
+                    prettyError += $"\nFor more information, see {doc_url} (error code was \"{code}\").";
+                }
+            }
+            // Print user errors
+            else
+            {
+                prettyError +=
+                    $"\nThere was a problem with your request. The error message provides information on the problem and will help you fix it.";
+                if (!string.IsNullOrEmpty(doc_url ?? ""))
+                {
+                    prettyError += $"\nFor more information, see {doc_url ?? ""} (error code was \"{code ?? ""}\").";
+                }
+
+                prettyError +=
+                    $"\nIf you are unable to fix the issue, contact LootLocker support and provide the following error details:";
+                if (!string.IsNullOrEmpty(trace_id ?? ""))
+                {
+                    prettyError += $"\n     trace ID - \"{trace_id}\"";
+                }
+                if (!string.IsNullOrEmpty(request_id))
+                {
+                    prettyError += $"\n     request ID - \"{request_id}\"";
+                }
+
+                prettyError += $"\n     message - \"{message ?? ""}\".";
+            }
+            return prettyError;
+        }
+    }
+}