Merge branch 'release' into 'feature/PB-45984_Fix-webviews-synchronization-can-lead-to-black-screen'

# Conflicts:
#   passbolt/Models/Messaging/Webviews/BackgroundTopic.cs

Author: scadra

passbolt/Models/Messaging/Webviews/BackgroundTopic.cs

@@ -16,7 +16,7 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using passbolt.Exceptions;
-using passbolt.Models.Authentication;
+using passbolt.Models.Authentication;
 using passbolt.Models.Cookies;
 using passbolt.Models.CredentialLocker;
 using passbolt.Models.Messaging.Topics;
@@ -30,21 +30,21 @@
 using passbolt.Utils;
 using System;
 using System.Collections.Generic;
-using System.Threading.Tasks;
+using System.Threading.Tasks;
 using Windows.ApplicationModel.DataTransfer;
 
 namespace passbolt.Models.Messaging
 {
     public class BackgroundTopic : WebviewTopic
     {
         private CredentialLockerService credentialLockerService;
-        private string currentIndexBackground = "index-auth.html";
+        private string currentIndexBackground = "index-auth.html";
         private string currentIndexRendered = "index-auth.html";
         private string passphrase;
         private string pendingRequestId;
         private RbacService rbacService;
         private CookiesManager cookiesManager;
-        private List<IPC> pendingMessages;
+        private List<IPC> pendingMessages;
 
         public BackgroundTopic(WebView2 background, WebView2 rendered, LocalFolderService localFolderService, BackgroundWebviewService backgroundWebviewService) : base(background, rendered, localFolderService, backgroundWebviewService)
         {
@@ -67,67 +67,67 @@ public async override void ProceedMessage(IPC ipc)
             {
                 case AllowedTopics.BACKGROUND_READY:
                     //It means we have a single navigation of the Background webview
-                    if(this.pendingRequestId != null)
-                    {
-                        this.proceedPendingRequest();
-                    }
-                    else
-                    {
+                    if(this.pendingRequestId != null)
+                    {
+                        this.proceedPendingRequest();
+                    }
+                    else
+                    {
                         WebviewOrchestratorService.Instance.SetBackgroundStatus(true);
                         if(WebviewOrchestratorService.Instance.AreAllReady())
                         {
                             rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(AllowedTopics.BACKGROUND_READY)));
                             background.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(AllowedTopics.RENDERED_READY)));
-                        }
-                        if (passphrase != null)
-                        {
-                            background.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(AllowedTopics.BACKGROUND_STORE_PASSPHRASE, passphrase)));
+                        }
+                        if (passphrase != null)
+                        {
+                            background.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(AllowedTopics.BACKGROUND_STORE_PASSPHRASE, passphrase)));
                             rendered.Source = new Uri(UriBuilderHelper.BuildHostUri(RenderedNavigationService.Instance.trustedUrl, "/Rendered/index-workspace.html"));
-                            passphrase = null;
-                        }
-                    }
+                            passphrase = null;
+                        }
+                    }
                     break;
                 case AllowedTopics.BACKGROUND_GET_COOKIE:
                     string cookie = cookiesManager.getCookie((string)ipc.message);
                     var response = new IPC();
                     response.message = cookie;
                     response.status = "SUCCESS";
                     response.topic = ipc.requestId;
-                    background.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(response));
+                    background.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(response));
                     break;
                 case AllowedTopics.BACKGROUND_SET_THEME:
                     accountMetaData.theme = (string) ipc.message;
-                    await this.credentialLockerService.Create("account-metadata", JsonConvert.SerializeObject(accountMetaData));
+                    await this.credentialLockerService.Create("account-metadata", JsonConvert.SerializeObject(accountMetaData));
                     break;
                 case AllowedTopics.BACKGROUND_SET_LOCALE:
                     accountMetaData.locale = (string)ipc.message;
-                    await this.credentialLockerService.Create("account-metadata", JsonConvert.SerializeObject(accountMetaData));
+                    await this.credentialLockerService.Create("account-metadata", JsonConvert.SerializeObject(accountMetaData));
                     break;
                 case AllowedTopics.BACKGROUND_SET_SECURITY_TOKEN:
                     accountMetaData.securityToken = SerializationHelper.DeserializeFromJson<SecurityToken>(((JObject)ipc.message).ToString());
-                    await this.credentialLockerService.Create("account-metadata", JsonConvert.SerializeObject(accountMetaData));
+                    await this.credentialLockerService.Create("account-metadata", JsonConvert.SerializeObject(accountMetaData));
                     break;
                 case AllowedTopics.BACKGROUND_ROTATE_KEY:
                     var accountSecret = await this.credentialLockerService.GetAccountSecret();
                     accountSecret.userPrivateArmoredKey = (string)ipc.message;
                     await this.credentialLockerService.Create("account-secret", JsonConvert.SerializeObject(accountSecret));
-                    break;
-                case AuthenticationTopics.REQUIRE_MFA:
-                    var message = SerializationHelper.DeserializeFromJson<MfaAuthentication>(((JObject)ipc.message).ToString());
+                    break;
+                case AuthenticationTopics.REQUIRE_MFA:
+                    var message = SerializationHelper.DeserializeFromJson<MfaAuthentication>(((JObject)ipc.message).ToString());
                     passphrase = message.passphrase;
 
                     // Allow navigation for MFA authentication
                     RenderedNavigationService.Instance.AllowMfaUrls(accountMetaData.domain);
-                    rendered.Source = new Uri(accountMetaData.domain + $"/mfa/verify/{message.provider}?redirect=/");
+                    rendered.Source = new Uri(accountMetaData.domain + $"/mfa/verify/{message.provider}?redirect=/");
                     break;
                 case AuthImportTopics.SAVE_ACCOUNT:
-                    this.currentIndexBackground = "index-auth.html";
-                    this.currentIndexRendered = "index-import.html";
-                    pendingRequestId = SerializationHelper.DeserializeFromJson<RequestId>(((JObject)ipc.message).ToString()).requestId;
+                    this.currentIndexBackground = "index-auth.html";
+                    this.currentIndexRendered = "index-import.html";
+                    pendingRequestId = SerializationHelper.DeserializeFromJson<RequestId>(((JObject)ipc.message).ToString()).requestId;
                     var metaData = SerializationHelper.DeserializeFromJson<AccountMetaData>(((JObject)ipc.message).ToString());
                     var secrets = SerializationHelper.DeserializeFromJson<AccountSecret>(((JObject)ipc.message).ToString());
                     await this.credentialLockerService.CreateAccount(metaData, secrets);
-                    //We remove previous virtualhost and create a new one based on trusted domain
+                    //We remove previous virtualhost and create a new one based on trusted domain
                     var backgroundUrl = await this.webviewService.SetVirtualHost();
                     await localFolderService.CreateBackgroundIndex(this.currentIndexBackground, "background-auth", metaData.domain);
                     background.Source = new Uri(UriBuilderHelper.BuildHostUri(backgroundUrl, "/index-auth.html"));
@@ -148,26 +148,32 @@ public async override void ProceedMessage(IPC ipc)
                     await downloadService.Download(ipc);
                     break;
                 case LocalStorageTopics.BACKGROUND_LOCALSTORAGE_UPDATE:
-                    this.canProceedMessage(ipc);
-                    rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(LocalStorageTopics.RENDERED_LOCALSTORAGE_UPDATE, SerializationHelper.SerializeToJson(ipc.message))));
+                    if(this.canProceedMessage(ipc))
+                    {
+                        rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(LocalStorageTopics.RENDERED_LOCALSTORAGE_UPDATE, SerializationHelper.SerializeToJson(ipc.message))));
+                    }
                     break;
                 case LocalStorageTopics.BACKGROUND_LOCALSTORAGE_DELETE:
-                    this.canProceedMessage(ipc);
-                    rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(LocalStorageTopics.RENDERED_LOCALSTORAGE_DELETE, (string)ipc.message)));
+                    if (this.canProceedMessage(ipc))
+                    {
+                        rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(LocalStorageTopics.RENDERED_LOCALSTORAGE_DELETE, (string)ipc.message)));
+                    }
                     break;
                 case LocalStorageTopics.BACKGROUND_LOCALSTORAGE_CLEAR:
-                    this.canProceedMessage(ipc);
-                    rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(LocalStorageTopics.RENDERED_LOCALSTORAGE_CLEAR)));
+                    if (this.canProceedMessage(ipc))
+                    {
+                        rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(new IPC(LocalStorageTopics.RENDERED_LOCALSTORAGE_CLEAR)));
+                    }
                     break;
                 case AuthenticationTopics.LOG_OUT:
-                    this.currentIndexBackground = "index-auth.html";
-                    this.currentIndexRendered = "index-auth.html";
+                    this.currentIndexBackground = "index-auth.html";
+                    this.currentIndexRendered = "index-auth.html";
                     await localFolderService.RemoveFile("Rendered", "index-workspace.html");
                     await localFolderService.RemoveFile("Background", "index-workspace.html");
-                    await localFolderService.CreateRenderedIndex(this.currentIndexRendered, "rendered-auth", "ext_authentication.min.css", accountMetaData.domain);
-                    await localFolderService.CreateBackgroundIndex(this.currentIndexBackground, "background-auth", accountMetaData.domain);
-                    background.Source = new Uri(UriBuilderHelper.BuildHostUri(BackgroundNavigationService.Instance.trustedUrl, "/Background/index-auth.html"));
-                    rendered.Source = new Uri(UriBuilderHelper.BuildHostUri(RenderedNavigationService.Instance.trustedUrl, "/Rendered/index-auth.html"));
+                    await localFolderService.CreateRenderedIndex(this.currentIndexRendered, "rendered-auth", "ext_authentication.min.css", accountMetaData.domain);
+                    await localFolderService.CreateBackgroundIndex(this.currentIndexBackground, "background-auth", accountMetaData.domain);
+                    background.Source = new Uri(UriBuilderHelper.BuildHostUri(BackgroundNavigationService.Instance.trustedUrl, "/Background/index-auth.html"));
+                    rendered.Source = new Uri(UriBuilderHelper.BuildHostUri(RenderedNavigationService.Instance.trustedUrl, "/Rendered/index-auth.html"));
                     break;
                 case AuthenticationTopics.AFTER_LOGIN:
                     passphrase = (string)ipc.message;
@@ -184,8 +190,10 @@ public async override void ProceedMessage(IPC ipc)
                     {
                         AllowedTopics.AddRequestId(ipc.requestId);
                     }
-                    this.canProceedMessage(ipc);
-                    rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(ipc));
+                    if (this.canProceedMessage(ipc))
+                    {
+                        rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(ipc));
+                    }
                     break;
                 case AllowedTopics.BACKGROUND_CLIPBOARD_SET_TEXT:
                     DataPackage dataPackage = new DataPackage();
@@ -202,85 +210,88 @@ public async override void ProceedMessage(IPC ipc)
                         this.mapResponse(ipc, value);
                         AllowedTopics.RemovePendingRequest(ipc.topic);
                     }
-                    this.canProceedMessage(ipc);
                     rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(ipc));
+
                     break;
             }
-        }
-
-        /// <summary>
-        /// Create folder for workspace and redirect user to workspace
-        /// </summary>
+        }
+
+        /// <summary>
+        /// Create folder for workspace and redirect user to workspace
+        /// </summary>
         /// <param name="accountMeta"></param>
-        public async Task RedirectToWorkspace()
-        {
+        public async Task RedirectToWorkspace()
+        {
             var accountMetaData = await this.credentialLockerService.GetAccountMetadata();
-
-            await localFolderService.RemoveFile("Rendered", this.currentIndexRendered);
-            await localFolderService.RemoveFile("Background", this.currentIndexBackground);
-            await localFolderService.CreateRenderedIndex("index-workspace.html", "rendered-workspace", "ext_app.min.css", accountMetaData.domain);
+
+            await localFolderService.RemoveFile("Rendered", this.currentIndexRendered);
+            await localFolderService.RemoveFile("Background", this.currentIndexBackground);
+            await localFolderService.CreateRenderedIndex("index-workspace.html", "rendered-workspace", "ext_app.min.css", accountMetaData.domain);
             await localFolderService.CreateBackgroundIndex("index-workspace.html", "background-workspace", accountMetaData.domain);
-            var configuration = await credentialLockerService.GetApplicationConfiguration();
-            background.Source = new Uri(UriBuilderHelper.BuildHostUri(configuration.backgroundUrl, "/Background/index-workspace.html"));
+            var configuration = await credentialLockerService.GetApplicationConfiguration();
+            background.Source = new Uri(UriBuilderHelper.BuildHostUri(configuration.backgroundUrl, "/Background/index-workspace.html"));
         }
 
-        /// <summary>
-        /// Process all pending messages when Rendered webview becomes ready
-        /// </summary>
-        public void ProcessPendingMessages()
-        {
-            if (pendingMessages.Count > 0)
-            {
-                var messages = new List<IPC>(pendingMessages);
+        /// <summary>
+        /// Process all pending messages when Rendered webview becomes ready
+        /// </summary>
+        public void ProcessPendingMessages()
+        {
+            if (pendingMessages.Count > 0)
+            {
+                var messages = new List<IPC>(pendingMessages);
 
-                foreach (var message in messages)
-                {
-                    ProceedMessage(message);
+                foreach (var message in messages)
+                {
+                    ProceedMessage(message);
                 }
 
-                pendingMessages.Clear();
-            }
+                pendingMessages.Clear();
+            }
         }
 
-        /// <summary>
-        /// Proceed a pending request Id
+        /// <summary>
+        /// Proceed a pending request Id
         /// </summary>
-        public void proceedPendingRequest()
-        {
-            AllowedTopics.proceedRequestId(this.pendingRequestId);
-            var icpMessage = new IPC();
-            icpMessage.status = "SUCCESS";
-            icpMessage.topic = this.pendingRequestId;
-            rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(icpMessage));
-            this.pendingRequestId = null;
+        public void proceedPendingRequest()
+        {
+            AllowedTopics.proceedRequestId(this.pendingRequestId);
+            var icpMessage = new IPC();
+            icpMessage.status = "SUCCESS";
+            icpMessage.topic = this.pendingRequestId;
+            rendered.CoreWebView2.PostWebMessageAsJson(SerializationHelper.SerializeToJson(icpMessage));
+            this.pendingRequestId = null;
         }
 
-        /// <summary>
-        /// Map the response from the background webview
-        /// </summary>
-        /// <param name="ipc"></param>
-        /// <returns></returns>
-        public void mapResponse(IPC ipc, string topic)
-        {
-            if (topic == RbacTopics.FIND_ME)
+        /// <summary>
+        /// Map the response from the background webview
+        /// </summary>
+        /// <param name="ipc"></param>
+        /// <returns></returns>
+        public void mapResponse(IPC ipc, string topic)
+        {
+            if (topic == RbacTopics.FIND_ME)
             {
                 var controls = SerializationHelper.DeserializeFromJson<List<ControlFunction>>(((JArray)ipc.message).ToString());
                 this.rbacService.AddDesktopRbac(controls);
-                ipc.message = controls;
-            }
+                ipc.message = controls;
+            }
         }
 
         /// <summary>
         /// Check if the rendered webview is listening and if not we add the ipc message as pending
         /// This method should be added before calling each topic calling the rendered webview
         /// </summary>
         /// <param name="ipc"></param>
-        private void canProceedMessage(IPC ipc)
+        /// <returns bool></returns>
+        private bool canProceedMessage(IPC ipc)
         {
-            if (!WebviewOrchestratorService.Instance.IsRenderedReady() && ipc.topic != AllowedTopics.BACKGROUND_READY)
-            {
+            if (!WebviewOrchestratorService.Instance.IsRenderedReady() && ipc.topic != AllowedTopics.BACKGROUND_READY)
+            {
                 pendingMessages.Add(ipc);
             }
+
+            return true;
         }
     }
 }