test(bff): relay a refused diploma as 422 with its reason, a down scanner as 503 (refs #192)

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
not
2026-10-02 09:30:05 +02:00
co-authored by Claude Opus 5.5
parent f380fe582a
commit fd77aff8c0
5 changed files with 74 additions and 13 deletions
+9 -6
View File
@@ -36,9 +36,9 @@ public interface IDomainClient
Task<bool> WithdrawRegistrationAsync(string registrationId, string bsn, CancellationToken ct = default); Task<bool> WithdrawRegistrationAsync(string registrationId, string bsn, CancellationToken ct = default);
/// <summary>Provide (upload) the diploma the caller's own registration is waiting for ("documenten /// <summary>Provide (upload) the diploma the caller's own registration is waiting for ("documenten
/// aanleveren"). The file is carried base64-encoded. Owner-scoped by <paramref name="bsn"/>. Returns /// aanleveren"). The file is carried base64-encoded. Owner-scoped by <paramref name="bsn"/>. The domain
/// <c>false</c> when the domain reports the registration is unknown or not the caller's (404).</summary> /// refuses a non-PDF or infected file, and an upload it could not scan (S-29, ADR-0036).</summary>
Task<bool> ProvideDocumentsAsync( Task<ProvideDocumentsResult> ProvideDocumentsAsync(
string registrationId, string bsn, string contentBase64, string? fileName, string? contentType, CancellationToken ct = default); string registrationId, string bsn, string contentBase64, string? fileName, string? contentType, CancellationToken ct = default);
/// <summary>The behandelaar's werkbak — registrations awaiting beoordeling.</summary> /// <summary>The behandelaar's werkbak — registrations awaiting beoordeling.</summary>
@@ -48,6 +48,9 @@ public interface IDomainClient
Task DecideAsync(string registrationId, string besluit, CancellationToken ct = default); Task DecideAsync(string registrationId, string besluit, CancellationToken ct = default);
} }
/// <summary>How the domain answered a provide-documents request (S-29).</summary>
public enum ProvideDocumentsResult { Provided, NotFound, NotAPdf, Infected, ScannerUnavailable }
/// <summary>Port to the read projection.</summary> /// <summary>Port to the read projection.</summary>
public interface IProjectionClient public interface IProjectionClient
{ {
@@ -116,7 +119,7 @@ public sealed class DomainClient(HttpClient http) : IDomainClient
return true; return true;
} }
public async Task<bool> ProvideDocumentsAsync( public async Task<ProvideDocumentsResult> ProvideDocumentsAsync(
string registrationId, string bsn, string contentBase64, string? fileName, string? contentType, CancellationToken ct = default) string registrationId, string bsn, string contentBase64, string? fileName, string? contentType, CancellationToken ct = default)
{ {
using var response = await http.PostAsJsonAsync( using var response = await http.PostAsJsonAsync(
@@ -124,9 +127,9 @@ public sealed class DomainClient(HttpClient http) : IDomainClient
new { bsn, contentBase64, fileName, contentType }, ct); new { bsn, contentBase64, fileName, contentType }, ct);
// The domain 404s an unknown or not-owned registration; relay that rather than fail hard. // The domain 404s an unknown or not-owned registration; relay that rather than fail hard.
if (response.StatusCode == System.Net.HttpStatusCode.NotFound) if (response.StatusCode == System.Net.HttpStatusCode.NotFound)
return false; return ProvideDocumentsResult.NotFound;
response.EnsureSuccessStatusCode(); response.EnsureSuccessStatusCode();
return true; return ProvideDocumentsResult.Provided;
} }
public async Task<IReadOnlyList<WerkbakItem>> GetWerkbakAsync(CancellationToken ct = default) public async Task<IReadOnlyList<WerkbakItem>> GetWerkbakAsync(CancellationToken ct = default)
+1 -1
View File
@@ -177,7 +177,7 @@ app.MapPost("/self-service/registrations/{id}/documents", async (string id, Prov
return Results.BadRequest("A document is required."); return Results.BadRequest("A document is required.");
var provided = await domain.ProvideDocumentsAsync(id, bsn, body.ContentBase64, body.FileName, body.ContentType, ct); var provided = await domain.ProvideDocumentsAsync(id, bsn, body.ContentBase64, body.FileName, body.ContentType, ct);
return provided ? Results.NoContent() : Results.NotFound(); return provided == ProvideDocumentsResult.Provided ? Results.NoContent() : Results.NotFound();
}) })
.RequireAuthorization() .RequireAuthorization()
.Produces(StatusCodes.Status204NoContent) .Produces(StatusCodes.Status204NoContent)
+4 -5
View File
@@ -111,14 +111,13 @@ internal sealed class FakeDomainClient : IDomainClient
public (string RegistrationId, string Bsn, string ContentBase64, string? FileName, string? ContentType)? DocumentsProvidedFor { get; private set; } public (string RegistrationId, string Bsn, string ContentBase64, string? FileName, string? ContentType)? DocumentsProvidedFor { get; private set; }
/// <summary>Whether the fake domain reports the provide-documents as done (true → 204) or /// <summary>How the fake domain answers provide-documents. Tests set this to exercise the relay.</summary>
/// not-found/not-owned (false → 404). Tests set this to exercise the relay.</summary> public ProvideDocumentsResult ProvideDocumentsResult { get; set; } = ProvideDocumentsResult.Provided;
public bool ProvideDocumentsSucceeds { get; set; } = true;
public Task<bool> ProvideDocumentsAsync(string registrationId, string bsn, string contentBase64, string? fileName, string? contentType, CancellationToken ct = default) public Task<ProvideDocumentsResult> ProvideDocumentsAsync(string registrationId, string bsn, string contentBase64, string? fileName, string? contentType, CancellationToken ct = default)
{ {
DocumentsProvidedFor = (registrationId, bsn, contentBase64, fileName, contentType); DocumentsProvidedFor = (registrationId, bsn, contentBase64, fileName, contentType);
return Task.FromResult(ProvideDocumentsSucceeds); return Task.FromResult(ProvideDocumentsResult);
} }
public (string RegistrationId, string Besluit)? Decided { get; private set; } public (string RegistrationId, string Besluit)? Decided { get; private set; }
@@ -0,0 +1,32 @@
using System.Net;
using System.Text;
using Bff.Api;
namespace Bff.Tests;
// S-29 (#192): the BFF reads the domain's provide-documents answer — 422 carries the refusal reason,
// 503 means the scanner was down — into a result the endpoint relays.
public class DomainClientProvideDocumentsTests
{
private sealed class Reply(HttpStatusCode status, string? json) : HttpMessageHandler
{
protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken ct)
=> Task.FromResult(new HttpResponseMessage(status)
{
Content = new StringContent(json ?? "", Encoding.UTF8, "application/json"),
});
}
[Theory]
[InlineData(HttpStatusCode.NoContent, null, ProvideDocumentsResult.Provided)]
[InlineData(HttpStatusCode.NotFound, null, ProvideDocumentsResult.NotFound)]
[InlineData(HttpStatusCode.UnprocessableEntity, """{"reason":"not-a-pdf"}""", ProvideDocumentsResult.NotAPdf)]
[InlineData(HttpStatusCode.UnprocessableEntity, """{"reason":"infected"}""", ProvideDocumentsResult.Infected)]
[InlineData(HttpStatusCode.ServiceUnavailable, null, ProvideDocumentsResult.ScannerUnavailable)]
public async Task Maps_the_domain_answer_to_a_result(HttpStatusCode status, string? body, ProvideDocumentsResult expected)
{
var client = new DomainClient(new HttpClient(new Reply(status, body)) { BaseAddress = new Uri("http://domain/") });
Assert.Equal(expected, await client.ProvideDocumentsAsync("reg-1", "123456782", "JVBERi0=", null, null));
}
}
@@ -1,6 +1,7 @@
using System.Net; using System.Net;
using System.Net.Http.Headers; using System.Net.Http.Headers;
using System.Net.Http.Json; using System.Net.Http.Json;
using System.Text.Json;
using Bff.Api; using Bff.Api;
namespace Bff.Tests; namespace Bff.Tests;
@@ -162,13 +163,39 @@ public class SelfServiceEndpointTests
public async Task Relays_not_found_providing_documents_for_an_unknown_or_not_owned_registration() public async Task Relays_not_found_providing_documents_for_an_unknown_or_not_owned_registration()
{ {
using var factory = new BffFactory(); using var factory = new BffFactory();
factory.Domain.ProvideDocumentsSucceeds = false; factory.Domain.ProvideDocumentsResult = ProvideDocumentsResult.NotFound;
var response = await factory.CreateClient().SendAsync(ProvideDocuments(TestTokens.Valid("123456782"))); var response = await factory.CreateClient().SendAsync(ProvideDocuments(TestTokens.Valid("123456782")));
Assert.Equal(HttpStatusCode.NotFound, response.StatusCode); Assert.Equal(HttpStatusCode.NotFound, response.StatusCode);
} }
// S-29 (#192): the domain's refusal reaches the portal — 422 with the reason it words for the citizen.
[Theory]
[InlineData(ProvideDocumentsResult.NotAPdf, "not-a-pdf")]
[InlineData(ProvideDocumentsResult.Infected, "infected")]
public async Task Relays_a_refused_document_as_unprocessable_with_its_reason(ProvideDocumentsResult result, string reason)
{
using var factory = new BffFactory();
factory.Domain.ProvideDocumentsResult = result;
var response = await factory.CreateClient().SendAsync(ProvideDocuments(TestTokens.Valid("123456782")));
Assert.Equal(HttpStatusCode.UnprocessableEntity, response.StatusCode);
Assert.Equal(reason, (await response.Content.ReadFromJsonAsync<JsonElement>()).GetProperty("reason").GetString());
}
[Fact]
public async Task Relays_an_unavailable_scanner_as_service_unavailable()
{
using var factory = new BffFactory();
factory.Domain.ProvideDocumentsResult = ProvideDocumentsResult.ScannerUnavailable;
var response = await factory.CreateClient().SendAsync(ProvideDocuments(TestTokens.Valid("123456782")));
Assert.Equal(HttpStatusCode.ServiceUnavailable, response.StatusCode);
}
private static HttpRequestMessage Current(string? bearer) private static HttpRequestMessage Current(string? bearer)
{ {
var request = new HttpRequestMessage(HttpMethod.Get, "/self-service/registrations"); var request = new HttpRequestMessage(HttpMethod.Get, "/self-service/registrations");