Annotate CDP as fully AOT-unsafe

Author: RenderMichael

dotnet/src/webdriver/Chromium/ChromiumDriver.cs

@@ -22,6 +22,7 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Threading.Tasks;
 
@@ -278,6 +279,8 @@ public object ExecuteCdpCommand(string commandName, Dictionary<string, object> c
         /// Creates a session to communicate with a browser using the Chromium Developer Tools debugging protocol.
         /// </summary>
         /// <returns>The active session to use to communicate with the Chromium Developer Tools debugging protocol.</returns>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         public DevToolsSession GetDevToolsSession()
         {
             return GetDevToolsSession(new DevToolsOptions() { ProtocolVersion = DevToolsSession.AutoDetectDevToolsProtocolVersion });
@@ -287,6 +290,8 @@ public DevToolsSession GetDevToolsSession()
         /// Creates a session to communicate with a browser using the Chromium Developer Tools debugging protocol.
         /// </summary>
         /// <returns>The active session to use to communicate with the Chromium Developer Tools debugging protocol.</returns>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         public DevToolsSession GetDevToolsSession(DevToolsOptions options)
         {
             if (this.devToolsSession == null)
@@ -329,6 +334,8 @@ public DevToolsSession GetDevToolsSession(DevToolsOptions options)
         /// <param name="devToolsProtocolVersion">The version of the Chromium Developer Tools protocol to use. Defaults to autodetect the protocol version.</param>
         /// <returns>The active session to use to communicate with the Chromium Developer Tools debugging protocol.</returns>
         [Obsolete("Use GetDevToolsSession(DevToolsOptions options)")]
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         public DevToolsSession GetDevToolsSession(int devToolsProtocolVersion)
         {
             return GetDevToolsSession(new DevToolsOptions() { ProtocolVersion = devToolsProtocolVersion });

dotnet/src/webdriver/DevTools/DevToolsSession.cs

@@ -34,6 +34,8 @@ namespace OpenQA.Selenium.DevTools
     /// Represents a WebSocket connection to a running DevTools instance that can be used to send
     /// commands and recieve events.
     ///</summary>
+    [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+    [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
     public class DevToolsSession : IDevToolsSession
     {
         /// <summary>
@@ -149,8 +151,6 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains
         /// <param name="millisecondsTimeout">The execution timeout of the command in milliseconds.</param>
         /// <param name="throwExceptionIfResponseNotReceived"><see langword="true"/> to throw an exception if a response is not received; otherwise, <see langword="false"/>.</param>
         /// <returns>The command response object implementing the <see cref="ICommandResponse{T}"/> interface.</returns>
-        [RequiresUnreferencedCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
-        [RequiresDynamicCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
         public async Task<ICommandResponse<TCommand>> SendCommand<TCommand>(TCommand command, CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
             where TCommand : ICommand
         {
@@ -184,8 +184,6 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains
         /// <param name="millisecondsTimeout">The execution timeout of the command in milliseconds.</param>
         /// <param name="throwExceptionIfResponseNotReceived"><see langword="true"/> to throw an exception if a response is not received; otherwise, <see langword="false"/>.</param>
         /// <returns>The command response object implementing the <see cref="ICommandResponse{T}"/> interface.</returns>
-        [RequiresUnreferencedCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
-        [RequiresDynamicCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
         public async Task<ICommandResponse<TCommand>> SendCommand<TCommand>(TCommand command, string sessionId, CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
             where TCommand : ICommand
         {
@@ -219,8 +217,6 @@ public T GetVersionSpecificDomains<T>() where T : DevToolsSessionDomains
         /// <param name="millisecondsTimeout">The execution timeout of the command in milliseconds.</param>
         /// <param name="throwExceptionIfResponseNotReceived"><see langword="true"/> to throw an exception if a response is not received; otherwise, <see langword="false"/>.</param>
         /// <returns>The command response object implementing the <see cref="ICommandResponse{T}"/> interface.</returns>
-        [RequiresUnreferencedCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
-        [RequiresDynamicCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
         public async Task<TCommandResponse> SendCommand<TCommand, TCommandResponse>(TCommand command, CancellationToken cancellationToken = default(CancellationToken), int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)
             where TCommand : ICommand
             where TCommandResponse : ICommandResponse<TCommand>

dotnet/src/webdriver/DevTools/IDevTools.cs

@@ -18,6 +18,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 namespace OpenQA.Selenium.DevTools
 {
@@ -35,13 +36,17 @@ public interface IDevTools
         /// Creates a session to communicate with a browser using a Developer Tools debugging protocol.
         /// </summary>
         /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         DevToolsSession GetDevToolsSession();
 
         /// <summary>
         /// Creates a session to communicate with a browser using a specific version of the Developer Tools debugging protocol.
         /// </summary>
         /// <param name="options">The options for the DevToolsSession to use.</param>
         /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         DevToolsSession GetDevToolsSession(DevToolsOptions options);
 
         /// <summary>
@@ -50,11 +55,15 @@ public interface IDevTools
         /// <param name="protocolVersion">The specific version of the Developer Tools debugging protocol to use.</param>
         /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
         [Obsolete("Use GetDevToolsSession(DevToolsOptions options)")]
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         DevToolsSession GetDevToolsSession(int protocolVersion);
 
         /// <summary>
         /// Closes a DevTools session
         /// </summary>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         void CloseDevToolsSession();
     }
 }

dotnet/src/webdriver/DevTools/IDevToolsSession.cs

@@ -60,8 +60,8 @@ public interface IDevToolsSession : IDisposable
         /// <param name="millisecondsTimeout">The execution timeout of the command in milliseconds.</param>
         /// <param name="throwExceptionIfResponseNotReceived"><see langword="true"/> to throw an exception if a response is not received; otherwise, <see langword="false"/>.</param>
         /// <returns>The command response object implementing the <see cref="ICommandResponse{T}"/> interface.</returns>
-        [RequiresUnreferencedCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
-        [RequiresDynamicCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         Task<ICommandResponse<TCommand>> SendCommand<TCommand>(TCommand command, CancellationToken cancellationToken, int? millisecondsTimeout, bool throwExceptionIfResponseNotReceived)
             where TCommand : ICommand;
 
@@ -75,8 +75,8 @@ Task<ICommandResponse<TCommand>> SendCommand<TCommand>(TCommand command, Cancell
         /// <param name="millisecondsTimeout">The execution timeout of the command in milliseconds.</param>
         /// <param name="throwExceptionIfResponseNotReceived"><see langword="true"/> to throw an exception if a response is not received; otherwise, <see langword="false"/>.</param>
         /// <returns>The command response object implementing the <see cref="ICommandResponse{T}"/> interface.</returns>
-        [RequiresUnreferencedCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
-        [RequiresDynamicCode("SendCommand is not compatible with trimming or AOT. Use the overload that takes JsonNode parameters instead")]
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         Task<TCommandResponse> SendCommand<TCommand, TCommandResponse>(TCommand command, CancellationToken cancellationToken, int? millisecondsTimeout, bool throwExceptionIfResponseNotReceived)
             where TCommand : ICommand
             where TCommandResponse : ICommandResponse<TCommand>;
@@ -90,6 +90,8 @@ Task<TCommandResponse> SendCommand<TCommand, TCommandResponse>(TCommand command,
         /// <param name="millisecondsTimeout">The execution timeout of the command in milliseconds.</param>
         /// <param name="throwExceptionIfResponseNotReceived"><see langword="true"/> to throw an exception if a response is not received; otherwise, <see langword="false"/>.</param>
         /// <returns>The command response object implementing the <see cref="ICommandResponse{T}"/> interface.</returns>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         Task<JsonElement?> SendCommand(string commandName, JsonNode @params, CancellationToken cancellationToken, int? millisecondsTimeout, bool throwExceptionIfResponseNotReceived);
     }
 }

dotnet/src/webdriver/INetwork.cs

@@ -18,6 +18,7 @@
 // </copyright>
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium
@@ -77,12 +78,16 @@ public interface INetwork
         /// Asynchronously starts monitoring for network traffic.
         /// </summary>
         /// <returns>A task that represents the asynchronous operation.</returns>
+        [RequiresUnreferencedCode("Network monitoring is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported")]
+        [RequiresDynamicCode("Network monitoring is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported.")]
         Task StartMonitoring();
 
         /// <summary>
         /// Asynchronously stops monitoring for network traffic.
         /// </summary>
         /// <returns>A task that represents the asynchronous operation.</returns>
+        [RequiresUnreferencedCode("Network monitoring is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported")]
+        [RequiresDynamicCode("Network monitoring is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported.")]
         Task StopMonitoring();
     }
 }

dotnet/src/webdriver/JavaScriptEngine.cs

@@ -21,6 +21,7 @@
 using OpenQA.Selenium.Internal;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.IO;
 using System.Linq;
@@ -32,6 +33,8 @@ namespace OpenQA.Selenium
     /// <summary>
     /// Provides methods allowing the user to manage settings in the browser's JavaScript engine.
     /// </summary>
+    [RequiresUnreferencedCode("JavaScriptEngine is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported")]
+    [RequiresDynamicCode("JavaScriptEngine is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported.")]
     public class JavaScriptEngine : IJavaScriptEngine
     {
         private readonly string MonitorBindingName = "__webdriver_attribute";

dotnet/src/webdriver/NetworkManager.cs

@@ -20,6 +20,7 @@
 using OpenQA.Selenium.DevTools;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium
@@ -38,6 +39,8 @@ public class NetworkManager : INetwork
         /// Initializes a new instance of the <see cref="NetworkManager"/> class.
         /// </summary>
         /// <param name="driver">The <see cref="IWebDriver"/> instance on which the network should be monitored.</param>
+        [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "Warnings are added to StartMonitoring and StopMonitoring")]
+        [UnconditionalSuppressMessage("Trimming", "IL3050", Justification = "Warnings are added to StartMonitoring and StopMonitoring")]
         public NetworkManager(IWebDriver driver)
         {
             // Use of Lazy<T> means this exception won't be thrown until the user first
@@ -69,6 +72,8 @@ public NetworkManager(IWebDriver driver)
         /// Asynchronously starts monitoring for network traffic.
         /// </summary>
         /// <returns>A task that represents the asynchronous operation.</returns>
+        [RequiresUnreferencedCode("NetworkManager is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported")]
+        [RequiresDynamicCode("NetworkManager is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported.")]
         public async Task StartMonitoring()
         {
             this.session.Value.Domains.Network.RequestPaused += OnRequestPaused;
@@ -83,6 +88,8 @@ public async Task StartMonitoring()
         /// Asynchronously stops monitoring for network traffic.
         /// </summary>
         /// <returns>A task that represents the asynchronous operation.</returns>
+        [RequiresUnreferencedCode("Network monitoring is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported")]
+        [RequiresDynamicCode("Network monitoring is currently implemented with CDP. When it is implemented with BiDi, AOT will be supported.")]
         public async Task StopMonitoring()
         {
             this.session.Value.Domains.Network.ResponsePaused -= OnResponsePaused;

dotnet/src/webdriver/Remote/RemoteWebDriver.cs

@@ -26,6 +26,7 @@
 using System.IO.Compression;
 using System.Linq;
 using System.Threading.Tasks;
+using System.Diagnostics.CodeAnalysis;
 
 namespace OpenQA.Selenium.Remote
 {
@@ -426,6 +427,8 @@ public ReadOnlyCollection<IWebElement> FindElementsByCssSelector(string cssSelec
         /// Creates a session to communicate with a browser using a Developer Tools debugging protocol.
         /// </summary>
         /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         public DevToolsSession GetDevToolsSession()
         {
             if (this.Capabilities.GetCapability(CapabilityType.BrowserName) is "firefox")
@@ -443,6 +446,8 @@ public DevToolsSession GetDevToolsSession()
         /// Creates a session to communicate with a browser using a Developer Tools debugging protocol.
         /// </summary>
         /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         public DevToolsSession GetDevToolsSession(DevToolsOptions options)
         {
             if (options is null)
@@ -498,6 +503,8 @@ public DevToolsSession GetDevToolsSession(DevToolsOptions options)
         /// <param name="protocolVersion">The specific version of the Developer Tools debugging protocol to use.</param>
         /// <returns>The active session to use to communicate with the Developer Tools debugging protocol.</returns>
         [Obsolete("Use GetDevToolsSession(DevToolsOptions options)")]
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         public DevToolsSession GetDevToolsSession(int protocolVersion)
         {
             return GetDevToolsSession(new DevToolsOptions() { ProtocolVersion = protocolVersion });
@@ -576,6 +583,8 @@ public void DeleteDownloadableFiles()
         /// <summary>
         /// Closes a DevTools session.
         /// </summary>
+        [RequiresUnreferencedCode("CDP is not compatible with trimming or AOT.")]
+        [RequiresDynamicCode("CDP is not compatible with trimming or AOT.")]
         public void CloseDevToolsSession()
         {
             if (this.devToolsSession != null)

dotnet/src/webdriver/Response.cs

@@ -20,6 +20,7 @@
 using OpenQA.Selenium.Internal;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Text.Json;
 using System.Text.Json.Serialization;
@@ -210,6 +211,9 @@ public static Response FromErrorJson(string value)
         /// Returns this object as a JSON-encoded string.
         /// </summary>
         /// <returns>A JSON-encoded string representing this <see cref="Response"/> object.</returns>
+
+        [RequiresUnreferencedCode("Free-form JSON serialization.")]
+        [RequiresDynamicCode("Free-form JSON serialization.")]
         public string ToJson()
         {
             return JsonSerializer.Serialize(this);