Skip to content

[dotnet] Annotate nullability on HttpCommandExecutor aside from Response #14871

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jan 17, 2025
Merged

[dotnet] Annotate nullability on HttpCommandExecutor aside from Response #14871

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3ca5ba7
[dotnet] Annotate nullability on `HttpCommandExecutor` aside from `Re…
RenderMichael Dec 6, 2024
312791e
Remove nullability annotation from `HttpCommandExecutor.CreateHttpCli…
RenderMichael Dec 6, 2024
546cb67
Merge branch 'trunk' into httpCommandExecutor
RenderMichael Dec 28, 2024
22e4bd9
Merge branch 'trunk' into httpCommandExecutor
RenderMichael Jan 16, 2025
68d2cd9
Merge branch 'trunk' into httpCommandExecutor
RenderMichael Jan 17, 2025
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
84 changes: 44 additions & 40 deletions dotnet/src/webdriver/Remote/HttpCommandExecutor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
using OpenQA.Selenium.Internal.Logging;
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Linq;
using System.Net;
Expand All @@ -43,12 +44,9 @@ public class HttpCommandExecutor : ICommandExecutor
private const string RequestAcceptHeader = JsonMimeType + ", " + PngMimeType;
private const string RequestContentTypeHeader = JsonMimeType + "; charset=" + Utf8CharsetType;
private const string UserAgentHeaderTemplate = "selenium/{0} (.net {1})";
private Uri remoteServerUri;
private TimeSpan serverResponseTimeout;
private string userAgent;
private bool enableKeepAlive;
private readonly Uri remoteServerUri;
private readonly TimeSpan serverResponseTimeout;
private bool isDisposed;
private IWebProxy proxy;
private CommandInfoRepository commandInfoRepository = new W3CWireProtocolCommandInfoRepository();
private HttpClient client;

Expand All @@ -71,6 +69,7 @@ public HttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout)
/// <param name="timeout">The timeout within which the server must respond.</param>
/// <param name="enableKeepAlive"><see langword="true"/> if the KeepAlive header should be sent
/// with HTTP requests; otherwise, <see langword="false"/>.</param>
/// <exception cref="ArgumentNullException">If <paramref name="addressOfRemoteServer"/> is <see langword="null"/>.</exception>
public HttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout, bool enableKeepAlive)
{
if (addressOfRemoteServer == null)
Expand All @@ -83,10 +82,10 @@ public HttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout, bool ena
addressOfRemoteServer = new Uri(addressOfRemoteServer.ToString() + "/");
}

this.userAgent = string.Format(CultureInfo.InvariantCulture, UserAgentHeaderTemplate, ResourceUtilities.ProductVersion, ResourceUtilities.PlatformFamily);
this.UserAgent = string.Format(CultureInfo.InvariantCulture, UserAgentHeaderTemplate, ResourceUtilities.ProductVersion, ResourceUtilities.PlatformFamily);
this.remoteServerUri = addressOfRemoteServer;
this.serverResponseTimeout = timeout;
this.enableKeepAlive = enableKeepAlive;
this.IsKeepAliveEnabled = enableKeepAlive;
}

/// <summary>
Expand All @@ -100,41 +99,30 @@ public HttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout, bool ena
/// between this <see cref="HttpCommandExecutor"/> and the remote end WebDriver
/// implementation.
/// </summary>
public IWebProxy Proxy
{
get { return this.proxy; }
set { this.proxy = value; }
}
public IWebProxy Proxy { get; set; }

/// <summary>
/// Gets or sets a value indicating whether keep-alive is enabled for HTTP
/// communication between this <see cref="HttpCommandExecutor"/> and the
/// remote end WebDriver implementation.
/// </summary>
public bool IsKeepAliveEnabled
{
get { return this.enableKeepAlive; }
set { this.enableKeepAlive = value; }
}
public bool IsKeepAliveEnabled { get; set; }

/// <summary>
/// Gets or sets the user agent string used for HTTP communication
/// batween this <see cref="HttpCommandExecutor"/> and the remote end
/// WebDriver implementation
/// </summary>
public string UserAgent
{
get { return this.userAgent; }
set { this.userAgent = value; }
}
public string UserAgent { get; set; }

/// <summary>
/// Gets the repository of objects containing information about commands.
/// </summary>
/// <exception cref="ArgumentNullException">If the value is set to <see langword="null"/>.</exception>
protected CommandInfoRepository CommandInfoRepository
{
get { return this.commandInfoRepository; }
set { this.commandInfoRepository = value; }
get => this.commandInfoRepository;
set => this.commandInfoRepository = value ?? throw new ArgumentNullException(nameof(value), "CommandInfoRepository cannot be null");
}

/// <summary>
Expand All @@ -145,8 +133,7 @@ protected CommandInfoRepository CommandInfoRepository
/// <returns><see langword="true"/> if the new command has been added successfully; otherwise, <see langword="false"/>.</returns>
public bool TryAddCommand(string commandName, CommandInfo info)
{
HttpCommandInfo commandInfo = info as HttpCommandInfo;
if (commandInfo == null)
if (info is not HttpCommandInfo commandInfo)
{
return false;
}
Expand Down Expand Up @@ -193,7 +180,7 @@ public virtual async Task<Response> ExecuteAsync(Command commandToExecute)
}

HttpRequestInfo requestInfo = new HttpRequestInfo(this.remoteServerUri, commandToExecute, info);
HttpResponseInfo responseInfo = null;
HttpResponseInfo responseInfo;
try
{
responseInfo = await this.MakeHttpRequest(requestInfo).ConfigureAwait(false);
Expand Down Expand Up @@ -236,6 +223,7 @@ protected virtual void OnSendingRemoteHttpRequest(SendingRemoteHttpRequestEventA
}
}

[MemberNotNull(nameof(client))]
private void CreateHttpClient()
{
HttpClientHandler httpClientHandler = new HttpClientHandler();
Expand Down Expand Up @@ -304,12 +292,11 @@ private async Task<HttpResponseInfo> MakeHttpRequest(HttpRequestInfo requestInfo

using (HttpResponseMessage responseMessage = await this.client.SendAsync(requestMessage).ConfigureAwait(false))
{
HttpResponseInfo httpResponseInfo = new HttpResponseInfo();
httpResponseInfo.Body = await responseMessage.Content.ReadAsStringAsync().ConfigureAwait(false);
httpResponseInfo.ContentType = responseMessage.Content.Headers.ContentType?.ToString();
httpResponseInfo.StatusCode = responseMessage.StatusCode;
var responseBody = await responseMessage.Content.ReadAsStringAsync().ConfigureAwait(false);
var responseContentType = responseMessage.Content.Headers.ContentType?.ToString();
var responseStatusCode = responseMessage.StatusCode;

return httpResponseInfo;
return new HttpResponseInfo(responseBody, responseContentType, responseStatusCode);
}
}
}
Expand Down Expand Up @@ -339,20 +326,23 @@ private Response CreateResponse(HttpResponseInfo responseInfo)
response.Value = body;
}

if (response.Value is string)
if (response.Value is string valueString)
{
response.Value = ((string)response.Value).Replace("\r\n", "\n").Replace("\n", Environment.NewLine);
response.Value = valueString.Replace("\r\n", "\n").Replace("\n", Environment.NewLine);
}

return response;
}

#nullable enable

/// <summary>
/// Releases all resources used by the <see cref="HttpCommandExecutor"/>.
/// </summary>
public void Dispose()
{
this.Dispose(true);
GC.SuppressFinalize(this);
}

/// <summary>
Expand All @@ -365,10 +355,7 @@ protected virtual void Dispose(bool disposing)
{
if (!this.isDisposed)
{
if (this.client != null)
{
this.client.Dispose();
}
this.client?.Dispose();

this.isDisposed = true;
}
Expand All @@ -378,6 +365,11 @@ private class HttpRequestInfo
{
public HttpRequestInfo(Uri serverUri, Command commandToExecute, HttpCommandInfo commandInfo)
{
if (commandInfo is null)
{
throw new ArgumentNullException(nameof(commandInfo));
}

this.FullUri = commandInfo.CreateCommandUri(serverUri, commandToExecute);
this.HttpMethod = commandInfo.Method;
this.RequestBody = commandToExecute.ParametersAsJsonString;
Expand All @@ -390,9 +382,16 @@ public HttpRequestInfo(Uri serverUri, Command commandToExecute, HttpCommandInfo

private class HttpResponseInfo
{
public HttpResponseInfo(string body, string? contentType, HttpStatusCode statusCode)
{
this.Body = body ?? throw new ArgumentNullException(nameof(body));
this.ContentType = contentType;
this.StatusCode = statusCode;
}

public HttpStatusCode StatusCode { get; set; }
public string Body { get; set; }
public string ContentType { get; set; }
public string? ContentType { get; set; }
}

/// <summary>
Expand All @@ -405,7 +404,12 @@ private class DiagnosticsHttpHandler : DelegatingHandler
public DiagnosticsHttpHandler(HttpMessageHandler messageHandler, ILogger logger)
: base(messageHandler)
{
_logger = logger;
if (messageHandler is null)
{
throw new ArgumentNullException(nameof(messageHandler));
}

_logger = logger ?? throw new ArgumentNullException(nameof(logger));
}

/// <summary>
Expand Down
Loading