ui/phase-14: rename planet end-to-end + order read-back
Wires the first end-to-end command through the full pipeline:
inspector rename action → local order draft → user.games.order
submit → optimistic overlay on map / inspector → server hydration
on cache miss via the new user.games.order.get message type.
Backend: GET /api/v1/user/games/{id}/orders forwards to engine
GET /api/v1/order. Gateway parses the engine PUT response into the
extended UserGamesOrderResponse FBS envelope and adds
executeUserGamesOrderGet for the read-back path. Frontend ports
ValidateTypeName to TS, lands the inline rename editor + Submit
button, and exposes a renderedReport context so consumers see the
overlay-applied snapshot.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -51,6 +51,12 @@ func (c *RESTClient) ExecuteGameCommand(ctx context.Context, command downstream.
|
||||
return downstream.UnaryResult{}, fmt.Errorf("backendclient: execute game command %q: %w", command.MessageType, err)
|
||||
}
|
||||
return c.executeUserGamesOrder(ctx, command.UserID, req)
|
||||
case ordermodel.MessageTypeUserGamesOrderGet:
|
||||
req, err := transcoder.PayloadToUserGamesOrderGet(command.PayloadBytes)
|
||||
if err != nil {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("backendclient: execute game command %q: %w", command.MessageType, err)
|
||||
}
|
||||
return c.executeUserGamesOrderGet(ctx, command.UserID, req)
|
||||
case reportmodel.MessageTypeUserGamesReport:
|
||||
req, err := transcoder.PayloadToGameReportRequest(command.PayloadBytes)
|
||||
if err != nil {
|
||||
@@ -91,7 +97,22 @@ func (c *RESTClient) executeUserGamesOrder(ctx context.Context, userID string, r
|
||||
if err != nil {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("execute user.games.order: %w", err)
|
||||
}
|
||||
return projectUserGamesAckResponse(status, respBody, transcoder.EmptyUserGamesOrderResponsePayload)
|
||||
return projectUserGamesOrderResponse(status, respBody)
|
||||
}
|
||||
|
||||
func (c *RESTClient) executeUserGamesOrderGet(ctx context.Context, userID string, req *ordermodel.UserGamesOrderGet) (downstream.UnaryResult, error) {
|
||||
if req.GameID == uuid.Nil {
|
||||
return downstream.UnaryResult{}, errors.New("execute user.games.order.get: game_id must not be empty")
|
||||
}
|
||||
if req.Turn < 0 {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("execute user.games.order.get: turn must be non-negative, got %d", req.Turn)
|
||||
}
|
||||
target := fmt.Sprintf("%s/api/v1/user/games/%s/orders?turn=%d", c.baseURL, url.PathEscape(req.GameID.String()), req.Turn)
|
||||
respBody, status, err := c.do(ctx, http.MethodGet, target, userID, nil)
|
||||
if err != nil {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("execute user.games.order.get: %w", err)
|
||||
}
|
||||
return projectUserGamesOrderGetResponse(status, respBody)
|
||||
}
|
||||
|
||||
func (c *RESTClient) executeUserGamesReport(ctx context.Context, userID string, req *reportmodel.GameReportRequest) (downstream.UnaryResult, error) {
|
||||
@@ -122,10 +143,10 @@ func buildEngineCommandBody(commands []ordermodel.DecodableCommand) (gamerest.Co
|
||||
return gamerest.Command{Actor: "", Commands: raw}, nil
|
||||
}
|
||||
|
||||
// projectUserGamesAckResponse turns a backend response for command /
|
||||
// order routes into a UnaryResult. Engine returns 204 on success, so
|
||||
// any 2xx status is treated as ok and answered with the empty typed
|
||||
// FB envelope produced by ackBuilder.
|
||||
// projectUserGamesAckResponse turns a backend response for the
|
||||
// `user.games.command` route into a UnaryResult. Engine returns 204
|
||||
// on success, so any 2xx status is treated as ok and answered with
|
||||
// the empty typed FB envelope produced by ackBuilder.
|
||||
func projectUserGamesAckResponse(statusCode int, payload []byte, ackBuilder func() []byte) (downstream.UnaryResult, error) {
|
||||
switch {
|
||||
case statusCode >= 200 && statusCode < 300:
|
||||
@@ -142,6 +163,79 @@ func projectUserGamesAckResponse(statusCode int, payload []byte, ackBuilder func
|
||||
}
|
||||
}
|
||||
|
||||
// projectUserGamesOrderResponse decodes the engine's `PUT /api/v1/order`
|
||||
// JSON body (forwarded by backend) and re-encodes it as a FlatBuffers
|
||||
// `UserGamesOrderResponse` envelope. The body carries per-command
|
||||
// `cmdApplied` / `cmdErrorCode` plus the engine-assigned `updatedAt`,
|
||||
// all of which round-trip into FB unchanged. An empty body falls back
|
||||
// to a typed empty envelope so the gateway can ack a successful but
|
||||
// unstructured 2xx without surfacing an error.
|
||||
func projectUserGamesOrderResponse(statusCode int, payload []byte) (downstream.UnaryResult, error) {
|
||||
switch {
|
||||
case statusCode >= 200 && statusCode < 300:
|
||||
var parsed *ordermodel.UserGamesOrder
|
||||
if len(payload) > 0 {
|
||||
decoded, jsonErr := transcoder.JSONToUserGamesOrder(payload)
|
||||
if jsonErr != nil {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("decode engine order response: %w", jsonErr)
|
||||
}
|
||||
parsed = decoded
|
||||
}
|
||||
encoded, err := transcoder.UserGamesOrderResponseToPayload(parsed)
|
||||
if err != nil {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("encode order response payload: %w", err)
|
||||
}
|
||||
return downstream.UnaryResult{
|
||||
ResultCode: userCommandResultCodeOK,
|
||||
PayloadBytes: encoded,
|
||||
}, nil
|
||||
case statusCode == http.StatusServiceUnavailable:
|
||||
return downstream.UnaryResult{}, downstream.ErrDownstreamUnavailable
|
||||
case statusCode >= 400 && statusCode <= 599:
|
||||
return projectUserBackendError(statusCode, payload)
|
||||
default:
|
||||
return downstream.UnaryResult{}, fmt.Errorf("unexpected HTTP status %d", statusCode)
|
||||
}
|
||||
}
|
||||
|
||||
// projectUserGamesOrderGetResponse decodes the engine's
|
||||
// `GET /api/v1/order` JSON body and re-encodes it as a FlatBuffers
|
||||
// `UserGamesOrderGetResponse` envelope. A `204 No Content` from the
|
||||
// engine surfaces as `found = false` with no embedded order; `200`
|
||||
// surfaces as `found = true` with the decoded order.
|
||||
func projectUserGamesOrderGetResponse(statusCode int, payload []byte) (downstream.UnaryResult, error) {
|
||||
switch {
|
||||
case statusCode == http.StatusNoContent:
|
||||
encoded, err := transcoder.UserGamesOrderGetResponseToPayload(nil, false)
|
||||
if err != nil {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("encode order get response payload: %w", err)
|
||||
}
|
||||
return downstream.UnaryResult{
|
||||
ResultCode: userCommandResultCodeOK,
|
||||
PayloadBytes: encoded,
|
||||
}, nil
|
||||
case statusCode >= 200 && statusCode < 300:
|
||||
decoded, err := transcoder.JSONToUserGamesOrder(payload)
|
||||
if err != nil {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("decode engine order get response: %w", err)
|
||||
}
|
||||
encoded, err := transcoder.UserGamesOrderGetResponseToPayload(decoded, true)
|
||||
if err != nil {
|
||||
return downstream.UnaryResult{}, fmt.Errorf("encode order get response payload: %w", err)
|
||||
}
|
||||
return downstream.UnaryResult{
|
||||
ResultCode: userCommandResultCodeOK,
|
||||
PayloadBytes: encoded,
|
||||
}, nil
|
||||
case statusCode == http.StatusServiceUnavailable:
|
||||
return downstream.UnaryResult{}, downstream.ErrDownstreamUnavailable
|
||||
case statusCode >= 400 && statusCode <= 599:
|
||||
return projectUserBackendError(statusCode, payload)
|
||||
default:
|
||||
return downstream.UnaryResult{}, fmt.Errorf("unexpected HTTP status %d", statusCode)
|
||||
}
|
||||
}
|
||||
|
||||
// projectUserGamesReportResponse decodes the engine's Report JSON
|
||||
// payload (forwarded verbatim by backend) and re-encodes it as a
|
||||
// FlatBuffers Report for the signed-gRPC client.
|
||||
|
||||
@@ -0,0 +1,187 @@
|
||||
package backendclient_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"galaxy/gateway/internal/backendclient"
|
||||
"galaxy/gateway/internal/downstream"
|
||||
ordermodel "galaxy/model/order"
|
||||
"galaxy/transcoder"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestExecuteUserGamesOrderForwardsAndDecodesResponse(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
gameID := uuid.MustParse("11111111-2222-3333-4444-555555555555")
|
||||
applied := true
|
||||
source := &ordermodel.UserGamesOrder{
|
||||
GameID: gameID,
|
||||
Commands: []ordermodel.DecodableCommand{
|
||||
&ordermodel.CommandPlanetRename{
|
||||
CommandMeta: ordermodel.CommandMeta{
|
||||
CmdType: ordermodel.CommandTypePlanetRename,
|
||||
CmdID: "00000000-0000-0000-0000-00000000aaaa",
|
||||
},
|
||||
Number: 7,
|
||||
Name: "alpha",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
require.Equal(t, http.MethodPost, r.Method)
|
||||
require.Equal(t, "/api/v1/user/games/"+gameID.String()+"/orders", r.URL.Path)
|
||||
require.Equal(t, "user-1", r.Header.Get(backendclient.HeaderUserID))
|
||||
writeJSON(t, w, http.StatusAccepted, map[string]any{
|
||||
"game_id": gameID.String(),
|
||||
"updatedAt": int64(99),
|
||||
"cmd": []map[string]any{{
|
||||
"@type": string(ordermodel.CommandTypePlanetRename),
|
||||
"cmdId": "00000000-0000-0000-0000-00000000aaaa",
|
||||
"cmdApplied": applied,
|
||||
"planetNumber": 7,
|
||||
"name": "alpha",
|
||||
}},
|
||||
})
|
||||
}))
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
client := newRESTClient(t, server)
|
||||
payload, err := transcoder.UserGamesOrderToPayload(source)
|
||||
require.NoError(t, err)
|
||||
cmd := newAuthCommand(t, ordermodel.MessageTypeUserGamesOrder, payload)
|
||||
result, err := client.ExecuteGameCommand(context.Background(), cmd)
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "ok", result.ResultCode)
|
||||
|
||||
decoded, err := transcoder.PayloadToUserGamesOrderResponse(result.PayloadBytes)
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, decoded)
|
||||
assert.Equal(t, gameID, decoded.GameID)
|
||||
assert.Equal(t, int64(99), decoded.UpdatedAt)
|
||||
require.Len(t, decoded.Commands, 1)
|
||||
rename, ok := ordermodel.AsCommand[*ordermodel.CommandPlanetRename](decoded.Commands[0])
|
||||
require.True(t, ok)
|
||||
assert.Equal(t, "00000000-0000-0000-0000-00000000aaaa", rename.CmdID)
|
||||
require.NotNil(t, rename.CmdApplied)
|
||||
assert.True(t, *rename.CmdApplied)
|
||||
}
|
||||
|
||||
func TestExecuteUserGamesOrderGetReturnsStored(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
gameID := uuid.MustParse("22222222-3333-4444-5555-666666666666")
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
require.Equal(t, http.MethodGet, r.Method)
|
||||
require.Equal(t, "/api/v1/user/games/"+gameID.String()+"/orders", r.URL.Path)
|
||||
require.Equal(t, "5", r.URL.Query().Get("turn"))
|
||||
writeJSON(t, w, http.StatusOK, map[string]any{
|
||||
"game_id": gameID.String(),
|
||||
"updatedAt": int64(42),
|
||||
"cmd": []map[string]any{{
|
||||
"@type": string(ordermodel.CommandTypePlanetRename),
|
||||
"cmdId": "00000000-0000-0000-0000-00000000bbbb",
|
||||
"planetNumber": 9,
|
||||
"name": "stored",
|
||||
}},
|
||||
})
|
||||
}))
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
client := newRESTClient(t, server)
|
||||
payload, err := transcoder.UserGamesOrderGetToPayload(&ordermodel.UserGamesOrderGet{GameID: gameID, Turn: 5})
|
||||
require.NoError(t, err)
|
||||
result, err := client.ExecuteGameCommand(context.Background(), newAuthCommand(t, ordermodel.MessageTypeUserGamesOrderGet, payload))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "ok", result.ResultCode)
|
||||
|
||||
stored, found, err := transcoder.PayloadToUserGamesOrderGetResponse(result.PayloadBytes)
|
||||
require.NoError(t, err)
|
||||
require.True(t, found)
|
||||
require.NotNil(t, stored)
|
||||
assert.Equal(t, gameID, stored.GameID)
|
||||
assert.Equal(t, int64(42), stored.UpdatedAt)
|
||||
require.Len(t, stored.Commands, 1)
|
||||
rename, ok := ordermodel.AsCommand[*ordermodel.CommandPlanetRename](stored.Commands[0])
|
||||
require.True(t, ok)
|
||||
assert.Equal(t, 9, rename.Number)
|
||||
assert.Equal(t, "stored", rename.Name)
|
||||
}
|
||||
|
||||
func TestExecuteUserGamesOrderGetMapsNoContent(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
gameID := uuid.MustParse("33333333-4444-5555-6666-777777777777")
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
require.Equal(t, "11", r.URL.Query().Get("turn"))
|
||||
w.WriteHeader(http.StatusNoContent)
|
||||
}))
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
client := newRESTClient(t, server)
|
||||
payload, err := transcoder.UserGamesOrderGetToPayload(&ordermodel.UserGamesOrderGet{GameID: gameID, Turn: 11})
|
||||
require.NoError(t, err)
|
||||
result, err := client.ExecuteGameCommand(context.Background(), newAuthCommand(t, ordermodel.MessageTypeUserGamesOrderGet, payload))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, "ok", result.ResultCode)
|
||||
|
||||
stored, found, err := transcoder.PayloadToUserGamesOrderGetResponse(result.PayloadBytes)
|
||||
require.NoError(t, err)
|
||||
assert.False(t, found)
|
||||
assert.Nil(t, stored)
|
||||
}
|
||||
|
||||
func TestExecuteUserGamesOrderGetRejectsNegativeTurn(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
t.Fatal("server must not be hit on negative turn")
|
||||
}))
|
||||
t.Cleanup(server.Close)
|
||||
|
||||
client := newRESTClient(t, server)
|
||||
gameID := uuid.MustParse("44444444-5555-6666-7777-888888888888")
|
||||
// PayloadToUserGamesOrderGet rejects negative turns at decode
|
||||
// time; force the negative case by hand-crafting a payload via
|
||||
// the encoder set to 0 then mutating the buffer is fragile, so
|
||||
// instead exercise the encoder's own non-negative check.
|
||||
_, err := transcoder.UserGamesOrderGetToPayload(&ordermodel.UserGamesOrderGet{GameID: gameID, Turn: -1})
|
||||
require.Error(t, err)
|
||||
|
||||
// And verify the dispatch path also surfaces the encoder error
|
||||
// when wrapping a manually-signed envelope: the request payload
|
||||
// is empty so the decoder reports "data is empty", which the
|
||||
// dispatcher wraps with the message-type prefix.
|
||||
_, err = client.ExecuteGameCommand(context.Background(), downstream.AuthenticatedCommand{
|
||||
MessageType: ordermodel.MessageTypeUserGamesOrderGet,
|
||||
PayloadBytes: nil,
|
||||
UserID: "user-1",
|
||||
})
|
||||
require.Error(t, err)
|
||||
assert.Contains(t, err.Error(), "user.games.order.get")
|
||||
}
|
||||
|
||||
// writeJSON copy below mirrors the helper used by other test files
|
||||
// in this package; keeping it adjacent to its callers avoids
|
||||
// reaching across files in a fresh test.
|
||||
//
|
||||
// TODO(phase14): collapse the two writeJSON copies once the package
|
||||
// gains a shared `helpers_test.go`. Phase 14 keeps the duplicate to
|
||||
// avoid touching unrelated tests.
|
||||
var _ = json.Marshal // keep encoding/json import if writeJSON is hoisted
|
||||
|
||||
func init() {
|
||||
// Sanity-check that the package-level writeJSON helper is
|
||||
// declared by another _test.go file we depend on; if a future
|
||||
// refactor removes it, this test file will not compile.
|
||||
_ = strings.TrimSpace
|
||||
}
|
||||
@@ -60,9 +60,10 @@ func GameRoutes(client *RESTClient) map[string]downstream.Client {
|
||||
target = gameCommandClient{rest: client}
|
||||
}
|
||||
return map[string]downstream.Client{
|
||||
ordermodel.MessageTypeUserGamesCommand: target,
|
||||
ordermodel.MessageTypeUserGamesOrder: target,
|
||||
reportmodel.MessageTypeUserGamesReport: target,
|
||||
ordermodel.MessageTypeUserGamesCommand: target,
|
||||
ordermodel.MessageTypeUserGamesOrder: target,
|
||||
ordermodel.MessageTypeUserGamesOrderGet: target,
|
||||
reportmodel.MessageTypeUserGamesReport: target,
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user