* Replace CachedString with new types.

lukebakken · lukebakken · commit 14ff1b0c17aa · 2024-05-16T15:32:43.000-07:00
diff --git a/projects/RabbitMQ.Client/PublicAPI.Unshipped.txt b/projects/RabbitMQ.Client/PublicAPI.Unshipped.txt
@@ -186,10 +186,6 @@ RabbitMQ.Client.BinaryTableValue.BinaryTableValue() -> void
 RabbitMQ.Client.BinaryTableValue.BinaryTableValue(byte[] bytes) -> void
 RabbitMQ.Client.BinaryTableValue.Bytes.get -> byte[]
 RabbitMQ.Client.BinaryTableValue.Bytes.set -> void
-RabbitMQ.Client.CachedString
-RabbitMQ.Client.CachedString.CachedString(string value) -> void
-RabbitMQ.Client.CachedString.CachedString(string value, System.ReadOnlyMemory<byte> bytes) -> void
-RabbitMQ.Client.CachedString.CachedString(System.ReadOnlyMemory<byte> bytes) -> void
 RabbitMQ.Client.ConnectionConfig
 RabbitMQ.Client.ConnectionConfig.CredentialsProvider -> RabbitMQ.Client.ICredentialsProvider
 RabbitMQ.Client.ConnectionConfig.CredentialsRefresher -> RabbitMQ.Client.ICredentialsRefresher
@@ -481,7 +477,7 @@ RabbitMQ.Client.IChannel.BasicAckAsync(ulong deliveryTag, bool multiple, System.
 RabbitMQ.Client.IChannel.BasicAcks -> System.EventHandler<RabbitMQ.Client.Events.BasicAckEventArgs>
 RabbitMQ.Client.IChannel.BasicNackAsync(ulong deliveryTag, bool multiple, bool requeue, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask
 RabbitMQ.Client.IChannel.BasicNacks -> System.EventHandler<RabbitMQ.Client.Events.BasicNackEventArgs>
-RabbitMQ.Client.IChannel.BasicPublishAsync<TProperties>(RabbitMQ.Client.CachedString! exchange, RabbitMQ.Client.CachedString! routingKey, TProperties basicProperties, System.ReadOnlyMemory<byte> body = default(System.ReadOnlyMemory<byte>), bool mandatory = false, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask
+RabbitMQ.Client.IChannel.BasicPublishAsync<TProperties>(RabbitMQ.Client.ExchangeName! exchange, RabbitMQ.Client.RoutingKey! routingKey, TProperties basicProperties, System.ReadOnlyMemory<byte> body = default(System.ReadOnlyMemory<byte>), bool mandatory = false, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask
 RabbitMQ.Client.IChannel.BasicPublishAsync<TProperties>(string! exchange, string! routingKey, TProperties basicProperties, System.ReadOnlyMemory<byte> body = default(System.ReadOnlyMemory<byte>), bool mandatory = false, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.ValueTask
 RabbitMQ.Client.IChannel.BasicReturn -> System.EventHandler<RabbitMQ.Client.Events.BasicReturnEventArgs>
 RabbitMQ.Client.IChannel.CallbackException -> System.EventHandler<RabbitMQ.Client.Events.CallbackExceptionEventArgs>
@@ -780,8 +776,6 @@ readonly RabbitMQ.Client.BasicGetResult.Exchange -> string
 readonly RabbitMQ.Client.BasicGetResult.MessageCount -> uint
 readonly RabbitMQ.Client.BasicGetResult.Redelivered -> bool
 readonly RabbitMQ.Client.BasicGetResult.RoutingKey -> string
-readonly RabbitMQ.Client.CachedString.Bytes -> System.ReadOnlyMemory<byte>
-readonly RabbitMQ.Client.CachedString.Value -> string
 readonly RabbitMQ.Client.ConnectionConfig.AuthMechanisms -> System.Collections.Generic.IEnumerable<RabbitMQ.Client.IAuthMechanismFactory>
 readonly RabbitMQ.Client.ConnectionConfig.ClientProperties -> System.Collections.Generic.IDictionary<string, object>
 readonly RabbitMQ.Client.ConnectionConfig.ClientProvidedName -> string
@@ -847,8 +841,8 @@ static RabbitMQ.Client.EndpointResolverExtensions.SelectOneAsync<T>(this RabbitM
 static RabbitMQ.Client.Events.CallbackExceptionEventArgs.Build(System.Exception e, string context) -> RabbitMQ.Client.Events.CallbackExceptionEventArgs
 static RabbitMQ.Client.Events.CallbackExceptionEventArgs.Build(System.Exception e, string context, object consumer) -> RabbitMQ.Client.Events.CallbackExceptionEventArgs
 static RabbitMQ.Client.ExchangeType.All() -> System.Collections.Generic.ICollection<string>
-static RabbitMQ.Client.IChannelExtensions.BasicPublishAsync(this RabbitMQ.Client.IChannel channel, RabbitMQ.Client.CachedString exchange, RabbitMQ.Client.CachedString routingKey, System.ReadOnlyMemory<byte> body = default(System.ReadOnlyMemory<byte>), bool mandatory = false) -> System.Threading.Tasks.ValueTask
 static RabbitMQ.Client.IChannelExtensions.BasicPublishAsync(this RabbitMQ.Client.IChannel channel, string exchange, string routingKey, System.ReadOnlyMemory<byte> body = default(System.ReadOnlyMemory<byte>), bool mandatory = false) -> System.Threading.Tasks.ValueTask
+static RabbitMQ.Client.IChannelExtensions.BasicPublishAsync(this RabbitMQ.Client.IChannel! channel, RabbitMQ.Client.ExchangeName! exchange, RabbitMQ.Client.RoutingKey! routingKey, System.ReadOnlyMemory<byte> body = default(System.ReadOnlyMemory<byte>), bool mandatory = false) -> System.Threading.Tasks.ValueTask
 static RabbitMQ.Client.IChannelExtensions.BasicPublishAsync<T>(this RabbitMQ.Client.IChannel channel, RabbitMQ.Client.PublicationAddress addr, in T basicProperties, System.ReadOnlyMemory<byte> body) -> System.Threading.Tasks.ValueTask
 static RabbitMQ.Client.PublicationAddress.Parse(string uriLikeString) -> RabbitMQ.Client.PublicationAddress
 static RabbitMQ.Client.PublicationAddress.TryParse(string uriLikeString, out RabbitMQ.Client.PublicationAddress result) -> bool
@@ -857,7 +851,6 @@ static RabbitMQ.Client.RabbitMQActivitySource.UseRoutingKeyAsOperationName.get -
 static RabbitMQ.Client.RabbitMQActivitySource.UseRoutingKeyAsOperationName.set -> void
 static RabbitMQ.Client.TcpClientAdapter.GetMatchingHost(System.Collections.Generic.IReadOnlyCollection<System.Net.IPAddress> addresses, System.Net.Sockets.AddressFamily addressFamily) -> System.Net.IPAddress
 static RabbitMQ.Client.TimerBasedCredentialRefresherEventSource.Log.get -> RabbitMQ.Client.TimerBasedCredentialRefresherEventSource
-static readonly RabbitMQ.Client.CachedString.Empty -> RabbitMQ.Client.CachedString
 static readonly RabbitMQ.Client.ConnectionFactory.DefaultAuthMechanisms -> System.Collections.Generic.IEnumerable<RabbitMQ.Client.IAuthMechanismFactory>
 static readonly RabbitMQ.Client.ConnectionFactory.DefaultConnectionTimeout -> System.TimeSpan
 static readonly RabbitMQ.Client.ConnectionFactory.DefaultCredentialsRefresher -> RabbitMQ.Client.ICredentialsRefresher
diff --git a/projects/RabbitMQ.Client/client/api/CachedString.cs b/projects/RabbitMQ.Client/client/api/CachedString.cs
diff --git a/projects/RabbitMQ.Client/client/api/IChannel.cs b/projects/RabbitMQ.Client/client/api/IChannel.cs
@@ -224,7 +224,7 @@ ValueTask BasicPublishAsync<TProperties>(string exchange, string routingKey, TPr
         /// <remarks>
         /// Routing key must be shorter than 255 bytes.
         /// </remarks>
-        ValueTask BasicPublishAsync<TProperties>(CachedString exchange, CachedString routingKey, TProperties basicProperties,
+        ValueTask BasicPublishAsync<TProperties>(ExchangeName exchange, RoutingKey routingKey, TProperties basicProperties,
             ReadOnlyMemory<byte> body = default, bool mandatory = false,
             CancellationToken cancellationToken = default)
             where TProperties : IReadOnlyBasicProperties, IAmqpHeader;
diff --git a/projects/RabbitMQ.Client/client/api/IChannelExtensions.cs b/projects/RabbitMQ.Client/client/api/IChannelExtensions.cs
@@ -93,10 +93,12 @@ public static ValueTask BasicPublishAsync<T>(this IChannel channel, PublicationA
             return channel.BasicPublishAsync(addr.ExchangeName, addr.RoutingKey, basicProperties, body);
         }
 
-        public static ValueTask BasicPublishAsync(this IChannel channel, string exchange, string routingKey, ReadOnlyMemory<byte> body = default, bool mandatory = false)
+        public static ValueTask BasicPublishAsync(this IChannel channel, string exchange, string routingKey,
+            ReadOnlyMemory<byte> body = default, bool mandatory = false)
             => channel.BasicPublishAsync(exchange, routingKey, EmptyBasicProperty.Empty, body, mandatory);
 
-        public static ValueTask BasicPublishAsync(this IChannel channel, CachedString exchange, CachedString routingKey, ReadOnlyMemory<byte> body = default, bool mandatory = false)
+        public static ValueTask BasicPublishAsync(this IChannel channel, ExchangeName exchange, RoutingKey routingKey,
+            ReadOnlyMemory<byte> body = default, bool mandatory = false)
             => channel.BasicPublishAsync(exchange, routingKey, EmptyBasicProperty.Empty, body, mandatory);
 
 #nullable disable
diff --git a/projects/RabbitMQ.Client/client/impl/AutorecoveringChannel.cs b/projects/RabbitMQ.Client/client/impl/AutorecoveringChannel.cs
@@ -288,7 +288,7 @@ public ValueTask BasicPublishAsync<TProperties>(string exchange, string routingK
             where TProperties : IReadOnlyBasicProperties, IAmqpHeader
             => InnerChannel.BasicPublishAsync(exchange, routingKey, basicProperties, body, mandatory, cancellationToken);
 
-        public ValueTask BasicPublishAsync<TProperties>(CachedString exchange, CachedString routingKey, TProperties basicProperties,
+        public ValueTask BasicPublishAsync<TProperties>(ExchangeName exchange, RoutingKey routingKey, TProperties basicProperties,
             ReadOnlyMemory<byte> body, bool mandatory,
             CancellationToken cancellationToken)
             where TProperties : IReadOnlyBasicProperties, IAmqpHeader
diff --git a/projects/RabbitMQ.Client/client/impl/ChannelBase.cs b/projects/RabbitMQ.Client/client/impl/ChannelBase.cs
@@ -1122,7 +1122,7 @@ await _confirmSemaphore.WaitAsync(cancellationToken)
             }
         }
 
-        public async ValueTask BasicPublishAsync<TProperties>(CachedString exchange, CachedString routingKey,
+        public async ValueTask BasicPublishAsync<TProperties>(ExchangeName exchange, RoutingKey routingKey,
             TProperties basicProperties, ReadOnlyMemory<byte> body, bool mandatory,
             CancellationToken cancellationToken)
             where TProperties : IReadOnlyBasicProperties, IAmqpHeader
@@ -1143,11 +1143,11 @@ await _confirmSemaphore.WaitAsync(cancellationToken)
 
             try
             {
-                var cmd = new BasicPublishMemory(exchange.Bytes, routingKey.Bytes, mandatory, default);
+                var cmd = new BasicPublishMemory(exchange, routingKey, mandatory, default);
 
                 RabbitMQActivitySource.TryGetExistingContext(basicProperties, out ActivityContext existingContext);
                 using Activity sendActivity = RabbitMQActivitySource.PublisherHasListeners
-                    ? RabbitMQActivitySource.Send(routingKey.Value, exchange.Value, body.Length, existingContext)
+                    ? RabbitMQActivitySource.Send(routingKey, exchange, body.Length, existingContext)
                     : default;
 
                 if (sendActivity != null)
diff --git a/projects/Test/Integration/TestBasicPublish.cs b/projects/Test/Integration/TestBasicPublish.cs
@@ -90,8 +90,8 @@ public async Task TestBasicRoundtripCachedString()
             _conn = await _connFactory.CreateConnectionAsync();
             _channel = await _conn.CreateChannelAsync();
 
-            CachedString exchangeName = new CachedString(string.Empty);
-            CachedString queueName = new CachedString((await _channel.QueueDeclareAsync()).QueueName);
+            var exchangeName = new ExchangeName(string.Empty);
+            var queueName = new QueueName((await _channel.QueueDeclareAsync()).QueueName);
             byte[] sendBody = _encoding.GetBytes("hi");
             byte[] consumeBody = null;
             var consumer = new EventingBasicConsumer(_channel);
@@ -102,7 +102,7 @@ public async Task TestBasicRoundtripCachedString()
                     consumeBody = a.Body.ToArray();
                     consumerReceivedSemaphore.Release();
                 };
-                string tag = await _channel.BasicConsumeAsync(queueName.Value, true, consumer);
+                string tag = await _channel.BasicConsumeAsync(queueName, true, consumer);
 
                 await _channel.BasicPublishAsync(exchangeName, queueName, sendBody);
                 bool waitResFalse = await consumerReceivedSemaphore.WaitAsync(TimeSpan.FromSeconds(2));
diff --git a/projects/Test/Integration/TestFloodPublishing.cs b/projects/Test/Integration/TestFloodPublishing.cs
@@ -102,7 +102,7 @@ public async Task TestUnthrottledFloodPublishing()
                         }
                     }
 
-                    await _channel.BasicPublishAsync(CachedString.Empty, CachedString.Empty, _body);
+                    await _channel.BasicPublishAsync(ExchangeName.Empty, RoutingKey.Empty, _body);
                 }
             }
             finally
diff --git a/projects/Test/Integration/TestPublishSharedChannelAsync.cs b/projects/Test/Integration/TestPublishSharedChannelAsync.cs
@@ -40,8 +40,8 @@ namespace Test.Integration
     public class TestPublishSharedChannelAsync : IntegrationFixture
     {
         private const string QueueName = "TestPublishSharedChannel_Queue";
-        private static readonly CachedString ExchangeName = new CachedString("TestPublishSharedChannel_Ex");
-        private static readonly CachedString PublishKey = new CachedString("TestPublishSharedChannel_RoutePub");
+        private static readonly ExchangeName s_exchangeName = new ExchangeName("TestPublishSharedChannel_Ex");
+        private static readonly RoutingKey s_publishKey = new RoutingKey("TestPublishSharedChannel_RoutePub");
         private const int Loops = 20;
         private const int Repeats = 1000;
 
@@ -85,16 +85,16 @@ public async Task MultiThreadPublishOnSharedChannel()
                         try
                         {
                             channel.ChannelShutdown += HandleChannelShutdown;
-                            await channel.ExchangeDeclareAsync(ExchangeName.Value, ExchangeType.Topic, passive: false, durable: false, autoDelete: true,
+                            await channel.ExchangeDeclareAsync(s_exchangeName, ExchangeType.Topic, passive: false, durable: false, autoDelete: true,
                                 noWait: false, arguments: null);
                             await channel.QueueDeclareAsync(QueueName, exclusive: false, autoDelete: true);
-                            await channel.QueueBindAsync(QueueName, ExchangeName.Value, PublishKey.Value);
+                            await channel.QueueBindAsync(QueueName, s_exchangeName, s_publishKey);
 
                             for (int i = 0; i < Loops; i++)
                             {
                                 for (int j = 0; j < Repeats; j++)
                                 {
-                                    await channel.BasicPublishAsync(ExchangeName, PublishKey, _body, false);
+                                    await channel.BasicPublishAsync(s_exchangeName, s_publishKey, _body, false);
                                 }
                             }
                         }

Original file line number	Diff line number	Diff line change
`@@ -1122,7 +1122,7 @@ await _confirmSemaphore.WaitAsync(cancellationToken)`
`1122`	`1122`	`}`
`1123`	`1123`	`}`
`1124`	`1124`
`1125`		`- public async ValueTask BasicPublishAsync<TProperties>(CachedString exchange, CachedString routingKey,`
	`1125`	`+ public async ValueTask BasicPublishAsync<TProperties>(ExchangeName exchange, RoutingKey routingKey,`
`1126`	`1126`	`TProperties basicProperties, ReadOnlyMemory<byte> body, bool mandatory,`
`1127`	`1127`	`CancellationToken cancellationToken)`
`1128`	`1128`	`where TProperties : IReadOnlyBasicProperties, IAmqpHeader`
`@@ -1143,11 +1143,11 @@ await _confirmSemaphore.WaitAsync(cancellationToken)`
`1143`	`1143`
`1144`	`1144`	`try`
`1145`	`1145`	`{`
`1146`		`- var cmd = new BasicPublishMemory(exchange.Bytes, routingKey.Bytes, mandatory, default);`
	`1146`	`+ var cmd = new BasicPublishMemory(exchange, routingKey, mandatory, default);`
`1147`	`1147`
`1148`	`1148`	`RabbitMQActivitySource.TryGetExistingContext(basicProperties, out ActivityContext existingContext);`
`1149`	`1149`	`using Activity sendActivity = RabbitMQActivitySource.PublisherHasListeners`
`1150`		`- ? RabbitMQActivitySource.Send(routingKey.Value, exchange.Value, body.Length, existingContext)`
	`1150`	`+ ? RabbitMQActivitySource.Send(routingKey, exchange, body.Length, existingContext)`
`1151`	`1151`	`: default;`
`1152`	`1152`
`1153`	`1153`	`if (sendActivity != null)`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ public async Task TestUnthrottledFloodPublishing()`
`102`	`102`	`}`
`103`	`103`	`}`
`104`	`104`
`105`		`- await _channel.BasicPublishAsync(CachedString.Empty, CachedString.Empty, _body);`
	`105`	`+ await _channel.BasicPublishAsync(ExchangeName.Empty, RoutingKey.Empty, _body);`
`106`	`106`	`}`
`107`	`107`	`}`
`108`	`108`	`finally`
Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,8 @@ namespace Test.Integration`
`40`	`40`	`public class TestPublishSharedChannelAsync : IntegrationFixture`
`41`	`41`	`{`
`42`	`42`	`private const string QueueName = "TestPublishSharedChannel_Queue";`
`43`		`- private static readonly CachedString ExchangeName = new CachedString("TestPublishSharedChannel_Ex");`
`44`		`- private static readonly CachedString PublishKey = new CachedString("TestPublishSharedChannel_RoutePub");`
	`43`	`+ private static readonly ExchangeName s_exchangeName = new ExchangeName("TestPublishSharedChannel_Ex");`
	`44`	`+ private static readonly RoutingKey s_publishKey = new RoutingKey("TestPublishSharedChannel_RoutePub");`
`45`	`45`	`private const int Loops = 20;`
`46`	`46`	`private const int Repeats = 1000;`
`47`	`47`
`@@ -85,16 +85,16 @@ public async Task MultiThreadPublishOnSharedChannel()`
`85`	`85`	`try`
`86`	`86`	`{`
`87`	`87`	`channel.ChannelShutdown += HandleChannelShutdown;`
`88`		`- await channel.ExchangeDeclareAsync(ExchangeName.Value, ExchangeType.Topic, passive: false, durable: false, autoDelete: true,`
	`88`	`+ await channel.ExchangeDeclareAsync(s_exchangeName, ExchangeType.Topic, passive: false, durable: false, autoDelete: true,`
`89`	`89`	`noWait: false, arguments: null);`
`90`	`90`	`await channel.QueueDeclareAsync(QueueName, exclusive: false, autoDelete: true);`
`91`		`- await channel.QueueBindAsync(QueueName, ExchangeName.Value, PublishKey.Value);`
	`91`	`+ await channel.QueueBindAsync(QueueName, s_exchangeName, s_publishKey);`
`92`	`92`
`93`	`93`	`for (int i = 0; i < Loops; i++)`
`94`	`94`	`{`
`95`	`95`	`for (int j = 0; j < Repeats; j++)`
`96`	`96`	`{`
`97`		`- await channel.BasicPublishAsync(ExchangeName, PublishKey, _body, false);`
	`97`	`+ await channel.BasicPublishAsync(s_exchangeName, s_publishKey, _body, false);`
`98`	`98`	`}`
`99`	`99`	`}`
`100`	`100`	`}`