[ECO-5624] Fixed UnityAdapter as per review comments

sacOO7 · sacOO7 · commit 945920047c3f · 2025-11-06T15:37:37.000+05:30
- Updated UnityAdapter to handle instance access for different unity versions
- Fixed unity editmode and playmode tests for agent identifiers
- Updated link.xml with exclusions for needed types
diff --git a/src/IO.Ably.Shared/IO.Ably.Shared.projitems b/src/IO.Ably.Shared/IO.Ably.Shared.projitems
@@ -178,6 +178,8 @@
     <Compile Include="$(MSBuildThisFileDirectory)Types\PresenceMessage.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Types\ProtocolMessage.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Types\SemanticVersion.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)Unity\UnityAdapter.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)Unity\UnityHelper.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Utils\ActionOnDispose.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Utils\ActionUtils.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Utils\ConnectionChangeAwaiter.cs" />
diff --git a/src/IO.Ably.Shared/Unity/UnityAdapter.cs b/src/IO.Ably.Shared/Unity/UnityAdapter.cs
@@ -20,37 +20,37 @@ namespace IO.Ably.Unity
     /// - No link.xml preservation directives needed for UnityEngine.Application (it's always preserved)
     /// - Works across all Unity scripting backends: Mono, IL2CPP (iOS/Android/WebGL/Console)
     /// - Gracefully degrades in non-Unity environments (returns empty/default values)
-    /// - Zero reflection overhead after first access due to Lazy<T> caching
-    /// - Safe for AOT platforms: no runtime code generation, only metadata queries
+    /// - Zero reflection overhead after first access due to Lazy caching
+    /// - Safe for AOT platforms: no runtime code generation, only metadata queries.
     /// </summary>
     internal static class UnityAdapter
     {
         private static readonly Lazy<Type> _unityApplication =
             new Lazy<Type>(() => GetUnityApplication());
-    
+
         private static readonly Lazy<string> _unityVersion =
             new Lazy<string>(() => GetUnityVersion());
-    
-        private static readonly Lazy<int> _runtimePlatform =
-            new Lazy<int>(() => GetRuntimePlatform());
+
+        private static readonly Lazy<string> _runtimePlatform =
+            new Lazy<string>(() => GetRuntimePlatform());
 
         /// <summary>
         /// Indicates whether Unity runtime is available.
         /// </summary>
         public static bool IsAvailable => _unityApplication.Value != null;
-    
+
         /// <summary>
         /// Gets the cached Unity version string.
         /// The value is computed once on first access and cached for subsequent calls.
         /// </summary>
         public static string UnityVersion => _unityVersion.Value;
-    
+
         /// <summary>
-        /// Gets the cached runtime platform value.
+        /// Gets the cached runtime platform string value.
         /// The value is computed once on first access and cached for subsequent calls.
         /// </summary>
-        public static int RuntimePlatform => _runtimePlatform.Value;
-    
+        public static string RuntimePlatform => _runtimePlatform.Value;
+
         /// <summary>
         /// Gets the UnityEngine.Application type using reflection.
         /// </summary>
@@ -60,15 +60,13 @@ private static Type GetUnityApplication()
             try
             {
                 // Attempt to load UnityEngine.Application type at runtime
-                // This will succeed if UnityEngine.dll is available in the runtime
-                return Type.GetType(
-                    "UnityEngine.Application, UnityEngine",
-                    throwOnError: false);
+                // The UnityEngine.Application class has been located in the UnityEngine.CoreModule assembly since Unity 2017.1
+                // Returns null if the class is not found in UnityEngine.CoreModule
+                return Type.GetType("UnityEngine.Application, UnityEngine.CoreModule", throwOnError: false);
             }
             catch
             {
                 // Silently fail - Unity is not available
-                // This is expected in non-Unity environments
                 return null;
             }
         }
@@ -88,17 +86,11 @@ private static string GetUnityVersion()
             try
             {
                 // Get property info for unityVersion
-                var unityVersionProperty = applicationType.GetProperty(
+                var version = applicationType.GetProperty(
                     "unityVersion",
-                    BindingFlags.Public | BindingFlags.Static);
+                    BindingFlags.Public | BindingFlags.Static)
+                    ?.GetValue(null) as string;
 
-                if (unityVersionProperty == null)
-                {
-                    return string.Empty;
-                }
-
-                // Get static property value via reflection
-                var version = unityVersionProperty.GetValue(null) as string;
                 return version ?? string.Empty;
             }
             catch
@@ -109,43 +101,33 @@ private static string GetUnityVersion()
         }
 
         /// <summary>
-        /// Gets the runtime platform as an integer value using reflection.
+        /// Gets the runtime platform as a string value using reflection.
         /// </summary>
-        /// <returns>Platform integer value (maps to RuntimePlatform enum) or -1 if unavailable.</returns>
-        private static int GetRuntimePlatform()
+        /// <returns>Platform string value (e.g., "OSXEditor", "WindowsPlayer") or empty string if unavailable.</returns>
+        private static string GetRuntimePlatform()
         {
             var applicationType = _unityApplication.Value;
             if (applicationType == null)
             {
-                return -1;
+                return string.Empty;
             }
 
             try
             {
-                // Get property info for platform
-                var platformProperty = applicationType.GetProperty(
+                // Get property info for platform and convert enum to string (e.g., "OSXEditor", "WindowsPlayer")
+                var platform = applicationType.GetProperty(
                     "platform",
-                    BindingFlags.Public | BindingFlags.Static);
-
-                if (platformProperty == null)
-                {
-                    return -1;
-                }
+                    BindingFlags.Public | BindingFlags.Static)
+                    ?.GetValue(null)
+                    ?.ToString();
 
-                // Get static property value via reflection
-                var platformValue = platformProperty.GetValue(null);
-                if (platformValue != null)
-                {
-                    // RuntimePlatform is an enum, convert to int
-                    return (int)platformValue;
-                }
+                return platform ?? string.Empty;
             }
             catch
             {
                 // Ignore reflection errors
+                return string.Empty;
             }
-
-            return -1;
         }
     }
 }
diff --git a/src/IO.Ably.Shared/Unity/UnityHelper.cs b/src/IO.Ably.Shared/Unity/UnityHelper.cs
@@ -29,55 +29,55 @@ internal static class UnityHelper
         public const string Xbox = "unity-xbox";
 
         /// <summary>
-        /// Constants representing UnityEngine.RuntimePlatform enum values.
-        /// These integer values map to the RuntimePlatform enum without requiring a compile-time reference.
-        /// Values are stable across Unity versions and documented in Unity's API reference.
+        /// Constants representing UnityEngine.RuntimePlatform enum string values.
+        /// These string values map to the RuntimePlatform enum names without requiring a compile-time reference.
+        /// Using string values instead of integers provides stability across Unity versions.
         /// </summary>
         public static class RuntimePlatform
         {
             /// <summary>In the Unity editor on macOS.</summary>
-            public const int OSXEditor = 0;
+            public const string OSXEditor = "OSXEditor";
 
             /// <summary>In the player on macOS.</summary>
-            public const int OSXPlayer = 1;
+            public const string OSXPlayer = "OSXPlayer";
 
             /// <summary>In the player on Windows.</summary>
-            public const int WindowsPlayer = 2;
+            public const string WindowsPlayer = "WindowsPlayer";
 
             /// <summary>In the Unity editor on Windows.</summary>
-            public const int WindowsEditor = 7;
+            public const string WindowsEditor = "WindowsEditor";
 
             /// <summary>In the player on iPhone.</summary>
-            public const int IPhonePlayer = 8;
+            public const string IPhonePlayer = "IPhonePlayer";
 
             /// <summary>In the player on Android.</summary>
-            public const int Android = 11;
+            public const string Android = "Android";
 
             /// <summary>In the player on Linux.</summary>
-            public const int LinuxPlayer = 13;
+            public const string LinuxPlayer = "LinuxPlayer";
 
             /// <summary>In the Unity editor on Linux.</summary>
-            public const int LinuxEditor = 16;
+            public const string LinuxEditor = "LinuxEditor";
 
             /// <summary>In the player on WebGL.</summary>
-            public const int WebGLPlayer = 17;
+            public const string WebGLPlayer = "WebGLPlayer";
 
             /// <summary>In the player on PS4.</summary>
-            public const int PS4 = 19;
+            public const string PS4 = "PS4";
 
             /// <summary>In the player on Xbox One.</summary>
-            public const int XboxOne = 21;
+            public const string XboxOne = "XboxOne";
 
             /// <summary>In the player on Apple TV.</summary>
-            public const int tvOS = 31;
+            public const string TvOS = "tvOS";
 
             /// <summary>In the player on Nintendo Switch.</summary>
-            public const int Switch = 32;
+            public const string Switch = "Switch";
 
             /// <summary>In the player on PS5.</summary>
-            public const int PS5 = 34;
+            public const string PS5 = "PS5";
         }
-    
+
         /// <summary>
         /// Gets the cached Unity OS identifier string.
         /// The value is computed once on first access and cached for subsequent calls.
@@ -89,7 +89,7 @@ public static class RuntimePlatform
         /// The value is computed once on first access and cached for subsequent calls.
         /// </summary>
         public static string UnityIdentifier => _unityIdentifier.Value;
-    
+
         /// <summary>
         /// Gets the Unity OS identifier string based on the current runtime platform.
         /// Uses reflection to detect Unity platform without compile-time dependency.
@@ -133,7 +133,7 @@ private static string GetOsIdentifier()
                         return PS4;
                     case RuntimePlatform.XboxOne:
                         return Xbox;
-                    case RuntimePlatform.tvOS:
+                    case RuntimePlatform.TvOS:
                         return TvOS;
                     case RuntimePlatform.Switch:
                         return Switch;
@@ -165,4 +165,3 @@ private static string GetUnityIdentifier()
         }
     }
 }
-
diff --git a/unity/Assets/Ably/Plugins/IO.Ably.dll b/unity/Assets/Ably/Plugins/IO.Ably.dll
diff --git a/unity/Assets/Ably/Plugins/link.xml b/unity/Assets/Ably/Plugins/link.xml
@@ -1,4 +1,9 @@
 <linker>
     <assembly fullname="IO.Ably" preserve="all" />
-    <assembly fullname="IO.Ably.DeltaCodec" preserve="all" />
-</linker>
+    <assembly fullname="UnityEngine.CoreModule">
+        <type fullname="UnityEngine.Application">
+            <property name="unityVersion" />
+            <property name="platform" />
+        </type>
+    </assembly>
+</linker>
diff --git a/unity/Assets/Tests/AblySandbox/AblyRealtimeExtensions.cs b/unity/Assets/Tests/AblySandbox/AblyRealtimeExtensions.cs
@@ -2,8 +2,6 @@
 using System.Threading.Tasks;
 using IO.Ably;
 using IO.Ably.Realtime;
-using IO.Ably.Realtime.Workflow;
-using IO.Ably.Types;
 
 namespace Assets.Tests.AblySandbox
 {
diff --git a/unity/Assets/Tests/EditMode/AblyRealtimeSpecs.cs b/unity/Assets/Tests/EditMode/AblyRealtimeSpecs.cs
@@ -1,15 +1,13 @@
-using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net;
 using System.Net.Http;
-using System.Threading.Tasks;
-using System.Threading;
 using Assets.Tests.AblySandbox;
 using Cysharp.Threading.Tasks;
 using IO.Ably;
 using IO.Ably.Realtime;
+using IO.Ably.Unity;
 using NUnit.Framework;
 using UnityEngine.TestTools;
 
@@ -224,18 +222,18 @@ public IEnumerator TestHttpUnityAgentHeader([ValueSource(nameof(_protocols))] Pr
                 Assert.AreEqual(1, values.Length);
                 string[] agentValues = values[0].Split(' ');
 
-                Assert.IsTrue(Agent.OsIdentifier().StartsWith("unity-"));
-                Assert.IsTrue(Agent.UnityPlayerIdentifier().StartsWith("unity/"));
+                Assert.IsTrue(Agent.OsIdentifier.StartsWith("unity-"));
+                Assert.IsTrue(UnityHelper.UnityIdentifier.StartsWith("unity/"));
 
                 var keys = new List<string>()
                 {
                     "ably-dotnet/",
-                    Agent.DotnetRuntimeIdentifier(),
-                    Agent.UnityPlayerIdentifier(),
-                    Agent.OsIdentifier()
+                    Agent.DotnetRuntimeIdentifier,
+                    UnityHelper.UnityIdentifier,
+                    Agent.OsIdentifier
                 };
 
-                Assert.AreEqual(2, Agent.DotnetRuntimeIdentifier().Split('/').Length);
+                Assert.AreEqual(2, Agent.DotnetRuntimeIdentifier.Split('/').Length);
 
                 keys.RemoveAll(s => s.IsEmpty());
 
diff --git a/unity/Assets/Tests/PlayMode/AblyRealtimeSpecs.cs b/unity/Assets/Tests/PlayMode/AblyRealtimeSpecs.cs
@@ -7,6 +7,7 @@
 using Cysharp.Threading.Tasks;
 using IO.Ably;
 using IO.Ably.Realtime;
+using IO.Ably.Unity;
 using NUnit.Framework;
 using UnityEngine.TestTools;
 
@@ -221,18 +222,18 @@ public IEnumerator TestHttpUnityAgentHeader([ValueSource(nameof(_protocols))] Pr
                 Assert.AreEqual(1, values.Length);
                 string[] agentValues = values[0].Split(' ');
 
-                Assert.IsTrue(Agent.OsIdentifier().StartsWith("unity-"));
-                Assert.IsTrue(Agent.UnityPlayerIdentifier().StartsWith("unity/"));
+                Assert.IsTrue(Agent.OsIdentifier.StartsWith("unity-"));
+                Assert.IsTrue(UnityHelper.UnityIdentifier.StartsWith("unity/"));
 
                 var keys = new List<string>()
                 {
                     "ably-dotnet/",
-                    Agent.DotnetRuntimeIdentifier(),
-                    Agent.UnityPlayerIdentifier(),
-                    Agent.OsIdentifier()
+                    Agent.DotnetRuntimeIdentifier,
+                    UnityHelper.UnityIdentifier,
+                    Agent.OsIdentifier
                 };
 
-                Assert.AreEqual(2, Agent.DotnetRuntimeIdentifier().Split('/').Length);
+                Assert.AreEqual(2, Agent.DotnetRuntimeIdentifier.Split('/').Length);
 
                 keys.RemoveAll(s => s.IsEmpty());
 

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,6 @@`
`2`	`2`	`using System.Threading.Tasks;`
`3`	`3`	`using IO.Ably;`
`4`	`4`	`using IO.Ably.Realtime;`
`5`		`-using IO.Ably.Realtime.Workflow;`
`6`		`-using IO.Ably.Types;`
`7`	`5`
`8`	`6`	`namespace Assets.Tests.AblySandbox`
`9`	`7`	`{`