Split JSHandle and ElementHandle (#2570)

* Split JSHandle and ElementHandle

* add missing toString

lib/PuppeteerSharp/Cdp/CdpElementHandle.cs

@@ -0,0 +1,175 @@
+// * 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;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using PuppeteerSharp.Messaging;
+using PuppeteerSharp.QueryHandlers;
+
+namespace PuppeteerSharp.Cdp;
+
+/// <inheritdoc />
+public class CdpElementHandle : ElementHandle
+{
+    internal CdpElementHandle(
+        IsolatedWorld world,
+        RemoteObject remoteObject) : base(world, remoteObject)
+    {
+        Handle = new CdpJSHandle(world, remoteObject);
+        Logger = Realm.Environment.Client.Connection.LoggerFactory.CreateLogger(GetType());
+    }
+
+    /// <summary>
+    /// Logger.
+    /// </summary>
+    internal ILogger Logger { get; }
+
+    internal override CustomQuerySelectorRegistry CustomQuerySelectorRegistry =>
+        Client.Connection.CustomQuerySelectorRegistry;
+
+    /// <inheritdoc/>
+    protected override Page Page => Frame.FrameManager.Page;
+
+    private CDPSession Client => Handle.Realm.Environment.Client;
+
+    private FrameManager FrameManager => Frame.FrameManager;
+
+    /// <inheritdoc/>
+    public override async Task<IFrame> ContentFrameAsync()
+    {
+        var nodeInfo = await Client
+            .SendAsync<DomDescribeNodeResponse>("DOM.describeNode", new DomDescribeNodeRequest { ObjectId = Id, })
+            .ConfigureAwait(false);
+
+        return string.IsNullOrEmpty(nodeInfo.Node.FrameId)
+            ? null
+            : await FrameManager.FrameTree.GetFrameAsync(nodeInfo.Node.FrameId).ConfigureAwait(false);
+    }
+
+    /// <inheritdoc/>
+    public override Task ScrollIntoViewAsync()
+        => BindIsolatedHandleAsync<IElementHandle, CdpElementHandle>(async handle =>
+        {
+            await handle.AssertConnectedElementAsync().ConfigureAwait(false);
+            try
+            {
+                await handle.Client
+                    .SendAsync(
+                        "DOM.scrollIntoViewIfNeeded",
+                        new DomScrollIntoViewIfNeededRequest { ObjectId = Id, })
+                    .ConfigureAwait(false);
+            }
+            catch (Exception ex)
+            {
+                Logger.LogError(ex, "DOM.scrollIntoViewIfNeeded is not supported");
+                await base.ScrollIntoViewAsync().ConfigureAwait(false);
+            }
+
+            return handle;
+        });
+
+    /// <inheritdoc />
+    public override Task UploadFileAsync(bool resolveFilePaths, params string[] filePaths)
+            => BindIsolatedHandleAsync<CdpElementHandle, CdpElementHandle>(async handle =>
+            {
+                var isMultiple = await EvaluateFunctionAsync<bool>("element => element.multiple").ConfigureAwait(false);
+
+                if (!isMultiple && filePaths.Length > 1)
+                {
+                    throw new PuppeteerException("Multiple file uploads only work with <input type=file multiple>");
+                }
+
+                // The zero-length array is a special case, it seems that
+                // DOM.setFileInputFiles does not actually update the files in that case, so
+                // the solution is to eval the element value to a new FileList directly.
+                if (!filePaths.Any())
+                {
+                    await handle.EvaluateFunctionAsync(@"(element) => {
+                        element.files = new DataTransfer().files;
+
+                        // Dispatch events for this case because it should behave akin to a user action.
+                        element.dispatchEvent(
+                            new Event('input', {bubbles: true, composed: true})
+                        );
+                        element.dispatchEvent(new Event('change', { bubbles: true }));
+                    }").ConfigureAwait(false);
+
+                    return handle;
+                }
+
+                var node = await handle.Client
+                    .SendAsync<DomDescribeNodeResponse>(
+                        "DOM.describeNode",
+                        new DomDescribeNodeRequest { ObjectId = Id, }).ConfigureAwait(false);
+                var backendNodeId = node.Node.BackendNodeId;
+
+                var files = resolveFilePaths ? filePaths.Select(Path.GetFullPath).ToArray() : filePaths;
+                CheckForFileAccess(files);
+                await handle.Client.SendAsync(
+                    "DOM.setFileInputFiles",
+                    new DomSetFileInputFilesRequest
+                    {
+                        ObjectId = Id,
+                        Files = files,
+                        BackendNodeId = backendNodeId,
+                    })
+                    .ConfigureAwait(false);
+
+                return handle;
+            });
+
+    /// <inheritdoc />
+    public override ValueTask DisposeAsync()
+    {
+        if (Disposed)
+        {
+            return default;
+        }
+
+        Disposed = true;
+
+        Handle.DisposeAsync();
+        GC.SuppressFinalize(this);
+        return default;
+    }
+
+    /// <inheritdoc />
+    public override string ToString() => Handle.ToString();
+
+    private void CheckForFileAccess(string[] files)
+    {
+        foreach (var file in files)
+        {
+            try
+            {
+                File.Open(file, FileMode.Open).Dispose();
+            }
+            catch (Exception ex)
+            {
+                throw new PuppeteerException($"{files} does not exist or is not readable", ex);
+            }
+        }
+    }
+}

lib/PuppeteerSharp/Cdp/CdpJSHandle.cs

@@ -0,0 +1,96 @@
+// * 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;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using Newtonsoft.Json;
+using PuppeteerSharp.Helpers;
+using PuppeteerSharp.Helpers.Json;
+using PuppeteerSharp.Messaging;
+
+namespace PuppeteerSharp.Cdp;
+
+/// <inheritdoc/>
+[JsonConverter(typeof(JSHandleMethodConverter))]
+public class CdpJSHandle : JSHandle
+{
+    internal CdpJSHandle(IsolatedWorld world, RemoteObject remoteObject) : base(world, remoteObject)
+    {
+        Logger = Client.Connection.LoggerFactory.CreateLogger(GetType());
+    }
+
+    /// <summary>
+    /// Logger.
+    /// </summary>
+    private ILogger Logger { get; }
+
+    private CDPSession Client => Realm.Environment.Client;
+
+    /// <inheritdoc/>
+    public override async Task<T> JsonValueAsync<T>()
+    {
+        var objectId = RemoteObject.ObjectId;
+
+        if (objectId == null)
+        {
+            return (T)RemoteObjectHelper.ValueFromRemoteObject<T>(RemoteObject);
+        }
+
+        var value = await EvaluateFunctionAsync<T>("object => object").ConfigureAwait(false);
+
+        return value == null ? throw new PuppeteerException("Could not serialize referenced object") : value;
+    }
+
+    /// <inheritdoc/>
+    public override async ValueTask DisposeAsync()
+    {
+        if (Disposed)
+        {
+            return;
+        }
+
+        Disposed = true;
+
+        if (DisposeAction != null)
+        {
+            await DisposeAction().ConfigureAwait(false);
+        }
+
+        await RemoteObjectHelper.ReleaseObjectAsync(Client, RemoteObject, Logger).ConfigureAwait(false);
+        GC.SuppressFinalize(this);
+    }
+
+    /// <inheritdoc/>
+    public override string ToString()
+    {
+        if (RemoteObject.ObjectId == null)
+        {
+            return "JSHandle:" + RemoteObjectHelper.ValueFromRemoteObject<object>(RemoteObject, true);
+        }
+
+        var type = RemoteObject.Subtype != RemoteObjectSubtype.Other
+            ? RemoteObject.Subtype.ToString()
+            : RemoteObject.Type.ToString();
+        return "JSHandle@" + type.ToLower(System.Globalization.CultureInfo.CurrentCulture);
+    }
+}

lib/PuppeteerSharp/Cdp/CdpWebWorker.cs

@@ -147,7 +147,7 @@ private async Task OnConsoleAPICalledAsync(MessageEventArgs e)
         var consoleData = e.MessageData.ToObject<PageConsoleResponse>(true);
         await _consoleAPICalled(
             consoleData.Type,
-            consoleData.Args.Select(i => new JSHandle(World, i)).ToArray(),
+            consoleData.Args.Select(i => new CdpJSHandle(World, i)).ToArray(),
             consoleData.StackTrace)
                 .ConfigureAwait(false);
     }