CDMS-200 adds total import notifications and movements to analytics d…

…ashboard (#44)
DEFRA · Jan 8, 2025 · 438d3b2 · 438d3b2
1 parent 56abf11
commit 438d3b2
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 16 deletions.
diff --git a/Btms.Analytics.Tests/ImportNotificationsByMaxVersionTests.cs b/Btms.Analytics.Tests/ImportNotificationsByMaxVersionTests.cs
@@ -30,21 +30,20 @@ public async Task WhenCalledLastMonth_ReturnExpectedAggregation()
     public async Task WhenCalledLast48Hours_ReturnExpectedAggregation()
     {
         TestOutputHelper.WriteLine("Querying for aggregated data");
-        var result = (await GetImportNotificationsAggregationService()
-            .ByMaxVersion(DateTime.Now.NextHour().AddDays(-2), DateTime.Now.NextHour()));
+        var result = await ImportNotificationsAggregationService
+            .ByMaxVersion(DateTime.Now.NextHour().AddDays(-2), DateTime.Now.NextHour());
 
         TestOutputHelper.WriteLine($"{result.Values.Count} aggregated items found");
 
         result.Values.Count.Should().Be(1);
-
     }
 
     [Fact]
     public async Task WhenCalledWithTimePeriodYieldingNoResults_ReturnEmptyAggregation()
     {
         TestOutputHelper.WriteLine("Querying for aggregated data");
-        var result = (await GetImportNotificationsAggregationService()
-            .ByMaxVersion(DateTime.MaxValue.AddDays(-1), DateTime.MaxValue));
+        var result = await ImportNotificationsAggregationService
+            .ByMaxVersion(DateTime.MaxValue.AddDays(-1), DateTime.MaxValue);
 
         TestOutputHelper.WriteLine($"{result.Values.Count} aggregated items found");
 
@@ -55,8 +54,8 @@ public async Task WhenCalledWithTimePeriodYieldingNoResults_ReturnEmptyAggregati
     public async Task WhenCalledWithChedType_ReturnsResults()
     {
         TestOutputHelper.WriteLine("Querying for aggregated data");
-        var result = (await GetImportNotificationsAggregationService()
-            .ByMaxVersion(DateTime.Now.NextHour().AddDays(-2), DateTime.Now.NextHour(), chedTypes: [ImportNotificationTypeEnum.Cveda]));
+        var result = await ImportNotificationsAggregationService
+            .ByMaxVersion(DateTime.Now.NextHour().AddDays(-2), DateTime.Now.NextHour(), chedTypes: [ImportNotificationTypeEnum.Cveda]);
 
         TestOutputHelper.WriteLine($"{result.Values.Count} aggregated items found");
 
@@ -67,8 +66,8 @@ public async Task WhenCalledWithChedType_ReturnsResults()
     public async Task WhenCalledWithCountry_ReturnsResults()
     {
         TestOutputHelper.WriteLine("Querying for aggregated data");
-        var result = (await GetImportNotificationsAggregationService()
-            .ByMaxVersion(DateTime.Now.NextHour().AddDays(-2), DateTime.Now.NextHour(), country: "ES"));
+        var result = await ImportNotificationsAggregationService
+            .ByMaxVersion(DateTime.Now.NextHour().AddDays(-2), DateTime.Now.NextHour(), country: "ES");
 
         TestOutputHelper.WriteLine($"{result.Values.Count} aggregated items found");
 

diff --git a/Btms.Analytics/IImportNotificationsAggregationService.cs b/Btms.Analytics/IImportNotificationsAggregationService.cs
@@ -6,7 +6,7 @@ public interface IImportNotificationsAggregationService
 {
     public Task<MultiSeriesDatetimeDataset> ByCreated(DateTime from, DateTime to, AggregationPeriod aggregateBy = AggregationPeriod.Day);
     public Task<MultiSeriesDatetimeDataset> ByArrival(DateTime from, DateTime to, AggregationPeriod aggregateBy = AggregationPeriod.Day);
-    public Task<SingleSeriesDataset> ByStatus(DateTime from, DateTime to);
+    public Task<SingleSeriesDataset> ByStatus(DateTime? from = null, DateTime? to = null);
     public Task<MultiSeriesDataset> ByCommodityCount(DateTime from, DateTime to);
     public Task<SingleSeriesDataset> ByMaxVersion(DateTime from, DateTime to, ImportNotificationTypeEnum[]? chedTypes = null, string? country = null);
 }
diff --git a/Btms.Analytics/IMovementsAggregationService.cs b/Btms.Analytics/IMovementsAggregationService.cs
@@ -6,7 +6,7 @@ namespace Btms.Analytics;
 public interface IMovementsAggregationService
 {
     public Task<MultiSeriesDatetimeDataset> ByCreated(DateTime from, DateTime to, AggregationPeriod aggregateBy = AggregationPeriod.Day);
-    public Task<SingleSeriesDataset> ByStatus(DateTime from, DateTime to);
+    public Task<SingleSeriesDataset> ByStatus(DateTime? from = null, DateTime? to = null);
     public Task<MultiSeriesDataset> ByItemCount(DateTime from, DateTime to);
     public Task<SummarisedDataset<SingleSeriesDataset, StringBucketDimensionResult>> ByDecision(DateTime from, DateTime to, ImportNotificationTypeEnum[]? chedTypes = null, string? country = null);
     // public Task<TabularDataset<ByNameDimensionResult>> ByDecisionAndLinkStatus(DateTime from, DateTime to);

diff --git a/Btms.Analytics/ImportNotificationsAggregationService.cs b/Btms.Analytics/ImportNotificationsAggregationService.cs
@@ -39,11 +39,11 @@ string CreateDatasetName(BsonDocument b) =>
         return AggregateByLinkedAndNotificationType(dateRange, CreateDatasetName, matchFilter, "$partOne.arrivesAt", aggregateBy);
     }
 
-    public Task<SingleSeriesDataset> ByStatus(DateTime from, DateTime to)
+    public Task<SingleSeriesDataset> ByStatus(DateTime? from = null, DateTime? to = null)
     {
         var data = context
             .Notifications
-            .Where(n => n.CreatedSource >= from && n.CreatedSource < to)
+            .Where(n => (from == null || n.CreatedSource >= from) && (to == null || n.CreatedSource < to))
             .GroupBy(n => new { n.ImportNotificationType, Linked = n.Relationships.Movements.Data.Count > 0 })
             .Select(g => new { g.Key.Linked, g.Key.ImportNotificationType, Count = g.Count() })
             .ToDictionary(g => AnalyticsHelpers.GetLinkedName(g.Linked, g.ImportNotificationType.AsString()),

diff --git a/Btms.Analytics/MovementsAggregationService.cs b/Btms.Analytics/MovementsAggregationService.cs
@@ -37,12 +37,12 @@ public Task<MultiSeriesDatetimeDataset> ByCreated(DateTime from, DateTime to, Ag
         return Aggregate(dateRange, CreateDatasetName, matchFilter, "$createdSource", aggregateBy);
     }
 
-    public Task<SingleSeriesDataset> ByStatus(DateTime from, DateTime to)
+    public Task<SingleSeriesDataset> ByStatus(DateTime? from = null, DateTime? to = null)
     {
         var data = context
             .Movements
             .SelectLinkStatus()
-            .Where(n => n.CreatedSource >= from && n.CreatedSource < to)
+            .Where(n => (from == null || n.CreatedSource >= from) && (to == null || n.CreatedSource < to))
             .GroupBy(m => m.Description)
             .Select(g => new { g.Key, Count = g.Count() })
             .ToDictionary(g => g.Key, g => g.Count);

diff --git a/Btms.Backend/Config/AnalyticsDashboards.cs b/Btms.Backend/Config/AnalyticsDashboards.cs
@@ -48,6 +48,10 @@ public static async Task<IDictionary<string, IDataset>> GetCharts(
                 "lastMonthImportNotificationsByTypeAndStatus",
                 () => importService.ByStatus(DateTime.Today.MonthAgo(), DateTime.Now).AsIDataset()
             },
+            {
+                "allImportNotificationsByTypeAndStatus",
+                () => importService.ByStatus().AsIDataset()
+            },
             {
                 "last24HoursMovementsLinkingByCreated",
                 () => movementsService.ByCreated(DateTime.Now.NextHour().Yesterday(), DateTime.Now.NextHour(), AggregationPeriod.Hour).AsIDataset()
@@ -56,6 +60,10 @@ public static async Task<IDictionary<string, IDataset>> GetCharts(
                 "movementsLinkingByCreated",
                 () => movementsService.ByCreated(DateTime.Today.MonthAgo(), DateTime.Today).AsIDataset()
             },
+            {
+                "allMovementsByStatus",
+                () => movementsService.ByStatus().AsIDataset()
+            },
             {
                 "lastMonthMovementsByStatus",
                 () => movementsService.ByStatus(DateTime.Today.MonthAgo(), DateTime.Now).AsIDataset()

diff --git a/TestGenerator.IntegrationTesting.Backend/ScenarioDatasetBaseTest.cs b/TestGenerator.IntegrationTesting.Backend/ScenarioDatasetBaseTest.cs
@@ -20,7 +20,10 @@ public abstract class ScenarioDatasetBaseTest
 
     private static Dictionary<string, List<GeneratedResult>> AllDatasets
         = new Dictionary<string, List<GeneratedResult>>();
-
+
+    protected readonly IImportNotificationsAggregationService ImportNotificationsAggregationService;
+    protected readonly IMovementsAggregationService MovementsAggregationService;
+
     /// <summary>
     /// 
     /// </summary>
@@ -49,6 +52,12 @@ protected ScenarioDatasetBaseTest(
 
         Client = BackendFixture.BtmsClient;
         MongoDbContext = BackendFixture.MongoDbContext;
+
+        ImportNotificationsAggregationService = new ImportNotificationsAggregationService(MongoDbContext,
+            TestOutputHelper.GetLogger<ImportNotificationsAggregationService>());
+
+        MovementsAggregationService = new MovementsAggregationService(MongoDbContext,
+            TestOutputHelper.GetLogger<MovementsAggregationService>());
 
         if (reloadData)
         {
@@ -95,6 +104,7 @@ protected List<GeneratedResult> GetLoadedData()
     /// </summary>
     /// <param name="testOutputHelper"></param>
     /// <returns></returns>
+    // [Obsolete("Use the ImportNotificationsAggregationService property instead")]
     protected IImportNotificationsAggregationService GetImportNotificationsAggregationService()
     {
         var logger = TestOutputHelper.GetLogger<ImportNotificationsAggregationService>();
@@ -106,6 +116,7 @@ protected IImportNotificationsAggregationService GetImportNotificationsAggregati
     /// </summary>
     /// <param name="testOutputHelper"></param>
     /// <returns></returns>
+    // [Obsolete("Use the MovementsAggregationService property instead")]
     protected IMovementsAggregationService GetMovementsAggregationService()
     {
         var logger = TestOutputHelper.GetLogger<MovementsAggregationService>();