Obsolete TimeToBeReceived and forward to TimeToLive (#307)

Co-authored-by: Brandon Ording <bording@gmail.com>
Particular · May 22, 2024 · 78a359e · 78a359e
1 parent 28442dc
commit 78a359e
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 4 deletions.
diff --git a/...Bus.ServicePlatform.Connector.UnitTests/ApprovalFiles/APIApprovals.PublicClr.approved.txt b/...Bus.ServicePlatform.Connector.UnitTests/ApprovalFiles/APIApprovals.PublicClr.approved.txt
@@ -43,7 +43,11 @@ namespace NServiceBus
         public string InstanceId { get; set; }
         public System.TimeSpan Interval { get; set; }
         public string MetricsQueue { get; set; }
+        [System.Obsolete("Use `TimeToLive` instead. Will be treated as an error from version 4.0.0. Will be" +
+            " removed in version 5.0.0.", false)]
+        [System.Text.Json.Serialization.JsonIgnore]
         public System.TimeSpan? TimeToBeReceived { get; set; }
+        public System.TimeSpan? TimeToLive { get; set; }
     }
     public class ServicePlatformSagaAuditConfiguration
     {

diff --git a/src/NServiceBus.ServicePlatform.Connector/FodyWeavers.xml b/src/NServiceBus.ServicePlatform.Connector/FodyWeavers.xml
@@ -0,0 +1,3 @@
+<Weavers GenerateXsd="false">
+  <Obsolete HideObsoleteMembers="never" />
+</Weavers>
diff --git a/src/NServiceBus.ServicePlatform.Connector/NServiceBus.ServicePlatform.Connector.csproj b/src/NServiceBus.ServicePlatform.Connector/NServiceBus.ServicePlatform.Connector.csproj
@@ -24,7 +24,9 @@
     <PackageReference Include="NServiceBus.Metrics" Version="[4.0.0, 5.0.0)" />
   </ItemGroup>
 
-  <ItemGroup>
+  <ItemGroup Label="Private dependencies">
+    <PackageReference Include="Fody" Version="6.8.1" PrivateAssets="All" />
+    <PackageReference Include="Obsolete.Fody" Version="5.3.0" PrivateAssets="All" />
     <PackageReference Include="Particular.Packaging" Version="2.3.0" PrivateAssets="All" />
   </ItemGroup>
 

diff --git a/src/NServiceBus.ServicePlatform.Connector/ServicePlatformMetricsConfiguration.cs b/src/NServiceBus.ServicePlatform.Connector/ServicePlatformMetricsConfiguration.cs
@@ -1,6 +1,7 @@
 namespace NServiceBus
 {
     using System;
+    using System.Text.Json.Serialization;
 
     /// <summary>
     /// Contains configuration options for the Metrics features of the Particular Service Platform.
@@ -30,7 +31,21 @@ public class ServicePlatformMetricsConfiguration
         /// <summary>
         /// The maximum time to live for Metrics messages.
         /// </summary>
-        public TimeSpan? TimeToBeReceived { get; set; }
+        [ObsoleteEx(
+            TreatAsErrorFromVersion = "4.0.0",
+            RemoveInVersion = "5.0.0",
+            ReplacementTypeOrMember = "TimeToLive")]
+        [JsonIgnore]
+        public TimeSpan? TimeToBeReceived
+        {
+            get => TimeToLive;
+            set => TimeToLive = value;
+        }
+
+        /// <summary>
+        /// The maximum time to live for Metrics messages.
+        /// </summary>
+        public TimeSpan? TimeToLive { get; set; }
 
         internal void ApplyTo(EndpointConfiguration endpointConfiguration)
         {
@@ -48,9 +63,10 @@ internal void ApplyTo(EndpointConfiguration endpointConfiguration)
 
             var metrics = endpointConfiguration.EnableMetrics();
             metrics.SendMetricDataToServiceControl(MetricsQueue, Interval, InstanceId);
-            if (TimeToBeReceived.HasValue)
+
+            if (TimeToLive.HasValue)
             {
-                metrics.SetServiceControlMetricsMessageTTBR(TimeToBeReceived.Value);
+                metrics.SetServiceControlMetricsMessageTTBR(TimeToLive.Value);
             }
         }
     }