acdream/tests/AcDream.Core.Net.Tests/Packets/FragmentAssemblerTests.cs
Erik 3226c4bcab feat(net): message fragment header + fragment + assembler (Phase 4.3)
Ports the fragment layer of the AC UDP protocol. A UDP packet's body is
zero or more message fragments back-to-back; a logical GameMessage that
doesn't fit in ~448 bytes gets split across multiple fragments sharing
the same Id with differing Index values. The assembler handles
reassembly across arbitrary arrival ordering and duplicate fragments.

Added (all reimplemented from ACE's AGPL reference, see NOTICE.md):
  - Packets/MessageFragmentHeader.cs: 16-byte fragment header struct
    with Pack/Unpack, constants for MaxFragmentSize (464) and
    MaxFragmentDataSize (448). Bit-layout doc comment documents what
    each field is for.
  - Packets/MessageFragment.cs: readonly record struct bundling a
    header with its payload bytes; TryParse(source) parses one fragment
    from the start of a buffer and returns (fragment, consumed) for
    incremental parsing of multi-fragment packets. Refuses to parse
    fragments with impossible TotalSize (too small for header, too
    large for the 464-byte max, or larger than the source buffer).
  - Packets/FragmentAssembler.cs: buffers partial messages keyed by
    fragment Id. Ingest(frag, out queue) returns the assembled byte[]
    when the last fragment arrives, null while still waiting. Key
    correctness properties, all tested:
      * Single-fragment (Count=1) shortcut releases with no buffering
      * Out-of-order arrival (e.g. 2, 0, 1) releases on last arrival
        and assembles in INDEX order, not arrival order
      * Duplicate-fragment idempotence (re-sending same index is a no-op)
      * Missing fragments stay buffered; DropAll() forcibly clears them
      * Two independent messages can be assembled in parallel without
        interfering
      * messageQueue captured from first-arriving fragment (it's a
        property of the logical message, not individual fragments)

Tests (17 new, 37 total in net project, 114 across both test projects):
  - MessageFragmentHeader (4): pack/unpack round-trip, little-endian
    wire format, constants, size-check throw
  - MessageFragment (6): complete parse, insufficient header, oversized
    TotalSize, undersized TotalSize, incomplete body, two-back-to-back
    incremental parse
  - FragmentAssembler (7): single-fragment, in-order 3-fragment,
    out-of-order 3-fragment (tests index-order assembly), duplicate
    idempotence, missing-fragment buffered, two parallel messages,
    DropAll

Phase 4.4 (GameMessage reader + opcode handlers) next.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-11 14:20:53 +02:00

123 lines
4.8 KiB
C#

using AcDream.Core.Net.Packets;
namespace AcDream.Core.Net.Tests.Packets;
public class FragmentAssemblerTests
{
private static MessageFragment MakeFrag(uint id, ushort count, ushort index, byte[] payload, ushort queue = 7)
=> new(
new MessageFragmentHeader
{
Id = id,
Count = count,
Index = index,
TotalSize = (ushort)(MessageFragmentHeader.Size + payload.Length),
Queue = queue,
},
payload);
[Fact]
public void Ingest_SingleFragmentMessage_ReleasesImmediately()
{
var assembler = new FragmentAssembler();
var frag = MakeFrag(id: 1, count: 1, index: 0, payload: new byte[] { 1, 2, 3 }, queue: 42);
var result = assembler.Ingest(frag, out var queue);
Assert.NotNull(result);
Assert.Equal(new byte[] { 1, 2, 3 }, result);
Assert.Equal(42, queue);
Assert.Equal(0, assembler.PartialCount);
}
[Fact]
public void Ingest_ThreeFragmentsInOrder_ReleasesOnLast()
{
// Queue is a property of the logical message, not individual fragments,
// so all three fragments carry the same queue value (captured from the
// first arrival). Testing with queue=9 on all three.
var assembler = new FragmentAssembler();
Assert.Null(assembler.Ingest(MakeFrag(7, 3, 0, new byte[] { 0xAA, 0xBB }, queue: 9), out _));
Assert.Equal(1, assembler.PartialCount);
Assert.Null(assembler.Ingest(MakeFrag(7, 3, 1, new byte[] { 0xCC, 0xDD }, queue: 9), out _));
var result = assembler.Ingest(MakeFrag(7, 3, 2, new byte[] { 0xEE }, queue: 9), out var queue);
Assert.NotNull(result);
Assert.Equal(new byte[] { 0xAA, 0xBB, 0xCC, 0xDD, 0xEE }, result);
Assert.Equal(9, queue);
Assert.Equal(0, assembler.PartialCount);
}
[Fact]
public void Ingest_OutOfOrderFragments_ReleasesCorrectlyOnLastArrival()
{
// Arrive as index 2, then 0, then 1 — the last arrival (index 1) is
// neither the first nor the last index, so this tests that the
// assembler releases on "count full", not "last index".
var assembler = new FragmentAssembler();
Assert.Null(assembler.Ingest(MakeFrag(3, 3, 2, new byte[] { 0xCC }), out _));
Assert.Null(assembler.Ingest(MakeFrag(3, 3, 0, new byte[] { 0xAA }), out _));
var result = assembler.Ingest(MakeFrag(3, 3, 1, new byte[] { 0xBB }), out _);
Assert.NotNull(result);
// Result must be assembled in INDEX order, not arrival order.
Assert.Equal(new byte[] { 0xAA, 0xBB, 0xCC }, result);
}
[Fact]
public void Ingest_DuplicateFragment_IsIdempotent()
{
var assembler = new FragmentAssembler();
Assert.Null(assembler.Ingest(MakeFrag(5, 2, 0, new byte[] { 0x11 }), out _));
// Resend index 0 — should not double-count or corrupt state.
Assert.Null(assembler.Ingest(MakeFrag(5, 2, 0, new byte[] { 0x11 }), out _));
// Assembler should still be waiting for index 1.
Assert.Equal(1, assembler.PartialCount);
var result = assembler.Ingest(MakeFrag(5, 2, 1, new byte[] { 0x22 }), out _);
Assert.NotNull(result);
Assert.Equal(new byte[] { 0x11, 0x22 }, result);
}
[Fact]
public void Ingest_MissingFragment_DoesNotRelease()
{
var assembler = new FragmentAssembler();
Assert.Null(assembler.Ingest(MakeFrag(9, 3, 0, new byte[] { 1 }), out _));
Assert.Null(assembler.Ingest(MakeFrag(9, 3, 2, new byte[] { 3 }), out _));
// Only 2 of 3 arrived → still waiting
Assert.Equal(1, assembler.PartialCount);
}
[Fact]
public void Ingest_TwoIndependentMessages_BuiltInParallel()
{
var assembler = new FragmentAssembler();
Assert.Null(assembler.Ingest(MakeFrag(100, 2, 0, new byte[] { 0xA1 }), out _));
Assert.Null(assembler.Ingest(MakeFrag(200, 2, 0, new byte[] { 0xB1 }), out _));
Assert.Equal(2, assembler.PartialCount);
var resultA = assembler.Ingest(MakeFrag(100, 2, 1, new byte[] { 0xA2 }), out _);
Assert.Equal(new byte[] { 0xA1, 0xA2 }, resultA);
Assert.Equal(1, assembler.PartialCount);
var resultB = assembler.Ingest(MakeFrag(200, 2, 1, new byte[] { 0xB2 }), out _);
Assert.Equal(new byte[] { 0xB1, 0xB2 }, resultB);
Assert.Equal(0, assembler.PartialCount);
}
[Fact]
public void DropAll_ClearsInFlightPartials()
{
var assembler = new FragmentAssembler();
assembler.Ingest(MakeFrag(1, 5, 0, new byte[] { 1 }), out _);
assembler.Ingest(MakeFrag(2, 5, 0, new byte[] { 2 }), out _);
Assert.Equal(2, assembler.PartialCount);
assembler.DropAll();
Assert.Equal(0, assembler.PartialCount);
}
}