SVSim/SVSimServer
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix(guild): friend_list returns bare array-at-root (matches GuildFriendListTask.Parse)

Browse Source 
GuildFriendListTask.Parse() reads base.ResponseData[data][i] directly —
data must be a bare JSON array, not {friends:[...]}.  Delete the
GuildFriendListResponse wrapper DTO; promote GuildInviteCandidateDto to its
own file.  Controller now returns List<GuildInviteCandidateDto> so the
middleware wraps it as data:[…].  Update wire-shape and integration tests to
assert array-at-root.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
gamer147
2026-06-27 14:35:20 -04:00
parent f2b996a593
commit 484b51086a
4 changed files with 58 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
SVSim.EmulatedEntrypoint/Controllers/GuildController.cs
View File

@@ -174,13 +174,13 @@ public sealed class GuildController : SVSimController
}
[HttpPost("friend_list")]
public async Task<ActionResult<GuildFriendListResponse>> FriendList([FromBody] BaseRequest _, CancellationToken ct)
public async Task<ActionResult<List<GuildInviteCandidateDto>>> FriendList([FromBody] BaseRequest _, CancellationToken ct)
{
if (!TryGetViewerId(out var viewerId)) return Unauthorized();
var friendInfo = await _friends.GetFriendsAsync(viewerId, ct);
if (friendInfo.Friends.Count == 0)
return new GuildFriendListResponse { Friends = new() };
return new List<GuildInviteCandidateDto>();
// For each friend, determine if they are already in a guild (is_join_guild).
var friendViewerIds = friendInfo.Friends.Select(f => (long)f.ViewerId).ToList();
@@ -206,7 +206,7 @@ public sealed class GuildController : SVSimController
});
}
return new GuildFriendListResponse { Friends = candidates };
return candidates;
}
[HttpPost("invite_user_list")]

18
SVSim.EmulatedEntrypoint/Models/Dtos/Guild/GuildFriendListResponse.cs → SVSim.EmulatedEntrypoint/Models/Dtos/Guild/GuildInviteCandidateDto.cs
View File

@@ -1,26 +1,14 @@
using MessagePack;
using System.Text.Json.Serialization;
using SVSim.EmulatedEntrypoint.Models.Dtos.Common.Guild;
namespace SVSim.EmulatedEntrypoint.Models.Dtos.Guild;
/// <summary>
/// Response for POST /guild/friend_list.
/// NOTE: per guild-friend_list.md, `data` is an array at the root — BUT we return this
/// as a wrapper for now; the controller returns the List directly.
/// TODO(task-14): verify array-root shape via capture; may need a custom response wrapper.
/// One entry in the /guild/friend_list response.
/// GuildFriendListTask.Parse() iterates base.ResponseData["data"][i] directly — data is a
/// bare JSON array, not a wrapper object. This DTO is the element type of that array.
/// </summary>
[MessagePackObject]
public class GuildFriendListResponse
{
// Placeholder — see controller; actual wire shape is array-at-root per spec.
// The controller returns List<GuildInviteCandidateDto> directly for now.
[JsonPropertyName("friends"), Key("friends")]
public List<GuildInviteCandidateDto> Friends { get; set; } = new();
}
/// <summary>InviteCandidate — UserInfoBase + is_join_guild flag.</summary>
[MessagePackObject]
public class GuildInviteCandidateDto
{
[JsonPropertyName("viewer_id"), Key("viewer_id"), JsonConverter(typeof(SVSim.EmulatedEntrypoint.Models.Dtos.Common.StringifiedLongConverter))]

36
SVSim.UnitTests/Integration/Guild/GuildChangeRoleFriendListFlowTests.cs
View File

@@ -163,8 +163,9 @@ public class GuildChangeRoleFriendListFlowTests
// ─── /guild/friend_list ───────────────────────────────────────────────────────
[Test]
public async Task FriendList_returns_friends_array_with_is_join_guild_field()
public async Task FriendList_returns_bare_array_with_is_join_guild_field()
{
// GuildFriendListTask.Parse() reads base.ResponseData["data"][i] directly — data is a bare array.
using var factory = new SVSimTestFactory();
long viewerA = await factory.SeedViewerAsync(76_561_198_500_000_005UL, "CrfViewerA");
long viewerB = await factory.SeedViewerAsync(76_561_198_500_000_006UL, "CrfViewerB");
@@ -186,16 +187,12 @@ public class GuildChangeRoleFriendListFlowTests
using var doc = JsonDocument.Parse(body);
var root = doc.RootElement;
if (root.TryGetProperty("result_code", out var rc))
Assert.That(rc.GetInt32(), Is.Not.EqualTo(2), $"friend_list returned error: {body}");
// Response must be a bare JSON array at root — NOT an object with a "friends" key.
Assert.That(root.ValueKind, Is.EqualTo(JsonValueKind.Array),
$"friend_list data must be a bare array at root: {body}");
Assert.That(root.GetArrayLength(), Is.EqualTo(1), "viewerA has 1 friend");
// Response must have "friends" array.
Assert.That(root.TryGetProperty("friends", out var friends), Is.True,
$"response must have 'friends' key: {body}");
Assert.That(friends.ValueKind, Is.EqualTo(JsonValueKind.Array));
Assert.That(friends.GetArrayLength(), Is.EqualTo(1), "viewerA has 1 friend");
var friend = friends[0];
var friend = root[0];
Assert.That(GetStringifiedLong(friend, "viewer_id"), Is.EqualTo(viewerB));
// is_join_guild must be present — viewerB has no guild, so false.
@@ -237,10 +234,13 @@ public class GuildChangeRoleFriendListFlowTests
Assert.That(resp.IsSuccessStatusCode, Is.True);
using var doc = JsonDocument.Parse(body);
var friends = doc.RootElement.GetProperty("friends");
Assert.That(friends.GetArrayLength(), Is.EqualTo(1));
// Response is a bare array — GuildFriendListTask reads data[i] directly.
var arr = doc.RootElement;
Assert.That(arr.ValueKind, Is.EqualTo(JsonValueKind.Array),
$"friend_list data must be a bare array at root: {body}");
Assert.That(arr.GetArrayLength(), Is.EqualTo(1));
var friend = friends[0];
var friend = arr[0];
Assert.That(friend.GetProperty("is_join_guild").GetBoolean(), Is.True,
"viewerB is in a guild so is_join_guild must be true");
}
@@ -257,10 +257,10 @@ public class GuildChangeRoleFriendListFlowTests
Assert.That(resp.IsSuccessStatusCode, Is.True);
using var doc = JsonDocument.Parse(body);
if (doc.RootElement.TryGetProperty("result_code", out var rc))
Assert.That(rc.GetInt32(), Is.Not.EqualTo(2), $"friend_list error: {body}");
Assert.That(doc.RootElement.TryGetProperty("friends", out var friends), Is.True);
Assert.That(friends.GetArrayLength(), Is.EqualTo(0), "No friends means empty array");
// Response is a bare array at root — no wrapper object.
var root = doc.RootElement;
Assert.That(root.ValueKind, Is.EqualTo(JsonValueKind.Array),
$"friend_list must return a bare array even when empty: {body}");
Assert.That(root.GetArrayLength(), Is.EqualTo(0), "No friends means empty array");
}
}

28
SVSim.UnitTests/Wire/GuildWireShape.cs
View File

@@ -157,13 +157,11 @@ public class GuildWireShape
}
[Test]
public void GuildFriendList_response_serializes_friends_array_with_is_join_guild()
public void GuildFriendList_response_is_bare_array_at_root_with_is_join_guild()
{
// GuildFriendListTask.Parse() iterates data[i] and reads jsonData2["is_join_guild"].ToBoolean()
// from each entry. The root wrapper is "friends" in our DTO.
var resp = new GuildFriendListResponse
{
Friends = new()
// GuildFriendListTask.Parse() reads base.ResponseData["data"] and iterates with data[i] directly.
// data must be a bare JSON array — NOT an object with a "friends" key.
var list = new List<GuildInviteCandidateDto>
{
new GuildInviteCandidateDto
{
@@ -185,28 +183,32 @@ public class GuildWireShape
DegreeId = 0,
IsJoinGuild = true,
},
}
};
var json = JsonSerializer.Serialize(resp, Opts);
var json = JsonSerializer.Serialize(list, Opts);
using var doc = JsonDocument.Parse(json);
var root = doc.RootElement;
Assert.That(root.TryGetProperty("friends", out var friends), Is.True, "response must have 'friends' key");
Assert.That(friends.ValueKind, Is.EqualTo(JsonValueKind.Array));
Assert.That(friends.GetArrayLength(), Is.EqualTo(2));
// Root must be an array directly — GuildFriendListTask reads data[i], not data["friends"][i].
Assert.That(root.ValueKind, Is.EqualTo(JsonValueKind.Array),
"friend_list data must be a bare array, not a wrapper object");
Assert.That(root.GetArrayLength(), Is.EqualTo(2));
// First entry: is_join_guild = false.
var first = friends[0];
var first = root[0];
Assert.That(first.TryGetProperty("is_join_guild", out var jg1), Is.True, "is_join_guild must be present");
Assert.That(jg1.GetBoolean(), Is.False);
// Second entry: is_join_guild = true.
var second = friends[1];
var second = root[1];
Assert.That(second.GetProperty("is_join_guild").GetBoolean(), Is.True);
// viewer_id must be stringified.
Assert.That(first.GetProperty("viewer_id").ValueKind, Is.EqualTo(JsonValueKind.String),
"viewer_id must be stringified in friend_list entries");
// No "friends" wrapper key must exist.
Assert.That(root.ValueKind, Is.Not.EqualTo(JsonValueKind.Object),
"root must not be an object — no 'friends' wrapper allowed");
}
[Test]