Merge branch 'release/v7.2.0' into main

readyplayerme · Sep 6, 2024 · 6310fde · 6310fde
2 parents 5376855 + 31e3eca
commit 6310fde
Show file tree

Hide file tree

Showing 21 changed files with 108 additions and 41 deletions.
diff --git a/.github/latest.md b/.github/latest.md
@@ -1,5 +1,7 @@
 
 ## Changelog
 
+## Updated
+- Updated handling of response data to reduce garbage allocation [#314](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/314)
 ## Fixed
-- Fixed an issue causing json parsing to fail on iFrame events [#311](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/311/)
+- Preserve AssetId property in IAssetData [#313](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/313)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [7.2.0] - 2024.09.06
+
+## Updated
+- Updated handling of response data to reduce garbage allocation [#314](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/314)
+## Fixed
+- Preserve AssetId property in IAssetData [#313](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/313)
+
 ## [7.1.1] - 2024.07.25
 
 ## Fixed

diff --git a/Runtime/AvatarCreator/Scripts/Extensions/ResponseExtensions.cs b/Runtime/AvatarCreator/Scripts/Extensions/ResponseExtensions.cs
@@ -14,7 +14,7 @@ public static void ThrowIfError(this IResponse response)
             }
         }
 
-        public static void ThrowIfError(this Response response)
+        public static void ThrowIfError(this ResponseText response)
         {
             if (!response.IsSuccess)
             {

diff --git a/Runtime/AvatarCreator/Scripts/Interfaces/IAssetData.cs b/Runtime/AvatarCreator/Scripts/Interfaces/IAssetData.cs
@@ -1,7 +1,10 @@
+using UnityEngine.Scripting;
+
 namespace ReadyPlayerMe.AvatarCreator
 {
     public interface IAssetData
     {
+        [Preserve]
         public string Id { get; set; }
         public AssetType AssetType { get; set; }
     }

diff --git a/Runtime/AvatarCreator/Scripts/WebRequests/AssetAPIRequests.cs b/Runtime/AvatarCreator/Scripts/WebRequests/AssetAPIRequests.cs
@@ -98,7 +98,7 @@ public AssetAPIRequests(string appId)
 
             var url = BuildAssetListUrl(type, limit, pageNumber, AuthManager.UserSession.Id, appId, gender == OutfitGender.Masculine ? "male" : "female");
 
-            var response = await authorizedRequest.SendRequest<Response>(new RequestData
+            var response = await authorizedRequest.SendRequest<ResponseText>(new RequestData
             {
                 Url = url,
                 Method = HttpMethod.GET

diff --git a/Runtime/AvatarCreator/Scripts/WebRequests/AuthAPIRequests.cs b/Runtime/AvatarCreator/Scripts/WebRequests/AuthAPIRequests.cs
@@ -38,7 +38,7 @@ public AuthAPIRequests(string domain)
 
         public async Task<UserSession> LoginAsAnonymous(CancellationToken cancellationToken = default)
         {
-            var response = await webRequestDispatcher.SendRequest<Response>($"{rpmAuthBaseUrl}/users", HttpMethod.POST, headers, ctx:cancellationToken);
+            var response = await webRequestDispatcher.SendRequest<ResponseText>($"{rpmAuthBaseUrl}/users", HttpMethod.POST, headers, ctx:cancellationToken);
             response.ThrowIfError();
 
             var data = AuthDataConverter.ParseResponse(response.Text);
@@ -60,7 +60,7 @@ public async Task SendCodeToEmail(string email, string userId = "",CancellationT
 
             var payload = AuthDataConverter.CreatePayload(data);
 
-            var response = await webRequestDispatcher.SendRequest<Response>($"{rpmAuthBaseUrl}/auth/start", HttpMethod.POST, headers, payload, ctx:cancellationToken);
+            var response = await webRequestDispatcher.SendRequest<ResponseText>($"{rpmAuthBaseUrl}/auth/start", HttpMethod.POST, headers, payload, ctx:cancellationToken);
             response.ThrowIfError();
         }
 
@@ -76,7 +76,7 @@ public async Task<UserSession> LoginWithCode(string code, string userIdToMerge =
             }
             var payload = AuthDataConverter.CreatePayload(body);
 
-            var response = await webRequestDispatcher.SendRequest<Response>($"{rpmAuthBaseUrl}/auth/login", HttpMethod.POST, headers, payload, ctx:cancellationToken);
+            var response = await webRequestDispatcher.SendRequest<ResponseText>($"{rpmAuthBaseUrl}/auth/login", HttpMethod.POST, headers, payload, ctx:cancellationToken);
             response.ThrowIfError();
 
             var data = AuthDataConverter.ParseResponse(response.Text);
@@ -93,7 +93,7 @@ public async Task Signup(string email, string userId, CancellationToken cancella
             };
 
             var payload = AuthDataConverter.CreatePayload(data);
-            var response = await webRequestDispatcher.SendRequest<Response>($"{rpmAuthBaseUrl}/auth/start", HttpMethod.POST, headers, payload, ctx:cancellationToken);
+            var response = await webRequestDispatcher.SendRequest<ResponseText>($"{rpmAuthBaseUrl}/auth/start", HttpMethod.POST, headers, payload, ctx:cancellationToken);
             response.ThrowIfError();
         }
 
@@ -122,7 +122,7 @@ private async Task<JToken> RefreshRequest(string token, string refreshToken, Can
                 { AuthConstants.REFRESH_TOKEN, refreshToken }
             });
 
-            var response = await webRequestDispatcher.SendRequest<Response>(url, HttpMethod.POST, headers, payload, ctx:cancellationToken);
+            var response = await webRequestDispatcher.SendRequest<ResponseText>(url, HttpMethod.POST, headers, payload, ctx:cancellationToken);
             response.ThrowIfError();
 
             return AuthDataConverter.ParseResponse(response.Text);

diff --git a/Runtime/AvatarCreator/Scripts/WebRequests/AvatarAPIRequests.cs b/Runtime/AvatarCreator/Scripts/WebRequests/AvatarAPIRequests.cs
@@ -34,7 +34,7 @@ public AvatarAPIRequests(CancellationToken ctx = default)
 
         public async Task<List<UserAvatarResponse>> GetUserAvatars(string userId)
         {
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = $"{RPM_AVATAR_V1_BASE_URL}/?userId={userId}&select={ID},{PARTNER},{DATA}.{BODY_TYPE}",
@@ -58,7 +58,7 @@ public async Task<List<UserAvatarResponse>> GetUserAvatars(string userId)
 
         public async Task<List<AvatarTemplateData>> GetAvatarTemplates()
         {
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = $"{RPM_AVATAR_V2_BASE_URL}/templates?{BODY_TYPE}={CoreSettingsHandler.CoreSettings.BodyType.GetDescription()}",
@@ -83,7 +83,7 @@ public async Task<AvatarProperties> CreateFromTemplateAvatar(string templateId,
 
             var payload = AuthDataConverter.CreatePayload(payloadData);
 
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = $"{RPM_AVATAR_V2_BASE_URL}/templates/{templateId}",
@@ -109,7 +109,7 @@ public async Task<AssetColor[]> GetAvatarColors(string avatarId, AssetType asset
                 colorParameters = "skin,beard,hair,eyebrow";
             }
 
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = $"{RPM_AVATAR_V2_BASE_URL}/{avatarId}/colors?type={colorParameters}",
@@ -130,7 +130,7 @@ public async Task<AvatarProperties> GetAvatarMetadata(string avatarId, bool isDr
             if (isDraft)
                 url += "preview=true";
 
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = url,
@@ -148,7 +148,7 @@ public async Task<AvatarProperties> GetAvatarMetadata(string avatarId, bool isDr
 
         public async Task<AvatarProperties> CreateNewAvatar(AvatarProperties avatarProperties)
         {
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = RPM_AVATAR_V2_BASE_URL,
@@ -175,7 +175,7 @@ public async Task<byte[]> GetAvatar(string avatarId, bool isPreview = false, str
             if (isPreview)
                 url += "preview=true";
 
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseData>(
                 new RequestData
                 {
                     Url = url,
@@ -192,7 +192,7 @@ public async Task<AvatarProperties> GetAvatarProperties(string avatarId)
             ValidateAvatarId(avatarId);
             var url = $"{RPM_AVATAR_V2_BASE_URL}/{avatarId}.json?";
 
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = url,
@@ -211,7 +211,7 @@ public async Task<byte[]> UpdateAvatar(string avatarId, AvatarProperties avatarP
             ValidateAvatarId(avatarId);
             var url = $"{RPM_AVATAR_V2_BASE_URL}/{avatarId}?responseType=glb&{parameters}";
 
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseData>(
                 new RequestData
                 {
                     Url = url,
@@ -228,7 +228,7 @@ public async Task PrecompileAvatar(string avatarId, PrecompileData precompileDat
             ValidateAvatarId(avatarId);
             var json = JsonConvert.SerializeObject(precompileData);
 
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = $"{RPM_AVATAR_V2_BASE_URL}/{avatarId}/precompile?{parameters ?? string.Empty}",
@@ -243,7 +243,7 @@ public async Task PrecompileAvatar(string avatarId, PrecompileData precompileDat
         public async Task<string> SaveAvatar(string avatarId)
         {
             ValidateAvatarId(avatarId);
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = $"{RPM_AVATAR_V2_BASE_URL}/{avatarId}",
@@ -263,7 +263,7 @@ public async Task DeleteAvatar(string avatarId, bool isDraft = false)
             if (isDraft)
                 url += "draft";
 
-            var response = await authorizedRequest.SendRequest<Response>(
+            var response = await authorizedRequest.SendRequest<ResponseText>(
                 new RequestData
                 {
                     Url = url,

diff --git a/Runtime/Core/Scripts/Analytics/AmplitudeEventLogger.cs b/Runtime/Core/Scripts/Analytics/AmplitudeEventLogger.cs
@@ -81,7 +81,7 @@ private static async Task Dispatch(string url, string payload)
             }
 
             var webRequestDispatcher = new WebRequestDispatcher();
-            var response = await webRequestDispatcher.SendRequest<Response>(url, HttpMethod.POST, CommonHeaders.GetHeadersWithAppId(), payload);
+            var response = await webRequestDispatcher.SendRequest<ResponseText>(url, HttpMethod.POST, CommonHeaders.GetHeadersWithAppId(), payload);
 
             if (!response.IsSuccess)
             {

diff --git a/Runtime/Core/Scripts/Data/ApplicationData.cs b/Runtime/Core/Scripts/Data/ApplicationData.cs
@@ -6,7 +6,7 @@ namespace ReadyPlayerMe.Core
 {
     public static class ApplicationData
     {
-        public const string SDK_VERSION = "v7.1.1";
+        public const string SDK_VERSION = "v7.2.0";
         private const string TAG = "ApplicationData";
         private const string DEFAULT_RENDER_PIPELINE = "Built-In Render Pipeline";
         private static readonly AppData Data;

diff --git a/Runtime/Core/Scripts/Data/Response.cs.meta b/Runtime/Core/Scripts/Data/Response.cs.meta
diff --git a/Runtime/Core/Scripts/Data/Response.cs → Runtime/Core/Scripts/Data/ResponseData.cs b/Runtime/Core/Scripts/Data/Response.cs → Runtime/Core/Scripts/Data/ResponseData.cs
@@ -2,9 +2,8 @@
 
 namespace ReadyPlayerMe.Core
 {
-    public class Response : IResponse
+    public class ResponseData : IResponse
     {
-        public string Text;
         public byte[] Data;
 
         public bool IsSuccess { get; set; }
@@ -18,7 +17,6 @@ public void Parse(UnityWebRequest request)
                 return;
             }
 
-            Text = request.downloadHandler.text;
             Data = request.downloadHandler.data;
         }
     }

diff --git a/Runtime/Core/Scripts/Data/ResponseData.cs.meta b/Runtime/Core/Scripts/Data/ResponseData.cs.meta
diff --git a/Runtime/Core/Scripts/Data/ResponseText.cs b/Runtime/Core/Scripts/Data/ResponseText.cs
@@ -0,0 +1,23 @@
+using UnityEngine.Networking;
+
+namespace ReadyPlayerMe.Core
+{
+    public class ResponseText : IResponse
+    {
+        public string Text;
+
+        public bool IsSuccess { get; set; }
+        public string Error { get; set; }
+        public long ResponseCode { get; set; }
+
+        public void Parse(UnityWebRequest request)
+        {
+            if (request.downloadHandler is DownloadHandlerFile)
+            {
+                return;
+            }
+
+            Text = request.downloadHandler.text;
+        }
+    }
+}
diff --git a/Runtime/Core/Scripts/Data/ResponseText.cs.meta b/Runtime/Core/Scripts/Data/ResponseText.cs.meta
diff --git a/Runtime/Core/Scripts/Extensions/WebRequestDispatcherExtension.cs b/Runtime/Core/Scripts/Extensions/WebRequestDispatcherExtension.cs
@@ -21,15 +21,15 @@ public static class WebRequestDispatcherExtension
 
         /// <summary>
         /// This asynchronous method makes GET request to the <paramref name="url" /> and returns the data in the
-        /// <see cref="Response" />.
+        /// <see cref="IResponse" />.
         /// </summary>
         /// <param name="webRequestDispatcher">WebRequestDispatcher object</param>
         /// <param name="url">The URL to make the <see cref="UnityWebRequest" /> to.</param>
         /// <param name="token">Can be used to cancel the operation.</param>
         /// <param name="timeout">The number of seconds to wait for the WebRequest to finish before aborting.</param>
-        /// <returns>A <see cref="Response" /> if successful otherwise it will throw an exception.</returns>
-        public static async Task<Response> DownloadIntoMemory(this WebRequestDispatcher webRequestDispatcher, string url, CancellationToken token,
-            int timeout = TIMEOUT)
+        /// <returns>A <see cref="IResponse" /> if successful otherwise it will throw an exception.</returns>
+        public static async Task<T> DownloadIntoMemory<T>(this WebRequestDispatcher webRequestDispatcher, string url, CancellationToken token,
+            int timeout = TIMEOUT) where T : IResponse, new()
         {
             if (!HasInternetConnection)
             {
@@ -45,7 +45,7 @@ public static async Task<Response> DownloadIntoMemory(this WebRequestDispatcher
             headers.Add(CommonHeaders.GetAppIdHeader());
 
             webRequestDispatcher.Timeout = timeout;
-            var response = await webRequestDispatcher.SendRequest<Response>(url, HttpMethod.GET, headers, ctx: token);
+            var response = await webRequestDispatcher.SendRequest<T>(url, HttpMethod.GET, headers, ctx: token);
             token.ThrowCustomExceptionIfCancellationRequested();
 
             if (!response.IsSuccess)

diff --git a/Runtime/Core/Scripts/Operations/AvatarDownloader.cs b/Runtime/Core/Scripts/Operations/AvatarDownloader.cs
@@ -105,7 +105,7 @@ public async Task<AvatarContext> Execute(AvatarContext context, CancellationToke
 
             try
             {
-                var response = await dispatcher.DownloadIntoMemory(url, token, Timeout);
+                var response = await dispatcher.DownloadIntoMemory<ResponseData>(url, token, Timeout);
                 return response.Data;
             }
             catch (CustomException exception)

diff --git a/Runtime/Core/Scripts/Operations/MetadataDownloader.cs b/Runtime/Core/Scripts/Operations/MetadataDownloader.cs
@@ -81,9 +81,9 @@ private AvatarContext UpdateContext(AvatarContext avatarContext, AvatarMetadata
             {
 #if UNITY_WEBGL
                 // add random tail to the url to prevent JSON from being loaded from the browser cache
-                var response = await dispatcher.DownloadIntoMemory(url + "?tail=" + Guid.NewGuid(), token, Timeout);
+                var response = await dispatcher.DownloadIntoMemory<ResponseText>(url + "?tail=" + Guid.NewGuid(), token, Timeout);
 #else
-                Response response = await dispatcher.DownloadIntoMemory(url, token, Timeout);
+                ResponseText response = await dispatcher.DownloadIntoMemory<ResponseText>(url, token, Timeout);
 #endif
                 return ParseResponse(response.Text);
             }

diff --git a/Runtime/Core/Shaders/glTFastShaderVariants.shadervariants b/Runtime/Core/Shaders/glTFastShaderVariants.shadervariants
@@ -10,4 +10,34 @@ ShaderVariantCollection:
   m_Shaders:
   - first: {fileID: 4800000, guid: 99fa998bbbed3408aafa652b466d261d, type: 3}
     second:
-      variants: []
+      variants:
+      - keywords: DIRECTIONAL LIGHTPROBE_SH SHADOWS_SCREEN
+        passType: 4
+      - keywords: DIRECTIONAL LIGHTPROBE_SH SHADOWS_SCREEN _EMISSION _METALLICGLOSSMAP
+          _NORMALMAP
+        passType: 4
+      - keywords: DIRECTIONAL LIGHTPROBE_SH SHADOWS_SCREEN _METALLICGLOSSMAP _NORMALMAP
+        passType: 4
+      - keywords: DIRECTIONAL LIGHTPROBE_SH SHADOWS_SCREEN _NORMALMAP
+        passType: 4
+      - keywords: DIRECTIONAL LIGHTPROBE_SH _ALPHABLEND_ON
+        passType: 4
+      - keywords: DIRECTIONAL LIGHTPROBE_SH _ALPHABLEND_ON _EMISSION _METALLICGLOSSMAP
+          _NORMALMAP
+        passType: 4
+      - keywords: DIRECTIONAL LIGHTPROBE_SH _ALPHABLEND_ON _METALLICGLOSSMAP _NORMALMAP
+        passType: 4
+      - keywords: 
+        passType: 8
+      - keywords: SHADOWS_DEPTH
+        passType: 8
+      - keywords: SHADOWS_DEPTH _ALPHABLEND_ON
+        passType: 8
+      - keywords: SHADOWS_DEPTH _ALPHABLEND_ON _METALLICGLOSSMAP
+        passType: 8
+      - keywords: SHADOWS_DEPTH _METALLICGLOSSMAP
+        passType: 8
+      - keywords: _ALPHABLEND_ON
+        passType: 8
+      - keywords: _METALLICGLOSSMAP
+        passType: 8
diff --git a/Samples~/AvatarCreatorSamples/AvatarCreatorWizard/Scripts/UI/AvatarCreatorStateMachine.cs b/Samples~/AvatarCreatorSamples/AvatarCreatorWizard/Scripts/UI/AvatarCreatorStateMachine.cs
@@ -113,7 +113,12 @@ private void OnStateChanged(StateType current, StateType previous)
 
         private bool CanShowBackButton(StateType current, StateType previous)
         {
-            return current != startingState && current != previous;
+            return AuthManager.IsSignedIn switch
+            {
+                true => current != StateType.AvatarSelection,
+                false => current != startingState && current != previous
+            };
+
         }
 
         public void OnCustomizeDraft(string avatarId)

diff --git a/...rCreatorSamples/AvatarCreatorWizard/Scripts/UI/SelectionScreens/AvatarCreatorSelection.cs b/...rCreatorSamples/AvatarCreatorWizard/Scripts/UI/SelectionScreens/AvatarCreatorSelection.cs
@@ -1,12 +1,10 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using ReadyPlayerMe.AvatarCreator;
 using ReadyPlayerMe.Core;
 using UnityEngine;
-using UnityEngine.Serialization;
 using UnityEngine.UI;
 using TaskExtensions = ReadyPlayerMe.AvatarCreator.TaskExtensions;