DSI-8877/8886: Cancel pending change email

src/Dfe.SignIn.Core.Contracts/Features/Users/IUsersApiClient.cs

@@ -77,4 +77,13 @@ public interface IUsersApiClient
     /// <returns>A task representing the asynchronous operation.</returns>
     [Post(UsersApiRoutes.ConfirmChangeEmail)]
     Task ConfirmChangeEmailAddress(Guid userId, [Body] ConfirmChangeEmailAddressRequest request, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Cancels the process of changing a user's email address.
+    /// </summary>
+    /// <param name="userId">The ID of the user whose email address change is being cancelled.</param>
+    /// <param name="cancellationToken">A token to monitor for cancellation requests.</param>
+    /// <returns>A task representing the asynchronous operation.</returns>
+    [Delete(UsersApiRoutes.CancelChangeEmail)]
+    Task CancelChangeEmailAddress(Guid userId, CancellationToken cancellationToken = default);
 }

src/Dfe.SignIn.Core.Contracts/Features/Users/Shared/UserCodeType.cs

@@ -0,0 +1,38 @@
+namespace Dfe.SignIn.Core.Contracts.Features.Users.Shared;
+
+/// <summary>
+/// Represents the type of user code used for various user actions, such as changing email or resetting password.
+/// </summary>
+public enum UserCodeType
+{
+    /// <summary>
+    /// Represents a user code type used for changing a user's email address.
+    /// </summary>
+    ChangeEmail,
+
+    /// <summary>
+    /// Represents a user code type used for password reset actions.
+    /// </summary>
+    PasswordReset,
+}
+
+/// <summary>
+/// Provides extension methods for the <see cref="UserCodeType"/> enum to convert it to database values.
+/// </summary>
+public static class UserCodeTypeExtensions
+{
+    /// <summary>
+    /// Converts the <see cref="UserCodeType"/> enum value to its corresponding database string representation.
+    /// </summary>
+    /// <param name="codeType">The <see cref="UserCodeType"/> enum value to convert.</param>
+    /// <returns>The database string representation of the <see cref="UserCodeType"/> enum value.</returns>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown when the <see cref="UserCodeType"/> value is not recognized.</exception>
+    public static string ToDbValue(this UserCodeType codeType)
+    {
+        return codeType switch {
+            UserCodeType.ChangeEmail => "changeemail",
+            UserCodeType.PasswordReset => "PasswordReset",
+            _ => throw new ArgumentOutOfRangeException(nameof(codeType), codeType, null)
+        };
+    }
+}

src/Dfe.SignIn.Core.Contracts/Features/Users/UsersApiRoutes.cs

@@ -39,4 +39,9 @@ public static class UsersApiRoutes
     /// The API route for confirming the change of a user's email address.
     /// </summary>
     public const string ConfirmChangeEmail = "/internal/users/{userId}/confirm-change-email";
+
+    /// <summary>
+    /// The API route for cancelling the change of a user's email address.
+    /// </summary>
+    public const string CancelChangeEmail = "/internal/users/{userId}/cancel-change-email";
 }

src/Dfe.SignIn.Core.Entities/Directories/UserCodeEntity.cs

@@ -24,5 +24,3 @@ public partial class UserCodeEntity
 
     public string? ContextData { get; set; }
 }
-#pragma warning restore CS1591
-

src/Dfe.SignIn.InternalApi/Endpoints/EndpointRegistry.cs

@@ -0,0 +1,45 @@
+namespace Dfe.SignIn.InternalApi.Endpoints;
+
+/// <summary>
+/// A compile-time safe registry for class-based Minimal API endpoints.
+/// Handles both Dependency Injection registration and HTTP route mapping
+/// using strongly-typed generics (no reflection).
+/// </summary>
+public sealed class EndpointRegistry
+{
+    private readonly List<(Type Type, ServiceLifetime Lifetime)> endpoints = [];
+    private readonly List<Action<IEndpointRouteBuilder>> mappers = [];
+
+    /// <summary>
+    /// Registers an endpoint class for DI and captures its static Map delegate.
+    /// </summary>
+    /// <typeparam name="T">The endpoint class implementing <see cref="IEndpoint"/>.</typeparam>
+    /// <param name="lifetime">The DI service lifetime. Defaults to Transient.</param>
+    public EndpointRegistry Add<T>(ServiceLifetime lifetime = ServiceLifetime.Transient)
+        where T : class, IEndpoint
+    {
+        this.endpoints.Add((typeof(T), lifetime));
+        this.mappers.Add(T.Map);
+        return this;
+    }
+
+    /// <summary>
+    /// Registers all added endpoint classes with the DI container.
+    /// </summary>
+    public void RegisterServices(IServiceCollection services)
+    {
+        foreach (var (type, lifetime) in this.endpoints) {
+            services.Add(new ServiceDescriptor(type, type, lifetime));
+        }
+    }
+
+    /// <summary>
+    /// Maps all added endpoint routes to the application.
+    /// </summary>
+    public void MapRoutes(IEndpointRouteBuilder app)
+    {
+        foreach (var map in this.mappers) {
+            map(app);
+        }
+    }
+}

src/Dfe.SignIn.InternalApi/IEndpoint.cs → src/Dfe.SignIn.InternalApi/Endpoints/IEndpoint.cs

@@ -1,4 +1,4 @@
-namespace Dfe.SignIn.InternalApi;
+namespace Dfe.SignIn.InternalApi.Endpoints;
 
 /// <summary>
 /// Defines a contract for an endpoint that can be mapped to an <see cref="IEndpointRouteBuilder"/>.

src/Dfe.SignIn.InternalApi/Features/Users/ChangeEmail/CancelChangeEmailAddressEndpoint.cs

@@ -0,0 +1,76 @@
+using Dfe.SignIn.Core.Contracts.Audit;
+using Dfe.SignIn.Core.Contracts.Features.Users;
+using Dfe.SignIn.Core.Contracts.Features.Users.Shared;
+using Dfe.SignIn.Gateways.EntityFramework;
+using Dfe.SignIn.InternalApi.Endpoints;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.EntityFrameworkCore;
+
+namespace Dfe.SignIn.InternalApi.Features.Users.ChangeEmail;
+
+/// <summary>
+/// An endpoint to cancel the change of a user's email address.
+/// </summary>
+public sealed class CancelChangeEmailAddressEndpoint(
+    DbDirectoriesContext directoriesDbContext,
+    IAuditWriter auditWriter,
+    ILogger<CancelChangeEmailAddressEndpoint> logger,
+    IUserLookupService userLookupService) : IEndpoint
+{
+    /// <summary>
+    /// Maps the endpoint to the specified <see cref="IEndpointRouteBuilder"/>.
+    /// </summary>
+    /// <param name="app">The endpoint route builder to map the endpoint to.</param>
+    public static void Map(IEndpointRouteBuilder app)
+    {
+        app.MapDelete(UsersApiRoutes.CancelChangeEmail, async (
+            [FromRoute] Guid userId,
+            [FromServices] CancelChangeEmailAddressEndpoint endpoint,
+            CancellationToken cancellationToken) =>
+            await endpoint.HandleAsync(userId, cancellationToken))
+            .WithName("Cancel Change Email Address")
+            .WithTags("Users")
+            .Produces(StatusCodes.Status200OK)
+            .Produces(StatusCodes.Status400BadRequest)
+            .Produces(StatusCodes.Status404NotFound)
+            .Produces(StatusCodes.Status401Unauthorized)
+            .WithOpenApi();
+    }
+
+    /// <summary>
+    /// Handles the cancellation of a user's email address change request.
+    /// </summary>
+    public async Task<IResult> HandleAsync(
+        Guid userId,
+        CancellationToken cancellationToken)
+    {
+        logger.LogInformation("Cancelling email change for user {UserId}", userId);
+
+        var userInfo = await userLookupService.GetUserInfoAsync(userId, cancellationToken);
+
+        if (userInfo is null) {
+            logger.LogWarning("User {UserId} not found", userId);
+            return Results.NotFound(new { Message = "User not found" });
+        }
+
+        await auditWriter.Log(new WriteToAuditRequest {
+            EventCategory = AuditEventCategoryNames.ChangeEmail,
+            EventName = AuditChangeEmailEventNames.CancelChangeEmail,
+            Message = $"Cancel change email request from {userInfo.EmailAddress} (id: {userId})",
+        });
+
+        try {
+            await directoriesDbContext.UserCodes
+                .Where(uc => uc.Uid == userId)
+                .Where(uc => uc.CodeType == UserCodeType.ChangeEmail.ToDbValue())
+                .ExecuteDeleteAsync(cancellationToken);
+        }
+        catch (Exception ex) {
+            logger.LogError(ex, "Error cancelling email change for user {UserId}", userId);
+            throw;
+        }
+
+        logger.LogInformation("Successfully cancelled email change for user {UserId}", userId);
+        return Results.Ok();
+    }
+}

src/Dfe.SignIn.InternalApi/Features/Users/ChangeEmail/ConfirmChangeEmailAddressEndpoint.cs

@@ -7,6 +7,7 @@
 using Dfe.SignIn.Core.Interfaces.ExternalAuth;
 using Dfe.SignIn.Core.Interfaces.Notifications;
 using Dfe.SignIn.Gateways.EntityFramework;
+using Dfe.SignIn.InternalApi.Endpoints;
 using Dfe.SignIn.InternalApi.Features.Users.UserCode;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;

src/Dfe.SignIn.InternalApi/Features/Users/ChangeEmail/InitiateChangeEmailAddressEndpoint.cs

@@ -3,6 +3,7 @@
 using Dfe.SignIn.Core.Contracts.Features.Users;
 using Dfe.SignIn.Core.Contracts.Features.Users.ChangeEmailAddress;
 using Dfe.SignIn.Gateways.DistributedCache.Interactions;
+using Dfe.SignIn.InternalApi.Endpoints;
 using Dfe.SignIn.InternalApi.Features.Users.UserCode;
 using Humanizer;
 using Microsoft.AspNetCore.Mvc;

src/Dfe.SignIn.InternalApi/Features/Users/ChangeJobTitle/ChangeJobTitleEndpoint.cs

@@ -3,6 +3,7 @@
 using Dfe.SignIn.Core.Contracts.Features.Users;
 using Dfe.SignIn.Core.Contracts.Features.Users.ChangeJobTitle;
 using Dfe.SignIn.Gateways.EntityFramework;
+using Dfe.SignIn.InternalApi.Endpoints;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
 

src/Dfe.SignIn.InternalApi/Features/Users/ChangeName/ChangeNameEndpoint.cs

@@ -3,6 +3,7 @@
 using Dfe.SignIn.Core.Contracts.Features.Users;
 using Dfe.SignIn.Core.Contracts.Features.Users.ChangeName;
 using Dfe.SignIn.Gateways.EntityFramework;
+using Dfe.SignIn.InternalApi.Endpoints;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
 

src/Dfe.SignIn.InternalApi/Features/Users/GetUserProfile/GetUserProfileEndpoint.cs

@@ -1,6 +1,7 @@
 using Dfe.SignIn.Core.Contracts.Features.Users;
 using Dfe.SignIn.Core.Contracts.Features.Users.GetUserProfile;
 using Dfe.SignIn.Gateways.EntityFramework;
+using Dfe.SignIn.InternalApi.Endpoints;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
 

src/Dfe.SignIn.InternalApi/Features/Users/IsApprover/IsApproverEndpoint.cs

@@ -3,6 +3,7 @@
 using Dfe.SignIn.Core.Contracts.Organisations;
 using Dfe.SignIn.Core.Contracts.Users;
 using Dfe.SignIn.Gateways.EntityFramework;
+using Dfe.SignIn.InternalApi.Endpoints;
 using Dfe.SignIn.InternalApi.Features.Users.ChangeName;
 using Microsoft.EntityFrameworkCore;
 

src/Dfe.SignIn.InternalApi/Features/Users/PendingApprovalCounter/PendingApprovalCounterEndpoint.cs

@@ -2,6 +2,7 @@
 using Dfe.SignIn.Core.Contracts.Organisations;
 using Dfe.SignIn.Core.Contracts.Users;
 using Dfe.SignIn.Gateways.EntityFramework;
+using Dfe.SignIn.InternalApi.Endpoints;
 using Microsoft.EntityFrameworkCore;
 
 namespace Dfe.SignIn.InternalApi.Features.Users.PendingApprovalCounter;

src/Dfe.SignIn.InternalApi/Features/Users/UsersFeature.cs

@@ -5,6 +5,7 @@
 using Dfe.SignIn.Core.Interfaces.Notifications;
 using Dfe.SignIn.Core.UseCases.Users;
 using Dfe.SignIn.Gateways.DistributedCache.Interactions;
+using Dfe.SignIn.InternalApi.Endpoints;
 using Dfe.SignIn.InternalApi.Features.Users.ChangeEmail;
 using Dfe.SignIn.InternalApi.Features.Users.ChangeJobTitle;
 using Dfe.SignIn.InternalApi.Features.Users.ChangeName;
@@ -21,6 +22,9 @@ namespace Dfe.SignIn.InternalApi.Features.Users;
 [ExcludeFromCodeCoverage]
 public static class UsersFeature
 {
+    private static readonly EndpointRegistry NewEndpointRegistry = new EndpointRegistry()
+        .Add<CancelChangeEmailAddressEndpoint>();
+
     /// <summary>
     /// Maps the user-related endpoints to the specified <see cref="IEndpointRouteBuilder"/>.
     /// </summary>
@@ -34,6 +38,9 @@ public static void MapUsersEndpoints(this IEndpointRouteBuilder app)
         IsApproverEndpoint.Map(app);
         PendingApprovalCounterEndpoint.Map(app);
         ChangeJobTitleEndpoint.Map(app);
+
+        // New class-based endpoint mapped via registry
+        NewEndpointRegistry.MapRoutes(app);
     }
 
     /// <summary>
@@ -50,6 +57,10 @@ public static IServiceCollection AddUserServices(this IServiceCollection service
         services.AddScoped<IUserUpdatedPublisher, StubUserUpdatedPublisher>();
 
         services.AddInteractionLimiter<InitiateChangeEmailAddressRequest>(configuration);
+
+        // Register class-based endpoints with DI
+        NewEndpointRegistry.RegisterServices(services);
+
         return services;
     }
 }

src/Dfe.SignIn.Web.Profile/Controllers/ChangeEmailController.cs

@@ -203,11 +203,7 @@ public IActionResult PostComplete()
     [ValidateAntiForgeryToken]
     public async Task<IActionResult> PostCancel()
     {
-        await interaction.DispatchAsync(
-            new CancelPendingChangeEmailAddressRequest {
-                UserId = this.User.GetUserId(),
-            }
-        );
+        await usersApiClient.CancelChangeEmailAddress(this.User.GetUserId());
 
         this.SetFlashNotification(
             heading: "Email change cancelled",