feat: or-2350 add admin endpoint to analyze duplicates

Informatievlaanderen · Jan 16, 2025 · be381d3 · be381d3
1 parent aaffa1d
commit be381d3
Show file tree

Hide file tree

Showing 10 changed files with 91 additions and 26 deletions.
diff --git a/...Adapters/DuplicateVerenigingDetectionService/SearchDuplicateVerenigingDetectionService.cs b/...Adapters/DuplicateVerenigingDetectionService/SearchDuplicateVerenigingDetectionService.cs
@@ -1,8 +1,8 @@
 namespace AssociationRegistry.Admin.Api.Adapters.DuplicateVerenigingDetectionService;
 
-using AssociationRegistry.Admin.Schema.Search;
-using AssociationRegistry.DuplicateVerenigingDetection;
-using AssociationRegistry.Vereniging;
+using Schema.Search;
+using DuplicateVerenigingDetection;
+using Vereniging;
 using Nest;
 using System.Collections.Immutable;
 
@@ -15,8 +15,11 @@ public SearchDuplicateVerenigingDetectionService(IElasticClient client)
         _client = client;
     }
 
-    public async Task<IReadOnlyCollection<DuplicaatVereniging>> GetDuplicates(VerenigingsNaam naam, Locatie[] locaties)
+    public async Task<IReadOnlyCollection<DuplicaatVereniging>> GetDuplicates(VerenigingsNaam naam, Locatie[] locaties,
+                                                                              bool includeScore = false, MinimumScore? minimumScoreOverride = null)
     {
+        minimumScoreOverride ??= MinimumScore.Default;
+
         var locatiesMetAdres = locaties.Where(l => l.Adres is not null).ToArray();
 
         if (locatiesMetAdres.Length == 0) return Array.Empty<DuplicaatVereniging>();
@@ -28,6 +31,9 @@ public async Task<IReadOnlyCollection<DuplicaatVereniging>> GetDuplicates(Vereni
             await _client
                .SearchAsync<DuplicateDetectionDocument>(
                     s => s
+                        .Explain(includeScore)
+                        .TrackScores(includeScore)
+                        //.MinScore(minimumScoreOverride.Value)
                        .Query(
                             q => q.Bool(
                                 b => b.Must(
@@ -41,7 +47,8 @@ await _client
                             )
                         ));
 
-        return searchResponse.Documents.Select(ToDuplicateVereniging)
+        return searchResponse.Hits
+                             .Select(ToDuplicateVereniging)
                              .ToArray();
     }
 
@@ -140,17 +147,24 @@ private static Func<QueryContainerDescriptor<DuplicateDetectionDocument>, QueryC
             );
     }
 
-    private static DuplicaatVereniging ToDuplicateVereniging(DuplicateDetectionDocument document)
+    private static DuplicaatVereniging ToDuplicateVereniging(IHit<DuplicateDetectionDocument> document)
         => new(
-            document.VCode,
-            new DuplicaatVereniging.VerenigingsType(document.VerenigingsTypeCode,
-                                                    Verenigingstype.Parse(document.VerenigingsTypeCode).Naam),
-            document.Naam,
-            document.KorteNaam,
-            document.HoofdactiviteitVerenigingsloket?
+            document.Source.VCode,
+            new DuplicaatVereniging.VerenigingsType(document.Source.VerenigingsTypeCode,
+                                                    Verenigingstype.Parse(document.Source.VerenigingsTypeCode).Naam),
+            document.Source.Naam,
+            document.Source.KorteNaam,
+            document.Source.HoofdactiviteitVerenigingsloket?
                     .Select(h => new DuplicaatVereniging.HoofdactiviteitVerenigingsloket(
                                 h, HoofdactiviteitVerenigingsloket.Create(h).Naam)).ToImmutableArray() ?? [],
-            document.Locaties.Select(ToLocatie).ToImmutableArray());
+            document.Source.Locaties.Select(ToLocatie).ToImmutableArray(),
+            IncludesScore(document)
+                ? new DuplicaatVereniging.ScoringInfo(document.Explanation.Description, document.Score)
+                : DuplicaatVereniging.ScoringInfo.NotApplicable
+        );
+
+    private static bool IncludesScore(IHit<DuplicateDetectionDocument> document)
+        => document.Explanation is not null && document.Score is not null;
 
     private static DuplicaatVereniging.Locatie ToLocatie(DuplicateDetectionDocument.Locatie loc)
         => new(

diff --git a/src/AssociationRegistry.Admin.Api/Administratie/DubbelControle/DubbelControleController.cs b/src/AssociationRegistry.Admin.Api/Administratie/DubbelControle/DubbelControleController.cs
@@ -0,0 +1,35 @@
+namespace AssociationRegistry.Admin.Api.Administratie.DubbelControle;
+
+using Asp.Versioning;
+using Be.Vlaanderen.Basisregisters.Api;
+using DecentraalBeheer.Verenigingen.Registreer.FeitelijkeVereniging.RequetsModels;
+using DuplicateVerenigingDetection;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+
+[ApiVersion("1.0")]
+[AdvertiseApiVersions("1.0")]
+[ApiRoute("projections")]
+[ApiExplorerSettings(IgnoreApi = true)]
+[Authorize(Policy = Program.SuperAdminPolicyName)]
+public class DubbelControleController : ApiController
+{
+    [HttpPost("admin/dubbelcontrole")]
+    public async Task<IActionResult> ControleerOpDubbels(
+        [FromBody] RegistreerFeitelijkeVerenigingRequest? request,
+        [FromQuery] double? minimumScoreOverride,
+        [FromServices] IDuplicateVerenigingDetectionService duplicateVerenigingDetectionService
+    )
+    {
+        var command = request.ToCommand();
+
+        var result = await duplicateVerenigingDetectionService.GetDuplicates(
+            command.Naam, command.Locaties,
+            true,
+            minimumScoreOverride.HasValue
+                ? new MinimumScore(minimumScoreOverride.Value)
+                : MinimumScore.Default);
+
+        return Ok(result);
+    }
+}
diff --git a/src/AssociationRegistry.Admin.Api/AssociationRegistry.Admin.Api.csproj b/src/AssociationRegistry.Admin.Api/AssociationRegistry.Admin.Api.csproj
@@ -77,9 +77,5 @@
     </EmbeddedResource>
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="Administratie\" />
-  </ItemGroup>
-
   <Import Project="..\..\.paket\Paket.Restore.targets" />
 </Project>
diff --git a/...Admin.Api/DecentraalBeheer/Verenigingen/Registreer/PotentialDuplicatesResponseExamples.cs b/...Admin.Api/DecentraalBeheer/Verenigingen/Registreer/PotentialDuplicatesResponseExamples.cs
@@ -28,13 +28,13 @@ public PotentialDuplicatesResponse GetExamples()
                             Verenigingstype.FeitelijkeVereniging.Naam),
                         Naam: "Naam",
                         KorteNaam: "Korte naam",
-                        ImmutableArray.Create(
+                        [
                             new DuplicaatVereniging.HoofdactiviteitVerenigingsloket(Code: "CODE", Naam: "Beschrijving")
-                        ),
-                        ImmutableArray.Create(
+                        ],
+                        [
                             new DuplicaatVereniging.Locatie(Locatietype: "Locatietype", IsPrimair: true, Adres: "Adresvoorstelling",
                                                             Naam: "Naam", Postcode: "Postcode", Gemeente: "Gemeente")
-                        )),
+                        ]),
                 }),
             _appSettings);
 }
diff --git a/src/AssociationRegistry/DuplicateVerenigingDetection/DuplicaatVereniging.cs b/src/AssociationRegistry/DuplicateVerenigingDetection/DuplicaatVereniging.cs
@@ -8,7 +8,9 @@ public record DuplicaatVereniging(
     string Naam,
     string KorteNaam,
     ImmutableArray<DuplicaatVereniging.HoofdactiviteitVerenigingsloket> HoofdactiviteitenVerenigingsloket,
-    ImmutableArray<DuplicaatVereniging.Locatie> Locaties)
+    ImmutableArray<DuplicaatVereniging.Locatie> Locaties,
+    DuplicaatVereniging.ScoringInfo? Scoring = null
+    )
 {
     public record Locatie(
         string Locatietype,
@@ -21,4 +23,9 @@ public record Locatie(
     public record VerenigingsType(string Code, string Naam);
     public record Activiteit(int Id, string Categorie);
     public record HoofdactiviteitVerenigingsloket(string Code, string Naam);
+
+    public record ScoringInfo(string Explanation, double? Score)
+    {
+        public static ScoringInfo NotApplicable => new("N/A", null);
+    };
 }
diff --git a/src/AssociationRegistry/DuplicateVerenigingDetection/IDuplicateVerenigingDetectionService.cs b/src/AssociationRegistry/DuplicateVerenigingDetection/IDuplicateVerenigingDetectionService.cs
@@ -4,5 +4,9 @@
 
 public interface IDuplicateVerenigingDetectionService
 {
-    Task<IReadOnlyCollection<DuplicaatVereniging>> GetDuplicates(VerenigingsNaam naam, Locatie[] locaties);
+    Task<IReadOnlyCollection<DuplicaatVereniging>> GetDuplicates(
+        VerenigingsNaam naam,
+        Locatie[] locaties,
+        bool includeScore = false,
+        MinimumScore? minimumScoreOverride = null);
 }
diff --git a/src/AssociationRegistry/DuplicateVerenigingDetection/MinimumScore.cs b/src/AssociationRegistry/DuplicateVerenigingDetection/MinimumScore.cs
@@ -0,0 +1,6 @@
+namespace AssociationRegistry.DuplicateVerenigingDetection;
+
+public record MinimumScore(double Value)
+{
+    public static MinimumScore Default = new(1);
+};
diff --git a/...reniging/When_RegistreerFeitelijkeVereniging/CommandHandling/With_A_PotentialDuplicate.cs b/...reniging/When_RegistreerFeitelijkeVereniging/CommandHandling/With_A_PotentialDuplicate.cs
@@ -52,7 +52,8 @@ public With_A_PotentialDuplicate()
                              d =>
                                  d.GetDuplicates(
                                      command.Naam,
-                                     command.Locaties))
+                                     command.Locaties,
+                                     false, null))
                         .ReturnsAsync(_potentialDuplicates);
 
         var commandMetadata = fixture.Create<CommandMetadata>();

diff --git a/...hen_RegistreerFeitelijkeVereniging/CommandHandling/With_A_PotentialDuplicate_And_Force.cs b/...hen_RegistreerFeitelijkeVereniging/CommandHandling/With_A_PotentialDuplicate_And_Force.cs
@@ -60,7 +60,9 @@ public With_A_PotentialDuplicate_And_Force()
                              d =>
                                  d.GetDuplicates(
                                      _command.Naam,
-                                     _command.Locaties))
+                                     _command.Locaties,
+                                     false,
+                                     MinimumScore.Default))
                         .ReturnsAsync(potentialDuplicates);
 
         var commandMetadata = fixture.Create<CommandMetadata>();

diff --git a/...sociationRegistry.Test.Admin.Api/Framework/Fakes/NoDuplicateVerenigingDetectionService.cs b/...sociationRegistry.Test.Admin.Api/Framework/Fakes/NoDuplicateVerenigingDetectionService.cs
@@ -5,6 +5,6 @@
 
 public class NoDuplicateVerenigingDetectionService : IDuplicateVerenigingDetectionService
 {
-    public Task<IReadOnlyCollection<DuplicaatVereniging>> GetDuplicates(VerenigingsNaam naam, Locatie[] locaties)
+    public Task<IReadOnlyCollection<DuplicaatVereniging>> GetDuplicates(VerenigingsNaam naam, Locatie[] locaties, bool includeScore = false, MinimumScore? minimumScoreOverride = null)
         => Task.FromResult<IReadOnlyCollection<DuplicaatVereniging>>(new List<DuplicaatVereniging>());
 }