fix: restrict access to _activeInvocations in concurrent RouteHandler methods … (#2887)

Author: Brimerland

src/Playwright.Tests/BrowserContextRouteTests.cs

@@ -177,6 +177,44 @@ await page.RouteAsync("**/non-empty.html", (route) =>
         Assert.AreEqual("context", await response.TextAsync());
     }
 
+
+    [PlaywrightTest("browsercontext-route.spec.ts", "should not throw on concurrent requests")]
+    public async Task ShouldNotThrowOnConcurrentRequest()
+    {
+        await using var context = await Browser.NewContextAsync();
+
+        // provide an html page which performs a high load of requests
+        await context.RouteAsync("**/empty.html", async (route) =>
+        {
+            await route.FulfillAsync(new()
+            {
+                Status = (int)HttpStatusCode.OK,
+                Body = @"<script>document.addEventListener('DOMContentLoaded', async () => { while (true) { await fetch('test.json') }})</script>"
+            });
+        });
+
+        // provide a simple json to fulfill the requests
+        await context.RouteAsync("**/test.json", async (route) =>
+        {
+            await route.FulfillAsync(new()
+            {
+                Status = (int)HttpStatusCode.OK,
+                Body = @"[]"
+            });
+        });
+
+
+        // open 10 pages to generate load on the RouteHandler
+        foreach (int pageNr in Enumerable.Range(0, 10))
+            await (await context.NewPageAsync())
+                .GotoAsync(Server.EmptyPage);
+
+        // let the test run for 5 second
+        await Task.Delay(5000);
+
+        // unobserved task exceptions are automatically collected by the PlaywrightTest attribute
+    }
+
     [PlaywrightTest("browsercontext-route.spec.ts", "should support the times parameter with route matching")]
     public async Task ShouldSupportTheTimesParameterWithRouteMatching()
     {

src/Playwright/Core/RouteHandler.cs

@@ -23,6 +23,7 @@
  */
 
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
@@ -32,7 +33,7 @@ namespace Microsoft.Playwright.Core;
 
 internal class RouteHandler
 {
-    private readonly HashSet<HandlerInvocation> _activeInvocations = new HashSet<HandlerInvocation>();
+    private readonly IDictionary<HandlerInvocation, bool> _activeInvocations = new ConcurrentDictionary<HandlerInvocation, bool>();
 
     private bool _ignoreException;
 
@@ -88,7 +89,7 @@ public async Task<bool> HandleAsync(Route route)
             Complete = new TaskCompletionSource<bool>(),
             Route = route,
         };
-        _activeInvocations.Add(handlerInvocation);
+        _activeInvocations[handlerInvocation] = false;
         try
         {
             return await HandleInternalAsync(route).ConfigureAwait(false);
@@ -122,7 +123,7 @@ public async Task StopAsync(UnrouteBehavior behavior)
         else
         {
             var tasks = new List<Task>();
-            foreach (var activation in _activeInvocations)
+            foreach (var activation in _activeInvocations.Keys)
             {
                 if (!activation.Route.DidThrow)
                 {