Bidi: Unlock dialog tests (#2970)

* Bidi: Unlock Dialog tests

* cr

* cr

* prettier

Author: kblok

lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json

@@ -76,13 +76,6 @@
     "parameters": ["firefox", "headful"],
     "expectations": ["FAIL"]
   },
-  {
-    "comment": "This is flaky on CI/CD",
-    "testIdPattern": "[oopif.spec] OOPIF should provide access to elements",
-    "platforms": ["win32"],
-    "parameters": ["chrome"],
-    "expectations": ["FAIL"]
-  },
   {
     "comment": "This is flaky on CI/CD",
     "testIdPattern": "[worker.spec] Workers Page.workers",
@@ -397,21 +390,6 @@
       "FAIL"
     ]
   },
-  {
-    "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
-    "testIdPattern": "[dialog.spec] *",
-    "platforms": [
-      "darwin",
-      "linux",
-      "win32"
-    ],
-    "parameters": [
-      "webDriverBiDi"
-    ],
-    "expectations": [
-      "FAIL"
-    ]
-  },
   {
     "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
     "testIdPattern": "[diffstyle] *",

lib/PuppeteerSharp.Tests/DialogTests/DialogTests.cs

@@ -6,10 +6,6 @@ namespace PuppeteerSharp.Tests.DialogTests
 {
     public class DialogTests : PuppeteerPageBaseTest
     {
-        public DialogTests() : base()
-        {
-        }
-
         [Test, PuppeteerTest("dialog.spec", "Page.Events.Dialog", "should fire")]
         public async Task ShouldFire()
         {

lib/PuppeteerSharp/Bidi/BidiBrowser.cs

@@ -41,6 +41,7 @@ public class BidiBrowser : Browser
     private readonly ConcurrentSet<BidiBrowserContext> _browserContexts = [];
     private readonly ILogger<BidiBrowser> _logger;
     private readonly BidiBrowserTarget _target;
+    private bool _isClosed;
 
     private BidiBrowser(Core.Browser browserCore, LaunchOptions options, ILoggerFactory loggerFactory)
     {
@@ -52,7 +53,7 @@ private BidiBrowser(Core.Browser browserCore, LaunchOptions options, ILoggerFact
     }
 
     /// <inheritdoc />
-    public override bool IsClosed { get; }
+    public override bool IsClosed => _isClosed;
 
     /// <inheritdoc />
     public override ITarget Target => _target;
@@ -103,6 +104,7 @@ private BidiBrowser(Core.Browser browserCore, LaunchOptions options, ILoggerFact
     /// <inheritdoc />
     public override async Task CloseAsync()
     {
+        _isClosed = true;
         try
         {
             await BrowserCore.CloseAsync().ConfigureAwait(false);

lib/PuppeteerSharp/Bidi/BidiDialog.cs

@@ -0,0 +1,63 @@
+// * MIT License
+//  *
+//  * Copyright (c) Darío Kondratiuk
+//  *
+//  * Permission is hereby granted, free of charge, to any person obtaining a copy
+//  * of this software and associated documentation files (the "Software"), to deal
+//  * in the Software without restriction, including without limitation the rights
+//  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  * copies of the Software, and to permit persons to whom the Software is
+//  * furnished to do so, subject to the following conditions:
+//  *
+//  * The above copyright notice and this permission notice shall be included in all
+//  * copies or substantial portions of the Software.
+//  *
+//  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  * SOFTWARE.
+
+using System.Threading.Tasks;
+using PuppeteerSharp.Bidi.Core;
+
+namespace PuppeteerSharp.Bidi;
+
+/// <summary>
+/// BiDi implementation of <see cref="Dialog"/>.
+/// </summary>
+public class BidiDialog : Dialog
+{
+    private readonly UserPrompt _prompt;
+
+    private BidiDialog(UserPrompt prompt)
+        : base(ConvertDialogType(prompt.Info.PromptType), prompt.Info.Message, prompt.Info.DefaultValue ?? string.Empty)
+    {
+        _prompt = prompt;
+    }
+
+    internal static BidiDialog From(UserPrompt prompt)
+    {
+        return new BidiDialog(prompt);
+    }
+
+    internal override Task HandleAsync(bool accept, string text)
+    {
+        return _prompt.HandleAsync(accept, text);
+    }
+
+    private static DialogType ConvertDialogType(WebDriverBiDi.BrowsingContext.UserPromptType type)
+    {
+        return type switch
+        {
+            WebDriverBiDi.BrowsingContext.UserPromptType.Alert => DialogType.Alert,
+            WebDriverBiDi.BrowsingContext.UserPromptType.Confirm => DialogType.Confirm,
+            WebDriverBiDi.BrowsingContext.UserPromptType.Prompt => DialogType.Prompt,
+            WebDriverBiDi.BrowsingContext.UserPromptType.BeforeUnload => DialogType.BeforeUnload,
+            _ => DialogType.Alert,
+        };
+    }
+}
+

lib/PuppeteerSharp/Bidi/BidiFrame.cs

@@ -570,6 +570,12 @@ private void Initialize()
             ((Page)Page).OnDOMContentLoaded();
             ((Page)Page).OnFrameNavigated(new FrameNavigatedEventArgs(this, NavigationType.Navigation));
         };
+
+        BrowsingContext.UserPrompt += (sender, args) =>
+        {
+            var dialog = BidiDialog.From(args.UserPrompt);
+            ((Page)Page).OnDialog(new DialogEventArgs(dialog));
+        };
     }
 
     private void CreateFrameTarget(BrowsingContext browsingContext)

lib/PuppeteerSharp/Bidi/Core/BrowsingContext.cs

@@ -24,7 +24,6 @@
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Threading.Tasks;
-using Microsoft.Extensions.Options;
 using WebDriverBiDi.BrowsingContext;
 using WebDriverBiDi.Input;
 
@@ -64,6 +63,8 @@ private BrowsingContext(UserContext userContext, BrowsingContext parent, string
 
     public event EventHandler HistoryUpdated;
 
+    public event EventHandler<UserPromptEventArgs> UserPrompt;
+
     public UserContext UserContext { get; }
 
     public string Id { get; }
@@ -174,7 +175,7 @@ internal WindowRealm CreateWindowRealm(string sandbox = null)
     {
         var realm = WindowRealm.From(this, sandbox);
 
-        realm.Worker += (sender, args) =>
+        realm.Worker += (_, args) =>
         {
             OnWorker(args.Realm);
         };
@@ -192,7 +193,7 @@ internal async Task ReloadAsync()
 
     private void Initialize()
     {
-        UserContext.Closed += (sender, args) => Dispose("User context was closed");
+        UserContext.Closed += (_, _) => Dispose("User context was closed");
 
         Session.BrowsingContextContextCreated += (sender, args) =>
         {
@@ -205,15 +206,15 @@ private void Initialize()
 
             _children.TryAdd(args.UserContextId, browsingContext);
 
-            browsingContext.Closed += (sender, args) =>
+            browsingContext.Closed += (_, _) =>
             {
                 _children.TryRemove(browsingContext.Id, out _);
             };
 
             OnBrowsingContextCreated(new BidiBrowsingContextEventArgs(browsingContext));
         };
 
-        Session.BrowsingContextContextDestroyed += (sender, args) =>
+        Session.BrowsingContextContextDestroyed += (_, args) =>
         {
             if (args.UserContextId != Id)
             {
@@ -223,7 +224,7 @@ private void Initialize()
             Dispose("Browsing context already closed.");
         };
 
-        Session.BrowsingContextDomContentLoaded += (sender, args) =>
+        Session.BrowsingContextDomContentLoaded += (_, args) =>
         {
             if (args.BrowsingContextId != Id)
             {
@@ -234,7 +235,7 @@ private void Initialize()
             OnDomContentLoaded();
         };
 
-        Session.BrowsingContextLoad += (sender, args) =>
+        Session.BrowsingContextLoad += (_, args) =>
         {
             if (args.BrowsingContextId != Id)
             {
@@ -274,7 +275,7 @@ private void Initialize()
             OnNavigation(new BrowserContextNavigationEventArgs(_navigation));
         };
 
-        Session.BrowsingContextHistoryUpdated += (sender, args) =>
+        Session.BrowsingContextHistoryUpdated += (_, args) =>
         {
             if (args.BrowsingContextId != Id)
             {
@@ -284,7 +285,7 @@ private void Initialize()
             OnHistoryUpdated();
         };
 
-        Session.NetworkBeforeRequestSent += (sender, args) =>
+        Session.NetworkBeforeRequestSent += (_, args) =>
         {
             if (args.BrowsingContextId != Id)
             {
@@ -300,6 +301,17 @@ private void Initialize()
             _requests.TryAdd(args.Request.RequestId, request);
             Request?.Invoke(this, new RequestEventArgs(request));
         };
+
+        Session.BrowsingContextUserPromptOpened += (_, args) =>
+        {
+            if (args.BrowsingContextId != Id)
+            {
+                return;
+            }
+
+            var userPrompt = Core.UserPrompt.From(this, args);
+            OnUserPromptOpened(new UserPromptEventArgs(userPrompt));
+        };
     }
 
     private void OnNavigation(BrowserContextNavigationEventArgs args) => Navigation?.Invoke(this, args);
@@ -324,4 +336,6 @@ private void Dispose(string reason)
     private void OnClosed(string reason) => Closed?.Invoke(this, new ClosedEventArgs(reason));
 
     private void OnWorker(DedicatedWorkerRealm args) => Worker?.Invoke(this, new WorkerRealmEventArgs(args));
+
+    private void OnUserPromptOpened(UserPromptEventArgs args) => UserPrompt?.Invoke(this, args);
 }

lib/PuppeteerSharp/Bidi/Core/Session.cs

@@ -64,6 +64,10 @@ internal class Session(BiDiDriver driver, NewCommandResult info) : IDisposable
 
     public event EventHandler<ResponseCompletedEventArgs> NetworkResponseComplete;
 
+    public event EventHandler<WebDriverBiDi.BrowsingContext.UserPromptOpenedEventArgs> BrowsingContextUserPromptOpened;
+
+    public event EventHandler<WebDriverBiDi.BrowsingContext.UserPromptClosedEventArgs> BrowsingContextUserPromptClosed;
+
     public BiDiDriver Driver { get; } = driver;
 
     public NewCommandResult Info { get; } = info;
@@ -112,6 +116,8 @@ private async Task InitializeAsync()
         Driver.Network.OnAuthRequired.AddObserver(OnNetworkAuthRequired);
         Driver.Network.OnFetchError.AddObserver(OnNetworkFetchError);
         Driver.Network.OnResponseCompleted.AddObserver(OnNetworkResponseCompleted);
+        Driver.BrowsingContext.OnUserPromptOpened.AddObserver(OnBrowsingContextUserPromptOpened);
+        Driver.BrowsingContext.OnUserPromptClosed.AddObserver(OnBrowsingContextUserPromptClosed);
     }
 
     private void OnFragmentNavigated(WebDriverBiDi.BrowsingContext.NavigationEventArgs info)
@@ -149,4 +155,8 @@ private void OnFragmentNavigated(WebDriverBiDi.BrowsingContext.NavigationEventAr
     private void OnBrowsingContextDomContentLoaded(WebDriverBiDi.BrowsingContext.NavigationEventArgs obj) => BrowsingContextDomContentLoaded?.Invoke(this, obj);
 
     private void OnBrowsingContextContextDestroyed(BrowsingContextEventArgs obj) => BrowsingContextContextDestroyed?.Invoke(this, obj);
+
+    private void OnBrowsingContextUserPromptOpened(WebDriverBiDi.BrowsingContext.UserPromptOpenedEventArgs obj) => BrowsingContextUserPromptOpened?.Invoke(this, obj);
+
+    private void OnBrowsingContextUserPromptClosed(WebDriverBiDi.BrowsingContext.UserPromptClosedEventArgs obj) => BrowsingContextUserPromptClosed?.Invoke(this, obj);
 }