Merge pull request #104 from dennisdoomen/ExposeProjectionSpeed

Extended the projector stats with the weighted average speed.

LiquidProjections.sln.DotSettings

@@ -51,6 +51,7 @@
 	<s:String x:Key="/Default/CodeStyle/Naming/XamlNaming/UserRules/=NAMESPACE_005FALIAS/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/XamlNaming/UserRules/=XAML_005FFIELD/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/XamlNaming/UserRules/=XAML_005FRESOURCE/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpAttributeForSingleLineMethodUpgrade/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAddAccessorOwnerDeclarationBracesMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateBlankLinesAroundFieldToBlankLinesAroundProperty/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateThisQualifierSettings/@EntryIndexedValue">True</s:Boolean>

NuGet.Config

@@ -4,7 +4,7 @@
     <add key="disableSourceControlIntegration" value="true" />
   </solution>
   <packageSources>
-    <add key="chill ci" value="https://www.myget.org/F/chill/"/>
+    <add key="chill ci" value="https://www.myget.org/F/chill/" />
     <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
   </packageSources>
 </configuration>

Src/LiquidProjections/Statistics/ProjectionStats.cs

@@ -46,6 +46,16 @@ public void LogEvent(string projectorId, string body)
             this[projectorId].LogEvent(body, nowUtc());
         }
 
+        /// <summary>
+        /// Gets the speed in transactions per minute based on a weighted average over the last
+        /// ten minutes, or <c>null</c> if there is not enough information yet.        
+        /// </summary>
+        /// <param name="projectorId"></param>
+        public float? GetSpeed(string projectorId)
+        {
+            return this[projectorId].GetSpeed();
+        }
+
         /// <summary>
         /// Calculates the expected time for the projector identified by <paramref name="projectorId"/> to reach a 
         /// certain <paramref name="targetCheckpoint"/> based on a weighted average over the last 

Src/LiquidProjections/Statistics/ProjectorStats.cs

@@ -54,6 +54,21 @@ public TimestampedCheckpoint LastCheckpoint
             }
         }
 
+        /// <summary>
+        /// Calculates the speed in transactions per second based on a weighted average over the last 10 minutes 
+        /// or <c>null</c> if no information is yet available.
+        /// </summary>
+        public float? GetSpeed()
+        {
+            float? speed = lastMinuteSamples.GetWeightedSpeed();
+
+            speed = (speed == null)
+                ? last10MinuteSamples.GetWeightedSpeed()
+                : last10MinuteSamples.GetWeightedSpeedIncluding(speed.Value);
+
+            return speed;
+        }
+
         /// <summary>
         /// Gets a snapshot of the properties stored for this projector at the time of calling.
         /// </summary>
@@ -100,20 +115,14 @@ public void LogEvent(string body, DateTime timestampUtc)
                 {
                     return TimeSpan.Zero;
                 }
-
-                float speed = lastMinuteSamples.GetWeightedSpeed();
 
-                speed = (speed == 0)
-                    ? last10MinuteSamples.GetWeightedSpeed()
-                    : last10MinuteSamples.GetWeightedSpeedIncluding(speed);
-
-                if (speed == 0)
+                float? speed = GetSpeed();
+                if (speed == null)
                 {
                     return null;
                 }
 
-                float secondsWithFractionalPart = (targetCheckpoint - lastCheckpoint.Checkpoint) / speed;
-
+                float secondsWithFractionalPart = (targetCheckpoint - lastCheckpoint.Checkpoint) / speed.Value;
                 if (secondsWithFractionalPart > long.MaxValue)
                 {
                     return null;

Src/LiquidProjections/Statistics/WeightedProjectionSpeedCalculator.cs

@@ -66,17 +66,17 @@ private void DiscardOlderSamples()
             }
         }
 
-        public float GetWeightedSpeedIncluding(float sample)
+        public float? GetWeightedSpeedIncluding(float sample)
         {
             return GetWeightedSpeed(samples.Concat(new[] { sample }));
         }
 
-        public float GetWeightedSpeed()
+        public float? GetWeightedSpeed()
         {
             return GetWeightedSpeed(samples);
         }
 
-        public float GetWeightedSpeed(IEnumerable<float> effectiveSamples)
+        public float? GetWeightedSpeed(IEnumerable<float> effectiveSamples)
         {
             float weightedSum = 0;
             int weights = 0;
@@ -89,7 +89,7 @@ public float GetWeightedSpeed(IEnumerable<float> effectiveSamples)
                 weightedSum += sample * weight;
             }
 
-            return weights == 0 ? 0 : weightedSum / weights;
+            return (weights == 0) ? (float?) null : weightedSum / weights;
         }
     }
 }

Tests/LiquidProjections.Specs/EventMapSpecs.cs

@@ -65,7 +65,7 @@ await map.Handle(
             [Fact]
             public void It_should_properly_pass_the_mapping_to_the_creating_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = "Hybrids",
@@ -146,7 +146,7 @@ await map.Handle(
             [Fact]
             public void It_should_properly_pass_the_mapping_to_the_creating_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = "Hybrids",
@@ -227,7 +227,7 @@ await map.Handle(
             [Fact]
             public void It_should_properly_pass_the_mapping_to_the_creating_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = "Hybrids",
@@ -305,7 +305,7 @@ await map.Handle(
             [Fact]
             public void It_should_properly_pass_the_mapping_to_the_updating_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = "Hybrids",
@@ -387,7 +387,7 @@ await map.Handle(
             [Fact]
             public void It_should_properly_pass_the_mapping_to_the_updating_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = "Hybrids",
@@ -461,7 +461,7 @@ await map.Handle(
             [Fact]
             public void It_should_properly_pass_the_mapping_to_the_deleting_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = (string) null,
@@ -528,7 +528,7 @@ await map.Handle(
             [Fact]
             public void It_should_properly_pass_the_mapping_to_the_deleting_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = (string)null,
@@ -629,7 +629,7 @@ await map.Handle(
             [Fact]
             public void It_should_not_invoke_any_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = "Electrics",
@@ -680,7 +680,7 @@ await map.Handle(
             [Fact]
             public void It_should_invoke_the_right_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = "Hybrids",
@@ -907,7 +907,7 @@ await map.Handle(
             [Fact]
             public void It_should_invoke_the_right_handler()
             {
-                projection.ShouldBeEquivalentTo(new
+                projection.Should().BeEquivalentTo(new
                 {
                     Id = "c350E",
                     Category = "Hybrids",

Tests/LiquidProjections.Specs/LiquidProjections.Specs.csproj

@@ -34,17 +34,14 @@
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="Chill, Version=3.0.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\Chill.3.0.0\lib\net45\Chill.dll</HintPath>
+    <Reference Include="Chill, Version=3.0.1.0, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Chill.3.0.1\lib\net45\Chill.dll</HintPath>
     </Reference>
-    <Reference Include="FluentAssertions, Version=4.19.2.0, Culture=neutral, PublicKeyToken=33f2691a05b67b6a, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\FluentAssertions.4.19.2\lib\net45\FluentAssertions.dll</HintPath>
+    <Reference Include="FluentAssertions, Version=1.0.0.0, Culture=neutral, PublicKeyToken=33f2691a05b67b6a, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\FluentAssertions.5.0.0-beta0001\lib\net451\FluentAssertions.dll</HintPath>
     </Reference>
-    <Reference Include="FluentAssertions.Core, Version=4.19.2.0, Culture=neutral, PublicKeyToken=33f2691a05b67b6a, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\FluentAssertions.4.19.2\lib\net45\FluentAssertions.Core.dll</HintPath>
-    </Reference>
-    <Reference Include="FluentAssertions.Json, Version=4.19.0.0, Culture=neutral, PublicKeyToken=33f2691a05b67b6a, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\FluentAssertions.Json.4.19.0\lib\net45\FluentAssertions.Json.dll</HintPath>
+    <Reference Include="FluentAssertions.Json, Version=5.0.0.0, Culture=neutral, PublicKeyToken=33f2691a05b67b6a">
+      <HintPath>..\..\packages\FluentAssertions.Json.5.0.0-beta0003\lib\net451\FluentAssertions.Json.dll</HintPath>
     </Reference>
     <Reference Include="Microsoft.Owin, Version=3.1.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <HintPath>..\..\packages\Microsoft.Owin.3.1.0\lib\net45\Microsoft.Owin.dll</HintPath>
@@ -116,11 +113,11 @@
     <None Include="packages.config" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
-  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
-       Other similar extension points exist, see Microsoft.Common.targets.
-  <Target Name="BeforeBuild">
-  </Target>
-  <Target Name="AfterBuild">
-  </Target>
+  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
+       Other similar extension points exist, see Microsoft.Common.targets.
+  <Target Name="BeforeBuild">
+  </Target>
+  <Target Name="AfterBuild">
+  </Target>
   -->
 </Project>

Tests/LiquidProjections.Specs/ProjectionStatsSpecs.cs

@@ -56,7 +56,7 @@ public void When_multiple_properties_are_registered_under_the_same_name_it_shoul
             var projectorStats = stats.GetForAllProjectors().Should().ContainSingle(s => s.ProjectorId == "myProjector").Subject;
 
             projectorStats.GetProperties().Should().ContainKey("theName");
-            projectorStats.GetProperties()["theName"].ShouldBeEquivalentTo(new
+            projectorStats.GetProperties()["theName"].Should().BeEquivalentTo(new
             {
                 Value = "anotherValue",
                 TimestampUtc = nowUtc
@@ -86,14 +86,14 @@ public void When_multiple_properties_are_registered_under_different_names_it_sho
             var projectorStats = stats.GetForAllProjectors().Should().ContainSingle(s => s.ProjectorId == "myProjector").Subject;
 
             projectorStats.GetProperties().Should().ContainKey("aName");
-            projectorStats.GetProperties()["aName"].ShouldBeEquivalentTo(new
+            projectorStats.GetProperties()["aName"].Should().BeEquivalentTo(new
             {
                 Value = "aValue",
                 TimestampUtc = firstUtc
             });
 
             projectorStats.GetProperties().Should().ContainKey("anotherName");
-            projectorStats.GetProperties()["anotherName"].ShouldBeEquivalentTo(new
+            projectorStats.GetProperties()["anotherName"].Should().BeEquivalentTo(new
             {
                 Value = "anotherValue",
                 TimestampUtc = nowUtc
@@ -122,7 +122,7 @@ public void When_multiple_events_are_registered_it_should_remember_their_timesta
             // Assert
             //-----------------------------------------------------------------------------------------------------------
             var projectorStats = stats.GetForAllProjectors().Should().ContainSingle(s => s.ProjectorId == "myProjector").Subject;
-            projectorStats.GetEvents().ShouldAllBeEquivalentTo(new[]
+            projectorStats.GetEvents().Should().BeEquivalentTo(new[]
             {
                 new
                 {
@@ -168,6 +168,8 @@ public void When_the_projector_runs_at_a_constant_speed_it_should_use_that_to_ca
             //-----------------------------------------------------------------------------------------------------------
             TimeSpan? eta = stats.GetTimeToReach("myProjector", 100000);
 
+            stats.GetSpeed("myProjector").Should().Be(transactionsPerSecond);
+
             long secondsToComplete = (100000 - checkpoint) / transactionsPerSecond;
 
             eta.Should().Be(TimeSpan.FromSeconds(secondsToComplete));
@@ -202,6 +204,7 @@ public void When_the_projector_runs_at_a_very_low_speed_it_should_still_calculat
             //-----------------------------------------------------------------------------------------------------------
             // Assert
             //-----------------------------------------------------------------------------------------------------------
+
             TimeSpan? eta = stats.GetTimeToReach("myProjector", 100000);
 
             long secondsToComplete =((100000 - checkpoint) / transactionsPer5Seconds * 5);
@@ -242,6 +245,8 @@ public void When_the_projectors_speed_increases_it_should_favor_the_higher_speed
             TimeSpan? eta = stats.GetTimeToReach("myProjector", checkpoint + 100000);
 
             long weightedAveragePerSecond = 4550;
+            stats.GetSpeed("myProjector").Should().Be(weightedAveragePerSecond);
+
 
             long secondsToComplete = 100000 / weightedAveragePerSecond;
 
@@ -281,6 +286,7 @@ public void When_the_projectors_speed_decreases_it_should_favor_the_lower_speed_
             TimeSpan? eta = stats.GetTimeToReach("myProjector", checkpoint + 100000);
 
             long weightedAveragePerSecond = 645;
+            stats.GetSpeed("myProjector").Should().Be(weightedAveragePerSecond);
 
             long secondsToComplete = 100000 / weightedAveragePerSecond;
 
@@ -342,6 +348,7 @@ public void When_the_projector_runs_for_more_than_10_minutes_it_should_only_eval
             long secondsToComplete = (long) (100000 / precalculatedWeightedAveragePerSecond);
 
             eta.Should().Be(TimeSpan.FromSeconds(secondsToComplete));
+            stats.GetSpeed("myProjector").Should().BeApproximately(precalculatedWeightedAveragePerSecond, 1);
         }
 
         [Fact]
@@ -363,8 +370,8 @@ public void When_the_projector_is_ahead_of_the_requested_checkpoint_the_eta_shou
             //-----------------------------------------------------------------------------------------------------------
             // Assert
             //-----------------------------------------------------------------------------------------------------------
-            TimeSpan? eta = stats.GetTimeToReach("myProjector", 5000);
-            eta.Should().Be(TimeSpan.Zero);
+            stats.GetSpeed("myProjector").Should().Be((10000-1000) / 120);
+            stats.GetTimeToReach("myProjector", 5000).Should().Be(TimeSpan.Zero);
         }
 
         [Fact]
@@ -384,6 +391,8 @@ public void When_the_projector_has_not_checked_in_yet_it_should_not_provide_an_e
             // Assert
             //-----------------------------------------------------------------------------------------------------------
             eta.Should().NotHaveValue();
+
+            stats.GetSpeed("myProjector").Should().BeNull();
         }
     }
 }

Tests/LiquidProjections.Specs/ProjectorSpecs.cs

@@ -110,7 +110,7 @@ public void Then_it_should_have_executed_the_custom_action()
             [Fact]
             public void Then_it_should_have_created_the_context()
             {
-                context.ShouldBeEquivalentTo(new ProjectionContext
+                context.Should().BeEquivalentTo(new ProjectionContext
                 {
                     Checkpoint = 111,
                     TransactionId = "MyTransactionId",
@@ -276,7 +276,7 @@ public void Then_it_should_include_the_current_transaction_batch_into_the_projec
             {
                 ProjectionExceptions.Should().ContainSingle()
                     .Which.Should().BeOfType<ProjectionException>()
-                    .Which.TransactionBatch.Should().BeEquivalentTo(The<Transaction>());
+                    .Which.TransactionBatch.Should().AllBeEquivalentTo(The<Transaction>());
             }
         }
 

Tests/LiquidProjections.Specs/packages.config

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Chill" version="3.0.0" targetFramework="net452" />
-  <package id="FluentAssertions" version="4.19.2" targetFramework="net452" />
-  <package id="FluentAssertions.Json" version="4.19.0" targetFramework="net452" />
+  <package id="Chill" version="3.0.1" targetFramework="net452" />
+  <package id="FluentAssertions" version="5.0.0-beta0001" targetFramework="net452" />
+  <package id="FluentAssertions.Json" version="5.0.0-beta0003" targetFramework="net452" />
   <package id="Microsoft.Owin" version="3.1.0" targetFramework="net452" />
   <package id="Newtonsoft.Json" version="10.0.3" targetFramework="net452" />
   <package id="Owin" version="1.0" targetFramework="net452" />