cherry pick of lobby fix: Adding instructions when we get a service error on conflicting joins (#511)

Author: SamuelBellomo

Assets/BossRoom/Scenes/Startup.unity

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:7b2c33d4681d53ec62b32b7ff2c81123b4457d8dcd8d0b6d643097e74ae36856
-size 35006
+oid sha256:22939a0b19a2e47d1c43cf76d229f2a99bcc8511f03020367645a163b6ab2fba
+size 35402

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

@@ -21,6 +21,7 @@ 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;
@@ -67,7 +68,7 @@ void InjectDependenciesAndInitialize(AuthenticationServiceFacade authServiceFaca
             var arguments = System.Environment.GetCommandLineArgs();
             for (int i = 0; i < arguments.Length; i++)
             {
-                if (arguments[i] == "-AuthProfile")
+                if (arguments[i] == AuthProfileCommandLineArg)
                 {
                     var profileId = arguments[i + 1];
                     unityAuthenticationInitOptions.SetProfile(profileId);

Assets/BossRoom/Scripts/Client/UI/Lobby/LobbyUIMediator.cs

@@ -1,7 +1,7 @@
+using System;
 using TMPro;
 using Unity.Multiplayer.Samples.BossRoom.Client;
 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 Unity.Services.Authentication;
 using Unity.Services.Lobbies.Models;
@@ -33,7 +33,6 @@ public class LobbyUIMediator : MonoBehaviour
         [Inject]
         void InjectDependenciesAndInitialize(
             LobbyServiceFacade lobbyServiceFacade,
-            IPublisher<UnityServiceErrorMessage> unityServiceErrorMessagePublisher,
             LocalLobbyUser localUser,
             LocalLobby localLobby,
             NameGenerationData nameGenerationData,

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

@@ -0,0 +1,47 @@
+using System;
+using Unity.Multiplayer.Samples.BossRoom.Client;
+using Unity.Multiplayer.Samples.BossRoom.Shared.Infrastructure;
+using Unity.Multiplayer.Samples.BossRoom.Shared.Net.UnityServices.Infrastructure;
+using Unity.Services.Lobbies;
+using UnityEngine;
+
+namespace Unity.Multiplayer.Samples.BossRoom.Visual
+{
+    public class UnityServicesUIHandler : MonoBehaviour
+    {
+        IDisposable m_Subscriptions;
+
+        void Awake()
+        {
+            DontDestroyOnLoad(gameObject);
+        }
+
+        [Inject]
+        void Initialize(ISubscriber<UnityServiceErrorMessage> serviceError)
+        {
+            m_Subscriptions = serviceError.Subscribe(ServiceErrorHandler);
+        }
+
+        void ServiceErrorHandler(UnityServiceErrorMessage error)
+        {
+            var errorMessage = error.Message;
+            if (error.AffectedService == UnityServiceErrorMessage.Service.Lobby)
+            {
+                if ((error.OriginalException as LobbyServiceException).Reason == LobbyExceptionReason.LobbyConflict)
+                {
+                    // 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");
+                }
+            }
+
+            PopupPanel.ShowPopupPanel("Service error", errorMessage);
+        }
+
+        void OnDestroy()
+        {
+            m_Subscriptions.Dispose();
+        }
+    }
+}

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

@@ -24,7 +24,7 @@ void OnServiceException(AuthenticationException e)
 
             var reason = $"{e.Message} ({e.InnerException?.Message})"; // Lobby error type, then HTTP error type.
 
-            m_UnityServiceErrorMessagePublisher.Publish(new UnityServiceErrorMessage("Authentication Error", reason));
+            m_UnityServiceErrorMessagePublisher.Publish(new UnityServiceErrorMessage("Authentication Error", reason, UnityServiceErrorMessage.Service.Authentication, e));
         }
 
         public void DoSignInAsync(Action onSigninComplete, Action onFailed, InitializationOptions initializationOptions)

Assets/BossRoom/Scripts/Shared/Net/UnityServices/Auth/AuthenticationServiceFacade.cs

@@ -1,13 +1,26 @@
+using Unity.Services.Core;
+
 namespace Unity.Multiplayer.Samples.BossRoom.Shared.Net.UnityServices.Infrastructure
 {
     public struct UnityServiceErrorMessage
     {
+        public enum Service
+        {
+            Authentication,
+            Lobby,
+        }
+
         public string Title;
         public string Message;
-        public UnityServiceErrorMessage(string title, string message)
+        public Service AffectedService;
+        public RequestFailedException OriginalException;
+
+        public UnityServiceErrorMessage(string title, string message, Service service, RequestFailedException originalException = null)
         {
             Title = title;
             Message = message;
+            AffectedService = service;
+            OriginalException = originalException;
         }
     }
 }

Assets/BossRoom/Scripts/Shared/Net/UnityServices/Infrastructure/Messages/UnityServiceErrorMessage.cs

@@ -66,7 +66,7 @@ void OnServiceException(LobbyServiceException e)
 
             var reason = $"{e.Message} ({e.InnerException?.Message})"; // Lobby error type, then HTTP error type.
 
-            m_UnityServiceErrorMessagePublisher.Publish(new UnityServiceErrorMessage("Lobby Error", reason));
+            m_UnityServiceErrorMessagePublisher.Publish(new UnityServiceErrorMessage("Lobby Error", reason, UnityServiceErrorMessage.Service.Lobby, e));
         }
 
         public void CreateLobbyAsync(string requesterUasId, string lobbyName, int maxPlayers, bool isPrivate, Dictionary<string, PlayerDataObject> hostUserData, Dictionary<string, DataObject> lobbyData, Action<Lobby> onComplete, Action onFailed)

Assets/BossRoom/Scripts/Shared/Net/UnityServices/Lobbies/LobbyAPIInterface.cs

@@ -125,7 +125,7 @@ void OnSuccess(Lobby lobby)
                             return;
                         }
                     }
-                    m_UnityServiceErrorMessagePub.Publish(new UnityServiceErrorMessage("Host left the lobby","Disconnecting."));
+                    m_UnityServiceErrorMessagePub.Publish(new UnityServiceErrorMessage("Host left the lobby","Disconnecting.", UnityServiceErrorMessage.Service.Lobby));
                     ForceLeaveLobbyAttempt();
                     // no need to disconnect Netcode, it should already be handled by Netcode's callback to disconnect
                 }