feat: replace guid with auth playerid for session management (#488)

* Replaced custom guid with playerid for session management when signed in through UGS's Authentication Service

* Removed code handling duplicate connections in debug builds

* When not using UGS, player id is now defined as GUID + profile string

Author: LPLafontaineB

Assets/BossRoom/Scripts/Client/Game/State/ClientMainMenuState.cs

@@ -6,9 +6,6 @@
 using Unity.Services.Core;
 using UnityEngine;
 
-#if UNITY_EDITOR
-using ParrelSync;
-#endif
 
 namespace Unity.Multiplayer.Samples.BossRoom.Client
 {
@@ -21,7 +18,6 @@ namespace Unity.Multiplayer.Samples.BossRoom.Client
     /// </remarks>
     public class ClientMainMenuState : GameStateBehaviour
     {
-        public const string AuthProfileCommandLineArg = "-AuthProfile";
         public override GameState ActiveState { get { return GameState.MainMenu; } }
 
         [SerializeField] GameObject[] m_GameObjectsThatWillBeInjectedAutomatically;
@@ -51,33 +47,11 @@ void InjectDependenciesAndInitialize(AuthenticationServiceFacade authServiceFaca
             m_Scope.BindInstanceAsSingle(m_IPUIMediator);
 
             var unityAuthenticationInitOptions = new InitializationOptions();
-
-#if UNITY_EDITOR
-            //The code below makes it possible for the clone instance to log in as a different user profile in Authentication service.
-            //This allows us to test services integration locally by utilising Parrelsync.
-            if (ClonesManager.IsClone())
-            {
-                Debug.Log("This is a clone project.");
-                var customArguments = ClonesManager.GetArgument().Split(',');
-
-                //second argument is our custom ID, but if it's not set we would just use some default.
-
-                var hardcodedProfileID = customArguments.Length > 1 ? customArguments[1] : "defaultCloneID";
-
-                unityAuthenticationInitOptions.SetProfile(hardcodedProfileID);
-            }
-#else
-            var arguments = System.Environment.GetCommandLineArgs();
-            for (int i = 0; i < arguments.Length; i++)
+            var profile = ProfileManager.Profile;
+            if (profile.Length > 0)
             {
-                if (arguments[i] == AuthProfileCommandLineArg)
-                {
-                    var profileId = arguments[i + 1];
-                    unityAuthenticationInitOptions.SetProfile(profileId);
-                    break;
-                }
+                unityAuthenticationInitOptions.SetProfile(profile);
             }
-#endif
 
             authServiceFacade.DoSignInAsync(OnAuthSignIn,  OnSignInFailed, unityAuthenticationInitOptions);
 

Assets/BossRoom/Scripts/Client/UI/UnityServicesUIHandler.cs

@@ -34,7 +34,7 @@ void ServiceErrorHandler(UnityServiceErrorMessage error)
                         // LobbyConflict can have multiple causes. Let's add other solutions here if there's other situations that arise for this.
                         errorMessage += "\nSee logs for possible causes and solution.";
                         Debug.LogError($"Got service error {error.Message} with LobbyConflict. Possible conflict cause: Trying to play with two builds on the " +
-                            $"same machine. Please use command line arg '{ClientMainMenuState.AuthProfileCommandLineArg} someName' to set a different auth profile.\n");
+                            $"same machine. Please use command line arg '{ProfileManager.AuthProfileCommandLineArg} someName' to set a different auth profile.\n");
                     }
                 }
             }
@@ -47,4 +47,4 @@ void OnDestroy()
             m_Subscriptions.Dispose();
         }
     }
-}
+}

Assets/BossRoom/Scripts/Client/com.unity.multiplayer.samples.bossroom.client.asmdef

@@ -11,8 +11,7 @@
         "Unity.Netcode.Adapter.UTP",
         "Unity.Services.Relay",
         "Unity.Multiplayer.Samples.Utilities",
-        "Unity.Services.Lobbies",
-        "ParrelSync"
+        "Unity.Services.Lobbies"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],
@@ -23,4 +22,4 @@
     "defineConstraints": [],
     "versionDefines": [],
     "noEngineReferences": false
-}
+}

Assets/BossRoom/Scripts/Shared/ClientPrefs.cs

@@ -7,10 +7,10 @@ namespace Unity.Multiplayer.Samples.BossRoom.Client
     /// (This is just a wrapper around the PlayerPrefs system,
     /// so that all the calls are in the same place.)
     /// </summary>
-    public class ClientPrefs
+    public static class ClientPrefs
     {
-        private const float k_DefaultMasterVolume = 0.5f;
-        private const float k_DefaultMusicVolume = 0.8f;
+        const float k_DefaultMasterVolume = 0.5f;
+        const float k_DefaultMusicVolume = 0.8f;
 
         public static float GetMasterVolume()
         {

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/ClientGameNetPortal.cs

@@ -1,6 +1,5 @@
 using System;
 using Unity.Multiplayer.Samples.BossRoom.Shared.Infrastructure;
-using Unity.Multiplayer.Samples.BossRoom.Shared.Net.UnityServices.Infrastructure;
 using Unity.Multiplayer.Samples.BossRoom.Shared.Net.UnityServices.Lobbies;
 using UnityEngine;
 using UnityEngine.SceneManagement;
@@ -155,7 +154,6 @@ private void OnDisconnectOrTimeout(ulong clientID)
         /// This method must be static because, when it is invoked, the client still doesn't know it's a client yet, and in particular, GameNetPortal hasn't
         /// yet initialized its client and server GameNetPortal objects yet (which it does in OnNetworkSpawn, based on the role that the current player is performing).
         /// </remarks>
-        /// <param name="portal"> </param>
         /// <param name="ipaddress">the IP address of the host to connect to. (currently IPV4 only)</param>
         /// <param name="port">The port of the host to connect to. </param>
         public void StartClient(string ipaddress, int port)
@@ -202,15 +200,16 @@ public async void StartClientUnityRelayModeAsync(string joinCode, Action<string>
                 return;//not re-throwing, but still not allowing to connect
             }
 
+
             ConnectClient();
         }
 
-        private void ConnectClient()
+        void ConnectClient()
         {
-            var clientGuid = ClientPrefs.GetGuid();
+
             var payload = JsonUtility.ToJson(new ConnectionPayload()
             {
-                clientGUID = clientGuid,
+                playerId = m_Portal.GetPlayerId(),
                 clientScene = SceneManager.GetActiveScene().buildIndex,
                 playerName = m_Portal.PlayerName
             });

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/GameNetPortal.cs

@@ -5,6 +5,7 @@
 using Unity.Multiplayer.Samples.BossRoom.Shared.Net.UnityServices.Lobbies;
 using Unity.Netcode;
 using Unity.Netcode.Transports.UNET;
+using Unity.Services.Authentication;
 using UnityEngine;
 using UnityEngine.SceneManagement;
 
@@ -31,7 +32,7 @@ public enum OnlineMode
     [Serializable]
     public class ConnectionPayload
     {
-        public string clientGUID;
+        public string playerId;
         public int clientScene = -1;
         public string playerName;
     }
@@ -245,5 +246,10 @@ public void RequestDisconnect()
             SessionManager<SessionPlayerData>.Instance.OnUserDisconnectRequest();
             NetManager.Shutdown();
         }
+
+        public string GetPlayerId()
+        {
+            return AuthenticationService.Instance.IsSignedIn ? AuthenticationService.Instance.PlayerId : ClientPrefs.GetGuid() + ProfileManager.Profile;
+        }
     }
 }

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/ServerGameNetPortal.cs

@@ -146,7 +146,7 @@ private void ApprovalCheck(byte[] connectionData, ulong clientId, NetworkManager
             // Approval check happens for Host too, but obviously we want it to be approved
             if (clientId == NetworkManager.Singleton.LocalClientId)
             {
-                SessionManager<SessionPlayerData>.Instance.AddHostData(
+                SessionManager<SessionPlayerData>.Instance.SetupConnectingPlayerSessionData(clientId, m_Portal.GetPlayerId(),
                     new SessionPlayerData(clientId, m_Portal.PlayerName, m_Portal.AvatarRegistry.GetRandomAvatar().Guid.ToNetworkGuid(), 0, true));
 
                 connectionApprovedCallback(true, null, true, null, null);
@@ -176,9 +176,9 @@ private void ApprovalCheck(byte[] connectionData, ulong clientId, NetworkManager
 
             int clientScene = connectionPayload.clientScene;
 
-            Debug.Log("Host ApprovalCheck: connecting client GUID: " + connectionPayload.clientGUID);
+            Debug.Log("Host ApprovalCheck: connecting client with player ID: " + connectionPayload.playerId);
 
-            gameReturnStatus = SessionManager<SessionPlayerData>.Instance.SetupConnectingPlayerSessionData(clientId, connectionPayload.clientGUID,
+            gameReturnStatus = SessionManager<SessionPlayerData>.Instance.SetupConnectingPlayerSessionData(clientId, connectionPayload.playerId,
                 new SessionPlayerData(clientId, connectionPayload.playerName, m_Portal.AvatarRegistry.GetRandomAvatar().Guid.ToNetworkGuid(), 0, true))
                 ? ConnectStatus.Success
                 : ConnectStatus.LoggedInAgain;
@@ -187,7 +187,7 @@ private void ApprovalCheck(byte[] connectionData, ulong clientId, NetworkManager
             if (gameReturnStatus == ConnectStatus.LoggedInAgain)
             {
                 SessionPlayerData? sessionPlayerData =
-                    SessionManager<SessionPlayerData>.Instance.GetPlayerData(connectionPayload.clientGUID);
+                    SessionManager<SessionPlayerData>.Instance.GetPlayerData(connectionPayload.playerId);
 
                 ulong oldClientId = sessionPlayerData?.ClientID ?? 0;
                 // kicking old client to leave only current

Assets/BossRoom/Scripts/Shared/ProfileManager.cs

@@ -0,0 +1,48 @@
+using UnityEngine;
+
+#if UNITY_EDITOR
+using ParrelSync;
+#endif
+
+namespace Unity.Multiplayer.Samples.BossRoom.Shared
+{
+    public static class ProfileManager
+    {
+        public const string AuthProfileCommandLineArg = "-AuthProfile";
+
+        static string s_Profile;
+
+        public static string Profile => s_Profile ??= GetProfile();
+
+        static string GetProfile()
+        {
+#if UNITY_EDITOR
+
+            //The code below makes it possible for the clone instance to log in as a different user profile in Authentication service.
+            //This allows us to test services integration locally by utilising Parrelsync.
+            if (ClonesManager.IsClone())
+            {
+                Debug.Log("This is a clone project.");
+                var customArguments = ClonesManager.GetArgument().Split(',');
+
+                //second argument is our custom ID, but if it's not set we would just use some default.
+
+                var hardcodedProfileID = customArguments.Length > 1 ? customArguments[1] : "defaultCloneID";
+
+                return hardcodedProfileID;
+            }
+#else
+        var arguments = System.Environment.GetCommandLineArgs();
+        for (int i = 0; i < arguments.Length; i++)
+        {
+            if (arguments[i] == AuthProfileCommandLineArg)
+            {
+                var profileId = arguments[i + 1];
+                return profileId;
+            }
+        }
+#endif
+            return "";
+        }
+    }
+}

Assets/BossRoom/Scripts/Shared/ProfileManager.cs.meta

@@ -11,7 +11,8 @@
         "Unity.Netcode.Adapter.UTP",
         "Unity.Collections",
         "Unity.Multiplayer.Samples.Utilities",
-        "Unity.Networking.Transport"
+        "Unity.Networking.Transport",
+        "ParrelSync"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],
@@ -22,4 +23,4 @@
     "defineConstraints": [],
     "versionDefines": [],
     "noEngineReferences": false
-}
+}