BREAKING: Use target for filters (#2319)

kblok · web-flow · commit 54ac49c0129b · 2023-09-20T13:52:34.000Z
* Use target for filters

* fix a test
diff --git a/lib/PuppeteerSharp.Tests/LauncherTests/PuppeteerConnectTests.cs b/lib/PuppeteerSharp.Tests/LauncherTests/PuppeteerConnectTests.cs
@@ -99,7 +99,7 @@ public async Task ShouldSupportTargetFilter()
 
                 var browser = await Puppeteer.ConnectAsync(new ConnectOptions {
                     BrowserWSEndpoint = originalBrowser.WebSocketEndpoint,
-                    TargetFilter = (TargetInfo targetInfo) => !targetInfo.Url.Contains("should-be-ignored"),
+                    TargetFilter = (Target target) => !target.Url.Contains("should-be-ignored"),
                 }, TestConstants.LoggerFactory);
 
                 var pages = await browser.PagesAsync();
diff --git a/lib/PuppeteerSharp/Browser.cs b/lib/PuppeteerSharp/Browser.cs
@@ -21,7 +21,7 @@ public class Browser : IBrowser
 
         private readonly ConcurrentDictionary<string, BrowserContext> _contexts;
         private readonly ILogger<Browser> _logger;
-        private readonly Func<TargetInfo, bool> _targetFilterCallback;
+        private readonly Func<Target, bool> _targetFilterCallback;
         private readonly BrowserContext _defaultContext;
         private readonly CustomQueriesManager _customQueriesManager = new();
         private Task _closeTask;
@@ -33,18 +33,18 @@ internal Browser(
             bool ignoreHTTPSErrors,
             ViewPortOptions defaultViewport,
             LauncherBase launcher,
-            Func<TargetInfo, bool> targetFilter = null,
-            Func<TargetInfo, bool> isPageTargetFunc = null)
+            Func<Target, bool> targetFilter = null,
+            Func<Target, bool> isPageTargetFunc = null)
         {
             IgnoreHTTPSErrors = ignoreHTTPSErrors;
             DefaultViewport = defaultViewport;
             Launcher = launcher;
             Connection = connection;
-            _targetFilterCallback = targetFilter ?? ((TargetInfo _) => true);
+            _targetFilterCallback = targetFilter ?? ((Target _) => true);
             _logger = Connection.LoggerFactory.CreateLogger<Browser>();
             IsPageTargetFunc =
                 isPageTargetFunc ??
-                new Func<TargetInfo, bool>((TargetInfo target) =>
+                new Func<Target, bool>((Target target) =>
                 {
                     return
                         target.Type == TargetType.Page ||
@@ -139,7 +139,7 @@ public bool IsClosed
 
         internal ITargetManager TargetManager { get; }
 
-        internal Func<TargetInfo, bool> IsPageTargetFunc { get; set; }
+        internal Func<Target, bool> IsPageTargetFunc { get; set; }
 
         /// <inheritdoc/>
         public Task<IPage> NewPageAsync() => _defaultContext.NewPageAsync();
@@ -269,8 +269,8 @@ internal static async Task<Browser> CreateAsync(
             bool ignoreHTTPSErrors,
             ViewPortOptions defaultViewPort,
             LauncherBase launcher,
-            Func<TargetInfo, bool> targetFilter = null,
-            Func<TargetInfo, bool> isPageTargetCallback = null,
+            Func<Target, bool> targetFilter = null,
+            Func<Target, bool> isPageTargetCallback = null,
             Action<IBrowser> initAction = null)
         {
             var browser = new Browser(
@@ -475,7 +475,14 @@ private Target CreateTarget(TargetInfo targetInfo, CDPSession session)
 
             Func<bool, Task<CDPSession>> createSession = (bool isAutoAttachEmulated) => Connection.CreateSessionAsync(targetInfo, isAutoAttachEmulated);
 
-            if (IsPageTargetFunc(targetInfo))
+            var otherTarget = new OtherTarget(
+                targetInfo,
+                session,
+                context,
+                TargetManager,
+                createSession);
+
+            if (IsPageTargetFunc(otherTarget))
             {
                 return new PageTarget(
                     targetInfo,
@@ -498,12 +505,7 @@ private Target CreateTarget(TargetInfo targetInfo, CDPSession session)
                     createSession);
             }
 
-            return new OtherTarget(
-                targetInfo,
-                session,
-                context,
-                TargetManager,
-                createSession);
+            return otherTarget;
         }
     }
 }
diff --git a/lib/PuppeteerSharp/BrowserContext.cs b/lib/PuppeteerSharp/BrowserContext.cs
@@ -52,7 +52,7 @@ public async Task<IPage[]> PagesAsync()
             Targets()
                 .Where(t =>
                     t.Type == TargetType.Page ||
-                    (t.Type == TargetType.Other && Browser.IsPageTargetFunc((t as Target).TargetInfo)))
+                    (t.Type == TargetType.Other && Browser.IsPageTargetFunc(t as Target)))
                 .Select(t => t.PageAsync())).ConfigureAwait(false))
             .Where(p => p != null).ToArray();
 
diff --git a/lib/PuppeteerSharp/ChromeTargetManager.cs b/lib/PuppeteerSharp/ChromeTargetManager.cs
@@ -17,7 +17,7 @@ internal class ChromeTargetManager : ITargetManager
         private readonly List<string> _ignoredTargets = new();
         private readonly Connection _connection;
         private readonly Func<TargetInfo, CDPSession, Target> _targetFactoryFunc;
-        private readonly Func<TargetInfo, bool> _targetFilterFunc;
+        private readonly Func<Target, bool> _targetFilterFunc;
         private readonly ILogger<ChromeTargetManager> _logger;
         private readonly AsyncDictionaryHelper<string, Target> _attachedTargetsByTargetId = new("Target {0} not found");
         private readonly ConcurrentDictionary<string, Target> _attachedTargetsBySessionId = new();
@@ -33,7 +33,7 @@ internal class ChromeTargetManager : ITargetManager
         public ChromeTargetManager(
             Connection connection,
             Func<TargetInfo, CDPSession, Target> targetFactoryFunc,
-            Func<TargetInfo, bool> targetFilterFunc,
+            Func<Target, bool> targetFilterFunc,
             int targetDiscoveryTimeout = 0)
         {
             _connection = connection;
@@ -119,7 +119,14 @@ private void StoreExistingTargetsForInit()
         {
             foreach (var kv in _discoveredTargetsByTargetId)
             {
-                if ((_targetFilterFunc == null || _targetFilterFunc(kv.Value)) &&
+                var targetForFilter = new Target(
+                    kv.Value,
+                    null,
+                    null,
+                    this,
+                    null);
+
+                if ((_targetFilterFunc == null || _targetFilterFunc(targetForFilter)) &&
                     kv.Value.Type != TargetType.Browser)
                 {
                     _targetsIdsForInit.Add(kv.Key);
@@ -286,7 +293,13 @@ await parent.SendAsync(
                 return;
             }
 
-            if (_targetFilterFunc?.Invoke(targetInfo) == false)
+            var existingTarget = _attachedTargetsByTargetId.TryGetValue(targetInfo.TargetId, out var target);
+            if (!existingTarget)
+            {
+                target = _targetFactoryFunc(targetInfo, session);
+            }
+
+            if (_targetFilterFunc?.Invoke(target) == false)
             {
                 _ignoredTargets.Add(targetInfo.TargetId);
                 await EnsureTargetsIdsForInitAsync().ConfigureAwait(false);
@@ -295,12 +308,6 @@ await parent.SendAsync(
                 return;
             }
 
-            var existingTarget = _attachedTargetsByTargetId.TryGetValue(targetInfo.TargetId, out var target);
-            if (!existingTarget)
-            {
-                target = _targetFactoryFunc(targetInfo, session);
-            }
-
             session.MessageReceived += OnMessageReceived;
 
             if (existingTarget)
diff --git a/lib/PuppeteerSharp/ConnectOptions.cs b/lib/PuppeteerSharp/ConnectOptions.cs
@@ -89,7 +89,7 @@ public class ConnectOptions : IBrowserOptions, IConnectionOptions
         /// <summary>
         /// Callback to decide if Puppeteer should connect to a given target or not.
         /// </summary>
-        public Func<TargetInfo, bool> TargetFilter { get; set; }
+        public Func<Target, bool> TargetFilter { get; set; }
 
         /// <summary>
         /// Optional callback to initialize properties as soon as the <see cref="IBrowser"/> instance is created, i.e., set up event handlers.
diff --git a/lib/PuppeteerSharp/FirefoxTargetManager.cs b/lib/PuppeteerSharp/FirefoxTargetManager.cs
@@ -14,7 +14,7 @@ internal class FirefoxTargetManager : ITargetManager
     {
         private readonly Connection _connection;
         private readonly Func<TargetInfo, CDPSession, Target> _targetFactoryFunc;
-        private readonly Func<TargetInfo, bool> _targetFilterFunc;
+        private readonly Func<Target, bool> _targetFilterFunc;
         private readonly ILogger<FirefoxTargetManager> _logger;
         private readonly ConcurrentDictionary<ICDPConnection, List<TargetInterceptor>> _targetInterceptors = new();
         private readonly AsyncDictionaryHelper<string, Target> _availableTargetsByTargetId = new("Target {0} not found");
@@ -27,7 +27,7 @@ internal class FirefoxTargetManager : ITargetManager
         public FirefoxTargetManager(
             Connection connection,
             Func<TargetInfo, CDPSession, Target> targetFactoryFunc,
-            Func<TargetInfo, bool> targetFilterFunc)
+            Func<Target, bool> targetFilterFunc)
         {
             _connection = connection;
             _targetFilterFunc = targetFilterFunc;
@@ -121,14 +121,14 @@ private void OnTargetCreated(TargetCreatedResponse e)
                 FinishInitializationIfReady(e.TargetInfo.TargetId);
             }
 
-            if (_targetFilterFunc != null && !_targetFilterFunc(e.TargetInfo))
+            var target = _targetFactoryFunc(e.TargetInfo, null);
+            if (_targetFilterFunc != null && !_targetFilterFunc(target))
             {
                 _ignoredTargets.Add(e.TargetInfo.TargetId);
                 FinishInitializationIfReady(e.TargetInfo.TargetId);
                 return;
             }
 
-            var target = _targetFactoryFunc(e.TargetInfo, null);
             _availableTargetsByTargetId.AddItem(e.TargetInfo.TargetId, target);
             TargetAvailable?.Invoke(
                 this,
diff --git a/lib/PuppeteerSharp/IConnectionOptions.cs b/lib/PuppeteerSharp/IConnectionOptions.cs
@@ -50,6 +50,6 @@ public interface IConnectionOptions
         /// <summary>
         /// Callback to decide if Puppeteer should connect to a given target or not.
         /// </summary>
-        public Func<TargetInfo, bool> TargetFilter { get; set; }
+        public Func<Target, bool> TargetFilter { get; set; }
     }
 }
diff --git a/lib/PuppeteerSharp/LaunchOptions.cs b/lib/PuppeteerSharp/LaunchOptions.cs
@@ -186,6 +186,6 @@ public string[] IgnoredDefaultArgs
         /// <summary>
         /// Callback to decide if Puppeteer should connect to a given target or not.
         /// </summary>
-        public Func<TargetInfo, bool> TargetFilter { get; set; }
+        public Func<Target, bool> TargetFilter { get; set; }
     }
 }
diff --git a/lib/PuppeteerSharp/PuppeteerSharp.csproj b/lib/PuppeteerSharp/PuppeteerSharp.csproj
@@ -12,10 +12,10 @@
     <Description>Headless Browser .NET API</Description>
     <PackageId>PuppeteerSharp</PackageId>
     <PackageReleaseNotes></PackageReleaseNotes>
-    <PackageVersion>11.0.6</PackageVersion>
-    <ReleaseVersion>11.0.6</ReleaseVersion>
-    <AssemblyVersion>11.0.6</AssemblyVersion>
-    <FileVersion>11.0.6</FileVersion>
+    <PackageVersion>12.0.0</PackageVersion>
+    <ReleaseVersion>12.0.0</ReleaseVersion>
+    <AssemblyVersion>12.0.0</AssemblyVersion>
+    <FileVersion>12.0.0</FileVersion>
     <SynchReleaseVersion>false</SynchReleaseVersion>
     <StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings>
     <DebugType>embedded</DebugType>

Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,6 @@ public interface IConnectionOptions`
`50`	`50`	`/// <summary>`
`51`	`51`	`/// Callback to decide if Puppeteer should connect to a given target or not.`
`52`	`52`	`/// </summary>`
`53`		`- public Func<TargetInfo, bool> TargetFilter { get; set; }`
	`53`	`+ public Func<Target, bool> TargetFilter { get; set; }`
`54`	`54`	`}`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -186,6 +186,6 @@ public string[] IgnoredDefaultArgs`
`186`	`186`	`/// <summary>`
`187`	`187`	`/// Callback to decide if Puppeteer should connect to a given target or not.`
`188`	`188`	`/// </summary>`
`189`		`- public Func<TargetInfo, bool> TargetFilter { get; set; }`
	`189`	`+ public Func<Target, bool> TargetFilter { get; set; }`
`190`	`190`	`}`
`191`	`191`	`}`