ISorted and SortBySortIndex

Directory.Build.props

@@ -5,7 +5,7 @@
     <Description>Silverback is a simple framework to build reactive, event-driven, microservices.</Description>
     <License>MIT</License>
     <Copyright>Copyright (c) 2019 Sergio Aquilini</Copyright>
-    <VersionSuffix>-rc2</VersionSuffix>
+    <VersionSuffix>-rc3</VersionSuffix>
     <BaseVersion>1.1.0$(VersionSuffix)</BaseVersion>
     <ProjectUrl>https://beagle1984.github.io/silverback/</ProjectUrl>
     <RepositoryUrl>https://github.com/BEagle1984/silverback/</RepositoryUrl>

docs/_docs/0-introduction/003-releases.md

@@ -4,11 +4,15 @@ permalink: /docs/releases
 toc: true
 ---
 
-## [1.1.0-rc2](https://github.com/BEagle1984/silverback/releases/tag/1.1.0-rc2)
+## [1.1.0-rc3](https://github.com/BEagle1984/silverback/releases/tag/1.1.0-rc3)
 
 ### What's new
 * Added `IEndpointsConfigurator` interface to allow splitting the endpoints configuration across multiple types (see [Connecting to a Message Broker]({{ site.baseurl }}/docs/quickstart/message-broker#using-iendpointsconfigurator))
 * Added support for distributed tracing (based on standard [System.Diagnostics.DiagnosticSource](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/))
+* Added `IProducerBehavior` and `IConsumerBehavior` to create an extension point closer to the actual message broker logic (see [Behaviors]({{ site.baseurl }}/docs/quickstart/behaviors))
+
+### Breaking Changes
+* `ISortedBehavior` was removed and replaced by a generic `ISorted` interface
 
 ## [1.0.5](https://github.com/BEagle1984/silverback/releases/tag/1.0.5)
 

docs/_docs/1-quickstart/107-behaviors.md

@@ -4,12 +4,14 @@ permalink: /docs/quickstart/behaviors
 toc: false
 ---
 
-Behaviors can be used to build a custom pipeline (similar to the asp.net pipeline), easily adding your cross-cutting functionalities such as logging, validation, etc.
+The behaviors can be used to build a custom pipeline (similar to the asp.net pipeline), easily adding your cross-cutting functionalities such as logging, validation, etc.
+
+## IBehavior
 
 A behavior must implement the `IBehavior` interface and be registered for dependency injection.
 
 ```c#
-using Silverback.Messaging.Subscribers;
+using Silverback.Messaging.Publishing;
 
 public class ValidationBehavior : IBehavior
 {
@@ -43,7 +45,7 @@ public void ConfigureServices(IServiceCollection services)
 
 At every call to `IPublisher.Publish` the `Handle` method of each registered behavior is called, passing in the array of messages and the delegate to the next step in the pipeline. This gives you the flexibility to execute any sort of code before and after the messages have been actually published (before or after calling the `next()` step). You can for example modify the messages before publishing them, validate them (like in the above example), add some logging / tracing, etc.
 
-## Message headers
+### Example: Message headers
 
 The behaviors can be quite useful to get and set the message headers for inbound/outbound messages.
 
@@ -99,4 +101,8 @@ public class LogHeadersBehavior : IBehavior
 ```
 
 **Note:** `IInboundMessage` and `IOutboundMessage` are internally used by Silverback to wrap the messages being sent to or received from the message broker.
-{: .notice--info}
+{: .notice--info}
+
+## IProducerBehavior and IConsumerBehavior
+
+The `IProducerBehavior` and `IConsumerBehavior` are similar to the `IBehavior` but work at a lower level, much closer to the message broker. You should be able to accomplish most tasks with the normal `IBehavior`.

src/Silverback.Core/Messaging/Publishing/ISortedBehavior.cs → src/Silverback.Core/ISorted.cs

@@ -1,9 +1,9 @@
 // Copyright (c) 2019 Sergio Aquilini
 // This code is licensed under MIT license (see LICENSE file for details)
 
-namespace Silverback.Messaging.Publishing
+namespace Silverback
 {
-    public interface ISortedBehavior : IBehavior
+    public interface ISorted
     {
         int SortIndex { get; }
     }

src/Silverback.Core/Messaging/Publishing/Publisher.cs

@@ -102,23 +102,8 @@ private Task<IEnumerable<object>> InvokeNonExclusiveMethods(IEnumerable<object>
                 .ParallelSelectManyAsync(method =>
                     GetMethodInvoker().Invoke(method, messages, executeAsync));
 
-        private IEnumerable<IBehavior> GetBehaviors()
-        {
-            if (_behaviors == null)
-            {
-                var behaviors = _serviceProvider.GetServices<IBehavior>();
-                var sortedBehaviors = behaviors.OfType<ISortedBehavior>().OrderBy(b => b.SortIndex).ToList();
-                behaviors = behaviors.Where(b => !(b is ISortedBehavior)).ToList();
-
-                _behaviors =
-                    sortedBehaviors.Where(b => b.SortIndex <= 0)
-                        .Union(behaviors)
-                        .Union(sortedBehaviors.Where(b => b.SortIndex > 0))
-                        .ToList();
-            }
-
-            return _behaviors;
-        }
+        private IEnumerable<IBehavior> GetBehaviors() =>
+            _behaviors ??= _serviceProvider.GetServices<IBehavior>().SortBySortIndex();
 
         private SubscribedMethodInvoker GetMethodInvoker() =>
             _methodInvoker ??= _serviceProvider.GetRequiredService<SubscribedMethodInvoker>();

src/Silverback.Core/Util/EnumerableSortExtensions.cs

@@ -0,0 +1,23 @@
+// Copyright (c) 2019 Sergio Aquilini
+// This code is licensed under MIT license (see LICENSE file for details)
+
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Silverback.Util
+{
+    internal static class EnumerableSortExtensions
+    {
+        public static IEnumerable<T> SortBySortIndex<T>(this IEnumerable<T> items)
+        {
+            var sorted = items.OfType<ISorted>().OrderBy(b => b.SortIndex).ToList();
+            var unsortable = items.Where(b => !(b is ISorted)).ToList();
+
+            return sorted
+                .Where(b => b.SortIndex <= 0).Cast<T>()
+                .Union(unsortable)
+                .Union(sorted.Where(b => b.SortIndex > 0).Cast<T>())
+                .ToList();
+        }
+    }
+}

src/Silverback.Integration.Kafka/Messaging/Behaviors/KafkaPartitioningKeyBehavior.cs

@@ -12,7 +12,7 @@
 
 namespace Silverback.Messaging.Behaviors
 {
-    public class KafkaPartitioningKeyBehavior : ISortedBehavior
+    public class KafkaPartitioningKeyBehavior : IBehavior, ISorted
     {
         public int SortIndex { get; } = 200;
 

src/Silverback.Integration/Messaging/Connectors/Behaviors/OutboundProducingBehavior.cs

@@ -12,7 +12,7 @@
 
 namespace Silverback.Messaging.Connectors.Behaviors
 {
-    public class OutboundProducingBehavior : ISortedBehavior
+    public class OutboundProducingBehavior : IBehavior, ISorted
     {
         private readonly IEnumerable<IOutboundConnector> _outboundConnectors;
 

src/Silverback.Integration/Messaging/Connectors/Behaviors/OutboundRoutingBehavior.cs

@@ -13,7 +13,7 @@
 
 namespace Silverback.Messaging.Connectors.Behaviors
 {
-    public class OutboundRoutingBehavior : ISortedBehavior
+    public class OutboundRoutingBehavior : IBehavior, ISorted
     {
         private readonly IServiceProvider _serviceProvider;
         private readonly IOutboundRoutingConfiguration _routing;

tests/Silverback.Core.Tests/TestTypes/Behaviors/TestSortedBehavior.cs

@@ -7,7 +7,7 @@
 
 namespace Silverback.Tests.Core.TestTypes.Behaviors
 {
-    public class TestSortedBehavior : ISortedBehavior
+    public class TestSortedBehavior : IBehavior, ISorted
     {
         private readonly List<string> _calls;
 

tests/Silverback.Core.Tests/Util/EnumerableExtensionsTests.cs → tests/Silverback.Core.Tests/Util/EnumerableForEachExtensionsTests.cs

@@ -9,7 +9,7 @@
 
 namespace Silverback.Tests.Core.Util
 {
-    public class EnumerableForEachExtensions
+    public class EnumerableForEachExtensionsTests
     {
         [Fact]
         public void ForEachTest()

tests/Silverback.Core.Tests/Util/EnumerableSortExtensionsTests.cs

@@ -0,0 +1,53 @@
+// Copyright (c) 2019 Sergio Aquilini
+// This code is licensed under MIT license (see LICENSE file for details)
+
+using System.Collections.Generic;
+using FluentAssertions;
+using Silverback.Messaging.Publishing;
+using Silverback.Tests.Core.TestTypes.Behaviors;
+using Silverback.Tests.Core.TestTypes.Messages;
+using Silverback.Util;
+using Xunit;
+
+namespace Silverback.Tests.Core.Util
+{
+    public class EnumerableSortExtensionsTests
+    {
+        [Fact]
+        public void SortBySortIndex_SomeItems_SortedAsExpected()
+        {
+            var items = new[]
+            {
+                new SortedItem(100),
+                new SortedItem(-50),
+                new SortedItem(50),
+                new SortedItem(-100),
+                new Item("unsorted3"),
+                new Item("unsorted2")
+            };
+
+            var sorted = items.SortBySortIndex();
+
+            sorted.Should().BeEquivalentTo(
+                new SortedItem(-100),
+                new SortedItem(-50),
+                new Item("unsorted3"),
+                new Item("unsorted2"),
+                new SortedItem(50),
+                new SortedItem(100)
+            );
+        }
+
+        private class Item
+        {
+            public Item(string id) => Id = id;
+            public string Id { get; }
+        }
+
+        private class SortedItem : Item, ISorted
+        {
+            public SortedItem(int sortIndex) : base(sortIndex.ToString()) => SortIndex = sortIndex;
+            public int SortIndex { get;}
+        }
+    }
+}