[WIP] async code and dispose in tests

src/DocumentationBrowserViewExtension/DocumentationBrowserView.xaml.cs

@@ -2,6 +2,7 @@
 using System.Diagnostics;
 using System.IO;
 using System.Reflection;
+using System.Threading.Tasks;
 using System.Web;
 using System.Windows;
 using System.Windows.Controls;
@@ -21,7 +22,8 @@ public partial class DocumentationBrowserView : UserControl, IDisposable
         private readonly DocumentationBrowserViewModel viewModel;
         private const string VIRTUAL_FOLDER_MAPPING = "appassets";
         static readonly string HTML_IMAGE_PATH_PREFIX = @"http://";
-        private bool hasBeenInitialized;
+        private Task hasBeenInitialized;
+        private bool isDisposing;
         private ScriptingObject comScriptingObject;
         private string fontStylePath = "Dynamo.Wpf.Views.GuidedTour.HtmlPages.Resources.ArtifaktElement-Regular.woff";
 
@@ -104,32 +106,30 @@ private void ShouldAllowNavigation(object sender, CoreWebView2NavigationStarting
         /// <param name="link"></param>
         public void NavigateToPage(Uri link)
         {
-            InitializeAsync();
+            Dispatcher.BeginInvoke(InitializeAsync);
         }
 
         protected virtual void Dispose(bool disposing)
         {
             // Cleanup
             this.viewModel.LinkChanged -= NavigateToPage;
-            this.documentationBrowser.NavigationStarting -= ShouldAllowNavigation;
-            this.documentationBrowser.DpiChanged -= DocumentationBrowser_DpiChanged;
-
-            if (this.documentationBrowser.CoreWebView2 != null)
+            if (this.documentationBrowser != null)
             {
-                this.documentationBrowser.CoreWebView2.WebMessageReceived -= CoreWebView2OnWebMessageReceived;
-            }
+                this.documentationBrowser.NavigationStarting -= ShouldAllowNavigation;
+                this.documentationBrowser.DpiChanged -= DocumentationBrowser_DpiChanged;
 
-            // Note to test writers
-            // Disposing the document browser will cause future tests
-            // that uses the Browser component to crash
-            if (!Models.DynamoModel.IsTestMode)
-            {
+                if (this.documentationBrowser.CoreWebView2 != null)
+                {
+                    this.documentationBrowser.CoreWebView2.WebMessageReceived -= CoreWebView2OnWebMessageReceived;
+                }
                 this.documentationBrowser.Dispose();
             }
         }
 
         async void InitializeAsync()
         {
+            if (isDisposing) return;
+
             VirtualFolderPath = string.Empty;
             try
             {
@@ -159,7 +159,7 @@ async void InitializeAsync()
             }
 
             // Only initialize once 
-            if (!hasBeenInitialized)
+            if (hasBeenInitialized == null)
             {
                 if (!string.IsNullOrEmpty(WebBrowserUserDataFolder))
                 {
@@ -170,32 +170,30 @@ async void InitializeAsync()
                     };
                 }
                 //Initialize the CoreWebView2 component otherwise we can't navigate to a web page
-                await documentationBrowser.EnsureCoreWebView2Async();
-
-
-                this.documentationBrowser.CoreWebView2.WebMessageReceived += CoreWebView2OnWebMessageReceived;
-                comScriptingObject = new ScriptingObject(this.viewModel);
-                //register the interop object into the browser.
-                this.documentationBrowser.CoreWebView2.AddHostObjectToScript("bridge", comScriptingObject);
-
-                this.documentationBrowser.CoreWebView2.Settings.IsZoomControlEnabled = true;
-                this.documentationBrowser.CoreWebView2.Settings.AreDevToolsEnabled = true;
-
-                hasBeenInitialized = true;
+                hasBeenInitialized = documentationBrowser.EnsureCoreWebView2Async().ContinueWith((_) => {
+                    if (isDisposing) return;
+
+                    this.documentationBrowser.CoreWebView2.WebMessageReceived += CoreWebView2OnWebMessageReceived;
+                    comScriptingObject = new ScriptingObject(this.viewModel);
+                    //register the interop object into the browser.
+                    this.documentationBrowser.CoreWebView2.AddHostObjectToScript("bridge", comScriptingObject);
+
+                    this.documentationBrowser.CoreWebView2.Settings.IsZoomControlEnabled = true;
+                    this.documentationBrowser.CoreWebView2.Settings.AreDevToolsEnabled = true;
+                }, TaskScheduler.FromCurrentSynchronizationContext());
             }
+            await hasBeenInitialized;
+            if (isDisposing) return;
 
-            if(Directory.Exists(VirtualFolderPath))
+            if (Directory.Exists(VirtualFolderPath))
                 //Due that the Web Browser(WebView2 - Chromium) security CORS is blocking the load of resources like images then we need to create a virtual folder in which the image are located.
                 this.documentationBrowser.CoreWebView2.SetVirtualHostNameToFolderMapping(VIRTUAL_FOLDER_MAPPING, VirtualFolderPath, CoreWebView2HostResourceAccessKind.DenyCors);
 
             string htmlContent = this.viewModel.GetContent();
 
             htmlContent = ResourceUtilities.LoadResourceAndReplaceByKey(htmlContent, "#fontStyle", fontStylePath);
 
-            Dispatcher.BeginInvoke(new Action(() =>
-            {
-                this.documentationBrowser.NavigateToString(htmlContent);
-            }));
+            this.documentationBrowser.NavigateToString(htmlContent);
         }
 
         private void CoreWebView2OnWebMessageReceived(object sender, CoreWebView2WebMessageReceivedEventArgs e)
@@ -207,8 +205,17 @@ private void CoreWebView2OnWebMessageReceived(object sender, CoreWebView2WebMess
         /// <summary>
         /// Dispose function for DocumentationBrowser
         /// </summary>
-        public void Dispose()
+        public async void Dispose()
         {
+            isDisposing = true;
+            if (Models.DynamoModel.IsTestMode && hasBeenInitialized != null)
+            {
+                GC.SuppressFinalize(this);
+                await hasBeenInitialized;
+                Dispose(true);
+                return;
+            }
+
             Dispose(true);
             GC.SuppressFinalize(this);
         }

src/DocumentationBrowserViewExtension/DocumentationBrowserViewExtension.cs

@@ -178,7 +178,7 @@ public override void Loaded(ViewLoadedParams viewLoadedParams)
 
         public override void Shutdown()
         {
-            Dispose();
+            // Do nothing for now 
         }
 
         private void OnInsertFile(object sender, InsertDocumentationLinkEventArgs e)

src/DynamoUtilities/CLIWrapper.cs

@@ -97,7 +97,7 @@ protected static string GetToolPath(string relativePath)
         /// </summary>
         /// <param name="timeoutms">will return empty string if we don't finish reading all data in the timeout provided in milliseconds.</param>
         /// <returns></returns>
-        protected virtual async Task<string> GetData(int timeoutms)
+        protected virtual string GetData(int timeoutms)
         {
             var readStdOutTask = Task.Run(() =>
             {
@@ -145,7 +145,8 @@ protected virtual async Task<string> GetData(int timeoutms)
                     return writer.ToString();
                 }
             });
-            var completedTask = await Task.WhenAny(readStdOutTask, Task.Delay(TimeSpan.FromMilliseconds(timeoutms)));
+
+            var completedTask = Task.WhenAny(readStdOutTask, Task.Delay(TimeSpan.FromMilliseconds(timeoutms))).Result;
             //if the completed task was our read std out task, then return the data
             //else we timed out, so return an empty string.
             return completedTask == readStdOutTask ? readStdOutTask.Result : string.Empty;

src/DynamoUtilities/DynamoFeatureFlagsManager.cs

@@ -64,7 +64,7 @@ internal void CacheAllFlags()
         {
 
             //wait for response
-            var dataFromCLI = GetData(featureFlagTimeoutMs).Result;    
+            var dataFromCLI = GetData(featureFlagTimeoutMs);    
             //convert from json string to dictionary.
             try
             {

src/DynamoUtilities/Md2Html.cs

@@ -73,9 +73,7 @@ internal string ParseMd2Html(string mdString, string mdPath)
                 return GetCantCommunicateErrorMessage();
             }
 
-            var output = GetData(processCommunicationTimeoutms);
-
-            return output.Result;
+            return GetData(processCommunicationTimeoutms);
         }
 
         /// <summary>
@@ -104,7 +102,7 @@ internal string SanitizeHtml(string content)
 
             var output = GetData(processCommunicationTimeoutms);
 
-           return output.Result;
+           return output;
         }
 
         /// <summary>

src/LibraryViewExtensionWebView2/LibraryViewController.cs

@@ -18,6 +18,7 @@
 using Dynamo.Models;
 using Dynamo.Search;
 using Dynamo.Search.SearchElements;
+using Dynamo.Utilities;
 using Dynamo.ViewModels;
 using Dynamo.Wpf.Interfaces;
 using Dynamo.Wpf.UI.GuidedTour;
@@ -73,6 +74,8 @@ public class LibraryViewController : IDisposable
         private ICommandExecutive commandExecutive;
         private DynamoViewModel dynamoViewModel;
         private FloatingLibraryTooltipPopup libraryViewTooltip;
+        private Task isInitialized;
+        bool isDisposing;
         // private ResourceHandlerFactory resourceFactory;
         private IDisposable observer;
         internal WebView2 browser;
@@ -319,9 +322,6 @@ internal void AddLibraryView()
             browser.Loaded += Browser_Loaded;
             browser.SizeChanged += Browser_SizeChanged;
 
-            this.browser = view.mainGrid.Children.OfType<WebView2>().FirstOrDefault();
-            InitializeAsync();
-
             LibraryViewController.SetupSearchModelEventsObserver(browser, dynamoViewModel.Model.SearchModel,
                     this, this.customization);
         }
@@ -350,12 +350,19 @@ async void InitializeAsync()
                 };
             }
 
-            await browser.EnsureCoreWebView2Async();
-            this.browser.CoreWebView2.WebMessageReceived += CoreWebView2_WebMessageReceived;
-            twoWayScriptingObject = new ScriptingObject(this);
-            //register the interop object into the browser.
-            this.browser.CoreWebView2.AddHostObjectToScript("bridgeTwoWay", twoWayScriptingObject);
-            browser.CoreWebView2.Settings.IsZoomControlEnabled = true;
+            isInitialized = browser.EnsureCoreWebView2Async().ContinueWith((_) =>
+            {
+                if (isDisposing) return;
+
+                this.browser.CoreWebView2.WebMessageReceived += CoreWebView2_WebMessageReceived;
+                twoWayScriptingObject = new ScriptingObject(this);
+                //register the interop object into the browser.
+                this.browser.CoreWebView2.AddHostObjectToScript("bridgeTwoWay", twoWayScriptingObject);
+                browser.CoreWebView2.Settings.IsZoomControlEnabled = true;
+            }, TaskScheduler.FromCurrentSynchronizationContext());
+            await isInitialized;
+
+            if (isDisposing) return;
         }
 
         private void CoreWebView2_WebMessageReceived(object sender, CoreWebView2WebMessageReceivedEventArgs args)
@@ -422,6 +429,11 @@ private void Browser_Loaded(object sender, RoutedEventArgs e)
         {
             string msg = "Browser Loaded";
             LogToDynamoConsole(msg);
+
+            if (!isDisposing)
+            {
+                InitializeAsync();
+            }
         }
 
         // This enum is for matching the modifier keys between C# and javaScript
@@ -712,8 +724,18 @@ internal void LogToDynamoConsole(string message)
             this.dynamoViewModel.Model.Logger.Log(message);
         }
 
-        public void Dispose()
+        public async void Dispose()
         {
+            isDisposing = true;
+
+            if (Models.DynamoModel.IsTestMode && isInitialized != null)
+            {
+                GC.SuppressFinalize(this);
+                await isInitialized;
+                Dispose(true);
+                return;
+            }
+
             Dispose(true);
             GC.SuppressFinalize(this);
         }