Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bidi: Implement SetContentAsync #2880

Open
wants to merge 3 commits into
base: v21
Choose a base branch
from
Open

Bidi: Implement SetContentAsync #2880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3bbb8f2
Bidi: Implement SetContentAsync
kblok Feb 12, 2025
cb2e83c
Ignore one test
kblok Feb 12, 2025
c9c3859
some progress
kblok Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/PuppeteerSharp.Nunit/PuppeteerTestAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ public class PuppeteerTestAttribute : NUnitAttribute, IApplyToTest
private static TestExpectation[] _localExpectations;
private static TestExpectation[] _upstreamExpectations;

public static readonly bool IsChrome = Environment.GetEnvironmentVariable("BROWSER") != "FIREFOX";
public static readonly bool IsCdp = string.IsNullOrEmpty(Environment.GetEnvironmentVariable("PROTOCOL")) || Environment.GetEnvironmentVariable("PROTOCOL")!.Equals("cdp");
public static readonly bool IsChrome = false;
public static readonly bool IsCdp = false;

public static readonly HeadlessMode Headless =
string.IsNullOrEmpty(Environment.GetEnvironmentVariable("HEADLESS_MODE")) ?
Expand Down
15 changes: 0 additions & 15 deletions lib/PuppeteerSharp.Nunit/TestExpectations/TestExpectations.local.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1515,21 +1515,6 @@
"FAIL"
]
},
{
"comment": "This is part of organizing the webdriver bidi implementation, We will remove it one by one",
"testIdPattern": "[page.spec] *Page.setContent*",
"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": "[proxy.spec] *",
Expand Down
6 changes: 3 additions & 3 deletions lib/PuppeteerSharp.Tests/PageTests/SetContentTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace PuppeteerSharp.Tests.PageTests
{
public class SetContentTests : PuppeteerPageBaseTest
{
const string ExpectedOutput = "<html><head></head><body><div>hello</div></body></html>";
private const string ExpectedOutput = "<html><head></head><body><div>hello</div></body></html>";

public async Task Usage(IBrowser browser)
{
Expand Down Expand Up @@ -65,7 +65,7 @@ public async Task ShouldRespectTimeout()
Timeout = 1
}));

Assert.That(exception.Message, Does.Contain("Timeout of 1 ms exceeded"));
Assert.That(exception!.Message, Does.Contain("Timeout of 1 ms exceeded"));
}

[Test, Retry(2), PuppeteerTest("page.spec", "Page Page.setContent", "should respect default navigation timeout")]
Expand All @@ -79,7 +79,7 @@ public async Task ShouldRespectDefaultTimeout()
var exception = Assert.ThrowsAsync<TimeoutException>(async () =>
await Page.SetContentAsync($"<img src='{TestConstants.ServerUrl + imgPath}'></img>"));

Assert.That(exception.Message, Does.Contain("Timeout of 1 ms exceeded"));
Assert.That(exception!.Message, Does.Contain("Timeout of 1 ms exceeded"));
}

[Test, Retry(2), PuppeteerTest("page.spec", "Page Page.setContent", "should await resources to load")]
Expand Down
2 changes: 0 additions & 2 deletions lib/PuppeteerSharp/Bidi/BidiElementHandle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ public static IJSHandle From(RemoteValue value, BidiRealm realm)
return new BidiElementHandle(value, realm);
}

public override ValueTask DisposeAsync() => throw new System.NotImplementedException();

public override Task UploadFileAsync(bool resolveFilePaths, params string[] filePaths) => throw new System.NotImplementedException();

public override Task<IFrame> ContentFrameAsync() => throw new System.NotImplementedException();
Expand Down
18 changes: 17 additions & 1 deletion lib/PuppeteerSharp/Bidi/BidiFrame.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,14 @@ internal BidiPage BidiPage
public override Task<IElementHandle> AddScriptTagAsync(AddTagOptions options) => throw new System.NotImplementedException();

/// <inheritdoc />
public override Task SetContentAsync(string html, NavigationOptions options = null) => throw new System.NotImplementedException();
public override Task SetContentAsync(string html, NavigationOptions options = null)
{
var waitForLoadTask = WaitForLoadAsync(options);
var waitForNetworkIdleTask = WaitForNetworkIdleAsync(options);
var waitTask = Task.WhenAny([waitForLoadTask, waitForNetworkIdleTask]);

return Task.WhenAll(SetFrameContentAsync(html), waitTask);
}

/// <inheritdoc />
public override async Task<IResponse> GoToAsync(string url, NavigationOptions options)
Expand Down Expand Up @@ -334,6 +341,15 @@ private void CreateFrameTarget(BrowsingContext browsingContext)
};
}

private Task SetFrameContentAsync(string content)
=> EvaluateFunctionAsync(
@"html => {{
document.open();
document.write(html);
document.close();
}}",
content);

private class Realms(BidiFrameRealm defaultRealm, BidiFrameRealm internalRealm)
{
public BidiFrameRealm Default { get; } = defaultRealm;
Expand Down
2 changes: 1 addition & 1 deletion lib/PuppeteerSharp/Bidi/BidiFrameRealm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

namespace PuppeteerSharp.Bidi;

internal class BidiFrameRealm(WindowRealm realm, BidiFrame frame) : BidiRealm(realm, frame.TimeoutSettings)
internal class BidiFrameRealm(WindowRealm realm, BidiFrame frame) : BidiRealm(realm, frame.TimeoutSettings, frame.BidiPage.BidiBrowser.LoggerFactory)
{
private readonly WindowRealm _realm = realm;
private bool _bindingsInstalled;
Expand Down
13 changes: 12 additions & 1 deletion lib/PuppeteerSharp/Bidi/BidiJSHandle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ public bool IsPrimitiveValue
}
}

internal override string Id => RemoteValue.Handle;

internal override Realm Realm { get; } = realm;

public static BidiJSHandle From(RemoteValue value, BidiRealm realm)
Expand All @@ -51,7 +53,16 @@ public static BidiJSHandle From(RemoteValue value, BidiRealm realm)

public override Task<T> JsonValueAsync<T>() => throw new System.NotImplementedException();

public override ValueTask DisposeAsync() => throw new System.NotImplementedException();
public override async ValueTask DisposeAsync()
{
if (Disposed)
{
return;
}

Disposed = true;
await realm.DestroyHandlesAsync([this]).ConfigureAwait(false);
}

/// <inheritdoc/>
public override string ToString()
Expand Down
51 changes: 46 additions & 5 deletions lib/PuppeteerSharp/Bidi/BidiRealm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
using System.Text.Json;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using PuppeteerSharp.Bidi.Core;
using WebDriverBiDi.Script;

Expand All @@ -43,10 +44,12 @@ namespace PuppeteerSharp.Bidi;
/// <returns>Resolved argument.</returns>
public delegate Task<LocalValue> BidiLazyArg(IPuppeteerUtilWrapper context);

internal class BidiRealm(Core.Realm realm, TimeoutSettings timeoutSettings) : Realm(timeoutSettings), IDisposable, IPuppeteerUtilWrapper
internal class BidiRealm(Core.Realm realm, TimeoutSettings timeoutSettings, ILoggerFactory loggerFactory) : Realm(timeoutSettings), IDisposable, IPuppeteerUtilWrapper
{
private static readonly Regex _sourceUrlRegex = new(@"^[\x20\t]*//([@#])\s*sourceURL=\s{0,10}(\S*?)\s{0,10}$", RegexOptions.Multiline);

private readonly ILogger _logger = loggerFactory.CreateLogger<BidiRealm>();

public bool Disposed { get; private set; }

public JSHandle InternalPuppeteerUtilHandle { get; set; }
Expand All @@ -61,16 +64,27 @@ public void Dispose()

public virtual Task<IJSHandle> GetPuppeteerUtilAsync() => throw new NotImplementedException();

internal override Task<IJSHandle> AdoptHandleAsync(IJSHandle handle) => throw new System.NotImplementedException();
internal override Task<IJSHandle> AdoptHandleAsync(IJSHandle handle)
=> EvaluateFunctionHandleAsync("node => node", handle);

internal override Task<IElementHandle> AdoptBackendNodeAsync(object backendNodeId) => throw new System.NotImplementedException();

internal override Task<IJSHandle> TransferHandleAsync(IJSHandle handle) => throw new System.NotImplementedException();
internal override async Task<IJSHandle> TransferHandleAsync(IJSHandle handle)
{
if (handle is not JSHandle jsHandle || jsHandle.Realm == this)
{
return handle;
}

var transferredHandle = AdoptHandleAsync(handle);
await handle.DisposeAsync().ConfigureAwait(false);
return await transferredHandle.ConfigureAwait(false);
}

internal async override Task<IJSHandle> EvaluateExpressionHandleAsync(string script)
internal override async Task<IJSHandle> EvaluateExpressionHandleAsync(string script)
=> CreateHandleAsync(await EvaluateAsync(false, true, script).ConfigureAwait(false));

internal async override Task<IJSHandle> EvaluateFunctionHandleAsync(string script, params object[] args)
internal override async Task<IJSHandle> EvaluateFunctionHandleAsync(string script, params object[] args)
=> CreateHandleAsync(await EvaluateAsync(false, false, script).ConfigureAwait(false));

internal override async Task<T> EvaluateExpressionAsync<T>(string script)
Expand All @@ -84,6 +98,33 @@ internal override async Task<T> EvaluateFunctionAsync<T>(string script, params o
internal override async Task<JsonElement?> EvaluateFunctionAsync(string script, params object[] args)
=> DeserializeResult<JsonElement?>((await EvaluateAsync(true, false, script, args).ConfigureAwait(false)).Result.Value);

internal async Task DestroyHandlesAsync(BidiJSHandle[] handles)
{
if (Disposed)
{
return;
}

var handleIds = handles
.Select(handle => handle.Id)
.Where(id => id is not null)
.ToArray();

if (handleIds.Length == 0)
{
return;
}

try
{
await realm.DisownAsync(handleIds).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to destroy handles");
}
}

protected virtual void Initialize()
{
realm.Destroyed += (_, e) =>
Expand Down
3 changes: 3 additions & 0 deletions lib/PuppeteerSharp/Bidi/Core/Realm.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@ public Task<EvaluateResult> CallFunctionAsync(
return Session.Driver.Script.CallFunctionAsync(parameters);
}

public Task DisownAsync(string[] handleIds)
=> Session.Driver.Script.DisownAsync(new DisownCommandParameters(Target, handleIds));

protected virtual void OnUpdated() => Updated?.Invoke(this, EventArgs.Empty);

private void OnDestroyed() => Destroyed?.Invoke(this, new ClosedEventArgs(_reason));
Expand Down
16 changes: 1 addition & 15 deletions lib/PuppeteerSharp/Cdp/CdpElementHandle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ internal CdpElementHandle(

internal override CustomQuerySelectorRegistry CustomQuerySelectorRegistry => CustomQuerySelectorRegistry.Default;

internal string Id => RemoteObject.ObjectId;
internal override string Id => RemoteObject.ObjectId;

/// <inheritdoc/>
protected override Page Page => _cdpFrame.FrameManager.Page;
Expand Down Expand Up @@ -162,20 +162,6 @@ await handle.Client.SendAsync(
return handle;
});

/// <inheritdoc />
public override async ValueTask DisposeAsync()
{
if (Disposed)
{
return;
}

Disposed = true;

await Handle.DisposeAsync().ConfigureAwait(false);
GC.SuppressFinalize(this);
}

/// <inheritdoc />
public override string ToString() => Handle.ToString();

Expand Down
2 changes: 1 addition & 1 deletion lib/PuppeteerSharp/Cdp/CdpJSHandle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ internal CdpJSHandle(IsolatedWorld world, RemoteObject remoteObject)
/// </summary>
public RemoteObject RemoteObject { get; }

internal string Id => RemoteObject.ObjectId;
internal override string Id => RemoteObject.ObjectId;

/// <inheritdoc/>
internal override Realm Realm { get; }
Expand Down
16 changes: 16 additions & 0 deletions lib/PuppeteerSharp/ElementHandle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ internal ElementHandle(JSHandle handle)

internal abstract CustomQuerySelectorRegistry CustomQuerySelectorRegistry { get; }

internal override string Id => Handle.Id;

/// <summary>
/// Base handle.
/// </summary>
Expand All @@ -40,6 +42,20 @@ internal ElementHandle(JSHandle handle)
/// <inheritdoc/>
public override string ToString() => Handle.ToString();

/// <inheritdoc/>
public override async ValueTask DisposeAsync()
{
if (Disposed)
{
return;
}

Disposed = true;

await Handle.DisposeAsync().ConfigureAwait(false);
GC.SuppressFinalize(this);
}

/// <inheritdoc/>
public Task ScreenshotAsync(string file) => ScreenshotAsync(file, new ElementScreenshotOptions());

Expand Down
2 changes: 2 additions & 0 deletions lib/PuppeteerSharp/JSHandle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ internal JSHandle()

internal abstract Realm Realm { get; }

internal abstract string Id { get; }

internal Frame Frame => Realm.Environment as Frame;

/// <inheritdoc/>
Expand Down
Loading