feat: windows webview

nattb8 · nattb8 · commit 2f1647f5a245 · 2024-07-30T17:20:40.000+12:00
diff --git a/.gitignore b/.gitignore
@@ -100,5 +100,4 @@ sample/AltTester.log
 sample/mono_crash*
 
 # Vuplex
-src/Packages/Passport/Runtime/ThirdParty/Vuplex/Vuplex
-src/Packages/Passport/Runtime/ThirdParty/Vuplex/Vuplex.meta
+sample/Assets/Vuplex*
diff --git a/sample/Assets/Scripts/SelectAuthMethodScript.cs b/sample/Assets/Scripts/SelectAuthMethodScript.cs
@@ -79,6 +79,7 @@ private async void InitialisePassport(string redirectUri = null, string logoutRe
         }
         catch (Exception ex)
         {
+            Debug.Log(ex);
             ShowOutput($"Initialise Passport error: {ex.Message}");
         }
     }
diff --git a/sample/ProjectSettings/ProjectSettings.asset b/sample/ProjectSettings/ProjectSettings.asset
@@ -499,6 +499,9 @@ PlayerSettings:
   - m_BuildTarget: iOSSupport
     m_APIs: 10000000
     m_Automatic: 1
+  - m_BuildTarget: WindowsStandaloneSupport
+    m_APIs: 02000000
+    m_Automatic: 1
   m_BuildTargetVRSettings: []
   m_DefaultShaderChunkSizeInMB: 16
   m_DefaultShaderChunkCount: 0
@@ -766,14 +769,14 @@ PlayerSettings:
   webGLDecompressionFallback: 0
   webGLPowerPreference: 2
   scriptingDefineSymbols:
-    Standalone: 
+    Standalone: VUPLEX_STANDALONE
   additionalCompilerArguments:
     Standalone:
     - -nullable+
   platformArchitecture: {}
   scriptingBackend:
     Android: 1
-    Standalone: 1
+    Standalone: 0
   il2cppCompilerConfiguration: {}
   managedStrippingLevel:
     EmbeddedLinux: 1
@@ -794,7 +797,7 @@ PlayerSettings:
   allowUnsafeCode: 0
   useDeterministicCompilation: 1
   enableRoslynAnalyzers: 1
-  selectedPlatform: 2
+  selectedPlatform: 0
   additionalIl2CppArgs: 
   scriptingRuntimeVersion: 1
   gcIncremental: 1
diff --git a/src/Packages/Passport/Runtime/Resources/index.html b/src/Packages/Passport/Runtime/Resources/index.html
diff --git a/src/Packages/Passport/Runtime/Scripts/Private/Core/BrowserCommunicationsManager.cs b/src/Packages/Passport/Runtime/Scripts/Private/Core/BrowserCommunicationsManager.cs
@@ -19,8 +19,10 @@ namespace Immutable.Passport.Core
 
     public interface IBrowserCommunicationsManager
     {
+#if (UNITY_ANDROID && !UNITY_EDITOR_WIN) || (UNITY_IPHONE && !UNITY_EDITOR_WIN) || UNITY_STANDALONE_OSX
         event OnUnityPostMessageDelegate OnAuthPostMessage;
         event OnUnityPostMessageErrorDelegate OnPostMessageError;
+#endif
         void SetCallTimeout(int ms);
         void LaunchAuthURL(string url, string redirectUri);
         UniTask<string> Call(string fxName, string data = null, bool ignoreTimeout = false, Nullable<long> timeoutMs = null);
@@ -60,8 +62,10 @@ public BrowserCommunicationsManager(IWebBrowserClient webBrowserClient)
         {
             this.webBrowserClient = webBrowserClient;
             this.webBrowserClient.OnUnityPostMessage += InvokeOnUnityPostMessage;
+#if (UNITY_ANDROID && !UNITY_EDITOR_WIN) || (UNITY_IPHONE && !UNITY_EDITOR_WIN) || UNITY_STANDALONE_OSX
             this.webBrowserClient.OnAuthPostMessage += InvokeOnAuthPostMessage;
             this.webBrowserClient.OnPostMessageError += InvokeOnPostMessageError;
+#endif
         }
 
         #region Unity to Browser
diff --git a/src/Packages/Passport/Runtime/Scripts/Private/PassportImpl.cs b/src/Packages/Passport/Runtime/Scripts/Private/PassportImpl.cs
@@ -54,8 +54,11 @@ public async UniTask Init(string clientId, string environment, string redirectUr
         {
             this.redirectUri = redirectUri;
             this.logoutRedirectUri = logoutRedirectUri;
+
+#if (UNITY_ANDROID && !UNITY_EDITOR_WIN) || (UNITY_IPHONE && !UNITY_EDITOR_WIN) || UNITY_STANDALONE_OSX
             this.communicationsManager.OnAuthPostMessage += OnDeepLinkActivated;
             this.communicationsManager.OnPostMessageError += OnPostMessageError;
+#endif
 
             var versionInfo = new VersionInfo
             {
diff --git a/src/Packages/Passport/Runtime/Scripts/Public/Passport.cs b/src/Packages/Passport/Runtime/Scripts/Public/Passport.cs
@@ -20,69 +20,86 @@ public class Passport
         private const string TAG = "[Passport]";
 
         public static Passport Instance { get; private set; }
+        private PassportImpl passportImpl = null;
 
-#if UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
-        private readonly IWebBrowserClient webBrowserClient = new WebBrowserClient();
-#else
-        private readonly IWebBrowserClient webBrowserClient = new GreeBrowserClient();
-#endif
+        private IWebBrowserClient webBrowserClient;
 
         // Keeps track of the latest received deeplink
         private static string deeplink = null;
         private static bool readySignalReceived = false;
-        private PassportImpl passportImpl = null;
 
+        /// <summary>
+        /// Passport auth events
+        /// </summary>
+        /// <seealso cref="Immutable.Passport.Event.PassportAuthEvent" />
         public event OnAuthEventDelegate OnAuthEvent;
 
         private Passport()
         {
+            // Handle clean-up tasks when the application is quitting
 #if UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
             Application.quitting += OnQuit;
 #elif UNITY_IPHONE || UNITY_STANDALONE_OSX || UNITY_EDITOR_OSX
+            // Handle deeplinks for iOS and macOS
             Application.deepLinkActivated += OnDeepLinkActivated;
+
+            // Check if there is a deep link URL provided on application start
             if (!string.IsNullOrEmpty(Application.absoluteURL))
             {
-                // Cold start and Application.absoluteURL not null so process Deep Link.
+                // Handle the deep link if provided during a cold start
                 OnDeepLinkActivated(Application.absoluteURL);
             }
 #endif
         }
 
         /// <summary>
-        /// Initialises Passport
+        /// Initialises Passport with the specified parameters. 
+        /// This sets up the Passport instance, configures the web browser, and waits for the ready signal.
         /// </summary>
         /// <param name="clientId">The client ID</param>
         /// <param name="environment">The environment to connect to</param>
-        /// <param name="redirectUri">(Android, iOS and macOS only) The URL to which auth will redirect the browser after authorisation has been granted by the user</param>
-        /// <param name="logoutRedirectUri">(Android, iOS and macOS only) The URL to which auth will redirect the browser after log out is complete</param>
-        /// <param name="engineStartupTimeoutMs">(Windows only) Timeout time for waiting for the engine to start (in milliseconds)</param>
+        /// <param name="redirectUri">(Android, iOS, and macOS only) The URL where the browser will redirect after successful authentication.</param>
+        /// <param name="logoutRedirectUri">(Android, iOS, and macOS only) The URL where the browser will redirect after logout is complete.</param>
+        /// <param name="engineStartupTimeoutMs">(Windows only) Timeout duration in milliseconds to wait for the default Windows browser engine to start.</param>
+        /// <param name="webBrowserClient">(Windows only) Custom Windows browser to use instead of the default browser in the SDK.</param>
         public static UniTask<Passport> Init(
 #if UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
-            string clientId, string environment, string redirectUri = null, string logoutRedirectUri = null, int engineStartupTimeoutMs = 30000
+            string clientId, 
+            string environment, 
+            string redirectUri = null, 
+            string logoutRedirectUri = null,
+            int engineStartupTimeoutMs = 30000,
+            WindowsWebBrowserClient webBrowserClient = null
 #else
-            string clientId, string environment, string redirectUri = null, string logoutRedirectUri = null
+            string clientId,
+            string environment,
+            string redirectUri = null,
+            string logoutRedirectUri = null
 #endif
         )
         {
             if (Instance == null)
             {
                 Debug.Log($"{TAG} Initialising Passport...");
                 Instance = new Passport();
-                // Wait until we get a ready signal
+
+                // Start initialisation process
                 return Instance.Initialise(
 #if UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
-                        engineStartupTimeoutMs
+                        engineStartupTimeoutMs, webBrowserClient
 #endif
                     )
                     .ContinueWith(async () =>
                     {
+                        // Wait for the ready signal
                         Debug.Log($"{TAG} Waiting for ready signal...");
                         await UniTask.WaitUntil(() => readySignalReceived == true);
                     })
                     .ContinueWith(async () =>
                     {
                         if (readySignalReceived == true)
                         {
+                            // Initialise Passport with provided parameters
                             await Instance.GetPassportImpl().Init(clientId, environment, redirectUri, logoutRedirectUri, deeplink);
                             return Instance;
                         }
@@ -95,43 +112,72 @@ public static UniTask<Passport> Init(
             }
             else
             {
+                // Return the existing instance if already initialised
                 readySignalReceived = true;
                 return UniTask.FromResult(Instance);
             }
         }
 
+        /// <summary>
+        /// Initialises the appropriate web browser and sets up browser communication.
+        /// </summary>
+        /// <param name="engineStartupTimeoutMs">(Windows only) Timeout duration in milliseconds to wait for the default Windows browser engine to start.</param>
+        /// <param name="webBrowserClient">(Windows only) Custom Windows browser to use instead of the default browser in the SDK.</param>
         private async UniTask Initialise(
 #if UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
-            int engineStartupTimeoutMs
+            int engineStartupTimeoutMs, WindowsWebBrowserClient webBrowserClient
 #endif
         )
         {
             try
             {
-                BrowserCommunicationsManager communicationsManager = new BrowserCommunicationsManager(webBrowserClient);
-                communicationsManager.OnReady += () => readySignalReceived = true;
+                // Initialise the web browser client
 #if UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
-                await ((WebBrowserClient)webBrowserClient).Init(engineStartupTimeoutMs);
+                if (webBrowserClient != null)
+                {
+                    // Use the provided custom Windows browser client
+                    this.webBrowserClient = webBrowserClient;
+                    await ((WindowsWebBrowserClient)this.webBrowserClient).Init();
+                }
+                else
+                {
+                    // Initialise with default Windows browser client
+                    this.webBrowserClient = new WebBrowserClient();
+                    await ((WebBrowserClient)this.webBrowserClient).Init(engineStartupTimeoutMs);
+                }
+#else
+                // Initialise default browser client for Android, iOS, and macOS
+                webBrowserClient = new GreeBrowserClient();
 #endif
+
+                // Set up browser communication
+                BrowserCommunicationsManager communicationsManager = new BrowserCommunicationsManager(webBrowserClient);
+                // Mark ready when browser is initialised and game bridge file is loaded
+                communicationsManager.OnReady += () => readySignalReceived = true;
+
+                // Set up Passport implementation
                 passportImpl = new PassportImpl(communicationsManager);
+                // Subscribe to Passport authentication events
                 passportImpl.OnAuthEvent += OnPassportAuthEvent;
             }
             catch (Exception ex)
             {
-                // Reset values
+                // Reset everything on error
                 readySignalReceived = false;
                 Instance = null;
                 throw ex;
             }
         }
 
+
 #if UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
+        /// <summary>
+        /// Handles clean-up when the application quits.
+        /// </summary>
         private void OnQuit()
         {
-            // Need to clean up UWB resources when quitting the game in the editor
-            // as the child engine process would still be alive
             Debug.Log($"{TAG} Quitting the Player");
-            ((WebBrowserClient)webBrowserClient).Dispose();
+            webBrowserClient.Dispose();
             Instance = null;
         }
 #endif
diff --git a/src/Packages/Passport/Runtime/ThirdParty/Gree/Assets/Plugins/GreeBrowserClient.cs b/src/Packages/Passport/Runtime/ThirdParty/Gree/Assets/Plugins/GreeBrowserClient.cs
@@ -1,3 +1,5 @@
+#if (UNITY_ANDROID && !UNITY_EDITOR_WIN) || (UNITY_IPHONE && !UNITY_EDITOR_WIN) || UNITY_STANDALONE_OSX
+
 using Immutable.Browser.Core;
 using UnityEngine;
 using System.IO;
@@ -96,4 +98,6 @@ public void ClearStorage()
 #endif
 
     }
-}
+}
+
+#endif
diff --git a/src/Packages/Passport/Runtime/ThirdParty/ImmutableBrowserCore/IWebBrowserClient.cs b/src/Packages/Passport/Runtime/ThirdParty/ImmutableBrowserCore/IWebBrowserClient.cs
@@ -3,12 +3,21 @@ namespace Immutable.Browser.Core
     public interface IWebBrowserClient
     {
         event OnUnityPostMessageDelegate OnUnityPostMessage;
+
+        // Required for Gree browser only
+#if (UNITY_ANDROID && !UNITY_EDITOR_WIN) || (UNITY_IPHONE && !UNITY_EDITOR_WIN) || UNITY_STANDALONE_OSX
         event OnUnityPostMessageDelegate OnAuthPostMessage;
         event OnUnityPostMessageErrorDelegate OnPostMessageError;
-
+#endif
         void ExecuteJs(string js);
-
         void LaunchAuthURL(string url, string redirectUri);
+
+        // Required for Windows browser only
+#if UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
+        void Dispose();
+#endif
+
+        // Only available for mobile devices
 #if (UNITY_IPHONE && !UNITY_EDITOR) || (UNITY_ANDROID && !UNITY_EDITOR)
         void ClearCache(bool includeDiskFiles);
         void ClearStorage();
diff --git a/src/Packages/Passport/Runtime/ThirdParty/ImmutableBrowserCore/Immutable.Browser.Core.asmdef b/src/Packages/Passport/Runtime/ThirdParty/ImmutableBrowserCore/Immutable.Browser.Core.asmdef
@@ -1,7 +1,9 @@
 {
     "name": "Immutable.Browser.Core",
     "rootNamespace": "Immutable.Browser.Core",
-    "references": [],
+    "references": [
+        "GUID:f51ebe6a0ceec4240a699833d6309b23"
+    ],
     "includePlatforms": [],
     "excludePlatforms": [],
     "allowUnsafeCode": false,
diff --git a/src/Packages/Passport/Runtime/ThirdParty/ImmutableBrowserCore/WindowsWebBrowserClient.cs b/src/Packages/Passport/Runtime/ThirdParty/ImmutableBrowserCore/WindowsWebBrowserClient.cs
@@ -0,0 +1,39 @@
+using System.IO;
+using UnityEngine;
+using Immutable.Browser.Core;
+using Cysharp.Threading.Tasks;
+
+namespace Immutable.Browser.Core
+{
+    public abstract class WindowsWebBrowserClient : IWebBrowserClient
+    {
+        public event OnUnityPostMessageDelegate OnUnityPostMessage;
+
+        public abstract UniTask Init();
+
+        public abstract void ExecuteJs(string js);
+
+        protected void PostMessage(string message)
+        {
+            OnUnityPostMessage?.Invoke(message);
+        }
+
+        public void LaunchAuthURL(string url, string? redirectUri)
+        {
+            Application.OpenURL(url);
+        }
+
+        public abstract void Dispose();
+
+        protected string GetBridgeFilePath()
+        {
+            string filePath = "";
+#if UNITY_EDITOR
+            filePath = Constants.SCHEME_FILE + Path.GetFullPath($"{Constants.PASSPORT_PACKAGE_RESOURCES_DIRECTORY}{Constants.PASSPORT_HTML_FILE_NAME}");
+#elif UNITY_STANDALONE_WIN || (UNITY_ANDROID && UNITY_EDITOR_WIN) || (UNITY_IPHONE && UNITY_EDITOR_WIN)
+            filePath = Constants.SCHEME_FILE + Path.GetFullPath(Application.dataPath) + Constants.PASSPORT_DATA_DIRECTORY_NAME + Constants.PASSPORT_HTML_FILE_NAME;
+#endif
+            return filePath;
+        }
+    }
+}
diff --git a/src/Packages/Passport/Runtime/ThirdParty/ImmutableBrowserCore/WindowsWebBrowserClient.cs.meta b/src/Packages/Passport/Runtime/ThirdParty/ImmutableBrowserCore/WindowsWebBrowserClient.cs.meta
diff --git a/src/Packages/Passport/Runtime/ThirdParty/UnityWebBrowser/Runtime/Core/WebBrowserClient.cs b/src/Packages/Passport/Runtime/ThirdParty/UnityWebBrowser/Runtime/Core/WebBrowserClient.cs
@@ -609,8 +609,6 @@ internal void InvokeLoadProgressChange(double progress)
         ///     Invoked when the browser goes in or out of fullscreen
         /// </summary>
         public event OnFullscreenChange OnFullscreen;
-        public event OnUnityPostMessageDelegate OnAuthPostMessage;
-        public event OnUnityPostMessageErrorDelegate OnPostMessageError;
 
         internal void InvokeFullscreen(bool fullscreen)
         {
diff --git a/src/Packages/Passport/Runtime/ThirdParty/Vuplex.meta b/src/Packages/Passport/Runtime/ThirdParty/Vuplex.meta
diff --git a/src/Packages/Passport/Runtime/ThirdParty/Vuplex/VuplexWebView.cs b/src/Packages/Passport/Runtime/ThirdParty/Vuplex/VuplexWebView.cs
diff --git a/src/Packages/Passport/Tests/Runtime/Scripts/Core/BrowserCommunicationsManagerTests.cs b/src/Packages/Passport/Tests/Runtime/Scripts/Core/BrowserCommunicationsManagerTests.cs

Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,7 @@ private async void InitialisePassport(string redirectUri = null, string logoutRe`
`79`	`79`	`}`
`80`	`80`	`catch (Exception ex)`
`81`	`81`	`{`
	`82`	`+ Debug.Log(ex);`
`82`	`83`	`ShowOutput($"Initialise Passport error: {ex.Message}");`
`83`	`84`	`}`
`84`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,10 @@ namespace Immutable.Passport.Core`
`19`	`19`
`20`	`20`	`public interface IBrowserCommunicationsManager`
`21`	`21`	`{`
	`22`	`+#if (UNITY_ANDROID && !UNITY_EDITOR_WIN) \|\| (UNITY_IPHONE && !UNITY_EDITOR_WIN) \|\| UNITY_STANDALONE_OSX`
`22`	`23`	`event OnUnityPostMessageDelegate OnAuthPostMessage;`
`23`	`24`	`event OnUnityPostMessageErrorDelegate OnPostMessageError;`
	`25`	`+#endif`
`24`	`26`	`void SetCallTimeout(int ms);`
`25`	`27`	`void LaunchAuthURL(string url, string redirectUri);`
`26`	`28`	`UniTask<string> Call(string fxName, string data = null, bool ignoreTimeout = false, Nullable<long> timeoutMs = null);`
`@@ -60,8 +62,10 @@ public BrowserCommunicationsManager(IWebBrowserClient webBrowserClient)`
`60`	`62`	`{`
`61`	`63`	`this.webBrowserClient = webBrowserClient;`
`62`	`64`	`this.webBrowserClient.OnUnityPostMessage += InvokeOnUnityPostMessage;`
	`65`	`+#if (UNITY_ANDROID && !UNITY_EDITOR_WIN) \|\| (UNITY_IPHONE && !UNITY_EDITOR_WIN) \|\| UNITY_STANDALONE_OSX`
`63`	`66`	`this.webBrowserClient.OnAuthPostMessage += InvokeOnAuthPostMessage;`
`64`	`67`	`this.webBrowserClient.OnPostMessageError += InvokeOnPostMessageError;`
	`68`	`+#endif`
`65`	`69`	`}`
`66`	`70`
`67`	`71`	`#region Unity to Browser`
Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,11 @@ public async UniTask Init(string clientId, string environment, string redirectUr`
`54`	`54`	`{`
`55`	`55`	`this.redirectUri = redirectUri;`
`56`	`56`	`this.logoutRedirectUri = logoutRedirectUri;`
	`57`	`+`
	`58`	`+#if (UNITY_ANDROID && !UNITY_EDITOR_WIN) \|\| (UNITY_IPHONE && !UNITY_EDITOR_WIN) \|\| UNITY_STANDALONE_OSX`
`57`	`59`	`this.communicationsManager.OnAuthPostMessage += OnDeepLinkActivated;`
`58`	`60`	`this.communicationsManager.OnPostMessageError += OnPostMessageError;`
	`61`	`+#endif`
`59`	`62`
`60`	`63`	`var versionInfo = new VersionInfo`
`61`	`64`	`{`
Original file line number	Diff line number	Diff line change
`@@ -609,8 +609,6 @@ internal void InvokeLoadProgressChange(double progress)`
`609`	`609`	`/// Invoked when the browser goes in or out of fullscreen`
`610`	`610`	`/// </summary>`
`611`	`611`	`public event OnFullscreenChange OnFullscreen;`
`612`		`- public event OnUnityPostMessageDelegate OnAuthPostMessage;`
`613`		`- public event OnUnityPostMessageErrorDelegate OnPostMessageError;`
`614`	`612`
`615`	`613`	`internal void InvokeFullscreen(bool fullscreen)`
`616`	`614`	`{`