feat: replace guid with auth playerid for session management

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()
         {
@@ -32,23 +32,5 @@ public static void SetMusicVolume(float volume)
             PlayerPrefs.SetFloat("MusicVolume", volume);
         }
 
-        /// <summary>
-        /// Either loads a Guid string from Unity preferences, or creates one and checkpoints it, then returns it.
-        /// </summary>
-        /// <returns>The Guid that uniquely identifies this client install, in string form. </returns>
-        public static string GetGuid()
-        {
-            if (PlayerPrefs.HasKey("client_guid"))
-            {
-                return PlayerPrefs.GetString("client_guid");
-            }
-
-            var guid = System.Guid.NewGuid();
-            var guidString = guid.ToString();
-
-            PlayerPrefs.SetString("client_guid", guidString);
-            return guidString;
-        }
-
     }
 }

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

@@ -6,6 +6,7 @@
 using UnityEngine.SceneManagement;
 using Unity.Netcode;
 using Unity.Netcode.Transports.UNET;
+using Unity.Services.Authentication;
 
 namespace Unity.Multiplayer.Samples.BossRoom.Client
 {
@@ -207,10 +208,9 @@ public async void StartClientUnityRelayModeAsync(string joinCode, Action<string>
 
         private void ConnectClient()
         {
-            var clientGuid = ClientPrefs.GetGuid();
             var payload = JsonUtility.ToJson(new ConnectionPayload()
             {
-                clientGUID = clientGuid,
+                playerId = AuthenticationService.Instance.PlayerId,
                 clientScene = SceneManager.GetActiveScene().buildIndex,
                 playerName = m_Portal.PlayerName
             });

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

@@ -31,7 +31,7 @@ public enum OnlineMode
     [Serializable]
     public class ConnectionPayload
     {
-        public string clientGUID;
+        public string playerId;
         public int clientScene = -1;
         public string playerName;
     }

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

@@ -4,6 +4,7 @@
 using Unity.Multiplayer.Samples.BossRoom.Client;
 using UnityEngine;
 using Unity.Netcode;
+using Unity.Services.Authentication;
 using UnityEngine.SceneManagement;
 
 namespace Unity.Multiplayer.Samples.BossRoom.Server
@@ -146,7 +147,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, AuthenticationService.Instance.PlayerId,
                     new SessionPlayerData(clientId, m_Portal.PlayerName, m_Portal.AvatarRegistry.GetRandomAvatar().Guid.ToNetworkGuid(), 0, true));
 
                 connectionApprovedCallback(true, null, true, null, null);
@@ -176,9 +177,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 +188,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

Packages/com.unity.multiplayer.samples.coop/Utilities/Net/SessionManager.cs

@@ -25,11 +25,9 @@ public interface ISessionPlayerData
     /// <typeparam name="T"></typeparam>
     public class SessionManager<T> where T : struct, ISessionPlayerData
     {
-        const string k_HostGUID = "host_guid";
-
         NetworkManager m_NetworkManager;
 
-        protected SessionManager()
+        SessionManager()
         {
             m_NetworkManager = NetworkManager.Singleton;
             if (m_NetworkManager)
@@ -38,7 +36,7 @@ protected SessionManager()
             }
 
             m_ClientData = new Dictionary<string, T>();
-            m_ClientIDToGuid = new Dictionary<ulong, string>();
+            m_ClientIDToPlayerId = new Dictionary<ulong, string>();
         }
 
         ~SessionManager()
@@ -51,44 +49,31 @@ protected SessionManager()
 
         public static SessionManager<T> Instance => s_Instance ??= new SessionManager<T>();
 
-        private static SessionManager<T> s_Instance;
+        static SessionManager<T> s_Instance;
 
         /// <summary>
-        /// Maps a given client guid to the data for a given client player.
+        /// Maps a given client player id to the data for a given client player.
         /// </summary>
-        private Dictionary<string, T> m_ClientData;
+        Dictionary<string, T> m_ClientData;
 
         /// <summary>
-        /// Map to allow us to cheaply map from guid to player data.
+        /// Map to allow us to cheaply map from player id to player data.
         /// </summary>
-        private Dictionary<ulong, string> m_ClientIDToGuid;
-
-        public void AddHostData(T sessionPlayerData)
-        {
-            if (sessionPlayerData.ClientID == m_NetworkManager.ServerClientId)
-            {
-                m_ClientData.Add(k_HostGUID, sessionPlayerData);
-                m_ClientIDToGuid.Add(sessionPlayerData.ClientID, k_HostGUID);
-            }
-            else
-            {
-                Debug.LogError($"Invalid ClientId for host. Got {sessionPlayerData.ClientID}, but should have gotten {m_NetworkManager.ServerClientId}.");
-            }
-        }
+        Dictionary<ulong, string> m_ClientIDToPlayerId;
 
         /// <summary>
         /// Handles the case where NetworkManager has told us a client has disconnected. This includes ourselves, if we're the host,
         /// and the server is stopped."
         /// </summary>
-        private void OnClientDisconnect(ulong clientId)
+        void OnClientDisconnect(ulong clientId)
         {
-            if (m_ClientIDToGuid.TryGetValue(clientId, out var guid))
+            if (m_ClientIDToPlayerId.TryGetValue(clientId, out var playerId))
             {
-                if (GetPlayerData(guid)?.ClientID == clientId)
+                if (GetPlayerData(playerId)?.ClientID == clientId)
                 {
-                    var clientData = m_ClientData[guid];
+                    var clientData = m_ClientData[playerId];
                     clientData.IsConnected = false;
-                    m_ClientData[guid] = clientData;
+                    m_ClientData[playerId] = clientData;
                 }
             }
 
@@ -109,50 +94,33 @@ public void OnUserDisconnectRequest()
             Clear();
         }
 
-        private void Clear()
+        void Clear()
         {
             //resets all our runtime state.
             m_ClientData.Clear();
-            m_ClientIDToGuid.Clear();
+            m_ClientIDToPlayerId.Clear();
         }
 
         /// <summary>
         /// Adds a connecting player's session data if it is a new connection, or updates their session data in case of a reconnection. If the connection is not valid, simply returns false.
         /// </summary>
         /// <param name="clientId">This is the clientId that Netcode assigned us on login. It does not persist across multiple logins from the same client. </param>
-        /// <param name="clientGUID">This is the clientGUID that is unique to this client and persists accross multiple logins from the same client</param>
+        /// <param name="playerId">This is the playerId that is unique to this client and persists across multiple logins from the same client</param>
         /// <param name="sessionPlayerData">The player's initial data</param>
         /// <returns>True if the player connection is valid (i.e. not a duplicate connection)</returns>
-        public bool SetupConnectingPlayerSessionData(ulong clientId, string clientGUID, T sessionPlayerData)
+        public bool SetupConnectingPlayerSessionData(ulong clientId, string playerId, T sessionPlayerData)
         {
             bool success = true;
 
             //Test for Duplicate Login.
-            if (m_ClientData.ContainsKey(clientGUID))
+            if (m_ClientData.ContainsKey(playerId))
             {
                 bool isReconnecting = false;
 
-                // If another client is connected with the same clientGUID
-                if (m_ClientData[clientGUID].IsConnected)
+                // If another client is connected with the same playerId
+                if (m_ClientData[playerId].IsConnected)
                 {
-                    if (Debug.isDebugBuild)
-                    {
-                        Debug.Log($"Client GUID {clientGUID} already exists. Because this is a debug build, we will still accept the connection");
-
-                        // If debug build, accept connection and manually update clientGUID until we get one that either is not connected or that does not already exist
-                        while (m_ClientData.ContainsKey(clientGUID) && m_ClientData[clientGUID].IsConnected) clientGUID += "_Secondary";
-
-                        if (m_ClientData.ContainsKey(clientGUID) && !m_ClientData[clientGUID].IsConnected)
-                        {
-                            // In this specific case, if the clients with the same GUID reconnect in a different order than when they originally connected,
-                            // they will swap characters, since their GUIDs are manually modified here at runtime.
-                            isReconnecting = true;
-                        }
-                    }
-                    else
-                    {
-                        success = false;
-                    }
+                    success = false;
                 }
                 else
                 {
@@ -163,7 +131,7 @@ public bool SetupConnectingPlayerSessionData(ulong clientId, string clientGUID,
                 if (isReconnecting)
                 {
                     // Update player session data
-                    sessionPlayerData = m_ClientData[clientGUID];
+                    sessionPlayerData = m_ClientData[playerId];
                     sessionPlayerData.ClientID = clientId;
                     sessionPlayerData.IsConnected = true;
                 }
@@ -172,8 +140,8 @@ public bool SetupConnectingPlayerSessionData(ulong clientId, string clientGUID,
             //Populate our dictionaries with the SessionPlayerData
             if (success)
             {
-                m_ClientIDToGuid[clientId] = clientGUID;
-                m_ClientData[clientGUID] = sessionPlayerData;
+                m_ClientIDToPlayerId[clientId] = playerId;
+                m_ClientData[playerId] = sessionPlayerData;
             }
 
             return success;
@@ -186,30 +154,30 @@ public bool SetupConnectingPlayerSessionData(ulong clientId, string clientGUID,
         /// <returns>Player data struct matching the given ID</returns>
         public T? GetPlayerData(ulong clientId)
         {
-            //First see if we have a guid matching the clientID given.
+            //First see if we have a playerId matching the clientID given.
 
-            if (m_ClientIDToGuid.TryGetValue(clientId, out string clientGUID))
+            if (m_ClientIDToPlayerId.TryGetValue(clientId, out string playerId))
             {
-                return GetPlayerData(clientGUID);
+                return GetPlayerData(playerId);
             }
 
-            Debug.LogError($"No client guid found mapped to the given client ID: {clientId}");
+            Debug.LogError($"No client player ID found mapped to the given client ID: {clientId}");
             return null;
         }
 
         /// <summary>
         ///
         /// </summary>
-        /// <param name="clientGUID"> guid of the client whose data is requested</param>
+        /// <param name="playerId"> Player ID of the client whose data is requested</param>
         /// <returns>Player data struct matching the given ID</returns>
-        public T? GetPlayerData(string clientGUID)
+        public T? GetPlayerData(string playerId)
         {
-            if (m_ClientData.TryGetValue(clientGUID, out T data))
+            if (m_ClientData.TryGetValue(playerId, out T data))
             {
                 return data;
             }
 
-            Debug.LogError($"No PlayerData of matching guid found: {clientGUID}");
+            Debug.LogError($"No PlayerData of matching player ID found: {playerId}");
             return null;
         }
 
@@ -220,20 +188,20 @@ public bool SetupConnectingPlayerSessionData(ulong clientId, string clientGUID,
         /// <param name="sessionPlayerData"> new data to overwrite the old </param>
         public void SetPlayerData(ulong clientId, T sessionPlayerData)
         {
-            if (m_ClientIDToGuid.TryGetValue(clientId, out string clientGUID))
+            if (m_ClientIDToPlayerId.TryGetValue(clientId, out string playerId))
             {
-                m_ClientData[clientGUID] = sessionPlayerData;
+                m_ClientData[playerId] = sessionPlayerData;
             }
             else
             {
-                Debug.LogError($"No client guid found mapped to the given client ID: {clientId}");
+                Debug.LogError($"No client player ID found mapped to the given client ID: {clientId}");
             }
         }
 
         /// <summary>
         /// Called after the server is created-  This is primarily meant for the host server to clean up or handle/set state as its starting up
         /// </summary>
-        private void ServerStartedHandler()
+        void ServerStartedHandler()
         {
             if (m_NetworkManager.IsServer)
             {
@@ -254,14 +222,14 @@ public void OnSessionEnded()
         {
             ClearDisconnectedPlayersData();
             List<ulong> connectedClientIds = new List<ulong>(m_NetworkManager.ConnectedClientsIds);
-            foreach (var id in m_ClientIDToGuid.Keys)
+            foreach (var id in m_ClientIDToPlayerId.Keys)
             {
                 if (connectedClientIds.Contains(id))
                 {
-                    string guid = m_ClientIDToGuid[id];
-                    T sessionPlayerData = m_ClientData[guid];
+                    string playerId = m_ClientIDToPlayerId[id];
+                    T sessionPlayerData = m_ClientData[playerId];
                     sessionPlayerData.Reinitialize();
-                    m_ClientData[guid] = sessionPlayerData;
+                    m_ClientData[playerId] = sessionPlayerData;
                 }
             }
         }
@@ -270,30 +238,30 @@ void ClearDisconnectedPlayersData()
         {
             List<ulong> idsToClear = new List<ulong>();
             List<ulong> connectedClientIds = new List<ulong>(m_NetworkManager.ConnectedClientsIds);
-            foreach (var id in m_ClientIDToGuid.Keys)
+            foreach (var id in m_ClientIDToPlayerId.Keys)
             {
                 if (!connectedClientIds.Contains(id))
                 {
                     idsToClear.Add(id);
                 }
                 else
                 {
-                    string guid = m_ClientIDToGuid[id];
-                    T sessionPlayerData = m_ClientData[guid];
+                    string playerId = m_ClientIDToPlayerId[id];
+                    T sessionPlayerData = m_ClientData[playerId];
                     sessionPlayerData.Reinitialize();
-                    m_ClientData[guid] = sessionPlayerData;
+                    m_ClientData[playerId] = sessionPlayerData;
                 }
             }
 
             foreach (var id in idsToClear)
             {
-                string guid = m_ClientIDToGuid[id];
-                if (GetPlayerData(guid)?.ClientID == id)
+                string playerId = m_ClientIDToPlayerId[id];
+                if (GetPlayerData(playerId)?.ClientID == id)
                 {
-                    m_ClientData.Remove(guid);
+                    m_ClientData.Remove(playerId);
                 }
 
-                m_ClientIDToGuid.Remove(id);
+                m_ClientIDToPlayerId.Remove(id);
             }
         }
     }