Add Info class to the Producer/Consumer classes (#322)

Gsantomaggio · web-flow · commit e37f2a27b6de · 2023-10-11T13:10:01.000+02:00
The call returns the Reference and Stream.
Note that for the producer class the Reference is deprecated and it will be removed
at some point. So the info.reference for the producer will be removed as well.

We can add other info about the consumer and the consumer in the future.

Signed-off-by: Gabriele Santomaggio &lt;G.santomaggio@gmail.com&gt;
diff --git a/RabbitMQ.Stream.Client/AbstractEntity.cs b/RabbitMQ.Stream.Client/AbstractEntity.cs
@@ -21,5 +21,7 @@ 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
@@ -0,0 +1,17 @@
+﻿// This source code is dual-licensed under the Apache License, version
+// 2.0, and the Mozilla Public License, version 2.0.
+// Copyright (c) 2007-2023 VMware, Inc.
+
+namespace RabbitMQ.Stream.Client;
+
+public class Info
+{
+    public string Reference { get; }
+    public string Stream { get; }
+
+    internal Info(string reference, string stream)
+    {
+        Reference = reference;
+        Stream = stream;
+    }
+}
diff --git a/RabbitMQ.Stream.Client/IConsumer.cs b/RabbitMQ.Stream.Client/IConsumer.cs
@@ -12,6 +12,8 @@ public interface IConsumer
     public Task StoreOffset(ulong offset);
     public Task<ResponseCode> Close();
     public void Dispose();
+
+    public Info Info { get; }
 }
 
 public record IConsumerConfig : INamedEntity
diff --git a/RabbitMQ.Stream.Client/IProducer.cs b/RabbitMQ.Stream.Client/IProducer.cs
@@ -67,6 +67,11 @@ public interface IProducer
     public int PublishCommandsSent { get; }
 
     public int PendingCount { get; }
+
+    /// <summary>
+    /// Info contains the reference and the stream name.
+    /// </summary>
+    public Info Info { get; }
 }
 
 public record ProducerFilter
diff --git a/RabbitMQ.Stream.Client/PublicAPI.Unshipped.txt b/RabbitMQ.Stream.Client/PublicAPI.Unshipped.txt
@@ -1,5 +1,6 @@
 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
@@ -25,6 +26,7 @@ RabbitMQ.Stream.Client.ConsumerFilter.Values.set -> void
 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.IConsumerConfig.Crc32.get -> RabbitMQ.Stream.Client.ICrc32
 RabbitMQ.Stream.Client.IConsumerConfig.Crc32.set -> void
 RabbitMQ.Stream.Client.IConsumerConfig.ConsumerFilter.get -> RabbitMQ.Stream.Client.ConsumerFilter
@@ -54,6 +56,10 @@ RabbitMQ.Stream.Client.IConsumerConfig.InitialCredits.get -> ushort
 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.Stream.get -> string
+RabbitMQ.Stream.Client.IProducer.Info.get -> RabbitMQ.Stream.Client.Info
 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>>
@@ -73,6 +79,8 @@ 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.RawSuperStreamProducerConfig.RoutingStrategyType.get -> RabbitMQ.Stream.Client.RoutingStrategyType
 RabbitMQ.Stream.Client.RawSuperStreamProducerConfig.RoutingStrategyType.set -> void
 RabbitMQ.Stream.Client.Reliable.ConsumerConfig.Crc32.get -> RabbitMQ.Stream.Client.ICrc32
@@ -84,13 +92,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.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.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);
             // _chunksBuffer is a channel that is used to buffer the chunks
             _chunksBuffer = Channel.CreateBounded<Chunk>(new BoundedChannelOptions(_initialCredits)
             {
diff --git a/RabbitMQ.Stream.Client/RawProducer.cs b/RabbitMQ.Stream.Client/RawProducer.cs
@@ -79,6 +79,7 @@ private RawProducer(Client client, RawProducerConfig config, ILogger logger = nu
         {
             _client = client;
             _config = config;
+            Info = new Info(_config.Reference, _config.Stream);
             _messageBuffer = Channel.CreateBounded<OutgoingMsg>(new BoundedChannelOptions(10000)
             {
                 AllowSynchronousContinuations = false,
diff --git a/RabbitMQ.Stream.Client/RawSuperStreamConsumer.cs b/RabbitMQ.Stream.Client/RawSuperStreamConsumer.cs
@@ -55,6 +55,7 @@ private RawSuperStreamConsumer(
         _streamInfos = streamInfos;
         _clientParameters = clientParameters;
         _logger = logger ?? NullLogger.Instance;
+        Info = new Info(_config.Reference, _config.SuperStream);
 
         StartConsumers().Wait(CancellationToken.None);
     }
@@ -217,6 +218,8 @@ public void Dispose()
         _disposed = true;
         GC.SuppressFinalize(this);
     }
+
+    public Info Info { get; internal set; }
 }
 
 public record RawSuperStreamConsumerConfig : IConsumerConfig
diff --git a/RabbitMQ.Stream.Client/RawSuperStreamProducer.cs b/RabbitMQ.Stream.Client/RawSuperStreamProducer.cs
@@ -56,13 +56,13 @@ public static IProducer Create(
     private RawSuperStreamProducer(
         RawSuperStreamProducerConfig config,
         IDictionary<string, StreamInfo> streamInfos,
-        ClientParameters clientParameters,
-        ILogger logger = null
+        ClientParameters clientParameters, ILogger logger = null
     )
     {
         _config = config;
         _streamInfos = streamInfos;
         _clientParameters = clientParameters;
+        Info = new Info(config.Reference, config.SuperStream);
         _defaultRoutingConfiguration.RoutingStrategy = _config.RoutingStrategyType switch
         {
             RoutingStrategyType.Key => new KeyRoutingStrategy(_config.Routing,
@@ -277,6 +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 enum RoutingStrategyType
diff --git a/RabbitMQ.Stream.Client/Reliable/Consumer.cs b/RabbitMQ.Stream.Client/Reliable/Consumer.cs
@@ -165,6 +165,7 @@ internal Consumer(ConsumerConfig consumerConfig, ILogger<Consumer> logger = null
     {
         _logger = logger ?? NullLogger<Consumer>.Instance;
         _consumerConfig = consumerConfig;
+        Info = new Info(consumerConfig.Reference, consumerConfig.Stream);
     }
 
     public static async Task<Consumer> Create(ConsumerConfig consumerConfig, ILogger<Consumer> logger = null)
diff --git a/RabbitMQ.Stream.Client/Reliable/DeduplicatingProducer.cs b/RabbitMQ.Stream.Client/Reliable/DeduplicatingProducer.cs
@@ -86,4 +86,6 @@ public async Task<ulong> GetLastPublishedId()
     {
         return await _producer.GetLastPublishingId().ConfigureAwait(false);
     }
+
+    public Info Info => _producer.Info;
 }
diff --git a/RabbitMQ.Stream.Client/Reliable/Producer.cs b/RabbitMQ.Stream.Client/Reliable/Producer.cs
@@ -138,6 +138,7 @@ private Producer(ProducerConfig producerConfig, ILogger<Producer> logger = null)
             producerConfig.TimeoutMessageAfter,
             producerConfig.MaxInFlight
         );
+        Info = new Info(producerConfig.Reference, producerConfig.Stream);
         _logger = logger ?? NullLogger<Producer>.Instance;
     }
 
diff --git a/RabbitMQ.Stream.Client/Reliable/ReliableBase.cs b/RabbitMQ.Stream.Client/Reliable/ReliableBase.cs
@@ -216,4 +216,6 @@ public bool IsOpen()
     {
         return _isOpen;
     }
+
+    public Info Info { get; internal set; }
 }
diff --git a/Tests/RawConsumerSystemTests.cs b/Tests/RawConsumerSystemTests.cs
@@ -732,5 +732,94 @@ public async void ShouldConsumeFromDateTimeOffset()
             await consumer.Close().ConfigureAwait(false);
             await SystemUtils.CleanUpStreamSystem(system, stream);
         }
+
+        [Fact]
+        public async void EntityInfoShouldBeCorrect()
+        {
+            SystemUtils.ResetSuperStreams();
+            SystemUtils.InitStreamSystemWithRandomStream(out var system, out var stream);
+            var rawConsumer = await system.CreateRawConsumer(
+                new RawConsumerConfig(stream) { Reference = "consumer", });
+
+            var entityInfo = rawConsumer.Info;
+            Assert.Equal(stream, entityInfo.Stream);
+            Assert.Equal("consumer", entityInfo.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);
+            await rawProducer.Close();
+
+            var rawSuperStreamProducer = await system.CreateRawSuperStreamProducer(
+                new RawSuperStreamProducerConfig(SystemUtils.InvoicesExchange)
+                {
+                    Reference = "super_producer",
+                    RoutingStrategyType = RoutingStrategyType.Hash,
+                    Routing = _ => "OK",
+                });
+            entityInfo = rawSuperStreamProducer.Info;
+            Assert.Equal(SystemUtils.InvoicesExchange, entityInfo.Stream);
+            Assert.Equal("super_producer", entityInfo.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);
+            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));
+            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);
+            await consumer.Close();
+
+            var producerSuperStream =
+                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));
+
+            await producerSuperStream.Close();
+
+            var consumerSuperStream = await Consumer.Create(new ConsumerConfig(system, SystemUtils.InvoicesExchange)
+            {
+                Reference = "consumer",
+                IsSuperStream = true,
+            });
+
+            entityInfo = consumerSuperStream.Info;
+            Assert.Equal(SystemUtils.InvoicesExchange, entityInfo.Stream);
+            Assert.Equal("consumer", entityInfo.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);
+            await dedProducer.Close();
+
+            await SystemUtils.CleanUpStreamSystem(system, stream);
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,7 @@ protected void MaybeCancelToken()`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`protected Client _client;`
	`24`	`+`
	`25`	`+ public Info Info { get; internal set; }`
`24`	`26`	`}`
`25`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@ public interface IConsumer`
`12`	`12`	`public Task StoreOffset(ulong offset);`
`13`	`13`	`public Task<ResponseCode> Close();`
`14`	`14`	`public void Dispose();`
	`15`	`+`
	`16`	`+ public Info Info { get; }`
`15`	`17`	`}`
`16`	`18`
`17`	`19`	`public record IConsumerConfig : INamedEntity`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ private RawConsumer(Client client, RawConsumerConfig config, ILogger logger = nu`
`140`	`140`	`_initialCredits = config.InitialCredits;`
`141`	`141`	`_config = config;`
`142`	`142`	`_logger.LogDebug("Creating... {ConsumerInfo}", ConsumerInfo());`
`143`		`-`
	`143`	`+ Info = new Info(_config.Reference, _config.Stream);`
`144`	`144`	`// _chunksBuffer is a channel that is used to buffer the chunks`
`145`	`145`	`_chunksBuffer = Channel.CreateBounded<Chunk>(new BoundedChannelOptions(_initialCredits)`
`146`	`146`	`{`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,7 @@ private RawProducer(Client client, RawProducerConfig config, ILogger logger = nu`
`79`	`79`	`{`
`80`	`80`	`_client = client;`
`81`	`81`	`_config = config;`
	`82`	`+ Info = new Info(_config.Reference, _config.Stream);`
`82`	`83`	`_messageBuffer = Channel.CreateBounded<OutgoingMsg>(new BoundedChannelOptions(10000)`
`83`	`84`	`{`
`84`	`85`	`AllowSynchronousContinuations = false,`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ private RawSuperStreamConsumer(`
`55`	`55`	`_streamInfos = streamInfos;`
`56`	`56`	`_clientParameters = clientParameters;`
`57`	`57`	`_logger = logger ?? NullLogger.Instance;`
	`58`	`+ Info = new Info(_config.Reference, _config.SuperStream);`
`58`	`59`
`59`	`60`	`StartConsumers().Wait(CancellationToken.None);`
`60`	`61`	`}`
`@@ -217,6 +218,8 @@ public void Dispose()`
`217`	`218`	`_disposed = true;`
`218`	`219`	`GC.SuppressFinalize(this);`
`219`	`220`	`}`
	`221`	`+`
	`222`	`+ public Info Info { get; internal set; }`
`220`	`223`	`}`
`221`	`224`
`222`	`225`	`public record RawSuperStreamConsumerConfig : IConsumerConfig`
Original file line number	Diff line number	Diff line change
`@@ -56,13 +56,13 @@ public static IProducer Create(`
`56`	`56`	`private RawSuperStreamProducer(`
`57`	`57`	`RawSuperStreamProducerConfig config,`
`58`	`58`	`IDictionary<string, StreamInfo> streamInfos,`
`59`		`- ClientParameters clientParameters,`
`60`		`- ILogger logger = null`
	`59`	`+ ClientParameters clientParameters, ILogger logger = null`
`61`	`60`	`)`
`62`	`61`	`{`
`63`	`62`	`_config = config;`
`64`	`63`	`_streamInfos = streamInfos;`
`65`	`64`	`_clientParameters = clientParameters;`
	`65`	`+ Info = new Info(config.Reference, config.SuperStream);`
`66`	`66`	`_defaultRoutingConfiguration.RoutingStrategy = _config.RoutingStrategyType switch`
`67`	`67`	`{`
`68`	`68`	`RoutingStrategyType.Key => new KeyRoutingStrategy(_config.Routing,`
`@@ -277,6 +277,7 @@ public void Dispose()`
`277`	`277`	`public int IncomingFrames => _producers.Sum(x => x.Value.IncomingFrames);`
`278`	`278`	`public int PublishCommandsSent => _producers.Sum(x => x.Value.PublishCommandsSent);`
`279`	`279`	`public int PendingCount => _producers.Sum(x => x.Value.PendingCount);`
	`280`	`+ public Info Info { get; }`
`280`	`281`	`}`
`281`	`282`
`282`	`283`	`public enum RoutingStrategyType`
Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,7 @@ internal Consumer(ConsumerConfig consumerConfig, ILogger<Consumer> logger = null`
`165`	`165`	`{`
`166`	`166`	`_logger = logger ?? NullLogger<Consumer>.Instance;`
`167`	`167`	`_consumerConfig = consumerConfig;`
	`168`	`+ Info = new Info(consumerConfig.Reference, consumerConfig.Stream);`
`168`	`169`	`}`
`169`	`170`
`170`	`171`	`public static async Task<Consumer> Create(ConsumerConfig consumerConfig, ILogger<Consumer> logger = null)`