Merge pull request #43 from spacecowboy-app/nullability-improvements/1

General service code improvements
spacecowboy-app · Aug 23, 2023 · 5f7d7d8 · 5f7d7d8
2 parents 013626b + d84adea
commit 5f7d7d8
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 28 deletions.
diff --git a/service/src/Controllers/DTO/Errors/ErrorDetails.cs b/service/src/Controllers/DTO/Errors/ErrorDetails.cs
@@ -36,7 +36,7 @@ public class ErrorDetails
  /// <summary>
  /// The session identifier related to this problem, or <code>null</code>
  /// </summary>
- public string SessionId { get; init; }
+ public string? SessionId { get; init; }
 
  /// <summary>
  /// The participant identifier related to this problem, or <code>null</code>

diff --git a/service/src/Controllers/Hubs/SessionHub.cs b/service/src/Controllers/Hubs/SessionHub.cs
@@ -14,7 +14,6 @@
  limitations under the License.
 */
 
-using AutoMapper;
 using Microsoft.AspNetCore.SignalR;
 using Microsoft.Extensions.Logging;
 using Spacecowboy.Service.Controllers.DTO;
@@ -33,14 +32,12 @@ public class SessionHub: Hub
 
  private readonly ILogger<SessionHub> log;
  private readonly ISessionRepository repo;
- private readonly IMapper map;
 
 
- public SessionHub(ILogger<SessionHub> log, ISessionRepository repo, IMapper map)
+ public SessionHub(ILogger<SessionHub> log, ISessionRepository repo)
  {
  this.log = log;
  this.repo = repo;
- this.map = map;
  }
 
 
@@ -54,7 +51,7 @@ public override async Task OnConnectedAsync()
 
 
  /// <inheritdoc/>
- public override async Task OnDisconnectedAsync(Exception exception)
+ public override async Task OnDisconnectedAsync(Exception? exception)
  {
  await Clients.Caller.SendAsync(EventMessage, "Disconnected from service hub");
  await base.OnDisconnectedAsync(exception);
@@ -116,8 +113,8 @@ public async Task ParticipantHeartbeat(string sessionId, Guid participantId)
  /// Return session information to a client
  /// </summary>
  /// <param name="sessionId">Session identifier</param>
- /// <returns>Session information or null on error</returns>
- public async Task<SessionResponse> GetSession(string sessionId)
+ /// <returns>Session information or <code>null</code> on error</returns>
+ public async Task<SessionResponse?> GetSession(string sessionId)
  {
  if (repo == null)
  {

diff --git a/service/src/Controllers/SessionController.cs b/service/src/Controllers/SessionController.cs
@@ -19,7 +19,6 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.SignalR;
 using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Options;
 using Prometheus;
 using Spacecowboy.Service.Controllers.DTO;
 using Spacecowboy.Service.Controllers.DTO.Errors;
@@ -62,15 +61,13 @@ public class SessionController : ControllerBase
 
  private readonly ILogger<SessionController> log;
  private readonly IMapper map;
- private readonly ServiceOptions options;
  private readonly ISessionRepository repository;
  private readonly IHubContext<SessionHub> sessionHub;
 
- public SessionController(ILogger<SessionController> log, ISessionRepository repository, IMapper map, IOptions<ServiceOptions> options, IHubContext<SessionHub> hub)
+ public SessionController(ILogger<SessionController> log, ISessionRepository repository, IMapper map, IHubContext<SessionHub> hub)
  {
  this.log = log ?? throw new ArgumentNullException(nameof(log));
  this.map = map ?? throw new ArgumentNullException(nameof(map));
- this.options = options.Value ?? throw new ArgumentNullException(nameof(options));
  this.repository = repository ?? throw new ArgumentNullException(nameof(repository));
  this.sessionHub = hub;
 

diff --git a/service/src/Service.csproj b/service/src/Service.csproj
@@ -12,12 +12,13 @@
  <RootNamespace>Spacecowboy.Service</RootNamespace>
  <PackageId>Spacecowboy.Service</PackageId>
  <DockerComposeProjectPath>..\docker-compose.dcproj</DockerComposeProjectPath>
+ <Nullable>enable</Nullable>
  </PropertyGroup>
 
  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
  <DocumentationFile>spacecowboy-api.xml</DocumentationFile>
  <NoWarn>1591;1701;1702</NoWarn>
- <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+ <TreatWarningsAsErrors>False</TreatWarningsAsErrors>
  </PropertyGroup>
 
  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
@@ -33,11 +34,11 @@
  <ItemGroup>
  <PackageReference Include="AutoMapper" Version="12.0.1" />
  <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="12.0.1" />
- <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.18.1" />
- <PackageReference Include="prometheus-net" Version="8.0.0" />
- <PackageReference Include="prometheus-net.AspNetCore" Version="8.0.0" />
+ <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.5" />
+ <PackageReference Include="prometheus-net" Version="8.0.1" />
+ <PackageReference Include="prometheus-net.AspNetCore" Version="8.0.1" />
  <PackageReference Include="Serilog.AspNetCore" Version="7.0.0" />
- <PackageReference Include="Serilog.Settings.Configuration" Version="7.0.0" />
+ <PackageReference Include="Serilog.Settings.Configuration" Version="7.0.1" />
  <PackageReference Include="Serilog.Sinks.Seq" Version="5.2.2" />
  <PackageReference Include="StackExchange.Redis" Version="2.6.122" />
  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />

diff --git a/service/src/ServiceOptions.cs b/service/src/ServiceOptions.cs
@@ -16,7 +16,10 @@
 
 namespace Spacecowboy.Service
 {
- public class ServiceOptions
+ /// <summary>
+ /// Service configuration options.
+ /// </summary>
+ public record ServiceOptions
  {
  public const string Service = "Spacecowboy";
 
@@ -26,11 +29,11 @@ public class ServiceOptions
  /// <remarks>
  /// Valid values are "redis" and "memory".
  /// </remarks>
- public string RepositoryType { get; set; }
+ public string? RepositoryType { get; init; }
 
  /// <summary>
  /// Name of this instance of the service. Each running instance has a unique name.
  /// </summary>
- public string InstanceName { get; set; }
+ public string? InstanceName { get; init; }
  }
 }
diff --git a/service/test/Controller/ParticipantApiTest.cs b/service/test/Controller/ParticipantApiTest.cs
@@ -66,7 +66,7 @@ public ParticipantApiTest()
 
  var options = new ServiceOptions();
 
- controller = new SessionController(logger, repository, mapper, Options.Create<ServiceOptions>(options), null);
+ controller = new SessionController(logger, repository, mapper, null);
  }
 
 

diff --git a/service/test/Controller/SessionControllerTest.cs b/service/test/Controller/SessionControllerTest.cs
@@ -19,7 +19,6 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Options;
 using Spacecowboy.Service.Controllers;
 using Spacecowboy.Service.Controllers.DTO;
 using Spacecowboy.Service.Controllers.DTO.Errors;
@@ -61,7 +60,7 @@ public SessionControllerTest()
 
  var options = new ServiceOptions();
 
- controller = new SessionController(logger, repository, mapper, Options.Create<ServiceOptions>(options), null);
+ controller = new SessionController(logger, repository, mapper, null);
  }
 
 

diff --git a/service/test/Service.Test.csproj b/service/test/Service.Test.csproj
@@ -16,17 +16,19 @@
  <Authors>Rolf Michelsen and Tami Weiss</Authors>
 
  <Copyright>Copyright 2021-2023 Rolf Michelsen and Tami Weiss</Copyright>
+
+ <Nullable>enable</Nullable>
  </PropertyGroup>
 
  <ItemGroup>
- <PackageReference Include="FluentAssertions" Version="6.9.0" />
- <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
- <PackageReference Include="xunit" Version="2.4.2" />
- <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+ <PackageReference Include="FluentAssertions" Version="6.12.0" />
+ <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.1" />
+ <PackageReference Include="xunit" Version="2.5.0" />
+ <PackageReference Include="xunit.runner.visualstudio" Version="2.5.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
  </PackageReference>
- <PackageReference Include="coverlet.collector" Version="3.2.0">
+ <PackageReference Include="coverlet.collector" Version="6.0.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
  </PackageReference>