Use secondary DOMWorld to drive page.Select (#924)

Author: kblok

lib/PuppeteerSharp.Tests/PageTests/SelectTests.cs

@@ -112,7 +112,7 @@ public async Task ShouldDeselectAllOptionsWhenPassedNoValuesForASelectWithoutMul
                 "select => Array.from(select.options).every(option => !option.selected)"));
         }
 
-        [Fact(Skip = "see https://github.com/GoogleChrome/puppeteer/issues/3327")]
+        [Fact]
         public async Task ShouldWorkWhenRedefiningTopLevelEventClass()
         {
             await Page.GoToAsync(TestConstants.ServerUrl + "/input/select.html");

lib/PuppeteerSharp/ContextPayload.cs

@@ -6,5 +6,6 @@ internal class ContextPayload
     {
         public int Id { get; set; }
         public ContextPayloadAuxData AuxData { get; set; }
+        public string Name { get; set; }
     }
 }

lib/PuppeteerSharp/ContextPayloadAuxData.cs

@@ -6,5 +6,6 @@ internal class ContextPayloadAuxData
     {
         public string FrameId { get; set; }
         public bool IsDefault { get; set; }
+        public DOMWorldType Type { get; set; }
     }
 }

lib/PuppeteerSharp/DOMWorld.cs

@@ -10,19 +10,17 @@ namespace PuppeteerSharp
     internal class DOMWorld
     {
         private readonly FrameManager _frameManager;
-        private readonly Frame _frame;
-
         private bool _detached;
-
         private TaskCompletionSource<ExecutionContext> _contextResolveTaskWrapper;
         private TaskCompletionSource<ElementHandle> _documentCompletionSource;
 
         internal List<WaitTask> WaitTasks;
+        internal Frame Frame { get; }
 
         public DOMWorld(FrameManager frameManager, Frame frame)
         {
             _frameManager = frameManager;
-            _frame = frame;
+            Frame = frame;
 
             SetContext(null);
 
@@ -60,7 +58,7 @@ internal Task<ExecutionContext> GetExecutionContextAsync()
         {
             if (_detached)
             {
-                throw new PuppeteerException($"Execution Context is not available in detached frame \"{_frame.Url}\"(are you trying to evaluate?)");
+                throw new PuppeteerException($"Execution Context is not available in detached frame \"{Frame.Url}\"(are you trying to evaluate?)");
             }
             return _contextResolveTaskWrapper.Task;
         }
@@ -142,7 +140,7 @@ await EvaluateFunctionAsync(@"html => {
                 document.close();
             }", html).ConfigureAwait(false);
 
-            var watcher = new LifecycleWatcher(_frameManager, _frame, waitUntil, timeout);
+            var watcher = new LifecycleWatcher(_frameManager, Frame, waitUntil, timeout);
             var watcherTask = await Task.WhenAny(
                 watcher.TimeoutOrTerminationTask,
                 watcher.LifecycleTask).ConfigureAwait(false);

lib/PuppeteerSharp/DOMWorldType.cs

@@ -0,0 +1,14 @@
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using PuppeteerSharp.Helpers.Json;
+
+namespace PuppeteerSharp
+{
+    [JsonConverter(typeof(FlexibleStringEnumConverter), Other)]
+    internal enum DOMWorldType
+    {
+        Other,
+        [EnumMember(Value = "isolated")]
+        Isolated
+    }
+}

lib/PuppeteerSharp/ExecutionContext.cs

@@ -24,14 +24,16 @@ public class ExecutionContext
         private readonly CDPSession _client;
         private readonly int _contextId;
 
+        internal DOMWorld World { get; }
+
         internal ExecutionContext(
             CDPSession client,
             ContextPayload contextPayload,
-            Frame frame)
+            DOMWorld world)
         {
             _client = client;
             _contextId = contextPayload.Id;
-            Frame = frame;
+            World = world;
         }
 
         /// <summary>
@@ -40,7 +42,7 @@ internal ExecutionContext(
         /// <remarks>
         /// NOTE Not every execution context is associated with a frame. For example, workers and extensions have execution contexts that are not associated with frames.
         /// </remarks>
-        public Frame Frame { get; }
+        public Frame Frame => World?.Frame;
 
         /// <summary>
         /// Executes a script in browser context

lib/PuppeteerSharp/Frame.cs

@@ -19,6 +19,9 @@ internal class FrameManager
         private readonly ConcurrentDictionary<string, Frame> _frames;
         private const string RefererHeaderName = "referer";
         private readonly AsyncDictionaryHelper<string, Frame> _asyncFrames;
+        private readonly List<string> _isolatedWorlds = new List<string>();
+
+        private const string UtilityWorldName = "__puppeteer_utility_world__";
 
         private FrameManager(CDPSession client, Page page, NetworkManager networkManager)
         {
@@ -215,8 +218,12 @@ private void OnExecutionContextsCleared()
             while (_contextIdToContext.Count > 0)
             {
                 var contextItem = _contextIdToContext.ElementAt(0);
-                RemoveContext(contextItem.Value);
                 _contextIdToContext.Remove(contextItem.Key);
+
+                if (contextItem.Value.World != null)
+                {
+                    contextItem.Value.World.SetContext(null);
+                }
             }
         }
 
@@ -227,26 +234,41 @@ private void OnExecutionContextDestroyed(int executionContextId)
             if (context != null)
             {
                 _contextIdToContext.Remove(executionContextId);
-                RemoveContext(context);
+
+                if (context.World != null)
+                {
+                    context.World.SetContext(null);
+                }
             }
         }
 
         private async Task OnExecutionContextCreatedAsync(ContextPayload contextPayload)
         {
-            var frameId = contextPayload.AuxData.IsDefault ? contextPayload.AuxData.FrameId : null;
-            var frame = !string.IsNullOrEmpty(frameId) ? await GetFrameAsync(frameId) : null;
-
-            var context = new ExecutionContext(
-                Client,
-                contextPayload,
-                frame);
-
-            _contextIdToContext[contextPayload.Id] = context;
+            var frameId = contextPayload.AuxData?.FrameId;
+            var frame = !string.IsNullOrEmpty(frameId) ? await GetFrameAsync(frameId).ConfigureAwait(false) : null;
+            DOMWorld world = null;
 
             if (frame != null)
             {
-                frame.AddExecutionContext(context);
+                if (contextPayload.AuxData?.IsDefault == true)
+                {
+                    world = frame.MainWorld;
+                }
+                else if (contextPayload.Name == UtilityWorldName)
+                {
+                    world = frame.SecondaryWorld;
+                }
+            }
+            if (contextPayload.AuxData?.Type == DOMWorldType.Isolated)
+            {
+                _isolatedWorlds.Add(contextPayload.Name);
             }
+            var context = new ExecutionContext(Client, contextPayload, world);
+            if (world != null)
+            {
+                world.SetContext(context);
+            }
+            _contextIdToContext[contextPayload.Id] = context;
         }
 
         private void OnFrameDetached(BasicFrameResponse e)
@@ -314,14 +336,6 @@ private void OnFrameNavigatedWithinDocument(NavigatedWithinDocumentResponse e)
             }
         }
 
-        private void RemoveContext(ExecutionContext context)
-        {
-            if (context.Frame != null)
-            {
-                context.Frame.RemoveExecutionContext();
-            }
-        }
-
         private void RemoveFramesRecursively(Frame frame)
         {
             while (frame.ChildFrames.Count > 0)
@@ -365,6 +379,28 @@ private async Task HandleFrameTreeAsync(FrameTree frameTree)
             }
         }
 
+        internal Task EnsureSecondaryDOMWorldAsync() => EnsureSecondaryDOMWorldAsync(UtilityWorldName);
+
+        internal async Task EnsureSecondaryDOMWorldAsync(string name)
+        {
+            if (_isolatedWorlds.Contains(name))
+            {
+                return;
+            }
+            _isolatedWorlds.Add(name);
+            await Client.SendAsync("Page.addScriptToEvaluateOnNewDocument", new PageAddScriptToEvaluateOnNewDocumentRequest
+            {
+                Source = $"//# sourceURL={ExecutionContext.EvaluationScriptUrl}",
+                WorldName = name,
+            });
+            await Task.WhenAll(GetFrames().Select(frame => Client.SendAsync("Page.createIsolatedWorld", new PageCreateIsolatedWorldRequest
+            {
+                FrameId = frame.Id,
+                GrantUniveralAccess = true,
+                WorldName = name
+            }))).ConfigureAwait(false);
+        }
+
         internal Task<Frame> GetFrameAsync(string frameId) => _asyncFrames.GetItemAsync(frameId);
 
         #endregion

lib/PuppeteerSharp/FrameManager.cs

@@ -3,5 +3,6 @@
     internal class PageAddScriptToEvaluateOnNewDocumentRequest
     {
         public string Source { get; set; }
+        public string WorldName { get; set; }
     }
 }

lib/PuppeteerSharp/Messaging/PageAddScriptToEvaluateOnNewDocumentRequest.cs

@@ -0,0 +1,9 @@
+namespace PuppeteerSharp.Messaging
+{
+    internal class PageCreateIsolatedWorldRequest
+    {
+        public string FrameId { get; set; }
+        public string WorldName { get; set; }
+        public bool GrantUniveralAccess { get; set; }
+    }
+}