Merge branch 'master' into 'release'

Voltstro · Voltstro · commit c81279afdbad · 2024-10-06T21:42:19.000+10:00
Release 2.2.1

See merge request voltstro-studios/uwb/unitywebbrowser!4
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.1] - 2024-10-06
+
+### Added
+
+- Added Incognito mode
+
+### Changed
+
+- Updated CEF to 129.0.11
+- CachePath can only be set before HasInitialized
+- LogPath can only be set before HasInitialized
+- Change some path building to use `Path.Combine` instead
+
+### Deprecated
+
+- Cache control is no longer used. A cache path will always be used now. To use a incognito/private mode, where no profile-specific data is persisted to disk, set incognito mode to true.
+
+### Fixed
+
+- Do not pass proxy settings if ProxyServer is false
+- Fix missing icudtl.dat on Linux cef (#346)
+
 ## [2.2.0] - 2024-09-20
 
 ### Added
diff --git a/docs/articles/dev/dev-guide.md b/docs/articles/dev/dev-guide.md
@@ -14,7 +14,3 @@ To setup UWB's git repo, see the [setup section](setup.md).
 ## Developing
 
 When developing for UWB, it is highly recommended to develop using the `src/UnityWebBrowser.UnityProject` project provided in the repo. Other means of development will **NOT** be supported! Even if you are creating an external separate package for UWB, it is still recommended to develop using the provided project in the repo! We recommend this approach as the Unity project has all dependencies ready to go, all the tools, and proper projects setup for the code (both Engine and Core).
-
-## Packaging
-
-TODO
diff --git a/docs/articles/user/setup.md b/docs/articles/user/setup.md
@@ -53,7 +53,7 @@ To know what packages you need, checkout the [packages section](packages.md).
 
 Most developers will probably only need the 'Core' package, and a single engine with it's native Windows binaries. A basic installation might look like this.
 
-![Packages](~/assets/images/articles/user/packages/StandardPackages.webp)
+![Packages](~/assets/images/articles/user/setup/StandardPackages.webp)
 
 If you plan on providing builds of your game for Linux and MacOS, install their native engine packages as well.
 
diff --git a/src/Packages/UnityWebBrowser.Engine.Cef.Linux-x64/package.json b/src/Packages/UnityWebBrowser.Engine.Cef.Linux-x64/package.json
@@ -2,7 +2,7 @@
   "name": "dev.voltstro.unitywebbrowser.engine.cef.linux.x64",
   "displayName": "Unity Web Browser CEF Engine (Linux x64)",
   "description": "CEF engine for Unity Web Browser (Linux x64).",
-  "version": "2.2.0-128.4.9",
+  "version": "2.2.1-129.0.11",
   "unity": "2021.3",
   "author": {
     "name": "Voltstro",
@@ -17,6 +17,6 @@
   "documentationUrl": "https://projects.voltstro.dev/UnityWebBrowser/latest/articles/user/engines/#cef-engine",
   "licensesUrl": "https://github.com/Voltstro-Studios/UnityWebBrowser/blob/master/LICENSE.md",
   "dependencies": {
-    "dev.voltstro.unitywebbrowser.engine.cef": "2.2.0-128.4.9"
+    "dev.voltstro.unitywebbrowser.engine.cef": "2.2.1-129.0.11"
   }
 }
diff --git a/src/Packages/UnityWebBrowser.Engine.Cef.MacOS-arm64/package.json b/src/Packages/UnityWebBrowser.Engine.Cef.MacOS-arm64/package.json
@@ -2,7 +2,7 @@
   "name": "dev.voltstro.unitywebbrowser.engine.cef.macos.arm64",
   "displayName": "Unity Web Browser CEF Engine (MacOS arm64)",
   "description": "CEF engine for Unity Web Browser (MacOS arm64).",
-  "version": "2.2.0-128.4.9",
+  "version": "2.2.1-129.0.11",
   "unity": "2021.2",
   "author": {
     "name": "Voltstro",
@@ -17,6 +17,6 @@
   "documentationUrl": "https://projects.voltstro.dev/UnityWebBrowser/latest/articles/user/engines/#cef-engine",
   "licensesUrl": "https://github.com/Voltstro-Studios/UnityWebBrowser/blob/master/LICENSE.md",
   "dependencies": {
-    "dev.voltstro.unitywebbrowser.engine.cef": "2.2.0-128.4.9"
+    "dev.voltstro.unitywebbrowser.engine.cef": "2.2.1-129.0.11"
   }
 }
diff --git a/src/Packages/UnityWebBrowser.Engine.Cef.MacOS-x64/package.json b/src/Packages/UnityWebBrowser.Engine.Cef.MacOS-x64/package.json
@@ -2,7 +2,7 @@
   "name": "dev.voltstro.unitywebbrowser.engine.cef.macos.x64",
   "displayName": "Unity Web Browser CEF Engine (MacOS x64)",
   "description": "CEF engine for Unity Web Browser (MacOS x64).",
-  "version": "2.2.0-128.4.9",
+  "version": "2.2.1-129.0.11",
   "unity": "2021.2",
   "author": {
     "name": "Voltstro",
@@ -17,6 +17,6 @@
   "documentationUrl": "https://projects.voltstro.dev/UnityWebBrowser/latest/articles/user/engines/#cef-engine",
   "licensesUrl": "https://github.com/Voltstro-Studios/UnityWebBrowser/blob/master/LICENSE.md",
   "dependencies": {
-    "dev.voltstro.unitywebbrowser.engine.cef": "2.2.0-128.4.9"
+    "dev.voltstro.unitywebbrowser.engine.cef": "2.2.1-129.0.11"
   }
 }
diff --git a/src/Packages/UnityWebBrowser.Engine.Cef.Win-x64/package.json b/src/Packages/UnityWebBrowser.Engine.Cef.Win-x64/package.json
@@ -2,7 +2,7 @@
   "name": "dev.voltstro.unitywebbrowser.engine.cef.win.x64",
   "displayName": "Unity Web Browser CEF Engine (Win x64)",
   "description": "CEF engine for Unity Web Browser (Win x64).",
-  "version": "2.2.0-128.4.9",
+  "version": "2.2.1-129.0.11",
   "unity": "2021.2",
   "author": {
     "name": "Voltstro",
@@ -17,6 +17,6 @@
   "documentationUrl": "https://projects.voltstro.dev/UnityWebBrowser/latest/articles/user/engines/#cef-engine",
   "licensesUrl": "https://github.com/Voltstro-Studios/UnityWebBrowser/blob/master/LICENSE.md",
   "dependencies": {
-    "dev.voltstro.unitywebbrowser.engine.cef": "2.2.0-128.4.9"
+    "dev.voltstro.unitywebbrowser.engine.cef": "2.2.1-129.0.11"
   }
 }
diff --git a/src/Packages/UnityWebBrowser.Engine.Cef/package.json b/src/Packages/UnityWebBrowser.Engine.Cef/package.json
@@ -2,7 +2,7 @@
   "name": "dev.voltstro.unitywebbrowser.engine.cef",
   "displayName": "Unity Web Browser CEF Engine",
   "description": "CEF engine for Unity Web Browser.",
-  "version": "2.2.0-128.4.9",
+  "version": "2.2.1-129.0.11",
   "unity": "2021.3",
   "author": {
     "name": "Voltstro",
@@ -18,6 +18,6 @@
   "documentationUrl": "https://projects.voltstro.dev/UnityWebBrowser/latest/articles/user/engines/#cef-engine",
   "licensesUrl": "https://github.com/Voltstro-Studios/UnityWebBrowser/blob/master/LICENSE.md",
   "dependencies": {
-    "dev.voltstro.unitywebbrowser": "2.2.0"
+    "dev.voltstro.unitywebbrowser": "2.2.1"
   }
 }
diff --git a/src/Packages/UnityWebBrowser/Runtime/AssemblyInfo.cs b/src/Packages/UnityWebBrowser/Runtime/AssemblyInfo.cs
@@ -34,8 +34,8 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.2.0")]
-[assembly: AssemblyFileVersion("2.2.0")]
+[assembly: AssemblyVersion("2.2.1")]
+[assembly: AssemblyFileVersion("2.2.1")]
 
 [assembly: InternalsVisibleTo("VoltstroStudios.UnityWebBrowser.Prj")]
 [assembly: InternalsVisibleTo("VoltstroStudios.UnityWebBrowser.Editor")]
diff --git a/src/Packages/UnityWebBrowser/Runtime/Core/WebBrowserClient.cs b/src/Packages/UnityWebBrowser/Runtime/Core/WebBrowserClient.cs
@@ -103,8 +103,17 @@ public Resolution Resolution
         ///     Enable or disable the cache
         /// </summary>
         [Tooltip("Enable or disable the cache")]
+        [Obsolete("Cache control is no longer used. A cache path will always be used now. To use a incognito/private mode, where no profile-specific data is persisted to disk, set incognitoMode to true.")]
+        [HideInInspector]
         public bool cache = true;
 
+        /// <summary>
+        ///     Enable or disable incognito/private mode.
+        ///     When true, no profile-specific data is persisted to disk, but cache is sill used to persist installation-specific data.
+        /// </summary>
+        [Tooltip("Enable or disable incognito/private mode. When true, no profile-specific data is persisted to disk, but cache is still used to persist installation-specific data.")]
+        public bool incognitoMode;
+
         /// <summary>
         ///     Enable or disable WebRTC
         /// </summary>
@@ -200,16 +209,15 @@ public Resolution Resolution
         /// <summary>
         ///     The path that UWB engine will log to
         /// </summary>
-        /// <exception cref="UwbIsConnectedException"></exception>
-        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="UwbHasInitializedException">Thrown if value is attempted to be changed once UWB has already initialized</exception>
+        /// <exception cref="ArgumentNullException">Thrown is value provide is null</exception>
         public FileInfo LogPath
         {
             get => logPath;
             set
             {
-                if (IsConnected)
-                    throw new UwbIsConnectedException(
-                        "You cannot change the log path once the browser engine is connected");
+                if (HasInitialized)
+                    throw new UwbHasInitializedException("You cannot change the log path once UWB has initialized!");
 
                 logPath = value ?? throw new ArgumentNullException(nameof(value));
             }
@@ -224,20 +232,15 @@ public FileInfo LogPath
         /// <summary>
         ///     The path to the cache
         /// </summary>
-        /// <exception cref="UwbIsConnectedException"></exception>
-        /// <exception cref="ArgumentException"></exception>
-        /// <exception cref="ArgumentNullException"></exception>
+        /// <exception cref="UwbHasInitializedException">Thrown if value is attempted to be changed once UWB has already initialized</exception>
+        /// <exception cref="ArgumentNullException">Thrown is value provide is null</exception>
         public FileInfo CachePath
         {
             get => cachePath;
             set
             {
-                if (IsConnected)
-                    throw new UwbIsConnectedException(
-                        "You cannot change the cache path once the browser engine is connected");
-
-                if (!cache)
-                    throw new ArgumentException("The cache is disabled!");
+                if (HasInitialized)
+                    throw new UwbHasInitializedException("You cannot change the cache path once UWB has initialized!");
 
                 cachePath = value ?? throw new ArgumentNullException(nameof(value));
             }
@@ -334,7 +337,7 @@ internal void Init()
             argsBuilder.AppendArgument("background-color", WebBrowserUtils.ColorToHex(backgroundColor));
 
             //Logging
-            LogPath ??= new FileInfo($"{browserEngineMainDir}/{engine.GetEngineExecutableName()}.log");
+            LogPath ??= new FileInfo(Path.Combine(browserEngineMainDir, $"{Path.GetFileNameWithoutExtension(engine.GetEngineExecutableName())}.log"));
             argsBuilder.AppendArgument("log-path", LogPath.FullName, true);
             argsBuilder.AppendArgument("log-severity", logSeverity);
 
@@ -350,12 +353,11 @@ internal void Init()
             argsBuilder.AppendArgument("in-location", inLocation, true);
             argsBuilder.AppendArgument("out-location", outLocation, true);
 
-            //If we have a cache, set the cache path
-            if (cache)
-            {
-                cachePath ??= new FileInfo($"{browserEngineMainDir}/UWBCache");
-                argsBuilder.AppendArgument("cache-path", cachePath.FullName, true);
-            }
+            //Set cache path
+            cachePath ??= new FileInfo(Path.Combine(browserEngineMainDir, "UWBCache"));
+            argsBuilder.AppendArgument("cache-path", cachePath.FullName, true);
+            
+            argsBuilder.AppendArgument("incognito-mode", incognitoMode);
 
             //Popups
             argsBuilder.AppendArgument("popup-action", popupAction, true);
@@ -374,12 +376,15 @@ internal void Init()
             }
 
             //Setup proxy
-            argsBuilder.AppendArgument("proxy-server", proxySettings.ProxyServer);
-            if (!string.IsNullOrWhiteSpace(proxySettings.Username))
-                argsBuilder.AppendArgument("proxy-username", proxySettings.Username, true);
+            if (proxySettings.ProxyServer)
+            {
+                argsBuilder.AppendArgument("proxy-server", true);
+                if (!string.IsNullOrWhiteSpace(proxySettings.Username))
+                    argsBuilder.AppendArgument("proxy-username", proxySettings.Username, true);
 
-            if (!string.IsNullOrWhiteSpace(proxySettings.Password))
-                argsBuilder.AppendArgument("proxy-password", proxySettings.Password, true);
+                if (!string.IsNullOrWhiteSpace(proxySettings.Password))
+                    argsBuilder.AppendArgument("proxy-password", proxySettings.Password, true);
+            }
 
             //Make sure not to include this, its for testing
 #if UWB_ENGINE_PRJ //Define for backup, cause I am dumb as fuck and gonna accidentally include this in a release build one day 
diff --git a/src/Packages/UnityWebBrowser/Runtime/Helper/WebBrowserUtils.cs b/src/Packages/UnityWebBrowser/Runtime/Helper/WebBrowserUtils.cs
@@ -40,7 +40,7 @@ public static class WebBrowserUtils
         public static string GetAdditionFilesDirectory()
         {
 #if UNITY_EDITOR
-            return Path.GetFullPath($"{Directory.GetParent(Application.dataPath).FullName}/Library");
+            return Path.GetFullPath(Path.Combine(Directory.GetParent(Application.dataPath)!.FullName, "Library"));
 #elif UNITY_STANDALONE_OSX
             return Application.persistentDataPath;
 #else
diff --git a/src/Packages/UnityWebBrowser/Runtime/UwbHasInitializedException.cs b/src/Packages/UnityWebBrowser/Runtime/UwbHasInitializedException.cs
@@ -0,0 +1,20 @@
+﻿// UnityWebBrowser (UWB)
+// Copyright (c) 2021-2024 Voltstro-Studios
+// 
+// This project is under the MIT license.See the LICENSE.md file for more details.
+
+using System;
+
+namespace VoltstroStudios.UnityWebBrowser
+{
+    /// <summary>
+    ///     An <see cref="Exception"/> related to when trying to change something that cannot be changed when the
+    ///     UWB has already initalized
+    /// </summary>
+    public sealed class UwbHasInitializedException : Exception
+    {
+        internal UwbHasInitializedException(string message) : base(message)
+        {
+        }
+    }
+}
diff --git a/src/Packages/UnityWebBrowser/Runtime/UwbHasInitializedException.cs.meta b/src/Packages/UnityWebBrowser/Runtime/UwbHasInitializedException.cs.meta
diff --git a/src/Packages/UnityWebBrowser/package.json b/src/Packages/UnityWebBrowser/package.json
@@ -2,7 +2,7 @@
   "name": "dev.voltstro.unitywebbrowser",
   "displayName": "Unity Web Browser",
   "description": "Unity Web Browser (UWB) is a Unity package that allows displaying and interacting with the web from within Unity.",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "unity": "2021.3",
   "author": {
     "name": "Voltstro",
diff --git a/src/ThirdParty/CefGlue b/src/ThirdParty/CefGlue
@@ -1 +1 @@
-Subproject commit 8746fecdddba6a993f3e3c19401d487c99d33599
+Subproject commit 173a38fd3e4ccbd04f37e5791ec71a8b48c69b62
diff --git a/src/UnityWebBrowser.Engine.Cef/Main/Core/CefEngineControlsManager.cs b/src/UnityWebBrowser.Engine.Cef/Main/Core/CefEngineControlsManager.cs
@@ -118,10 +118,17 @@ public void EarlyInit(LaunchArguments arguments, string[] rawArguments)
     /// <exception cref="Exception"></exception>
     public void Init(ClientControlsActions clientControlsActions, EnginePopupManager popupManager)
     {
-        //Do we have a cache or not, if not CEF will run in "incognito" mode.
-        string cachePathArgument = null;
-        if (launchArguments.CachePath != null)
-            cachePathArgument = launchArguments.CachePath.FullName;
+        //Always need a cache path. Should usually be provided
+        string cachePath = launchArguments.CachePath?.FullName;
+        if (cachePath == null)
+        {
+            cachePath = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("N"));
+            mainLogger.LogWarning("No cache path was set. Using {TempPath} for cache.", cachePath);
+        }
+
+        //Log this as it handy to know
+        if (launchArguments.IncognitoMode)
+            mainLogger.LogInformation("Incognito mode is enabled. No profile-specific data will be persisted to disk.");
 
         //Convert UnityWebBrowser log severity to CefLogSeverity
         CefLogSeverity logSeverity = launchArguments.LogSeverity switch
@@ -159,13 +166,14 @@ public void Init(ClientControlsActions clientControlsActions, EnginePopupManager
             WindowlessRenderingEnabled = true,
             NoSandbox = launchArguments.NoSandbox,
             LogFile = launchArguments.LogPath.FullName,
-            CachePath = cachePathArgument,
+            CachePath = launchArguments.IncognitoMode ? null : Path.Combine(cachePath, "UserDefaultCache"),
+            RootCachePath = cachePath,
             MultiThreadedMessageLoop = false,
             LogSeverity = logSeverity,
             Locale = "en-US",
             ExternalMessagePump = false,
             RemoteDebuggingPort = launchArguments.RemoteDebugging,
-            PersistSessionCookies = true,
+            //PersistSessionCookies = true,
             //PersistUserPreferences = true,
             ResourcesDirPath = resourcesPath,
             LocalesDirPath = localesPath,
@@ -202,7 +210,7 @@ public void Init(ClientControlsActions clientControlsActions, EnginePopupManager
                      $"\nJS: {launchArguments.JavaScript}" +
                      $"\nLocal Storage: {launchArguments.LocalStorage}" +
                      $"\nBackgroundColor: {suppliedColor}" +
-                     $"\nCache Path: {cachePathArgument}" +
+                     $"\nCache Path: {cachePath}" +
                      $"\nPopup Action: {launchArguments.PopupAction}" +
                      $"\nLog Path: {launchArguments.LogPath.FullName}" +
                      $"\nLog Severity: {launchArguments.LogSeverity}");
diff --git a/src/UnityWebBrowser.Engine.Cef/Main/UnityWebBrowser.Engine.Cef.csproj b/src/UnityWebBrowser.Engine.Cef/Main/UnityWebBrowser.Engine.Cef.csproj
@@ -42,7 +42,6 @@
         <NativeLibrary Include="wbemuuid.lib" />
         <NativeLibrary Include="WindowsApp.lib" />
         <NativeLibrary Include="winmm.lib" />
-
         
         <NativeLibrary Include="comctl32.lib" />
         <NativeLibrary Include="gdi32.lib" />
diff --git a/src/UnityWebBrowser.Engine.Cef/Shared/UnityWebBrowser.Engine.Cef.Shared.csproj b/src/UnityWebBrowser.Engine.Cef/Shared/UnityWebBrowser.Engine.Cef.Shared.csproj
@@ -94,7 +94,7 @@
             <ExcludeFromSingleFile>true</ExcludeFromSingleFile>
         </ContentWithTargetPath>
 
-        <ContentWithTargetPath Include="..\..\ThirdParty\Libs\cef\linux64\Release\*.dat" Link="Libs/%(Filename)%(Extension)">
+        <ContentWithTargetPath Include="..\..\ThirdParty\Libs\cef\linux64\Resources\*.dat" Link="Libs/%(Filename)%(Extension)">
             <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
             <TargetPath>%(Filename)%(Extension)</TargetPath>
             <ExcludeFromSingleFile>true</ExcludeFromSingleFile>
diff --git a/src/UnityWebBrowser.Engine.Cef/version.json b/src/UnityWebBrowser.Engine.Cef/version.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "2.2.0-128.4.9",
+  "version": "2.2.1-129.0.11",
   "publicReleaseRefSpec": [
     "^refs/heads/master$"
   ],
diff --git a/src/UnityWebBrowser.Pages/package.json b/src/UnityWebBrowser.Pages/package.json
@@ -10,8 +10,8 @@
   },
   "devDependencies": {
     "@types/node": "^18.0.0",
-    "typescript": "^5.5.4",
-    "vite": "^5.4.6",
+    "typescript": "^5.6.2",
+    "vite": "^5.4.8",
     "vite-plugin-html": "^3.2.0",
     "vite-plugin-singlefile": "^2.0.2"
   }
diff --git a/src/UnityWebBrowser.Pages/yarn.lock b/src/UnityWebBrowser.Pages/yarn.lock
diff --git a/src/VoltstroStudios.UnityWebBrowser.Engine.Shared/Core/LaunchArguments.cs b/src/VoltstroStudios.UnityWebBrowser.Engine.Shared/Core/LaunchArguments.cs
diff --git a/src/VoltstroStudios.UnityWebBrowser.Engine.Shared/Core/LaunchArgumentsBinder.cs b/src/VoltstroStudios.UnityWebBrowser.Engine.Shared/Core/LaunchArgumentsBinder.cs
diff --git a/src/VoltstroStudios.UnityWebBrowser.Engine.Shared/Core/LaunchArgumentsParser.cs b/src/VoltstroStudios.UnityWebBrowser.Engine.Shared/Core/LaunchArgumentsParser.cs
diff --git a/src/VoltstroStudios.UnityWebBrowser.Engine.Shared/VoltstroStudios.UnityWebBrowser.Engine.Shared.csproj b/src/VoltstroStudios.UnityWebBrowser.Engine.Shared/VoltstroStudios.UnityWebBrowser.Engine.Shared.csproj
diff --git a/src/version.json b/src/version.json
