Include deprecation date in deprecation log message

Author: Matthias Gessinger

src/Client/src/Asp.Versioning.Http.Client/ApiNotificationContext.cs

@@ -21,6 +21,20 @@ public ApiNotificationContext( HttpResponseMessage response, ApiVersion apiVersi
         ApiVersion = apiVersion ?? throw new System.ArgumentNullException( nameof( apiVersion ) );
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ApiNotificationContext"/> class.
+    /// </summary>
+    /// <param name="response">The current HTTP response.</param>
+    /// <param name="apiVersion">The requested API version.</param>
+    /// <param name="sunsetPolicy">The sunset policy which was previously read from the <paramref name="response"/>.</param>
+    /// <param name="deprecationPolicy">The deprecation policy which was previously read from the <paramref name="response"/>.</param>
+    public ApiNotificationContext( HttpResponseMessage response, ApiVersion apiVersion, SunsetPolicy? sunsetPolicy = null, DeprecationPolicy? deprecationPolicy = null )
+        : this( response, apiVersion )
+    {
+        this.sunsetPolicy = sunsetPolicy;
+        this.deprecationPolicy = deprecationPolicy;
+    }
+
     /// <summary>
     /// Gets the current HTTP response.
     /// </summary>

src/Client/src/Asp.Versioning.Http.Client/ApiVersionHandler.cs

@@ -46,10 +46,10 @@ protected override async Task<HttpResponseMessage> SendAsync( HttpRequestMessage
 
         var response = await base.SendAsync( request, cancellationToken ).ConfigureAwait( false );
 
-        if ( IsDeprecatedApi( response ) )
+        if ( IsDeprecatedApi( response, out var deprecationPolicy ) )
         {
             response.RequestMessage ??= request;
-            await notification.OnApiDeprecatedAsync( new( response, apiVersion ), cancellationToken ).ConfigureAwait( false );
+            await notification.OnApiDeprecatedAsync( new( response, apiVersion, deprecationPolicy: deprecationPolicy ), cancellationToken ).ConfigureAwait( false );
         }
         else if ( IsNewApiAvailable( response ) )
         {
@@ -64,12 +64,13 @@ protected override async Task<HttpResponseMessage> SendAsync( HttpRequestMessage
     /// Determines whether the requested API is deprecated.
     /// </summary>
     /// <param name="response">The <see cref="HttpResponseMessage">HTTP response</see> from the requested API.</param>
+    /// <param name="deprecationPolicy">The deprecation policy read from the <paramref name="response"/>.</param>
     /// <returns>True if the requested API has been deprecated; otherwise, false.</returns>
-    protected virtual bool IsDeprecatedApi( HttpResponseMessage response )
+    protected virtual bool IsDeprecatedApi( HttpResponseMessage response, out DeprecationPolicy deprecationPolicy )
     {
         ArgumentNullException.ThrowIfNull( response );
 
-        var deprecationPolicy = response.ReadDeprecationPolicy();
+        deprecationPolicy = response.ReadDeprecationPolicy();
 
         if ( deprecationPolicy.Date.HasValue && deprecationPolicy.Date <= DateTimeOffset.UtcNow )
         {

src/Client/src/Asp.Versioning.Http.Client/net#.0/ApiVersionHandlerLogger{T}.cs

@@ -36,8 +36,9 @@ protected override void OnApiDeprecated( ApiNotificationContext context )
         var requestUrl = context.Response.RequestMessage!.RequestUri!;
         var apiVersion = context.ApiVersion;
         var sunsetPolicy = context.SunsetPolicy;
+        var deprecationPolicy = context.DeprecationPolicy;
 
-        logger.ApiVersionDeprecated( requestUrl, apiVersion, sunsetPolicy );
+        logger.ApiVersionDeprecated( requestUrl, apiVersion, sunsetPolicy, deprecationPolicy );
     }
 
     /// <inheritdoc />

src/Client/src/Asp.Versioning.Http.Client/net#.0/ILoggerExtensions.cs

@@ -16,25 +16,33 @@ internal static void ApiVersionDeprecated(
         this ILogger logger,
         Uri requestUrl,
         ApiVersion apiVersion,
-        SunsetPolicy sunsetPolicy )
+        SunsetPolicy sunsetPolicy,
+        DeprecationPolicy deprecationPolicy )
     {
         var sunsetDate = FormatDate( sunsetPolicy.Date );
-        var additionalInfo = FormatLinks( sunsetPolicy );
+        var deprecationDate = FormatDate( deprecationPolicy.Date );
+
+        var additionalInfoSunset = FormatLinks( sunsetPolicy );
+        var additionalInfoDeprecation = FormatLinks( deprecationPolicy );
+
+        var additionalInfo = additionalInfoDeprecation.Concat( additionalInfoSunset ).ToArray();
 
         ApiVersionDeprecated(
             logger,
             apiVersion.ToString(),
             requestUrl.OriginalString,
             sunsetDate,
+            deprecationDate,
             additionalInfo );
     }
 
-    [LoggerMessage( EventId = 1, Level = Warning, Message = "API version {apiVersion} for {requestUrl} has been deprecated and will sunset on {sunsetDate}. Additional information: {links}" )]
+    [LoggerMessage( EventId = 1, Level = Warning, Message = "API version {apiVersion} for {requestUrl} has been deprecated since {deprecationDate} and will sunset on {sunsetDate}. Additional information: {links}" )]
     static partial void ApiVersionDeprecated(
         ILogger logger,
         string apiVersion,
         string requestUrl,
         string sunsetDate,
+        string deprecationDate,
         string[] links );
 
     [MethodImpl( MethodImplOptions.AggressiveInlining )]
@@ -80,6 +88,16 @@ private static string[] FormatLinks( SunsetPolicy sunsetPolicy )
         return FormatLinks( sunsetPolicy.Links );
     }
 
+    private static string[] FormatLinks( DeprecationPolicy deprecationPolicy )
+    {
+        if ( !deprecationPolicy.HasLinks )
+        {
+            return [];
+        }
+
+        return FormatLinks( deprecationPolicy.Links );
+    }
+
     private static string[] FormatLinks( IList<LinkHeaderValue> links )
     {
         // <Title> (<Language>[,<Language>]): <Url>

src/Client/test/Asp.Versioning.Http.Client.Tests/net#.0/ApiVersionHandlerLoggerTTest.cs

@@ -21,7 +21,7 @@ public async Task on_api_deprecated_should_log_message()
         };
         var context = new ApiNotificationContext( response, new ApiVersion( 1.0 ) );
         var date = DateTimeOffset.Now;
-        var expected = "API version 1.0 for http://tempuri.org has been deprecated and will " +
+        var expected = "API version 1.0 for http://tempuri.org has been deprecated since <unspecified> and will " +
                       $"sunset on {date.ToUniversalTime()}. Additional information: " +
                       "API Policy (en): http://tempuri.org/policy/en, " +
                       "API Política (es): http://tempuri.org/policy/es";

src/Common/src/Common/DeprecationPolicyManager.cs

@@ -8,5 +8,5 @@ namespace Asp.Versioning;
 /// <remarks>
 /// This class serves as a type alias to hide the generic arguments of <see cref="PolicyManager{TPolicy, TPolicyBuilder}"/>.
 /// </remarks>
-public partial class DeprecationPolicyManager : PolicyManager<DeprecationPolicy, DeprecationPolicyBuilder>
+public partial class DeprecationPolicyManager : PolicyManager<DeprecationPolicy, IDeprecationPolicyBuilder>
 { }

src/Common/src/Common/SunsetPolicyManager.cs

@@ -8,5 +8,5 @@ namespace Asp.Versioning;
 /// <remarks>
 /// This class serves as a type alias to hide the generic arguments of <see cref="PolicyManager{TPolicy, TPolicyBuilder}"/>.
 /// </remarks>
-public partial class SunsetPolicyManager : PolicyManager<SunsetPolicy, SunsetPolicyBuilder>
+public partial class SunsetPolicyManager : PolicyManager<SunsetPolicy, ISunsetPolicyBuilder>
 { }