Mark Timeout Property as Obsolete and Recommend IHttpClientFactory for Timeout Config

[WanjohiSammy]

Issues

This pull request fixes #3131.

Description

Summary

This PR marks the Timeout property in the DataServiceContext class as obsolete and recommends using IHttpClientFactory to configure the timeout. This change is part of our effort to modernize the configuration of HTTP requests and provide more flexible and robust options for users.

Changes

• Added the [Obsolete] attribute to the Timeout property with a message indicating the deprecation and suggesting the use of IHttpClientFactory.

Reason for Change

The Timeout property is being deprecated to encourage the use of IHttpClientFactory, which provides a more flexible and configurable way to manage HTTP client settings, including timeouts. This approach aligns with modern .NET practices and offers better integration with dependency injection and other configuration mechanisms.

Impact

Users will see a compiler warning when using the Timeout property, indicating that it is obsolete and suggesting the use of IHttpClientFactory instead. This change does not break existing code but encourages users to migrate to the new approach.

Next Steps

• Update any relevant documentation to guide users on how to configure timeouts using IHttpClientFactory. Documentation PR
• Plan for the eventual removal of the Timeout property in a future major release.

Example Usage of IHttpClientFactory

1. Create CustomHttpClientFactory

public class CustomHttpClientFactory : IHttpClientFactory
{
    private readonly HttpClient _httpClient;

    public CustomHttpClientFactory(HttpClient httpClient)
    {
        _httpClient = httpClient;
    }

    public HttpClient CreateClient(string name)
    {
        return _httpClient;
    }
}

2. Create HttpClient and specify the Timeout

var httpClient = new HttpClient
{
    Timeout = TimeSpan.FromSeconds(160)
};

var httpClientFactory= new CustomHttpClientFactory(httpClient);

var context = new Container(new Uri("https://localhost:7214/odata"))
{
    HttpClientFactory = httpClientFactory
};

3. Using DI:

var services = new ServiceCollection();
services.AddHttpClient("", client =>  // Note that the httpClient is not named
{
    client.Timeout = TimeSpan.FromSeconds(160);
});

var serviceProvider = services.BuildServiceProvider();
var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();

var context = new Container(new Uri("https://localhost:7214/odata"))
{
    HttpClientFactory = httpClientFactory
};

Checklist (Uncheck if it is not completed)

• Test cases added
• Build and test with one-click build and test script passed

Additional work necessary

Using IHttpClientFactory with Microsoft.OData.Client