Refactoring of MessageProperties for compatibility with latest RabbitMQ.Client (#1111)

Pliner · web-flow · commit d914dc0f21e9 · 2020-10-01T20:10:39.000+05:00
* Check basicProperties.Headers for null

* Multiple fixes of MessageProperties

1. All necessary xml docs are added
2. It implements IClonable
3. *Present fields are readonly
4. HeadersPresent property is true only if headers != null &amp;&amp; headers.Count &gt; 0
5. Headers property is lazily initialized
6. Nice code formatting :-/

* Limit RabbitMQ.Client compatibility to minor version

* Fix tests

* Trigger CI
diff --git a/Source/EasyNetQ.DI.Tests/EasyNetQ.DI.Tests.csproj b/Source/EasyNetQ.DI.Tests/EasyNetQ.DI.Tests.csproj
@@ -27,7 +27,7 @@
     <PackageReference Include="LightInject" Version="5.5.0" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="NSubstitute" Version="4.2.2" />
-    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,7.0.0)" />
+    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,6.3.0)" />
     <PackageReference Include="SimpleInjector" Version="4.6.2" />
     <PackageReference Include="Autofac" Version="4.9.3" />
     <DotNetCliToolReference Include="dotnet-xunit" Version="2.3.0-beta3-build3705" />
diff --git a/Source/EasyNetQ.Hosepipe.Tests/EasyNetQ.Hosepipe.Tests.csproj b/Source/EasyNetQ.Hosepipe.Tests/EasyNetQ.Hosepipe.Tests.csproj
@@ -17,7 +17,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
-    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,7.0.0)" />
+    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,6.3.0)" />
     <PackageReference Include="GitVersionTask" Version="5.0.1">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
diff --git a/Source/EasyNetQ.Hosepipe/EasyNetQ.Hosepipe.csproj b/Source/EasyNetQ.Hosepipe/EasyNetQ.Hosepipe.csproj
@@ -25,7 +25,7 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
-    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,7.0.0)" />
+    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,6.3.0)" />
     <Reference Include="System" />
     <Reference Include="System.Core" />
   </ItemGroup>
diff --git a/Source/EasyNetQ.IntegrationTests/EasyNetQ.IntegrationTests.csproj b/Source/EasyNetQ.IntegrationTests/EasyNetQ.IntegrationTests.csproj
@@ -19,7 +19,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="NSubstitute" Version="4.2.2" />
-    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,7.0.0)" />
+    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,6.3.0)" />
     <PackageReference Include="System.ComponentModel.TypeConverter" Version="4.3.0" />
     <PackageReference Include="System.Net.Http" Version="4.3.4" />
     <PackageReference Include="xunit" Version="2.4.1" />
diff --git a/Source/EasyNetQ.Scheduler/EasyNetQ.Scheduler.csproj b/Source/EasyNetQ.Scheduler/EasyNetQ.Scheduler.csproj
@@ -22,7 +22,7 @@
   <ItemGroup>
     <PackageReference Include="log4net" Version="2.0.8" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
-    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,7.0.0)" />
+    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,6.3.0)" />
     <PackageReference Include="Topshelf" Version="4.2.1" />
     <PackageReference Include="GitVersionTask" Version="5.0.1">
       <PrivateAssets>all</PrivateAssets>
diff --git a/Source/EasyNetQ.Tests/EasyNetQ.Tests.csproj b/Source/EasyNetQ.Tests/EasyNetQ.Tests.csproj
@@ -17,7 +17,7 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.2.0" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="NSubstitute" Version="4.2.2" />
-    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,7.0.0)" />
+    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,6.3.0)" />
     <PackageReference Include="System.ComponentModel.TypeConverter" Version="4.3.0" />
     <PackageReference Include="System.Net.Http" Version="4.3.4" />
     <PackageReference Include="xunit" Version="2.4.1" />
diff --git a/Source/EasyNetQ.Tests/MessagePropertiesTests.cs b/Source/EasyNetQ.Tests/MessagePropertiesTests.cs
@@ -1,10 +1,8 @@
 ﻿// ReSharper disable InconsistentNaming
 using System.Collections.Generic;
-using RabbitMQ.Client.Framing;
 using System;
 using System.Linq;
 using System.Reflection;
-using System.Text;
 using FluentAssertions;
 using Xunit;
 
@@ -47,7 +45,7 @@ public void Should_clone()
 
             var properties = new MessageProperties {
                 ReplyTo = replyTo,
-                Headers = new Dictionary<string, object>()
+                Headers = new Dictionary<string, object>
                           {
                               { "AString", "ThisIsAString" },
                               { "AnInt", 123 }
@@ -65,13 +63,12 @@ public void Should_clone()
         [Fact]
         public void Should_be_able_to_write_debug_properties()
         {
-            const string expectedDebugProperties = 
-                "ContentType=content_type, ContentEncoding=content_encoding, " + 
-                "Headers=[key1=value1, key2=value2], DeliveryMode=10, Priority=3, CorrelationId=NULL, " + 
-                "ReplyTo=reply_to, Expiration=expiration, MessageId=message_id, Timestamp=123456, Type=type, " + 
+            const string expectedDebugProperties =
+                "ContentType=content_type, ContentEncoding=content_encoding, " +
+                "Headers=[key1=value1, key2=value2], DeliveryMode=10, Priority=3, CorrelationId=NULL, " +
+                "ReplyTo=reply_to, Expiration=expiration, MessageId=message_id, Timestamp=123456, Type=type, " +
                 "UserId=userid, AppId=app_id, ClusterId=cluster_id";
 
-            var stringBuilder = new StringBuilder();
             var headers = new Dictionary<string, object>
                 {
                     {"key1", "value1"},
@@ -134,4 +131,4 @@ public void Should_throw_if_any_string_property_exceeds_255_chars()
     }
 }
 
-// ReSharper restore InconsistentNaming
+// ReSharper restore InconsistentNaming
diff --git a/Source/EasyNetQ.Tests/TestMessage.cs b/Source/EasyNetQ.Tests/TestMessage.cs
@@ -2,7 +2,6 @@
 {
     public class TestMessage
     {
-         
     }
 
     [Queue("MyQueue", ExchangeName = "MyExchange")]
@@ -47,4 +46,4 @@ public class MyOtherMessage
         public string Text { get; set; }
     }
 
-}
+}
diff --git a/Source/EasyNetQ/EasyNetQ.csproj b/Source/EasyNetQ/EasyNetQ.csproj
@@ -19,7 +19,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
-    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,7.0.0)" />
+    <PackageReference Include="RabbitMQ.Client" Version="[6.2.1,6.3.0)" />
     <PackageReference Include="LibLog" Version="5.0.8">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
diff --git a/Source/EasyNetQ/MessageProperties.cs b/Source/EasyNetQ/MessageProperties.cs

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`	`{`
`3`	`3`	`public class TestMessage`
`4`	`4`	`{`
`5`		`-`
`6`	`5`	`}`
`7`	`6`
`8`	`7`	`[Queue("MyQueue", ExchangeName = "MyExchange")]`
`@@ -47,4 +46,4 @@ public class MyOtherMessage`
`47`	`46`	`public string Text { get; set; }`
`48`	`47`	`}`
`49`	`48`
`50`		`-}`
	`49`	`+}`