feat: implement get current instance endpoint (#69)

andrei2699 · web-flow · commit 738830ed14e6 · 2025-03-30T14:38:29.000+03:00
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/Analysis/DownloadAnalysisFileResultsEndpoint.cs b/src/Adapters/Driving/Web/EndpointDefinitions/Analysis/DownloadAnalysisFileResultsEndpoint.cs
@@ -59,7 +59,7 @@ private static async Task<DownloadResult> DownloadIndividualFile(
                     namedStream.Name
                 ),
             error => error.ToProblem(context),
-            error =>error.ToProblem(context)
+            error => error.ToProblem(context)
         );
     }
 
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/Analysis/GetAnalysisResultsEndpoint.cs b/src/Adapters/Driving/Web/EndpointDefinitions/Analysis/GetAnalysisResultsEndpoint.cs
@@ -51,7 +51,7 @@ private static async Task<
 
         return result.Match<Results<Ok<WebGetAnalysisResultConsole>, NotFound<ProblemDetails>>>(
             content => TypedResults.Ok(new WebGetAnalysisResultConsole(content)),
-            error =>error.ToProblem(context)
+            error => error.ToProblem(context)
         );
     }
 
@@ -95,7 +95,7 @@ private static async Task<
 
         return result.Match<Results<Ok<WebGetAnalysisResultFileList>, NotFound<ProblemDetails>>>(
             files => TypedResults.Ok(WebGetAnalysisResultFileList.Map(files)),
-            error =>error.ToProblem(context)
+            error => error.ToProblem(context)
         );
     }
 }
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/Context/ProjectContextLinkEndpoint.cs b/src/Adapters/Driving/Web/EndpointDefinitions/Context/ProjectContextLinkEndpoint.cs
@@ -43,7 +43,7 @@ CancellationToken cancellationToken
         return result.Match<Results<NoContent, NotFound<ProblemDetails>>>(
             _ => TypedResults.NoContent(),
             error => error.ToProblem(context),
-            error =>error.ToProblem(context)
+            error => error.ToProblem(context)
         );
     }
 }
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/Context/ProjectContextReloadEndpoint.cs b/src/Adapters/Driving/Web/EndpointDefinitions/Context/ProjectContextReloadEndpoint.cs
@@ -41,7 +41,7 @@ CancellationToken cancellationToken
         return result.Match<Results<NoContent, NotFound<ProblemDetails>>>(
             _ => TypedResults.NoContent(),
             error => error.ToProblem(context),
-            error =>error.ToProblem(context)
+            error => error.ToProblem(context)
         );
     }
 }
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/Instances/Contracts/WebGetProjectInstanceInfo.cs b/src/Adapters/Driving/Web/EndpointDefinitions/Instances/Contracts/WebGetProjectInstanceInfo.cs
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/Instances/GetCurrentInstanceEndpoint.cs b/src/Adapters/Driving/Web/EndpointDefinitions/Instances/GetCurrentInstanceEndpoint.cs
@@ -0,0 +1,43 @@
+﻿using Microsoft.AspNetCore.Http.HttpResults;
+using Microsoft.AspNetCore.Mvc;
+using ScriptBee.Common.Web;
+using ScriptBee.Domain.Model.Project;
+using ScriptBee.Service.Project.Analysis;
+using ScriptBee.UseCases.Project.Analysis;
+using ScriptBee.Web.EndpointDefinitions.Instances.Contracts;
+using ScriptBee.Web.Exceptions;
+
+namespace ScriptBee.Web.EndpointDefinitions.Instances;
+
+using GetCurrentInstanceType = Results<Ok<WebProjectInstance>, NotFound<ProblemDetails>>;
+
+public class GetCurrentInstanceEndpoint : IEndpointDefinition
+{
+    public void DefineServices(IServiceCollection services)
+    {
+        services.AddSingleton<IGetCurrentInstanceUseCase, GetCurrentInstanceService>();
+    }
+
+    public void DefineEndpoints(IEndpointRouteBuilder app)
+    {
+        app.MapGet("/api/projects/{projectId}/instances/current", GetCurrentInstance);
+    }
+
+    private static async Task<GetCurrentInstanceType> GetCurrentInstance(
+        HttpContext context,
+        [FromRoute] string projectId,
+        IGetCurrentInstanceUseCase useCase,
+        CancellationToken cancellationToken
+    )
+    {
+        var result = await useCase.GetCurrentInstance(
+            ProjectId.FromValue(projectId),
+            cancellationToken
+        );
+
+        return result.Match<GetCurrentInstanceType>(
+            instanceInfo => TypedResults.Ok(WebProjectInstance.Map(instanceInfo)),
+            error => error.ToNotFoundProblem(context)
+        );
+    }
+}
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/Instances/GetProjectInstancesEndpoint.cs b/src/Adapters/Driving/Web/EndpointDefinitions/Instances/GetProjectInstancesEndpoint.cs
@@ -13,13 +13,11 @@ public class GetProjectInstancesEndpoint : IEndpointDefinition
     public void DefineServices(IServiceCollection services)
     {
         services.AddSingleton<IGetProjectInstancesUseCase, GetProjectInstancesService>();
-        services.AddSingleton<IGetCurrentInstanceUseCase, GetCurrentInstanceService>();
     }
 
     public void DefineEndpoints(IEndpointRouteBuilder app)
     {
         app.MapGet("/api/projects/{projectId}/instances", GetAllInstances);
-        app.MapGet("/api/projects/{projectId}/instances/current", GetCurrentInstance);
     }
 
     private static async Task<Ok<WebGetProjectInstancesListResponse>> GetAllInstances(
@@ -33,27 +31,4 @@ private static async Task<Ok<WebGetProjectInstancesListResponse>> GetAllInstance
 
         return TypedResults.Ok(WebGetProjectInstancesListResponse.Map(calculationInstanceInfos));
     }
-
-    private static async Task<Ok<WebGetProjectInstanceInfo>> GetCurrentInstance(
-        [FromRoute] string projectId
-    )
-    {
-        await Task.CompletedTask;
-
-        // TODO FIXIT: remove hardcoded value
-
-        return TypedResults.Ok(
-            new WebGetProjectInstanceInfo(
-                "instance-id",
-                ["honeydew", "InspectorGit"],
-                ["software-analysis"],
-                new Dictionary<string, IEnumerable<string>>
-                {
-                    { "InspectorGit", ["honeydew.iglog"] },
-                    { "honeydew", ["honeydew-raw.json"] },
-                },
-                DateTimeOffset.UtcNow
-            )
-        );
-    }
 }
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/Loaders/UploadLoaderFilesEndpoint.cs b/src/Adapters/Driving/Web/EndpointDefinitions/Loaders/UploadLoaderFilesEndpoint.cs
@@ -54,7 +54,7 @@ private static async Task<UploadResult> UploadLoaderFiles(
                 TypedResults.Ok(
                     new WebUploadLoaderFilesResponse(loaderId, fileData.Select(f => f.Name))
                 ),
-            error =>error.ToProblem(context)
+            error => error.ToProblem(context)
         );
     }
 }
diff --git a/src/Adapters/Driving/Web/EndpointDefinitions/ProjectStructure/CreateProjectScriptsEndpoint.cs b/src/Adapters/Driving/Web/EndpointDefinitions/ProjectStructure/CreateProjectScriptsEndpoint.cs
@@ -13,6 +13,7 @@ namespace ScriptBee.Web.EndpointDefinitions.ProjectStructure;
 using CreateResponse = Results<
     Created<WebScriptData>,
     NotFound<ProblemDetails>,
+    BadRequest<ProblemDetails>,
     ValidationProblem,
     Conflict<ProblemDetails>
 >;
@@ -50,6 +51,7 @@ private static async Task<CreateResponse> CreateProjectScript(
                     WebScriptData.Map(script)
                 ),
             error => error.ToProblem(context),
+            error => error.ToBadRequestProblem(context),
             error => error.ToProblem(context),
             error => error.ToProblem(context)
         );
diff --git a/src/Adapters/Driving/Web/Exceptions/ApiErrorExtensions.cs b/src/Adapters/Driving/Web/Exceptions/ApiErrorExtensions.cs
@@ -1,6 +1,7 @@
 using Microsoft.AspNetCore.Http.HttpResults;
 using Microsoft.AspNetCore.Mvc;
 using ScriptBee.Common.Web.Extensions;
+using ScriptBee.Domain.Model.Analysis;
 using ScriptBee.Domain.Model.Errors;
 using ScriptBee.Web.EndpointDefinitions.ProjectStructure.Contracts;
 
@@ -101,4 +102,30 @@ HttpContext context
             )
         );
     }
+
+    public static BadRequest<ProblemDetails> ToBadRequestProblem(
+        this NoInstanceAllocatedForProjectError error,
+        HttpContext context
+    )
+    {
+        return TypedResults.BadRequest(
+            context.ToProblemDetails(
+                "No Instance Allocated For Project",
+                $"There is no instance allocated for project with the ID '{error.ProjectId}'"
+            )
+        );
+    }
+
+    public static NotFound<ProblemDetails> ToNotFoundProblem(
+        this NoInstanceAllocatedForProjectError error,
+        HttpContext context
+    )
+    {
+        return TypedResults.NotFound(
+            context.ToProblemDetails(
+                "No Instance Allocated For Project",
+                $"There is no instance allocated for project with the ID '{error.ProjectId}'"
+            )
+        );
+    }
 }
diff --git a/src/Application/Domain/Model/Analysis/NoInstanceAllocatedForProjectError.cs b/src/Application/Domain/Model/Analysis/NoInstanceAllocatedForProjectError.cs
@@ -0,0 +1,5 @@
+using ScriptBee.Domain.Model.Project;
+
+namespace ScriptBee.Domain.Model.Analysis;
+
+public record NoInstanceAllocatedForProjectError(ProjectId ProjectId);
diff --git a/src/Application/Domain/Service.Project/Analysis/GetCurrentInstanceService.cs b/src/Application/Domain/Service.Project/Analysis/GetCurrentInstanceService.cs
@@ -1,17 +1,29 @@
-﻿using ScriptBee.Domain.Model.Instance;
+﻿using OneOf;
+using ScriptBee.Domain.Model.Analysis;
+using ScriptBee.Domain.Model.Instance;
 using ScriptBee.Domain.Model.Project;
+using ScriptBee.Ports.Instance;
 using ScriptBee.UseCases.Project.Analysis;
 
 namespace ScriptBee.Service.Project.Analysis;
 
-public class GetCurrentInstanceService : IGetCurrentInstanceUseCase
+public class GetCurrentInstanceService(IGetAllProjectInstances getAllProjectInstances)
+    : IGetCurrentInstanceUseCase
 {
-    public Task<InstanceInfo> GetOrAllocate(
+    public async Task<OneOf<InstanceInfo, NoInstanceAllocatedForProjectError>> GetCurrentInstance(
         ProjectId projectId,
         CancellationToken cancellationToken = default
     )
     {
-        // TODO FIXIT(#45): implement it
-        throw new NotImplementedException();
+        var instanceInfos = await getAllProjectInstances.GetAll(projectId, cancellationToken);
+
+        var instanceInfo = instanceInfos.FirstOrDefault();
+
+        if (instanceInfo == null)
+        {
+            return new NoInstanceAllocatedForProjectError(projectId);
+        }
+
+        return instanceInfo;
     }
 }
diff --git a/src/Application/Domain/Service.Project/ProjectStructure/CreateScriptService.cs b/src/Application/Domain/Service.Project/ProjectStructure/CreateScriptService.cs
@@ -1,6 +1,8 @@
 ﻿using OneOf;
 using ScriptBee.Common;
+using ScriptBee.Domain.Model.Analysis;
 using ScriptBee.Domain.Model.Errors;
+using ScriptBee.Domain.Model.Instance;
 using ScriptBee.Domain.Model.Project;
 using ScriptBee.Domain.Model.ProjectStructure;
 using ScriptBee.Ports.Files;
@@ -15,6 +17,7 @@ namespace ScriptBee.Service.Project.ProjectStructure;
 using CreateResult = OneOf<
     Script,
     ProjectDoesNotExistsError,
+    NoInstanceAllocatedForProjectError,
     ScriptLanguageDoesNotExistsError,
     ScriptPathAlreadyExistsError
 >;
@@ -47,10 +50,25 @@ private async Task<CreateResult> Create(
         CancellationToken cancellationToken = default
     )
     {
-        var instanceInfo = await currentInstanceUseCase.GetOrAllocate(
+        var result = await currentInstanceUseCase.GetCurrentInstance(
             projectDetails.Id,
             cancellationToken
         );
+
+        return await result.Match<Task<CreateResult>>(
+            async instanceInfo =>
+                await Create(command, instanceInfo, projectDetails, cancellationToken),
+            error => Task.FromResult<CreateResult>(error)
+        );
+    }
+
+    private async Task<CreateResult> Create(
+        CreateScriptCommand command,
+        InstanceInfo instanceInfo,
+        ProjectDetails projectDetails,
+        CancellationToken cancellationToken = default
+    )
+    {
         var languageResult = await getScriptLanguages.Get(
             instanceInfo,
             command.Language,
diff --git a/src/Application/Ports/Driving/UseCases.Project/Analysis/IGetCurrentInstanceUseCase.cs b/src/Application/Ports/Driving/UseCases.Project/Analysis/IGetCurrentInstanceUseCase.cs
@@ -1,11 +1,13 @@
-﻿using ScriptBee.Domain.Model.Instance;
+﻿using OneOf;
+using ScriptBee.Domain.Model.Analysis;
+using ScriptBee.Domain.Model.Instance;
 using ScriptBee.Domain.Model.Project;
 
 namespace ScriptBee.UseCases.Project.Analysis;
 
 public interface IGetCurrentInstanceUseCase
 {
-    Task<InstanceInfo> GetOrAllocate(
+    Task<OneOf<InstanceInfo, NoInstanceAllocatedForProjectError>> GetCurrentInstance(
         ProjectId projectId,
         CancellationToken cancellationToken = default
     );
diff --git a/src/Application/Ports/Driving/UseCases.Project/ProjectStructure/ICreateScriptUseCase.cs b/src/Application/Ports/Driving/UseCases.Project/ProjectStructure/ICreateScriptUseCase.cs
@@ -1,4 +1,5 @@
 ﻿using OneOf;
+using ScriptBee.Domain.Model.Analysis;
 using ScriptBee.Domain.Model.Errors;
 using ScriptBee.Domain.Model.ProjectStructure;
 
@@ -10,6 +11,7 @@ public interface ICreateScriptUseCase
         OneOf<
             Script,
             ProjectDoesNotExistsError,
+            NoInstanceAllocatedForProjectError,
             ScriptLanguageDoesNotExistsError,
             ScriptPathAlreadyExistsError
         >
diff --git a/test/Adapters/Driving/Web.Tests/EndpointDefinitions/Instances/GetCurrentInstanceEndpointTest.cs b/test/Adapters/Driving/Web.Tests/EndpointDefinitions/Instances/GetCurrentInstanceEndpointTest.cs
@@ -0,0 +1,77 @@
+using System.Net;
+using Microsoft.Extensions.DependencyInjection;
+using NSubstitute;
+using OneOf;
+using ScriptBee.Domain.Model.Analysis;
+using ScriptBee.Domain.Model.Instance;
+using ScriptBee.Domain.Model.Project;
+using ScriptBee.Tests.Common;
+using ScriptBee.UseCases.Project.Analysis;
+using ScriptBee.Web.EndpointDefinitions.Instances.Contracts;
+using Xunit.Abstractions;
+using static ScriptBee.Tests.Common.InstanceInfoFixture;
+using static ScriptBee.Tests.Common.ProblemValidationUtils;
+
+namespace ScriptBee.Web.Tests.EndpointDefinitions.Instances;
+
+public class GetCurrentInstanceEndpointTest(ITestOutputHelper outputHelper)
+{
+    private const string TestUrl = "/api/projects/project-id/instances/current";
+    private readonly TestApiCaller<Program> _api = new(TestUrl);
+
+    [Fact]
+    public async Task ShouldReturnInstanceInfoWithContext()
+    {
+        var useCase = Substitute.For<IGetCurrentInstanceUseCase>();
+        var projectId = ProjectId.FromValue("project-id");
+        var instanceInfo = BasicInstanceInfo(projectId);
+        useCase
+            .GetCurrentInstance(projectId, Arg.Any<CancellationToken>())
+            .Returns(
+                Task.FromResult<OneOf<InstanceInfo, NoInstanceAllocatedForProjectError>>(
+                    instanceInfo
+                )
+            );
+
+        var response = await _api.GetApi(
+            new TestWebApplicationFactory<Program>(
+                outputHelper,
+                services =>
+                {
+                    services.AddSingleton(useCase);
+                }
+            )
+        );
+
+        response.StatusCode.ShouldBe(HttpStatusCode.OK);
+        var webProjectInstanceInfo = await response.ReadContentAsync<WebProjectInstance>();
+        webProjectInstanceInfo.Id.ShouldBe(instanceInfo.Id.ToString());
+        webProjectInstanceInfo.CreationDate.ShouldBe(instanceInfo.CreationDate);
+    }
+
+    [Fact]
+    public async Task NoInstanceAllocatedForProject_ShouldReturnNotFound()
+    {
+        var useCase = Substitute.For<IGetCurrentInstanceUseCase>();
+        var projectId = ProjectId.FromValue("project-id");
+        useCase
+            .GetCurrentInstance(projectId, Arg.Any<CancellationToken>())
+            .Returns(
+                Task.FromResult<OneOf<InstanceInfo, NoInstanceAllocatedForProjectError>>(
+                    new NoInstanceAllocatedForProjectError(projectId)
+                )
+            );
+
+        var response = await _api.GetApi(
+            new TestWebApplicationFactory<Program>(
+                outputHelper,
+                services =>
+                {
+                    services.AddSingleton(useCase);
+                }
+            )
+        );
+
+        await AssertNoInstanceAllocatedForProjectNotFoundProblem(response, TestUrl);
+    }
+}
diff --git a/test/Adapters/Driving/Web.Tests/EndpointDefinitions/Instances/GetProjectInstancesEndpointTest.cs b/test/Adapters/Driving/Web.Tests/EndpointDefinitions/Instances/GetProjectInstancesEndpointTest.cs
diff --git a/test/Adapters/Driving/Web.Tests/EndpointDefinitions/ProjectStructure/CreateProjectScriptsEndpointTest.cs b/test/Adapters/Driving/Web.Tests/EndpointDefinitions/ProjectStructure/CreateProjectScriptsEndpointTest.cs
diff --git a/test/Application/Domain/Service.Project.Tests/Analysis/GetCurrentInstanceServiceTest.cs b/test/Application/Domain/Service.Project.Tests/Analysis/GetCurrentInstanceServiceTest.cs
diff --git a/test/Application/Domain/Service.Project.Tests/ProjectStructure/CreateScriptServiceTest.cs b/test/Application/Domain/Service.Project.Tests/ProjectStructure/CreateScriptServiceTest.cs
diff --git a/test/Common/Tests.Common/ProblemValidationUtils.Concrete.cs b/test/Common/Tests.Common/ProblemValidationUtils.Concrete.cs
diff --git a/test/Common/Tests.Common/ProblemValidationUtils.cs b/test/Common/Tests.Common/ProblemValidationUtils.cs

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ private static async Task<DownloadResult> DownloadIndividualFile(`
`59`	`59`	`namedStream.Name`
`60`	`60`	`),`
`61`	`61`	`error => error.ToProblem(context),`
`62`		`- error =>error.ToProblem(context)`
	`62`	`+ error => error.ToProblem(context)`
`63`	`63`	`);`
`64`	`64`	`}`
`65`	`65`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ private static async Task<`
`51`	`51`
`52`	`52`	`return result.Match<Results<Ok<WebGetAnalysisResultConsole>, NotFound<ProblemDetails>>>(`
`53`	`53`	`content => TypedResults.Ok(new WebGetAnalysisResultConsole(content)),`
`54`		`- error =>error.ToProblem(context)`
	`54`	`+ error => error.ToProblem(context)`
`55`	`55`	`);`
`56`	`56`	`}`
`57`	`57`
`@@ -95,7 +95,7 @@ private static async Task<`
`95`	`95`
`96`	`96`	`return result.Match<Results<Ok<WebGetAnalysisResultFileList>, NotFound<ProblemDetails>>>(`
`97`	`97`	`files => TypedResults.Ok(WebGetAnalysisResultFileList.Map(files)),`
`98`		`- error =>error.ToProblem(context)`
	`98`	`+ error => error.ToProblem(context)`
`99`	`99`	`);`
`100`	`100`	`}`
`101`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ CancellationToken cancellationToken`
`43`	`43`	`return result.Match<Results<NoContent, NotFound<ProblemDetails>>>(`
`44`	`44`	`_ => TypedResults.NoContent(),`
`45`	`45`	`error => error.ToProblem(context),`
`46`		`- error =>error.ToProblem(context)`
	`46`	`+ error => error.ToProblem(context)`
`47`	`47`	`);`
`48`	`48`	`}`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ CancellationToken cancellationToken`
`41`	`41`	`return result.Match<Results<NoContent, NotFound<ProblemDetails>>>(`
`42`	`42`	`_ => TypedResults.NoContent(),`
`43`	`43`	`error => error.ToProblem(context),`
`44`		`- error =>error.ToProblem(context)`
	`44`	`+ error => error.ToProblem(context)`
`45`	`45`	`);`
`46`	`46`	`}`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ private static async Task<UploadResult> UploadLoaderFiles(`
`54`	`54`	`TypedResults.Ok(`
`55`	`55`	`new WebUploadLoaderFilesResponse(loaderId, fileData.Select(f => f.Name))`
`56`	`56`	`),`
`57`		`- error =>error.ToProblem(context)`
	`57`	`+ error => error.ToProblem(context)`
`58`	`58`	`);`
`59`	`59`	`}`
`60`	`60`	`}`