Merge pull request #3213 from MicrosoftEdge/MultipleFile_Delete

Multiple file API: `Profile.Delete`

Author: yunate

specs/MultiProfile.md

@@ -169,20 +169,50 @@ void ScenarioCookieManagement::DeleteAllCookies()
 ### Delete profile
 
 ```cpp
-HRESULT AppWindow::DeleteProfile(ICoreWebView2Controller* controller)
+HRESULT AppWindow::DeleteProfile(ICoreWebView2* webView2)
 {
-    wil::com_ptr<ICoreWebView2> coreWebView2;
-    CHECK_FAILURE(controller->get_CoreWebView2(&coreWebView2));
-    auto webview7 = coreWebView2.try_query<ICoreWebView2_7>();
-    if (webview7)
+    auto webview13 = wil::try_com_query<ICoreWebView2_13>(webview2);
+    if (webview13)
     {
         wil::com_ptr<ICoreWebView2Profile> profile;
-        CHECK_FAILURE(webview7->get_Profile(&profile));
-        auto profile2 = profile.try_query<ICoreWebView2StagingProfile4>();
-        if (profile2)
-        {
-            CHECK_FAILURE(profile2->Delete());
-        }
+        CHECK_FAILURE(webview13->get_Profile(&profile));
+        CHECK_FAILURE(profile->Delete());
+    }
+}
+
+void AppWindow::RegisterProfileDeletedEventHandlers(ICoreWebView2* webView2)
+{
+    wil::com_ptr<ICoreWebView2Profile> profile;
+    CHECK_FAILURE(webView2->get_Profile(&profile));
+    CHECK_FAILURE(profile->add_Deleted(
+        Microsoft::WRL::Callback<ICoreWebView2StagingProfileDeletedEventHandler>(
+            [this](ICoreWebView2Profile* sender, IUnknown* args)
+            {
+                RunAsync(
+                    [this]()
+                    {
+                        std::wstring message = L"The profile has been marked"
+                        "for deletion. Any associated webview2 objects has"
+                        " been closed.";
+                        MessageBox(
+                            m_mainWindow, message.c_str(), L"webview2 closed",
+                            MB_OK);
+                        CloseAppWindow();
+                    });
+                return S_OK;
+            }).Get(), nullptr));
+}
+
+HRESULT AppWindow::OnCreateCoreWebView2ControllerCompleted(
+    HRESULT result, ICoreWebView2Controller* controller)
+{
+    if (result == HRESULT_FROM_WIN32(ERROR_DELETE_PENDING))
+    {
+        ShowFailure(
+            result, L"Failed to create webview, because the profile's name has "
+            "been marked as deleted, please use a different profile's name");
+        m_webviewOption.PopupDialog(this);
+        CloseAppWindow();
     }
 }
 ```
@@ -249,13 +279,40 @@ void DeleteAllCookies()
 ```
 
 ```csharp
-public DeleteProfile(CoreWebView2Controller controller)
+public DeleteProfile(CoreWebView2 coreWebView2)
 {
-    // Get the profile object.
-    CoreWebView2Profile profile = controller.CoreWebView2.Profile;
-    
     // Delete current profile.
-    profile.Delete();
+    CoreWebView2.Profile.Delete();
+}
+
+void WebView_CoreWebView2InitializationCompleted(object sender, CoreWebView2InitializationCompletedEventArgs e)
+{
+    WebViewProfile.Deleted += WebViewProfile_Deleted;
+
+    // ...
+    // ERROR_DELETE_PENDING(0x8007012f)
+    if (e.InitializationException.HResult == -2147024593)
+    {
+        MessageBox.Show($"Failed to create webview, because the profile's name has been marked as deleted, please use a different profile's name.");
+        var dialog = new NewWindowOptionsDialog();
+        dialog.CreationProperties = webView.CreationProperties;
+        if (dialog.ShowDialog())
+        {
+            new MainWindow(dialog.CreationProperties).Show();
+        }
+        Close();
+        return;
+    }
+}
+
+private void WebViewProfile_Deleted(object sender, object e)
+{
+    this.Dispatcher.InvokeAsync(() =>
+    {
+        String message = "The profile has been marked for deletion. Any associated webview2 objects will be closed.";
+        MessageBox.Show(message);
+        Close();
+    });
 }
 ```
 
@@ -270,6 +327,8 @@ interface ICoreWebView2_7;
 interface ICoreWebView2Profile;
 interface ICoreWebView2Profile2;
 interface ICoreWebView2Profile3;
+interface ICoreWebView2StagingProfile7;
+interface ICoreWebView2StagingProfileDeletedEventHandler;
 
 /// This interface is used to manage profile options that created by 'CreateCoreWebView2ControllerOptions'.
 [uuid(C2669A3A-03A9-45E9-97EA-03CD55E5DC03), object, pointer_default(unique)]
@@ -363,16 +422,42 @@ interface ICoreWebView2Profile2 : ICoreWebView2Profile {
   [propget] HRESULT CookieManager([out, retval] ICoreWebView2CookieManager** cookieManager);
 }
 
-[uuid(1c1ae2cc-d5c2-ffe3-d3e7-7857035d23b7), object, pointer_default(unique)]
-interface ICoreWebView2Profile3 : ICoreWebView2Profile2 {
-  /// All webviews on this profile will be closed, and the profile will be marked for deletion.
-  /// After the Delete() call completes, The render process of webviews on this profile will
-  /// asynchronously exit with the reason:`COREWEBVIEW2_PROCESS_FAILED_REASON_PROFILE_DELETED`.
-  /// See 'COREWEBVIEW2_PROCESS_FAILED_REASON::COREWEBVIEW2_PROCESS_FAILED_REASON_PROFILE_DELETED'
-  /// for more details. The profile directory on disk will be actually deleted when the browser
-  /// process exits. Webview2 creation will fail with the HRESULT is ERROR_INVALID_STATE(0x8007139FL)
-  /// if you create it with the same name as a profile that is being deleted.
-  HRESULT Delete(); 
+[uuid(2765B8BD-7C57-4B76-B8CC-1EC940FF92CC), object, pointer_default(unique)]
+interface ICoreWebView2StagingProfile7 : IUnknown {
+  /// After the API is called, the profile will be marked for deletion. The
+  /// local profile's directory will be deleted at browser process exit. If it
+  /// fails to delete, because something else is holding the files open,
+  /// WebView2 will try to delete the profile at all future browser process
+  /// starts until successful.
+  /// The corresponding CoreWebView2s will be closed and the 
+  /// CoreWebView2Profile.Deleted event will be raised. See
+  /// `CoreWebView2Profile.Deleted` for more information.
+  /// If you try to create a new profile with the same name as an existing
+  /// profile that has been marked as deleted but hasn't yet been deleted,
+  /// profile creation will fail with HRESULT_FROM_WIN32(ERROR_DELETE_PENDING).
+  HRESULT Delete();
+
+  /// Add an event handler for the `Deleted` event. The `Deleted` event is
+  /// raised when the profile is marked for deletion. When this event is
+  /// raised, the CoreWebView2Profile and its corresponding CoreWebView2s have
+  /// been closed, and cannot be used anymore.
+  HRESULT add_Deleted(
+      [in] ICoreWebView2StagingProfileDeletedEventHandler* eventHandler,
+      [out] EventRegistrationToken* token);
+
+  /// Remove an event handler previously added with `add_Deleted`.
+  HRESULT remove_Deleted(
+      [in] EventRegistrationToken token);
+}
+
+[uuid(e5dea648-79c9-4caa-8314-dd71de62ad49), object, pointer_default(unique)]
+interface ICoreWebView2StagingProfileDeletedEventHandler: IUnknown {
+  /// Called to provide the implementer with the event args for the
+  /// profile deleted event. No event args exist and the `args`
+  /// parameter is set to `null`.
+  HRESULT Invoke(
+      [in] ICoreWebView2Profile* sender,
+      [in] IUnknown* args);
 }
 ```
 
@@ -415,7 +500,7 @@ namespace Microsoft.Web.WebView2.Core
         // ...
         CoreWebView2Profile Profile { get; };
     }
-    
+
     runtimeclass CoreWebView2Profile
     {
         String ProfileName { get; };
@@ -426,10 +511,10 @@ namespace Microsoft.Web.WebView2.Core
 
         CoreWebView2CookieManager CookieManager { get; };
 
-        [interface_name("Microsoft.Web.WebView2.Core.ICoreWebView2Profile3")]
+        [interface_name("Microsoft.Web.WebView2.Core.ICoreWebView2Profile7")]
         {
-            // ICoreWebView2Profile3 members
             void Delete();
+            event Windows.Foundation.TypedEventHandler<CoreWebView2Profile, Object> Deleted;
         }
     }
 }