Make the info class abstract (#323)

Signed-off-by: Gabriele Santomaggio <G.santomaggio@gmail.com>
rabbitmq · Oct 11, 2023 · a515ea9 · a515ea9
1 parent e37f2a2
commit a515ea9
Show file tree

Hide file tree

Showing 14 changed files with 77 additions and 53 deletions.
diff --git a/RabbitMQ.Stream.Client/AbstractEntity.cs b/RabbitMQ.Stream.Client/AbstractEntity.cs
@@ -22,6 +22,5 @@ protected void MaybeCancelToken()
 
         protected Client _client;
 
-        public Info Info { get; internal set; }
     }
 }
diff --git a/RabbitMQ.Stream.Client/EntityInfo.cs b/RabbitMQ.Stream.Client/EntityInfo.cs
@@ -4,14 +4,12 @@
 
 namespace RabbitMQ.Stream.Client;
 
-public class Info
+public abstract class Info
 {
-    public string Reference { get; }
     public string Stream { get; }
 
-    internal Info(string reference, string stream)
+    protected Info(string stream)
     {
-        Reference = reference;
         Stream = stream;
     }
 }
diff --git a/RabbitMQ.Stream.Client/IConsumer.cs b/RabbitMQ.Stream.Client/IConsumer.cs
@@ -13,7 +13,7 @@ public interface IConsumer
     public Task<ResponseCode> Close();
     public void Dispose();
 
-    public Info Info { get; }
+    public ConsumerInfo Info { get; }
 }
 
 public record IConsumerConfig : INamedEntity
@@ -73,3 +73,12 @@ public ushort InitialCredits
     // It is not enabled by default because it is could reduce the performance.
     public ICrc32 Crc32 { get; set; } = null;
 }
+
+public class ConsumerInfo : Info
+{
+    public string Reference { get; }
+    public ConsumerInfo(string stream, string reference) : base(stream)
+    {
+        Reference = reference;
+    }
+}
diff --git a/RabbitMQ.Stream.Client/IProducer.cs b/RabbitMQ.Stream.Client/IProducer.cs
@@ -71,7 +71,7 @@ public interface IProducer
     /// <summary>
     /// Info contains the reference and the stream name.
     /// </summary>
-    public Info Info { get; }
+    public ProducerInfo Info { get; }
 }
 
 public record ProducerFilter
@@ -104,3 +104,16 @@ public record IProducerConfig : INamedEntity
     /// </summary>
     public ProducerFilter Filter { get; set; } = null;
 }
+
+/// <summary>
+/// ProducerInfo contains the reference and the stream name.
+/// </summary>
+public class ProducerInfo : Info
+{
+    public string Reference { get; }
+
+    public ProducerInfo(string stream, string reference) : base(stream)
+    {
+        Reference = reference;
+    }
+}
diff --git a/RabbitMQ.Stream.Client/PublicAPI.Unshipped.txt b/RabbitMQ.Stream.Client/PublicAPI.Unshipped.txt
@@ -1,6 +1,5 @@
 const RabbitMQ.Stream.Client.RouteQueryResponse.Key = 24 -> ushort
 const RabbitMQ.Stream.Client.StreamStatsResponse.Key = 28 -> ushort
-RabbitMQ.Stream.Client.AbstractEntity.Info.get -> RabbitMQ.Stream.Client.Info
 RabbitMQ.Stream.Client.AbstractEntity.MaybeCancelToken() -> void
 RabbitMQ.Stream.Client.AbstractEntity.Token.get -> System.Threading.CancellationToken
 RabbitMQ.Stream.Client.AuthMechanism
@@ -23,10 +22,13 @@ RabbitMQ.Stream.Client.ConsumerFilter.PostFilter.get -> System.Func<RabbitMQ.Str
 RabbitMQ.Stream.Client.ConsumerFilter.PostFilter.set -> void
 RabbitMQ.Stream.Client.ConsumerFilter.Values.get -> System.Collections.Generic.List<string>
 RabbitMQ.Stream.Client.ConsumerFilter.Values.set -> void
+RabbitMQ.Stream.Client.ConsumerInfo
+RabbitMQ.Stream.Client.ConsumerInfo.ConsumerInfo(string stream, string reference) -> void
+RabbitMQ.Stream.Client.ConsumerInfo.Reference.get -> string
 RabbitMQ.Stream.Client.CrcException
 RabbitMQ.Stream.Client.CrcException.CrcException(string s) -> void
 RabbitMQ.Stream.Client.HashRoutingMurmurStrategy.Route(RabbitMQ.Stream.Client.Message message, System.Collections.Generic.List<string> partitions) -> System.Threading.Tasks.Task<System.Collections.Generic.List<string>>
-RabbitMQ.Stream.Client.IConsumer.Info.get -> RabbitMQ.Stream.Client.Info
+RabbitMQ.Stream.Client.IConsumer.Info.get -> RabbitMQ.Stream.Client.ConsumerInfo
 RabbitMQ.Stream.Client.IConsumerConfig.Crc32.get -> RabbitMQ.Stream.Client.ICrc32
 RabbitMQ.Stream.Client.IConsumerConfig.Crc32.set -> void
 RabbitMQ.Stream.Client.IConsumerConfig.ConsumerFilter.get -> RabbitMQ.Stream.Client.ConsumerFilter
@@ -57,9 +59,9 @@ RabbitMQ.Stream.Client.IConsumerConfig.InitialCredits.set -> void
 RabbitMQ.Stream.Client.ICrc32
 RabbitMQ.Stream.Client.ICrc32.Hash(byte[] data) -> byte[]
 RabbitMQ.Stream.Client.Info
-RabbitMQ.Stream.Client.Info.Reference.get -> string
+RabbitMQ.Stream.Client.Info.Info(string stream) -> void
 RabbitMQ.Stream.Client.Info.Stream.get -> string
-RabbitMQ.Stream.Client.IProducer.Info.get -> RabbitMQ.Stream.Client.Info
+RabbitMQ.Stream.Client.IProducer.Info.get -> RabbitMQ.Stream.Client.ProducerInfo
 RabbitMQ.Stream.Client.IProducerConfig.Filter.get -> RabbitMQ.Stream.Client.ProducerFilter
 RabbitMQ.Stream.Client.IProducerConfig.Filter.set -> void
 RabbitMQ.Stream.Client.IRoutingStrategy.Route(RabbitMQ.Stream.Client.Message message, System.Collections.Generic.List<string> partitions) -> System.Threading.Tasks.Task<System.Collections.Generic.List<string>>
@@ -71,6 +73,9 @@ RabbitMQ.Stream.Client.OffsetTypeTimestamp.OffsetTypeTimestamp(System.DateTimeOf
 RabbitMQ.Stream.Client.ProducerFilter
 RabbitMQ.Stream.Client.ProducerFilter.FilterValue.get -> System.Func<RabbitMQ.Stream.Client.Message, string>
 RabbitMQ.Stream.Client.ProducerFilter.FilterValue.set -> void
+RabbitMQ.Stream.Client.ProducerInfo
+RabbitMQ.Stream.Client.ProducerInfo.ProducerInfo(string stream, string reference) -> void
+RabbitMQ.Stream.Client.ProducerInfo.Reference.get -> string
 RabbitMQ.Stream.Client.PublishFilter
 RabbitMQ.Stream.Client.PublishFilter.Command.get -> ushort
 RabbitMQ.Stream.Client.PublishFilter.MaxVersion.get -> ushort
@@ -79,10 +84,13 @@ RabbitMQ.Stream.Client.PublishFilter.PublishFilter() -> void
 RabbitMQ.Stream.Client.PublishFilter.PublishFilter(byte publisherId, System.Collections.Generic.List<(ulong, RabbitMQ.Stream.Client.Message)> messages, System.Func<RabbitMQ.Stream.Client.Message, string> filterValueExtractor, Microsoft.Extensions.Logging.ILogger logger) -> void
 RabbitMQ.Stream.Client.PublishFilter.SizeNeeded.get -> int
 RabbitMQ.Stream.Client.PublishFilter.Write(System.Span<byte> span) -> int
-RabbitMQ.Stream.Client.RawSuperStreamConsumer.Info.get -> RabbitMQ.Stream.Client.Info
-RabbitMQ.Stream.Client.RawSuperStreamProducer.Info.get -> RabbitMQ.Stream.Client.Info
+RabbitMQ.Stream.Client.RawConsumer.Info.get -> RabbitMQ.Stream.Client.ConsumerInfo
+RabbitMQ.Stream.Client.RawProducer.Info.get -> RabbitMQ.Stream.Client.ProducerInfo
+RabbitMQ.Stream.Client.RawSuperStreamConsumer.Info.get -> RabbitMQ.Stream.Client.ConsumerInfo
+RabbitMQ.Stream.Client.RawSuperStreamProducer.Info.get -> RabbitMQ.Stream.Client.ProducerInfo
 RabbitMQ.Stream.Client.RawSuperStreamProducerConfig.RoutingStrategyType.get -> RabbitMQ.Stream.Client.RoutingStrategyType
 RabbitMQ.Stream.Client.RawSuperStreamProducerConfig.RoutingStrategyType.set -> void
+RabbitMQ.Stream.Client.Reliable.Consumer.Info.get -> RabbitMQ.Stream.Client.ConsumerInfo
 RabbitMQ.Stream.Client.Reliable.ConsumerConfig.Crc32.get -> RabbitMQ.Stream.Client.ICrc32
 RabbitMQ.Stream.Client.Reliable.ConsumerConfig.Crc32.set -> void
 RabbitMQ.Stream.Client.Reliable.ConsumerConfig.Filter.get -> RabbitMQ.Stream.Client.ConsumerFilter
@@ -92,15 +100,15 @@ RabbitMQ.Stream.Client.Reliable.ConsumerConfig.InitialCredits.set -> void
 RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer
 RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer.Close() -> System.Threading.Tasks.Task
 RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer.GetLastPublishedId() -> System.Threading.Tasks.Task<ulong>
-RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer.Info.get -> RabbitMQ.Stream.Client.Info
+RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer.Info.get -> RabbitMQ.Stream.Client.ProducerInfo
 RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer.IsOpen() -> bool
 RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer.Send(ulong publishing, RabbitMQ.Stream.Client.Message message) -> System.Threading.Tasks.ValueTask
 RabbitMQ.Stream.Client.Reliable.DeduplicatingProducerConfig
 RabbitMQ.Stream.Client.Reliable.DeduplicatingProducerConfig.DeduplicatingProducerConfig(RabbitMQ.Stream.Client.StreamSystem streamSystem, string stream, string reference) -> void
+RabbitMQ.Stream.Client.Reliable.Producer.Info.get -> RabbitMQ.Stream.Client.ProducerInfo
 RabbitMQ.Stream.Client.Reliable.ProducerConfig.Filter.get -> RabbitMQ.Stream.Client.ProducerFilter
 RabbitMQ.Stream.Client.Reliable.ProducerConfig.Filter.set -> void
 RabbitMQ.Stream.Client.Reliable.ProducerConfig.Reference.set -> void
-RabbitMQ.Stream.Client.Reliable.ReliableBase.Info.get -> RabbitMQ.Stream.Client.Info
 RabbitMQ.Stream.Client.Reliable.SuperStreamConfig.RoutingStrategyType.get -> RabbitMQ.Stream.Client.RoutingStrategyType
 RabbitMQ.Stream.Client.Reliable.SuperStreamConfig.RoutingStrategyType.set -> void
 RabbitMQ.Stream.Client.RouteNotFoundException

diff --git a/RabbitMQ.Stream.Client/RawConsumer.cs b/RabbitMQ.Stream.Client/RawConsumer.cs
@@ -140,7 +140,7 @@ private RawConsumer(Client client, RawConsumerConfig config, ILogger logger = nu
             _initialCredits = config.InitialCredits;
             _config = config;
             _logger.LogDebug("Creating... {ConsumerInfo}", ConsumerInfo());
-            Info = new Info(_config.Reference, _config.Stream);
+            Info = new ConsumerInfo(_config.Stream, _config.Reference);
             // _chunksBuffer is a channel that is used to buffer the chunks
             _chunksBuffer = Channel.CreateBounded<Chunk>(new BoundedChannelOptions(_initialCredits)
             {
@@ -643,5 +643,7 @@ public void Dispose()
                 GC.SuppressFinalize(this);
             }
         }
+
+        public ConsumerInfo Info { get; }
     }
 }
diff --git a/RabbitMQ.Stream.Client/RawProducer.cs b/RabbitMQ.Stream.Client/RawProducer.cs
@@ -79,7 +79,7 @@ private RawProducer(Client client, RawProducerConfig config, ILogger logger = nu
         {
             _client = client;
             _config = config;
-            Info = new Info(_config.Reference, _config.Stream);
+            Info = new ProducerInfo(_config.Stream, _config.Reference);
             _messageBuffer = Channel.CreateBounded<OutgoingMsg>(new BoundedChannelOptions(10000)
             {
                 AllowSynchronousContinuations = false,
@@ -403,5 +403,7 @@ public void Dispose()
 
             GC.SuppressFinalize(this);
         }
+
+        public ProducerInfo Info { get; }
     }
 }
diff --git a/RabbitMQ.Stream.Client/RawSuperStreamConsumer.cs b/RabbitMQ.Stream.Client/RawSuperStreamConsumer.cs
@@ -55,7 +55,7 @@ private RawSuperStreamConsumer(
         _streamInfos = streamInfos;
         _clientParameters = clientParameters;
         _logger = logger ?? NullLogger.Instance;
-        Info = new Info(_config.Reference, _config.SuperStream);
+        Info = new ConsumerInfo(_config.SuperStream, _config.Reference);
 
         StartConsumers().Wait(CancellationToken.None);
     }
@@ -219,7 +219,7 @@ public void Dispose()
         GC.SuppressFinalize(this);
     }
 
-    public Info Info { get; internal set; }
+    public ConsumerInfo Info { get; }
 }
 
 public record RawSuperStreamConsumerConfig : IConsumerConfig

diff --git a/RabbitMQ.Stream.Client/RawSuperStreamProducer.cs b/RabbitMQ.Stream.Client/RawSuperStreamProducer.cs
@@ -62,7 +62,7 @@ private RawSuperStreamProducer(
         _config = config;
         _streamInfos = streamInfos;
         _clientParameters = clientParameters;
-        Info = new Info(config.Reference, config.SuperStream);
+        Info = new ProducerInfo(config.SuperStream, config.Reference);
         _defaultRoutingConfiguration.RoutingStrategy = _config.RoutingStrategyType switch
         {
             RoutingStrategyType.Key => new KeyRoutingStrategy(_config.Routing,
@@ -277,7 +277,7 @@ public void Dispose()
     public int IncomingFrames => _producers.Sum(x => x.Value.IncomingFrames);
     public int PublishCommandsSent => _producers.Sum(x => x.Value.PublishCommandsSent);
     public int PendingCount => _producers.Sum(x => x.Value.PendingCount);
-    public Info Info { get; }
+    public ProducerInfo Info { get; }
 }
 
 public enum RoutingStrategyType

diff --git a/RabbitMQ.Stream.Client/Reliable/Consumer.cs b/RabbitMQ.Stream.Client/Reliable/Consumer.cs
@@ -165,7 +165,7 @@ internal Consumer(ConsumerConfig consumerConfig, ILogger<Consumer> logger = null
     {
         _logger = logger ?? NullLogger<Consumer>.Instance;
         _consumerConfig = consumerConfig;
-        Info = new Info(consumerConfig.Reference, consumerConfig.Stream);
+        Info = new ConsumerInfo(consumerConfig.Stream, consumerConfig.Reference);
     }
 
     public static async Task<Consumer> Create(ConsumerConfig consumerConfig, ILogger<Consumer> logger = null)
@@ -213,4 +213,6 @@ public override string ToString()
     {
         return $"Consumer reference: {_consumerConfig.Reference}, stream: {_consumerConfig.Stream} ";
     }
+
+    public ConsumerInfo Info { get; }
 }
diff --git a/RabbitMQ.Stream.Client/Reliable/DeduplicatingProducer.cs b/RabbitMQ.Stream.Client/Reliable/DeduplicatingProducer.cs
@@ -87,5 +87,5 @@ public async Task<ulong> GetLastPublishedId()
         return await _producer.GetLastPublishingId().ConfigureAwait(false);
     }
 
-    public Info Info => _producer.Info;
+    public ProducerInfo Info => _producer.Info;
 }
diff --git a/RabbitMQ.Stream.Client/Reliable/Producer.cs b/RabbitMQ.Stream.Client/Reliable/Producer.cs
@@ -138,7 +138,7 @@ private Producer(ProducerConfig producerConfig, ILogger<Producer> logger = null)
             producerConfig.TimeoutMessageAfter,
             producerConfig.MaxInFlight
         );
-        Info = new Info(producerConfig.Reference, producerConfig.Stream);
+        Info = new ProducerInfo(producerConfig.Stream, producerConfig.Reference);
         _logger = logger ?? NullLogger<Producer>.Instance;
     }
 
@@ -374,4 +374,6 @@ public async ValueTask Send(List<Message> messages)
             SemaphoreSlim.Release();
         }
     }
+
+    public ProducerInfo Info { get; }
 }
diff --git a/RabbitMQ.Stream.Client/Reliable/ReliableBase.cs b/RabbitMQ.Stream.Client/Reliable/ReliableBase.cs
@@ -216,6 +216,4 @@ public bool IsOpen()
     {
         return _isOpen;
     }
-
-    public Info Info { get; internal set; }
 }
diff --git a/Tests/RawConsumerSystemTests.cs b/Tests/RawConsumerSystemTests.cs
@@ -741,17 +741,15 @@ public async void EntityInfoShouldBeCorrect()
             var rawConsumer = await system.CreateRawConsumer(
                 new RawConsumerConfig(stream) { Reference = "consumer", });
 
-            var entityInfo = rawConsumer.Info;
-            Assert.Equal(stream, entityInfo.Stream);
-            Assert.Equal("consumer", entityInfo.Reference);
+            Assert.Equal(stream, rawConsumer.Info.Stream);
+            Assert.Equal("consumer", rawConsumer.Info.Reference);
             await rawConsumer.Close();
 
             var rawProducer = await system.CreateRawProducer(
                 new RawProducerConfig(stream) { Reference = "producer", });
 
-            entityInfo = rawProducer.Info;
-            Assert.Equal(stream, entityInfo.Stream);
-            Assert.Equal("producer", entityInfo.Reference);
+            Assert.Equal(stream, rawProducer.Info.Stream);
+            Assert.Equal("producer", rawProducer.Info.Reference);
             await rawProducer.Close();
 
             var rawSuperStreamProducer = await system.CreateRawSuperStreamProducer(
@@ -761,31 +759,27 @@ public async void EntityInfoShouldBeCorrect()
                     RoutingStrategyType = RoutingStrategyType.Hash,
                     Routing = _ => "OK",
                 });
-            entityInfo = rawSuperStreamProducer.Info;
-            Assert.Equal(SystemUtils.InvoicesExchange, entityInfo.Stream);
-            Assert.Equal("super_producer", entityInfo.Reference);
+            Assert.Equal(SystemUtils.InvoicesExchange, rawSuperStreamProducer.Info.Stream);
+            Assert.Equal("super_producer", rawSuperStreamProducer.Info.Reference);
             await rawSuperStreamProducer.Close();
 
             var rawSuperStreamConsumer = await system.CreateSuperStreamConsumer(
                 new RawSuperStreamConsumerConfig(SystemUtils.InvoicesExchange) { Reference = "super_consumer", });
 
-            entityInfo = rawSuperStreamConsumer.Info;
-            Assert.Equal(SystemUtils.InvoicesExchange, entityInfo.Stream);
-            Assert.Equal("super_consumer", entityInfo.Reference);
+            Assert.Equal(SystemUtils.InvoicesExchange, rawSuperStreamConsumer.Info.Stream);
+            Assert.Equal("super_consumer", rawSuperStreamConsumer.Info.Reference);
             await rawSuperStreamConsumer.Close();
 
             var producer = await Producer.Create(new ProducerConfig(system, stream));
 
-            entityInfo = producer.Info;
-            Assert.Equal(stream, entityInfo.Stream);
-            Assert.True(string.IsNullOrWhiteSpace(entityInfo.Reference));
+            Assert.Equal(stream, producer.Info.Stream);
+            Assert.True(string.IsNullOrWhiteSpace(producer.Info.Reference));
             await producer.Close();
 
             var consumer = await Consumer.Create(new ConsumerConfig(system, stream) { Reference = "consumer", });
 
-            entityInfo = consumer.Info;
-            Assert.Equal(stream, entityInfo.Stream);
-            Assert.Equal("consumer", entityInfo.Reference);
+            Assert.Equal(stream, consumer.Info.Stream);
+            Assert.Equal("consumer", consumer.Info.Reference);
             await consumer.Close();
 
             var producerSuperStream =
@@ -794,9 +788,8 @@ await Producer.Create(new ProducerConfig(system, SystemUtils.InvoicesExchange)
                     SuperStreamConfig = new SuperStreamConfig() { Routing = _ => "OK" }
                 });
 
-            entityInfo = producerSuperStream.Info;
-            Assert.Equal(SystemUtils.InvoicesExchange, entityInfo.Stream);
-            Assert.True(string.IsNullOrWhiteSpace(entityInfo.Reference));
+            Assert.Equal(SystemUtils.InvoicesExchange, producerSuperStream.Info.Stream);
+            Assert.True(string.IsNullOrWhiteSpace(producerSuperStream.Info.Reference));
 
             await producerSuperStream.Close();
 
@@ -806,17 +799,15 @@ await Producer.Create(new ProducerConfig(system, SystemUtils.InvoicesExchange)
                 IsSuperStream = true,
             });
 
-            entityInfo = consumerSuperStream.Info;
-            Assert.Equal(SystemUtils.InvoicesExchange, entityInfo.Stream);
-            Assert.Equal("consumer", entityInfo.Reference);
+            Assert.Equal(SystemUtils.InvoicesExchange, consumerSuperStream.Info.Stream);
+            Assert.Equal("consumer", consumerSuperStream.Info.Reference);
             await consumerSuperStream.Close();
 
             var dedProducer =
                 await DeduplicatingProducer.Create(new DeduplicatingProducerConfig(system, stream, "dedProducer"));
 
-            entityInfo = dedProducer.Info;
-            Assert.Equal(stream, entityInfo.Stream);
-            Assert.Equal("dedProducer", entityInfo.Reference);
+            Assert.Equal(stream, dedProducer.Info.Stream);
+            Assert.Equal("dedProducer", dedProducer.Info.Reference);
             await dedProducer.Close();
 
             await SystemUtils.CleanUpStreamSystem(system, stream);