refactor!: use GUID internally and expose SquadNumber as public identifier

Author: nanotaboada

.codacy.yml

@@ -30,3 +30,4 @@ exclude_paths:
   - '**/Utilities/**'      # Helper extensions or static classes
   - '**/Validators/**'     # FluentValidation validators
   - 'test/**/*'            # Entire test suite (unit + integration)
+  - 'scripts/**/*'         # Helper shell scripts

codecov.yml

@@ -50,6 +50,7 @@ ignore:
   - '**/*.md'
 
   - .*\/test\/.*
+  - .*\/scripts\/.*
   - .*\/Program\.cs
   - '**/LICENSE'
   - '**/README.md'

scripts/run-migrations-and-copy-database.sh

@@ -0,0 +1,63 @@
+#!/bin/bash
+
+DATA_FILE="players-sqlite3.db"
+
+PROJECT_ROOT_PATH="src/Dotnet.Samples.AspNetCore.WebApi"
+PROJECT_BASE_PATH="$PROJECT_ROOT_PATH/bin/Debug/net8.0"
+
+SOURCE_FILE_PATH="$PROJECT_BASE_PATH/Data/$DATA_FILE"
+TARGET_FILE_PATH="$PROJECT_ROOT_PATH/Data/$DATA_FILE"
+
+log() {
+    local emoji=$1
+    local level=$2
+    local message=$3
+    local timestamp
+    timestamp=$(date +"%Y-%m-%d %H:%M:%S")
+    echo "$emoji [$timestamp] [$level] $message"
+}
+
+# Check if the EF Core CLI tool is installed
+if ! command -v dotnet ef &> /dev/null; then
+    log "❌" "ERROR" "'dotnet ef' not found. Install it with 'dotnet tool install --global dotnet-ef'"
+    exit 1
+fi
+
+# Ensure clean placeholder database file exists
+log "✅" "INFO" "Resetting placeholder database at '$TARGET_FILE_PATH'"
+rm -f "$TARGET_FILE_PATH"
+touch "$TARGET_FILE_PATH"
+
+# Run the database migration
+log "✅" "INFO" "Running EF Core database migration for project at '$PROJECT_ROOT_PATH'..."
+dotnet ef database update --project "$PROJECT_ROOT_PATH"
+if [ $? -ne 0 ]; then
+    log "❌" "ERROR" "Migration failed. See error above."
+    exit 1
+fi
+
+# Check and copy database
+if [ -f "$SOURCE_FILE_PATH" ]; then
+    log "✅" "INFO" "Found database at '$SOURCE_FILE_PATH'"
+    log "✅" "INFO" "Copying to '$TARGET_FILE_PATH'..."
+    cp -f "$SOURCE_FILE_PATH" "$TARGET_FILE_PATH"
+
+    if [ $? -eq 0 ]; then
+        log "✅" "INFO" "Database successfully copied to '$TARGET_FILE_PATH'"
+    else
+        log "❌" "ERROR" "Failed to copy the database file."
+        exit 1
+    fi
+else
+    log "⚠️" "WARNING" "Database file not found at '$SOURCE_FILE_PATH'."
+    log "⚠️" "WARNING" "Make sure the migration actually generated the file."
+    exit 1
+fi
+
+# Confirm destination file exists
+if [ -f "$TARGET_FILE_PATH" ]; then
+    log "✅" "INFO" "Done. The database is now available at '$TARGET_FILE_PATH'"
+else
+    log "⚠️" "WARNING" "Something went wrong. The destination file was not found."
+    exit 1
+fi

src/Dotnet.Samples.AspNetCore.WebApi/Controllers/PlayerController.cs

@@ -2,6 +2,7 @@
 using Dotnet.Samples.AspNetCore.WebApi.Models;
 using Dotnet.Samples.AspNetCore.WebApi.Services;
 using FluentValidation;
+using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 
 namespace Dotnet.Samples.AspNetCore.WebApi.Controllers;
@@ -45,11 +46,11 @@ public async Task<IResult> PostAsync([FromBody] PlayerRequestModel player)
             return TypedResults.BadRequest(errors);
         }
 
-        if (await playerService.RetrieveByIdAsync(player.Id) != null)
+        if (await playerService.RetrieveBySquadNumberAsync(player.SquadNumber) != null)
         {
             logger.LogWarning(
-                "POST /players failed: Player with ID {Id} already exists",
-                player.Id
+                "POST /players failed: Player with Squad Number {SquadNumber} already exists",
+                player.SquadNumber
             );
             return TypedResults.Conflict();
         }
@@ -58,8 +59,8 @@ public async Task<IResult> PostAsync([FromBody] PlayerRequestModel player)
 
         logger.LogInformation("POST /players created: {@Player}", result);
         return TypedResults.CreatedAtRoute(
-            routeName: "GetById",
-            routeValues: new { id = result.Id },
+            routeName: "GetBySquadNumber",
+            routeValues: new { squadNumber = result.Dorsal },
             value: result
         );
     }
@@ -98,10 +99,12 @@ public async Task<IResult> GetAsync()
     /// <param name="id">The ID of the Player</param>
     /// <response code="200">OK</response>
     /// <response code="404">Not Found</response>
-    [HttpGet("{id:long}", Name = "GetById")]
+    [Authorize(Roles = "Admin")]
+    [ApiExplorerSettings(IgnoreApi = true)]
+    [HttpGet("{id:Guid}", Name = "GetById")]
     [ProducesResponseType<PlayerResponseModel>(StatusCodes.Status200OK)]
     [ProducesResponseType(StatusCodes.Status404NotFound)]
-    public async Task<IResult> GetByIdAsync([FromRoute] long id)
+    public async Task<IResult> GetByIdAsync([FromRoute] Guid id)
     {
         var player = await playerService.RetrieveByIdAsync(id);
         if (player != null)
@@ -149,19 +152,23 @@ public async Task<IResult> GetBySquadNumberAsync([FromRoute] int squadNumber)
      * ---------------------------------------------------------------------- */
 
     /// <summary>
-    /// Updates (entirely) a Player by its ID
+    /// Updates (entirely) a Player by its Squad Number
     /// </summary>
-    /// <param name="id">The ID of the Player</param>
+    ///
     /// <param name="player">The PlayerRequestModel</param>
+    /// <param name="squadNumber">The Squad Number of the Player</param>
     /// <response code="204">No Content</response>
     /// <response code="400">Bad Request</response>
     /// <response code="404">Not Found</response>
-    [HttpPut("{id}")]
+    [HttpPut("{squadNumber:int}")]
     [Consumes(MediaTypeNames.Application.Json)]
     [ProducesResponseType(StatusCodes.Status204NoContent)]
     [ProducesResponseType(StatusCodes.Status400BadRequest)]
     [ProducesResponseType(StatusCodes.Status404NotFound)]
-    public async Task<IResult> PutAsync([FromRoute] long id, [FromBody] PlayerRequestModel player)
+    public async Task<IResult> PutAsync(
+        [FromRoute] int squadNumber,
+        [FromBody] PlayerRequestModel player
+    )
     {
         var validation = await validator.ValidateAsync(player);
         if (!validation.IsValid)
@@ -170,16 +177,20 @@ public async Task<IResult> PutAsync([FromRoute] long id, [FromBody] PlayerReques
                 .Errors.Select(error => new { error.PropertyName, error.ErrorMessage })
                 .ToArray();
 
-            logger.LogWarning("PUT /players/{Id} validation failed: {@Errors}", id, errors);
+            logger.LogWarning(
+                "PUT /players/{squadNumber} validation failed: {@Errors}",
+                squadNumber,
+                errors
+            );
             return TypedResults.BadRequest(errors);
         }
-        if (await playerService.RetrieveByIdAsync(id) == null)
+        if (await playerService.RetrieveBySquadNumberAsync(squadNumber) == null)
         {
-            logger.LogWarning("PUT /players/{Id} not found", id);
+            logger.LogWarning("PUT /players/{SquadNumber} not found", squadNumber);
             return TypedResults.NotFound();
         }
         await playerService.UpdateAsync(player);
-        logger.LogInformation("PUT /players/{Id} updated: {@Player}", id, player);
+        logger.LogInformation("PUT /players/{SquadNumber} updated: {@Player}", squadNumber, player);
         return TypedResults.NoContent();
     }
 
@@ -188,25 +199,25 @@ public async Task<IResult> PutAsync([FromRoute] long id, [FromBody] PlayerReques
      * ---------------------------------------------------------------------- */
 
     /// <summary>
-    /// Deletes a Player by its ID
+    /// Deletes a Player by its Squad Number
     /// </summary>
-    /// <param name="id">The ID of the Player</param>
+    /// <param name="squadNumber">The Squad Number of the Player</param>
     /// <response code="204">No Content</response>
     /// <response code="404">Not Found</response>
-    [HttpDelete("{id:long}")]
+    [HttpDelete("{squadNumber:int}")]
     [ProducesResponseType(StatusCodes.Status204NoContent)]
     [ProducesResponseType(StatusCodes.Status404NotFound)]
-    public async Task<IResult> DeleteAsync([FromRoute] long id)
+    public async Task<IResult> DeleteAsync([FromRoute] int squadNumber)
     {
-        if (await playerService.RetrieveByIdAsync(id) == null)
+        if (await playerService.RetrieveBySquadNumberAsync(squadNumber) == null)
         {
-            logger.LogWarning("DELETE /players/{Id} not found", id);
+            logger.LogWarning("DELETE /players/{SquadNumber} not found", squadNumber);
             return TypedResults.NotFound();
         }
         else
         {
-            await playerService.DeleteAsync(id);
-            logger.LogInformation("DELETE /players/{Id} deleted", id);
+            await playerService.DeleteAsync(squadNumber);
+            logger.LogInformation("DELETE /players/{SquadNumber} deleted", squadNumber);
             return TypedResults.NoContent();
         }
     }

src/Dotnet.Samples.AspNetCore.WebApi/Data/IPlayerRepository.cs

@@ -14,8 +14,8 @@ public interface IPlayerRepository : IRepository<Player>
     /// </summary>
     /// <param name="squadNumber">The Squad Number of the Player to retrieve.</param>
     /// <returns>
-    /// A ValueTask representing the asynchronous operation, containing the Player if found,
-    /// or null if no Player with the specified Squad Number exists.
+    ///  A Task representing the asynchronous operation,containing the Player
+    ///  if found, or null if no Player with the specified Squad Number exists.
     /// </returns>
-    ValueTask<Player?> FindBySquadNumberAsync(int squadNumber);
+    Task<Player?> FindBySquadNumberAsync(int squadNumber);
 }

src/Dotnet.Samples.AspNetCore.WebApi/Data/IRepository.cs

@@ -29,7 +29,7 @@ public interface IRepository<T>
     /// A ValueTask representing the asynchronous operation, containing the entity if found,
     /// or null if no entity with the specified ID exists.
     /// </returns>
-    ValueTask<T?> FindByIdAsync(long id);
+    ValueTask<T?> FindByIdAsync(Guid id);
 
     /// <summary>
     /// Updates an existing entity in the repository.
@@ -43,5 +43,5 @@ public interface IRepository<T>
     /// </summary>
     /// <param name="id">The unique identifier of the entity to remove.</param>
     /// <returns>A Task representing the asynchronous operation.</returns>
-    Task RemoveAsync(long id);
+    Task RemoveAsync(Guid id);
 }