Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 65995f30a6 | |||
| fd88cef32f | |||
| eb39e4393d | |||
| 9c086a4b10 | |||
| b6c6ddfbc4 | |||
| 186a79a43e | |||
| c54ea6f055 | |||
| b562e9f7b3 |
@@ -8,7 +8,7 @@ from sqlalchemy.ext.asyncio import create_async_engine
|
||||
|
||||
from app.config import settings
|
||||
from app.database import Base
|
||||
from app.models import user, session, world, asset, avatar_loadout # noqa: F401
|
||||
from app.models import user, session, world, asset, avatar_loadout, world_content # noqa: F401
|
||||
|
||||
# this is the Alembic Config object, which provides
|
||||
# access to the values within the .ini file in use.
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
"""add world_rooms, world_chunks, world_chunk_revisions tables
|
||||
|
||||
Revision ID: 0005_add_world_content_tables
|
||||
Revises: 0004_add_avatar_loadouts_table
|
||||
Create Date: 2026-09-14 00:00:00.000000
|
||||
|
||||
See docs/architecture/world_persistence_impl.md §4. Chunk content
|
||||
(rooms, chunk payloads, chunk revisions) lives in Postgres, purely
|
||||
additive to the existing ``worlds`` table.
|
||||
"""
|
||||
from typing import Sequence, Union
|
||||
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
from sqlalchemy.dialects import postgresql
|
||||
|
||||
# revision identifiers, used by Alembic.
|
||||
revision: str = "0005_add_world_content_tables"
|
||||
down_revision: Union[str, None] = "0004_add_avatar_loadouts_table"
|
||||
branch_labels: Union[str, Sequence[str], None] = None
|
||||
depends_on: Union[str, Sequence[str], None] = None
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
op.create_table(
|
||||
"world_rooms",
|
||||
sa.Column("id", sa.Integer(), primary_key=True, index=True),
|
||||
sa.Column(
|
||||
"world_id", sa.Integer(),
|
||||
sa.ForeignKey("worlds.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column("slug", sa.String(64), nullable=False),
|
||||
sa.Column("name", sa.String(255), nullable=False),
|
||||
sa.Column(
|
||||
"grid", postgresql.JSONB(), nullable=False,
|
||||
server_default='{"size": [32, 32, 1], "origin": [0, 0, 0]}',
|
||||
),
|
||||
sa.Column("bounds", postgresql.JSONB(), nullable=True),
|
||||
sa.Column("spawn", postgresql.JSONB(), nullable=True),
|
||||
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=False),
|
||||
sa.Column(
|
||||
"updated_at", sa.DateTime(timezone=True),
|
||||
server_default=sa.func.now(), nullable=False,
|
||||
),
|
||||
sa.UniqueConstraint("world_id", "slug", name="uq_world_rooms_world_slug"),
|
||||
)
|
||||
op.create_index("ix_world_rooms_world_id", "world_rooms", ["world_id"])
|
||||
|
||||
op.create_table(
|
||||
"world_chunks",
|
||||
sa.Column("id", sa.Integer(), primary_key=True, index=True),
|
||||
sa.Column(
|
||||
"world_id", sa.Integer(),
|
||||
sa.ForeignKey("worlds.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column(
|
||||
"room_id", sa.Integer(),
|
||||
sa.ForeignKey("world_rooms.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column("chunk_key", sa.String(160), nullable=False, unique=True),
|
||||
sa.Column("cx", sa.Integer(), nullable=False),
|
||||
sa.Column("cy", sa.Integer(), nullable=False),
|
||||
sa.Column("cz", sa.Integer(), nullable=False, server_default="0"),
|
||||
sa.Column("format_version", sa.Integer(), nullable=False, server_default="1"),
|
||||
sa.Column("payload", sa.LargeBinary(), nullable=False),
|
||||
sa.Column("payload_len", sa.Integer(), nullable=False),
|
||||
sa.Column("checksum", sa.String(64), nullable=False),
|
||||
sa.Column("revision", sa.Integer(), nullable=False, server_default="1"),
|
||||
sa.Column("content_flags", postgresql.JSONB(), nullable=False, server_default="{}"),
|
||||
sa.Column("is_mature", sa.Boolean(), nullable=False, server_default="false"),
|
||||
sa.Column(
|
||||
"updated_by_id", sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="SET NULL"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=False),
|
||||
sa.Column(
|
||||
"updated_at", sa.DateTime(timezone=True),
|
||||
server_default=sa.func.now(), nullable=False,
|
||||
),
|
||||
sa.UniqueConstraint("room_id", "cx", "cy", "cz", name="uq_world_chunks_coord"),
|
||||
)
|
||||
op.create_index("ix_world_chunks_world_id", "world_chunks", ["world_id"])
|
||||
op.create_index("ix_world_chunks_room_id", "world_chunks", ["room_id"])
|
||||
op.create_index(
|
||||
"ix_world_chunks_room_coord", "world_chunks", ["room_id", "cx", "cy", "cz"],
|
||||
)
|
||||
op.create_index(
|
||||
"ix_world_chunks_mature", "world_chunks", ["world_id"],
|
||||
postgresql_where=sa.text("is_mature"),
|
||||
)
|
||||
|
||||
op.create_table(
|
||||
"world_chunk_revisions",
|
||||
sa.Column("id", sa.Integer(), primary_key=True, index=True),
|
||||
sa.Column("chunk_key", sa.String(160), nullable=False),
|
||||
sa.Column("world_id", sa.Integer(), nullable=False),
|
||||
sa.Column("revision", sa.Integer(), nullable=False),
|
||||
sa.Column("action", sa.String(16), nullable=False),
|
||||
sa.Column(
|
||||
"actor_id", sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="SET NULL"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column("checksum", sa.String(64), nullable=False),
|
||||
sa.Column("payload", sa.LargeBinary(), nullable=True),
|
||||
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=False),
|
||||
)
|
||||
op.create_index("ix_world_chunk_revisions_chunk_key", "world_chunk_revisions", ["chunk_key"])
|
||||
op.create_index("ix_world_chunk_revisions_world_id", "world_chunk_revisions", ["world_id"])
|
||||
op.create_index("ix_world_chunk_revisions_created_at", "world_chunk_revisions", ["created_at"])
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
op.drop_table("world_chunk_revisions")
|
||||
op.drop_table("world_chunks")
|
||||
op.drop_table("world_rooms")
|
||||
@@ -104,6 +104,22 @@ class Settings(BaseSettings):
|
||||
# Kill a world's server this long after its last join with no active
|
||||
# players reported.
|
||||
GAME_SERVER_IDLE_TIMEOUT_SECONDS: int = 300
|
||||
# How long ensure_server() waits for a spawned server to report
|
||||
# "ready": true in its status file before giving up (503 to the
|
||||
# joining client). See world_persistence_impl.md §7.4 -- content
|
||||
# loading makes a slow start more likely than the old bare-port-bind
|
||||
# wait, so this is a separate, longer-by-default budget.
|
||||
GAME_SERVER_READY_TIMEOUT_SECONDS: float = 20.0
|
||||
# The base URL the dedicated Godot server should call back into this
|
||||
# backend on, for the read-only /api/internal content routes
|
||||
# (world_persistence_impl.md §4.4 / §7).
|
||||
GAME_SERVER_INTERNAL_API_URL: str = "http://127.0.0.1:8000"
|
||||
|
||||
# ── World content persistence (world_persistence_impl.md §4.4) ─────────
|
||||
WORLD_CHUNK_MAX_PAYLOAD_BYTES: int = 1_048_576 # 1 MiB
|
||||
WORLD_CHUNK_MAX_OBJECTS: int = 512
|
||||
WORLD_CHUNK_MAX_BATCH: int = 64
|
||||
WORLD_CHUNK_REVISION_KEEP: int = 20
|
||||
|
||||
model_config = SettingsConfigDict(
|
||||
env_file=".env",
|
||||
|
||||
+3
-1
@@ -6,7 +6,7 @@ from fastapi import FastAPI
|
||||
from fastapi.middleware.cors import CORSMiddleware
|
||||
|
||||
from app.config import settings
|
||||
from app.routers import auth, users, worlds, assets, avatar
|
||||
from app.routers import auth, users, worlds, assets, avatar, world_content, internal
|
||||
|
||||
|
||||
from app.services.game_servers import supervisor
|
||||
@@ -40,8 +40,10 @@ app.add_middleware(
|
||||
app.include_router(auth.router, prefix="/api/auth", tags=["auth"])
|
||||
app.include_router(users.router, prefix="/api/users", tags=["users"])
|
||||
app.include_router(worlds.router, prefix="/api/worlds", tags=["worlds"])
|
||||
app.include_router(world_content.router, prefix="/api/worlds", tags=["world-content"])
|
||||
app.include_router(assets.router, prefix="/api/assets", tags=["assets"])
|
||||
app.include_router(avatar.router, prefix="/api/avatar", tags=["avatar"])
|
||||
app.include_router(internal.router, prefix="/api/internal", tags=["internal"])
|
||||
|
||||
|
||||
@app.get("/api/health")
|
||||
|
||||
@@ -3,5 +3,9 @@ from app.models.session import Session
|
||||
from app.models.world import World
|
||||
from app.models.asset import Asset
|
||||
from app.models.avatar_loadout import AvatarLoadout
|
||||
from app.models.world_content import WorldRoom, WorldChunk, WorldChunkRevision
|
||||
|
||||
__all__ = ["User", "Session", "World", "Asset", "AvatarLoadout"]
|
||||
__all__ = [
|
||||
"User", "Session", "World", "Asset", "AvatarLoadout",
|
||||
"WorldRoom", "WorldChunk", "WorldChunkRevision",
|
||||
]
|
||||
|
||||
@@ -34,3 +34,6 @@ class World(Base):
|
||||
|
||||
owner = relationship("User", back_populates="worlds")
|
||||
assets = relationship("Asset", back_populates="world", cascade="all, delete-orphan")
|
||||
# world_content.py / world_persistence_impl.md §4.1. Added here (only)
|
||||
# so PC1/PC2 code depending on this module is otherwise untouched.
|
||||
rooms = relationship("WorldRoom", back_populates="world", cascade="all, delete-orphan")
|
||||
|
||||
@@ -0,0 +1,153 @@
|
||||
"""World content persistence models.
|
||||
|
||||
Implements the schema decided in ``docs/architecture/world_persistence_impl.md``
|
||||
§4: chunk content (rooms, chunk payloads, chunk revisions) lives in Postgres,
|
||||
alongside ``worlds``, rather than in a per-world SQLite file
|
||||
(``docs/architecture/world.md`` §4, superseded).
|
||||
|
||||
The chunk *payload* format itself (the 48-byte header + sectioned binary
|
||||
body) is unchanged from ``world.md`` §3.6 and is decoded/encoded by
|
||||
``app.services.chunk_codec``, not by these models -- these just store the
|
||||
opaque ``BYTEA``.
|
||||
|
||||
Conventions follow the existing models (``app/models/world.py``,
|
||||
``app/models/avatar_loadout.py``): declarative ``Column(...)`` style,
|
||||
``Integer`` surrogate PKs, ``DateTime(timezone=True)`` with
|
||||
``server_default=func.now()``, JSONB for document-shaped fields.
|
||||
"""
|
||||
|
||||
from sqlalchemy import (
|
||||
Boolean,
|
||||
Column,
|
||||
DateTime,
|
||||
ForeignKey,
|
||||
Index,
|
||||
Integer,
|
||||
LargeBinary,
|
||||
String,
|
||||
UniqueConstraint,
|
||||
text,
|
||||
)
|
||||
from sqlalchemy.dialects.postgresql import JSONB
|
||||
from sqlalchemy.orm import relationship
|
||||
from sqlalchemy.sql import func
|
||||
|
||||
from app.database import Base
|
||||
|
||||
# Default chunk grid, matching Chunk.CHUNK_SIZE_* in scripts/chunk.gd (the
|
||||
# client's source of truth for the same constants) and world.md §2.2.
|
||||
DEFAULT_ROOM_GRID: dict = {"size": [32, 32, 1], "origin": [0, 0, 0]}
|
||||
|
||||
# The room every world gets automatically (world_persistence_impl.md §4.1).
|
||||
MAIN_ROOM_SLUG = "main"
|
||||
MAIN_ROOM_NAME = "Main"
|
||||
|
||||
|
||||
class WorldRoom(Base):
|
||||
"""A bounded region within a world -- a level, building, or zone
|
||||
(world.md §2.1). Holds the chunk grid config so a world can later hold
|
||||
rooms with different grids without touching the ``worlds`` table.
|
||||
"""
|
||||
|
||||
__tablename__ = "world_rooms"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
world_id = Column(
|
||||
Integer, ForeignKey("worlds.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
slug = Column(String(64), nullable=False) # url-safe; "main" by default
|
||||
name = Column(String(255), nullable=False)
|
||||
# {"size": [x, y, z], "origin": [x, y, z]}
|
||||
grid = Column(
|
||||
JSONB, nullable=False,
|
||||
server_default='{"size": [32, 32, 1], "origin": [0, 0, 0]}',
|
||||
)
|
||||
bounds = Column(JSONB, nullable=True) # {"min":[x,y,z], "max":[x,y,z]}; null = unbounded
|
||||
spawn = Column(JSONB, nullable=True) # {"pos":[x,y,z], "yaw": 0.0}
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
updated_at = Column(
|
||||
DateTime(timezone=True), server_default=func.now(), onupdate=func.now(), nullable=False
|
||||
)
|
||||
|
||||
__table_args__ = (
|
||||
UniqueConstraint("world_id", "slug", name="uq_world_rooms_world_slug"),
|
||||
)
|
||||
|
||||
world = relationship("World", back_populates="rooms")
|
||||
chunks = relationship("WorldChunk", back_populates="room", cascade="all, delete-orphan")
|
||||
|
||||
|
||||
class WorldChunk(Base):
|
||||
"""One chunk's persisted content -- the atomic load/save/stream unit
|
||||
(world.md §2.1). ``payload`` is the world.md §3.6 binary blob, stored
|
||||
verbatim as BYTEA.
|
||||
|
||||
Deltas from world.md §4.4 (SQLite design): a surrogate integer PK +
|
||||
unique coordinate constraint (rather than ``chunk_key`` as the PK), no
|
||||
``dirty`` column (write-behind doesn't apply over Postgres -- see
|
||||
world_persistence_impl.md §3.3/§5), and content flags folded into this
|
||||
row as JSONB + an indexed ``is_mature`` boolean rather than a separate
|
||||
``content_flags`` table (world.md §4.6).
|
||||
"""
|
||||
|
||||
__tablename__ = "world_chunks"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
world_id = Column(
|
||||
Integer, ForeignKey("worlds.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
) # denormalized: world-scoped queries without a join through rooms
|
||||
room_id = Column(
|
||||
Integer, ForeignKey("world_rooms.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
chunk_key = Column(String(160), nullable=False, unique=True) # world.md §2.3 / §4.5
|
||||
cx = Column(Integer, nullable=False)
|
||||
cy = Column(Integer, nullable=False)
|
||||
cz = Column(Integer, nullable=False, server_default="0")
|
||||
|
||||
format_version = Column(Integer, nullable=False, server_default="1")
|
||||
payload = Column(LargeBinary, nullable=False) # world.md §3.6 bytes
|
||||
payload_len = Column(Integer, nullable=False)
|
||||
checksum = Column(String(64), nullable=False) # SHA-256 hex of payload body
|
||||
revision = Column(Integer, nullable=False, server_default="1")
|
||||
|
||||
content_flags = Column(JSONB, nullable=False, server_default="{}") # world.md §3.4
|
||||
is_mature = Column(Boolean, nullable=False, server_default="false")
|
||||
|
||||
updated_by_id = Column(Integer, ForeignKey("users.id", ondelete="SET NULL"), nullable=True)
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
updated_at = Column(
|
||||
DateTime(timezone=True), server_default=func.now(), onupdate=func.now(), nullable=False
|
||||
)
|
||||
|
||||
__table_args__ = (
|
||||
UniqueConstraint("room_id", "cx", "cy", "cz", name="uq_world_chunks_coord"),
|
||||
Index("ix_world_chunks_room_coord", "room_id", "cx", "cy", "cz"),
|
||||
Index("ix_world_chunks_mature", "world_id", postgresql_where=text("is_mature")),
|
||||
)
|
||||
|
||||
room = relationship("WorldRoom", back_populates="chunks")
|
||||
|
||||
|
||||
class WorldChunkRevision(Base):
|
||||
"""Audit trail of chunk writes (world.md §4.7). ``chunk_key``/``world_id``
|
||||
are deliberately **not** foreign keys, so deleting a chunk or a world
|
||||
preserves the audit trail.
|
||||
|
||||
Retention (world_persistence_impl.md §4.3, required): only the newest
|
||||
``settings.WORLD_CHUNK_REVISION_KEEP`` rows per ``chunk_key`` keep a
|
||||
non-null ``payload``; older rows are pruned (payload nulled, metadata
|
||||
row kept) by ``WorldStore`` in the same transaction as the write that
|
||||
triggers it.
|
||||
"""
|
||||
|
||||
__tablename__ = "world_chunk_revisions"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
chunk_key = Column(String(160), nullable=False, index=True)
|
||||
world_id = Column(Integer, nullable=False, index=True)
|
||||
revision = Column(Integer, nullable=False)
|
||||
action = Column(String(16), nullable=False) # 'create' | 'update' | 'delete'
|
||||
actor_id = Column(Integer, ForeignKey("users.id", ondelete="SET NULL"), nullable=True)
|
||||
checksum = Column(String(64), nullable=False)
|
||||
payload = Column(LargeBinary, nullable=True) # full payload at this revision; nulled by retention
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False, index=True)
|
||||
@@ -0,0 +1,146 @@
|
||||
"""Internal, dedicated-server-only content API.
|
||||
|
||||
Implements `docs/architecture/world_persistence_impl.md` §7 + §8.3. This is
|
||||
how a spawned Godot dedicated server (`scripts/server.gd`, spawned by
|
||||
`app.services.game_servers`) pulls its world's content read-only over HTTP
|
||||
before binding its ENet port. Mounted at ``/api/internal`` -- a prefix that
|
||||
can also be blocked at the reverse proxy, per the doc's rejected-alternative
|
||||
note in §7.3.
|
||||
|
||||
Gated by ``require_game_server`` (§7.3): a bearer token minted per spawn by
|
||||
``GameServerSupervisor._spawn`` and checked against
|
||||
``supervisor.validate_token(world_id, token)``. There is no user identity
|
||||
here at all -- these routes skip the per-user visibility check public
|
||||
routes apply, and apply no mature-content gating (gating is a client/user
|
||||
concern; the dedicated server still needs the geometry for collision).
|
||||
|
||||
Read-only by construction: there is no write route here, and adding one
|
||||
would violate world_persistence_impl.md D2 (the FastAPI backend is the
|
||||
only writer).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Annotated
|
||||
|
||||
from fastapi import APIRouter, Depends, Header, HTTPException, Response
|
||||
from sqlalchemy import select
|
||||
from sqlalchemy.ext.asyncio import AsyncSession
|
||||
|
||||
from app.database import get_db
|
||||
from app.models.world import World
|
||||
from app.models.world_content import MAIN_ROOM_SLUG
|
||||
from app.services import chunk_codec
|
||||
from app.services.game_servers import supervisor
|
||||
from app.services.world_store import Bounds, WorldStore
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
DbDep = Annotated[AsyncSession, Depends(get_db)]
|
||||
|
||||
|
||||
async def require_game_server(
|
||||
world_id: int,
|
||||
authorization: Annotated[str | None, Header()] = None,
|
||||
) -> None:
|
||||
"""world_persistence_impl.md §7.3. A path whose ``world_id`` differs
|
||||
from the token's world is 403 -- ``validate_token`` enforces that by
|
||||
construction (it looks the token up *by* ``world_id``)."""
|
||||
if not authorization or not authorization.lower().startswith("bearer "):
|
||||
raise HTTPException(status_code=401, detail="missing bearer token")
|
||||
token = authorization.split(" ", 1)[1].strip()
|
||||
if not token or not supervisor.validate_token(world_id, token):
|
||||
raise HTTPException(status_code=403, detail="invalid or expired server token")
|
||||
|
||||
|
||||
async def _get_world_or_404(world_id: int, db: AsyncSession) -> World:
|
||||
result = await db.execute(select(World).where(World.id == world_id))
|
||||
world = result.scalar_one_or_none()
|
||||
if world is None:
|
||||
raise HTTPException(status_code=404, detail="World not found")
|
||||
return world
|
||||
|
||||
|
||||
async def _resolve_room(store: WorldStore, db: AsyncSession, world_id: int, slug: str):
|
||||
room = await store.get_room(world_id, slug)
|
||||
if room is None and slug == MAIN_ROOM_SLUG:
|
||||
room = await store.get_or_create_main_room(world_id)
|
||||
await db.commit()
|
||||
return room
|
||||
|
||||
|
||||
@router.get("/worlds/{world_id}/manifest", dependencies=[Depends(require_game_server)])
|
||||
async def manifest(world_id: int, db: DbDep):
|
||||
await _get_world_or_404(world_id, db)
|
||||
store = WorldStore(db)
|
||||
rooms = await store.list_rooms(world_id)
|
||||
if not rooms:
|
||||
rooms = [await store.get_or_create_main_room(world_id)]
|
||||
await db.commit()
|
||||
|
||||
room_payloads = []
|
||||
for r in rooms:
|
||||
room_payloads.append({
|
||||
"slug": r.slug, "name": r.name, "grid": r.grid, "bounds": r.bounds,
|
||||
"spawn": r.spawn, "chunk_count": await store.count_chunks(r.id),
|
||||
})
|
||||
|
||||
return {
|
||||
"world_id": world_id,
|
||||
"content_revision": await store.content_revision(world_id),
|
||||
"rooms": room_payloads,
|
||||
}
|
||||
|
||||
|
||||
@router.get("/worlds/{world_id}/rooms/{slug}/chunks", dependencies=[Depends(require_game_server)])
|
||||
async def internal_list_chunks(
|
||||
world_id: int, slug: str, db: DbDep,
|
||||
cx_min: int | None = None, cx_max: int | None = None,
|
||||
cy_min: int | None = None, cy_max: int | None = None,
|
||||
cz: int | None = None,
|
||||
):
|
||||
await _get_world_or_404(world_id, db)
|
||||
store = WorldStore(db)
|
||||
room = await _resolve_room(store, db, world_id, slug)
|
||||
if room is None:
|
||||
raise HTTPException(status_code=404, detail="room not found")
|
||||
|
||||
bounds = Bounds(cx_min=cx_min, cx_max=cx_max, cy_min=cy_min, cy_max=cy_max, cz=cz)
|
||||
chunks = await store.list_chunks(world_id, room.id, bounds)
|
||||
return {
|
||||
"room": room.slug,
|
||||
"content_revision": await store.content_revision(world_id),
|
||||
"chunks": [
|
||||
{
|
||||
"key": c.chunk_key, "cx": c.cx, "cy": c.cy, "cz": c.cz,
|
||||
"revision": c.revision, "checksum": c.checksum, "payload_len": c.payload_len,
|
||||
"is_mature": c.is_mature,
|
||||
"updated_at": c.updated_at.isoformat() if c.updated_at else None,
|
||||
}
|
||||
for c in chunks
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
@router.get(
|
||||
"/worlds/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}",
|
||||
dependencies=[Depends(require_game_server)],
|
||||
)
|
||||
async def internal_get_chunk(world_id: int, slug: str, cx: int, cy: int, cz: int, db: DbDep):
|
||||
await _get_world_or_404(world_id, db)
|
||||
store = WorldStore(db)
|
||||
room = await _resolve_room(store, db, world_id, slug)
|
||||
if room is None:
|
||||
raise HTTPException(status_code=404, detail="room not found")
|
||||
|
||||
key = chunk_codec.build_key(world_id, slug, cx, cy, cz)
|
||||
chunk = await store.get_chunk(key)
|
||||
if chunk is None:
|
||||
raise HTTPException(status_code=404, detail="chunk not found")
|
||||
|
||||
return Response(
|
||||
content=chunk.payload, media_type="application/octet-stream",
|
||||
headers={
|
||||
"ETag": f'"{chunk.checksum}"', "X-Chunk-Revision": str(chunk.revision), "X-Chunk-Key": key,
|
||||
},
|
||||
)
|
||||
@@ -0,0 +1,451 @@
|
||||
"""World content router -- rooms + chunks, for the editor and player client.
|
||||
|
||||
Implements `docs/architecture/world_persistence_impl.md` §8.1. JWT-authenticated
|
||||
(``CurrentUser``, same as ``app/routers/worlds.py``). All chunk content
|
||||
reads/writes go through ``WorldStore``; this module is HTTP plumbing +
|
||||
authorization only.
|
||||
|
||||
Authorization (doc §5.3):
|
||||
- **Read** (world visibility, room listing, chunk fetch/index/revisions):
|
||||
same rule as ``GET /api/worlds/{id}`` -- 404 (not 403) if the world is
|
||||
neither PUBLIC nor owned by the caller. See ``_get_world_readable``.
|
||||
- **Write** (room create, chunk PUT/DELETE/rollback): caller must be
|
||||
``world.owner_id``, matching ``update_world`` -- 403 otherwise, with
|
||||
*no* visibility gate (this deliberately mirrors ``update_world``, which
|
||||
also has no visibility check; see ``_get_world_writable``).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import base64
|
||||
import binascii
|
||||
from typing import Annotated
|
||||
|
||||
from fastapi import APIRouter, Depends, Header, HTTPException, Request, Response
|
||||
from fastapi.responses import JSONResponse
|
||||
from pydantic import BaseModel, Field
|
||||
from sqlalchemy import select
|
||||
from sqlalchemy.ext.asyncio import AsyncSession
|
||||
|
||||
from app.config import settings
|
||||
from app.database import get_db
|
||||
from app.dependencies import CurrentUser
|
||||
from app.models.user import User
|
||||
from app.models.world import World, WorldVisibility
|
||||
from app.models.world_content import MAIN_ROOM_SLUG, WorldRoom
|
||||
from app.services import chunk_codec
|
||||
from app.services.game_servers import supervisor
|
||||
from app.services.world_store import Bounds, RevisionConflict, RevisionNotAvailable, WorldStore
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
DbDep = Annotated[AsyncSession, Depends(get_db)]
|
||||
|
||||
# world_persistence_impl.md §8.1: "Bounds are capped (default 32x32 chunks
|
||||
# per query) and return 422 beyond that."
|
||||
MAX_BOUNDS_SPAN = 32
|
||||
# §8.1 batch write cap, beyond WORLD_CHUNK_MAX_BATCH chunks: "Capped at ...
|
||||
# 8 MB."
|
||||
MAX_BATCH_TOTAL_BYTES = 8 * 1024 * 1024
|
||||
|
||||
|
||||
# ─────────────────────────── auth helpers ───────────────────────────
|
||||
|
||||
async def _get_world_readable(world_id: int, current_user: User, db: AsyncSession) -> World:
|
||||
result = await db.execute(select(World).where(World.id == world_id))
|
||||
world = result.scalar_one_or_none()
|
||||
if world is None:
|
||||
raise HTTPException(status_code=404, detail="World not found")
|
||||
if world.visibility != WorldVisibility.PUBLIC and world.owner_id != current_user.id:
|
||||
raise HTTPException(status_code=404, detail="World not found")
|
||||
return world
|
||||
|
||||
|
||||
async def _get_world_writable(world_id: int, current_user: User, db: AsyncSession) -> World:
|
||||
result = await db.execute(select(World).where(World.id == world_id))
|
||||
world = result.scalar_one_or_none()
|
||||
if world is None:
|
||||
raise HTTPException(status_code=404, detail="World not found")
|
||||
if world.owner_id != current_user.id:
|
||||
raise HTTPException(status_code=403, detail="Not owner of this world")
|
||||
return world
|
||||
|
||||
|
||||
async def _resolve_room(store: WorldStore, db: AsyncSession, world_id: int, slug: str) -> WorldRoom | None:
|
||||
"""world_persistence_impl.md §4.1: lazily create the main room for
|
||||
worlds that predate this feature, on first read/write."""
|
||||
room = await store.get_room(world_id, slug)
|
||||
if room is None and slug == MAIN_ROOM_SLUG:
|
||||
room = await store.get_or_create_main_room(world_id)
|
||||
await db.commit()
|
||||
return room
|
||||
|
||||
|
||||
def _is_live(world_id: int) -> bool:
|
||||
return any(s["world_id"] == str(world_id) for s in supervisor.debug_state())
|
||||
|
||||
|
||||
def _validation_error_body(exc: chunk_codec.ChunkValidationError) -> dict:
|
||||
return {"detail": "chunk validation failed", "reason": exc.reason}
|
||||
|
||||
|
||||
def _conflict_body(exc: RevisionConflict) -> dict:
|
||||
body: dict = {
|
||||
"detail": "revision conflict",
|
||||
"current_revision": exc.current_revision,
|
||||
"current_checksum": exc.current_checksum,
|
||||
}
|
||||
if exc.coord is not None:
|
||||
body["coord"] = list(exc.coord)
|
||||
return body
|
||||
|
||||
|
||||
# ─────────────────────────── schemas ───────────────────────────
|
||||
|
||||
class RoomResponse(BaseModel):
|
||||
id: int
|
||||
slug: str
|
||||
name: str
|
||||
grid: dict
|
||||
bounds: dict | None
|
||||
spawn: dict | None
|
||||
chunk_count: int
|
||||
|
||||
|
||||
class RoomCreate(BaseModel):
|
||||
slug: str = Field(..., min_length=1, max_length=64, pattern=r"^[a-z0-9_-]+$")
|
||||
name: str = Field(..., min_length=1, max_length=255)
|
||||
grid: dict | None = None
|
||||
bounds: dict | None = None
|
||||
spawn: dict | None = None
|
||||
|
||||
|
||||
# ─────────────────────────── rooms ───────────────────────────
|
||||
|
||||
@router.get("/{world_id}/rooms", response_model=list[RoomResponse])
|
||||
async def list_rooms(world_id: int, current_user: CurrentUser, db: DbDep):
|
||||
await _get_world_readable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
rooms = await store.list_rooms(world_id)
|
||||
if not rooms:
|
||||
rooms = [await store.get_or_create_main_room(world_id)]
|
||||
await db.commit()
|
||||
return [
|
||||
RoomResponse(
|
||||
id=r.id, slug=r.slug, name=r.name, grid=r.grid, bounds=r.bounds, spawn=r.spawn,
|
||||
chunk_count=await store.count_chunks(r.id),
|
||||
)
|
||||
for r in rooms
|
||||
]
|
||||
|
||||
|
||||
@router.post("/{world_id}/rooms", response_model=RoomResponse, status_code=201)
|
||||
async def create_room(world_id: int, body: RoomCreate, current_user: CurrentUser, db: DbDep):
|
||||
await _get_world_writable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
if await store.get_room(world_id, body.slug) is not None:
|
||||
raise HTTPException(status_code=409, detail="a room with this slug already exists")
|
||||
room = await store.create_room(
|
||||
world_id, body.slug, body.name, grid=body.grid, bounds=body.bounds, spawn=body.spawn
|
||||
)
|
||||
await db.commit()
|
||||
await db.refresh(room)
|
||||
return RoomResponse(
|
||||
id=room.id, slug=room.slug, name=room.name, grid=room.grid,
|
||||
bounds=room.bounds, spawn=room.spawn, chunk_count=0,
|
||||
)
|
||||
|
||||
|
||||
# ─────────────────────────── chunk index ───────────────────────────
|
||||
|
||||
@router.get("/{world_id}/rooms/{slug}/chunks")
|
||||
async def list_chunks(
|
||||
world_id: int, slug: str, current_user: CurrentUser, db: DbDep,
|
||||
cx_min: int | None = None, cx_max: int | None = None,
|
||||
cy_min: int | None = None, cy_max: int | None = None,
|
||||
cz: int | None = None,
|
||||
):
|
||||
await _get_world_readable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
room = await _resolve_room(store, db, world_id, slug)
|
||||
if room is None:
|
||||
raise HTTPException(status_code=404, detail="room not found")
|
||||
|
||||
if cx_min is not None and cx_max is not None and (cx_max - cx_min + 1) > MAX_BOUNDS_SPAN:
|
||||
raise HTTPException(status_code=422, detail=f"cx bounds span exceeds {MAX_BOUNDS_SPAN}")
|
||||
if cy_min is not None and cy_max is not None and (cy_max - cy_min + 1) > MAX_BOUNDS_SPAN:
|
||||
raise HTTPException(status_code=422, detail=f"cy bounds span exceeds {MAX_BOUNDS_SPAN}")
|
||||
|
||||
bounds = Bounds(cx_min=cx_min, cx_max=cx_max, cy_min=cy_min, cy_max=cy_max, cz=cz)
|
||||
chunks = await store.list_chunks(world_id, room.id, bounds)
|
||||
content_revision = await store.content_revision(world_id)
|
||||
return {
|
||||
"room": room.slug,
|
||||
"content_revision": content_revision,
|
||||
"chunks": [
|
||||
{
|
||||
"key": c.chunk_key, "cx": c.cx, "cy": c.cy, "cz": c.cz,
|
||||
"revision": c.revision, "checksum": c.checksum, "payload_len": c.payload_len,
|
||||
"is_mature": c.is_mature,
|
||||
"updated_at": c.updated_at.isoformat() if c.updated_at else None,
|
||||
}
|
||||
for c in chunks
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
# ─────────────────────────── chunk fetch ───────────────────────────
|
||||
|
||||
@router.get("/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}")
|
||||
async def get_chunk(
|
||||
world_id: int, slug: str, cx: int, cy: int, cz: int,
|
||||
current_user: CurrentUser, db: DbDep,
|
||||
accept: Annotated[str | None, Header()] = None,
|
||||
if_none_match: Annotated[str | None, Header(alias="If-None-Match")] = None,
|
||||
):
|
||||
await _get_world_readable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
room = await _resolve_room(store, db, world_id, slug)
|
||||
if room is None:
|
||||
raise HTTPException(status_code=404, detail="room not found")
|
||||
|
||||
key = chunk_codec.build_key(world_id, slug, cx, cy, cz)
|
||||
chunk = await store.get_chunk(key)
|
||||
if chunk is None:
|
||||
raise HTTPException(status_code=404, detail="chunk not found")
|
||||
|
||||
etag = f'"{chunk.checksum}"'
|
||||
headers = {"ETag": etag, "X-Chunk-Revision": str(chunk.revision), "X-Chunk-Key": key}
|
||||
|
||||
if if_none_match is not None and if_none_match.strip('"') == chunk.checksum:
|
||||
return Response(status_code=304, headers=headers)
|
||||
|
||||
wants_json = (
|
||||
accept is not None
|
||||
and "application/json" in accept
|
||||
and "application/octet-stream" not in accept
|
||||
)
|
||||
if wants_json:
|
||||
decoded = chunk_codec.decode_binary(chunk.payload)
|
||||
body = chunk_codec.to_json_dict(decoded, key=key, chunk_checksum=chunk.checksum)
|
||||
return JSONResponse(content=body, headers=headers)
|
||||
|
||||
return Response(content=chunk.payload, media_type="application/octet-stream", headers=headers)
|
||||
|
||||
|
||||
# ─────────────────────────── chunk write ───────────────────────────
|
||||
|
||||
async def _read_write_payload(request: Request, x_base_revision: int | None) -> tuple[bytes, int]:
|
||||
content_type = request.headers.get("content-type", "")
|
||||
if "application/json" in content_type:
|
||||
body = await request.json()
|
||||
try:
|
||||
payload_bytes = base64.b64decode(body["payload_b64"], validate=True)
|
||||
except (KeyError, binascii.Error, ValueError) as exc:
|
||||
raise HTTPException(status_code=422, detail=f"invalid payload_b64: {exc}")
|
||||
base_revision = int(body.get("base_revision", 0))
|
||||
return payload_bytes, base_revision
|
||||
payload_bytes = await request.body()
|
||||
return payload_bytes, (x_base_revision if x_base_revision is not None else 0)
|
||||
|
||||
|
||||
@router.put("/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}")
|
||||
async def put_chunk(
|
||||
world_id: int, slug: str, cx: int, cy: int, cz: int,
|
||||
request: Request, current_user: CurrentUser, db: DbDep,
|
||||
x_base_revision: Annotated[int | None, Header(alias="X-Base-Revision")] = None,
|
||||
):
|
||||
await _get_world_writable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
room = await _resolve_room(store, db, world_id, slug)
|
||||
if room is None:
|
||||
raise HTTPException(status_code=404, detail="room not found")
|
||||
|
||||
payload_bytes, base_revision = await _read_write_payload(request, x_base_revision)
|
||||
if len(payload_bytes) > settings.WORLD_CHUNK_MAX_PAYLOAD_BYTES:
|
||||
raise HTTPException(
|
||||
status_code=413,
|
||||
detail=f"payload exceeds WORLD_CHUNK_MAX_PAYLOAD_BYTES ({settings.WORLD_CHUNK_MAX_PAYLOAD_BYTES})",
|
||||
)
|
||||
|
||||
try:
|
||||
chunk = await store.put_chunk(
|
||||
room=room, cx=cx, cy=cy, cz=cz, payload_bytes=payload_bytes,
|
||||
base_revision=base_revision, actor_id=current_user.id,
|
||||
)
|
||||
except chunk_codec.ChunkCodecError as exc:
|
||||
await db.rollback()
|
||||
return JSONResponse(status_code=422, content={"detail": "chunk decode failed", "reason": "malformed", "message": str(exc)})
|
||||
except chunk_codec.ChunkValidationError as exc:
|
||||
await db.rollback()
|
||||
return JSONResponse(status_code=422, content=_validation_error_body(exc))
|
||||
except RevisionConflict as exc:
|
||||
# Nothing must stick from a failed write. Returning a JSONResponse
|
||||
# here (rather than raising) means no exception propagates through
|
||||
# `get_db`, so this rollback has to be explicit -- see the note on
|
||||
# the batch endpoint below, where this is load-bearing for
|
||||
# all-or-nothing semantics.
|
||||
await db.rollback()
|
||||
return JSONResponse(status_code=409, content=_conflict_body(exc))
|
||||
|
||||
await db.commit()
|
||||
await db.refresh(chunk)
|
||||
|
||||
return {
|
||||
"key": chunk.chunk_key, "revision": chunk.revision, "checksum": chunk.checksum,
|
||||
"payload_len": chunk.payload_len,
|
||||
"updated_at": chunk.updated_at.isoformat() if chunk.updated_at else None,
|
||||
"is_mature": chunk.is_mature, "live_session": _is_live(world_id),
|
||||
}
|
||||
|
||||
|
||||
# ─────────────────────────── batch write ───────────────────────────
|
||||
|
||||
class BatchChunkItem(BaseModel):
|
||||
cx: int
|
||||
cy: int
|
||||
cz: int
|
||||
base_revision: int
|
||||
payload_b64: str
|
||||
|
||||
|
||||
class BatchPutRequest(BaseModel):
|
||||
chunks: list[BatchChunkItem]
|
||||
|
||||
|
||||
@router.put("/{world_id}/rooms/{slug}/chunks")
|
||||
async def put_chunks_batch(
|
||||
world_id: int, slug: str, body: BatchPutRequest, current_user: CurrentUser, db: DbDep,
|
||||
):
|
||||
await _get_world_writable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
room = await _resolve_room(store, db, world_id, slug)
|
||||
if room is None:
|
||||
raise HTTPException(status_code=404, detail="room not found")
|
||||
|
||||
if len(body.chunks) > settings.WORLD_CHUNK_MAX_BATCH:
|
||||
raise HTTPException(
|
||||
status_code=422,
|
||||
detail=f"batch of {len(body.chunks)} exceeds WORLD_CHUNK_MAX_BATCH ({settings.WORLD_CHUNK_MAX_BATCH})",
|
||||
)
|
||||
|
||||
items = []
|
||||
total_bytes = 0
|
||||
for item in body.chunks:
|
||||
try:
|
||||
payload_bytes = base64.b64decode(item.payload_b64, validate=True)
|
||||
except (binascii.Error, ValueError) as exc:
|
||||
raise HTTPException(status_code=422, detail=f"invalid payload_b64 for ({item.cx},{item.cy},{item.cz}): {exc}")
|
||||
total_bytes += len(payload_bytes)
|
||||
items.append({
|
||||
"cx": item.cx, "cy": item.cy, "cz": item.cz,
|
||||
"base_revision": item.base_revision, "payload_bytes": payload_bytes,
|
||||
})
|
||||
|
||||
if total_bytes > MAX_BATCH_TOTAL_BYTES:
|
||||
raise HTTPException(status_code=413, detail=f"batch exceeds {MAX_BATCH_TOTAL_BYTES} bytes")
|
||||
|
||||
try:
|
||||
rows = await store.put_chunks_batch(room=room, items=items, actor_id=current_user.id)
|
||||
except chunk_codec.ChunkCodecError as exc:
|
||||
# All-or-nothing (world_persistence_impl.md §8.1): earlier items in
|
||||
# this batch may already be flushed (but never committed) to this
|
||||
# transaction. Rolling back here is what actually makes the batch
|
||||
# atomic -- without it, returning a JSONResponse instead of raising
|
||||
# means no exception reaches `get_db`, and its own transaction
|
||||
# handling would otherwise commit those earlier writes anyway.
|
||||
await db.rollback()
|
||||
return JSONResponse(status_code=422, content={"detail": "chunk decode failed", "reason": "malformed", "message": str(exc)})
|
||||
except chunk_codec.ChunkValidationError as exc:
|
||||
await db.rollback()
|
||||
return JSONResponse(status_code=422, content=_validation_error_body(exc))
|
||||
except RevisionConflict as exc:
|
||||
await db.rollback()
|
||||
return JSONResponse(status_code=409, content=_conflict_body(exc))
|
||||
|
||||
await db.commit()
|
||||
for row in rows:
|
||||
await db.refresh(row)
|
||||
|
||||
return {
|
||||
"live_session": _is_live(world_id),
|
||||
"chunks": [
|
||||
{
|
||||
"key": r.chunk_key, "revision": r.revision, "checksum": r.checksum,
|
||||
"payload_len": r.payload_len,
|
||||
"updated_at": r.updated_at.isoformat() if r.updated_at else None,
|
||||
"is_mature": r.is_mature,
|
||||
}
|
||||
for r in rows
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
# ─────────────────────────── delete ───────────────────────────
|
||||
|
||||
@router.delete("/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}", status_code=204)
|
||||
async def delete_chunk(
|
||||
world_id: int, slug: str, cx: int, cy: int, cz: int, current_user: CurrentUser, db: DbDep,
|
||||
):
|
||||
await _get_world_writable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
room = await _resolve_room(store, db, world_id, slug)
|
||||
if room is None:
|
||||
raise HTTPException(status_code=404, detail="room not found")
|
||||
|
||||
key = chunk_codec.build_key(world_id, slug, cx, cy, cz)
|
||||
await store.delete_chunk(key, current_user.id)
|
||||
await db.commit()
|
||||
return Response(status_code=204)
|
||||
|
||||
|
||||
# ─────────────────────────── revisions + rollback ───────────────────────────
|
||||
|
||||
@router.get("/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}/revisions")
|
||||
async def chunk_revisions(
|
||||
world_id: int, slug: str, cx: int, cy: int, cz: int, current_user: CurrentUser, db: DbDep,
|
||||
):
|
||||
# doc: "(owner)" -- same gate as writes.
|
||||
await _get_world_writable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
key = chunk_codec.build_key(world_id, slug, cx, cy, cz)
|
||||
revisions = await store.list_revisions(key)
|
||||
return [
|
||||
{
|
||||
"revision": r.revision, "action": r.action, "actor_id": r.actor_id,
|
||||
"checksum": r.checksum, "payload_available": r.payload is not None,
|
||||
"created_at": r.created_at.isoformat() if r.created_at else None,
|
||||
}
|
||||
for r in revisions
|
||||
]
|
||||
|
||||
|
||||
class RollbackRequest(BaseModel):
|
||||
revision: int
|
||||
|
||||
|
||||
@router.post("/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}/rollback")
|
||||
async def rollback_chunk(
|
||||
world_id: int, slug: str, cx: int, cy: int, cz: int,
|
||||
body: RollbackRequest, current_user: CurrentUser, db: DbDep,
|
||||
):
|
||||
await _get_world_writable(world_id, current_user, db)
|
||||
store = WorldStore(db)
|
||||
key = chunk_codec.build_key(world_id, slug, cx, cy, cz)
|
||||
try:
|
||||
chunk = await store.rollback_chunk(key, body.revision, current_user.id)
|
||||
except RevisionNotAvailable as exc:
|
||||
await db.rollback()
|
||||
return JSONResponse(status_code=404, content={"detail": str(exc)})
|
||||
except chunk_codec.ChunkValidationError as exc:
|
||||
await db.rollback()
|
||||
return JSONResponse(status_code=422, content=_validation_error_body(exc))
|
||||
|
||||
await db.commit()
|
||||
await db.refresh(chunk)
|
||||
return {
|
||||
"key": chunk.chunk_key, "revision": chunk.revision, "checksum": chunk.checksum,
|
||||
"payload_len": chunk.payload_len,
|
||||
"updated_at": chunk.updated_at.isoformat() if chunk.updated_at else None,
|
||||
"is_mature": chunk.is_mature, "live_session": _is_live(world_id),
|
||||
}
|
||||
@@ -13,6 +13,7 @@ from app.database import get_db
|
||||
from app.dependencies import CurrentUser
|
||||
from app.models.world import World, WorldVisibility
|
||||
from app.services.game_servers import supervisor
|
||||
from app.services.world_store import WorldStore
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
@@ -147,7 +148,12 @@ async def create_world(
|
||||
current_user: CurrentUser,
|
||||
db: DbDep,
|
||||
):
|
||||
"""Create a new world."""
|
||||
"""Create a new world.
|
||||
|
||||
Also creates the world's "main" room (world_persistence_impl.md §4.1) --
|
||||
every world gets one so chunk content has somewhere to live from the
|
||||
start.
|
||||
"""
|
||||
world = World(
|
||||
name=world_data.name,
|
||||
description=world_data.description,
|
||||
@@ -155,6 +161,8 @@ async def create_world(
|
||||
visibility=world_data.visibility,
|
||||
)
|
||||
db.add(world)
|
||||
await db.flush() # assigns world.id, needed for the room's FK
|
||||
await WorldStore(db).get_or_create_main_room(world.id)
|
||||
await db.commit()
|
||||
await db.refresh(world)
|
||||
return world
|
||||
|
||||
@@ -0,0 +1,676 @@
|
||||
"""Python port of the chunk binary/JSON codec, `docs/architecture/world.md` §3.
|
||||
|
||||
This is the server-side half of the "single shared format, two
|
||||
implementations" contract world.md §5.2 and
|
||||
`world_persistence_impl.md` §5.5/§9 call for. The Godot-side implementation
|
||||
is `scripts/chunk_data_decoder.gd`; this module must decode anything it
|
||||
produces and produce bytes it can decode.
|
||||
|
||||
IMPORTANT DEVIATION (see the "Known cross-codec divergence" note at the
|
||||
bottom of this file): the current `scripts/chunk_data_decoder.gd` does not
|
||||
actually implement IEEE-754 float32 for the `pos`/`rot`/`scale`/`bounds`
|
||||
fields -- it performs a lossy numeric `int`/`float` cast instead of a bit
|
||||
reinterpretation, which both truncates fractional values and does not
|
||||
write IEEE-754 bits at all. This module implements the format as
|
||||
*specified* (real `<f` IEEE-754 float32, matching every other field in the
|
||||
spec and matching what any conformant decoder would assume). See the note
|
||||
for what this means for cross-codec byte parity today.
|
||||
|
||||
Nothing here talks to a database or the FastAPI app; it is a pure,
|
||||
side-effect-free codec so it can be golden-file tested in isolation.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import hashlib
|
||||
import json
|
||||
import struct
|
||||
from dataclasses import dataclass, field
|
||||
|
||||
MAGIC = b"AGPC"
|
||||
HEADER_SIZE = 48
|
||||
CURRENT_VERSION = 1
|
||||
|
||||
SECTION_META = 0x01
|
||||
SECTION_TILE = 0x02
|
||||
SECTION_OBJECT = 0x03
|
||||
SECTION_FLAGS = 0x04
|
||||
SECTION_REVISION_META = 0x05
|
||||
|
||||
CATEGORY_FIELDS = (
|
||||
"violence", "sexual", "language", "substance",
|
||||
"gambling", "horror", "hate", "custom",
|
||||
)
|
||||
|
||||
|
||||
class ChunkCodecError(Exception):
|
||||
"""Malformed bytes -- the payload isn't shaped like a chunk at all."""
|
||||
|
||||
|
||||
class ChunkValidationError(Exception):
|
||||
"""A structurally-valid chunk failed a content/business-rule check.
|
||||
|
||||
``reason`` is the machine-readable code the API surface (world_persistence_impl.md
|
||||
§8.1) puts in the 422 response body's ``reason`` field, e.g.
|
||||
``"checksum_mismatch"``, ``"layer_dims"``, ``"object_out_of_bounds"``.
|
||||
"""
|
||||
|
||||
def __init__(self, reason: str, message: str | None = None) -> None:
|
||||
self.reason = reason
|
||||
super().__init__(message or reason)
|
||||
|
||||
|
||||
# ───────────────────────── Logical model ─────────────────────────
|
||||
|
||||
@dataclass
|
||||
class TileDef:
|
||||
id: int
|
||||
asset_id: str = ""
|
||||
solid: bool = False
|
||||
flags: int = 0
|
||||
variants: int = 1
|
||||
|
||||
|
||||
@dataclass
|
||||
class TileLayer:
|
||||
name: str
|
||||
layer_id: int = 0
|
||||
width: int = 0
|
||||
height: int = 0
|
||||
depth: int = 1
|
||||
palette: list[TileDef] = field(default_factory=list)
|
||||
tiles: list[int] = field(default_factory=list) # flattened, row-major
|
||||
|
||||
|
||||
@dataclass
|
||||
class ContentFlags:
|
||||
violence: int = 0
|
||||
sexual: int = 0
|
||||
language: int = 0
|
||||
substance: int = 0
|
||||
gambling: int = 0
|
||||
horror: int = 0
|
||||
hate: int = 0
|
||||
custom: int = 0
|
||||
mature: bool = False
|
||||
sources: list[str] = field(default_factory=list)
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
return {
|
||||
"categories": {name: getattr(self, name) for name in CATEGORY_FIELDS},
|
||||
"mature": self.mature,
|
||||
"sources": list(self.sources),
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def from_dict(cls, d: dict) -> "ContentFlags":
|
||||
cats = d.get("categories", {})
|
||||
return cls(
|
||||
**{name: int(cats.get(name, 0)) for name in CATEGORY_FIELDS},
|
||||
mature=bool(d.get("mature", False)),
|
||||
sources=list(d.get("sources", [])),
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class WorldObject:
|
||||
id: str
|
||||
type: str
|
||||
asset_id: str
|
||||
pos: tuple[float, float, float] = (0.0, 0.0, 0.0)
|
||||
rot: tuple[float, float, float, float] = (0.0, 0.0, 0.0, 1.0)
|
||||
scale: tuple[float, float, float] = (1.0, 1.0, 1.0)
|
||||
dynamic: bool = False
|
||||
properties: dict = field(default_factory=dict)
|
||||
flags: ContentFlags = field(default_factory=ContentFlags)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ChunkBounds:
|
||||
"""Stored here as min-corner + size (matching the Godot client's AABB
|
||||
type) for convenience, but the §3.6 BINARY wire format is min + max
|
||||
(world.md §3.1, and the client's actual ChunkDataDecoder) -- fixed
|
||||
2026-09-14 after a real client/server interop test caught this class's
|
||||
original binary codec writing min+size on the wire, which the client
|
||||
decoder (unaware of the "size" convention) read as a second min/max
|
||||
pair, corrupting every chunk's bounds. The two representations are
|
||||
fully recoverable from each other; `max` below is computed for exactly
|
||||
this reason."""
|
||||
|
||||
min: tuple[float, float, float] = (0.0, 0.0, 0.0)
|
||||
size: tuple[float, float, float] = (0.0, 0.0, 0.0)
|
||||
|
||||
@property
|
||||
def max(self) -> tuple[float, float, float]:
|
||||
return tuple(a + b for a, b in zip(self.min, self.size))
|
||||
|
||||
|
||||
@dataclass
|
||||
class ChunkPayload:
|
||||
version: int = CURRENT_VERSION
|
||||
world_id: str = ""
|
||||
room_id: str = ""
|
||||
coord: tuple[int, int, int] = (0, 0, 0)
|
||||
bounds: ChunkBounds = field(default_factory=ChunkBounds)
|
||||
tile_layers: list[TileLayer] = field(default_factory=list)
|
||||
objects: list[WorldObject] = field(default_factory=list)
|
||||
flags: ContentFlags = field(default_factory=ContentFlags)
|
||||
created_at: int = 0
|
||||
updated_at: int = 0
|
||||
revision: int = 0
|
||||
author: str = ""
|
||||
|
||||
|
||||
def build_key(world_id: str | int, room_slug: str, cx: int, cy: int, cz: int) -> str:
|
||||
"""world_persistence_impl.md §4.5: ``"{world.id}:{room.slug}:{cx}:{cy}:{cz}"``."""
|
||||
return f"{world_id}:{room_slug}:{cx}:{cy}:{cz}"
|
||||
|
||||
|
||||
# ───────────────────────── Binary primitives ─────────────────────────
|
||||
# All integers little-endian, matching world.md §3.6.3. Floats are packed
|
||||
# as real IEEE-754 float32 -- see the module docstring's deviation note.
|
||||
|
||||
def _read_u16(data: bytes, off: int) -> int:
|
||||
return struct.unpack_from("<H", data, off)[0]
|
||||
|
||||
|
||||
def _read_u32(data: bytes, off: int) -> int:
|
||||
return struct.unpack_from("<I", data, off)[0]
|
||||
|
||||
|
||||
def _read_i32(data: bytes, off: int) -> int:
|
||||
return struct.unpack_from("<i", data, off)[0]
|
||||
|
||||
|
||||
def _read_i64(data: bytes, off: int) -> int:
|
||||
return struct.unpack_from("<q", data, off)[0]
|
||||
|
||||
|
||||
def _read_f32(data: bytes, off: int) -> float:
|
||||
return struct.unpack_from("<f", data, off)[0]
|
||||
|
||||
|
||||
def _w_u16(v: int) -> bytes:
|
||||
return struct.pack("<H", v & 0xFFFF)
|
||||
|
||||
|
||||
def _w_u32(v: int) -> bytes:
|
||||
return struct.pack("<I", v & 0xFFFFFFFF)
|
||||
|
||||
|
||||
def _w_i32(v: int) -> bytes:
|
||||
return struct.pack("<i", v)
|
||||
|
||||
|
||||
def _w_i64(v: int) -> bytes:
|
||||
return struct.pack("<q", v)
|
||||
|
||||
|
||||
def _w_f32(v: float) -> bytes:
|
||||
return struct.pack("<f", v)
|
||||
|
||||
|
||||
def _read_str(data: bytes, off: int) -> tuple[str, int]:
|
||||
"""Length-prefixed UTF-8 string. Returns (value, next_offset)."""
|
||||
n = _read_u16(data, off)
|
||||
off += 2
|
||||
s = data[off:off + n].decode("utf-8")
|
||||
return s, off + n
|
||||
|
||||
|
||||
def _w_str(s: str) -> bytes:
|
||||
b = s.encode("utf-8")
|
||||
if len(b) > 0xFFFF:
|
||||
raise ChunkCodecError(f"string field too long to encode ({len(b)} bytes)")
|
||||
return _w_u16(len(b)) + b
|
||||
|
||||
|
||||
def checksum(payload_body: bytes) -> str:
|
||||
"""SHA-256 hex digest of the payload body (world.md §3.6.3)."""
|
||||
return hashlib.sha256(payload_body).hexdigest()
|
||||
|
||||
|
||||
# ───────────────────────── Section codecs ─────────────────────────
|
||||
|
||||
def _encode_metadata(payload: ChunkPayload) -> bytes:
|
||||
out = bytearray()
|
||||
out += _w_str(payload.world_id)
|
||||
out += _w_str(payload.room_id)
|
||||
out += _w_i32(payload.coord[0])
|
||||
out += _w_i32(payload.coord[1])
|
||||
out += _w_i32(payload.coord[2])
|
||||
out += _w_f32(payload.bounds.min[0])
|
||||
out += _w_f32(payload.bounds.min[1])
|
||||
out += _w_f32(payload.bounds.min[2])
|
||||
out += _w_f32(payload.bounds.max[0])
|
||||
out += _w_f32(payload.bounds.max[1])
|
||||
out += _w_f32(payload.bounds.max[2])
|
||||
return bytes(out)
|
||||
|
||||
|
||||
def _decode_metadata(data: bytes, result: ChunkPayload) -> None:
|
||||
off = 0
|
||||
result.world_id, off = _read_str(data, off)
|
||||
result.room_id, off = _read_str(data, off)
|
||||
coord = (_read_i32(data, off), _read_i32(data, off + 4), _read_i32(data, off + 8))
|
||||
off += 12
|
||||
min_pos = (_read_f32(data, off), _read_f32(data, off + 4), _read_f32(data, off + 8))
|
||||
max_pos = (_read_f32(data, off + 12), _read_f32(data, off + 16), _read_f32(data, off + 20))
|
||||
size = tuple(a - b for a, b in zip(max_pos, min_pos))
|
||||
result.coord = coord
|
||||
result.bounds = ChunkBounds(min=min_pos, size=size)
|
||||
|
||||
|
||||
def _encode_tile_layer(layer: TileLayer) -> bytes:
|
||||
out = bytearray()
|
||||
out += _w_str(layer.name)
|
||||
out += _w_u16(layer.layer_id)
|
||||
out += _w_u16(layer.width)
|
||||
out += _w_u16(layer.height)
|
||||
out += _w_u16(layer.depth)
|
||||
out += _w_u16(len(layer.palette))
|
||||
for td in layer.palette:
|
||||
out += _w_u16(td.id)
|
||||
out += _w_str(td.asset_id)
|
||||
out += bytes([1 if td.solid else 0])
|
||||
out += _w_u32(td.flags)
|
||||
out += bytes([td.variants & 0xFF])
|
||||
out += _w_u32(len(layer.tiles))
|
||||
for tile_id in layer.tiles:
|
||||
out += _w_u16(tile_id)
|
||||
return bytes(out)
|
||||
|
||||
|
||||
def _decode_tile_layer(data: bytes) -> TileLayer:
|
||||
off = 0
|
||||
name, off = _read_str(data, off)
|
||||
layer_id = _read_u16(data, off); off += 2
|
||||
width = _read_u16(data, off); off += 2
|
||||
height = _read_u16(data, off); off += 2
|
||||
depth = _read_u16(data, off); off += 2
|
||||
palette_count = _read_u16(data, off); off += 2
|
||||
palette: list[TileDef] = []
|
||||
for _ in range(palette_count):
|
||||
tid = _read_u16(data, off); off += 2
|
||||
asset_id, off = _read_str(data, off)
|
||||
solid = data[off] != 0; off += 1
|
||||
flags = _read_u32(data, off); off += 4
|
||||
variants = data[off]; off += 1
|
||||
palette.append(TileDef(id=tid, asset_id=asset_id, solid=solid, flags=flags, variants=variants))
|
||||
tile_count = _read_u32(data, off); off += 4
|
||||
tiles: list[int] = []
|
||||
for _ in range(tile_count):
|
||||
tiles.append(_read_u16(data, off))
|
||||
off += 2
|
||||
return TileLayer(name=name, layer_id=layer_id, width=width, height=height,
|
||||
depth=depth, palette=palette, tiles=tiles)
|
||||
|
||||
|
||||
def _encode_flags(flags: ContentFlags) -> bytes:
|
||||
out = bytearray()
|
||||
for name in CATEGORY_FIELDS:
|
||||
out.append(getattr(flags, name) & 0xFF)
|
||||
out.append(1 if flags.mature else 0)
|
||||
out += _w_u16(len(flags.sources))
|
||||
for src in flags.sources:
|
||||
out += _w_str(src)
|
||||
return bytes(out)
|
||||
|
||||
|
||||
def _decode_flags(data: bytes) -> ContentFlags:
|
||||
off = 0
|
||||
values = {}
|
||||
for name in CATEGORY_FIELDS:
|
||||
values[name] = data[off]
|
||||
off += 1
|
||||
mature = data[off] != 0
|
||||
off += 1
|
||||
source_count = _read_u16(data, off)
|
||||
off += 2
|
||||
sources = []
|
||||
for _ in range(source_count):
|
||||
s, off = _read_str(data, off)
|
||||
sources.append(s)
|
||||
return ContentFlags(**values, mature=mature, sources=sources)
|
||||
|
||||
|
||||
def _encode_object(obj: WorldObject) -> bytes:
|
||||
out = bytearray()
|
||||
out += _w_str(obj.id)
|
||||
out += _w_str(obj.type)
|
||||
out += _w_str(obj.asset_id)
|
||||
for v in obj.pos:
|
||||
out += _w_f32(v)
|
||||
for v in obj.rot:
|
||||
out += _w_f32(v)
|
||||
for v in obj.scale:
|
||||
out += _w_f32(v)
|
||||
out.append(1 if obj.dynamic else 0)
|
||||
# Canonical JSON: keys sorted lexicographically (world.md §3.6.3).
|
||||
props_json = json.dumps(obj.properties, sort_keys=True, separators=(",", ":"))
|
||||
out += _w_str(props_json)
|
||||
out += _encode_flags(obj.flags)
|
||||
return bytes(out)
|
||||
|
||||
|
||||
def _decode_object(data: bytes) -> WorldObject:
|
||||
off = 0
|
||||
oid, off = _read_str(data, off)
|
||||
otype, off = _read_str(data, off)
|
||||
asset_id, off = _read_str(data, off)
|
||||
pos = (_read_f32(data, off), _read_f32(data, off + 4), _read_f32(data, off + 8))
|
||||
off += 12
|
||||
rot = (
|
||||
_read_f32(data, off), _read_f32(data, off + 4),
|
||||
_read_f32(data, off + 8), _read_f32(data, off + 12),
|
||||
)
|
||||
off += 16
|
||||
scale = (_read_f32(data, off), _read_f32(data, off + 4), _read_f32(data, off + 8))
|
||||
off += 12
|
||||
dynamic = data[off] != 0
|
||||
off += 1
|
||||
props_str, off = _read_str(data, off)
|
||||
try:
|
||||
properties = json.loads(props_str) if props_str else {}
|
||||
except json.JSONDecodeError as exc:
|
||||
raise ChunkCodecError(f"object {oid!r}: invalid properties JSON") from exc
|
||||
obj_flags = _decode_flags(data[off:])
|
||||
return WorldObject(id=oid, type=otype, asset_id=asset_id, pos=pos, rot=rot,
|
||||
scale=scale, dynamic=dynamic, properties=properties, flags=obj_flags)
|
||||
|
||||
|
||||
def _encode_revision_meta(payload: ChunkPayload) -> bytes:
|
||||
out = bytearray()
|
||||
out += _w_i64(payload.created_at)
|
||||
out += _w_i64(payload.updated_at)
|
||||
out += _w_u32(payload.revision)
|
||||
out += _w_str(payload.author)
|
||||
return bytes(out)
|
||||
|
||||
|
||||
def _decode_revision_meta(data: bytes, result: ChunkPayload) -> None:
|
||||
off = 0
|
||||
result.created_at = _read_i64(data, off); off += 8
|
||||
result.updated_at = _read_i64(data, off); off += 8
|
||||
result.revision = _read_u32(data, off); off += 4
|
||||
result.author, off = _read_str(data, off)
|
||||
|
||||
|
||||
def _wrap_section(section_id: int, data: bytes) -> bytes:
|
||||
return bytes([section_id]) + _w_u32(len(data)) + data
|
||||
|
||||
|
||||
# ───────────────────────── Top-level encode/decode ─────────────────────────
|
||||
|
||||
def encode_binary(payload: ChunkPayload) -> bytes:
|
||||
"""Encode a ChunkPayload to the world.md §3.6 wire format."""
|
||||
sections = bytearray()
|
||||
sections += _wrap_section(SECTION_META, _encode_metadata(payload))
|
||||
for layer in payload.tile_layers:
|
||||
sections += _wrap_section(SECTION_TILE, _encode_tile_layer(layer))
|
||||
for obj in payload.objects:
|
||||
sections += _wrap_section(SECTION_OBJECT, _encode_object(obj))
|
||||
sections += _wrap_section(SECTION_FLAGS, _encode_flags(payload.flags))
|
||||
sections += _wrap_section(SECTION_REVISION_META, _encode_revision_meta(payload))
|
||||
|
||||
payload_body = bytes(sections)
|
||||
digest = hashlib.sha256(payload_body).digest() # 32 raw bytes
|
||||
|
||||
header = bytearray()
|
||||
header += MAGIC
|
||||
header += _w_u16(CURRENT_VERSION)
|
||||
header += _w_u16(HEADER_SIZE - 8) # header_len: bytes of header after this field (spec-correct)
|
||||
header += _w_u32(0) # flags (reserved)
|
||||
header += _w_u32(len(payload_body))
|
||||
header += digest
|
||||
|
||||
return bytes(header) + payload_body
|
||||
|
||||
|
||||
def decode_binary(data: bytes) -> ChunkPayload:
|
||||
"""Decode a world.md §3.6 binary chunk. Raises ChunkCodecError on
|
||||
structurally malformed input (short buffer, bad magic, unsupported
|
||||
version, truncated payload)."""
|
||||
if len(data) < HEADER_SIZE:
|
||||
raise ChunkCodecError(f"data too short for header ({len(data)} bytes)")
|
||||
|
||||
if data[0:4] != MAGIC:
|
||||
raise ChunkCodecError("bad magic bytes")
|
||||
|
||||
version = _read_u16(data, 4)
|
||||
if version < 1 or version > CURRENT_VERSION:
|
||||
raise ChunkCodecError(f"unsupported chunk format version {version}")
|
||||
|
||||
# header_len (offset 6) is intentionally not used for offset math --
|
||||
# both this decoder and the Godot one always slice at the fixed
|
||||
# HEADER_SIZE, matching the reference implementation's actual (if
|
||||
# spec-inconsistent) behaviour.
|
||||
payload_len = _read_u32(data, 12)
|
||||
# bytes 16:48 are the header's advisory checksum -- decode_and_validate
|
||||
# re-reads it directly and recomputes against the parsed payload body.
|
||||
|
||||
if len(data) - HEADER_SIZE != payload_len:
|
||||
raise ChunkCodecError(
|
||||
f"declared payload_len ({payload_len}) does not match actual "
|
||||
f"remaining bytes ({len(data) - HEADER_SIZE})"
|
||||
)
|
||||
|
||||
payload_body = data[HEADER_SIZE:HEADER_SIZE + payload_len]
|
||||
|
||||
result = ChunkPayload(version=version)
|
||||
|
||||
offset = 0
|
||||
while offset < len(payload_body):
|
||||
if offset + 5 > len(payload_body):
|
||||
raise ChunkCodecError("truncated section header")
|
||||
section_id = payload_body[offset]
|
||||
section_len = _read_u32(payload_body, offset + 1)
|
||||
data_start = offset + 5
|
||||
data_end = data_start + section_len
|
||||
if data_end > len(payload_body):
|
||||
raise ChunkCodecError("truncated section body")
|
||||
section_data = payload_body[data_start:data_end]
|
||||
|
||||
if section_id == SECTION_META:
|
||||
_decode_metadata(section_data, result)
|
||||
elif section_id == SECTION_TILE:
|
||||
result.tile_layers.append(_decode_tile_layer(section_data))
|
||||
elif section_id == SECTION_OBJECT:
|
||||
result.objects.append(_decode_object(section_data))
|
||||
elif section_id == SECTION_FLAGS:
|
||||
result.flags = _decode_flags(section_data)
|
||||
elif section_id == SECTION_REVISION_META:
|
||||
_decode_revision_meta(section_data, result)
|
||||
# Unknown section ids are skipped (forward-compat), matching the
|
||||
# Godot decoder's match-with-no-default behaviour.
|
||||
|
||||
offset = data_end
|
||||
|
||||
return result
|
||||
|
||||
|
||||
# ───────────────────────── JSON encoding (world.md §3.5) ─────────────────────────
|
||||
# Derived, never stored (world_persistence_impl.md §8.1) -- produced here
|
||||
# from a decoded ChunkPayload for the ``Accept: application/json`` path.
|
||||
|
||||
def to_json_dict(payload: ChunkPayload, *, key: str, chunk_checksum: str) -> dict:
|
||||
return {
|
||||
"version": payload.version,
|
||||
"key": key,
|
||||
"world_id": payload.world_id,
|
||||
"room_id": payload.room_id,
|
||||
"coord": {"cx": payload.coord[0], "cy": payload.coord[1], "cz": payload.coord[2]},
|
||||
"bounds": {
|
||||
"min_x": payload.bounds.min[0], "min_y": payload.bounds.min[1], "min_z": payload.bounds.min[2],
|
||||
"max_x": payload.bounds.max[0], "max_y": payload.bounds.max[1], "max_z": payload.bounds.max[2],
|
||||
},
|
||||
"tiles": [
|
||||
{
|
||||
"name": layer.name,
|
||||
"layer_id": layer.layer_id,
|
||||
"width": layer.width,
|
||||
"height": layer.height,
|
||||
"depth": layer.depth,
|
||||
"palette": [
|
||||
{"id": td.id, "asset_id": td.asset_id, "solid": td.solid,
|
||||
"flags": td.flags, "variants": td.variants}
|
||||
for td in layer.palette
|
||||
],
|
||||
"tiles": list(layer.tiles),
|
||||
}
|
||||
for layer in payload.tile_layers
|
||||
],
|
||||
"objects": [
|
||||
{
|
||||
"id": obj.id, "type": obj.type, "asset_id": obj.asset_id,
|
||||
"transform": {
|
||||
"pos": list(obj.pos), "rot": list(obj.rot), "scale": list(obj.scale),
|
||||
},
|
||||
"properties": obj.properties,
|
||||
"dynamic": obj.dynamic,
|
||||
"flags": obj.flags.to_dict(),
|
||||
}
|
||||
for obj in payload.objects
|
||||
],
|
||||
"flags": payload.flags.to_dict(),
|
||||
"meta": {
|
||||
"created_at": payload.created_at, "updated_at": payload.updated_at,
|
||||
"revision": payload.revision, "author": payload.author,
|
||||
},
|
||||
"checksum": chunk_checksum,
|
||||
}
|
||||
|
||||
|
||||
# ───────────────────────── Validation (world_persistence_impl.md §5.5) ─────────────────────────
|
||||
|
||||
# Not precisely quantified by the design doc beyond "length limits" --
|
||||
# these are this implementation's conservative defaults (world.md §7).
|
||||
MAX_STRING_FIELD_LEN = 256
|
||||
MAX_PROPERTIES_JSON_LEN = 16_384
|
||||
MAX_SOURCES_PER_FLAGSET = 32
|
||||
|
||||
|
||||
def _check_string_lengths(obj: WorldObject) -> None:
|
||||
for field_name, value in (("id", obj.id), ("type", obj.type), ("asset_id", obj.asset_id)):
|
||||
if len(value) > MAX_STRING_FIELD_LEN:
|
||||
raise ChunkValidationError(
|
||||
"string_field_too_long", f"object.{field_name} exceeds {MAX_STRING_FIELD_LEN} chars"
|
||||
)
|
||||
props_json = json.dumps(obj.properties)
|
||||
if len(props_json) > MAX_PROPERTIES_JSON_LEN:
|
||||
raise ChunkValidationError(
|
||||
"string_field_too_long", f"object {obj.id!r} properties exceed {MAX_PROPERTIES_JSON_LEN} bytes"
|
||||
)
|
||||
if len(obj.flags.sources) > MAX_SOURCES_PER_FLAGSET:
|
||||
raise ChunkValidationError("string_field_too_long", f"object {obj.id!r} has too many flag sources")
|
||||
|
||||
|
||||
def decode_and_validate(
|
||||
data: bytes,
|
||||
*,
|
||||
expected_key: str,
|
||||
grid_size: tuple[int, int, int],
|
||||
max_objects: int,
|
||||
) -> ChunkPayload:
|
||||
"""Decode + fully validate a client-submitted chunk payload.
|
||||
|
||||
This is the boundary world_persistence_impl.md §5.5 requires: "the
|
||||
backend must not trust the client". Raises ``ChunkCodecError`` for
|
||||
structurally malformed bytes (mapped to a 422 by the router with a
|
||||
generic reason) or ``ChunkValidationError`` with a specific ``reason``
|
||||
code for a well-formed-but-invalid payload.
|
||||
"""
|
||||
payload = decode_binary(data) # raises ChunkCodecError for structural problems first
|
||||
|
||||
# Checksum is advisory in the header (world.md §7); the value that
|
||||
# matters is recomputed from the actual payload body we just parsed.
|
||||
payload_body = data[HEADER_SIZE:]
|
||||
recomputed = checksum(payload_body)
|
||||
header_checksum_hex = data[16:48].hex()
|
||||
if header_checksum_hex != recomputed:
|
||||
raise ChunkValidationError(
|
||||
"checksum_mismatch",
|
||||
"header checksum does not match the recomputed SHA-256 of the payload body",
|
||||
)
|
||||
|
||||
actual_key = build_key(payload.world_id, payload.room_id, *payload.coord)
|
||||
if actual_key != expected_key:
|
||||
raise ChunkValidationError(
|
||||
"chunk_key_mismatch",
|
||||
f"payload key {actual_key!r} does not match URL {expected_key!r}",
|
||||
)
|
||||
|
||||
for layer in payload.tile_layers:
|
||||
if (layer.width, layer.height, layer.depth) != tuple(grid_size):
|
||||
raise ChunkValidationError(
|
||||
"layer_dims",
|
||||
f"tile layer {layer.name!r} dims {(layer.width, layer.height, layer.depth)} "
|
||||
f"!= room grid {tuple(grid_size)}",
|
||||
)
|
||||
valid_ids = {0} | {td.id for td in layer.palette}
|
||||
for tile_id in layer.tiles:
|
||||
if tile_id not in valid_ids:
|
||||
raise ChunkValidationError(
|
||||
"tile_out_of_palette",
|
||||
f"tile layer {layer.name!r} references palette id {tile_id} not in its palette",
|
||||
)
|
||||
if len(layer.tiles) != layer.width * layer.height * layer.depth:
|
||||
raise ChunkValidationError(
|
||||
"layer_dims",
|
||||
f"tile layer {layer.name!r} has {len(layer.tiles)} cells, expected "
|
||||
f"{layer.width * layer.height * layer.depth}",
|
||||
)
|
||||
|
||||
if len(payload.objects) > max_objects:
|
||||
raise ChunkValidationError(
|
||||
"too_many_objects", f"{len(payload.objects)} objects exceeds max {max_objects}"
|
||||
)
|
||||
|
||||
bmin, bmax = payload.bounds.min, payload.bounds.max
|
||||
for obj in payload.objects:
|
||||
_check_string_lengths(obj)
|
||||
if not all(bmin[i] <= obj.pos[i] <= bmax[i] for i in range(3)):
|
||||
raise ChunkValidationError(
|
||||
"object_out_of_bounds",
|
||||
f"object {obj.id!r} position {obj.pos} outside chunk bounds "
|
||||
f"[{bmin}, {bmax}]",
|
||||
)
|
||||
|
||||
if len(payload.author) > MAX_STRING_FIELD_LEN:
|
||||
raise ChunkValidationError("string_field_too_long", "meta.author too long")
|
||||
|
||||
return payload
|
||||
|
||||
|
||||
# ───────────────────────── Known cross-codec divergence ─────────────────────────
|
||||
#
|
||||
# `scripts/chunk_data_decoder.gd`'s `_read_float32`/`_write_float32` do:
|
||||
#
|
||||
# static func _write_float32(val: float) -> PackedByteArray:
|
||||
# var bits := val as int
|
||||
# return _write_uint32(bits)
|
||||
#
|
||||
# static func _read_float32(data: PackedByteArray, offset: int) -> float:
|
||||
# var bits := _read_uint32(data, offset)
|
||||
# return bits as float
|
||||
#
|
||||
# `as` between int and float in GDScript is a numeric conversion, not a bit
|
||||
# reinterpretation (verified empirically against Godot 4.6.2 headless:
|
||||
# `1.5 as int` -> `1`, `1 as float` -> `1.0`; the IEEE-754 bit pattern of
|
||||
# 1.5f is 0x3FC00000 = 1069547520, not 1). So the shipped client codec
|
||||
# truncates every float32 field (bounds, object pos/rot/scale) to its
|
||||
# integer part and stores that integer as a raw int32 -- not as float32
|
||||
# bits at all. This is a real bug in already-merged, client-side code
|
||||
# (scripts/ is out of scope for this task) that breaks the "byte-stable
|
||||
# across two implementations" guarantee world.md §3.6.3 states.
|
||||
#
|
||||
# This module implements the *specified* format (real IEEE-754 float32)
|
||||
# rather than replicating that bug, because world.md §3.6 is normative and
|
||||
# says "float32" for these fields, and mirroring the bug would mean the
|
||||
# backend also corrupts every non-integer transform/bounds value it
|
||||
# stores. Practical effect until the client-side bug is fixed: payloads
|
||||
# with integer-only floats will decode identically on both sides; any
|
||||
# payload with a fractional position/rotation/scale/bounds value will not
|
||||
# be byte-identical (or numerically identical) between this module and the
|
||||
# current `scripts/chunk_data_decoder.gd`. This is flagged for the
|
||||
# client/editor follow-on task, not fixed here.
|
||||
@@ -13,15 +13,26 @@ project are on the host (see ``settings.GODOT_BIN`` / ``GAME_PROJECT_DIR``);
|
||||
the backend spawns them as subprocesses.
|
||||
|
||||
Design notes / limits (PC3):
|
||||
- All worlds currently load the same test level (per-world content is M2/M7).
|
||||
``world_id`` still scopes a distinct server process + session.
|
||||
- Port allocation is a linear scan of the configured range.
|
||||
- No crash-restart: if a server process dies, the next join respawns it.
|
||||
With world content now durable in Postgres (world_persistence_impl.md
|
||||
D2), this is genuinely safe rather than merely tolerated: the sim
|
||||
process holds no unsaved world content, so a reap/crash/kill can never
|
||||
lose world data.
|
||||
|
||||
Per-spawn auth token (world_persistence_impl.md §7.3): each spawned server
|
||||
gets a random ``secrets.token_urlsafe(32)`` on its command line, which it
|
||||
uses as a Bearer token against ``/api/internal`` to pull its world's
|
||||
content read-only before binding its ENet port. The token grants access to
|
||||
exactly one world and dies with its process (the reaper's
|
||||
``del self._servers[wid]`` invalidates it; see ``validate_token``).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import hmac
|
||||
import json
|
||||
import secrets
|
||||
import socket
|
||||
import subprocess
|
||||
import tempfile
|
||||
@@ -38,6 +49,7 @@ class _WorldServer:
|
||||
port: int
|
||||
proc: subprocess.Popen
|
||||
status_path: Path
|
||||
token: str
|
||||
started_at: float = field(default_factory=time.time)
|
||||
last_join: float = field(default_factory=time.time)
|
||||
|
||||
@@ -50,6 +62,9 @@ class _WorldServer:
|
||||
def player_count(self) -> int:
|
||||
return int(self.status().get("players", 0))
|
||||
|
||||
def is_ready(self) -> bool:
|
||||
return self.status().get("ready") is True
|
||||
|
||||
def alive(self) -> bool:
|
||||
return self.proc.poll() is None
|
||||
|
||||
@@ -104,16 +119,35 @@ class GameServerSupervisor:
|
||||
if srv is None:
|
||||
srv = self._spawn(world_id)
|
||||
self._servers[world_id] = srv
|
||||
# Give the engine a moment to bind the ENet port before we
|
||||
# hand the address to a client.
|
||||
await self._await_port(srv.port)
|
||||
try:
|
||||
await self._await_ready(srv)
|
||||
except TimeoutError:
|
||||
# Real failure now, not a silent "hope it's fine" --
|
||||
# see _await_ready's docstring. Don't leave a possibly
|
||||
# half-started process registered.
|
||||
srv.stop()
|
||||
del self._servers[world_id]
|
||||
raise RuntimeError(
|
||||
f"dedicated server for world {world_id} did not become ready in time"
|
||||
)
|
||||
|
||||
srv.last_join = time.time()
|
||||
return {"host": settings.GAME_SERVER_HOST, "port": srv.port, "world_id": world_id}
|
||||
|
||||
def validate_token(self, world_id: str, token: str) -> bool:
|
||||
"""`require_game_server` dependency support (world_persistence_impl.md
|
||||
§7.3): true iff *token* is the live token for *world_id*'s server.
|
||||
A dict lookup, as the doc specifies, plus a constant-time compare
|
||||
since it's a bearer credential."""
|
||||
srv = self._servers.get(str(world_id))
|
||||
if srv is None or not srv.alive():
|
||||
return False
|
||||
return hmac.compare_digest(srv.token, token)
|
||||
|
||||
# ── internals ────────────────────────────────────────────────────────
|
||||
def _spawn(self, world_id: str) -> _WorldServer:
|
||||
port = self._free_port()
|
||||
token = secrets.token_urlsafe(32)
|
||||
status_path = self._runtime_dir / f"world_{world_id}_{port}.json"
|
||||
status_path.unlink(missing_ok=True)
|
||||
cmd = [
|
||||
@@ -123,9 +157,13 @@ class GameServerSupervisor:
|
||||
"--port", str(port),
|
||||
"--world", str(world_id),
|
||||
"--status-file", str(status_path),
|
||||
"--api-url", settings.GAME_SERVER_INTERNAL_API_URL,
|
||||
"--server-token", token,
|
||||
]
|
||||
proc = subprocess.Popen(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
|
||||
return _WorldServer(world_id=world_id, port=port, proc=proc, status_path=status_path)
|
||||
return _WorldServer(
|
||||
world_id=world_id, port=port, proc=proc, status_path=status_path, token=token
|
||||
)
|
||||
|
||||
def _free_port(self) -> int:
|
||||
used = {s.port for s in self._servers.values()}
|
||||
@@ -140,16 +178,35 @@ class GameServerSupervisor:
|
||||
continue
|
||||
raise RuntimeError("no free game-server port in the configured range")
|
||||
|
||||
async def _await_port(self, port: int, timeout: float = 8.0) -> None:
|
||||
deadline = time.time() + timeout
|
||||
async def _await_ready(self, srv: _WorldServer) -> None:
|
||||
"""Wait for a ``"ready": true`` field in the status file
|
||||
(world_persistence_impl.md §7.4).
|
||||
|
||||
This replaces the old ``_await_port``, which had two real bugs:
|
||||
it treated a bound UDP port as "ready", but with content loading
|
||||
the port binds *before* the server has fetched its world's rooms
|
||||
and chunks (world_persistence_impl.md §7.2 step 4) -- so a client
|
||||
could get handed an address for a server still mid-fetch. And it
|
||||
*failed open*: past its 8s deadline it simply returned, with no
|
||||
error, so ``ensure_server`` reported success for a server that may
|
||||
never have started at all. This raises ``TimeoutError`` instead,
|
||||
which ``ensure_server`` turns into a real 503 for the joining
|
||||
client, and also bails out early (same exception) if the process
|
||||
has already exited.
|
||||
"""
|
||||
deadline = time.time() + settings.GAME_SERVER_READY_TIMEOUT_SECONDS
|
||||
while time.time() < deadline:
|
||||
# ENet is UDP; a bind failure means something (our server) has it.
|
||||
with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s:
|
||||
try:
|
||||
s.bind(("0.0.0.0", port))
|
||||
except OSError:
|
||||
return
|
||||
if srv.is_ready():
|
||||
return
|
||||
if not srv.alive():
|
||||
raise TimeoutError(
|
||||
f"server process for world {srv.world_id} exited before becoming ready"
|
||||
)
|
||||
await asyncio.sleep(0.25)
|
||||
raise TimeoutError(
|
||||
f"server for world {srv.world_id} did not report ready within "
|
||||
f"{settings.GAME_SERVER_READY_TIMEOUT_SECONDS}s"
|
||||
)
|
||||
|
||||
async def _reap_loop(self) -> None:
|
||||
try:
|
||||
|
||||
@@ -0,0 +1,431 @@
|
||||
"""World content storage service.
|
||||
|
||||
Implements the `world.md` §5.1 service interface over Postgres, per
|
||||
`world_persistence_impl.md` §9 -- **minus** ``flush_dirty`` and
|
||||
``rebuild_index``, which don't apply once there is no write-behind dirty
|
||||
set and no derived index to rebuild (see that doc's §3.3 and §4.2).
|
||||
|
||||
This is the *only* place chunk content is written (world_persistence_impl.md
|
||||
D2 / §5). Callers (the routers) own transaction boundaries: methods here
|
||||
``flush()`` so later statements in the same request see earlier ones and so
|
||||
integrity errors surface before a caller commits, but they never
|
||||
``commit()`` -- that mirrors the existing convention in
|
||||
``app/routers/worlds.py`` (``get_db`` docs: "Handlers are responsible for
|
||||
committing or rolling back their own transactions").
|
||||
|
||||
Known gap this module had to resolve on its own (flagged, not silently
|
||||
decided): `world_persistence_impl.md` §6/§7.2/§8.1 all reference a world's
|
||||
monotonic ``content_revision`` ("bumped on every chunk write"), but no
|
||||
column for it is defined anywhere in §4's schema. Rather than add an
|
||||
undocumented column, ``content_revision()`` below derives it as
|
||||
``MAX(id)`` over ``world_chunk_revisions`` scoped to the world: that table
|
||||
is append-only (retention only nulls ``payload``, it never deletes rows),
|
||||
so the value is genuinely monotonic and increments on every
|
||||
create/update/delete/rollback.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
|
||||
from sqlalchemy import func, select, update
|
||||
from sqlalchemy.exc import IntegrityError
|
||||
from sqlalchemy.ext.asyncio import AsyncSession
|
||||
from sqlalchemy.orm import load_only
|
||||
|
||||
from app.config import settings
|
||||
from app.models.world_content import (
|
||||
MAIN_ROOM_NAME,
|
||||
MAIN_ROOM_SLUG,
|
||||
WorldChunk,
|
||||
WorldChunkRevision,
|
||||
WorldRoom,
|
||||
)
|
||||
from app.services import chunk_codec
|
||||
|
||||
|
||||
class RevisionConflict(Exception):
|
||||
"""Optimistic-concurrency conflict (world.md §5.4). ``current_revision``
|
||||
is 0 and ``current_checksum`` is None when the caller's ``base_revision``
|
||||
assumed a chunk exists but it doesn't."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
current_revision: int,
|
||||
current_checksum: str | None,
|
||||
coord: tuple[int, int, int] | None = None,
|
||||
) -> None:
|
||||
self.current_revision = current_revision
|
||||
self.current_checksum = current_checksum
|
||||
self.coord = coord
|
||||
super().__init__(f"revision conflict: current_revision={current_revision}")
|
||||
|
||||
|
||||
class RevisionNotAvailable(Exception):
|
||||
"""Raised by ``rollback_chunk`` when the requested revision doesn't
|
||||
exist, or exists but its payload was pruned by the retention policy
|
||||
(world_persistence_impl.md §4.3)."""
|
||||
|
||||
|
||||
@dataclass
|
||||
class Bounds:
|
||||
cx_min: int | None = None
|
||||
cx_max: int | None = None
|
||||
cy_min: int | None = None
|
||||
cy_max: int | None = None
|
||||
cz: int | None = None
|
||||
|
||||
|
||||
class WorldStore:
|
||||
"""Owns chunk/room read/write operations over the async session
|
||||
handed to it. One instance per request is the expected usage
|
||||
(``WorldStore(db)`` where ``db`` is the ``DbDep`` session)."""
|
||||
|
||||
def __init__(self, db: AsyncSession) -> None:
|
||||
self.db = db
|
||||
|
||||
# ── rooms ────────────────────────────────────────────────────────────
|
||||
|
||||
async def get_room(self, world_id: int, slug: str) -> WorldRoom | None:
|
||||
result = await self.db.execute(
|
||||
select(WorldRoom).where(WorldRoom.world_id == world_id, WorldRoom.slug == slug)
|
||||
)
|
||||
return result.scalar_one_or_none()
|
||||
|
||||
async def list_rooms(self, world_id: int) -> list[WorldRoom]:
|
||||
result = await self.db.execute(
|
||||
select(WorldRoom).where(WorldRoom.world_id == world_id).order_by(WorldRoom.id)
|
||||
)
|
||||
return list(result.scalars().all())
|
||||
|
||||
async def create_room(
|
||||
self,
|
||||
world_id: int,
|
||||
slug: str,
|
||||
name: str,
|
||||
*,
|
||||
grid: dict | None = None,
|
||||
bounds: dict | None = None,
|
||||
spawn: dict | None = None,
|
||||
) -> WorldRoom:
|
||||
room = WorldRoom(world_id=world_id, slug=slug, name=name)
|
||||
if grid is not None:
|
||||
room.grid = grid
|
||||
if bounds is not None:
|
||||
room.bounds = bounds
|
||||
if spawn is not None:
|
||||
room.spawn = spawn
|
||||
self.db.add(room)
|
||||
await self.db.flush()
|
||||
await self.db.refresh(room)
|
||||
return room
|
||||
|
||||
async def get_or_create_main_room(self, world_id: int) -> WorldRoom:
|
||||
"""world_persistence_impl.md §4.1: every world gets a ``main`` room.
|
||||
Called from ``create_world`` for new worlds, and lazily here for
|
||||
worlds that predate this migration."""
|
||||
room = await self.get_room(world_id, MAIN_ROOM_SLUG)
|
||||
if room is not None:
|
||||
return room
|
||||
try:
|
||||
return await self.create_room(world_id, MAIN_ROOM_SLUG, MAIN_ROOM_NAME)
|
||||
except IntegrityError:
|
||||
# Lost a race with a concurrent creator; the row now exists.
|
||||
await self.db.rollback()
|
||||
room = await self.get_room(world_id, MAIN_ROOM_SLUG)
|
||||
if room is None:
|
||||
raise
|
||||
return room
|
||||
|
||||
async def count_chunks(self, room_id: int) -> int:
|
||||
result = await self.db.execute(
|
||||
select(func.count()).select_from(WorldChunk).where(WorldChunk.room_id == room_id)
|
||||
)
|
||||
return int(result.scalar_one())
|
||||
|
||||
async def content_revision(self, world_id: int) -> int:
|
||||
"""See module docstring for why this is derived rather than stored."""
|
||||
result = await self.db.execute(
|
||||
select(func.max(WorldChunkRevision.id)).where(WorldChunkRevision.world_id == world_id)
|
||||
)
|
||||
return int(result.scalar() or 0)
|
||||
|
||||
# ── chunk reads ──────────────────────────────────────────────────────
|
||||
|
||||
async def get_chunk(self, key: str) -> WorldChunk | None:
|
||||
result = await self.db.execute(select(WorldChunk).where(WorldChunk.chunk_key == key))
|
||||
return result.scalar_one_or_none()
|
||||
|
||||
async def get_chunk_by_coord(self, room_id: int, cx: int, cy: int, cz: int) -> WorldChunk | None:
|
||||
result = await self.db.execute(
|
||||
select(WorldChunk).where(
|
||||
WorldChunk.room_id == room_id, WorldChunk.cx == cx,
|
||||
WorldChunk.cy == cy, WorldChunk.cz == cz,
|
||||
)
|
||||
)
|
||||
return result.scalar_one_or_none()
|
||||
|
||||
async def get_chunk_binary(self, key: str) -> bytes | None:
|
||||
chunk = await self.get_chunk(key)
|
||||
return chunk.payload if chunk is not None else None
|
||||
|
||||
async def get_chunk_flags(self, key: str) -> dict | None:
|
||||
chunk = await self.get_chunk(key)
|
||||
return chunk.content_flags if chunk is not None else None
|
||||
|
||||
async def list_chunks(
|
||||
self,
|
||||
world_id: int,
|
||||
room_id: int | None = None,
|
||||
bounds: Bounds | None = None,
|
||||
) -> list[WorldChunk]:
|
||||
"""Index query -- world.md §5.1's ``list_chunks``. Payload bytes are
|
||||
deliberately not loaded (world_persistence_impl.md §8.1: "Payloads
|
||||
are not included")."""
|
||||
query = select(WorldChunk).options(
|
||||
load_only(
|
||||
WorldChunk.id, WorldChunk.world_id, WorldChunk.room_id, WorldChunk.chunk_key,
|
||||
WorldChunk.cx, WorldChunk.cy, WorldChunk.cz, WorldChunk.revision,
|
||||
WorldChunk.checksum, WorldChunk.payload_len, WorldChunk.is_mature,
|
||||
WorldChunk.updated_at,
|
||||
)
|
||||
).where(WorldChunk.world_id == world_id)
|
||||
if room_id is not None:
|
||||
query = query.where(WorldChunk.room_id == room_id)
|
||||
if bounds is not None:
|
||||
if bounds.cx_min is not None:
|
||||
query = query.where(WorldChunk.cx >= bounds.cx_min)
|
||||
if bounds.cx_max is not None:
|
||||
query = query.where(WorldChunk.cx <= bounds.cx_max)
|
||||
if bounds.cy_min is not None:
|
||||
query = query.where(WorldChunk.cy >= bounds.cy_min)
|
||||
if bounds.cy_max is not None:
|
||||
query = query.where(WorldChunk.cy <= bounds.cy_max)
|
||||
if bounds.cz is not None:
|
||||
query = query.where(WorldChunk.cz == bounds.cz)
|
||||
query = query.order_by(WorldChunk.cx, WorldChunk.cy, WorldChunk.cz)
|
||||
result = await self.db.execute(query)
|
||||
return list(result.scalars().all())
|
||||
|
||||
# ── chunk writes ─────────────────────────────────────────────────────
|
||||
|
||||
async def put_chunk(
|
||||
self,
|
||||
*,
|
||||
room: WorldRoom,
|
||||
cx: int,
|
||||
cy: int,
|
||||
cz: int,
|
||||
payload_bytes: bytes,
|
||||
base_revision: int,
|
||||
actor_id: int | None,
|
||||
) -> WorldChunk:
|
||||
"""Full-chunk write with optimistic concurrency (world.md §5.4,
|
||||
world_persistence_impl.md §5.4/§8.2). Validates the payload
|
||||
server-side (§5.5) before ever touching a row. ``base_revision=0``
|
||||
means "create; 409 if it already exists"."""
|
||||
key = chunk_codec.build_key(room.world_id, room.slug, cx, cy, cz)
|
||||
grid_size = tuple(room.grid.get("size", [32, 32, 1]))
|
||||
|
||||
# Raises ChunkCodecError / ChunkValidationError -- the router maps
|
||||
# those to 422. Nothing below trusts the request body's own claims
|
||||
# about content_flags/is_mature; both come from `decoded`.
|
||||
decoded = chunk_codec.decode_and_validate(
|
||||
payload_bytes,
|
||||
expected_key=key,
|
||||
grid_size=grid_size,
|
||||
max_objects=settings.WORLD_CHUNK_MAX_OBJECTS,
|
||||
)
|
||||
body_checksum = chunk_codec.checksum(payload_bytes[chunk_codec.HEADER_SIZE:])
|
||||
|
||||
result = await self.db.execute(
|
||||
select(WorldChunk)
|
||||
.where(
|
||||
WorldChunk.room_id == room.id, WorldChunk.cx == cx,
|
||||
WorldChunk.cy == cy, WorldChunk.cz == cz,
|
||||
)
|
||||
.with_for_update()
|
||||
)
|
||||
row = result.scalar_one_or_none()
|
||||
|
||||
if base_revision == 0:
|
||||
if row is not None:
|
||||
raise RevisionConflict(row.revision, row.checksum, (cx, cy, cz))
|
||||
row = WorldChunk(
|
||||
world_id=room.world_id, room_id=room.id, chunk_key=key,
|
||||
cx=cx, cy=cy, cz=cz, revision=1,
|
||||
)
|
||||
self.db.add(row)
|
||||
action = "create"
|
||||
else:
|
||||
if row is None or row.revision != base_revision:
|
||||
raise RevisionConflict(
|
||||
row.revision if row else 0, row.checksum if row else None, (cx, cy, cz)
|
||||
)
|
||||
row.revision = row.revision + 1
|
||||
action = "update"
|
||||
|
||||
row.format_version = decoded.version
|
||||
row.payload = payload_bytes
|
||||
row.payload_len = len(payload_bytes)
|
||||
row.checksum = body_checksum
|
||||
row.content_flags = decoded.flags.to_dict()
|
||||
row.is_mature = decoded.flags.mature
|
||||
row.updated_by_id = actor_id
|
||||
|
||||
try:
|
||||
await self.db.flush()
|
||||
except IntegrityError:
|
||||
# Lost a create race to a concurrent writer between our SELECT
|
||||
# and this flush. Roll back and report the real current state.
|
||||
await self.db.rollback()
|
||||
existing = await self.get_chunk_by_coord(room.id, cx, cy, cz)
|
||||
raise RevisionConflict(
|
||||
existing.revision if existing else 0,
|
||||
existing.checksum if existing else None,
|
||||
(cx, cy, cz),
|
||||
)
|
||||
|
||||
await self._record_revision(key, room.world_id, row.revision, action, actor_id, body_checksum, payload_bytes)
|
||||
await self.db.refresh(row)
|
||||
return row
|
||||
|
||||
async def put_chunks_batch(
|
||||
self,
|
||||
*,
|
||||
room: WorldRoom,
|
||||
items: list[dict],
|
||||
actor_id: int | None,
|
||||
) -> list[WorldChunk]:
|
||||
"""Batch write (world_persistence_impl.md §8.1). One transaction,
|
||||
all-or-nothing: none of this ``commit()``s, so a ``RevisionConflict``
|
||||
raised partway leaves nothing persisted once the caller's request
|
||||
handler lets the exception (or the HTTPException it becomes)
|
||||
propagate through ``get_db``, which rolls back on any exception."""
|
||||
rows: list[WorldChunk] = []
|
||||
for item in items:
|
||||
row = await self.put_chunk(
|
||||
room=room, cx=item["cx"], cy=item["cy"], cz=item["cz"],
|
||||
payload_bytes=item["payload_bytes"], base_revision=item["base_revision"],
|
||||
actor_id=actor_id,
|
||||
)
|
||||
rows.append(row)
|
||||
return rows
|
||||
|
||||
async def delete_chunk(self, key: str, actor_id: int | None) -> None:
|
||||
row = await self.get_chunk(key)
|
||||
if row is None:
|
||||
return
|
||||
await self._record_revision(key, row.world_id, row.revision, "delete", actor_id, row.checksum, None)
|
||||
await self.db.delete(row)
|
||||
await self.db.flush()
|
||||
|
||||
async def rollback_chunk(self, key: str, revision: int, actor_id: int | None) -> WorldChunk:
|
||||
"""Restore a chunk to a previously-recorded revision's payload
|
||||
(world.md §5.1). Raises ``RevisionNotAvailable`` if that revision
|
||||
was never recorded, its payload was pruned by retention, or the
|
||||
chunk has since been deleted outright (nothing to update in place)."""
|
||||
rev_result = await self.db.execute(
|
||||
select(WorldChunkRevision)
|
||||
.where(WorldChunkRevision.chunk_key == key, WorldChunkRevision.revision == revision)
|
||||
.order_by(WorldChunkRevision.id.desc())
|
||||
.limit(1)
|
||||
)
|
||||
rev_row = rev_result.scalar_one_or_none()
|
||||
if rev_row is None:
|
||||
raise RevisionNotAvailable(f"no revision {revision} recorded for {key!r}")
|
||||
if rev_row.payload is None:
|
||||
raise RevisionNotAvailable(f"revision {revision} of {key!r} was pruned; payload unavailable")
|
||||
|
||||
chunk = await self.get_chunk(key)
|
||||
if chunk is None:
|
||||
raise RevisionNotAvailable(f"chunk {key!r} no longer exists; cannot roll back in place")
|
||||
|
||||
room_result = await self.db.execute(select(WorldRoom).where(WorldRoom.id == chunk.room_id))
|
||||
room = room_result.scalar_one()
|
||||
grid_size = tuple(room.grid.get("size", [32, 32, 1]))
|
||||
decoded = chunk_codec.decode_and_validate(
|
||||
rev_row.payload, expected_key=key, grid_size=grid_size,
|
||||
max_objects=settings.WORLD_CHUNK_MAX_OBJECTS,
|
||||
)
|
||||
body_checksum = chunk_codec.checksum(rev_row.payload[chunk_codec.HEADER_SIZE:])
|
||||
|
||||
chunk.revision = chunk.revision + 1
|
||||
chunk.payload = rev_row.payload
|
||||
chunk.payload_len = len(rev_row.payload)
|
||||
chunk.checksum = body_checksum
|
||||
chunk.format_version = decoded.version
|
||||
chunk.content_flags = decoded.flags.to_dict()
|
||||
chunk.is_mature = decoded.flags.mature
|
||||
chunk.updated_by_id = actor_id
|
||||
|
||||
await self.db.flush()
|
||||
# Tagged "update" (not a fourth action value) to keep the
|
||||
# documented 'create'|'update'|'delete' action enum intact.
|
||||
await self._record_revision(
|
||||
key, chunk.world_id, chunk.revision, "update", actor_id, body_checksum, rev_row.payload
|
||||
)
|
||||
await self.db.refresh(chunk)
|
||||
return chunk
|
||||
|
||||
async def list_revisions(self, chunk_key: str, limit: int = 50) -> list[WorldChunkRevision]:
|
||||
"""Not in world.md §5.1's interface by name, but required to
|
||||
implement the revision-history endpoint world_persistence_impl.md
|
||||
§8.1 lists (``GET .../revisions``)."""
|
||||
result = await self.db.execute(
|
||||
select(WorldChunkRevision)
|
||||
.where(WorldChunkRevision.chunk_key == chunk_key)
|
||||
.order_by(WorldChunkRevision.revision.desc(), WorldChunkRevision.id.desc())
|
||||
.limit(limit)
|
||||
)
|
||||
return list(result.scalars().all())
|
||||
|
||||
async def migrate(self) -> None:
|
||||
"""No-op. `world.md` §4.8's hand-rolled SQLite migration runner is
|
||||
superseded by Alembic (`backend/alembic/`) now that content lives
|
||||
in Postgres (world_persistence_impl.md §3.3). Kept only so this
|
||||
class's shape still matches the §5.1 interface it's implementing
|
||||
a subset of."""
|
||||
return None
|
||||
|
||||
# ── internals ────────────────────────────────────────────────────────
|
||||
|
||||
async def _record_revision(
|
||||
self,
|
||||
chunk_key: str,
|
||||
world_id: int,
|
||||
revision: int,
|
||||
action: str,
|
||||
actor_id: int | None,
|
||||
checksum_hex: str,
|
||||
payload_bytes: bytes | None,
|
||||
) -> None:
|
||||
"""Append an audit row and enforce the retention policy
|
||||
(world_persistence_impl.md §4.3, required): keep the newest
|
||||
``WORLD_CHUNK_REVISION_KEEP`` payloads per ``chunk_key``, null out
|
||||
``payload`` on older rows, in the same transaction as the write."""
|
||||
rev = WorldChunkRevision(
|
||||
chunk_key=chunk_key, world_id=world_id, revision=revision, action=action,
|
||||
actor_id=actor_id, checksum=checksum_hex, payload=payload_bytes,
|
||||
)
|
||||
self.db.add(rev)
|
||||
await self.db.flush()
|
||||
|
||||
keep = settings.WORLD_CHUNK_REVISION_KEEP
|
||||
keep_ids_result = await self.db.execute(
|
||||
select(WorldChunkRevision.id)
|
||||
.where(WorldChunkRevision.chunk_key == chunk_key)
|
||||
.order_by(WorldChunkRevision.id.desc())
|
||||
.limit(keep)
|
||||
)
|
||||
keep_ids = [row[0] for row in keep_ids_result.all()]
|
||||
if keep_ids:
|
||||
await self.db.execute(
|
||||
update(WorldChunkRevision)
|
||||
.where(
|
||||
WorldChunkRevision.chunk_key == chunk_key,
|
||||
WorldChunkRevision.id.notin_(keep_ids),
|
||||
WorldChunkRevision.payload.isnot(None),
|
||||
)
|
||||
.values(payload=None)
|
||||
)
|
||||
@@ -30,7 +30,16 @@ from app.config import settings
|
||||
from app.database import get_db
|
||||
from app.main import app
|
||||
|
||||
TEST_TABLES = ("avatar_loadouts", "assets", "worlds", "sessions", "refresh_tokens", "users")
|
||||
TEST_TABLES = (
|
||||
"avatar_loadouts", "assets",
|
||||
# world_chunk_revisions has no FK to worlds/world_chunks (world.md §4.7 /
|
||||
# world_persistence_impl.md §4.3, deliberate -- deleting a chunk or world
|
||||
# must not lose the audit trail), so it won't be cascade-truncated via
|
||||
# `worlds` the way world_rooms/world_chunks would be. List all three
|
||||
# explicitly rather than rely on cascade for some of them.
|
||||
"world_chunk_revisions", "world_chunks", "world_rooms",
|
||||
"worlds", "sessions", "refresh_tokens", "users",
|
||||
)
|
||||
|
||||
BACKEND_DIR = Path(__file__).resolve().parents[1]
|
||||
_COMPOSE_PROJECT = "agp-pytest"
|
||||
|
||||
Binary file not shown.
BIN
Binary file not shown.
+105
@@ -0,0 +1,105 @@
|
||||
"""Generates the golden-file chunk fixtures in this directory.
|
||||
|
||||
These pin the world.md §3.6 binary format so the Python codec
|
||||
(app/services/chunk_codec.py) and any future Godot-side test fixture can be
|
||||
checked for drift (world_persistence_impl.md §5.5's "drift control"
|
||||
requirement). No Godot-side golden fixture existed at the time this was
|
||||
written (searched scripts/ and tests/ for AGPC / binary-format test
|
||||
vectors -- none found), so these are authored here, from this
|
||||
implementation, as the first golden files for the format. The client/editor
|
||||
follow-on task should decode these same files with
|
||||
`ChunkDataDecoder.decode_binary()` and assert the same logical values
|
||||
(see the note in chunk_codec.py about a confirmed float32 handling bug in
|
||||
that decoder that will need fixing for full byte parity on non-integer
|
||||
transforms).
|
||||
|
||||
Run with: `python tests/fixtures/chunks/generate_fixtures.py` from `backend/`.
|
||||
Fixtures are checked in; this script is for regenerating them if the format
|
||||
or these examples change, not run as part of the test suite.
|
||||
"""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parents[3])) # backend/
|
||||
|
||||
from app.services import chunk_codec as cc
|
||||
|
||||
FIXTURES_DIR = Path(__file__).resolve().parent
|
||||
|
||||
|
||||
def _empty_chunk() -> cc.ChunkPayload:
|
||||
return cc.ChunkPayload(
|
||||
world_id="7", room_id="main", coord=(0, 0, 0),
|
||||
bounds=cc.ChunkBounds(min=(0.0, 0.0, 0.0), size=(32.0, 32.0, 1.0)),
|
||||
tile_layers=[], objects=[],
|
||||
flags=cc.ContentFlags(),
|
||||
created_at=1_700_000_000, updated_at=1_700_000_000, revision=1, author="fixture-gen",
|
||||
)
|
||||
|
||||
|
||||
def _simple_tile_chunk() -> cc.ChunkPayload:
|
||||
layer = cc.TileLayer(
|
||||
name="ground", layer_id=0, width=4, height=4, depth=1,
|
||||
palette=[
|
||||
cc.TileDef(id=0, asset_id="", solid=False, flags=0, variants=1),
|
||||
cc.TileDef(id=1, asset_id="tiles/grass", solid=False, flags=1, variants=4),
|
||||
cc.TileDef(id=2, asset_id="tiles/stone", solid=True, flags=2, variants=2),
|
||||
],
|
||||
tiles=[0, 1, 1, 0, 1, 2, 2, 1, 1, 2, 2, 1, 0, 1, 1, 0],
|
||||
)
|
||||
return cc.ChunkPayload(
|
||||
world_id="12", room_id="main", coord=(3, -1, 0),
|
||||
bounds=cc.ChunkBounds(min=(96.0, -32.0, 0.0), size=(32.0, 32.0, 1.0)),
|
||||
tile_layers=[layer], objects=[],
|
||||
flags=cc.ContentFlags(violence=0, mature=False, sources=[]),
|
||||
created_at=1_700_000_000, updated_at=1_700_000_500, revision=2, author="fixture-gen",
|
||||
)
|
||||
|
||||
|
||||
def _chunk_with_objects() -> cc.ChunkPayload:
|
||||
layer = cc.TileLayer(
|
||||
name="ground", layer_id=0, width=2, height=2, depth=1,
|
||||
palette=[cc.TileDef(id=0, asset_id="", solid=False, flags=0, variants=1)],
|
||||
tiles=[0, 0, 0, 0],
|
||||
)
|
||||
obj1 = cc.WorldObject(
|
||||
id="obj_0001", type="interactable", asset_id="props/chest",
|
||||
pos=(101.5, -110.25, 0.5), rot=(0.0, 0.0, 0.0, 1.0), scale=(1.0, 1.0, 1.0),
|
||||
dynamic=False,
|
||||
properties={"locked": False, "loot_table": "chest_basic"},
|
||||
flags=cc.ContentFlags(violence=0, mature=False, sources=[]),
|
||||
)
|
||||
obj2 = cc.WorldObject(
|
||||
id="obj_0002", type="spawn_point", asset_id="",
|
||||
pos=(96.0, -128.0, 1.0), rot=(0.0, 0.7071, 0.0, 0.7071), scale=(1.0, 1.0, 1.0),
|
||||
dynamic=True,
|
||||
properties={},
|
||||
flags=cc.ContentFlags(violence=1, mature=False, sources=["asset:props/chest"]),
|
||||
)
|
||||
return cc.ChunkPayload(
|
||||
world_id="12", room_id="main", coord=(3, -4, 0),
|
||||
bounds=cc.ChunkBounds(min=(96.0, -128.0, 0.0), size=(32.0, 32.0, 1.0)),
|
||||
tile_layers=[layer], objects=[obj1, obj2],
|
||||
flags=cc.ContentFlags(violence=1, mature=False, sources=["asset:props/chest"]),
|
||||
created_at=1_700_000_000, updated_at=1_700_001_000, revision=5, author="agent-bot",
|
||||
)
|
||||
|
||||
|
||||
FIXTURES = {
|
||||
"empty_chunk.bin": _empty_chunk,
|
||||
"simple_tile_chunk.bin": _simple_tile_chunk,
|
||||
"chunk_with_objects.bin": _chunk_with_objects,
|
||||
}
|
||||
|
||||
|
||||
def main() -> None:
|
||||
for filename, builder in FIXTURES.items():
|
||||
payload = builder()
|
||||
data = cc.encode_binary(payload)
|
||||
(FIXTURES_DIR / filename).write_bytes(data)
|
||||
print(f"wrote {filename} ({len(data)} bytes)")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Binary file not shown.
@@ -0,0 +1,219 @@
|
||||
"""Tests for app.services.chunk_codec -- the Python port of world.md §3.6.
|
||||
|
||||
Pure unit tests: no database, no app, no network. Golden fixtures live in
|
||||
tests/fixtures/chunks/ (see generate_fixtures.py there for how/why).
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from app.services import chunk_codec as cc
|
||||
|
||||
FIXTURES_DIR = Path(__file__).resolve().parent / "fixtures" / "chunks"
|
||||
|
||||
|
||||
def _read_fixture(name: str) -> bytes:
|
||||
return (FIXTURES_DIR / name).read_bytes()
|
||||
|
||||
|
||||
class TestGoldenFixtures:
|
||||
"""Byte-stability: decode a committed fixture, re-encode it, and the
|
||||
bytes must match exactly (world.md §3.6.3)."""
|
||||
|
||||
@pytest.mark.parametrize("filename", [
|
||||
"empty_chunk.bin", "simple_tile_chunk.bin", "chunk_with_objects.bin",
|
||||
])
|
||||
def test_round_trip_is_byte_identical(self, filename):
|
||||
original = _read_fixture(filename)
|
||||
decoded = cc.decode_binary(original)
|
||||
re_encoded = cc.encode_binary(decoded)
|
||||
assert re_encoded == original
|
||||
|
||||
def test_simple_tile_chunk_logical_values(self):
|
||||
decoded = cc.decode_binary(_read_fixture("simple_tile_chunk.bin"))
|
||||
assert decoded.world_id == "12"
|
||||
assert decoded.room_id == "main"
|
||||
assert decoded.coord == (3, -1, 0)
|
||||
assert decoded.bounds.min == (96.0, -32.0, 0.0)
|
||||
assert decoded.bounds.size == (32.0, 32.0, 1.0)
|
||||
assert len(decoded.tile_layers) == 1
|
||||
layer = decoded.tile_layers[0]
|
||||
assert layer.name == "ground"
|
||||
assert (layer.width, layer.height, layer.depth) == (4, 4, 1)
|
||||
assert len(layer.palette) == 3
|
||||
assert layer.tiles == [0, 1, 1, 0, 1, 2, 2, 1, 1, 2, 2, 1, 0, 1, 1, 0]
|
||||
assert decoded.revision == 2
|
||||
assert decoded.author == "fixture-gen"
|
||||
|
||||
def test_chunk_with_objects_logical_values(self):
|
||||
decoded = cc.decode_binary(_read_fixture("chunk_with_objects.bin"))
|
||||
assert len(decoded.objects) == 2
|
||||
obj1, obj2 = decoded.objects
|
||||
assert obj1.id == "obj_0001"
|
||||
assert obj1.type == "interactable"
|
||||
assert obj1.pos == (101.5, -110.25, 0.5)
|
||||
assert obj1.properties == {"locked": False, "loot_table": "chest_basic"}
|
||||
assert obj2.id == "obj_0002"
|
||||
assert obj2.dynamic is True
|
||||
assert obj2.flags.violence == 1
|
||||
assert obj2.flags.sources == ["asset:props/chest"]
|
||||
assert decoded.flags.violence == 1
|
||||
assert decoded.flags.sources == ["asset:props/chest"]
|
||||
|
||||
def test_empty_chunk_has_no_layers_or_objects(self):
|
||||
decoded = cc.decode_binary(_read_fixture("empty_chunk.bin"))
|
||||
assert decoded.tile_layers == []
|
||||
assert decoded.objects == []
|
||||
|
||||
|
||||
class TestChecksum:
|
||||
def test_checksum_is_sha256_hex(self):
|
||||
import hashlib
|
||||
assert cc.checksum(b"") == hashlib.sha256(b"").hexdigest()
|
||||
assert len(cc.checksum(b"")) == 64
|
||||
|
||||
def test_header_checksum_matches_recomputed_for_valid_fixture(self):
|
||||
data = _read_fixture("simple_tile_chunk.bin")
|
||||
header_checksum_hex = data[16:48].hex()
|
||||
body = data[cc.HEADER_SIZE:]
|
||||
assert header_checksum_hex == cc.checksum(body)
|
||||
|
||||
|
||||
class TestBuildKey:
|
||||
def test_matches_world_persistence_impl_4_5_format(self):
|
||||
assert cc.build_key(12, "main", 3, -1, 0) == "12:main:3:-1:0"
|
||||
assert cc.build_key("12", "main", 3, -1, 0) == "12:main:3:-1:0"
|
||||
|
||||
|
||||
class TestFloat32Fidelity:
|
||||
"""This is the concrete regression test for the cross-codec divergence
|
||||
documented at the bottom of chunk_codec.py: this module must encode
|
||||
real IEEE-754 float32, including fractional and negative values,
|
||||
round-tripping exactly (up to float32 precision) -- unlike
|
||||
scripts/chunk_data_decoder.gd's current int-truncating implementation."""
|
||||
|
||||
def test_fractional_and_negative_floats_survive_round_trip(self):
|
||||
payload = cc.ChunkPayload(
|
||||
world_id="1", room_id="main", coord=(0, 0, 0),
|
||||
bounds=cc.ChunkBounds(min=(-17.25, 0.125, -3.0), size=(32.0, 32.0, 1.0)),
|
||||
objects=[cc.WorldObject(
|
||||
id="o1", type="prop", asset_id="a",
|
||||
pos=(1.5, -2.75, 0.001), rot=(0.0, 0.7071068, 0.0, 0.7071068),
|
||||
scale=(1.0, 1.0, 1.0),
|
||||
)],
|
||||
)
|
||||
encoded = cc.encode_binary(payload)
|
||||
decoded = cc.decode_binary(encoded)
|
||||
assert decoded.bounds.min == pytest.approx((-17.25, 0.125, -3.0), abs=1e-6)
|
||||
assert decoded.objects[0].pos == pytest.approx((1.5, -2.75, 0.001), abs=1e-6)
|
||||
assert decoded.objects[0].rot == pytest.approx(
|
||||
(0.0, 0.7071068, 0.0, 0.7071068), abs=1e-6
|
||||
)
|
||||
|
||||
|
||||
class TestMalformedInput:
|
||||
def test_bad_magic_raises_codec_error(self):
|
||||
data = bytearray(_read_fixture("empty_chunk.bin"))
|
||||
data[0:4] = b"XXXX"
|
||||
with pytest.raises(cc.ChunkCodecError):
|
||||
cc.decode_binary(bytes(data))
|
||||
|
||||
def test_too_short_raises_codec_error(self):
|
||||
with pytest.raises(cc.ChunkCodecError):
|
||||
cc.decode_binary(b"AGPC\x01\x00")
|
||||
|
||||
def test_unsupported_version_raises_codec_error(self):
|
||||
data = bytearray(_read_fixture("empty_chunk.bin"))
|
||||
data[4:6] = (99).to_bytes(2, "little")
|
||||
with pytest.raises(cc.ChunkCodecError):
|
||||
cc.decode_binary(bytes(data))
|
||||
|
||||
def test_payload_len_mismatch_raises_codec_error(self):
|
||||
data = bytearray(_read_fixture("empty_chunk.bin"))
|
||||
# Corrupt the declared payload_len (offset 12..16).
|
||||
data[12:16] = (99999).to_bytes(4, "little")
|
||||
with pytest.raises(cc.ChunkCodecError):
|
||||
cc.decode_binary(bytes(data))
|
||||
|
||||
|
||||
class TestValidation:
|
||||
"""decode_and_validate: the server-side "don't trust the client"
|
||||
boundary (world_persistence_impl.md §5.5)."""
|
||||
|
||||
def _valid_args(self):
|
||||
return {
|
||||
"expected_key": "12:main:3:-1:0",
|
||||
"grid_size": (4, 4, 1),
|
||||
"max_objects": 512,
|
||||
}
|
||||
|
||||
def test_valid_payload_passes(self):
|
||||
data = _read_fixture("simple_tile_chunk.bin")
|
||||
payload = cc.decode_and_validate(data, **self._valid_args())
|
||||
assert payload.coord == (3, -1, 0)
|
||||
|
||||
def test_checksum_mismatch_detected(self):
|
||||
data = bytearray(_read_fixture("simple_tile_chunk.bin"))
|
||||
# Corrupt one byte of the header's advisory checksum field
|
||||
# (offset 16..48) only -- magic/version/payload_len and the whole
|
||||
# payload body stay untouched, so this exercises exactly the
|
||||
# "recomputed checksum disagrees with the header" path rather than
|
||||
# also breaking structural decoding.
|
||||
data[16] ^= 0xFF
|
||||
with pytest.raises(cc.ChunkValidationError) as exc_info:
|
||||
cc.decode_and_validate(bytes(data), **self._valid_args())
|
||||
assert exc_info.value.reason == "checksum_mismatch"
|
||||
|
||||
def test_chunk_key_mismatch_detected(self):
|
||||
data = _read_fixture("simple_tile_chunk.bin")
|
||||
args = self._valid_args()
|
||||
args["expected_key"] = "12:main:99:99:0" # doesn't match the payload's own coord
|
||||
with pytest.raises(cc.ChunkValidationError) as exc_info:
|
||||
cc.decode_and_validate(data, **args)
|
||||
assert exc_info.value.reason == "chunk_key_mismatch"
|
||||
|
||||
def test_layer_dims_mismatch_detected(self):
|
||||
data = _read_fixture("simple_tile_chunk.bin")
|
||||
args = self._valid_args()
|
||||
args["grid_size"] = (8, 8, 1) # fixture's layer is 4x4x1
|
||||
with pytest.raises(cc.ChunkValidationError) as exc_info:
|
||||
cc.decode_and_validate(data, **args)
|
||||
assert exc_info.value.reason == "layer_dims"
|
||||
|
||||
def test_too_many_objects_detected(self):
|
||||
data = _read_fixture("chunk_with_objects.bin") # has 2 objects
|
||||
args = self._valid_args()
|
||||
args["expected_key"] = "12:main:3:-4:0"
|
||||
args["grid_size"] = (2, 2, 1)
|
||||
args["max_objects"] = 1
|
||||
with pytest.raises(cc.ChunkValidationError) as exc_info:
|
||||
cc.decode_and_validate(data, **args)
|
||||
assert exc_info.value.reason == "too_many_objects"
|
||||
|
||||
def test_object_out_of_bounds_detected(self):
|
||||
payload = cc.ChunkPayload(
|
||||
world_id="1", room_id="main", coord=(0, 0, 0),
|
||||
bounds=cc.ChunkBounds(min=(0.0, 0.0, 0.0), size=(32.0, 32.0, 1.0)),
|
||||
objects=[cc.WorldObject(id="o1", type="prop", asset_id="a", pos=(9999.0, 0.0, 0.0))],
|
||||
)
|
||||
data = cc.encode_binary(payload)
|
||||
with pytest.raises(cc.ChunkValidationError) as exc_info:
|
||||
cc.decode_and_validate(
|
||||
data, expected_key="1:main:0:0:0", grid_size=(32, 32, 1), max_objects=10
|
||||
)
|
||||
assert exc_info.value.reason == "object_out_of_bounds"
|
||||
|
||||
def test_tile_out_of_palette_detected(self):
|
||||
layer = cc.TileLayer(
|
||||
name="ground", width=2, height=2, depth=1,
|
||||
palette=[cc.TileDef(id=1)], # tile 5 below isn't in this palette
|
||||
tiles=[1, 5, 0, 1],
|
||||
)
|
||||
payload = cc.ChunkPayload(world_id="1", room_id="main", coord=(0, 0, 0), tile_layers=[layer])
|
||||
data = cc.encode_binary(payload)
|
||||
with pytest.raises(cc.ChunkValidationError) as exc_info:
|
||||
cc.decode_and_validate(
|
||||
data, expected_key="1:main:0:0:0", grid_size=(2, 2, 1), max_objects=10
|
||||
)
|
||||
assert exc_info.value.reason == "tile_out_of_palette"
|
||||
@@ -0,0 +1,153 @@
|
||||
"""Unit tests for the game_servers.py changes made for world persistence
|
||||
(world_persistence_impl.md §7.3/§7.4): per-spawn token validation, and the
|
||||
``_await_ready`` replacement for the old, fail-open ``_await_port``.
|
||||
|
||||
No real Godot process is spawned here (that stays a manual/checkpoint
|
||||
integration test, per test_world_join.py's docstring) -- these exercise
|
||||
``GameServerSupervisor`` against a fake process object standing in for
|
||||
``subprocess.Popen``.
|
||||
"""
|
||||
|
||||
import json
|
||||
|
||||
import pytest
|
||||
|
||||
from app.config import settings
|
||||
from app.services.game_servers import GameServerSupervisor, _WorldServer
|
||||
|
||||
|
||||
class _FakeProc:
|
||||
"""Stands in for subprocess.Popen: only .poll() is needed by the code
|
||||
paths under test here."""
|
||||
|
||||
def __init__(self, exited: bool = False):
|
||||
self._exited = exited
|
||||
|
||||
def poll(self):
|
||||
return 0 if self._exited else None
|
||||
|
||||
def terminate(self):
|
||||
self._exited = True
|
||||
|
||||
def wait(self, timeout=None):
|
||||
return 0
|
||||
|
||||
def kill(self):
|
||||
self._exited = True
|
||||
|
||||
|
||||
def _make_srv(tmp_path, token="secret", alive=True) -> _WorldServer:
|
||||
status_path = tmp_path / "status.json"
|
||||
return _WorldServer(
|
||||
world_id="7", port=27000, proc=_FakeProc(exited=not alive),
|
||||
status_path=status_path, token=token,
|
||||
)
|
||||
|
||||
|
||||
class TestValidateToken:
|
||||
def test_unknown_world_is_false(self):
|
||||
sup = GameServerSupervisor()
|
||||
assert sup.validate_token("no-such-world", "anything") is False
|
||||
|
||||
def test_correct_token_is_true(self, tmp_path):
|
||||
sup = GameServerSupervisor()
|
||||
sup._servers["7"] = _make_srv(tmp_path, token="secret")
|
||||
assert sup.validate_token("7", "secret") is True
|
||||
# world_id is looked up as str(world_id), so an int works too --
|
||||
# this matters because the FastAPI path param is an int.
|
||||
assert sup.validate_token(7, "secret") is True
|
||||
|
||||
def test_wrong_token_is_false(self, tmp_path):
|
||||
sup = GameServerSupervisor()
|
||||
sup._servers["7"] = _make_srv(tmp_path, token="secret")
|
||||
assert sup.validate_token("7", "wrong") is False
|
||||
|
||||
def test_token_scoped_to_its_own_world_only(self, tmp_path):
|
||||
sup = GameServerSupervisor()
|
||||
sup._servers["7"] = _make_srv(tmp_path, token="secret")
|
||||
# Same token, different world_id -- must not authenticate (§7.3:
|
||||
# "a path whose world_id differs from the token's world is 403").
|
||||
assert sup.validate_token("8", "secret") is False
|
||||
|
||||
def test_dead_server_token_is_false(self, tmp_path):
|
||||
sup = GameServerSupervisor()
|
||||
sup._servers["7"] = _make_srv(tmp_path, token="secret", alive=False)
|
||||
assert sup.validate_token("7", "secret") is False
|
||||
|
||||
def test_reaping_invalidates_the_token(self, tmp_path):
|
||||
"""§7.3: "dies with its process" -- once removed from _servers
|
||||
(what the reaper does), the same token no longer validates."""
|
||||
sup = GameServerSupervisor()
|
||||
sup._servers["7"] = _make_srv(tmp_path, token="secret")
|
||||
assert sup.validate_token("7", "secret") is True
|
||||
del sup._servers["7"]
|
||||
assert sup.validate_token("7", "secret") is False
|
||||
|
||||
|
||||
class TestAwaitReady:
|
||||
"""Replaces the old _await_port, which (a) treated a bound UDP port as
|
||||
readiness even though content loading happens before create_server, and
|
||||
(b) failed open past its deadline with no error at all."""
|
||||
|
||||
async def test_raises_timeout_error_when_never_ready(self, tmp_path, monkeypatch):
|
||||
monkeypatch.setattr(settings, "GAME_SERVER_READY_TIMEOUT_SECONDS", 0.3)
|
||||
sup = GameServerSupervisor()
|
||||
srv = _make_srv(tmp_path) # status file never written
|
||||
with pytest.raises(TimeoutError):
|
||||
await sup._await_ready(srv)
|
||||
|
||||
async def test_returns_once_status_file_reports_ready(self, tmp_path, monkeypatch):
|
||||
monkeypatch.setattr(settings, "GAME_SERVER_READY_TIMEOUT_SECONDS", 5.0)
|
||||
sup = GameServerSupervisor()
|
||||
srv = _make_srv(tmp_path)
|
||||
srv.status_path.write_text(json.dumps({"ready": True, "players": 0}))
|
||||
await sup._await_ready(srv) # must not raise / must not hang
|
||||
|
||||
async def test_ready_false_is_not_ready(self, tmp_path, monkeypatch):
|
||||
monkeypatch.setattr(settings, "GAME_SERVER_READY_TIMEOUT_SECONDS", 0.3)
|
||||
sup = GameServerSupervisor()
|
||||
srv = _make_srv(tmp_path)
|
||||
srv.status_path.write_text(json.dumps({"ready": False, "players": 0}))
|
||||
with pytest.raises(TimeoutError):
|
||||
await sup._await_ready(srv)
|
||||
|
||||
async def test_raises_promptly_if_process_already_exited(self, tmp_path, monkeypatch):
|
||||
# A long deadline, but the process is already dead -- must not wait
|
||||
# out the full deadline (this is the "no crash restart mid-wait"
|
||||
# case: don't silently poll a corpse for 20s).
|
||||
monkeypatch.setattr(settings, "GAME_SERVER_READY_TIMEOUT_SECONDS", 20.0)
|
||||
sup = GameServerSupervisor()
|
||||
srv = _make_srv(tmp_path, alive=False)
|
||||
with pytest.raises(TimeoutError):
|
||||
await sup._await_ready(srv)
|
||||
|
||||
|
||||
class TestSpawnCommandLine:
|
||||
def test_spawn_includes_api_url_and_server_token(self, monkeypatch, tmp_path):
|
||||
"""world_persistence_impl.md §7.2 step 1 / §7.4: `_spawn` must pass
|
||||
--api-url and --server-token on the command line."""
|
||||
sup = GameServerSupervisor()
|
||||
monkeypatch.setattr(sup, "_free_port", lambda: 27050)
|
||||
|
||||
captured = {}
|
||||
|
||||
class _Proc:
|
||||
def poll(self):
|
||||
return None
|
||||
|
||||
def _fake_popen(cmd, **kwargs):
|
||||
captured["cmd"] = cmd
|
||||
return _Proc()
|
||||
|
||||
monkeypatch.setattr(
|
||||
"app.services.game_servers.subprocess.Popen", _fake_popen
|
||||
)
|
||||
srv = sup._spawn("42")
|
||||
|
||||
cmd = captured["cmd"]
|
||||
assert "--api-url" in cmd
|
||||
assert cmd[cmd.index("--api-url") + 1] == settings.GAME_SERVER_INTERNAL_API_URL
|
||||
assert "--server-token" in cmd
|
||||
token_in_cmd = cmd[cmd.index("--server-token") + 1]
|
||||
assert token_in_cmd == srv.token
|
||||
assert len(srv.token) > 20 # secrets.token_urlsafe(32) -- not a short/guessable value
|
||||
@@ -0,0 +1,490 @@
|
||||
"""Integration tests for the world content API: rooms + chunks.
|
||||
|
||||
Covers docs/architecture/world_persistence_impl.md §8.1 (public router,
|
||||
app/routers/world_content.py) and §8.3 (internal router,
|
||||
app/routers/internal.py), plus the create_world -> auto "main" room
|
||||
behaviour (§4.1).
|
||||
|
||||
Runs against the real ephemeral Postgres the hermetic conftest.py stands
|
||||
up -- these are full HTTP round trips through TestClient, not mocked.
|
||||
"""
|
||||
|
||||
import base64
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from app.main import app
|
||||
from app.services import chunk_codec as cc
|
||||
from app.services.game_servers import supervisor
|
||||
|
||||
GRID_32 = (32, 32, 1)
|
||||
|
||||
|
||||
def _auth(client: TestClient, name: str) -> tuple[dict, int]:
|
||||
r = client.post("/api/auth/register", json={
|
||||
"username": name, "email": f"{name}@e.com", "password": "secret123",
|
||||
"date_of_birth": "1990-01-01",
|
||||
})
|
||||
assert r.status_code == 201, r.text
|
||||
headers = {"Authorization": f"Bearer {r.json()['access_token']}"}
|
||||
me = client.get("/api/users/me", headers=headers)
|
||||
return headers, me.json()["id"]
|
||||
|
||||
|
||||
def _make_world(client: TestClient, headers: dict, visibility: str = "public") -> int:
|
||||
r = client.post("/api/worlds/", headers=headers, json={"name": "W", "visibility": visibility})
|
||||
assert r.status_code == 201, r.text
|
||||
return r.json()["id"]
|
||||
|
||||
|
||||
def _build_chunk(world_id: int, slug: str, cx: int, cy: int, cz: int, *,
|
||||
grid=GRID_32, revision: int = 1, extra_tag: str = "") -> bytes:
|
||||
"""A small but structurally-real chunk payload for `world_id`/`slug`/coord,
|
||||
sized to match the room's default 32x32x1 grid."""
|
||||
w, h, d = grid
|
||||
layer = cc.TileLayer(
|
||||
name="ground", layer_id=0, width=w, height=h, depth=d,
|
||||
palette=[cc.TileDef(id=0, asset_id="", solid=False, flags=0, variants=1)],
|
||||
tiles=[0] * (w * h * d),
|
||||
)
|
||||
obj = cc.WorldObject(
|
||||
id=f"obj_{extra_tag or '1'}", type="prop", asset_id="props/rock",
|
||||
pos=(1.0, 1.0, 0.0), properties={"tag": extra_tag},
|
||||
)
|
||||
payload = cc.ChunkPayload(
|
||||
world_id=str(world_id), room_id=slug, coord=(cx, cy, cz),
|
||||
bounds=cc.ChunkBounds(min=(0.0, 0.0, 0.0), size=(float(w), float(h), float(d))),
|
||||
tile_layers=[layer], objects=[obj], revision=revision, author="pytest",
|
||||
created_at=1_700_000_000, updated_at=1_700_000_000,
|
||||
)
|
||||
return cc.encode_binary(payload)
|
||||
|
||||
|
||||
class TestCreateWorldMainRoom:
|
||||
def test_create_world_auto_creates_main_room(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "cw_main")
|
||||
wid = _make_world(client, headers)
|
||||
|
||||
r = client.get(f"/api/worlds/{wid}/rooms", headers=headers)
|
||||
assert r.status_code == 200, r.text
|
||||
rooms = r.json()
|
||||
assert len(rooms) == 1
|
||||
assert rooms[0]["slug"] == "main"
|
||||
assert rooms[0]["name"] == "Main"
|
||||
assert rooms[0]["chunk_count"] == 0
|
||||
assert rooms[0]["grid"]["size"] == [32, 32, 1]
|
||||
|
||||
|
||||
class TestRoomAuth:
|
||||
def test_create_room_requires_owner(self):
|
||||
client = TestClient(app)
|
||||
owner_headers, _ = _auth(client, "room_owner")
|
||||
wid = _make_world(client, owner_headers)
|
||||
other_headers, _ = _auth(client, "room_other")
|
||||
r = client.post(f"/api/worlds/{wid}/rooms", headers=other_headers,
|
||||
json={"slug": "annex", "name": "Annex"})
|
||||
assert r.status_code == 403
|
||||
|
||||
def test_list_rooms_of_private_world_is_404_for_non_owner(self):
|
||||
client = TestClient(app)
|
||||
owner_headers, _ = _auth(client, "room_priv_owner")
|
||||
wid = _make_world(client, owner_headers, "private")
|
||||
other_headers, _ = _auth(client, "room_priv_other")
|
||||
r = client.get(f"/api/worlds/{wid}/rooms", headers=other_headers)
|
||||
assert r.status_code == 404
|
||||
|
||||
|
||||
class TestChunkPutGetRoundTrip:
|
||||
def test_binary_put_then_binary_get_round_trips(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_rt")
|
||||
wid = _make_world(client, headers)
|
||||
payload = _build_chunk(wid, "main", 0, 0, 0)
|
||||
|
||||
r = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/0/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
assert r.status_code == 200, r.text
|
||||
body = r.json()
|
||||
assert body["revision"] == 1
|
||||
assert body["payload_len"] == len(payload)
|
||||
assert body["checksum"] == cc.checksum(payload[cc.HEADER_SIZE:])
|
||||
assert body["live_session"] is False
|
||||
|
||||
g = client.get(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/0/0/0",
|
||||
headers={**headers, "Accept": "application/octet-stream"},
|
||||
)
|
||||
assert g.status_code == 200
|
||||
assert g.content == payload
|
||||
assert g.headers["ETag"] == f'"{body["checksum"]}"'
|
||||
assert g.headers["X-Chunk-Revision"] == "1"
|
||||
|
||||
def test_json_accept_returns_decoded_shape(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_json")
|
||||
wid = _make_world(client, headers)
|
||||
payload = _build_chunk(wid, "main", 1, 1, 0)
|
||||
client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/1/1/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
g = client.get(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/1/1/0",
|
||||
headers={**headers, "Accept": "application/json"},
|
||||
)
|
||||
assert g.status_code == 200
|
||||
data = g.json()
|
||||
assert data["coord"] == {"cx": 1, "cy": 1, "cz": 0}
|
||||
assert data["world_id"] == str(wid)
|
||||
assert data["room_id"] == "main"
|
||||
assert len(data["objects"]) == 1
|
||||
|
||||
def test_json_put_with_base64_payload(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_json_put")
|
||||
wid = _make_world(client, headers)
|
||||
payload = _build_chunk(wid, "main", 2, 2, 0)
|
||||
r = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/2/2/0", headers=headers,
|
||||
json={"base_revision": 0, "payload_b64": base64.b64encode(payload).decode()},
|
||||
)
|
||||
assert r.status_code == 200, r.text
|
||||
assert r.json()["revision"] == 1
|
||||
|
||||
def test_if_none_match_returns_304(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_304")
|
||||
wid = _make_world(client, headers)
|
||||
payload = _build_chunk(wid, "main", 3, 3, 0)
|
||||
put = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/3/3/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
checksum = put.json()["checksum"]
|
||||
g = client.get(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/3/3/0",
|
||||
headers={**headers, "If-None-Match": f'"{checksum}"'},
|
||||
)
|
||||
assert g.status_code == 304
|
||||
|
||||
def test_unwritten_coordinate_is_404(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_404")
|
||||
wid = _make_world(client, headers)
|
||||
g = client.get(f"/api/worlds/{wid}/rooms/main/chunks/9/9/0", headers=headers)
|
||||
assert g.status_code == 404
|
||||
|
||||
|
||||
class TestRevisionConflict:
|
||||
def test_create_conflict_when_chunk_already_exists(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "conflict_create")
|
||||
wid = _make_world(client, headers)
|
||||
payload = _build_chunk(wid, "main", 4, 4, 0)
|
||||
first = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/4/4/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
assert first.status_code == 200
|
||||
|
||||
second = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/4/4/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
assert second.status_code == 409
|
||||
body = second.json()
|
||||
assert body["detail"] == "revision conflict"
|
||||
assert body["current_revision"] == 1
|
||||
|
||||
def test_stale_base_revision_conflict_reports_current_state(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "conflict_stale")
|
||||
wid = _make_world(client, headers)
|
||||
payload_v1 = _build_chunk(wid, "main", 5, 5, 0, revision=1)
|
||||
client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/5/5/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload_v1,
|
||||
)
|
||||
payload_v2 = _build_chunk(wid, "main", 5, 5, 0, revision=2, extra_tag="v2")
|
||||
r2 = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/5/5/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "1"},
|
||||
content=payload_v2,
|
||||
)
|
||||
assert r2.status_code == 200
|
||||
assert r2.json()["revision"] == 2
|
||||
|
||||
# Now retry with the now-stale base_revision=1 again.
|
||||
payload_v3 = _build_chunk(wid, "main", 5, 5, 0, revision=3, extra_tag="v3")
|
||||
stale = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/5/5/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "1"},
|
||||
content=payload_v3,
|
||||
)
|
||||
assert stale.status_code == 409
|
||||
body = stale.json()
|
||||
assert body["current_revision"] == 2
|
||||
assert body["current_checksum"] == r2.json()["checksum"]
|
||||
|
||||
|
||||
class TestBatchWrite:
|
||||
def test_batch_put_all_succeed(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "batch_ok")
|
||||
wid = _make_world(client, headers)
|
||||
chunks = [
|
||||
{"cx": cx, "cy": 0, "cz": 0, "base_revision": 0,
|
||||
"payload_b64": base64.b64encode(_build_chunk(wid, "main", cx, 0, 0)).decode()}
|
||||
for cx in (10, 11)
|
||||
]
|
||||
r = client.put(f"/api/worlds/{wid}/rooms/main/chunks", headers=headers, json={"chunks": chunks})
|
||||
assert r.status_code == 200, r.text
|
||||
body = r.json()
|
||||
assert len(body["chunks"]) == 2
|
||||
assert all(c["revision"] == 1 for c in body["chunks"])
|
||||
|
||||
idx = client.get(f"/api/worlds/{wid}/rooms/main/chunks", headers=headers)
|
||||
keys = {c["key"] for c in idx.json()["chunks"]}
|
||||
assert f"{wid}:main:10:0:0" in keys
|
||||
assert f"{wid}:main:11:0:0" in keys
|
||||
|
||||
def test_batch_put_is_all_or_nothing_on_conflict(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "batch_conflict")
|
||||
wid = _make_world(client, headers)
|
||||
|
||||
# Pre-create one of the two coordinates so the batch's base_revision=0
|
||||
# for it will conflict.
|
||||
pre = _build_chunk(wid, "main", 20, 0, 0)
|
||||
client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/20/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=pre,
|
||||
)
|
||||
|
||||
chunks = [
|
||||
{"cx": 21, "cy": 0, "cz": 0, "base_revision": 0,
|
||||
"payload_b64": base64.b64encode(_build_chunk(wid, "main", 21, 0, 0)).decode()},
|
||||
{"cx": 20, "cy": 0, "cz": 0, "base_revision": 0, # conflicts: already exists at revision 1
|
||||
"payload_b64": base64.b64encode(_build_chunk(wid, "main", 20, 0, 0, extra_tag="v2")).decode()},
|
||||
]
|
||||
r = client.put(f"/api/worlds/{wid}/rooms/main/chunks", headers=headers, json={"chunks": chunks})
|
||||
assert r.status_code == 409
|
||||
|
||||
# Nothing from this batch should have been persisted -- (21,0,0)
|
||||
# must NOT exist even though it was valid and came first.
|
||||
g = client.get(f"/api/worlds/{wid}/rooms/main/chunks/21/0/0", headers=headers)
|
||||
assert g.status_code == 404
|
||||
|
||||
|
||||
class TestDelete:
|
||||
def test_delete_then_get_is_404(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_delete")
|
||||
wid = _make_world(client, headers)
|
||||
payload = _build_chunk(wid, "main", 30, 0, 0)
|
||||
client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/30/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
d = client.delete(f"/api/worlds/{wid}/rooms/main/chunks/30/0/0", headers=headers)
|
||||
assert d.status_code == 204
|
||||
g = client.get(f"/api/worlds/{wid}/rooms/main/chunks/30/0/0", headers=headers)
|
||||
assert g.status_code == 404
|
||||
|
||||
|
||||
class TestRevisionsAndRollback:
|
||||
def test_revisions_then_rollback(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_rollback")
|
||||
wid = _make_world(client, headers)
|
||||
v1 = _build_chunk(wid, "main", 40, 0, 0, revision=1)
|
||||
r1 = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/40/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=v1,
|
||||
)
|
||||
v2 = _build_chunk(wid, "main", 40, 0, 0, revision=2, extra_tag="v2")
|
||||
r2 = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/40/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "1"},
|
||||
content=v2,
|
||||
)
|
||||
assert r2.status_code == 200
|
||||
|
||||
revs = client.get(f"/api/worlds/{wid}/rooms/main/chunks/40/0/0/revisions", headers=headers)
|
||||
assert revs.status_code == 200
|
||||
rev_numbers = [row["revision"] for row in revs.json()]
|
||||
assert 1 in rev_numbers and 2 in rev_numbers
|
||||
|
||||
rb = client.post(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/40/0/0/rollback",
|
||||
headers=headers, json={"revision": 1},
|
||||
)
|
||||
assert rb.status_code == 200, rb.text
|
||||
assert rb.json()["revision"] == 3 # a new revision, restoring v1's content
|
||||
assert rb.json()["checksum"] == r1.json()["checksum"]
|
||||
|
||||
def test_revisions_requires_owner(self):
|
||||
client = TestClient(app)
|
||||
owner_headers, _ = _auth(client, "revisions_owner")
|
||||
wid = _make_world(client, owner_headers)
|
||||
payload = _build_chunk(wid, "main", 41, 0, 0)
|
||||
client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/41/0/0",
|
||||
headers={**owner_headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
other_headers, _ = _auth(client, "revisions_other")
|
||||
r = client.get(f"/api/worlds/{wid}/rooms/main/chunks/41/0/0/revisions", headers=other_headers)
|
||||
assert r.status_code == 403
|
||||
|
||||
|
||||
class TestValidationErrors:
|
||||
def test_malformed_payload_is_422(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_malformed")
|
||||
wid = _make_world(client, headers)
|
||||
r = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/0/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=b"not a real chunk",
|
||||
)
|
||||
assert r.status_code == 422
|
||||
assert r.json()["reason"] == "malformed"
|
||||
|
||||
def test_wrong_grid_size_is_422_layer_dims(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_layerdims")
|
||||
wid = _make_world(client, headers)
|
||||
# Room's default grid is 32x32x1; build a chunk sized for 4x4x1.
|
||||
payload = _build_chunk(wid, "main", 0, 0, 0, grid=(4, 4, 1))
|
||||
r = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/0/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
assert r.status_code == 422
|
||||
assert r.json()["reason"] == "layer_dims"
|
||||
|
||||
def test_oversized_payload_is_413(self, monkeypatch):
|
||||
from app.config import settings
|
||||
monkeypatch.setattr(settings, "WORLD_CHUNK_MAX_PAYLOAD_BYTES", 10)
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "chunk_413")
|
||||
wid = _make_world(client, headers)
|
||||
payload = _build_chunk(wid, "main", 0, 0, 0)
|
||||
r = client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/0/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
assert r.status_code == 413
|
||||
|
||||
|
||||
class TestInternalApi:
|
||||
"""docs/architecture/world_persistence_impl.md §7/§8.3. No real Godot
|
||||
process is spawned in this test env (GAME_SERVERS_ENABLED=False); we
|
||||
register a fake in-memory server entry with a known token to exercise
|
||||
require_game_server without needing a live process."""
|
||||
|
||||
@pytest.fixture
|
||||
def fake_server_token(self):
|
||||
# NB: a class body can't read a same-named local from the
|
||||
# enclosing function via `token = token` (class bodies use LOAD_NAME,
|
||||
# which skips enclosing function scopes) -- use a literal instead.
|
||||
world_id_str = "internal-test-world"
|
||||
|
||||
class _FakeSrv:
|
||||
def alive(self_inner):
|
||||
return True
|
||||
token = "test-internal-token-12345"
|
||||
|
||||
supervisor._servers[world_id_str] = _FakeSrv()
|
||||
yield _FakeSrv.token
|
||||
supervisor._servers.pop(world_id_str, None)
|
||||
|
||||
def test_missing_token_is_401(self):
|
||||
client = TestClient(app)
|
||||
r = client.get("/api/internal/worlds/1/manifest")
|
||||
assert r.status_code == 401
|
||||
|
||||
def test_wrong_token_is_403(self):
|
||||
client = TestClient(app)
|
||||
r = client.get(
|
||||
"/api/internal/worlds/1/manifest",
|
||||
headers={"Authorization": "Bearer not-the-real-token"},
|
||||
)
|
||||
assert r.status_code == 403
|
||||
|
||||
def test_valid_token_but_wrong_world_id_is_403(self, fake_server_token):
|
||||
# The fake token is registered under world_id "internal-test-world";
|
||||
# a request for a different world_id must not authenticate.
|
||||
client = TestClient(app)
|
||||
r = client.get(
|
||||
"/api/internal/worlds/999999/manifest",
|
||||
headers={"Authorization": f"Bearer {fake_server_token}"},
|
||||
)
|
||||
assert r.status_code == 403
|
||||
|
||||
def test_valid_token_reaches_manifest_for_real_world(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "internal_manifest")
|
||||
wid = _make_world(client, headers)
|
||||
|
||||
class _FakeSrv:
|
||||
def alive(self_inner):
|
||||
return True
|
||||
token = "another-real-token"
|
||||
|
||||
supervisor._servers[str(wid)] = _FakeSrv()
|
||||
try:
|
||||
r = client.get(
|
||||
f"/api/internal/worlds/{wid}/manifest",
|
||||
headers={"Authorization": "Bearer another-real-token"},
|
||||
)
|
||||
assert r.status_code == 200, r.text
|
||||
body = r.json()
|
||||
assert body["world_id"] == wid
|
||||
assert len(body["rooms"]) == 1
|
||||
assert body["rooms"][0]["slug"] == "main"
|
||||
finally:
|
||||
supervisor._servers.pop(str(wid), None)
|
||||
|
||||
def test_internal_chunk_fetch_returns_binary(self):
|
||||
client = TestClient(app)
|
||||
headers, _ = _auth(client, "internal_chunk")
|
||||
wid = _make_world(client, headers)
|
||||
payload = _build_chunk(wid, "main", 0, 0, 0)
|
||||
client.put(
|
||||
f"/api/worlds/{wid}/rooms/main/chunks/0/0/0",
|
||||
headers={**headers, "Content-Type": "application/octet-stream", "X-Base-Revision": "0"},
|
||||
content=payload,
|
||||
)
|
||||
|
||||
class _FakeSrv:
|
||||
def alive(self_inner):
|
||||
return True
|
||||
token = "internal-chunk-token"
|
||||
|
||||
supervisor._servers[str(wid)] = _FakeSrv()
|
||||
try:
|
||||
r = client.get(
|
||||
f"/api/internal/worlds/{wid}/rooms/main/chunks/0/0/0",
|
||||
headers={"Authorization": "Bearer internal-chunk-token"},
|
||||
)
|
||||
assert r.status_code == 200
|
||||
assert r.content == payload
|
||||
finally:
|
||||
supervisor._servers.pop(str(wid), None)
|
||||
@@ -4,6 +4,11 @@
|
||||
> **Owner:** Platform team
|
||||
> **Related:** World chunk data format & persistence, server authority + client
|
||||
> prediction, content moderation & age verification, avatar component system
|
||||
> **Note:** the recommendation here stands, but edits do **not** ride the
|
||||
> `request_chunk_edit` ENet RPC (§4.2, §7.4). Per
|
||||
> [`world_persistence_impl.md`](world_persistence_impl.md) the editor saves
|
||||
> chunks over HTTP to the FastAPI backend, which is the sole writer; the
|
||||
> validation/moderation boundary moves with it.
|
||||
> **Godot version:** 4.6.2 stable
|
||||
|
||||
## 1. Overview
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
# World Chunk Data Format & Persistence Architecture
|
||||
|
||||
> **Status:** Proposed
|
||||
> **Status:** Proposed. The chunk format (§2, §3) is normative and implemented
|
||||
> on the client. **§4 (SQLite schema) and §5 (write ownership / write-behind)
|
||||
> are superseded by [`world_persistence_impl.md`](world_persistence_impl.md)**,
|
||||
> which stores chunks in the existing Postgres backend and makes the FastAPI
|
||||
> process — not the per-world Godot server — the sole writer.
|
||||
> **Owner:** Platform team
|
||||
> **Related:** Server authority + client prediction, avatar component system, content moderation & age verification, backend auth (JWT)
|
||||
|
||||
|
||||
@@ -0,0 +1,655 @@
|
||||
# World Persistence: Server-Side Implementation Architecture
|
||||
|
||||
> **Status:** Accepted (design). Implementation is split across two follow-on
|
||||
> tasks (backend endpoints; editor wiring).
|
||||
> **Owner:** Platform team
|
||||
> **Supersedes:** the *storage engine* and *write ownership* parts of
|
||||
> [`world.md`](world.md) §4 and §5. Everything else in `world.md` — the chunk
|
||||
> logical model, the JSON and binary encodings, checksums, revisions, content
|
||||
> flags — stands unchanged and is normative.
|
||||
> **Related:** [`world.md`](world.md) (chunk format), [`editor.md`](editor.md)
|
||||
> (authoring surface), [`networking.md`](networking.md) (ENet sim transport),
|
||||
> [`content_moderation.md`](content_moderation.md) (flags & gating).
|
||||
|
||||
## 1. Why this document exists
|
||||
|
||||
`world.md` was written during the client-side chunk-streaming work (M2). It
|
||||
assumes **one** server that owns **one** embedded SQLite file and is both the
|
||||
authoritative simulation and the authoritative store. That is not the system we
|
||||
built. What actually exists today is:
|
||||
|
||||
| Process | Lifetime | Owns | Code |
|
||||
|---|---|---|---|
|
||||
| FastAPI backend | always on, single worker | Postgres (users, worlds, assets, avatar loadouts), game-server orchestration | `backend/app/` |
|
||||
| Godot dedicated server, one per world | **spawned on join, reaped ~5 min after the last join when empty** | nothing durable; a 30 Hz in-memory player sim | `scripts/server.gd`, spawned by `backend/app/services/game_servers.py` |
|
||||
| Godot client | player session | local chunk streaming, the in-game editor (planned) | `scripts/chunk_stream_manager.gd`, `scripts/chunk_data_decoder.gd` |
|
||||
|
||||
Nothing server-side has ever stored or served a real chunk. `server.gd`
|
||||
`preload()`s `res://scenes/worlds/test_level.tscn` for **every** world and uses
|
||||
`world_id` only for logging and the status file. `ChunkStreamManager` has a
|
||||
`set_server_rpc()` seam that no code calls. The backend's `World` model is
|
||||
metadata only (`id`, `name`, `description`, `owner_id`, `visibility`).
|
||||
|
||||
This document decides where chunk content lives, who may write it, how the
|
||||
dedicated server gets it, and the exact API surface — so the two implementation
|
||||
tasks that follow have no architectural decisions left to make.
|
||||
|
||||
---
|
||||
|
||||
## 2. Decisions at a glance
|
||||
|
||||
| # | Question | Decision |
|
||||
|---|---|---|
|
||||
| D1 | Where does chunk data live at rest? | **Postgres**, in the existing backend database. Not a per-world SQLite file. |
|
||||
| D2 | Who writes it? | **The FastAPI backend, exclusively.** The editor writes through it over HTTP with optimistic concurrency. The dedicated Godot server never writes world content. |
|
||||
| D3 | How does the dedicated server get content? | **HTTP pull from the backend at startup**, over a loopback-only `/api/internal` route authenticated by a per-spawn token the supervisor mints. Lazy fetch as players roam. |
|
||||
| D4 | Edit while a live session exists? | **Out of scope this milestone, with a defined seam.** The editor is a non-joined client mode; writes always succeed and the response flags `live_session` so the UI can say "players see this when the session restarts". |
|
||||
| D5 | Edit granularity on the wire | **Full-chunk PUT with `base_revision`**, not RFC-6902 deltas. |
|
||||
| D6 | Client chunk transport | **HTTP from the backend**, not ENet from the dedicated server. The `set_server_rpc()` seam is satisfied by an HTTP-backed adapter. |
|
||||
|
||||
---
|
||||
|
||||
## 3. D1 — Chunk data lives in Postgres
|
||||
|
||||
### 3.1 Decision
|
||||
|
||||
World content (rooms, chunk payloads, chunk revisions) is stored in the
|
||||
**existing Postgres database**, alongside `worlds`, in new tables created by an
|
||||
Alembic migration. `world.md` §4's `world.db` SQLite file is **not** built.
|
||||
|
||||
The chunk **payload stays exactly what `world.md` §3.6 specifies**: the 48-byte
|
||||
header + sectioned binary body, checksummed with SHA-256. It moves from a
|
||||
SQLite `BLOB` to a Postgres `BYTEA`. Nothing about the format changes, so
|
||||
`scripts/chunk_data_decoder.gd` remains correct and the format spec stays the
|
||||
single contract.
|
||||
|
||||
### 3.2 Reasoning
|
||||
|
||||
1. **SQLite's premise does not hold here.** `world.md` §4 justifies SQLite as
|
||||
"ideal for a server that owns the world store". No process in this system
|
||||
owns a world store: the only process that could plausibly hold the file (the
|
||||
dedicated Godot server) is *ephemeral* — reaped when idle, `SIGTERM`'d on
|
||||
backend shutdown, `SIGKILL`'d 10 s later if it doesn't exit, and orphaned
|
||||
entirely if the backend dies. Meanwhile the editor must write when no such
|
||||
process exists. So the file would have to be shared by two processes with
|
||||
independent lifetimes, which is precisely the workload SQLite's
|
||||
single-writer/file-lock model handles worst.
|
||||
2. **Postgres is already a hard dependency; SQLite would be a second one.** The
|
||||
backend cannot start without Postgres. Adding a per-world SQLite file adds a
|
||||
second storage engine, a second migration system (`world.md` §4.8 specifies a
|
||||
hand-rolled `meta.schema_version` runner *next to* the Alembic we already
|
||||
have), a second backup story, and a second consistency story.
|
||||
3. **Referential integrity with metadata we already have.** `worlds` rows carry
|
||||
`owner_id` and `visibility`, and every authorization rule for content derives
|
||||
from them. In one database this is a join and a foreign key with
|
||||
`ON DELETE CASCADE`; across two engines, deleting a world silently orphans a
|
||||
file on disk and every ownership check becomes a cross-store read.
|
||||
4. **Concurrency is the normal case, not the edge case.** Two creators editing
|
||||
one world, or an editor writing while the backend serves chunks to a running
|
||||
dedicated server, are ordinary. Postgres gives row-level MVCC and real
|
||||
transactions for the read-modify-write in §5.4; SQLite gives a database-level
|
||||
write lock and `SQLITE_BUSY`.
|
||||
5. **The repo already has the precedent and the plumbing.** `avatar_loadouts`
|
||||
(migration `0004`) stores a client-shaped document in Postgres JSONB rather
|
||||
than inventing a side store, and `backend/app/database.py` already provides
|
||||
the async session factory this code will use.
|
||||
|
||||
### 3.3 What we give up, and why it's acceptable
|
||||
|
||||
- **Zero-config embedding.** Irrelevant — the backend already requires a
|
||||
configured Postgres.
|
||||
- **`world.md` §5.5 write-behind + the `dirty` column.** Deliberately dropped
|
||||
(§4.4). It existed to amortize disk I/O for a process that owned the file. Our
|
||||
writes are human-rate editor saves, not sim-rate; each one is a single
|
||||
transaction and is durable when the HTTP response returns. Dropping it also
|
||||
deletes the entire "unclean shutdown recovery" scan in §5.5 — there is no
|
||||
window in which committed content can be lost.
|
||||
- **Sharding by `world_id` (`world.md` §8).** Postgres partitioning by
|
||||
`world_id` remains available on the same table shape if a single table ever
|
||||
becomes a bottleneck. At ~2–8 KB per chunk, 10 000 chunks is under 100 MB.
|
||||
|
||||
---
|
||||
|
||||
## 4. Schema (Alembic migration `0005_add_world_content_tables`)
|
||||
|
||||
New model module: `backend/app/models/world_content.py`, registered in
|
||||
`backend/app/models/__init__.py`. `backend/app/models/world.py` is left alone
|
||||
except for one added relationship, so nothing PC1/PC2 depends on moves.
|
||||
|
||||
Conventions follow the existing models: `Column(...)` declarative style,
|
||||
`Integer` surrogate PKs, `DateTime(timezone=True)` with `server_default=func.now()`,
|
||||
JSONB for document-shaped fields (as `avatar_loadout.py` does).
|
||||
|
||||
### 4.1 `world_rooms`
|
||||
|
||||
```python
|
||||
class WorldRoom(Base):
|
||||
__tablename__ = "world_rooms"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
world_id = Column(Integer, ForeignKey("worlds.id", ondelete="CASCADE"),
|
||||
nullable=False, index=True)
|
||||
slug = Column(String(64), nullable=False) # url-safe; "main" by default
|
||||
name = Column(String(255), nullable=False)
|
||||
# Chunk grid config. world.md §2.2 puts this on the world; it lives on the
|
||||
# room so a world can later hold rooms with different grids, and so this
|
||||
# migration is purely additive (the existing `worlds` table is untouched).
|
||||
grid = Column(JSONB, nullable=False,
|
||||
server_default='{"size": [32, 32, 1], "origin": [0, 0, 0]}')
|
||||
bounds = Column(JSONB, nullable=True) # {"min":[x,y,z], "max":[x,y,z]}; null = unbounded
|
||||
spawn = Column(JSONB, nullable=True) # {"pos":[x,y,z], "yaw": 0.0}
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
updated_at = Column(DateTime(timezone=True), server_default=func.now(),
|
||||
onupdate=func.now(), nullable=False)
|
||||
|
||||
__table_args__ = (UniqueConstraint("world_id", "slug", name="uq_world_rooms_world_slug"),)
|
||||
```
|
||||
|
||||
`World` gains
|
||||
`rooms = relationship("WorldRoom", back_populates="world", cascade="all, delete-orphan")`.
|
||||
|
||||
Every world gets a `main` room: created in `create_world`, and lazily created on
|
||||
first room read/write for worlds that predate the migration. `grid` defaults
|
||||
match `Chunk.CHUNK_SIZE_*` in `scripts/chunk.gd`, which is the client's source
|
||||
of truth for the same constants.
|
||||
|
||||
### 4.2 `world_chunks`
|
||||
|
||||
```python
|
||||
class WorldChunk(Base):
|
||||
__tablename__ = "world_chunks"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
world_id = Column(Integer, ForeignKey("worlds.id", ondelete="CASCADE"),
|
||||
nullable=False, index=True) # denormalized: world-scoped queries
|
||||
room_id = Column(Integer, ForeignKey("world_rooms.id", ondelete="CASCADE"),
|
||||
nullable=False, index=True)
|
||||
chunk_key = Column(String(160), nullable=False, unique=True) # see §4.5
|
||||
cx = Column(Integer, nullable=False)
|
||||
cy = Column(Integer, nullable=False)
|
||||
cz = Column(Integer, nullable=False, server_default="0")
|
||||
|
||||
format_version = Column(Integer, nullable=False, server_default="1")
|
||||
payload = Column(LargeBinary, nullable=False) # world.md §3.6 bytes, BYTEA
|
||||
payload_len = Column(Integer, nullable=False)
|
||||
checksum = Column(String(64), nullable=False) # SHA-256 hex of payload body
|
||||
revision = Column(Integer, nullable=False, server_default="1")
|
||||
|
||||
content_flags = Column(JSONB, nullable=False, server_default="{}") # world.md §3.4
|
||||
is_mature = Column(Boolean, nullable=False, server_default="false")
|
||||
|
||||
updated_by_id = Column(Integer, ForeignKey("users.id", ondelete="SET NULL"), nullable=True)
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
updated_at = Column(DateTime(timezone=True), server_default=func.now(),
|
||||
onupdate=func.now(), nullable=False)
|
||||
|
||||
__table_args__ = (
|
||||
UniqueConstraint("room_id", "cx", "cy", "cz", name="uq_world_chunks_coord"),
|
||||
Index("ix_world_chunks_room_coord", "room_id", "cx", "cy", "cz"),
|
||||
Index("ix_world_chunks_mature", "world_id", postgresql_where=text("is_mature")),
|
||||
)
|
||||
```
|
||||
|
||||
Deltas from `world.md` §4.4:
|
||||
|
||||
- **Surrogate `id` PK + unique coordinate constraint**, with `chunk_key` kept as
|
||||
a unique denormalized column. The key string is the client-facing contract
|
||||
(`Chunk.build_key`) and is embedded in the payload, so storing it gives a
|
||||
single-index lookup by key; the coordinate constraint is what actually
|
||||
enforces one chunk per cell.
|
||||
- **`dirty` removed** — see §3.3.
|
||||
- **Content flags folded into the chunk row as JSONB + an indexed `is_mature`
|
||||
boolean**, instead of `world.md` §4.6's separate 11-column `content_flags`
|
||||
table. The flags are a document the client already produces in exactly this
|
||||
shape (`ChunkDataDecoder.ContentFlags.to_dict()`), the only query we anticipate
|
||||
is "is this mature", and folding them in removes a second write per save and
|
||||
the `object_id = ''` sentinel hack that §4.6 needed to work around SQLite's
|
||||
NULL-in-primary-key behaviour (Postgres has the same NULL semantics, so the
|
||||
hack would have carried over).
|
||||
- **`world.md` §4.5 `chunk_objects` is deferred, not dropped.** It is a derived
|
||||
index that exists to answer queries ("which chunks contain a door?") that no
|
||||
code asks yet, and maintaining it means a delete-and-reinsert of every object
|
||||
row on every save. It is fully rebuildable from `payload`, so it can be added
|
||||
in its own migration the day a query needs it, with a backfill. Do **not**
|
||||
build it in `0005`.
|
||||
|
||||
### 4.3 `world_chunk_revisions`
|
||||
|
||||
```python
|
||||
class WorldChunkRevision(Base):
|
||||
__tablename__ = "world_chunk_revisions"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
chunk_key = Column(String(160), nullable=False, index=True) # deliberately NOT a FK
|
||||
world_id = Column(Integer, nullable=False, index=True) # also not a FK, same reason
|
||||
revision = Column(Integer, nullable=False)
|
||||
action = Column(String(16), nullable=False) # 'create' | 'update' | 'delete'
|
||||
actor_id = Column(Integer, ForeignKey("users.id", ondelete="SET NULL"), nullable=True)
|
||||
checksum = Column(String(64), nullable=False)
|
||||
payload = Column(LargeBinary, nullable=True) # full payload at this revision
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
```
|
||||
|
||||
Kept from `world.md` §4.7 including its two design points: the full payload is
|
||||
stored (rollback needs it) and `chunk_key`/`world_id` are **not** foreign keys,
|
||||
so deleting a chunk or a world preserves the audit trail.
|
||||
|
||||
**Retention (new, required):** this table grows without bound — a creator
|
||||
dragging a brush can produce hundreds of revisions per minute. The
|
||||
implementation must ship a retention policy from day one: keep the newest
|
||||
`WORLD_CHUNK_REVISION_KEEP` (default 20) payloads per `chunk_key` and null out
|
||||
`payload` on older rows (keeping the metadata row for the audit trail), pruned
|
||||
in the same transaction as the write. A `created_at` index supports a later
|
||||
time-based prune.
|
||||
|
||||
### 4.4 Config additions (`backend/app/config.py`)
|
||||
|
||||
```
|
||||
WORLD_CHUNK_MAX_PAYLOAD_BYTES: int = 1_048_576 # 1 MiB; a dense 32×32 uint16 layer is 2 KiB
|
||||
WORLD_CHUNK_MAX_OBJECTS: int = 512
|
||||
WORLD_CHUNK_MAX_BATCH: int = 64
|
||||
WORLD_CHUNK_REVISION_KEEP: int = 20
|
||||
GAME_SERVER_INTERNAL_API_URL: str = "http://127.0.0.1:8000"
|
||||
```
|
||||
|
||||
### 4.5 Chunk key format
|
||||
|
||||
`world.md` §2.3 specifies `"{world_id}:{room_id}:{cx}:{cy}:{cz}"` and illustrates
|
||||
it with `w_0001:r_0001`. Those ids were illustrative. The real key uses the
|
||||
backend's identifiers:
|
||||
|
||||
```
|
||||
"{world.id}:{room.slug}:{cx}:{cy}:{cz}" e.g. "12:main:3:-1:0"
|
||||
```
|
||||
|
||||
The room **slug** rather than its numeric id, so a key is human-readable in logs
|
||||
and stable if rooms are ever re-imported. `Chunk.build_key()` in
|
||||
`scripts/chunk.gd` already produces this shape unmodified.
|
||||
|
||||
---
|
||||
|
||||
## 5. D2 — The FastAPI backend is the only writer
|
||||
|
||||
### 5.1 Decision
|
||||
|
||||
The in-game editor (`editor.md` §7.2) submits edits over **HTTP to the FastAPI
|
||||
backend**, which validates, versions, and persists them. The dedicated Godot
|
||||
server process **never writes world content** and does not sit in the edit path.
|
||||
|
||||
This preserves `world.md`'s and `editor.md`'s actual invariant — *clients never
|
||||
touch storage; they submit edits to a server-authoritative tier that validates
|
||||
them* — while identifying that tier as the always-on backend rather than the
|
||||
ephemeral sim process. `editor.md` §4.2's claim that edits ride the same
|
||||
`request_chunk_edit` RPC as gameplay is the one part of that doc this design
|
||||
changes; the moderation and validation properties it derives from that claim are
|
||||
unaffected, because the validation boundary moves with the writer.
|
||||
|
||||
### 5.2 Reasoning
|
||||
|
||||
1. **Nothing that can vanish in 300 seconds may own the write path.** The reaper
|
||||
in `game_servers.py` `stop()`s an idle server with `SIGTERM` and escalates to
|
||||
`SIGKILL` after 10 s; `supervisor.shutdown()` does the same to every server on
|
||||
backend shutdown; and if the backend dies uncleanly the servers are orphaned
|
||||
with no one to flush them. Because the sim process holds no unsaved world
|
||||
content in this design, **no reap, crash, or kill can ever lose world data** —
|
||||
that is the single strongest practical reason for this split.
|
||||
2. **Editing must work with no dedicated server running.** A creator opening
|
||||
their world to build should not have to spin up a 30 Hz sim process, burn a
|
||||
port from the 100-port range, and hold it for 5 minutes past their last save.
|
||||
3. **`server.gd` has no database access, no credentials, and no HTTP client.**
|
||||
Routing writes through it means either shipping Postgres credentials into a
|
||||
process spawned per join, or building an ENet→HTTP proxy inside the sim loop.
|
||||
Both are strictly worse than the editor calling the backend directly.
|
||||
4. **Authorization already lives in the backend.** `CurrentUser`, the
|
||||
`owner_id` check, and `WorldVisibility` are all there. The dedicated server
|
||||
has no user identities at all — it knows peer ids, not accounts.
|
||||
|
||||
### 5.3 Authorization
|
||||
|
||||
- **Read** a chunk: the same rule as `GET /api/worlds/{id}` — the world is
|
||||
`PUBLIC`, or the caller owns it. Otherwise 404 (not 403), matching the
|
||||
existing routers' deliberate non-disclosure.
|
||||
- **Write** a chunk: caller must be `world.owner_id`, matching `update_world`;
|
||||
403 otherwise. Collaborator/role-based editing is future work and slots in at
|
||||
this one check.
|
||||
- **Mature gating hook:** `is_mature` chunks are where `content_moderation.md`'s
|
||||
age gate attaches on the read path. Specify the column and the index now; the
|
||||
gate itself lands with that doc's work.
|
||||
|
||||
### 5.4 Concurrency
|
||||
|
||||
Optimistic concurrency exactly as `world.md` §5.4, expressed over HTTP:
|
||||
|
||||
1. Reader gets `revision` (header `X-Chunk-Revision`, or the JSON field).
|
||||
2. Writer sends `base_revision`.
|
||||
3. The service does `SELECT ... FOR UPDATE` on the chunk row, compares
|
||||
`base_revision` to `revision`, and either commits at `revision + 1` or returns
|
||||
**409** with `current_revision` and `current_checksum` so the editor can
|
||||
re-fetch and re-apply.
|
||||
4. `base_revision: 0` means "create; fail with 409 if it already exists".
|
||||
|
||||
### 5.5 Validation (the backend must not trust the client)
|
||||
|
||||
The write path decodes the submitted payload server-side before storing it. This
|
||||
requires a **Python port of the `world.md` §3.6 codec** —
|
||||
`backend/app/services/chunk_codec.py`, mirroring `scripts/chunk_data_decoder.gd`.
|
||||
It checks: magic `AGPC`, `format_version <= 1`, declared vs. actual
|
||||
`payload_len`, **recomputed** SHA-256 (the header's checksum is advisory), tile
|
||||
layer dims equal the room's `grid.size`, tile indices in palette range, object
|
||||
count ≤ `WORLD_CHUNK_MAX_OBJECTS`, object positions inside the chunk's bounds,
|
||||
`chunk_key` in the payload matching the URL, and string-field length limits
|
||||
(`world.md` §7). `content_flags` and `is_mature` are **recomputed** from the
|
||||
payload's flag sections, never taken from the request body.
|
||||
|
||||
**Drift control (required):** the two codecs must be pinned by golden files —
|
||||
fixture chunks under `tests/fixtures/chunks/` encoded by one implementation and
|
||||
decoded byte-identically by the other, asserted in both the pytest suite and the
|
||||
Godot headless suite. Without this the format has two implementations and no
|
||||
contract test, which is exactly the failure `world.md` §5.2 was trying to avoid
|
||||
by having one shared implementation.
|
||||
|
||||
---
|
||||
|
||||
## 6. D4 — Editing versus a live session (scope boundary)
|
||||
|
||||
**In scope for this milestone:**
|
||||
|
||||
- The editor is entered as **"Edit world" from the world browser**: a non-joined
|
||||
client mode. It does **not** call `POST /api/worlds/{id}/join`, does not open
|
||||
an ENet connection, and does not spawn a dedicated server. It loads chunks over
|
||||
HTTP, edits them locally, and saves them over HTTP.
|
||||
- Writes always succeed regardless of whether a session is live. The write
|
||||
response carries `live_session: bool` (from `supervisor.debug_state()`), so the
|
||||
editor can surface *"this world has players in it right now — they'll see your
|
||||
changes when the session restarts."*
|
||||
- A dedicated server started **after** a write sees the new content, because it
|
||||
loads from the store at startup (§7).
|
||||
|
||||
**Explicitly out of scope, deferred:**
|
||||
|
||||
- Build-in-place while joined to a live session.
|
||||
- `chunk_invalidated` push to connected clients (`world.md` §5.3) and hot-reload
|
||||
of the dedicated server's collision world.
|
||||
- Live collaborative editing / cursors (`editor.md` §9).
|
||||
|
||||
**The seam that makes the deferred work cheap:** the manifest endpoint (§7.2)
|
||||
returns a monotonic `content_revision` for the world, bumped on every chunk
|
||||
write. Hot reload is then: the dedicated server polls the manifest on a timer
|
||||
(or the backend pushes to it over the same internal channel), re-fetches the
|
||||
chunks whose revision changed, and rebuilds those collision bodies. Nothing in
|
||||
this design has to change to add it.
|
||||
|
||||
**Why the editor must not join:** if it joined, the sim process would enforce
|
||||
collision against content it loaded at spawn while the creator edits a diverging
|
||||
local copy — players would walk through new walls and bounce off deleted ones,
|
||||
with no error anywhere. Making build mode non-joined turns a silent correctness
|
||||
bug into an explicit product boundary.
|
||||
|
||||
---
|
||||
|
||||
## 7. D3 — What the dedicated server does at startup
|
||||
|
||||
### 7.1 Decision
|
||||
|
||||
`server.gd` pulls its world's content from the backend over **HTTP** at startup,
|
||||
authenticated by a **per-spawn token** the supervisor mints, and **does not bind
|
||||
the ENet port until content is loaded**.
|
||||
|
||||
Rejected alternative — *supervisor writes a whole-world snapshot file at spawn
|
||||
and passes `--world-file`*: attractive (no new auth surface, no HTTP client in
|
||||
the sim process), but it makes spawn latency proportional to world size, gives
|
||||
the server no way to fetch a chunk lazily as players roam beyond the preloaded
|
||||
set, and still needs a separate channel for the hot-reload work above. Rejected —
|
||||
*give the Godot process a Postgres connection*: there is no PG driver in
|
||||
GDScript, and it would put database credentials in a process spawned per join.
|
||||
|
||||
### 7.2 Startup sequence
|
||||
|
||||
1. `_parse_args()` gains `--api-url` and `--server-token` (§7.3).
|
||||
2. `GET /api/internal/worlds/{world_id}/manifest` → rooms, per-room `grid`,
|
||||
`bounds`, `spawn`, `chunk_count`, and the world's `content_revision`.
|
||||
3. `GET /api/internal/worlds/{world_id}/rooms/{slug}/chunks?` bounds query for
|
||||
the spawn neighbourhood (radius from the spawn point, default 3 chunks), then
|
||||
fetch each payload; decode with the existing `ChunkDataDecoder` and build
|
||||
static collision from the tile layers and objects.
|
||||
4. **Then** `network_peer.create_server(port)`, then write the status file.
|
||||
5. **Fallback:** if the backend is unreachable, the world has no rooms, or the
|
||||
room has zero chunks, load `test_level.tscn` as today and record
|
||||
`"content": "fallback"` in the status file. A content outage must never make
|
||||
a world un-joinable, and this keeps every PC3 flow working before any world
|
||||
has authored content.
|
||||
|
||||
During the session the server may lazily fetch chunks as players approach
|
||||
unloaded coordinates, through the same internal route. It **never writes**.
|
||||
Dynamic entity runtime state (positions, health) stays in memory and out of
|
||||
chunks, exactly as `world.md` §3.3 already specifies. Shutdown flushes nothing.
|
||||
|
||||
### 7.3 Internal authentication
|
||||
|
||||
`GameServerSupervisor._spawn()` generates `token = secrets.token_urlsafe(32)`,
|
||||
stores it on the `_WorldServer` dataclass, and passes it on the command line
|
||||
alongside the existing `--port/--world/--status-file`. A FastAPI dependency
|
||||
`require_game_server` resolves `Authorization: Bearer <token>` against
|
||||
`supervisor.validate_token(world_id, token)` — a dict lookup, since the
|
||||
supervisor is an in-process singleton. Properties this gives us:
|
||||
|
||||
- A token grants access to **one** world and **dies with its process** (the
|
||||
reaper's `del self._servers[wid]` invalidates it).
|
||||
- No long-lived shared secret in config or on disk.
|
||||
- It reuses the **already documented** single-worker constraint in
|
||||
`game_servers.py`; it does not add a new one.
|
||||
|
||||
Rejected alternative — *let the dedicated server use the public routes with a
|
||||
service user account*: the public routes enforce per-user visibility and
|
||||
ownership, which a service identity would have to be exempted from, and it would
|
||||
pollute `updated_by_id`/audit rows with a fake user. A separate `/api/internal`
|
||||
prefix keeps the two auth models apart and can be blocked at the reverse proxy.
|
||||
|
||||
### 7.4 Lifecycle changes this requires in `game_servers.py`
|
||||
|
||||
These are real, load-bearing findings from the current implementation:
|
||||
|
||||
- **`_await_port()` is the wrong readiness signal now.** It returns as soon as
|
||||
the UDP port is bound, and the port is bound before content exists today. With
|
||||
content loading it must await a `"ready": true` field that `server.gd` writes
|
||||
to the status file *after* content load + `create_server`. Otherwise the
|
||||
backend hands a client an address for a server that is still fetching chunks.
|
||||
- **`_await_port()` fails open.** After its 8 s deadline it returns normally,
|
||||
with no error — `ensure_server` then reports success for a server that may
|
||||
never have started. Content loading makes a slow start more likely, so the
|
||||
readiness wait needs a real timeout error (503 to the joining client) and a
|
||||
longer, configurable deadline.
|
||||
- **The status file is the only server→backend channel**, and `_spawn` currently
|
||||
passes no credentials at all — hence §7.3.
|
||||
- **`player_count()` returns 0 when the status file is missing or unparseable**,
|
||||
so a live server whose status write fails can be reaped after the idle timeout.
|
||||
Harmless for data (the sim owns nothing durable — the point of D2) but worth a
|
||||
comment where the fallback lives.
|
||||
- **No crash restart** (documented in the module docstring): if a server dies,
|
||||
the next join respawns it and it reloads content from the store. With D2 this
|
||||
is now genuinely safe rather than merely tolerated.
|
||||
|
||||
---
|
||||
|
||||
## 8. API surface
|
||||
|
||||
All paths are under the existing `worlds` router prefix (`/api/worlds`) unless
|
||||
noted. New router module: `backend/app/routers/world_content.py`, mounted at
|
||||
`/api/worlds`; internal routes in `backend/app/routers/internal.py` at
|
||||
`/api/internal`.
|
||||
|
||||
### 8.1 Public (editor & player client; JWT `CurrentUser`)
|
||||
|
||||
| Method | Path | Purpose |
|
||||
|---|---|---|
|
||||
| `GET` | `/api/worlds/{world_id}/rooms` | List rooms + grid config |
|
||||
| `POST` | `/api/worlds/{world_id}/rooms` | Create a room (owner) |
|
||||
| `GET` | `/api/worlds/{world_id}/rooms/{slug}/chunks` | Chunk **index** over a bounds query |
|
||||
| `GET` | `/api/worlds/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}` | Fetch one chunk |
|
||||
| `PUT` | `/api/worlds/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}` | Write one chunk |
|
||||
| `PUT` | `/api/worlds/{world_id}/rooms/{slug}/chunks` | Write up to `WORLD_CHUNK_MAX_BATCH` chunks atomically |
|
||||
| `DELETE` | `/api/worlds/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}` | Delete one chunk |
|
||||
| `GET` | `/api/worlds/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}/revisions` | Revision history (owner) |
|
||||
| `POST` | `/api/worlds/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}/rollback` | Restore a revision (owner) |
|
||||
|
||||
**Room list** — `GET .../rooms` → `200`
|
||||
|
||||
```json
|
||||
[{ "id": 7, "slug": "main", "name": "Main",
|
||||
"grid": { "size": [32, 32, 1], "origin": [0, 0, 0] },
|
||||
"bounds": null,
|
||||
"spawn": { "pos": [0, 1.5, 0], "yaw": 0.0 },
|
||||
"chunk_count": 41 }]
|
||||
```
|
||||
|
||||
**Chunk index** — `GET .../chunks?cx_min=&cx_max=&cy_min=&cy_max=&cz=0` → `200`.
|
||||
Payloads are *not* included; this is `world.md` §5.1's `list_chunks(bounds)` and
|
||||
lets a streamer decide what to fetch and skip anything already cached by
|
||||
checksum.
|
||||
|
||||
```json
|
||||
{ "room": "main", "content_revision": 118,
|
||||
"chunks": [{ "key": "12:main:0:0:0", "cx": 0, "cy": 0, "cz": 0,
|
||||
"revision": 4, "checksum": "9f86…", "payload_len": 2344,
|
||||
"is_mature": false, "updated_at": "2026-09-14T10:02:11Z" }] }
|
||||
```
|
||||
|
||||
Bounds are capped (default 32×32 chunks per query) and return `422` beyond that.
|
||||
|
||||
**Chunk fetch** — `GET .../chunks/{cx}/{cy}/{cz}`, content-negotiated:
|
||||
|
||||
- `Accept: application/octet-stream` (default for the game client) → `200` with
|
||||
the raw `world.md` §3.6 bytes, `ETag: "<checksum>"`,
|
||||
`X-Chunk-Revision: <n>`, `X-Chunk-Key: <key>`.
|
||||
- `Accept: application/json` (tooling, tests, the editor's debug view) → the
|
||||
§3.5 JSON encoding, decoded server-side from the payload. JSON is derived, never
|
||||
stored, so there is no dual-write drift (`world.md` §4.4).
|
||||
- `If-None-Match: "<checksum>"` → `304`. This is what makes the client's
|
||||
`user://chunk_cache/` cache cheap and is why the checksum is the ETag.
|
||||
- `404` if the chunk does not exist (an unwritten coordinate is not an error to
|
||||
the streamer — it renders empty).
|
||||
|
||||
**Chunk write** — `PUT .../chunks/{cx}/{cy}/{cz}`
|
||||
|
||||
```
|
||||
Content-Type: application/octet-stream
|
||||
X-Base-Revision: 4 # 0 = create
|
||||
<binary payload>
|
||||
```
|
||||
|
||||
or, for clients that prefer JSON:
|
||||
`{"base_revision": 4, "payload_b64": "…"}`.
|
||||
|
||||
Responses:
|
||||
|
||||
| Code | Body / meaning |
|
||||
|---|---|
|
||||
| `200` | `{"key", "revision", "checksum", "payload_len", "updated_at", "is_mature", "live_session"}` |
|
||||
| `409` | `{"detail": "revision conflict", "current_revision": 6, "current_checksum": "…"}` |
|
||||
| `403` | not the world owner |
|
||||
| `404` | world or room not found / not visible |
|
||||
| `413` | payload over `WORLD_CHUNK_MAX_PAYLOAD_BYTES` |
|
||||
| `422` | decode/validation failure (`{"detail", "reason"}`, e.g. `checksum_mismatch`, `layer_dims`, `object_out_of_bounds`) |
|
||||
|
||||
**Batch write** — `PUT .../chunks` with
|
||||
`{"chunks": [{"cx","cy","cz","base_revision","payload_b64"}, …]}`. Applied in
|
||||
**one transaction, all-or-nothing**: if any entry conflicts, nothing is written
|
||||
and the response is `409` naming the offending coordinate. Justification: an
|
||||
editor brush stroke or an object drag routinely straddles a chunk boundary, and
|
||||
without a batch the editor either issues N round trips or leaves half of a user
|
||||
action persisted. Capped at `WORLD_CHUNK_MAX_BATCH` chunks and 8 MB.
|
||||
|
||||
### 8.2 D5 — Full-chunk PUT, not JSON-Patch deltas
|
||||
|
||||
`world.md` §5.4 specifies RFC-6902 deltas against `base_revision`. This design
|
||||
sends **whole chunks** instead.
|
||||
|
||||
- A 32×32×1 chunk is ~2 KB of dense tile indices plus its objects — a few KB.
|
||||
The bandwidth a patch saves is negligible at editor rates.
|
||||
- The stored form is an opaque binary blob. Patching it means the backend must
|
||||
decode → apply a JSON-Patch → re-encode → re-checksum, i.e. implement and test
|
||||
a *second* mutation format on top of the codec, with its own failure modes, and
|
||||
keep it in sync with the client's patch generator. That is the same dual-path
|
||||
drift risk `world.md` §5.2 exists to prevent.
|
||||
- Lost-update protection comes from `base_revision`, not from the patch, so
|
||||
nothing is given up on correctness.
|
||||
|
||||
Delta encoding stays available as a pure bandwidth optimization later —
|
||||
`world.md` §8 already files it as future work.
|
||||
|
||||
### 8.3 Internal (dedicated server; `require_game_server` token)
|
||||
|
||||
| Method | Path | Purpose |
|
||||
|---|---|---|
|
||||
| `GET` | `/api/internal/worlds/{world_id}/manifest` | Rooms, grids, spawn, `content_revision`, chunk counts |
|
||||
| `GET` | `/api/internal/worlds/{world_id}/rooms/{slug}/chunks` | Bounds index (same shape as §8.1) |
|
||||
| `GET` | `/api/internal/worlds/{world_id}/rooms/{slug}/chunks/{cx}/{cy}/{cz}` | Binary payload |
|
||||
|
||||
Read-only by construction — there is no internal write route, and adding one
|
||||
would violate D2. The token is world-scoped, so a path whose `world_id` differs
|
||||
from the token's world is `403`. These routes skip the per-user visibility check
|
||||
(the sim process has no user) and apply no mature gating (gating is a client/user
|
||||
concern; the server still needs collision).
|
||||
|
||||
### 8.4 D6 — The client streams chunks over HTTP, not over ENet
|
||||
|
||||
`world.md` §5.3 routes `request_chunk` / `chunk_data` over the game's ENet
|
||||
connection. This design has the playing client fetch chunks from the **backend
|
||||
over HTTP**, the same routes the editor uses.
|
||||
|
||||
- The dedicated server has no content the backend doesn't have; proxying bytes
|
||||
through it adds a hop and puts multi-megabyte reliable transfers in contention
|
||||
with the 30 Hz snapshot broadcast on the same ENet peer.
|
||||
- HTTP gives caching for free — `ETag`/`If-None-Match` on the checksum, and a
|
||||
local `user://chunk_cache/<checksum>` that survives sessions.
|
||||
- `ApiClient` (`scripts/api_client.gd`) already carries the JWT and the result
|
||||
contract; no new transport code.
|
||||
|
||||
**This does not require rewriting `ChunkStreamManager`.** It already calls
|
||||
through a `set_server_rpc()` seam that only needs an object with
|
||||
`request_chunk(key)`. The editor-wiring task supplies an `HttpChunkSource` that
|
||||
implements that method against `ApiClient` and feeds
|
||||
`_on_chunk_data_received(key, bytes)` — which also finally gives that dormant
|
||||
seam a caller. Note the existing `_load_chunk()` builds its key with empty
|
||||
world/room ids (`Chunk.build_key("", "", coord)`); the adapter must supply the
|
||||
real world id and room slug.
|
||||
|
||||
---
|
||||
|
||||
## 9. What each follow-on task owns
|
||||
|
||||
**Backend task**
|
||||
- `backend/app/models/world_content.py` + `0005_add_world_content_tables`
|
||||
- `backend/app/services/chunk_codec.py` (Python port of `world.md` §3.6) and the
|
||||
golden-file fixtures shared with the Godot suite
|
||||
- `backend/app/services/world_store.py` (the `world.md` §5.1 service interface,
|
||||
minus `flush_dirty`/`rebuild_index`, over Postgres)
|
||||
- `backend/app/routers/world_content.py`, `backend/app/routers/internal.py`
|
||||
- `game_servers.py`: per-spawn token, `--api-url`/`--server-token` args,
|
||||
readiness-from-status-file instead of `_await_port` (§7.4)
|
||||
- `create_world` creates the `main` room
|
||||
|
||||
**Client/editor task**
|
||||
- `HttpChunkSource` adapter → `ChunkStreamManager.set_server_rpc()`
|
||||
- Editor save path (single + batch PUT), 409 conflict re-fetch-and-reapply,
|
||||
`live_session` warning UI
|
||||
- "Edit world" entry from the world browser that does **not** join
|
||||
- `server.gd`: arg parsing, manifest + chunk fetch before `create_server`,
|
||||
collision build from decoded chunks, `test_level.tscn` fallback,
|
||||
`"ready"`/`"content"` fields in the status file
|
||||
|
||||
---
|
||||
|
||||
## 10. Open questions (deliberately not decided here)
|
||||
|
||||
- **Hot reload / build-in-place** while a session is live (§6) — the
|
||||
`content_revision` seam is in place for it.
|
||||
- **Collaborator permissions** beyond `owner_id` — one check in §5.3.
|
||||
- **Mature-content gating** on the read path — column and index exist; the
|
||||
policy belongs to `content_moderation.md`.
|
||||
- **`world_chunk_objects`** derived index — spec'd in `world.md` §4.5, build it
|
||||
when a query needs it (§4.2).
|
||||
- **Payload compression** — the §3.6 header reserves a flags bitmask; Postgres
|
||||
TOAST already compresses `BYTEA`, so measure before adding a second layer.
|
||||
- **Chunk streaming for very large worlds** — the bounds-query cap in §8.1 is a
|
||||
guardrail, not a scaling plan.
|
||||
@@ -69,6 +69,16 @@ func clear_token() -> void:
|
||||
|
||||
var _base_url: String = "http://127.0.0.1:8000"
|
||||
|
||||
## Read-only access to the configured backend base URL (no trailing slash).
|
||||
## Lets other client-side code that needs to build its own request outside
|
||||
## the [method request] primitive -- e.g. [HttpChunkSource], which needs raw
|
||||
## response bytes and custom headers `request()`'s JSON-only contract can't
|
||||
## give it -- target the same backend without duplicating the env var /
|
||||
## ProjectSettings resolution logic in `_ready()`.
|
||||
var base_url: String:
|
||||
get:
|
||||
return _base_url
|
||||
|
||||
## Request timeout in seconds. 0 disables the timeout.
|
||||
var timeout_seconds: float = 10.0
|
||||
|
||||
|
||||
@@ -404,7 +404,15 @@ static func _parse_object_section(data: PackedByteArray, result: ChunkPayload) -
|
||||
offset += 2
|
||||
var props_str := data.slice(offset, offset + props_len).get_string_from_utf8()
|
||||
offset += props_len
|
||||
obj.properties = JSON.parse_string(props_str) or {}
|
||||
# `or` in GDScript is a boolean operator, not Python/JS-style
|
||||
# short-circuit-return -- `parsed or {}` returns a bool (true for any
|
||||
# non-empty Dictionary), not `parsed` itself. Assigning that bool to
|
||||
# `properties` (typed Dictionary) crashes at runtime for any object
|
||||
# with real property data -- verified: a real fixture with
|
||||
# {"locked": false, ...} threw "Invalid assignment of property or key
|
||||
# 'properties' with value of type 'bool'".
|
||||
var parsed_props: Variant = JSON.parse_string(props_str)
|
||||
obj.properties = parsed_props if parsed_props is Dictionary else {}
|
||||
|
||||
# flags (ContentFlags)
|
||||
obj.flags.violence = data[offset]
|
||||
@@ -484,13 +492,33 @@ static func _build_metadata_section(payload: ChunkPayload) -> PackedByteArray:
|
||||
data.append_array(_write_int32(payload.coord.x))
|
||||
data.append_array(_write_int32(payload.coord.y))
|
||||
data.append_array(_write_int32(payload.coord.z))
|
||||
# Wire format is min + max (world.md §3, and _parse_metadata_section
|
||||
# below reads the 2nd triple as max_pos and computes size = max - min)
|
||||
# -- writing raw `.size` here instead of `.position + .size` was a
|
||||
# latent bug that only escaped every test because AABB(Vector3.ZERO, ...)
|
||||
# happens to make size == max when position is exactly zero. Any chunk
|
||||
# at a real, nonzero world position (i.e. every real chunk except the
|
||||
# one at the origin) would round-trip through encode_binary/decode_binary
|
||||
# with a corrupted size. Same bug class as the backend's min+size/
|
||||
# min+max mismatch fixed in chunk_codec.py (commit eb39e43).
|
||||
var bounds_max: Vector3 = payload.bounds.position + payload.bounds.size
|
||||
data.append_array(_write_float32(payload.bounds.position.x))
|
||||
data.append_array(_write_float32(payload.bounds.position.y))
|
||||
data.append_array(_write_float32(payload.bounds.position.z))
|
||||
data.append_array(_write_float32(payload.bounds.size.x))
|
||||
data.append_array(_write_float32(payload.bounds.size.y))
|
||||
data.append_array(_write_float32(payload.bounds.size.z))
|
||||
return data
|
||||
data.append_array(_write_float32(bounds_max.x))
|
||||
data.append_array(_write_float32(bounds_max.y))
|
||||
data.append_array(_write_float32(bounds_max.z))
|
||||
# Every other section builder wraps its body with `_wrap_section`
|
||||
# (section_id + uint32 length prefix) -- this one didn't, so
|
||||
# `encode_binary()` spliced the raw metadata bytes directly into the
|
||||
# section stream with no header at all. The decoder then read the
|
||||
# metadata's own first bytes (a string length prefix) as a bogus
|
||||
# section_id/section_len pair, producing a garbage length that
|
||||
# overran the buffer ("truncated section body") and silently found
|
||||
# zero real sections. Never caught before because nothing in this
|
||||
# codebase called encode_binary() until
|
||||
# scripts/smoke_test_http_chunk_source.gd.
|
||||
return _wrap_section(data, SECTION_META)
|
||||
|
||||
|
||||
static func _build_tile_section(layer: TileLayerData) -> PackedByteArray:
|
||||
@@ -607,8 +635,11 @@ static func _read_int64(data: PackedByteArray, offset: int) -> int:
|
||||
return hi * 0x100000000 + lo
|
||||
|
||||
static func _read_float32(data: PackedByteArray, offset: int) -> float:
|
||||
var bits := _read_uint32(data, offset)
|
||||
return bits as float # GDScript float is 64-bit; bits repr works for IEEE 754
|
||||
# `int as float` is a NUMERIC cast, not an IEEE-754 bit reinterpretation --
|
||||
# it was silently corrupting every non-integer value (verified: bits for
|
||||
# 1.5f decoded as 1069547520.0). decode_float() does a real bitcast and
|
||||
# matches this format's little-endian byte order (§3.6).
|
||||
return data.decode_float(offset)
|
||||
|
||||
static func _read_hex_string(data: PackedByteArray, offset: int, length: int) -> String:
|
||||
var hex_chars := "0123456789abcdef"
|
||||
@@ -637,8 +668,10 @@ static func _write_int64(val: int) -> PackedByteArray:
|
||||
return _write_uint32(lo) + _write_uint32(hi)
|
||||
|
||||
static func _write_float32(val: float) -> PackedByteArray:
|
||||
var bits := val as int
|
||||
return _write_uint32(bits)
|
||||
var out := PackedByteArray()
|
||||
out.resize(4)
|
||||
out.encode_float(0, val)
|
||||
return out
|
||||
|
||||
static func _write_string(s: String) -> PackedByteArray:
|
||||
var bytes := s.to_utf8_buffer()
|
||||
|
||||
@@ -241,7 +241,11 @@ func _instantiate_chunk_scene_with_data(coord: Vector3i, data: ChunkDataDecoder.
|
||||
chunk_scene.coord = coord
|
||||
chunk_scene.key = data.key
|
||||
chunk_scene.bounds = data.bounds
|
||||
chunk_scene.format_version = data.format_version
|
||||
# ChunkDataDecoder.ChunkPayload's field is named `version`, not
|
||||
# `format_version` -- this was a hard crash ("Invalid access to
|
||||
# property or key 'format_version'") the first time real decoded data
|
||||
# ever reached this dormant method (via HttpChunkSource).
|
||||
chunk_scene.format_version = data.version
|
||||
chunk_scene.revision = data.revision
|
||||
|
||||
# Add tiles
|
||||
@@ -348,7 +352,13 @@ func clear_all_chunks() -> void:
|
||||
|
||||
func _parse_coord_from_key(key: String) -> Variant:
|
||||
"""Parse chunk coordinate from a canonical chunk key."""
|
||||
var parts: Array[String] = key.split(":")
|
||||
# String.split() returns PackedStringArray, not Array[String] -- those
|
||||
# are different container types with no implicit conversion, so this
|
||||
# raised "Trying to assign a value of type 'PackedStringArray' to a
|
||||
# variable of type 'Array[String]'" the moment real data reached this
|
||||
# dormant method for the first time (via HttpChunkSource's
|
||||
# _on_chunk_data_received call -- nothing exercised this path before).
|
||||
var parts: PackedStringArray = key.split(":")
|
||||
if parts.size() < 5:
|
||||
return null
|
||||
return Vector3i(
|
||||
|
||||
@@ -0,0 +1,203 @@
|
||||
class_name HttpChunkSource
|
||||
extends Node
|
||||
## HTTP-backed adapter for ChunkStreamManager.set_server_rpc().
|
||||
##
|
||||
## Implements docs/architecture/world_persistence_impl.md D6/§8.4: the
|
||||
## playing client streams chunks from the FastAPI backend over HTTP (the
|
||||
## same public routes the editor uses -- `backend/app/routers/world_content.py`),
|
||||
## not over the dedicated server's ENet connection.
|
||||
##
|
||||
## `ChunkStreamManager` only requires an object with a `request_chunk(key)`
|
||||
## method (see its `_server_rpc` seam); this adapter satisfies that and feeds
|
||||
## results back through the manager's existing (previously dormant)
|
||||
## `_on_chunk_data_received(key, bytes)` / `_on_chunk_load_error(coord, msg)`
|
||||
## methods, and its `_instantiate_chunk_scene(coord)` for the "unwritten
|
||||
## coordinate renders empty" case (§8.1).
|
||||
##
|
||||
## `ChunkStreamManager._load_chunk()` builds its request key with empty
|
||||
## world/room components (`Chunk.build_key("", "", coord)`) because the
|
||||
## manager itself has no notion of which world/room it's streaming --
|
||||
## that's this adapter's job. `request_chunk(key)` only reads the
|
||||
## coordinate out of the key it's given and rebuilds the real key from
|
||||
## `world_id`/`room_slug` before touching the network, per the doc's note
|
||||
## under §8.4.
|
||||
##
|
||||
## Must be added to the scene tree before use (it creates per-request
|
||||
## HTTPRequest child nodes), e.g.:
|
||||
##
|
||||
## var source := HttpChunkSource.new()
|
||||
## source.world_id = str(Session.world_id)
|
||||
## source.room_slug = "main"
|
||||
## source.stream_manager = stream_manager
|
||||
## stream_manager.add_child(source)
|
||||
## stream_manager.set_server_rpc(source)
|
||||
|
||||
## The world this source fetches chunks for (string form of the backend's
|
||||
## numeric world id -- matches Chunk.build_key's world_id parameter type).
|
||||
var world_id: String = ""
|
||||
|
||||
## The room slug within that world. world.md's default room is "main".
|
||||
var room_slug: String = "main"
|
||||
|
||||
## The ChunkStreamManager to feed decoded results back into. Required.
|
||||
var stream_manager: ChunkStreamManager = null
|
||||
|
||||
## In-memory ETag cache: chunk key -> last-known checksum (bare hex, no
|
||||
## quotes). Backs the on-disk payload cache so re-fetching an unchanged
|
||||
## chunk costs a 304, not a re-download (world_persistence_impl.md §8.1:
|
||||
## "This is what makes the client's user://chunk_cache/ cache cheap").
|
||||
var _etag_by_key: Dictionary = {}
|
||||
|
||||
const CACHE_DIR := "user://chunk_cache"
|
||||
|
||||
|
||||
func _ready() -> void:
|
||||
DirAccess.make_dir_recursive_absolute(CACHE_DIR)
|
||||
|
||||
|
||||
## Satisfies ChunkStreamManager's `_server_rpc.request_chunk(key)` seam.
|
||||
func request_chunk(key: String) -> void:
|
||||
var coord: Variant = _coord_from_key(key)
|
||||
if coord == null:
|
||||
push_error("HttpChunkSource: malformed chunk key %s" % key)
|
||||
return
|
||||
_fetch(coord)
|
||||
|
||||
|
||||
## world_persistence_impl.md §8.1 chunk index -- lists which chunks in a
|
||||
## bounds actually exist without fetching their payloads. Not called by
|
||||
## ChunkStreamManager's per-coordinate streaming loop today, but is the
|
||||
## "bounds-query listing" half of this adapter's contract for future
|
||||
## callers (e.g. a minimap, or a smarter prefetcher).
|
||||
func list_chunks(cx_min: int, cx_max: int, cy_min: int, cy_max: int, cz: int = 0) -> Dictionary:
|
||||
var path := "/api/worlds/%s/rooms/%s/chunks?cx_min=%d&cx_max=%d&cy_min=%d&cy_max=%d&cz=%d" % [
|
||||
world_id, room_slug, cx_min, cx_max, cy_min, cy_max, cz
|
||||
]
|
||||
return await _api_client().request(HTTPClient.METHOD_GET, path, "", "application/json", true)
|
||||
|
||||
|
||||
# ─────────────────────────── internals ───────────────────────────
|
||||
|
||||
## Resolved via an absolute node path rather than the bare `ApiClient`
|
||||
## autoload identifier: bare autoload identifiers only resolve at GDScript
|
||||
## compile time inside a scene the engine boots normally. Any script
|
||||
## compiled while running headless via `godot --script ...` (as
|
||||
## scripts/smoke_test_*.gd do) fails with "Identifier not found: ApiClient"
|
||||
## on the bare form -- confirmed while writing
|
||||
## scripts/smoke_test_http_chunk_source.gd. `get_node` resolves the same
|
||||
## singleton correctly in both contexts (the same pattern game.gd already
|
||||
## uses for AvatarSystem via `get_node_or_null("/root/AvatarSystem")`).
|
||||
func _api_client() -> Node:
|
||||
return get_node("/root/ApiClient")
|
||||
|
||||
|
||||
func _fetch(coord: Vector3i) -> void:
|
||||
var key := Chunk.build_key(world_id, room_slug, coord)
|
||||
|
||||
var http := HTTPRequest.new()
|
||||
http.timeout = 10.0
|
||||
add_child(http)
|
||||
|
||||
var api := _api_client()
|
||||
var headers := PackedStringArray()
|
||||
headers.append("Accept: application/octet-stream")
|
||||
if api.has_token():
|
||||
var bearer: String = api.bearer_token
|
||||
headers.append("Authorization: " + bearer)
|
||||
var cached_etag: String = _etag_by_key.get(key, "")
|
||||
if cached_etag != "":
|
||||
headers.append("If-None-Match: \"%s\"" % cached_etag)
|
||||
|
||||
var base_url: String = api.base_url
|
||||
var url := "%s/api/worlds/%s/rooms/%s/chunks/%d/%d/%d" % [
|
||||
base_url, world_id, room_slug, coord.x, coord.y, coord.z
|
||||
]
|
||||
var err := http.request(url, headers, HTTPClient.METHOD_GET)
|
||||
if err != OK:
|
||||
http.queue_free()
|
||||
_fail(coord, "HttpChunkSource: failed to start request for %s (%d)" % [key, err])
|
||||
return
|
||||
|
||||
var args: Array = await http.request_completed
|
||||
var result_code: int = args[0]
|
||||
var response_code: int = args[1]
|
||||
var response_headers: PackedStringArray = args[2]
|
||||
var body: PackedByteArray = args[3]
|
||||
http.queue_free()
|
||||
|
||||
if result_code != HTTPRequest.RESULT_SUCCESS:
|
||||
_fail(coord, "HttpChunkSource: transport error fetching %s (code %d)" % [key, result_code])
|
||||
return
|
||||
|
||||
match response_code:
|
||||
304:
|
||||
var cached := _read_cache(cached_etag)
|
||||
if cached.is_empty():
|
||||
# Cache miss despite a 304 (e.g. the user:// cache got
|
||||
# cleared) -- drop the stale ETag and refetch unconditionally
|
||||
# rather than deliver empty bytes to the decoder.
|
||||
_etag_by_key.erase(key)
|
||||
_fetch(coord)
|
||||
return
|
||||
_deliver(key, cached)
|
||||
200:
|
||||
var checksum := _etag_from_headers(response_headers)
|
||||
if checksum != "":
|
||||
_etag_by_key[key] = checksum
|
||||
_write_cache(checksum, body)
|
||||
_deliver(key, body)
|
||||
404:
|
||||
# world_persistence_impl.md §8.1: "an unwritten coordinate is not
|
||||
# an error to the streamer -- it renders empty."
|
||||
if stream_manager != null:
|
||||
stream_manager._instantiate_chunk_scene(coord)
|
||||
_:
|
||||
_fail(coord, "HttpChunkSource: HTTP %d fetching %s" % [response_code, key])
|
||||
|
||||
|
||||
func _deliver(key: String, bytes: PackedByteArray) -> void:
|
||||
if stream_manager != null:
|
||||
stream_manager._on_chunk_data_received(key, bytes)
|
||||
|
||||
|
||||
func _fail(coord: Vector3i, message: String) -> void:
|
||||
push_error(message)
|
||||
if stream_manager != null:
|
||||
stream_manager._on_chunk_load_error(coord, message)
|
||||
|
||||
|
||||
func _coord_from_key(key: String) -> Variant:
|
||||
var parts: PackedStringArray = key.split(":")
|
||||
if parts.size() < 5:
|
||||
return null
|
||||
return Vector3i(int(parts[2]), int(parts[3]), int(parts[4]))
|
||||
|
||||
|
||||
func _etag_from_headers(headers: PackedStringArray) -> String:
|
||||
for h in headers:
|
||||
if h.to_lower().begins_with("etag:"):
|
||||
var v := h.substr(h.find(":") + 1).strip_edges()
|
||||
return v.trim_prefix('"').trim_suffix('"')
|
||||
return ""
|
||||
|
||||
|
||||
func _cache_path(checksum: String) -> String:
|
||||
return "%s/%s" % [CACHE_DIR, checksum]
|
||||
|
||||
|
||||
func _write_cache(checksum: String, bytes: PackedByteArray) -> void:
|
||||
var f := FileAccess.open(_cache_path(checksum), FileAccess.WRITE)
|
||||
if f:
|
||||
f.store_buffer(bytes)
|
||||
f.close()
|
||||
|
||||
|
||||
func _read_cache(checksum: String) -> PackedByteArray:
|
||||
if checksum == "":
|
||||
return PackedByteArray()
|
||||
var f := FileAccess.open(_cache_path(checksum), FileAccess.READ)
|
||||
if f == null:
|
||||
return PackedByteArray()
|
||||
var bytes := f.get_buffer(f.get_length())
|
||||
f.close()
|
||||
return bytes
|
||||
+260
-7
@@ -9,9 +9,26 @@
|
||||
## Launched by the backend's game-server supervisor
|
||||
## (backend/app/services/game_servers.py):
|
||||
## godot --headless --path . res://scenes/server.tscn -- \
|
||||
## --port 27000 --world 3 --status-file /path/to/status.json
|
||||
## --port 27000 --world 3 --status-file /path/to/status.json \
|
||||
## --api-url http://127.0.0.1:8000 --server-token <per-spawn token>
|
||||
## All args are optional; the defaults let `godot res://scenes/server.tscn`
|
||||
## run standalone on 7777 for smoke_test_network_client.gd.
|
||||
## run standalone on 7777 for smoke_test_network_client.gd (which passes
|
||||
## neither --api-url nor --server-token, so startup goes straight to the
|
||||
## test_level.tscn fallback below).
|
||||
##
|
||||
## Startup sequence (docs/architecture/world_persistence_impl.md §7.2):
|
||||
## 1. Parse args.
|
||||
## 2. If --api-url/--server-token/--world are all present, pull the world's
|
||||
## manifest + the spawn-neighbourhood chunks from the backend's internal
|
||||
## API (§8.3), decode them, and build real static collision from the
|
||||
## tile layers + objects. This happens BEFORE the ENet port binds.
|
||||
## 3. Fall back to test_level.tscn if the backend is unreachable, the world
|
||||
## has no rooms, or the room has zero chunks -- a content outage must
|
||||
## never make a world un-joinable (§7.2 step 5).
|
||||
## 4. Bind the ENet port, then write "ready": true and "content" ("loaded"
|
||||
## or "fallback") to the status file -- this is what
|
||||
## GameServerSupervisor._await_ready() polls for (§7.4), replacing the
|
||||
## old bare-port-bind readiness check.
|
||||
extends Node
|
||||
|
||||
const MAX_PLAYERS := 16
|
||||
@@ -21,11 +38,40 @@ const PHYSICS_HZ := 30
|
||||
## every this many physics frames.
|
||||
const STATUS_WRITE_EVERY := 30
|
||||
|
||||
## world_persistence_impl.md §4.1's default room slug.
|
||||
const MAIN_ROOM_SLUG := "main"
|
||||
## §7.2 step 3: "the spawn neighbourhood (radius from the spawn point,
|
||||
## default 3 chunks)".
|
||||
const SPAWN_CHUNK_RADIUS := 3
|
||||
## HTTP timeout for internal-API calls during startup. Generous but bounded
|
||||
## -- a hung backend must not hang the server startup (§7.2 fallback rule).
|
||||
const CONTENT_FETCH_TIMEOUT := 8.0
|
||||
|
||||
var network_peer: ENetMultiplayerPeer
|
||||
var port: int = DEFAULT_PORT
|
||||
var world_id: String = ""
|
||||
var status_file_path: String = ""
|
||||
|
||||
## world_persistence_impl.md §7.3: internal-API base URL and this spawn's
|
||||
## bearer token, both passed on the command line by
|
||||
## GameServerSupervisor._spawn(). Empty means "no backend to talk to" --
|
||||
## content loading is skipped and the fallback level loads immediately.
|
||||
var api_url: String = ""
|
||||
var server_token: String = ""
|
||||
|
||||
## What startup actually loaded, written into the status file's "content"
|
||||
## field: "loaded" (real content from the backend) or "fallback"
|
||||
## (test_level.tscn, either because there was nothing to load or nothing
|
||||
## reachable to load it from).
|
||||
var _content_status: String = "fallback"
|
||||
## Diagnostic-only counters (not part of the doc's required status fields,
|
||||
## but real: they're the actual number of chunks decoded and collision
|
||||
## shapes added to the tree, computed in the same pass that builds them --
|
||||
## useful for verifying a real load happened without needing to poke the
|
||||
## running server's scene tree from outside).
|
||||
var _chunks_loaded: int = 0
|
||||
var _collision_shapes_built: int = 0
|
||||
|
||||
## peer_id -> Player node
|
||||
var players: Dictionary = {}
|
||||
var tick: int = 0
|
||||
@@ -35,7 +81,7 @@ var is_running: bool = false
|
||||
var _join_count: int = 0
|
||||
|
||||
var _player_scene: PackedScene = preload("res://scenes/server_player.tscn")
|
||||
var _level_scene: PackedScene = preload("res://scenes/worlds/test_level.tscn")
|
||||
var _fallback_level_scene: PackedScene = preload("res://scenes/worlds/test_level.tscn")
|
||||
var _spawn_point: Vector3 = Vector3(0, 1.5, 0)
|
||||
|
||||
|
||||
@@ -48,8 +94,16 @@ func _ready() -> void:
|
||||
_parse_args()
|
||||
Engine.physics_ticks_per_second = PHYSICS_HZ
|
||||
|
||||
# Load the world's level so players have real ground + collision.
|
||||
var level := _level_scene.instantiate()
|
||||
var level: Node = null
|
||||
if api_url != "" and server_token != "" and world_id != "":
|
||||
level = await _try_load_real_content()
|
||||
|
||||
if level == null:
|
||||
level = _fallback_level_scene.instantiate()
|
||||
_content_status = "fallback"
|
||||
else:
|
||||
_content_status = "loaded"
|
||||
|
||||
level.name = "World"
|
||||
add_child(level)
|
||||
var marker := level.find_child("PlayerSpawn", true, false)
|
||||
@@ -65,7 +119,9 @@ func _ready() -> void:
|
||||
multiplayer.multiplayer_peer = network_peer
|
||||
is_running = true
|
||||
_write_status()
|
||||
print("[Server] world=%s listening on ENet %d (%d Hz)" % [world_id, port, PHYSICS_HZ])
|
||||
print("[Server] world=%s listening on ENet %d (%d Hz) content=%s chunks=%d collision_shapes=%d" % [
|
||||
world_id, port, PHYSICS_HZ, _content_status, _chunks_loaded, _collision_shapes_built
|
||||
])
|
||||
|
||||
|
||||
## A spawn point offset from the level's marker so joins don't stack. Golden-
|
||||
@@ -95,9 +151,198 @@ func _parse_args() -> void:
|
||||
if i + 1 < args.size():
|
||||
status_file_path = args[i + 1]
|
||||
i += 1
|
||||
"--api-url":
|
||||
if i + 1 < args.size():
|
||||
api_url = args[i + 1].rstrip("/")
|
||||
i += 1
|
||||
"--server-token":
|
||||
if i + 1 < args.size():
|
||||
server_token = args[i + 1]
|
||||
i += 1
|
||||
i += 1
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Startup content load (world_persistence_impl.md §7.2/§7.3/§8.3)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
## Attempt to build a real level from the backend's internal content API.
|
||||
## Returns null on ANY failure (unreachable backend, no rooms, zero chunks)
|
||||
## so the caller falls back to test_level.tscn -- a content outage must
|
||||
## never make a world un-joinable.
|
||||
func _try_load_real_content() -> Node:
|
||||
var manifest_result := await _internal_get_json("/api/internal/worlds/%s/manifest" % world_id)
|
||||
if not manifest_result.ok:
|
||||
print("[Server] manifest fetch failed (%s); falling back to test_level" % manifest_result.get("detail", "?"))
|
||||
return null
|
||||
|
||||
var manifest: Dictionary = manifest_result.data
|
||||
var rooms: Array = manifest.get("rooms", [])
|
||||
var room: Variant = _pick_room(rooms)
|
||||
if room == null:
|
||||
print("[Server] world %s has no rooms; falling back to test_level" % world_id)
|
||||
return null
|
||||
if int(room.get("chunk_count", 0)) <= 0:
|
||||
print("[Server] room '%s' has zero chunks; falling back to test_level" % room.get("slug", "?"))
|
||||
return null
|
||||
|
||||
var slug: String = room.get("slug", MAIN_ROOM_SLUG)
|
||||
var spawn_pos := _spawn_pos_from_room(room)
|
||||
var spawn_coord := Chunk.coord_for_position(spawn_pos)
|
||||
|
||||
var index_path := "/api/internal/worlds/%s/rooms/%s/chunks?cx_min=%d&cx_max=%d&cy_min=%d&cy_max=%d&cz=%d" % [
|
||||
world_id, slug,
|
||||
spawn_coord.x - SPAWN_CHUNK_RADIUS, spawn_coord.x + SPAWN_CHUNK_RADIUS,
|
||||
spawn_coord.y - SPAWN_CHUNK_RADIUS, spawn_coord.y + SPAWN_CHUNK_RADIUS,
|
||||
spawn_coord.z,
|
||||
]
|
||||
var index_result := await _internal_get_json(index_path)
|
||||
if not index_result.ok:
|
||||
print("[Server] chunk index fetch failed (%s); falling back to test_level" % index_result.get("detail", "?"))
|
||||
return null
|
||||
|
||||
var world_root := Node3D.new()
|
||||
world_root.name = "World"
|
||||
var marker := Marker3D.new()
|
||||
marker.name = "PlayerSpawn"
|
||||
marker.position = spawn_pos
|
||||
world_root.add_child(marker)
|
||||
|
||||
var entries: Array = (index_result.data as Dictionary).get("chunks", [])
|
||||
for entry in entries:
|
||||
var cx: int = int(entry["cx"])
|
||||
var cy: int = int(entry["cy"])
|
||||
var cz: int = int(entry["cz"])
|
||||
var chunk_path := "/api/internal/worlds/%s/rooms/%s/chunks/%d/%d/%d" % [world_id, slug, cx, cy, cz]
|
||||
var payload_result := await _internal_get_binary(chunk_path)
|
||||
if not payload_result.ok:
|
||||
printerr("[Server] chunk fetch failed for %d/%d/%d (status %d); skipping" % [cx, cy, cz, payload_result.status])
|
||||
continue
|
||||
var decoded: ChunkDataDecoder.ChunkPayload = ChunkDataDecoder.decode_binary(payload_result.body)
|
||||
if decoded == null:
|
||||
printerr("[Server] chunk decode failed for %d/%d/%d; skipping" % [cx, cy, cz])
|
||||
continue
|
||||
_build_chunk_collision(world_root, Vector3i(cx, cy, cz), decoded)
|
||||
_chunks_loaded += 1
|
||||
|
||||
return world_root
|
||||
|
||||
|
||||
func _pick_room(rooms: Array) -> Variant:
|
||||
for r in rooms:
|
||||
if r.get("slug", "") == MAIN_ROOM_SLUG:
|
||||
return r
|
||||
if not rooms.is_empty():
|
||||
return rooms[0]
|
||||
return null
|
||||
|
||||
|
||||
func _spawn_pos_from_room(room: Dictionary) -> Vector3:
|
||||
var spawn: Variant = room.get("spawn")
|
||||
if spawn is Dictionary and (spawn as Dictionary).has("pos"):
|
||||
var p: Array = (spawn as Dictionary)["pos"]
|
||||
if p.size() >= 3:
|
||||
return Vector3(float(p[0]), float(p[1]), float(p[2]))
|
||||
return Vector3(0, 1.5, 0)
|
||||
|
||||
|
||||
## Build a StaticBody3D of box collision shapes for one decoded chunk: one
|
||||
## box per solid tile (TileDef.solid, world.md §3.2) plus one per static
|
||||
## (non-dynamic) object that isn't walkable. This is real collision derived
|
||||
## from the actual decoded payload -- there is no client-side precedent to
|
||||
## reuse (ChunkScene/TileLayerNode only build visuals; the dedicated server
|
||||
## has no renderer and needs physics bodies instead).
|
||||
func _build_chunk_collision(parent: Node3D, coord: Vector3i, data: ChunkDataDecoder.ChunkPayload) -> void:
|
||||
var body := StaticBody3D.new()
|
||||
body.name = "chunk_%d_%d_%d" % [coord.x, coord.y, coord.z]
|
||||
var chunk_origin := Vector3(
|
||||
coord.x * Chunk.CHUNK_SIZE_X,
|
||||
coord.y * Chunk.CHUNK_SIZE_Y,
|
||||
coord.z * Chunk.CHUNK_SIZE_Z
|
||||
)
|
||||
|
||||
for layer in data.tile_layers:
|
||||
for z in range(layer.depth):
|
||||
for y in range(layer.height):
|
||||
for x in range(layer.width):
|
||||
var tile_id := layer.get_tile(x, y, z)
|
||||
if tile_id == 0:
|
||||
continue
|
||||
var tile_def := layer.get_tile_def(tile_id)
|
||||
if tile_def == null or not tile_def.solid:
|
||||
continue
|
||||
var shape := CollisionShape3D.new()
|
||||
var box := BoxShape3D.new()
|
||||
box.size = Vector3.ONE
|
||||
shape.shape = box
|
||||
shape.position = chunk_origin + Vector3(x + 0.5, y + 0.5, z + 0.5)
|
||||
body.add_child(shape)
|
||||
_collision_shapes_built += 1
|
||||
|
||||
for obj in data.objects:
|
||||
if obj.dynamic:
|
||||
continue # dynamic templates are spawnable entities, not static geometry
|
||||
if bool(obj.properties.get("walkable", true)):
|
||||
continue
|
||||
var shape := CollisionShape3D.new()
|
||||
var box := BoxShape3D.new()
|
||||
box.size = obj.scale
|
||||
shape.shape = box
|
||||
shape.position = obj.position
|
||||
body.add_child(shape)
|
||||
_collision_shapes_built += 1
|
||||
|
||||
if body.get_child_count() > 0:
|
||||
parent.add_child(body)
|
||||
|
||||
|
||||
## Minimal internal-API HTTP GET, bearer-authenticated with --server-token
|
||||
## (world_persistence_impl.md §7.3). Deliberately separate from ApiClient:
|
||||
## that autoload's `request()` always decodes the response body as
|
||||
## UTF-8/JSON, which corrupts binary chunk payloads, and its auth model is
|
||||
## the player's JWT, not this process's per-spawn server token.
|
||||
func _internal_get_json(path: String) -> Dictionary:
|
||||
var raw := await _internal_get(path, "application/json")
|
||||
if not raw.ok:
|
||||
return {"ok": false, "status": raw.status, "detail": raw.get("detail", ""), "data": null}
|
||||
var parsed: Variant = JSON.parse_string(raw.body.get_string_from_utf8())
|
||||
if not (parsed is Dictionary):
|
||||
return {"ok": false, "status": raw.status, "detail": "invalid JSON response", "data": null}
|
||||
return {"ok": true, "status": raw.status, "detail": "", "data": parsed}
|
||||
|
||||
|
||||
func _internal_get_binary(path: String) -> Dictionary:
|
||||
return await _internal_get(path, "application/octet-stream")
|
||||
|
||||
|
||||
func _internal_get(path: String, accept: String) -> Dictionary:
|
||||
var http := HTTPRequest.new()
|
||||
http.timeout = CONTENT_FETCH_TIMEOUT
|
||||
add_child(http)
|
||||
|
||||
var headers := PackedStringArray()
|
||||
headers.append("Accept: " + accept)
|
||||
headers.append("Authorization: Bearer " + server_token)
|
||||
|
||||
var url := api_url + path
|
||||
var err := http.request(url, headers, HTTPClient.METHOD_GET)
|
||||
if err != OK:
|
||||
http.queue_free()
|
||||
return {"ok": false, "status": 0, "detail": "request() failed to start (%d)" % err, "body": PackedByteArray()}
|
||||
|
||||
var args: Array = await http.request_completed
|
||||
var result_code: int = args[0]
|
||||
var response_code: int = args[1]
|
||||
var body: PackedByteArray = args[3]
|
||||
http.queue_free()
|
||||
|
||||
if result_code != HTTPRequest.RESULT_SUCCESS:
|
||||
return {"ok": false, "status": 0, "detail": "transport error (%d)" % result_code, "body": PackedByteArray()}
|
||||
if response_code < 200 or response_code >= 300:
|
||||
return {"ok": false, "status": response_code, "detail": "HTTP %d" % response_code, "body": body}
|
||||
return {"ok": true, "status": response_code, "detail": "", "body": body}
|
||||
|
||||
|
||||
func _physics_process(_delta: float) -> void:
|
||||
if not is_running:
|
||||
return
|
||||
@@ -176,7 +421,8 @@ func _on_peer_disconnected(peer_id: int) -> void:
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Status file for the supervisor's idle reaper
|
||||
# Status file for the supervisor's idle reaper + readiness wait
|
||||
# (world_persistence_impl.md §7.4 / game_servers.py's _await_ready)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
func _write_status() -> void:
|
||||
@@ -190,5 +436,12 @@ func _write_status() -> void:
|
||||
"players": players.size(),
|
||||
"tick": tick,
|
||||
"updated": Time.get_unix_time_from_system(),
|
||||
# game_servers.py's _await_ready() polls for this -- only ever
|
||||
# written true, and only once content has been decided (loaded
|
||||
# or fallen back) AND create_server() has already succeeded.
|
||||
"ready": is_running,
|
||||
"content": _content_status,
|
||||
"chunks_loaded": _chunks_loaded,
|
||||
"collision_shapes": _collision_shapes_built,
|
||||
}))
|
||||
f.close()
|
||||
|
||||
@@ -0,0 +1,132 @@
|
||||
extends SceneTree
|
||||
## Proves the client-side ChunkDataDecoder decodes the backend's exact golden
|
||||
## fixture files (backend/tests/fixtures/chunks/*.bin) with byte-identical
|
||||
## logical values -- the actual cross-language contract this whole
|
||||
## persistence system depends on. Also regression-covers the float32
|
||||
## int<->float numeric-cast bug (fixed alongside this test): `bits as float`
|
||||
## silently corrupted every non-integer value (1.5 decoded as 1069547520.0).
|
||||
##
|
||||
## Run: ~/godot/godot --headless --script res://scripts/smoke_test_chunk_codec_interop.gd
|
||||
|
||||
const FIXTURES_DIR := "res://backend/tests/fixtures/chunks/"
|
||||
|
||||
var passed := 0
|
||||
var failed := 0
|
||||
|
||||
|
||||
func _check(label: String, cond: bool) -> void:
|
||||
if cond:
|
||||
passed += 1
|
||||
print(" PASS: ", label)
|
||||
else:
|
||||
failed += 1
|
||||
print(" FAIL: ", label)
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
_test_float32_roundtrip()
|
||||
_test_empty_chunk_fixture()
|
||||
_test_simple_tile_chunk_fixture()
|
||||
_test_chunk_with_objects_fixture()
|
||||
_test_nonzero_bounds_roundtrip()
|
||||
|
||||
print("\n=== SMOKE RESULT: %d/%d passed ===" % [passed, passed + failed])
|
||||
quit(0 if failed == 0 else 1)
|
||||
|
||||
|
||||
func _test_nonzero_bounds_roundtrip() -> void:
|
||||
print("--- client-local encode_binary/decode_binary round-trip, nonzero bounds position ---")
|
||||
# Regression for a real bug: _build_metadata_section used to write raw
|
||||
# `bounds.size` into the wire's 2nd float triple, but the wire format
|
||||
# (and _parse_metadata_section) treats that triple as max_pos, deriving
|
||||
# size = max - min. AABB(Vector3.ZERO, size) masks this (size == max
|
||||
# when position is 0), so this specifically uses a real, nonzero chunk
|
||||
# position -- e.g. the chunk at coord (3,-1,0), matching the backend
|
||||
# golden fixture's own bounds.position (96,-32,0) -- to catch it for real.
|
||||
var payload := ChunkDataDecoder.ChunkPayload.new()
|
||||
payload.world_id = "1"
|
||||
payload.room_id = "main"
|
||||
payload.coord = Vector3i(3, -1, 0)
|
||||
payload.bounds = AABB(Vector3(96.0, -32.0, 0.0), Vector3(32.0, 32.0, 1.0))
|
||||
|
||||
var encoded := ChunkDataDecoder.encode_binary(payload)
|
||||
var decoded: ChunkDataDecoder.ChunkPayload = ChunkDataDecoder.decode_binary(encoded)
|
||||
_check("decoded without error", decoded != null)
|
||||
if decoded == null:
|
||||
return
|
||||
_check("bounds.position survives round-trip (96,-32,0)", decoded.bounds.position.is_equal_approx(Vector3(96.0, -32.0, 0.0)))
|
||||
_check("bounds.size survives round-trip (32,32,1) -- the actual regression check", decoded.bounds.size.is_equal_approx(Vector3(32.0, 32.0, 1.0)))
|
||||
|
||||
|
||||
func _read_fixture(name: String) -> PackedByteArray:
|
||||
var f := FileAccess.open(FIXTURES_DIR + name, FileAccess.READ)
|
||||
if f == null:
|
||||
push_error("Could not open fixture: " + name)
|
||||
return PackedByteArray()
|
||||
return f.get_buffer(f.get_length())
|
||||
|
||||
|
||||
func _test_float32_roundtrip() -> void:
|
||||
print("--- float32 bitcast regression (the actual bug this fix addresses) ---")
|
||||
for val in [1.5, -110.25, 0.5, 3.14159, -0.001, 0.0, 100.0]:
|
||||
var encoded: PackedByteArray = ChunkDataDecoder._write_float32(val)
|
||||
var decoded: float = ChunkDataDecoder._read_float32(encoded, 0)
|
||||
_check("float32 round-trip for %s (got %s)" % [val, decoded], is_equal_approx(decoded, val))
|
||||
# The specific regression case: 1.5 must NOT decode as 1069547520.0
|
||||
# (the old `bits as float` numeric-cast bug's actual observed output).
|
||||
var bad_encoded := ChunkDataDecoder._write_float32(1.5)
|
||||
var bad_decoded: float = ChunkDataDecoder._read_float32(bad_encoded, 0)
|
||||
_check("1.5 does not decode as the old numeric-cast bug's 1069547520.0", not is_equal_approx(bad_decoded, 1069547520.0))
|
||||
|
||||
|
||||
func _test_empty_chunk_fixture() -> void:
|
||||
print("--- backend golden fixture: empty_chunk.bin ---")
|
||||
var data := _read_fixture("empty_chunk.bin")
|
||||
_check("fixture file read (non-empty)", data.size() > 0)
|
||||
var payload: ChunkDataDecoder.ChunkPayload = ChunkDataDecoder.decode_binary(data)
|
||||
_check("decoded without error", payload != null)
|
||||
if payload == null:
|
||||
return
|
||||
_check("world_id matches backend fixture (7)", payload.world_id == "7")
|
||||
_check("no tile layers", payload.tile_layers.is_empty())
|
||||
_check("no objects", payload.objects.is_empty())
|
||||
_check("revision matches backend fixture (1)", payload.revision == 1)
|
||||
|
||||
|
||||
func _test_simple_tile_chunk_fixture() -> void:
|
||||
print("--- backend golden fixture: simple_tile_chunk.bin ---")
|
||||
var data := _read_fixture("simple_tile_chunk.bin")
|
||||
var payload: ChunkDataDecoder.ChunkPayload = ChunkDataDecoder.decode_binary(data)
|
||||
_check("decoded without error", payload != null)
|
||||
if payload == null:
|
||||
return
|
||||
_check("world_id matches (12)", payload.world_id == "12")
|
||||
_check("coord matches (3,-1,0)", payload.coord == Vector3i(3, -1, 0))
|
||||
_check("bounds.position matches (96.0,-32.0,0.0) -- non-trivial floats", payload.bounds.position.is_equal_approx(Vector3(96.0, -32.0, 0.0)))
|
||||
_check("bounds.size matches (32.0,32.0,1.0)", payload.bounds.size.is_equal_approx(Vector3(32.0, 32.0, 1.0)))
|
||||
_check("one tile layer parsed", payload.tile_layers.size() == 1)
|
||||
if payload.tile_layers.size() == 1:
|
||||
var layer: ChunkDataDecoder.TileLayerData = payload.tile_layers[0]
|
||||
_check("tile layer dims 4x4x1", layer.width == 4 and layer.height == 4 and layer.depth == 1)
|
||||
_check("tile data matches backend fixture", layer.tiles == PackedInt32Array([0, 1, 1, 0, 1, 2, 2, 1, 1, 2, 2, 1, 0, 1, 1, 0]))
|
||||
_check("revision matches (2)", payload.revision == 2)
|
||||
|
||||
|
||||
func _test_chunk_with_objects_fixture() -> void:
|
||||
print("--- backend golden fixture: chunk_with_objects.bin (real non-integer floats) ---")
|
||||
var data := _read_fixture("chunk_with_objects.bin")
|
||||
var payload: ChunkDataDecoder.ChunkPayload = ChunkDataDecoder.decode_binary(data)
|
||||
_check("decoded without error", payload != null)
|
||||
if payload == null:
|
||||
return
|
||||
_check("one object parsed", payload.objects.size() >= 1)
|
||||
if payload.objects.is_empty():
|
||||
return
|
||||
var obj: ChunkDataDecoder.WorldObjectData = payload.objects[0]
|
||||
_check("object id matches (obj_0001)", obj.id == "obj_0001")
|
||||
_check("object asset_id matches (props/chest)", obj.asset_id == "props/chest")
|
||||
# The core regression check: these are exactly the kind of non-integer
|
||||
# values that decoded as garbage under the old `bits as float` bug.
|
||||
_check("object position.x matches 101.5 exactly (was the corrupted value)", is_equal_approx(obj.position.x, 101.5))
|
||||
_check("object position.y matches -110.25 exactly (was the corrupted value)", is_equal_approx(obj.position.y, -110.25))
|
||||
_check("object position.z matches 0.5 exactly (was the corrupted value)", is_equal_approx(obj.position.z, 0.5))
|
||||
@@ -0,0 +1,189 @@
|
||||
extends SceneTree
|
||||
## Real integration test for HttpChunkSource against a live backend.
|
||||
##
|
||||
## Covers docs/architecture/world_persistence_impl.md D6/§8.4: the client
|
||||
## streams chunks over HTTP through the same ChunkStreamManager.set_server_rpc()
|
||||
## seam a fake/ENet source would use. This proves the adapter actually
|
||||
## satisfies that seam end-to-end -- a real PUT'd chunk decodes into a real
|
||||
## ChunkScene with real tile layers + objects, an unwritten coordinate
|
||||
## "renders empty" instead of erroring, and a second fetch of an unchanged
|
||||
## chunk round-trips through the 304/ETag cache path without failing.
|
||||
##
|
||||
## Run with:
|
||||
## godot --headless --path . --script res://scripts/smoke_test_http_chunk_source.gd
|
||||
##
|
||||
## Requires the backend to be running (default base URL
|
||||
## `application/agp/api_base_url` -> http://127.0.0.1:8000, overridable via
|
||||
## AGP_API_BASE_URL).
|
||||
|
||||
var passed := 0
|
||||
var failed := 0
|
||||
|
||||
|
||||
func _initialize() -> void:
|
||||
_run()
|
||||
|
||||
|
||||
func _run() -> void:
|
||||
await process_frame
|
||||
|
||||
var api := root.get_node("ApiClient")
|
||||
|
||||
randomize()
|
||||
var unique_id: int = int(Time.get_unix_time_from_system() * 1000) + randi() % 100000
|
||||
var username := "httpchunk_%d" % unique_id
|
||||
var email := "httpchunk_%d@test.example.com" % unique_id
|
||||
var reg: Dictionary = await api.register(username, email, "SmokeTest123!", "1990-01-01")
|
||||
if not _check("setup: register succeeded", reg.ok):
|
||||
print(" detail: ", reg.detail)
|
||||
_finish()
|
||||
return
|
||||
|
||||
var world_body := JSON.stringify({
|
||||
"name": "HttpChunkSource Smoke World %d" % unique_id,
|
||||
"visibility": "public",
|
||||
})
|
||||
var world_result: Dictionary = await api.request(
|
||||
HTTPClient.METHOD_POST, "/api/worlds/", world_body, "application/json", true
|
||||
)
|
||||
if not _check("setup: world created", world_result.ok):
|
||||
print(" detail: ", world_result.detail)
|
||||
_finish()
|
||||
return
|
||||
var world_id: int = (world_result.data as Dictionary)["id"]
|
||||
|
||||
# Seed a real chunk at (0,0,0): one solid tile + one static object, built
|
||||
# with the same client-side codec HttpChunkSource's decode path uses on
|
||||
# the way back in (round-tripping through the real backend, not a mock).
|
||||
var chunk_payload := _build_test_chunk(world_id)
|
||||
var encoded := ChunkDataDecoder.encode_binary(chunk_payload)
|
||||
# ApiClient.request() only takes a String body, which can't carry
|
||||
# arbitrary binary safely -- PUT with a dedicated HTTPRequest instead
|
||||
# (request_raw takes a real PackedByteArray), matching what the real
|
||||
# backend test suite sends.
|
||||
var put_result: Dictionary = await _put_binary(api, world_id, encoded)
|
||||
if not _check("setup: chunk PUT succeeded", put_result.ok):
|
||||
print(" detail: ", put_result.detail)
|
||||
_finish()
|
||||
return
|
||||
|
||||
# Build the real ChunkStreamManager + HttpChunkSource pair and wire them
|
||||
# exactly as real gameplay code would.
|
||||
var manager := ChunkStreamManager.new()
|
||||
root.add_child(manager)
|
||||
var source := HttpChunkSource.new()
|
||||
source.world_id = str(world_id)
|
||||
source.room_slug = "main"
|
||||
source.stream_manager = manager
|
||||
manager.add_child(source)
|
||||
manager.set_server_rpc(source)
|
||||
|
||||
# 1. A written coordinate decodes into a real ChunkScene.
|
||||
manager._load_chunk(Vector3i(0, 0, 0))
|
||||
var chunk_scene: Node = await _wait_for_chunk(manager, Vector3i(0, 0, 0))
|
||||
_check("written chunk (0,0,0) loaded via HttpChunkSource", chunk_scene != null)
|
||||
if chunk_scene != null:
|
||||
_check("loaded chunk has 1 tile layer", chunk_scene.tile_layers.size() == 1)
|
||||
_check("loaded chunk tile layer has the expected solid tile",
|
||||
chunk_scene.tile_layers[0].tiles[0] == 1)
|
||||
_check("loaded chunk has 1 world object", chunk_scene.world_objects.size() == 1)
|
||||
|
||||
# 2. An unwritten coordinate renders empty, not an error.
|
||||
manager._load_chunk(Vector3i(9, 9, 0))
|
||||
var empty_scene: Node = await _wait_for_chunk(manager, Vector3i(9, 9, 0))
|
||||
_check("unwritten chunk (9,9,0) still resolves (renders empty)", empty_scene != null)
|
||||
if empty_scene != null:
|
||||
_check("unwritten chunk has no tile layers", empty_scene.tile_layers.is_empty())
|
||||
|
||||
# 3. Re-fetching the same written chunk exercises the ETag/304 path
|
||||
# (can't observe the wire status code directly here, but a stale cache
|
||||
# entry or a broken conditional-request path would either error or
|
||||
# silently return corrupt/empty data -- this proves it doesn't).
|
||||
manager.force_reload_chunk(Vector3i(0, 0, 0))
|
||||
var refetched: Node = await _wait_for_chunk(manager, Vector3i(0, 0, 0))
|
||||
_check("re-fetch of unchanged chunk (0,0,0) round-trips via cache/304 path", refetched != null)
|
||||
if refetched != null:
|
||||
_check("re-fetched chunk still has 1 tile layer", refetched.tile_layers.size() == 1)
|
||||
|
||||
_finish()
|
||||
|
||||
|
||||
func _build_test_chunk(world_id: int) -> ChunkDataDecoder.ChunkPayload:
|
||||
var layer := ChunkDataDecoder.TileLayerData.new()
|
||||
layer.name = "ground"
|
||||
layer.layer_id = 0
|
||||
layer.width = 32
|
||||
layer.height = 32
|
||||
layer.depth = 1
|
||||
var empty_def := TileDef.new(0, "", false, 0, 1)
|
||||
var solid_def := TileDef.new(1, "tiles/stone", true, 0, 1)
|
||||
layer.palette = [empty_def, solid_def]
|
||||
var tiles := PackedInt32Array()
|
||||
tiles.resize(32 * 32 * 1)
|
||||
tiles[0] = 1 # (x=0, y=0, z=0) solid
|
||||
layer.tiles = tiles
|
||||
|
||||
var obj := ChunkDataDecoder.WorldObjectData.new()
|
||||
obj.id = "obj_1"
|
||||
obj.type = "prop"
|
||||
obj.asset_id = "props/rock"
|
||||
obj.position = Vector3(1.0, 1.0, 0.0)
|
||||
obj.properties = {"tag": "smoke"}
|
||||
|
||||
var payload := ChunkDataDecoder.ChunkPayload.new()
|
||||
payload.world_id = str(world_id)
|
||||
payload.room_id = "main"
|
||||
payload.coord = Vector3i(0, 0, 0)
|
||||
payload.bounds = AABB(Vector3.ZERO, Vector3(32, 32, 1))
|
||||
payload.tile_layers = [layer]
|
||||
payload.objects = [obj]
|
||||
payload.revision = 1
|
||||
payload.author = "smoke_test"
|
||||
payload.created_at = 1700000000
|
||||
payload.updated_at = 1700000000
|
||||
return payload
|
||||
|
||||
|
||||
func _put_binary(api: Object, world_id: int, bytes: PackedByteArray) -> Dictionary:
|
||||
var http := HTTPRequest.new()
|
||||
root.add_child(http)
|
||||
var bearer: String = api.bearer_token
|
||||
var headers := PackedStringArray([
|
||||
"Content-Type: application/octet-stream",
|
||||
"X-Base-Revision: 0",
|
||||
"Authorization: " + bearer,
|
||||
])
|
||||
var base: String = api.base_url
|
||||
var url := base + "/api/worlds/%d/rooms/main/chunks/0/0/0" % world_id
|
||||
var err := http.request_raw(url, headers, HTTPClient.METHOD_PUT, bytes)
|
||||
if err != OK:
|
||||
http.queue_free()
|
||||
return {"ok": false, "detail": "request_raw failed (%d)" % err}
|
||||
var args: Array = await http.request_completed
|
||||
var response_code: int = args[1]
|
||||
var body: PackedByteArray = args[3]
|
||||
http.queue_free()
|
||||
return {"ok": response_code >= 200 and response_code < 300, "status": response_code, "detail": body.get_string_from_utf8()}
|
||||
|
||||
|
||||
func _wait_for_chunk(manager: ChunkStreamManager, coord: Vector3i, max_frames: int = 120) -> Node:
|
||||
for i in max_frames:
|
||||
await process_frame
|
||||
if manager.is_chunk_loaded(coord):
|
||||
return manager.get_loaded_chunk(coord)
|
||||
return null
|
||||
|
||||
|
||||
func _check(description: String, condition: bool) -> bool:
|
||||
if condition:
|
||||
print(" PASS: ", description)
|
||||
passed += 1
|
||||
else:
|
||||
printerr(" FAIL: ", description)
|
||||
failed += 1
|
||||
return condition
|
||||
|
||||
|
||||
func _finish() -> void:
|
||||
print("\n=== SMOKE RESULT: %d/%d passed ===" % [passed, passed + failed])
|
||||
quit(0 if failed == 0 else 1)
|
||||
Reference in New Issue
Block a user