Dyn 5106 webview2 documentation browser (#13212)

RobertGlobant20 · QilongTang · web-flow · commit 2686b5d35d15 · 2022-08-15T22:45:02.000-07:00
* DYN-5106-WebView2-DocumentationBrowser

I replaced the WebBrowser component by WebView2 in the file DocumentationBrowserView.xaml, also I added some functions for initializing WebView2,
The method ShouldAllowNavigation was modified due that WebView2 doesn't have the Navigating event and also the event handler receive different parameters then modified the function to implement the same behavior than the previous one.
Also I noticed that WebView2 CORS was blocking to load the jpg images that are shown for several nodes, then I had to create a mapped virtual directory in this way the html will be able to load the images and show them in the web page.
Finally I removed a tag in all the html that was making the web page compatible for IE based browsers (due that now we are using WebView2 a Chromium based browser).

* DYN-5106-WebView2-DocumentationBrowser Code Review

Due that the fallback_doc directory path can change depending if Dynamo is executed as Sandbox or if is over Revit then the path can be different so I added a code that will create the virtual directory depending of the correct fallback_doc directory path.
Also I modified the Md2Html class so now it will be inserting in the image source (&lt;img src) the prefix "https://appassets" so it can be loaded from a virtual directory created by the DocumentationBrowser.

* DYN-5106-WebView2-DocumentationBrowser Code Review

- changing the visibility for the property FallbackDirectoryName
- renaming coreDir by docsDir

* DYN-5106-WebView2-DocumentationBrowser Code Review

Fixing CanCreateNodeDocumenationHtmlFromNodeAnnotationEventArgsWithPackageNodeWithAddtionalDocumentation test due that it was using and old format of the html &lt;img&gt; tab, then I updated the image to use the virtual folder and http.

Co-authored-by: Aaron (Qilong) &lt;173288704@qq.com&gt;
diff --git a/src/DocumentationBrowserViewExtension/Docs/ArgumentNullException.html b/src/DocumentationBrowserViewExtension/Docs/ArgumentNullException.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/CustomNodeNotLoaded.html b/src/DocumentationBrowserViewExtension/Docs/CustomNodeNotLoaded.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/Deprecated.html b/src/DocumentationBrowserViewExtension/Docs/Deprecated.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/DereferencingNonPointer.html b/src/DocumentationBrowserViewExtension/Docs/DereferencingNonPointer.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/ErrorPageTemplate.html b/src/DocumentationBrowserViewExtension/Docs/ErrorPageTemplate.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/ExcelNotInstalled.html b/src/DocumentationBrowserViewExtension/Docs/ExcelNotInstalled.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/FailedToCastFromNull.html b/src/DocumentationBrowserViewExtension/Docs/FailedToCastFromNull.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/FileNotFound.html b/src/DocumentationBrowserViewExtension/Docs/FileNotFound.html
@@ -1,8 +1,8 @@
 ﻿<!DOCTYPE html>
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/IntegerOverflow.html b/src/DocumentationBrowserViewExtension/Docs/IntegerOverflow.html
@@ -1,6 +1,6 @@
-﻿<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+﻿
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/InternalError.html b/src/DocumentationBrowserViewExtension/Docs/InternalError.html
@@ -1,8 +1,8 @@
 ﻿<!DOCTYPE html>
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+  
   <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/InvalidArrayIndexType.html b/src/DocumentationBrowserViewExtension/Docs/InvalidArrayIndexType.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/InvalidKeysLenghtErrorMessage.html b/src/DocumentationBrowserViewExtension/Docs/InvalidKeysLenghtErrorMessage.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/MarkdownStyling.html b/src/DocumentationBrowserViewExtension/Docs/MarkdownStyling.html
@@ -1,6 +1,6 @@
-﻿<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+﻿
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <style>
diff --git a/src/DocumentationBrowserViewExtension/Docs/MessageErrorOpeningFileGeneral.html b/src/DocumentationBrowserViewExtension/Docs/MessageErrorOpeningFileGeneral.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/MessageFailedToOpenCorruptedFile.html b/src/DocumentationBrowserViewExtension/Docs/MessageFailedToOpenCorruptedFile.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/NoContent.html b/src/DocumentationBrowserViewExtension/Docs/NoContent.html
@@ -1,8 +1,8 @@
 <!DOCTYPE html>
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+  
   <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/NonOverloadMethodResolutionError.html b/src/DocumentationBrowserViewExtension/Docs/NonOverloadMethodResolutionError.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/NothingIsSelectedWarning.html b/src/DocumentationBrowserViewExtension/Docs/NothingIsSelectedWarning.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/OperationFailType1.html b/src/DocumentationBrowserViewExtension/Docs/OperationFailType1.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/RunCompletedWithWarningsMessage.html b/src/DocumentationBrowserViewExtension/Docs/RunCompletedWithWarningsMessage.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/UnhandledException.html b/src/DocumentationBrowserViewExtension/Docs/UnhandledException.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/UnhandledExceptionInDynamoEngine.html b/src/DocumentationBrowserViewExtension/Docs/UnhandledExceptionInDynamoEngine.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/errorLibGCoreCannotMakePolycurveFromEmptyList.html b/src/DocumentationBrowserViewExtension/Docs/errorLibGCoreCannotMakePolycurveFromEmptyList.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/errorLibGCorePolycurveBranching.html b/src/DocumentationBrowserViewExtension/Docs/errorLibGCorePolycurveBranching.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/errorLibGCorePolycurveMoreThanOneWIRE.html b/src/DocumentationBrowserViewExtension/Docs/errorLibGCorePolycurveMoreThanOneWIRE.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/errorLibGCoreUnableToLoft.html b/src/DocumentationBrowserViewExtension/Docs/errorLibGCoreUnableToLoft.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/errorLibGCoreUnableUpdateSolidBySweep.html b/src/DocumentationBrowserViewExtension/Docs/errorLibGCoreUnableUpdateSolidBySweep.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/kArrayOverIndexed.html b/src/DocumentationBrowserViewExtension/Docs/kArrayOverIndexed.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/kConvertArrayToNonArray.html b/src/DocumentationBrowserViewExtension/Docs/kConvertArrayToNonArray.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/kCyclicDependency.html b/src/DocumentationBrowserViewExtension/Docs/kCyclicDependency.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/kIndexOutOfRange.html b/src/DocumentationBrowserViewExtension/Docs/kIndexOutOfRange.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/kMethodHasInvalidArguments.html b/src/DocumentationBrowserViewExtension/Docs/kMethodHasInvalidArguments.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/kMethodNotFound.html b/src/DocumentationBrowserViewExtension/Docs/kMethodNotFound.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/kMultipleSymbolFound.html b/src/DocumentationBrowserViewExtension/Docs/kMultipleSymbolFound.html
@@ -10,9 +10,9 @@
     Dynamo Dictionary: https://github.com/DynamoDS/DynamoDictionary_React
 -->
 
-<!-- These headers are required to force the browser embedded in the DocumentationBrowser extension to render in modern IE11 mode. -->
+
 <head>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    
     <meta charset="UTF-8" />
 </head>
 
diff --git a/src/DocumentationBrowserViewExtension/Docs/kPropertyOfClassNotFound.html b/src/DocumentationBrowserViewExtension/Docs/kPropertyOfClassNotFound.html
diff --git a/src/DocumentationBrowserViewExtension/DocumentationBrowserView.xaml b/src/DocumentationBrowserViewExtension/DocumentationBrowserView.xaml
diff --git a/src/DocumentationBrowserViewExtension/DocumentationBrowserView.xaml.cs b/src/DocumentationBrowserViewExtension/DocumentationBrowserView.xaml.cs
diff --git a/src/DocumentationBrowserViewExtension/DocumentationBrowserViewExtension.cs b/src/DocumentationBrowserViewExtension/DocumentationBrowserViewExtension.cs
diff --git a/src/DocumentationBrowserViewExtension/DocumentationBrowserViewExtension.csproj b/src/DocumentationBrowserViewExtension/DocumentationBrowserViewExtension.csproj
diff --git a/src/Tools/Md2Html/Md2Html.cs b/src/Tools/Md2Html/Md2Html.cs
diff --git a/test/DynamoCoreWpfTests/ViewExtensions/DocumentationBrowserViewExtensionTests.cs b/test/DynamoCoreWpfTests/ViewExtensions/DocumentationBrowserViewExtensionTests.cs
