From 7dca812fa3f9c7a37138038a1fcc84b7074df192 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dar=C3=ADo=20Kondratiuk?= <dariokondratiuk@gmail.com>
Date: Thu, 26 Dec 2024 10:56:00 -0300
Subject: [PATCH] Bidi: Pass wait for navigation (#2848)

* Bidi: Pass wait for navigation

* markdown uses net8

* some fixes in the context

* Ignore one test
---
 .github/workflows/on-push-do-docs.yml         |  2 +-
 .../TestExpectations.local.json               |  2 +-
 .../PageWaitForNavigationTests.cs             | 14 +++-----
 lib/PuppeteerSharp/Bidi/BidiFrame.cs          | 33 ++++++++++++++++++-
 lib/PuppeteerSharp/Bidi/BidiRealm.cs          |  3 +-
 .../Bidi/Core/BrowsingContext.cs              |  2 +-
 .../Bidi/Core/DedicatedWorkerRealm.cs         |  8 ++---
 lib/PuppeteerSharp/Bidi/Core/Realm.cs         |  7 ++--
 lib/PuppeteerSharp/Bidi/WindowRealm.cs        | 16 +++++----
 lib/PuppeteerSharp/Page.cs                    | 28 ++++++++--------
 10 files changed, 73 insertions(+), 42 deletions(-)

diff --git a/.github/workflows/on-push-do-docs.yml b/.github/workflows/on-push-do-docs.yml
index 1088f7768..26843e88f 100644
--- a/.github/workflows/on-push-do-docs.yml
+++ b/.github/workflows/on-push-do-docs.yml
@@ -9,7 +9,7 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 7.0.x
+        dotnet-version: 8.0.x
     - name: Run MarkdownSnippets
       run: |
         dotnet tool install --global MarkdownSnippets.Tool
diff --git a/lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json b/lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json
index 38951f7a5..30c546b55 100644
--- a/lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json
+++ b/lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json
@@ -122,7 +122,7 @@
   },
   {
     "comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
-    "testIdPattern": "[navigation.spec] navigation Page.waitForNavigation*",
+    "testIdPattern": "[navigation.spec] navigation Page.waitForNavigation*should work with clicking on anchor links",
     "platforms": [
       "darwin",
       "linux",
diff --git a/lib/PuppeteerSharp.Tests/NavigationTests/PageWaitForNavigationTests.cs b/lib/PuppeteerSharp.Tests/NavigationTests/PageWaitForNavigationTests.cs
index e2b9e0d15..8a02b80f1 100644
--- a/lib/PuppeteerSharp.Tests/NavigationTests/PageWaitForNavigationTests.cs
+++ b/lib/PuppeteerSharp.Tests/NavigationTests/PageWaitForNavigationTests.cs
@@ -144,19 +144,13 @@ public async Task ShouldWorkWhenSubframeIssuesWindowStop()
             var frameAttachedTaskSource = new TaskCompletionSource<IFrame>();
             Page.FrameAttached += (_, e) =>
             {
-                frameAttachedTaskSource.SetResult(e.Frame);
-            };
-
-            var frame = await frameAttachedTaskSource.Task;
-            var frameNavigatedTaskSource = new TaskCompletionSource<bool>();
-            Page.FrameNavigated += (_, e) =>
-            {
-                if (e.Frame == frame)
+                if (e.Frame.ParentFrame != null)
                 {
-                    frameNavigatedTaskSource.TrySetResult(true);
+                    frameAttachedTaskSource.SetResult(e.Frame);
                 }
             };
-            await frameNavigatedTaskSource.Task;
+
+            var frame = await frameAttachedTaskSource.Task;
             await Task.WhenAll(
                 frame.EvaluateFunctionAsync("() => window.stop()"),
                 navigationTask
diff --git a/lib/PuppeteerSharp/Bidi/BidiFrame.cs b/lib/PuppeteerSharp/Bidi/BidiFrame.cs
index 463500bc8..a6f1c0032 100644
--- a/lib/PuppeteerSharp/Bidi/BidiFrame.cs
+++ b/lib/PuppeteerSharp/Bidi/BidiFrame.cs
@@ -26,6 +26,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using PuppeteerSharp.Bidi.Core;
+using PuppeteerSharp.Cdp.Messaging;
 using PuppeteerSharp.Helpers;
 
 namespace PuppeteerSharp.Bidi;
@@ -41,6 +42,7 @@ internal BidiFrame(BidiPage parentPage, BidiFrame parentFrame, BrowsingContext b
         ParentPage = parentPage;
         ParentFrame = parentFrame;
         BrowsingContext = browsingContext;
+        Id = browsingContext.Id;
         _realms = new Realms(
 #pragma warning disable CA2000
             BidiFrameRealm.From(browsingContext.DefaultRealm, this),
@@ -259,6 +261,11 @@ private void Initialize()
             CreateFrameTarget(browsingContext);
         }
 
+        BrowsingContext.BrowsingContextCreated += (sender, args) =>
+        {
+            CreateFrameTarget(args.BrowsingContext);
+        };
+
         BrowsingContext.Closed += (sender, args) =>
         {
             foreach (var session in BidiCdpSession.Sessions)
@@ -288,11 +295,35 @@ private void Initialize()
 
             _ = httpRequest.FinalizeInterceptionsAsync();
         };
+
+        BrowsingContext.Navigation += (sender, args) =>
+        {
+            if (args.Navigation.FragmentReceived)
+            {
+                ((Page)Page).OnFrameNavigated(new FrameNavigatedEventArgs(this, NavigationType.Navigation));
+            }
+
+            args.Navigation.Fragment += (o, eventArgs) =>
+            {
+                ((Page)Page).OnFrameNavigated(new FrameNavigatedEventArgs(this, NavigationType.Navigation));
+            };
+        };
+
+        BrowsingContext.Load += (sender, args) =>
+        {
+            ((Page)Page).OnLoad();
+        };
+
+        BrowsingContext.DomContentLoaded += (sender, args) =>
+        {
+            ((Page)Page).OnDOMContentLoaded();
+            ((Page)Page).OnFrameNavigated(new FrameNavigatedEventArgs(this, NavigationType.Navigation));
+        };
     }
 
     private void CreateFrameTarget(BrowsingContext browsingContext)
     {
-        var frame = BidiFrame.From(null, this, browsingContext);
+        var frame = From(null, this, browsingContext);
         _frames.TryAdd(browsingContext, frame);
         ((BidiPage)Page).OnFrameAttached(new FrameEventArgs(frame));
 
diff --git a/lib/PuppeteerSharp/Bidi/BidiRealm.cs b/lib/PuppeteerSharp/Bidi/BidiRealm.cs
index febd84b1a..42ee74a4e 100644
--- a/lib/PuppeteerSharp/Bidi/BidiRealm.cs
+++ b/lib/PuppeteerSharp/Bidi/BidiRealm.cs
@@ -79,7 +79,8 @@ internal override async Task<T> EvaluateExpressionAsync<T>(string script)
     internal override async Task<T> EvaluateFunctionAsync<T>(string script, params object[] args)
         => DeserializeResult<T>((await EvaluateAsync(true, false, script, args).ConfigureAwait(false)).Result.Value);
 
-    internal override Task<JsonElement?> EvaluateFunctionAsync(string script, params object[] args) => throw new System.NotImplementedException();
+    internal override async Task<JsonElement?> EvaluateFunctionAsync(string script, params object[] args)
+        => DeserializeResult<JsonElement?>((await EvaluateAsync(true, false, script, args).ConfigureAwait(false)).Result.Value);
 
     protected virtual void Initialize()
     {
diff --git a/lib/PuppeteerSharp/Bidi/Core/BrowsingContext.cs b/lib/PuppeteerSharp/Bidi/Core/BrowsingContext.cs
index 68de760e6..8ce526386 100644
--- a/lib/PuppeteerSharp/Bidi/Core/BrowsingContext.cs
+++ b/lib/PuppeteerSharp/Bidi/Core/BrowsingContext.cs
@@ -157,7 +157,7 @@ private void Initialize()
                 return;
             }
 
-            var browsingContext = From(UserContext, this, args.UserContextId, args.Url, args.OriginalOpener);
+            var browsingContext = From(UserContext, this, args.BrowsingContextId, args.Url, args.OriginalOpener);
 
             _children.TryAdd(args.UserContextId, browsingContext);
 
diff --git a/lib/PuppeteerSharp/Bidi/Core/DedicatedWorkerRealm.cs b/lib/PuppeteerSharp/Bidi/Core/DedicatedWorkerRealm.cs
index ec12b6194..1ccae26cd 100644
--- a/lib/PuppeteerSharp/Bidi/Core/DedicatedWorkerRealm.cs
+++ b/lib/PuppeteerSharp/Bidi/Core/DedicatedWorkerRealm.cs
@@ -29,17 +29,17 @@ internal class DedicatedWorkerRealm : Realm
 {
     private readonly ConcurrentSet<IDedicatedWorkerOwnerRealm> _owners = [];
 
-    private DedicatedWorkerRealm(IDedicatedWorkerOwnerRealm owner, string id, string origin)
-    : base(id, origin)
+    private DedicatedWorkerRealm(BrowsingContext context, IDedicatedWorkerOwnerRealm owner, string id, string origin)
+    : base(context, id, origin)
     {
         _owners.Add(owner);
     }
 
     public override Session Session => _owners.FirstOrDefault()?.Session;
 
-    public static DedicatedWorkerRealm From(IDedicatedWorkerOwnerRealm owner, string id, string origin)
+    public static DedicatedWorkerRealm From(BrowsingContext context, IDedicatedWorkerOwnerRealm owner, string id, string origin)
     {
-        var realm = new DedicatedWorkerRealm(owner, id, origin);
+        var realm = new DedicatedWorkerRealm(context, owner, id, origin);
         realm.Initialize();
         return realm;
     }
diff --git a/lib/PuppeteerSharp/Bidi/Core/Realm.cs b/lib/PuppeteerSharp/Bidi/Core/Realm.cs
index 1eaa094f3..ed7a7c61c 100644
--- a/lib/PuppeteerSharp/Bidi/Core/Realm.cs
+++ b/lib/PuppeteerSharp/Bidi/Core/Realm.cs
@@ -26,7 +26,7 @@
 
 namespace PuppeteerSharp.Bidi.Core;
 
-internal abstract class Realm(string id, string origin) : IDisposable
+internal abstract class Realm(BrowsingContext context, string id, string origin) : IDisposable
 {
     private string _reason;
 
@@ -40,10 +40,13 @@ internal abstract class Realm(string id, string origin) : IDisposable
 
     public bool Disposed { get; private set; }
 
-    public WebDriverBiDi.Script.Target Target => new RealmTarget(Id);
+    public virtual ContextTarget Target => new ContextTarget(Id);
 
     public abstract Session Session { get; }
 
+    // Just for testing purposes
+    internal BrowsingContext Context => context;
+
     public void Dispose(string reason)
     {
         _reason = reason;
diff --git a/lib/PuppeteerSharp/Bidi/WindowRealm.cs b/lib/PuppeteerSharp/Bidi/WindowRealm.cs
index 13a2012bc..1109eba1a 100644
--- a/lib/PuppeteerSharp/Bidi/WindowRealm.cs
+++ b/lib/PuppeteerSharp/Bidi/WindowRealm.cs
@@ -22,20 +22,22 @@
 
 using System;
 using System.Collections.Concurrent;
+using System.Threading.Tasks;
 using PuppeteerSharp.Bidi.Core;
-using PuppeteerSharp.Helpers;
 using WebDriverBiDi.Script;
 
 namespace PuppeteerSharp.Bidi;
 
-internal class WindowRealm(BrowsingContext browsingContext, string sandbox = null) : Core.Realm(string.Empty, string.Empty), IDedicatedWorkerOwnerRealm
+internal class WindowRealm(BrowsingContext browsingContext, string sandbox = null) : Core.Realm(browsingContext, string.Empty, string.Empty), IDedicatedWorkerOwnerRealm
 {
     private readonly string _sandbox = sandbox;
     private readonly ConcurrentDictionary<string, DedicatedWorkerRealm> _workers = [];
 
     public event EventHandler<WorkerRealmEventArgs> Worker;
 
-    public override Session Session => browsingContext.UserContext.Browser.Session;
+    public override Session Session => Context.UserContext.Browser.Session;
+
+    public override ContextTarget Target => new(Context.Id); // TODO: Add sandbox
 
     public string ExecutionContextId { get; set; }
 
@@ -48,7 +50,7 @@ public static WindowRealm From(BrowsingContext context, string sandbox = null)
 
     public override void Dispose()
     {
-        browsingContext.Dispose();
+        Context.Dispose();
         Session.Dispose();
 
         foreach (var worker in _workers.Values)
@@ -61,7 +63,7 @@ public override void Dispose()
 
     private void Initialize()
     {
-        browsingContext.Closed += (sender, args) => Dispose(args.Reason);
+        Context.Closed += (sender, args) => Dispose(args.Reason);
         Session.Driver.Script.OnRealmCreated.AddObserver(OnWindowRealmCreated);
         Session.Driver.Script.OnRealmCreated.AddObserver(OnDedicatedRealmCreated);
     }
@@ -80,7 +82,7 @@ private void OnWindowRealmCreated(RealmCreatedEventArgs args)
             return;
         }
 
-        var realm = DedicatedWorkerRealm.From(this, dedicatedWorkerInfo.RealmId, dedicatedWorkerInfo.Origin);
+        var realm = DedicatedWorkerRealm.From(Context, this, dedicatedWorkerInfo.RealmId, dedicatedWorkerInfo.Origin);
         _workers.TryAdd(realm.Id, realm);
         realm.Destroyed += (sender, args) => _workers.TryRemove(realm.Id, out _);
         OnWorker(realm);
@@ -91,7 +93,7 @@ private void OnWindowRealmCreated(RealmCreatedEventArgs args)
     private void OnDedicatedRealmCreated(RealmCreatedEventArgs args)
     {
         if (args.Type != RealmType.Window ||
-            args.As<WindowRealmInfo>().BrowsingContext != browsingContext.Id ||
+            args.As<WindowRealmInfo>().BrowsingContext != Context.Id ||
             args.As<WindowRealmInfo>().Sandbox != _sandbox)
         {
             return;
diff --git a/lib/PuppeteerSharp/Page.cs b/lib/PuppeteerSharp/Page.cs
index 2ea5f85e7..2a7b02117 100644
--- a/lib/PuppeteerSharp/Page.cs
+++ b/lib/PuppeteerSharp/Page.cs
@@ -905,30 +905,30 @@ internal void OnRequest(IRequest request)
         }
 
         /// <summary>
-        /// Dispose resources.
+        /// Raises the <see cref="DOMContentLoaded"/> event.
         /// </summary>
-        /// <param name="disposing">Indicates whether disposal was initiated by <see cref="Dispose()"/> operation.</param>
-        protected virtual void Dispose(bool disposing)
-        {
-            Mouse.Dispose();
-            _ = DisposeAsync();
-        }
+        internal void OnDOMContentLoaded() => DOMContentLoaded?.Invoke(this, EventArgs.Empty);
 
         /// <summary>
-        /// Raises the <see cref="FrameNavigated"/> event.
+        /// Raises the <see cref="Load"/> event.
         /// </summary>
-        /// <param name="e">Event arguments.</param>
-        protected void OnFrameNavigated(FrameNavigatedEventArgs e) => FrameNavigated?.Invoke(this, e);
+        internal void OnLoad() => Load?.Invoke(this, EventArgs.Empty);
 
         /// <summary>
-        /// Raises the <see cref="DOMContentLoaded"/> event.
+        /// Raises the <see cref="FrameNavigated"/> event.
         /// </summary>
-        protected void OnDOMContentLoaded() => DOMContentLoaded?.Invoke(this, EventArgs.Empty);
+        /// <param name="e">Event arguments.</param>
+        internal void OnFrameNavigated(FrameNavigatedEventArgs e) => FrameNavigated?.Invoke(this, e);
 
         /// <summary>
-        /// Raises the <see cref="Load"/> event.
+        /// Dispose resources.
         /// </summary>
-        protected void OnLoad() => Load?.Invoke(this, EventArgs.Empty);
+        /// <param name="disposing">Indicates whether disposal was initiated by <see cref="Dispose()"/> operation.</param>
+        protected virtual void Dispose(bool disposing)
+        {
+            Mouse.Dispose();
+            _ = DisposeAsync();
+        }
 
         /// <summary>
         /// Raises the <see cref="WorkerDestroyed"/> event.