Skip to content

[dotnet] Fully annotate Command for AOT support #15527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 63 additions & 12 deletions dotnet/src/webdriver/Command.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
using OpenQA.Selenium.Internal;
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Text.Json.Serialization.Metadata;
Expand All @@ -31,24 +32,40 @@ namespace OpenQA.Selenium
/// </summary>
public class Command
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Best viewed with whitespace off

{
private readonly static JsonSerializerOptions s_jsonSerializerOptions = new()
[UnconditionalSuppressMessage("Trimming", "IL2026", Justification = $"All trimming-unsafe access points to {nameof(s_jsonSerializerOptions)} are annotated as such")]
[UnconditionalSuppressMessage("AOT", "IL3050", Justification = $"All AOT-unsafe access points to {nameof(s_jsonSerializerOptions)} are annotated as such")]
private static class JsonOptionsHolder
{
TypeInfoResolverChain =
public readonly static JsonSerializerOptions s_jsonSerializerOptions = new()
{
CommandJsonSerializerContext.Default,
new DefaultJsonTypeInfoResolver()
},
Converters = { new ResponseValueJsonConverter() }
};
TypeInfoResolver = GetTypeInfoResolver(),
Converters = { new ResponseValueJsonConverter() }
};

private static IJsonTypeInfoResolver GetTypeInfoResolver()
{
#if NET8_0_OR_GREATER
if (!System.Runtime.CompilerServices.RuntimeFeature.IsDynamicCodeSupported)
{
return CommandJsonSerializerContext.Default;
}
#endif
return JsonTypeInfoResolver.Combine(CommandJsonSerializerContext.Default, new DefaultJsonTypeInfoResolver());
}
}

private readonly Dictionary<string, object?> _parameters;

/// <summary>
/// Initializes a new instance of the <see cref="Command"/> class using a command name and a JSON-encoded string for the parameters.
/// </summary>
/// <param name="name">Name of the command</param>
/// <param name="jsonParameters">Parameters for the command as a JSON-encoded string.</param>
public Command(string name, string jsonParameters)
: this(null, name, ConvertParametersFromJson(jsonParameters))
{
this.SessionId = null;
this._parameters = ConvertParametersFromJson(jsonParameters) ?? new Dictionary<string, object?>();
this.Name = name ?? throw new ArgumentNullException(nameof(name));
}

/// <summary>
Expand All @@ -61,7 +78,7 @@ public Command(string name, string jsonParameters)
public Command(SessionId? sessionId, string name, Dictionary<string, object?>? parameters)
{
this.SessionId = sessionId;
this.Parameters = parameters ?? new Dictionary<string, object?>();
this._parameters = parameters ?? new Dictionary<string, object?>();
this.Name = name ?? throw new ArgumentNullException(nameof(name));
}

Expand All @@ -81,18 +98,32 @@ public Command(SessionId? sessionId, string name, Dictionary<string, object?>? p
/// Gets the parameters of the command
/// </summary>
[JsonPropertyName("parameters")]
public Dictionary<string, object?> Parameters { get; }
public Dictionary<string, object?> Parameters
{
[RequiresUnreferencedCode("Adding untyped parameter values for JSON serialization has best-effort AOT support. Ensure only Selenium types and well-known .NET types are added.")]
[RequiresDynamicCode("Adding untyped parameter values for JSON serialization has best-effort AOT support. Ensure only Selenium types and well-known .NET types are added.")]
get => _parameters;
}

/// <summary>
/// Gets the parameters of the command as a JSON-encoded string.
/// </summary>
public string ParametersAsJsonString
{
[UnconditionalSuppressMessage("Trimming", "IL2026", Justification = $"All trimming-unsafe access points to {nameof(_parameters)} are annotated as such")]
[UnconditionalSuppressMessage("AOT", "IL3050", Justification = $"All AOT-unsafe access points to {nameof(_parameters)} are annotated as such")]
get
{
if (this.Parameters != null && this.Parameters.Count > 0)
if (HasParameters())
{
return JsonSerializer.Serialize(this.Parameters, s_jsonSerializerOptions);
try
{
return JsonSerializer.Serialize(this._parameters, JsonOptionsHolder.s_jsonSerializerOptions);
}
catch (NotSupportedException ex)
{
throw new WebDriverException("Attempted to serialize an unsupported type. Ensure you are using Selenium types, or well-known .NET types such as Dictionary<string, object> and object[]", ex);
}
}
else
{
Expand All @@ -101,6 +132,25 @@ public string ParametersAsJsonString
}
}

internal bool HasParameters()
{
return this._parameters != null && this._parameters.Count > 0;
}

internal bool TryGetValueAndRemoveIfNotNull(string key, [NotNullWhen(true)] out object? value)
{
if (this._parameters.TryGetValue(key, out value))
{
if (value is not null)
{
this._parameters.Remove(key);
return true;
}
}

return false;
}

/// <summary>
/// Returns a string of the Command object
/// </summary>
Expand Down Expand Up @@ -168,6 +218,7 @@ public override string ToString()
[JsonSerializable(typeof(Dictionary<string, short>))]
[JsonSerializable(typeof(Dictionary<string, ushort>))]
[JsonSerializable(typeof(Dictionary<string, string>))]
[JsonSerializable(typeof(object[]))]
[JsonSourceGenerationOptions(Converters = [typeof(ResponseValueJsonConverter)])]
internal partial class CommandJsonSerializerContext : JsonSerializerContext;
}
10 changes: 3 additions & 7 deletions dotnet/src/webdriver/HttpCommandInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -119,17 +119,13 @@ private static string GetCommandPropertyValue(string propertyName, Command comma
propertyValue = commandToExecute.SessionId.ToString();
}
}
else if (commandToExecute.Parameters != null && commandToExecute.Parameters.Count > 0)
else if (commandToExecute.HasParameters())
{
// Extract the URL parameter, and remove it from the parameters dictionary
// so it doesn't get transmitted as a JSON parameter.
if (commandToExecute.Parameters.TryGetValue(propertyName, out var propertyValueObject))
if (commandToExecute.TryGetValueAndRemoveIfNotNull(propertyName, out var propertyValueObject))
{
if (propertyValueObject != null)
{
propertyValue = propertyValueObject.ToString()!;
commandToExecute.Parameters.Remove(propertyName);
}
propertyValue = propertyValueObject.ToString()!;
}
}

Expand Down
2 changes: 1 addition & 1 deletion dotnet/src/webdriver/WebDriver.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class WebDriver : IWebDriver, ISearchContext, IJavaScriptExecutor, IFinds
/// </summary>
protected static readonly TimeSpan DefaultCommandTimeout = TimeSpan.FromSeconds(60);
private IFileDetector fileDetector = new DefaultFileDetector();
private NetworkManager network;
private NetworkManager? network;
private WebElementFactory elementFactory;

private readonly List<string> registeredCommands = new List<string>();
Expand Down
Loading