Compare commits
20 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 9334caf533 | |||
| f40940a491 | |||
| 546678a30d | |||
| d1f4547c5f | |||
| 9661b9a81c | |||
| 4eb4476fc3 | |||
| f34a4806ef | |||
| 9f04cef447 | |||
| 4ff74ae823 | |||
| 31f6974c7a | |||
| 7c37a0dc2f | |||
| 4c95ad79e6 | |||
| 65995f30a6 | |||
| fd88cef32f | |||
| eb39e4393d | |||
| 9c086a4b10 | |||
| b6c6ddfbc4 | |||
| 186a79a43e | |||
| c54ea6f055 | |||
| b562e9f7b3 |
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"objects": {
|
||||
"crate_small": {
|
||||
"asset_id": "props/crate_small.glb",
|
||||
"type": "prop",
|
||||
"display_name": "Small Crate",
|
||||
"category": "props"
|
||||
},
|
||||
"rock_01": {
|
||||
"asset_id": "props/rock_01.glb",
|
||||
"type": "prop",
|
||||
"display_name": "Rock",
|
||||
"category": "nature"
|
||||
},
|
||||
"tree_pine_01": {
|
||||
"asset_id": "props/tree_pine_01.glb",
|
||||
"type": "prop",
|
||||
"display_name": "Pine Tree",
|
||||
"category": "nature"
|
||||
},
|
||||
"lamp_post_01": {
|
||||
"asset_id": "props/lamp_post_01.glb",
|
||||
"type": "prop",
|
||||
"display_name": "Lamp Post",
|
||||
"category": "props"
|
||||
},
|
||||
"chest_01": {
|
||||
"asset_id": "props/chest.glb",
|
||||
"type": "interactable",
|
||||
"display_name": "Treasure Chest",
|
||||
"category": "interactables"
|
||||
},
|
||||
"spawn_point": {
|
||||
"asset_id": "",
|
||||
"type": "spawn_point",
|
||||
"display_name": "Spawn Point",
|
||||
"category": "gameplay"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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")
|
||||
@@ -0,0 +1,33 @@
|
||||
"""add presence columns to users
|
||||
|
||||
Revision ID: 0006_add_presence_columns
|
||||
Revises: 0005_add_world_content_tables
|
||||
Create Date: 2026-09-14 00:00:00.000000
|
||||
|
||||
Ported forward from the orphaned agent/dd2a126b57a1 branch (originally
|
||||
2a9b9873244a_add_presence_columns.py, down_revision 0001_initial) and
|
||||
rebased onto the current migration head. See app/services/presence.py /
|
||||
app/routers/presence.py.
|
||||
"""
|
||||
from typing import Sequence, Union
|
||||
|
||||
from alembic import op
|
||||
import sqlalchemy as sa
|
||||
|
||||
# revision identifiers, used by Alembic.
|
||||
revision: str = "0006_add_presence_columns"
|
||||
down_revision: Union[str, None] = "0005_add_world_content_tables"
|
||||
branch_labels: Union[str, Sequence[str], None] = None
|
||||
depends_on: Union[str, Sequence[str], None] = None
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
"""Add last_seen_at and status_message columns to users table."""
|
||||
op.add_column("users", sa.Column("last_seen_at", sa.DateTime(timezone=True), nullable=True))
|
||||
op.add_column("users", sa.Column("status_message", sa.Text(), nullable=True))
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
"""Remove presence columns from users table."""
|
||||
op.drop_column("users", "status_message")
|
||||
op.drop_column("users", "last_seen_at")
|
||||
@@ -0,0 +1,118 @@
|
||||
"""add social graph tables (friendships, follows, blocks)
|
||||
|
||||
Revision ID: 0007_add_social_graph_tables
|
||||
Revises: 0006_add_presence_columns
|
||||
Create Date: 2026-09-15 00:00:00.000000
|
||||
|
||||
docs/planning/social.md US-1 / app/models/social.py. Models + migration
|
||||
only -- the request/accept/block business logic lives in the sibling
|
||||
"Friends & follow API router" task.
|
||||
"""
|
||||
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 = "0007_add_social_graph_tables"
|
||||
down_revision: Union[str, None] = "0006_add_presence_columns"
|
||||
branch_labels: Union[str, Sequence[str], None] = None
|
||||
depends_on: Union[str, Sequence[str], None] = None
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
friendship_status = postgresql.ENUM(
|
||||
"pending", "accepted", name="friendship_status"
|
||||
)
|
||||
friendship_status.create(op.get_bind(), checkfirst=True)
|
||||
|
||||
op.create_table(
|
||||
"friendships",
|
||||
sa.Column("id", sa.Integer(), primary_key=True),
|
||||
sa.Column(
|
||||
"requester_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column(
|
||||
"addressee_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column(
|
||||
"status",
|
||||
postgresql.ENUM(
|
||||
"pending", "accepted", name="friendship_status", create_type=False
|
||||
),
|
||||
nullable=False,
|
||||
server_default="pending",
|
||||
),
|
||||
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("requester_id", "addressee_id", name="uq_friendships_pair"),
|
||||
)
|
||||
op.create_index("ix_friendships_requester_id", "friendships", ["requester_id"])
|
||||
op.create_index("ix_friendships_addressee_id", "friendships", ["addressee_id"])
|
||||
|
||||
op.create_table(
|
||||
"follows",
|
||||
sa.Column("id", sa.Integer(), primary_key=True),
|
||||
sa.Column(
|
||||
"follower_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column(
|
||||
"followed_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
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("follower_id", "followed_id", name="uq_follows_pair"),
|
||||
)
|
||||
op.create_index("ix_follows_follower_id", "follows", ["follower_id"])
|
||||
op.create_index("ix_follows_followed_id", "follows", ["followed_id"])
|
||||
|
||||
op.create_table(
|
||||
"blocks",
|
||||
sa.Column("id", sa.Integer(), primary_key=True),
|
||||
sa.Column(
|
||||
"blocker_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column(
|
||||
"blocked_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
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("blocker_id", "blocked_id", name="uq_blocks_pair"),
|
||||
)
|
||||
op.create_index("ix_blocks_blocker_id", "blocks", ["blocker_id"])
|
||||
op.create_index("ix_blocks_blocked_id", "blocks", ["blocked_id"])
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
op.drop_index("ix_blocks_blocked_id", table_name="blocks")
|
||||
op.drop_index("ix_blocks_blocker_id", table_name="blocks")
|
||||
op.drop_table("blocks")
|
||||
|
||||
op.drop_index("ix_follows_followed_id", table_name="follows")
|
||||
op.drop_index("ix_follows_follower_id", table_name="follows")
|
||||
op.drop_table("follows")
|
||||
|
||||
op.drop_index("ix_friendships_addressee_id", table_name="friendships")
|
||||
op.drop_index("ix_friendships_requester_id", table_name="friendships")
|
||||
op.drop_table("friendships")
|
||||
|
||||
postgresql.ENUM(name="friendship_status").drop(op.get_bind(), checkfirst=True)
|
||||
@@ -0,0 +1,178 @@
|
||||
"""add chat tables (conversations, messages, message_reports)
|
||||
|
||||
Revision ID: 0008_add_chat_tables
|
||||
Revises: 0007_add_social_graph_tables
|
||||
Create Date: 2026-09-15 00:00:00.000000
|
||||
|
||||
docs/planning/social.md US-4 / app/models/chat.py. Models + migration only
|
||||
-- text filtering, rate limiting, and send/report/moderation endpoints live
|
||||
in sibling tasks that depend on this one.
|
||||
"""
|
||||
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 = "0008_add_chat_tables"
|
||||
down_revision: Union[str, None] = "0007_add_social_graph_tables"
|
||||
branch_labels: Union[str, Sequence[str], None] = None
|
||||
depends_on: Union[str, Sequence[str], None] = None
|
||||
|
||||
|
||||
def upgrade() -> None:
|
||||
message_report_status = postgresql.ENUM(
|
||||
"open", "resolved", "dismissed", name="message_report_status"
|
||||
)
|
||||
message_report_status.create(op.get_bind(), checkfirst=True)
|
||||
|
||||
op.create_table(
|
||||
"conversations",
|
||||
sa.Column("id", sa.Integer(), primary_key=True),
|
||||
sa.Column(
|
||||
"user_a_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column(
|
||||
"user_b_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
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("user_a_id", "user_b_id", name="uq_conversations_pair"),
|
||||
sa.CheckConstraint("user_a_id < user_b_id", name="ck_conversations_ordered_pair"),
|
||||
)
|
||||
op.create_index("ix_conversations_user_a_id", "conversations", ["user_a_id"])
|
||||
op.create_index("ix_conversations_user_b_id", "conversations", ["user_b_id"])
|
||||
|
||||
op.create_table(
|
||||
"conversation_participants",
|
||||
sa.Column("id", sa.Integer(), primary_key=True),
|
||||
sa.Column(
|
||||
"conversation_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("conversations.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column(
|
||||
"user_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
),
|
||||
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=False),
|
||||
sa.UniqueConstraint(
|
||||
"conversation_id", "user_id", name="uq_conversation_participants_pair"
|
||||
),
|
||||
)
|
||||
op.create_index(
|
||||
"ix_conversation_participants_conversation_id",
|
||||
"conversation_participants",
|
||||
["conversation_id"],
|
||||
)
|
||||
op.create_index(
|
||||
"ix_conversation_participants_user_id", "conversation_participants", ["user_id"]
|
||||
)
|
||||
|
||||
op.create_table(
|
||||
"messages",
|
||||
sa.Column("id", sa.Integer(), primary_key=True),
|
||||
sa.Column(
|
||||
"sender_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="SET NULL"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column(
|
||||
"conversation_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("conversations.id", ondelete="CASCADE"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column(
|
||||
"world_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("worlds.id", ondelete="CASCADE"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column(
|
||||
"room_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("world_rooms.id", ondelete="CASCADE"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column("body", sa.Text(), nullable=False),
|
||||
sa.Column("filtered", sa.Boolean(), nullable=False, server_default="false"),
|
||||
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=False),
|
||||
)
|
||||
op.create_index("ix_messages_sender_id", "messages", ["sender_id"])
|
||||
op.create_index(
|
||||
"ix_messages_conversation_created", "messages", ["conversation_id", "created_at"]
|
||||
)
|
||||
op.create_index("ix_messages_world_created", "messages", ["world_id", "created_at"])
|
||||
|
||||
op.create_table(
|
||||
"message_reports",
|
||||
sa.Column("id", sa.Integer(), primary_key=True),
|
||||
sa.Column(
|
||||
"message_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("messages.id", ondelete="SET NULL"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column(
|
||||
"reporter_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="SET NULL"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column("reason", sa.Text(), nullable=False),
|
||||
sa.Column(
|
||||
"status",
|
||||
postgresql.ENUM(
|
||||
"open", "resolved", "dismissed", name="message_report_status", create_type=False
|
||||
),
|
||||
nullable=False,
|
||||
server_default="open",
|
||||
),
|
||||
sa.Column(
|
||||
"moderator_id",
|
||||
sa.Integer(),
|
||||
sa.ForeignKey("users.id", ondelete="SET NULL"),
|
||||
nullable=True,
|
||||
),
|
||||
sa.Column("resolved_at", sa.DateTime(timezone=True), nullable=True),
|
||||
sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=False),
|
||||
)
|
||||
op.create_index("ix_message_reports_message_id", "message_reports", ["message_id"])
|
||||
op.create_index("ix_message_reports_reporter_id", "message_reports", ["reporter_id"])
|
||||
op.create_index("ix_message_reports_moderator_id", "message_reports", ["moderator_id"])
|
||||
|
||||
|
||||
def downgrade() -> None:
|
||||
op.drop_index("ix_message_reports_moderator_id", table_name="message_reports")
|
||||
op.drop_index("ix_message_reports_reporter_id", table_name="message_reports")
|
||||
op.drop_index("ix_message_reports_message_id", table_name="message_reports")
|
||||
op.drop_table("message_reports")
|
||||
|
||||
op.drop_index("ix_messages_world_created", table_name="messages")
|
||||
op.drop_index("ix_messages_conversation_created", table_name="messages")
|
||||
op.drop_index("ix_messages_sender_id", table_name="messages")
|
||||
op.drop_table("messages")
|
||||
|
||||
op.drop_index("ix_conversation_participants_user_id", table_name="conversation_participants")
|
||||
op.drop_index(
|
||||
"ix_conversation_participants_conversation_id", table_name="conversation_participants"
|
||||
)
|
||||
op.drop_table("conversation_participants")
|
||||
|
||||
op.drop_index("ix_conversations_user_b_id", table_name="conversations")
|
||||
op.drop_index("ix_conversations_user_a_id", table_name="conversations")
|
||||
op.drop_table("conversations")
|
||||
|
||||
postgresql.ENUM(name="message_report_status").drop(op.get_bind(), checkfirst=True)
|
||||
@@ -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",
|
||||
|
||||
+4
-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, presence
|
||||
|
||||
|
||||
from app.services.game_servers import supervisor
|
||||
@@ -40,8 +40,11 @@ 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.include_router(presence.router, prefix="/api/presence", tags=["presence"])
|
||||
|
||||
|
||||
@app.get("/api/health")
|
||||
|
||||
@@ -3,5 +3,15 @@ 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
|
||||
from app.models.social import Friendship, Follow, Block, FriendshipStatus
|
||||
from app.models.chat import (
|
||||
Conversation, ConversationParticipant, Message, MessageReport, ReportStatus,
|
||||
)
|
||||
|
||||
__all__ = ["User", "Session", "World", "Asset", "AvatarLoadout"]
|
||||
__all__ = [
|
||||
"User", "Session", "World", "Asset", "AvatarLoadout",
|
||||
"WorldRoom", "WorldChunk", "WorldChunkRevision",
|
||||
"Friendship", "Follow", "Block", "FriendshipStatus",
|
||||
"Conversation", "ConversationParticipant", "Message", "MessageReport", "ReportStatus",
|
||||
]
|
||||
|
||||
@@ -0,0 +1,217 @@
|
||||
"""Chat: DM conversations and world/room chat, plus message reports.
|
||||
|
||||
docs/planning/social.md §4/§5 (US-4). This module is models + schema only --
|
||||
text filtering, rate limiting, and the send/list/report/moderation endpoints
|
||||
belong to sibling tasks that depend on this one.
|
||||
|
||||
Delete-behavior choices (mirrors ``app/models/world_content.py``'s
|
||||
established convention of preserving audit/history data over cascading it
|
||||
away):
|
||||
|
||||
- ``conversations.user_a_id`` / ``user_b_id`` -> CASCADE. A DM conversation
|
||||
is meaningless with one of its two (and only) participants gone, so
|
||||
deleting either user removes the conversation outright, which in turn
|
||||
cascades to its ``conversation_participants`` rows and its ``messages``.
|
||||
- ``conversation_participants.user_id`` -> CASCADE, ``.conversation_id`` ->
|
||||
CASCADE. Pure join-table rows; they only make sense alongside both sides.
|
||||
- ``messages.conversation_id`` -> CASCADE. Deleting a conversation deletes
|
||||
its message history with it.
|
||||
- ``messages.sender_id`` -> SET NULL (nullable). Unlike a DM conversation
|
||||
(which dies with its participants above), world/room chat history and any
|
||||
message under moderation review should survive the sender's account being
|
||||
deleted -- the row just becomes attributed to no one, matching how
|
||||
``WorldChunk.updated_by_id`` / ``WorldChunkRevision.actor_id`` treat
|
||||
actor references as SET NULL rather than cascading away history.
|
||||
- ``messages.world_id`` / ``room_id`` -> CASCADE. World/room chat has no
|
||||
meaning once the world or room it was said in is gone; consistent with
|
||||
``WorldChunk``'s own CASCADE from both.
|
||||
- ``message_reports.message_id`` -> SET NULL (nullable). Same audit-trail
|
||||
reasoning as ``WorldChunkRevision`` (world_content.py): a moderation
|
||||
report is a record that something *was* said and reported, which must
|
||||
outlive the underlying message being removed (e.g. as the moderation
|
||||
action taken in response to the report itself).
|
||||
- ``message_reports.reporter_id`` / ``moderator_id`` -> SET NULL (nullable).
|
||||
Actor references for an audit record; the report itself must survive
|
||||
either account being deleted later, matching the actor-reference
|
||||
convention above.
|
||||
"""
|
||||
import enum
|
||||
|
||||
from sqlalchemy import (
|
||||
Boolean,
|
||||
CheckConstraint,
|
||||
Column,
|
||||
DateTime,
|
||||
ForeignKey,
|
||||
Index,
|
||||
Integer,
|
||||
Text,
|
||||
UniqueConstraint,
|
||||
)
|
||||
from sqlalchemy.dialects.postgresql import ENUM
|
||||
from sqlalchemy.orm import relationship
|
||||
from sqlalchemy.sql import func
|
||||
|
||||
from app.database import Base
|
||||
|
||||
|
||||
class ReportStatus(str, enum.Enum):
|
||||
OPEN = "open"
|
||||
RESOLVED = "resolved"
|
||||
DISMISSED = "dismissed"
|
||||
|
||||
|
||||
class Conversation(Base):
|
||||
"""A DM conversation between exactly two users.
|
||||
|
||||
``conversation_participants`` is the real roster (modeled as a join
|
||||
table so a future group-DM schema change can widen it beyond two rows
|
||||
without touching this table's shape), but a 2-party DM also needs a
|
||||
cheap, DB-enforced "only one conversation per pair" guarantee, which a
|
||||
plain join table can't express as a simple unique constraint. So the
|
||||
pair is additionally denormalized here as ``user_a_id``/``user_b_id``,
|
||||
always stored with the lower user id first (enforced by the check
|
||||
constraint below); the API layer is responsible for normalizing the
|
||||
pair before insert/lookup.
|
||||
"""
|
||||
|
||||
__tablename__ = "conversations"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
user_a_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
user_b_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=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
|
||||
)
|
||||
|
||||
participants = relationship(
|
||||
"ConversationParticipant", back_populates="conversation", cascade="all, delete-orphan"
|
||||
)
|
||||
messages = relationship(
|
||||
"Message", back_populates="conversation", cascade="all, delete-orphan"
|
||||
)
|
||||
|
||||
__table_args__ = (
|
||||
UniqueConstraint("user_a_id", "user_b_id", name="uq_conversations_pair"),
|
||||
CheckConstraint("user_a_id < user_b_id", name="ck_conversations_ordered_pair"),
|
||||
)
|
||||
|
||||
|
||||
class ConversationParticipant(Base):
|
||||
"""Join table of a conversation's members.
|
||||
|
||||
DMs are strictly 2-party today (enforced by ``Conversation``'s pair
|
||||
columns above), but this is modeled as a real join table -- not folded
|
||||
into ``Conversation`` -- so a later group-conversation feature can add
|
||||
rows here without a schema change to this table.
|
||||
"""
|
||||
|
||||
__tablename__ = "conversation_participants"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
conversation_id = Column(
|
||||
Integer, ForeignKey("conversations.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
user_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
|
||||
conversation = relationship("Conversation", back_populates="participants")
|
||||
user = relationship("User")
|
||||
|
||||
__table_args__ = (
|
||||
UniqueConstraint(
|
||||
"conversation_id", "user_id", name="uq_conversation_participants_pair"
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
class Message(Base):
|
||||
"""A chat message: either a DM (``conversation_id`` set) or a
|
||||
world/room chat message (``conversation_id`` null, ``world_id`` set and
|
||||
optionally ``room_id``).
|
||||
|
||||
``world_id`` is denormalized onto every world/room message (mirroring
|
||||
``WorldChunk.world_id``) so world-scoped history queries don't need a
|
||||
join through rooms; ``room_id`` narrows further to a specific room when
|
||||
the world subdivides chat by room, and is null for world-wide chat.
|
||||
"""
|
||||
|
||||
__tablename__ = "messages"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
sender_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True
|
||||
)
|
||||
conversation_id = Column(
|
||||
Integer, ForeignKey("conversations.id", ondelete="CASCADE"), nullable=True
|
||||
)
|
||||
world_id = Column(
|
||||
Integer, ForeignKey("worlds.id", ondelete="CASCADE"), nullable=True
|
||||
)
|
||||
room_id = Column(
|
||||
Integer, ForeignKey("world_rooms.id", ondelete="CASCADE"), nullable=True
|
||||
)
|
||||
body = Column(Text, nullable=False)
|
||||
filtered = Column(Boolean, nullable=False, default=False, server_default="false")
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
|
||||
sender = relationship("User")
|
||||
conversation = relationship("Conversation", back_populates="messages")
|
||||
world = relationship("World")
|
||||
room = relationship("WorldRoom")
|
||||
reports = relationship(
|
||||
"MessageReport", back_populates="message", cascade="all, delete-orphan"
|
||||
)
|
||||
|
||||
__table_args__ = (
|
||||
Index("ix_messages_conversation_created", "conversation_id", "created_at"),
|
||||
Index("ix_messages_world_created", "world_id", "created_at"),
|
||||
)
|
||||
|
||||
|
||||
class MessageReport(Base):
|
||||
"""A moderation report filed against a message.
|
||||
|
||||
``message_id`` is nullable with ``ON DELETE SET NULL`` (rather than
|
||||
CASCADE) so the report -- the audit record that something was said and
|
||||
flagged -- outlives the message row, including when the message's own
|
||||
removal is the moderation action taken in response to this report.
|
||||
"""
|
||||
|
||||
__tablename__ = "message_reports"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
message_id = Column(
|
||||
Integer, ForeignKey("messages.id", ondelete="SET NULL"), nullable=True, index=True
|
||||
)
|
||||
reporter_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True
|
||||
)
|
||||
reason = Column(Text, nullable=False)
|
||||
status = Column(
|
||||
ENUM(
|
||||
ReportStatus,
|
||||
name="message_report_status",
|
||||
create_type=False,
|
||||
values_callable=lambda enum_cls: [e.value for e in enum_cls],
|
||||
),
|
||||
nullable=False,
|
||||
default=ReportStatus.OPEN,
|
||||
server_default=ReportStatus.OPEN.value,
|
||||
)
|
||||
moderator_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True
|
||||
)
|
||||
resolved_at = Column(DateTime(timezone=True), nullable=True)
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
|
||||
|
||||
message = relationship("Message", back_populates="reports")
|
||||
reporter = relationship("User", foreign_keys=[reporter_id])
|
||||
moderator = relationship("User", foreign_keys=[moderator_id])
|
||||
@@ -0,0 +1,106 @@
|
||||
"""Social graph: friendships, follows, blocks.
|
||||
|
||||
docs/planning/social.md §4/§5 (US-1). Friends = mutual (request -> accept),
|
||||
Follow = one-way (no approval), Block = hard deny. This module is models +
|
||||
schema only -- the request/accept/block business logic (idempotent
|
||||
duplicate/self handling, removing an existing friendship/follow on block,
|
||||
etc.) belongs to the API router task that depends on this one.
|
||||
"""
|
||||
import enum
|
||||
|
||||
from sqlalchemy import Column, Integer, ForeignKey, DateTime, UniqueConstraint
|
||||
from sqlalchemy.dialects.postgresql import ENUM
|
||||
from sqlalchemy.orm import relationship
|
||||
from sqlalchemy.sql import func
|
||||
|
||||
from app.database import Base
|
||||
|
||||
|
||||
class FriendshipStatus(str, enum.Enum):
|
||||
PENDING = "pending"
|
||||
ACCEPTED = "accepted"
|
||||
|
||||
|
||||
class Friendship(Base):
|
||||
"""A friend request, directional until accepted.
|
||||
|
||||
``requester_id`` sent the request to ``addressee_id``. Once accepted the
|
||||
friendship is mutual, but the row stays directional (who asked whom) for
|
||||
audit purposes; the API layer treats it as symmetric once accepted.
|
||||
"""
|
||||
|
||||
__tablename__ = "friendships"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
requester_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
addressee_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
status = Column(
|
||||
ENUM(
|
||||
FriendshipStatus,
|
||||
name="friendship_status",
|
||||
create_type=False,
|
||||
values_callable=lambda enum_cls: [e.value for e in enum_cls],
|
||||
),
|
||||
nullable=False,
|
||||
default=FriendshipStatus.PENDING,
|
||||
server_default=FriendshipStatus.PENDING.value,
|
||||
)
|
||||
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)
|
||||
|
||||
requester = relationship("User", foreign_keys=[requester_id], back_populates="sent_friend_requests")
|
||||
addressee = relationship("User", foreign_keys=[addressee_id], back_populates="received_friend_requests")
|
||||
|
||||
__table_args__ = (
|
||||
UniqueConstraint("requester_id", "addressee_id", name="uq_friendships_pair"),
|
||||
)
|
||||
|
||||
|
||||
class Follow(Base):
|
||||
"""A one-way follow relationship: ``follower_id`` follows ``followed_id``."""
|
||||
|
||||
__tablename__ = "follows"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
follower_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
followed_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=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)
|
||||
|
||||
follower = relationship("User", foreign_keys=[follower_id], back_populates="following")
|
||||
followed = relationship("User", foreign_keys=[followed_id], back_populates="followers")
|
||||
|
||||
__table_args__ = (
|
||||
UniqueConstraint("follower_id", "followed_id", name="uq_follows_pair"),
|
||||
)
|
||||
|
||||
|
||||
class Block(Base):
|
||||
"""A hard deny: ``blocker_id`` has blocked ``blocked_id``."""
|
||||
|
||||
__tablename__ = "blocks"
|
||||
|
||||
id = Column(Integer, primary_key=True, index=True)
|
||||
blocker_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=True
|
||||
)
|
||||
blocked_id = Column(
|
||||
Integer, ForeignKey("users.id", ondelete="CASCADE"), nullable=False, index=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)
|
||||
|
||||
blocker = relationship("User", foreign_keys=[blocker_id], back_populates="blocks_initiated")
|
||||
blocked = relationship("User", foreign_keys=[blocked_id], back_populates="blocked_by")
|
||||
|
||||
__table_args__ = (
|
||||
UniqueConstraint("blocker_id", "blocked_id", name="uq_blocks_pair"),
|
||||
)
|
||||
@@ -1,7 +1,7 @@
|
||||
from datetime import date
|
||||
from typing import Optional
|
||||
|
||||
from sqlalchemy import Column, Integer, String, Boolean, DateTime, Date
|
||||
from sqlalchemy import Column, Integer, String, Boolean, DateTime, Date, Text
|
||||
from sqlalchemy.orm import relationship
|
||||
from sqlalchemy.sql import func
|
||||
|
||||
@@ -20,6 +20,10 @@ class User(Base):
|
||||
created_at = Column(DateTime(timezone=True), server_default=func.now())
|
||||
updated_at = Column(DateTime(timezone=True), onupdate=func.now())
|
||||
|
||||
# Presence / status (backend/app/services/presence.py, app/routers/presence.py)
|
||||
last_seen_at = Column(DateTime(timezone=True), nullable=True)
|
||||
status_message = Column(Text, nullable=True)
|
||||
|
||||
sessions = relationship("Session", back_populates="user", cascade="all, delete-orphan")
|
||||
refresh_tokens = relationship("RefreshToken", back_populates="user", cascade="all, delete-orphan")
|
||||
worlds = relationship("World", back_populates="owner")
|
||||
@@ -31,6 +35,44 @@ class User(Base):
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
|
||||
# Social graph (docs/planning/social.md US-1; app/models/social.py)
|
||||
sent_friend_requests = relationship(
|
||||
"Friendship",
|
||||
foreign_keys="Friendship.requester_id",
|
||||
back_populates="requester",
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
received_friend_requests = relationship(
|
||||
"Friendship",
|
||||
foreign_keys="Friendship.addressee_id",
|
||||
back_populates="addressee",
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
following = relationship(
|
||||
"Follow",
|
||||
foreign_keys="Follow.follower_id",
|
||||
back_populates="follower",
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
followers = relationship(
|
||||
"Follow",
|
||||
foreign_keys="Follow.followed_id",
|
||||
back_populates="followed",
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
blocks_initiated = relationship(
|
||||
"Block",
|
||||
foreign_keys="Block.blocker_id",
|
||||
back_populates="blocker",
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
blocked_by = relationship(
|
||||
"Block",
|
||||
foreign_keys="Block.blocked_id",
|
||||
back_populates="blocked",
|
||||
cascade="all, delete-orphan",
|
||||
)
|
||||
|
||||
@property
|
||||
def is_adult(self) -> bool:
|
||||
"""Return True if the user is 18 or older based on date_of_birth."""
|
||||
|
||||
@@ -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,146 @@
|
||||
"""Presence & status router.
|
||||
|
||||
Endpoints:
|
||||
- POST /api/presence/heartbeat -- record a heartbeat (sets Redis TTL key)
|
||||
- GET /api/presence/presence -- query presence for a list of user ids
|
||||
- PATCH /api/presence/status -- update the authenticated user's status message
|
||||
"""
|
||||
|
||||
from datetime import datetime, timezone
|
||||
from typing import Annotated
|
||||
|
||||
from fastapi import APIRouter, HTTPException, status, Depends
|
||||
from pydantic import BaseModel, Field, field_validator
|
||||
from sqlalchemy import select
|
||||
from sqlalchemy.ext.asyncio import AsyncSession
|
||||
|
||||
from app.database import get_db
|
||||
from app.dependencies import CurrentUser
|
||||
from app.models.user import User
|
||||
from app.services.presence import presence_store
|
||||
|
||||
router = APIRouter()
|
||||
|
||||
DbDep = Annotated[AsyncSession, Depends(get_db)]
|
||||
|
||||
# ──────────────────────────── Pydantic schemas ────────────────────────────────
|
||||
|
||||
_STATUS_MAX_LEN = 140
|
||||
|
||||
|
||||
class HeartbeatRequest(BaseModel):
|
||||
"""Empty body -- the caller's identity comes from the JWT."""
|
||||
|
||||
|
||||
class PresenceUser(BaseModel):
|
||||
user_id: int
|
||||
is_online: bool
|
||||
last_seen_at: datetime | None
|
||||
status_message: str | None
|
||||
|
||||
|
||||
class PresenceResponse(BaseModel):
|
||||
users: list[PresenceUser]
|
||||
|
||||
|
||||
class StatusUpdate(BaseModel):
|
||||
status_message: str | None = Field(default=None, max_length=_STATUS_MAX_LEN)
|
||||
|
||||
@field_validator("status_message")
|
||||
@classmethod
|
||||
def strip_message(cls, v: str | None) -> str | None:
|
||||
if v is not None:
|
||||
v = v.strip()
|
||||
return v
|
||||
|
||||
|
||||
# ──────────────────────────────── Endpoints ───────────────────────────────────
|
||||
|
||||
|
||||
@router.post("/heartbeat", response_model=dict)
|
||||
async def heartbeat(
|
||||
_req: HeartbeatRequest,
|
||||
current_user: CurrentUser,
|
||||
db: DbDep,
|
||||
):
|
||||
"""Record a heartbeat for the authenticated user.
|
||||
|
||||
Sets a Redis key with a TTL so the server can derive online/offline
|
||||
status without trusting client claims. Also persists last_seen_at to
|
||||
the database.
|
||||
"""
|
||||
# Update Redis TTL (presence heartbeat)
|
||||
await presence_store.heartbeat(current_user.id)
|
||||
|
||||
# Persist last_seen_at to the database
|
||||
now = datetime.now(timezone.utc)
|
||||
result = await db.execute(select(User).where(User.id == current_user.id))
|
||||
user = result.scalar_one_or_none()
|
||||
if user:
|
||||
user.last_seen_at = now
|
||||
await db.commit()
|
||||
|
||||
return {"status": "ok", "user_id": current_user.id}
|
||||
|
||||
|
||||
@router.get("/presence", response_model=PresenceResponse)
|
||||
async def get_presence(
|
||||
user_ids: str,
|
||||
current_user: CurrentUser,
|
||||
db: DbDep,
|
||||
):
|
||||
"""Return presence info for a comma-separated list of user ids.
|
||||
|
||||
Online/offline is derived from the Redis heartbeat TTL.
|
||||
last_seen_at and status_message come from the database.
|
||||
"""
|
||||
ids = [int(uid.strip()) for uid in user_ids.split(",") if uid.strip()]
|
||||
if not ids:
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_400_BAD_REQUEST,
|
||||
detail="user_ids must contain at least one integer",
|
||||
)
|
||||
|
||||
# Check Redis for online status (single round trip via MGET).
|
||||
online_ids = await presence_store.is_online_batch(ids)
|
||||
|
||||
# Fetch DB records for last_seen_at and status_message
|
||||
result = await db.execute(select(User).where(User.id.in_(ids)))
|
||||
users = {u.id: u for u in result.scalars().all()}
|
||||
|
||||
presence_users = []
|
||||
for uid in ids:
|
||||
user = users.get(uid)
|
||||
if user is None:
|
||||
continue
|
||||
presence_users.append(
|
||||
PresenceUser(
|
||||
user_id=uid,
|
||||
is_online=uid in online_ids,
|
||||
last_seen_at=user.last_seen_at,
|
||||
status_message=user.status_message,
|
||||
)
|
||||
)
|
||||
|
||||
return PresenceResponse(users=presence_users)
|
||||
|
||||
|
||||
@router.patch("/status", response_model=dict)
|
||||
async def update_status(
|
||||
body: StatusUpdate,
|
||||
current_user: CurrentUser,
|
||||
db: DbDep,
|
||||
):
|
||||
"""Update the authenticated user's status message (length-limited)."""
|
||||
result = await db.execute(select(User).where(User.id == current_user.id))
|
||||
user = result.scalar_one_or_none()
|
||||
if not user:
|
||||
raise HTTPException(
|
||||
status_code=status.HTTP_404_NOT_FOUND,
|
||||
detail="User not found",
|
||||
)
|
||||
|
||||
user.status_message = body.status_message
|
||||
await db.commit()
|
||||
|
||||
return {"status": "ok", "status_message": body.status_message}
|
||||
@@ -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,145 @@
|
||||
"""Redis-backed presence store.
|
||||
|
||||
Presence is determined by a heartbeat TTL key in Redis:
|
||||
- heartbeat(user_id) sets a TTL key per user (default 60 s).
|
||||
- is_online(user_id) / is_online_batch(user_ids) check whether the key(s)
|
||||
exist.
|
||||
|
||||
status_message and last_seen_at are persisted in the ``users`` table by the
|
||||
router (app/routers/presence.py); this store only owns the Redis side.
|
||||
|
||||
The Redis client is created lazily, on first actual use, rather than
|
||||
requiring an explicit ``connect()`` call during app startup. This matters
|
||||
because FastAPI's lifespan handler does not run under the plain
|
||||
``TestClient(app)`` instantiation this codebase's tests use (no
|
||||
``with`` block), so anything that only connected during lifespan startup
|
||||
would never connect in tests. Lazy connection means the store works
|
||||
identically whether the app was started for real or is being driven by
|
||||
pytest.
|
||||
|
||||
The client is also cached per-*event loop* rather than globally: the same
|
||||
plain ``TestClient(app)`` pattern can dispatch different requests onto
|
||||
different event loops (see the NullPool comment on ``_override_db`` in
|
||||
tests/conftest.py for the analogous asyncpg problem), and an
|
||||
``aioredis.Redis`` connection, like an asyncpg connection, breaks with
|
||||
"Event loop is closed" if reused across loops. In the real running server
|
||||
there is exactly one event loop for the process lifetime, so this
|
||||
degrades to a single cached, pooled connection there.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
|
||||
import redis.asyncio as aioredis
|
||||
|
||||
from app.config import settings
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
# Key prefix for heartbeat entries.
|
||||
_PRESENCE_KEY_PREFIX = "presence:heartbeat:"
|
||||
|
||||
# Default heartbeat TTL in seconds (1 minute).
|
||||
# Clients should heartbeat at least once per interval.
|
||||
_DEFAULT_HEARTBEAT_TTL = 60
|
||||
|
||||
|
||||
class PresenceStore:
|
||||
"""Redis-backed presence store with async, lazily-connected operations."""
|
||||
|
||||
def __init__(self, redis_url: str | None = None, heartbeat_ttl: int = _DEFAULT_HEARTBEAT_TTL):
|
||||
# redis_url is resolved from settings at first use (not at
|
||||
# construction time) so tests that override settings.REDIS_URL
|
||||
# before the first call still take effect -- this module is
|
||||
# imported (and the module-level singleton below constructed)
|
||||
# well before any such override runs.
|
||||
self._redis_url = redis_url
|
||||
self._heartbeat_ttl = heartbeat_ttl
|
||||
# Keyed by id(running loop) -- see the module docstring.
|
||||
self._clients: dict[int, aioredis.Redis] = {}
|
||||
self._connect_lock = asyncio.Lock()
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Lifecycle
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
async def _ensure_client(self) -> aioredis.Redis:
|
||||
"""Return a connected client for the current event loop, connecting
|
||||
on first use per loop."""
|
||||
loop_key = id(asyncio.get_running_loop())
|
||||
client = self._clients.get(loop_key)
|
||||
if client is None:
|
||||
async with self._connect_lock:
|
||||
client = self._clients.get(loop_key)
|
||||
if client is None:
|
||||
url = self._redis_url or settings.REDIS_URL
|
||||
client = aioredis.from_url(
|
||||
url,
|
||||
encoding="utf-8",
|
||||
decode_responses=True,
|
||||
)
|
||||
try:
|
||||
await client.ping()
|
||||
except Exception:
|
||||
logger.warning("Redis ping failed for %s", url)
|
||||
raise
|
||||
self._clients[loop_key] = client
|
||||
return client
|
||||
|
||||
async def close(self) -> None:
|
||||
"""Close the Redis connection for the current event loop, if one was
|
||||
opened."""
|
||||
loop_key = id(asyncio.get_running_loop())
|
||||
client = self._clients.pop(loop_key, None)
|
||||
if client is not None:
|
||||
await client.aclose()
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Heartbeat
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
async def heartbeat(self, user_id: int) -> None:
|
||||
"""Record a heartbeat for *user_id*.
|
||||
|
||||
Sets a TTL key so that the user is considered online as long as
|
||||
heartbeats arrive at least once per heartbeat_ttl seconds.
|
||||
"""
|
||||
client = await self._ensure_client()
|
||||
await client.set(self._heartbeat_key(user_id), "1", ex=self._heartbeat_ttl)
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Online checks
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
async def is_online(self, user_id: int) -> bool:
|
||||
"""Return True if the user has a valid heartbeat key."""
|
||||
client = await self._ensure_client()
|
||||
exists = await client.exists(self._heartbeat_key(user_id))
|
||||
return bool(exists)
|
||||
|
||||
async def is_online_batch(self, user_ids: list[int]) -> set[int]:
|
||||
"""Return the subset of user_ids that currently have a valid
|
||||
heartbeat key. Uses MGET (one round trip) rather than one EXISTS
|
||||
per user.
|
||||
"""
|
||||
if not user_ids:
|
||||
return set()
|
||||
client = await self._ensure_client()
|
||||
keys = [self._heartbeat_key(uid) for uid in user_ids]
|
||||
values = await client.mget(keys)
|
||||
return {uid for uid, v in zip(user_ids, values) if v is not None}
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
@staticmethod
|
||||
def _heartbeat_key(user_id: int) -> str:
|
||||
return f"{_PRESENCE_KEY_PREFIX}{user_id}"
|
||||
|
||||
|
||||
# Singleton instance shared by the router, so all requests share the same
|
||||
# connection pool.
|
||||
presence_store = PresenceStore()
|
||||
@@ -0,0 +1,304 @@
|
||||
"""Pluggable server-side text filtering, `docs/planning/social.md` §4/§5 (US-4).
|
||||
|
||||
social.md §4 calls for a "Pluggable `TextFilter` interface with a
|
||||
deterministic default (profanity list + normalization) so it runs without
|
||||
external services; third-party hook later". This module is that interface
|
||||
plus the default implementation:
|
||||
|
||||
- `TextFilter` is a `Protocol` -- the extension point. A future third-party
|
||||
moderation provider (a paid API, an ML classifier, etc.) just needs to
|
||||
implement `check(text) -> FilterResult`; nothing else in this module
|
||||
needs to change, and callers depend on the protocol, not a concrete
|
||||
class.
|
||||
- `ListBasedTextFilter` is the deterministic default: a configurable
|
||||
term list (JSON file, see `text_filter_terms.json` next to this module)
|
||||
matched against a normalized form of the input text so that trivial
|
||||
evasion (case changes, leetspeak substitutions, and punctuation/spacing
|
||||
inserted between letters) doesn't slip through.
|
||||
|
||||
Nothing here talks to a database, an HTTP client, or the FastAPI app -- it
|
||||
is a pure, side-effect-free (aside from reading the term list file once, at
|
||||
construction) service so it can be unit tested in isolation. It is NOT
|
||||
wired into any router/endpoint by this task; that's for the chat feature
|
||||
tasks that depend on it (social.md §6) to do.
|
||||
|
||||
Normalization approach
|
||||
-----------------------
|
||||
Matching naively against raw text misses "sh1t", "@ss", or "s.h.i.t". To
|
||||
catch these without a real tokenizer, every character of the input is
|
||||
independently normalized to at most one lowercase ASCII alphanumeric
|
||||
character (case-folded, then run through a small leetspeak substitution
|
||||
table); characters that don't reduce to `[a-z0-9]` (punctuation, spacing,
|
||||
symbols, non-ASCII) are dropped entirely rather than kept as separators.
|
||||
This collapses "s.h.i.t", "s h i t", and "SHIT" to the same normalized
|
||||
string ("shit") that a plain lowercase term list entry matches, while a
|
||||
side table (`index_map`) remembers which original character produced each
|
||||
surviving normalized character -- so a match found in the normalized
|
||||
string can still be translated back into a span of the *original* text for
|
||||
redaction.
|
||||
|
||||
This is a deliberate precision/recall tradeoff common to list-based
|
||||
filters: stripping separators and folding leetspeak increases recall
|
||||
against evasion at the cost of occasionally matching a term inside an
|
||||
unrelated longer word (e.g. a 3-letter term inside a longer benign word).
|
||||
That tradeoff is exactly why this is pluggable -- a deployment that needs
|
||||
tighter precision can swap in a smarter `TextFilter` implementation behind
|
||||
the same protocol.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import re
|
||||
from dataclasses import dataclass
|
||||
from enum import Enum
|
||||
from pathlib import Path
|
||||
from typing import Iterable, Protocol, runtime_checkable
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Public result / protocol
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class FilterAction(str, Enum):
|
||||
"""What the caller should do with a checked message."""
|
||||
|
||||
ALLOW = "allow"
|
||||
REDACT = "redact"
|
||||
REJECT = "reject"
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class FilterResult:
|
||||
"""Outcome of running a piece of text through a `TextFilter`.
|
||||
|
||||
- `action`: ALLOW (no matches), REDACT (matches replaced in
|
||||
`filtered_text`), or REJECT (matches found; the message should be
|
||||
blocked -- callers should not persist/deliver it even though
|
||||
`filtered_text` is populated for logging/audit purposes).
|
||||
- `filtered_text`: the text to actually store/deliver. Equal to the
|
||||
input for ALLOW and REJECT; has matched spans replaced for REDACT.
|
||||
- `matched_terms`: the distinct matched terms (original, un-normalized
|
||||
list entries), in first-occurrence order. Empty for ALLOW.
|
||||
"""
|
||||
|
||||
action: FilterAction
|
||||
filtered_text: str
|
||||
matched_terms: tuple[str, ...] = ()
|
||||
|
||||
|
||||
@runtime_checkable
|
||||
class TextFilter(Protocol):
|
||||
"""Extension point for text filtering/moderation providers.
|
||||
|
||||
Any implementation -- the deterministic default below, or a future
|
||||
third-party service call -- just needs this one method.
|
||||
"""
|
||||
|
||||
def check(self, text: str) -> FilterResult:
|
||||
"""Check `text` and return the action to take plus filtered text."""
|
||||
...
|
||||
|
||||
|
||||
class FilterMode(str, Enum):
|
||||
"""Configures what `ListBasedTextFilter` does when it finds a match."""
|
||||
|
||||
REDACT = "redact"
|
||||
REJECT = "reject"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Normalization
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
# Common leetspeak / lookalike substitutions, applied after case-folding.
|
||||
# Keys are already-lowercased single characters.
|
||||
_LEET_MAP: dict[str, str] = {
|
||||
"0": "o",
|
||||
"1": "i",
|
||||
"!": "i",
|
||||
"3": "e",
|
||||
"4": "a",
|
||||
"@": "a",
|
||||
"5": "s",
|
||||
"$": "s",
|
||||
"7": "t",
|
||||
"+": "t",
|
||||
"8": "b",
|
||||
"|": "l",
|
||||
}
|
||||
|
||||
_ALNUM_RE = re.compile(r"[a-z0-9]")
|
||||
|
||||
|
||||
def _normalize(text: str) -> tuple[str, list[int]]:
|
||||
"""Fold `text` to a lowercase-alnum-only string plus an index map.
|
||||
|
||||
Returns `(normalized, index_map)` where `index_map[i]` is the index
|
||||
into the *original* `text` that produced `normalized[i]`. Characters
|
||||
that don't reduce to a single `[a-z0-9]` character (punctuation,
|
||||
whitespace, symbols, most non-ASCII) are dropped from both outputs.
|
||||
"""
|
||||
normalized_chars: list[str] = []
|
||||
index_map: list[int] = []
|
||||
for i, ch in enumerate(text):
|
||||
folded = ch.casefold()
|
||||
# case-fold can expand to multiple characters for some unicode
|
||||
# (e.g. German "ß" -> "ss"); such characters are not part of the
|
||||
# leetspeak table and are not plain ascii alnum, so just skip them
|
||||
# like any other non-matching character rather than guessing.
|
||||
if len(folded) != 1:
|
||||
continue
|
||||
folded = _LEET_MAP.get(folded, folded)
|
||||
if _ALNUM_RE.fullmatch(folded):
|
||||
normalized_chars.append(folded)
|
||||
index_map.append(i)
|
||||
return "".join(normalized_chars), index_map
|
||||
|
||||
|
||||
def _normalize_term(term: str) -> str:
|
||||
normalized, _ = _normalize(term)
|
||||
return normalized
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Default term list loading
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
DEFAULT_TERMS_PATH = Path(__file__).with_name("text_filter_terms.json")
|
||||
|
||||
|
||||
def load_terms(path: Path | str | None = None) -> list[str]:
|
||||
"""Load a term list from a JSON file shaped `{"terms": [...]}`.
|
||||
|
||||
Any other top-level keys (e.g. `_readme`) are ignored. Defaults to the
|
||||
bundled `text_filter_terms.json` next to this module.
|
||||
"""
|
||||
resolved = Path(path) if path is not None else DEFAULT_TERMS_PATH
|
||||
with resolved.open("r", encoding="utf-8") as f:
|
||||
data = json.load(f)
|
||||
terms = data.get("terms", [])
|
||||
if not isinstance(terms, list):
|
||||
raise ValueError(f"{resolved}: 'terms' must be a list")
|
||||
return [str(t) for t in terms]
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Span merging / redaction helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def _merge_spans(spans: list[tuple[int, int, str]]) -> list[tuple[int, int]]:
|
||||
"""Merge overlapping/adjacent (start, end) spans, sorted by start."""
|
||||
if not spans:
|
||||
return []
|
||||
ordered = sorted((s, e) for s, e, _ in spans)
|
||||
merged: list[tuple[int, int]] = [ordered[0]]
|
||||
for start, end in ordered[1:]:
|
||||
last_start, last_end = merged[-1]
|
||||
if start <= last_end:
|
||||
merged[-1] = (last_start, max(last_end, end))
|
||||
else:
|
||||
merged.append((start, end))
|
||||
return merged
|
||||
|
||||
|
||||
def _apply_redactions(text: str, merged_spans: list[tuple[int, int]], redaction_char: str) -> str:
|
||||
if not merged_spans:
|
||||
return text
|
||||
pieces: list[str] = []
|
||||
cursor = 0
|
||||
for start, end in merged_spans:
|
||||
pieces.append(text[cursor:start])
|
||||
pieces.append(redaction_char * (end - start))
|
||||
cursor = end
|
||||
pieces.append(text[cursor:])
|
||||
return "".join(pieces)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Default implementation
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class ListBasedTextFilter:
|
||||
"""Deterministic `TextFilter`: normalized substring match against a term list.
|
||||
|
||||
`mode` controls what happens on a match:
|
||||
- `FilterMode.REDACT` (default): matched spans in the *original* text
|
||||
are replaced with `redaction_char` repeated to the matched span's
|
||||
original length; `action` is REDACT if anything matched, else ALLOW.
|
||||
- `FilterMode.REJECT`: `filtered_text` is returned unchanged but
|
||||
`action` is REJECT if anything matched (callers should treat this as
|
||||
"do not store/deliver"), else ALLOW.
|
||||
|
||||
An empty or whitespace-only string always returns ALLOW with no
|
||||
matches -- there is nothing to filter.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
terms: Iterable[str] | None = None,
|
||||
*,
|
||||
mode: FilterMode = FilterMode.REDACT,
|
||||
terms_path: Path | str | None = None,
|
||||
redaction_char: str = "*",
|
||||
) -> None:
|
||||
if terms is None:
|
||||
terms = load_terms(terms_path)
|
||||
# De-dupe while preserving order; drop blanks.
|
||||
seen: dict[str, None] = {}
|
||||
for t in terms:
|
||||
t = t.strip()
|
||||
if t:
|
||||
seen.setdefault(t, None)
|
||||
self._terms: tuple[str, ...] = tuple(seen)
|
||||
# Pre-normalize once at construction; skip terms that normalize to
|
||||
# nothing (e.g. a term that's pure punctuation).
|
||||
self._normalized_terms: list[tuple[str, str]] = [
|
||||
(normalized, original)
|
||||
for original in self._terms
|
||||
if (normalized := _normalize_term(original))
|
||||
]
|
||||
self.mode = mode
|
||||
self.redaction_char = redaction_char
|
||||
|
||||
def check(self, text: str) -> FilterResult:
|
||||
if not text or not text.strip():
|
||||
return FilterResult(action=FilterAction.ALLOW, filtered_text=text, matched_terms=())
|
||||
|
||||
normalized, index_map = _normalize(text)
|
||||
if not normalized:
|
||||
return FilterResult(action=FilterAction.ALLOW, filtered_text=text, matched_terms=())
|
||||
|
||||
spans: list[tuple[int, int, str]] = []
|
||||
for normalized_term, original_term in self._normalized_terms:
|
||||
start = 0
|
||||
term_len = len(normalized_term)
|
||||
while True:
|
||||
idx = normalized.find(normalized_term, start)
|
||||
if idx == -1:
|
||||
break
|
||||
end = idx + term_len
|
||||
orig_start = index_map[idx]
|
||||
orig_end = index_map[end - 1] + 1
|
||||
spans.append((orig_start, orig_end, original_term))
|
||||
start = end # non-overlapping: resume after this match
|
||||
|
||||
if not spans:
|
||||
return FilterResult(action=FilterAction.ALLOW, filtered_text=text, matched_terms=())
|
||||
|
||||
spans.sort(key=lambda s: s[0])
|
||||
matched_terms = tuple(dict.fromkeys(term for _, _, term in spans))
|
||||
|
||||
if self.mode is FilterMode.REJECT:
|
||||
return FilterResult(action=FilterAction.REJECT, filtered_text=text, matched_terms=matched_terms)
|
||||
|
||||
merged = _merge_spans(spans)
|
||||
filtered_text = _apply_redactions(text, merged, self.redaction_char)
|
||||
return FilterResult(action=FilterAction.REDACT, filtered_text=filtered_text, matched_terms=matched_terms)
|
||||
|
||||
|
||||
def default_text_filter(mode: FilterMode = FilterMode.REDACT) -> ListBasedTextFilter:
|
||||
"""Convenience factory for the bundled default term list."""
|
||||
return ListBasedTextFilter(mode=mode)
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"_readme": "Default deterministic term list for app.services.text_filter.ListBasedTextFilter. This is a minimal, illustrative starter list (common mild-to-strong English profanity, no slurs) meant to be replaced/extended per-deployment -- swap this file, or pass an explicit `terms`/`terms_path` to the filter, rather than editing this list in place for production moderation policy.",
|
||||
"terms": [
|
||||
"fuck",
|
||||
"shit",
|
||||
"ass",
|
||||
"asshole",
|
||||
"bitch",
|
||||
"bastard",
|
||||
"damn",
|
||||
"crap",
|
||||
"dick",
|
||||
"piss",
|
||||
"slut",
|
||||
"whore",
|
||||
"cunt",
|
||||
"douche",
|
||||
"bullshit"
|
||||
]
|
||||
}
|
||||
@@ -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)
|
||||
)
|
||||
+90
-37
@@ -1,15 +1,18 @@
|
||||
"""Shared pytest fixtures + hermetic-DB bootstrap.
|
||||
"""Shared pytest fixtures + hermetic-DB/Redis bootstrap.
|
||||
|
||||
The integration tests hit a real Postgres (Postgres-specific types: JSONB,
|
||||
native ENUMs). To make ``cd backend && pytest`` work from a clean checkout
|
||||
with no manual setup, ``pytest_configure`` below brings up an ephemeral
|
||||
Postgres via docker compose and runs the migrations IF ``DATABASE_URL`` is
|
||||
not already pointing at a reachable database. When it is (dev loop, or the
|
||||
checkpoint runner which stands the DB up itself), that path is skipped and
|
||||
the existing database is reused.
|
||||
native ENUMs) and, for presence tests, a real Redis (TTL semantics aren't
|
||||
worth faking). To make ``cd backend && pytest`` work from a clean checkout
|
||||
with no manual setup, ``pytest_configure`` below brings up ephemeral
|
||||
Postgres/Redis containers via docker compose and runs the migrations IF
|
||||
``DATABASE_URL``/``REDIS_URL`` aren't already pointing at something
|
||||
reachable. When they are (dev loop, or the checkpoint runner which stands
|
||||
these up itself), that path is skipped and the existing services are
|
||||
reused.
|
||||
|
||||
If Docker isn't available and no DB is reachable, the whole DB-backed suite
|
||||
is skipped with a clear message rather than erroring out 60+ times.
|
||||
If Docker isn't available and nothing is reachable, the whole
|
||||
DB/Redis-backed suite is skipped with a clear message rather than erroring
|
||||
out dozens of times.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
@@ -30,13 +33,32 @@ 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",
|
||||
# Social graph (app/models/social.py) -- all three FK users with
|
||||
# ON DELETE CASCADE, but list explicitly for clarity/consistency.
|
||||
"friendships", "follows", "blocks",
|
||||
# Chat (app/models/chat.py). message_reports.message_id is ON DELETE SET
|
||||
# NULL (not CASCADE, deliberately -- see chat.py), so it wouldn't be
|
||||
# reached by cascading a truncate of messages/conversations; list it
|
||||
# explicitly along with the rest for clarity/consistency.
|
||||
"message_reports", "messages", "conversation_participants", "conversations",
|
||||
"sessions", "refresh_tokens", "users",
|
||||
)
|
||||
|
||||
BACKEND_DIR = Path(__file__).resolve().parents[1]
|
||||
_COMPOSE_PROJECT = "agp-pytest"
|
||||
_EPHEMERAL_PG_PORT = 25432
|
||||
_EPHEMERAL_REDIS_PORT = 26379
|
||||
|
||||
# Set by _ensure_database() when it starts a container it owns; torn down in
|
||||
# Set by pytest_configure() when it starts container(s) it owns; torn down in
|
||||
# pytest_unconfigure.
|
||||
_started_container = False
|
||||
_db_unavailable_reason: str | None = None
|
||||
@@ -55,6 +77,11 @@ def _db_reachable(url: str) -> bool:
|
||||
return _port_open(parts.hostname or "localhost", parts.port or 5432)
|
||||
|
||||
|
||||
def _redis_reachable(url: str) -> bool:
|
||||
parts = urlsplit(url)
|
||||
return _port_open(parts.hostname or "localhost", parts.port or 6379)
|
||||
|
||||
|
||||
def _run(cmd: list[str], **kw) -> subprocess.CompletedProcess:
|
||||
return subprocess.run(cmd, cwd=BACKEND_DIR, capture_output=True, text=True, **kw)
|
||||
|
||||
@@ -62,14 +89,17 @@ def _run(cmd: list[str], **kw) -> subprocess.CompletedProcess:
|
||||
def pytest_configure(config):
|
||||
global _started_container, _db_unavailable_reason
|
||||
|
||||
if _db_reachable(settings.DATABASE_URL):
|
||||
return # dev loop / checkpoint runner already provided one
|
||||
need_db = not _db_reachable(settings.DATABASE_URL)
|
||||
need_redis = not _redis_reachable(settings.REDIS_URL)
|
||||
|
||||
if not need_db and not need_redis:
|
||||
return # dev loop / checkpoint runner already provided both
|
||||
|
||||
if not _run(["docker", "--version"]).returncode == 0:
|
||||
_db_unavailable_reason = (
|
||||
"no reachable DATABASE_URL and docker is unavailable -- run the "
|
||||
"checkpoint suite (scripts/run_checkpoint_tests.py) or start Postgres "
|
||||
"manually"
|
||||
"no reachable DATABASE_URL/REDIS_URL and docker is unavailable -- run "
|
||||
"the checkpoint suite (scripts/run_checkpoint_tests.py) or start "
|
||||
"Postgres/Redis manually"
|
||||
)
|
||||
return
|
||||
|
||||
@@ -77,33 +107,55 @@ def pytest_configure(config):
|
||||
env["COMPOSE_PROJECT_NAME"] = _COMPOSE_PROJECT
|
||||
env["POSTGRES_HOST_PORT"] = str(_EPHEMERAL_PG_PORT)
|
||||
env["POSTGRES_PORT"] = str(_EPHEMERAL_PG_PORT)
|
||||
up = _run(["docker", "compose", "up", "-d", "postgres"], env=env)
|
||||
env["REDIS_HOST_PORT"] = str(_EPHEMERAL_REDIS_PORT)
|
||||
|
||||
services = [s for s, need in (("postgres", need_db), ("redis", need_redis)) if need]
|
||||
up = _run(["docker", "compose", "up", "-d", *services], env=env)
|
||||
if up.returncode != 0:
|
||||
_db_unavailable_reason = f"docker compose up postgres failed:\n{up.stderr[-800:]}"
|
||||
_db_unavailable_reason = f"docker compose up {' '.join(services)} failed:\n{up.stderr[-800:]}"
|
||||
return
|
||||
_started_container = True
|
||||
|
||||
for _ in range(30):
|
||||
r = _run(
|
||||
["docker", "compose", "exec", "-T", "postgres",
|
||||
"pg_isready", "-U", "agp_user", "-d", "agp_db"],
|
||||
env=env,
|
||||
)
|
||||
if r.returncode == 0:
|
||||
break
|
||||
time.sleep(1)
|
||||
else:
|
||||
_db_unavailable_reason = "ephemeral Postgres never became ready"
|
||||
return
|
||||
if need_db:
|
||||
for _ in range(30):
|
||||
r = _run(
|
||||
["docker", "compose", "exec", "-T", "postgres",
|
||||
"pg_isready", "-U", "agp_user", "-d", "agp_db"],
|
||||
env=env,
|
||||
)
|
||||
if r.returncode == 0:
|
||||
break
|
||||
time.sleep(1)
|
||||
else:
|
||||
_db_unavailable_reason = "ephemeral Postgres never became ready"
|
||||
return
|
||||
|
||||
url = f"postgresql+asyncpg://agp_user:agp_password@localhost:{_EPHEMERAL_PG_PORT}/agp_db"
|
||||
os.environ["DATABASE_URL"] = url
|
||||
settings.DATABASE_URL = url
|
||||
url = f"postgresql+asyncpg://agp_user:agp_password@localhost:{_EPHEMERAL_PG_PORT}/agp_db"
|
||||
os.environ["DATABASE_URL"] = url
|
||||
settings.DATABASE_URL = url
|
||||
|
||||
mig = _run([sys.executable, "-m", "alembic", "upgrade", "head"],
|
||||
env={**os.environ, "DATABASE_URL": url})
|
||||
if mig.returncode != 0:
|
||||
_db_unavailable_reason = f"alembic upgrade head failed:\n{mig.stderr[-800:]}"
|
||||
mig = _run([sys.executable, "-m", "alembic", "upgrade", "head"],
|
||||
env={**os.environ, "DATABASE_URL": url})
|
||||
if mig.returncode != 0:
|
||||
_db_unavailable_reason = f"alembic upgrade head failed:\n{mig.stderr[-800:]}"
|
||||
return
|
||||
|
||||
if need_redis:
|
||||
for _ in range(30):
|
||||
r = _run(
|
||||
["docker", "compose", "exec", "-T", "redis", "redis-cli", "ping"],
|
||||
env=env,
|
||||
)
|
||||
if r.returncode == 0 and "PONG" in r.stdout:
|
||||
break
|
||||
time.sleep(1)
|
||||
else:
|
||||
_db_unavailable_reason = "ephemeral Redis never became ready"
|
||||
return
|
||||
|
||||
redis_url = f"redis://localhost:{_EPHEMERAL_REDIS_PORT}/0"
|
||||
os.environ["REDIS_URL"] = redis_url
|
||||
settings.REDIS_URL = redis_url
|
||||
|
||||
|
||||
def pytest_unconfigure(config):
|
||||
@@ -113,6 +165,7 @@ def pytest_unconfigure(config):
|
||||
env["COMPOSE_PROJECT_NAME"] = _COMPOSE_PROJECT
|
||||
env["POSTGRES_HOST_PORT"] = str(_EPHEMERAL_PG_PORT)
|
||||
env["POSTGRES_PORT"] = str(_EPHEMERAL_PG_PORT)
|
||||
env["REDIS_HOST_PORT"] = str(_EPHEMERAL_REDIS_PORT)
|
||||
_run(["docker", "compose", "down", "-v"], env=env)
|
||||
|
||||
|
||||
|
||||
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,344 @@
|
||||
"""Model-level tests for chat: conversations, messages, message reports.
|
||||
|
||||
app/models/chat.py / alembic/versions/0008_add_chat_tables.py
|
||||
(docs/planning/social.md US-4). This is the models+migration task only --
|
||||
there are no API endpoints yet (sibling tasks own filtering, rate limiting,
|
||||
and the routers), so these tests exercise the ORM models and the real
|
||||
Postgres constraints directly rather than going through HTTP.
|
||||
"""
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
from sqlalchemy import delete, select
|
||||
from sqlalchemy.exc import IntegrityError
|
||||
from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine
|
||||
from sqlalchemy.pool import NullPool
|
||||
|
||||
from app.config import settings
|
||||
from app.main import app
|
||||
from app.models.chat import (
|
||||
Conversation,
|
||||
ConversationParticipant,
|
||||
Message,
|
||||
MessageReport,
|
||||
ReportStatus,
|
||||
)
|
||||
from app.models.user import User
|
||||
from app.models.world import World
|
||||
|
||||
|
||||
def _register(client: TestClient, username: str) -> int:
|
||||
resp = client.post(
|
||||
"/api/auth/register",
|
||||
json={
|
||||
"username": username,
|
||||
"email": f"{username}@example.com",
|
||||
"password": "secret123",
|
||||
"date_of_birth": "1990-01-01",
|
||||
},
|
||||
)
|
||||
assert resp.status_code == 201, resp.text
|
||||
headers = {"Authorization": f"Bearer {resp.json()['access_token']}"}
|
||||
me = client.get("/api/users/me", headers=headers)
|
||||
assert me.status_code == 200, me.text
|
||||
return me.json()["id"]
|
||||
|
||||
|
||||
def _session_factory():
|
||||
engine = create_async_engine(settings.DATABASE_URL, poolclass=NullPool)
|
||||
return engine, async_sessionmaker(engine, expire_on_commit=False)
|
||||
|
||||
|
||||
class TestConversationCreation:
|
||||
async def test_create_conversation_with_participants_and_messages(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "chat_conv_a")
|
||||
b = _register(client, "chat_conv_b")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
lo, hi = sorted((a, b))
|
||||
async with factory() as session:
|
||||
convo = Conversation(user_a_id=lo, user_b_id=hi)
|
||||
session.add(convo)
|
||||
await session.flush()
|
||||
session.add_all(
|
||||
[
|
||||
ConversationParticipant(conversation_id=convo.id, user_id=a),
|
||||
ConversationParticipant(conversation_id=convo.id, user_id=b),
|
||||
]
|
||||
)
|
||||
session.add(
|
||||
Message(sender_id=a, conversation_id=convo.id, body="hi there")
|
||||
)
|
||||
await session.commit()
|
||||
convo_id = convo.id
|
||||
|
||||
async with factory() as session:
|
||||
participants = (
|
||||
await session.execute(
|
||||
select(ConversationParticipant).where(
|
||||
ConversationParticipant.conversation_id == convo_id
|
||||
)
|
||||
)
|
||||
).scalars().all()
|
||||
messages = (
|
||||
await session.execute(
|
||||
select(Message).where(Message.conversation_id == convo_id)
|
||||
)
|
||||
).scalars().all()
|
||||
assert len(participants) == 2
|
||||
assert len(messages) == 1
|
||||
assert messages[0].sender_id == a
|
||||
assert messages[0].filtered is False
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
async def test_duplicate_pair_rejected(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "chat_uq_a")
|
||||
b = _register(client, "chat_uq_b")
|
||||
lo, hi = sorted((a, b))
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
session.add(Conversation(user_a_id=lo, user_b_id=hi))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
session.add(Conversation(user_a_id=lo, user_b_id=hi))
|
||||
with pytest.raises(IntegrityError):
|
||||
await session.commit()
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
async def test_unordered_pair_rejected_by_check_constraint(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "chat_ck_a")
|
||||
b = _register(client, "chat_ck_b")
|
||||
lo, hi = sorted((a, b))
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
# Reversed order violates ck_conversations_ordered_pair.
|
||||
session.add(Conversation(user_a_id=hi, user_b_id=lo))
|
||||
with pytest.raises(IntegrityError):
|
||||
await session.commit()
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
|
||||
class TestWorldRoomChat:
|
||||
async def test_world_message_has_null_conversation(self):
|
||||
client = TestClient(app)
|
||||
owner = _register(client, "chat_world_owner")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
world = World(name="Chat Test World", owner_id=owner)
|
||||
session.add(world)
|
||||
await session.flush()
|
||||
msg = Message(sender_id=owner, world_id=world.id, body="hello world")
|
||||
session.add(msg)
|
||||
await session.commit()
|
||||
world_id = world.id
|
||||
|
||||
async with factory() as session:
|
||||
rows = (
|
||||
await session.execute(
|
||||
select(Message).where(Message.world_id == world_id)
|
||||
)
|
||||
).scalars().all()
|
||||
assert len(rows) == 1
|
||||
assert rows[0].conversation_id is None
|
||||
assert rows[0].room_id is None
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
|
||||
class TestMessageReports:
|
||||
async def test_create_report_defaults_to_open(self):
|
||||
client = TestClient(app)
|
||||
sender = _register(client, "chat_rpt_sender")
|
||||
reporter = _register(client, "chat_rpt_reporter")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
world = World(name="Report World", owner_id=sender)
|
||||
session.add(world)
|
||||
await session.flush()
|
||||
msg = Message(sender_id=sender, world_id=world.id, body="bad words")
|
||||
session.add(msg)
|
||||
await session.flush()
|
||||
report = MessageReport(
|
||||
message_id=msg.id, reporter_id=reporter, reason="spam"
|
||||
)
|
||||
session.add(report)
|
||||
await session.commit()
|
||||
report_id = report.id
|
||||
|
||||
async with factory() as session:
|
||||
report = await session.get(MessageReport, report_id)
|
||||
assert report.status == ReportStatus.OPEN
|
||||
assert report.moderator_id is None
|
||||
assert report.resolved_at is None
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
|
||||
class TestCascadeDelete:
|
||||
async def test_deleting_conversation_deletes_participants_and_messages(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "chat_cd_conv_a")
|
||||
b = _register(client, "chat_cd_conv_b")
|
||||
lo, hi = sorted((a, b))
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
convo = Conversation(user_a_id=lo, user_b_id=hi)
|
||||
session.add(convo)
|
||||
await session.flush()
|
||||
session.add_all(
|
||||
[
|
||||
ConversationParticipant(conversation_id=convo.id, user_id=a),
|
||||
ConversationParticipant(conversation_id=convo.id, user_id=b),
|
||||
]
|
||||
)
|
||||
session.add(Message(sender_id=a, conversation_id=convo.id, body="bye"))
|
||||
await session.commit()
|
||||
convo_id = convo.id
|
||||
|
||||
async with factory() as session:
|
||||
# Core delete against the conversations table directly, so
|
||||
# the real ON DELETE CASCADE does the work (not the ORM).
|
||||
await session.execute(
|
||||
delete(Conversation).where(Conversation.id == convo_id)
|
||||
)
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
participants = (
|
||||
await session.execute(
|
||||
select(ConversationParticipant).where(
|
||||
ConversationParticipant.conversation_id == convo_id
|
||||
)
|
||||
)
|
||||
).scalars().all()
|
||||
messages = (
|
||||
await session.execute(
|
||||
select(Message).where(Message.conversation_id == convo_id)
|
||||
)
|
||||
).scalars().all()
|
||||
assert participants == []
|
||||
assert messages == []
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
async def test_deleting_user_removes_conversation_but_keeps_report_and_message_id_null(self):
|
||||
"""Deleting a conversation participant cascades away the whole DM
|
||||
(conversation + participants + messages -- there's no third party
|
||||
left to care about the history). Deleting the sender of a
|
||||
world-chat message, by contrast, must NOT delete the message or its
|
||||
report -- sender_id is SET NULL and message_reports.message_id
|
||||
follows the message (also SET NULL, never CASCADE) so the audit
|
||||
trail survives account deletion."""
|
||||
client = TestClient(app)
|
||||
a = _register(client, "chat_cd_user_a")
|
||||
b = _register(client, "chat_cd_user_b")
|
||||
reporter = _register(client, "chat_cd_user_reporter")
|
||||
lo, hi = sorted((a, b))
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
convo = Conversation(user_a_id=lo, user_b_id=hi)
|
||||
session.add(convo)
|
||||
await session.flush()
|
||||
session.add_all(
|
||||
[
|
||||
ConversationParticipant(conversation_id=convo.id, user_id=a),
|
||||
ConversationParticipant(conversation_id=convo.id, user_id=b),
|
||||
]
|
||||
)
|
||||
session.add(Message(sender_id=a, conversation_id=convo.id, body="dm"))
|
||||
|
||||
world = World(name="Sender Delete World", owner_id=b)
|
||||
session.add(world)
|
||||
await session.flush()
|
||||
world_msg = Message(sender_id=a, world_id=world.id, body="world chat")
|
||||
session.add(world_msg)
|
||||
await session.flush()
|
||||
report = MessageReport(
|
||||
message_id=world_msg.id, reporter_id=reporter, reason="rude"
|
||||
)
|
||||
session.add(report)
|
||||
await session.commit()
|
||||
convo_id = convo.id
|
||||
world_msg_id = world_msg.id
|
||||
report_id = report.id
|
||||
|
||||
async with factory() as session:
|
||||
# Delete `a`: participant in the DM (cascades the whole
|
||||
# conversation) and sender of the world message (SET NULL).
|
||||
await session.execute(delete(User).where(User.id == a))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
convo_row = await session.get(Conversation, convo_id)
|
||||
dm_messages = (
|
||||
await session.execute(
|
||||
select(Message).where(Message.conversation_id == convo_id)
|
||||
)
|
||||
).scalars().all()
|
||||
world_msg = await session.get(Message, world_msg_id)
|
||||
report = await session.get(MessageReport, report_id)
|
||||
|
||||
assert convo_row is None
|
||||
assert dm_messages == []
|
||||
# World message survives with sender_id nulled out.
|
||||
assert world_msg is not None
|
||||
assert world_msg.sender_id is None
|
||||
assert world_msg.body == "world chat"
|
||||
# Report still points at the surviving message.
|
||||
assert report is not None
|
||||
assert report.message_id == world_msg_id
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
async def test_deleting_message_nulls_report_message_id(self):
|
||||
client = TestClient(app)
|
||||
sender = _register(client, "chat_cd_msg_sender")
|
||||
reporter = _register(client, "chat_cd_msg_reporter")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
world = World(name="Msg Delete World", owner_id=sender)
|
||||
session.add(world)
|
||||
await session.flush()
|
||||
msg = Message(sender_id=sender, world_id=world.id, body="to be removed")
|
||||
session.add(msg)
|
||||
await session.flush()
|
||||
report = MessageReport(
|
||||
message_id=msg.id, reporter_id=reporter, reason="spam"
|
||||
)
|
||||
session.add(report)
|
||||
await session.commit()
|
||||
msg_id = msg.id
|
||||
report_id = report.id
|
||||
|
||||
async with factory() as session:
|
||||
await session.execute(delete(Message).where(Message.id == msg_id))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
report = await session.get(MessageReport, report_id)
|
||||
assert report is not None
|
||||
assert report.message_id is None
|
||||
finally:
|
||||
await engine.dispose()
|
||||
@@ -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,221 @@
|
||||
"""Integration tests for the presence feature:
|
||||
|
||||
- POST /api/presence/heartbeat
|
||||
- GET /api/presence/presence
|
||||
- PATCH /api/presence/status
|
||||
|
||||
Hits the real app against the configured Postgres *and* a real Redis
|
||||
(conftest.py brings up an ephemeral instance of each when neither is
|
||||
already reachable) -- presence is fundamentally "does a TTL key exist in
|
||||
Redis", which isn't worth faking with a mock.
|
||||
|
||||
Also covers the regression fixed in 47ab492 ("Fix StatusUpdate field
|
||||
annotation and is_online batch-call mismatch"): the router used to call
|
||||
``PresenceStore.is_online(ids)`` with a *list* of ids and then evaluate
|
||||
``uid in online_ids`` against the returned bool, which raised a TypeError
|
||||
on the first real multi-id batch call, and ``StatusUpdate.status_message``
|
||||
used the invalid annotation ``str | Field(...)``. Both are exercised below.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
|
||||
from app.main import app
|
||||
from app.services.presence import PresenceStore
|
||||
|
||||
|
||||
def _register(client: TestClient, username: str) -> dict:
|
||||
resp = client.post(
|
||||
"/api/auth/register",
|
||||
json={
|
||||
"username": username,
|
||||
"email": f"{username}@example.com",
|
||||
"password": "secret123",
|
||||
"date_of_birth": "1990-01-01",
|
||||
},
|
||||
)
|
||||
assert resp.status_code == 201, resp.text
|
||||
token = resp.json()["access_token"]
|
||||
headers = {"Authorization": f"Bearer {token}"}
|
||||
me = client.get("/api/users/me", headers=headers)
|
||||
assert me.status_code == 200, me.text
|
||||
return {"headers": headers, "id": me.json()["id"]}
|
||||
|
||||
|
||||
class TestHeartbeat:
|
||||
def test_heartbeat_sets_online(self):
|
||||
client = TestClient(app)
|
||||
user = _register(client, "presence_hb1")
|
||||
|
||||
resp = client.post("/api/presence/heartbeat", json={}, headers=user["headers"])
|
||||
assert resp.status_code == 200, resp.text
|
||||
assert resp.json() == {"status": "ok", "user_id": user["id"]}
|
||||
|
||||
presence = client.get(
|
||||
"/api/presence/presence",
|
||||
params={"user_ids": str(user["id"])},
|
||||
headers=user["headers"],
|
||||
)
|
||||
assert presence.status_code == 200, presence.text
|
||||
body = presence.json()["users"]
|
||||
assert len(body) == 1
|
||||
assert body[0]["user_id"] == user["id"]
|
||||
assert body[0]["is_online"] is True
|
||||
assert body[0]["last_seen_at"] is not None
|
||||
|
||||
def test_requires_auth(self):
|
||||
client = TestClient(app)
|
||||
resp = client.post("/api/presence/heartbeat", json={})
|
||||
assert resp.status_code == 401
|
||||
|
||||
def test_never_seen_user_is_offline_with_null_last_seen(self):
|
||||
client = TestClient(app)
|
||||
user = _register(client, "presence_never_hb")
|
||||
|
||||
presence = client.get(
|
||||
"/api/presence/presence",
|
||||
params={"user_ids": str(user["id"])},
|
||||
headers=user["headers"],
|
||||
)
|
||||
assert presence.status_code == 200
|
||||
body = presence.json()["users"][0]
|
||||
assert body["is_online"] is False
|
||||
assert body["last_seen_at"] is None
|
||||
|
||||
|
||||
class TestBatchPresence:
|
||||
"""Covers the batch-call path fixed in 47ab492 (is_online_batch via MGET)."""
|
||||
|
||||
def test_batch_query_mixes_online_offline_and_unknown_ids(self):
|
||||
client = TestClient(app)
|
||||
online_user = _register(client, "presence_batch_online")
|
||||
offline_user = _register(client, "presence_batch_offline")
|
||||
|
||||
client.post("/api/presence/heartbeat", json={}, headers=online_user["headers"])
|
||||
|
||||
unknown_id = max(online_user["id"], offline_user["id"]) + 999_999
|
||||
ids = f"{online_user['id']},{offline_user['id']},{unknown_id}"
|
||||
|
||||
resp = client.get(
|
||||
"/api/presence/presence",
|
||||
params={"user_ids": ids},
|
||||
headers=online_user["headers"],
|
||||
)
|
||||
assert resp.status_code == 200, resp.text
|
||||
by_id = {u["user_id"]: u for u in resp.json()["users"]}
|
||||
|
||||
# Unknown id is silently dropped (not in the DB), not a 500 or 404.
|
||||
assert unknown_id not in by_id
|
||||
assert by_id[online_user["id"]]["is_online"] is True
|
||||
assert by_id[offline_user["id"]]["is_online"] is False
|
||||
|
||||
def test_empty_user_ids_is_a_400(self):
|
||||
client = TestClient(app)
|
||||
user = _register(client, "presence_empty_ids")
|
||||
resp = client.get(
|
||||
"/api/presence/presence",
|
||||
params={"user_ids": ""},
|
||||
headers=user["headers"],
|
||||
)
|
||||
assert resp.status_code == 400
|
||||
|
||||
|
||||
class TestStatusMessage:
|
||||
def test_update_and_read_back_status_message(self):
|
||||
client = TestClient(app)
|
||||
user = _register(client, "presence_status1")
|
||||
|
||||
resp = client.patch(
|
||||
"/api/presence/status",
|
||||
json={"status_message": " brb, making coffee "},
|
||||
headers=user["headers"],
|
||||
)
|
||||
assert resp.status_code == 200, resp.text
|
||||
# The router strips whitespace (StatusUpdate.strip_message).
|
||||
assert resp.json()["status_message"] == "brb, making coffee"
|
||||
|
||||
presence = client.get(
|
||||
"/api/presence/presence",
|
||||
params={"user_ids": str(user["id"])},
|
||||
headers=user["headers"],
|
||||
)
|
||||
assert presence.json()["users"][0]["status_message"] == "brb, making coffee"
|
||||
|
||||
def test_status_message_over_max_length_is_rejected(self):
|
||||
client = TestClient(app)
|
||||
user = _register(client, "presence_status_toolong")
|
||||
resp = client.patch(
|
||||
"/api/presence/status",
|
||||
json={"status_message": "x" * 141},
|
||||
headers=user["headers"],
|
||||
)
|
||||
# StatusUpdate.status_message: str | None = Field(..., max_length=140)
|
||||
# This is exactly the annotation 47ab492 fixed (it used to be the
|
||||
# invalid `str | Field(...)`, which breaks model construction
|
||||
# entirely rather than validating length).
|
||||
assert resp.status_code == 422
|
||||
|
||||
def test_status_message_at_max_length_is_accepted(self):
|
||||
client = TestClient(app)
|
||||
user = _register(client, "presence_status_maxlen")
|
||||
resp = client.patch(
|
||||
"/api/presence/status",
|
||||
json={"status_message": "x" * 140},
|
||||
headers=user["headers"],
|
||||
)
|
||||
assert resp.status_code == 200, resp.text
|
||||
|
||||
def test_null_status_message_clears_it(self):
|
||||
client = TestClient(app)
|
||||
user = _register(client, "presence_status_clear")
|
||||
client.patch("/api/presence/status", json={"status_message": "hi"}, headers=user["headers"])
|
||||
resp = client.patch("/api/presence/status", json={"status_message": None}, headers=user["headers"])
|
||||
assert resp.status_code == 200
|
||||
assert resp.json()["status_message"] is None
|
||||
|
||||
|
||||
class TestPresenceStoreTTL:
|
||||
"""Exercises the real Redis TTL semantics directly against the service,
|
||||
with a short heartbeat_ttl so the test doesn't need to sleep for the
|
||||
real 60s default used in production. This is the cheap, real proxy for
|
||||
"TTL expiry means offline" the task asked for -- same code path
|
||||
(real Redis SET ... EX / EXISTS / MGET), just a much shorter window.
|
||||
"""
|
||||
|
||||
async def test_ttl_expiry_flips_online_to_offline(self):
|
||||
store = PresenceStore(heartbeat_ttl=1)
|
||||
try:
|
||||
uid = 987654321 # doesn't need to exist in Postgres; Redis-only check
|
||||
assert await store.is_online(uid) is False
|
||||
|
||||
await store.heartbeat(uid)
|
||||
assert await store.is_online(uid) is True
|
||||
|
||||
await asyncio.sleep(1.5)
|
||||
assert await store.is_online(uid) is False
|
||||
finally:
|
||||
await store.close()
|
||||
|
||||
async def test_is_online_batch_matches_is_online_semantics(self):
|
||||
"""Regression coverage for 47ab492: is_online_batch must return a
|
||||
set of ids usable with `in`, not a bool."""
|
||||
store = PresenceStore(heartbeat_ttl=30)
|
||||
try:
|
||||
online_uid, offline_uid = 111222333, 444555666
|
||||
await store.heartbeat(online_uid)
|
||||
|
||||
result = await store.is_online_batch([online_uid, offline_uid])
|
||||
assert isinstance(result, set)
|
||||
assert online_uid in result
|
||||
assert offline_uid not in result
|
||||
finally:
|
||||
await store.close()
|
||||
|
||||
async def test_is_online_batch_empty_list(self):
|
||||
store = PresenceStore()
|
||||
try:
|
||||
assert await store.is_online_batch([]) == set()
|
||||
finally:
|
||||
await store.close()
|
||||
@@ -0,0 +1,240 @@
|
||||
"""Model-level tests for the social graph: friendships, follows, blocks.
|
||||
|
||||
app/models/social.py / alembic/versions/0007_add_social_graph_tables.py
|
||||
(docs/planning/social.md US-1). This is the models+migration task only --
|
||||
there are no API endpoints yet (a sibling task owns the router), so these
|
||||
tests exercise the ORM models and the real Postgres constraints directly
|
||||
rather than going through HTTP.
|
||||
"""
|
||||
|
||||
import pytest
|
||||
from fastapi.testclient import TestClient
|
||||
from sqlalchemy import delete, select
|
||||
from sqlalchemy.exc import IntegrityError
|
||||
from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine
|
||||
from sqlalchemy.pool import NullPool
|
||||
|
||||
from app.config import settings
|
||||
from app.main import app
|
||||
from app.models.social import Friendship, Follow, Block, FriendshipStatus
|
||||
from app.models.user import User
|
||||
|
||||
|
||||
def _register(client: TestClient, username: str) -> int:
|
||||
resp = client.post(
|
||||
"/api/auth/register",
|
||||
json={
|
||||
"username": username,
|
||||
"email": f"{username}@example.com",
|
||||
"password": "secret123",
|
||||
"date_of_birth": "1990-01-01",
|
||||
},
|
||||
)
|
||||
assert resp.status_code == 201, resp.text
|
||||
headers = {"Authorization": f"Bearer {resp.json()['access_token']}"}
|
||||
me = client.get("/api/users/me", headers=headers)
|
||||
assert me.status_code == 200, me.text
|
||||
return me.json()["id"]
|
||||
|
||||
|
||||
def _session_factory():
|
||||
engine = create_async_engine(settings.DATABASE_URL, poolclass=NullPool)
|
||||
return engine, async_sessionmaker(engine, expire_on_commit=False)
|
||||
|
||||
|
||||
class TestFriendshipRequestAccept:
|
||||
async def test_request_defaults_to_pending(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "sg_fr_a1")
|
||||
b = _register(client, "sg_fr_b1")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
fr = Friendship(requester_id=a, addressee_id=b)
|
||||
session.add(fr)
|
||||
await session.commit()
|
||||
await session.refresh(fr)
|
||||
assert fr.status == FriendshipStatus.PENDING
|
||||
assert fr.requester_id == a
|
||||
assert fr.addressee_id == b
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
async def test_accept_updates_status(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "sg_fr_a2")
|
||||
b = _register(client, "sg_fr_b2")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
fr = Friendship(requester_id=a, addressee_id=b)
|
||||
session.add(fr)
|
||||
await session.commit()
|
||||
fr_id = fr.id
|
||||
|
||||
async with factory() as session:
|
||||
fr = await session.get(Friendship, fr_id)
|
||||
fr.status = FriendshipStatus.ACCEPTED
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
fr = await session.get(Friendship, fr_id)
|
||||
assert fr.status == FriendshipStatus.ACCEPTED
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
|
||||
class TestUniquePairConstraints:
|
||||
async def test_duplicate_friendship_pair_rejected(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "sg_uq_fr_a")
|
||||
b = _register(client, "sg_uq_fr_b")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
session.add(Friendship(requester_id=a, addressee_id=b))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
session.add(Friendship(requester_id=a, addressee_id=b))
|
||||
with pytest.raises(IntegrityError):
|
||||
await session.commit()
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
async def test_duplicate_follow_pair_rejected(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "sg_uq_fw_a")
|
||||
b = _register(client, "sg_uq_fw_b")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
session.add(Follow(follower_id=a, followed_id=b))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
session.add(Follow(follower_id=a, followed_id=b))
|
||||
with pytest.raises(IntegrityError):
|
||||
await session.commit()
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
async def test_duplicate_block_pair_rejected(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "sg_uq_bl_a")
|
||||
b = _register(client, "sg_uq_bl_b")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
session.add(Block(blocker_id=a, blocked_id=b))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
session.add(Block(blocker_id=a, blocked_id=b))
|
||||
with pytest.raises(IntegrityError):
|
||||
await session.commit()
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
|
||||
class TestFollow:
|
||||
async def test_create_follow(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "sg_follow_a")
|
||||
b = _register(client, "sg_follow_b")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
session.add(Follow(follower_id=a, followed_id=b))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
rows = (await session.execute(
|
||||
select(Follow).where(Follow.follower_id == a, Follow.followed_id == b)
|
||||
)).scalars().all()
|
||||
assert len(rows) == 1
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
|
||||
class TestBlock:
|
||||
async def test_create_block(self):
|
||||
client = TestClient(app)
|
||||
a = _register(client, "sg_block_a")
|
||||
b = _register(client, "sg_block_b")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
session.add(Block(blocker_id=a, blocked_id=b))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
rows = (await session.execute(
|
||||
select(Block).where(Block.blocker_id == a, Block.blocked_id == b)
|
||||
)).scalars().all()
|
||||
assert len(rows) == 1
|
||||
finally:
|
||||
await engine.dispose()
|
||||
|
||||
|
||||
class TestCascadeDelete:
|
||||
async def test_deleting_user_removes_rows_in_all_three_tables(self):
|
||||
"""Deleting a user removes friendships/follows/blocks referencing them
|
||||
in *either* FK column, via the real DB ON DELETE CASCADE (deleted with
|
||||
a Core statement, bypassing any ORM-level cascade, to prove the
|
||||
database constraint itself does the job)."""
|
||||
client = TestClient(app)
|
||||
a = _register(client, "sg_cascade_a")
|
||||
b = _register(client, "sg_cascade_b")
|
||||
c = _register(client, "sg_cascade_c")
|
||||
|
||||
engine, factory = _session_factory()
|
||||
try:
|
||||
async with factory() as session:
|
||||
# a as requester/follower/blocker, and also as addressee (c -> a)
|
||||
session.add(Friendship(requester_id=a, addressee_id=b))
|
||||
session.add(Friendship(requester_id=c, addressee_id=a))
|
||||
session.add(Follow(follower_id=a, followed_id=b))
|
||||
session.add(Follow(follower_id=c, followed_id=a))
|
||||
session.add(Block(blocker_id=a, blocked_id=b))
|
||||
session.add(Block(blocker_id=c, blocked_id=a))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
await session.execute(delete(User).where(User.id == a))
|
||||
await session.commit()
|
||||
|
||||
async with factory() as session:
|
||||
friendships = (await session.execute(
|
||||
select(Friendship).where(
|
||||
(Friendship.requester_id == a) | (Friendship.addressee_id == a)
|
||||
)
|
||||
)).scalars().all()
|
||||
follows = (await session.execute(
|
||||
select(Follow).where(
|
||||
(Follow.follower_id == a) | (Follow.followed_id == a)
|
||||
)
|
||||
)).scalars().all()
|
||||
blocks = (await session.execute(
|
||||
select(Block).where(
|
||||
(Block.blocker_id == a) | (Block.blocked_id == a)
|
||||
)
|
||||
)).scalars().all()
|
||||
assert friendships == []
|
||||
assert follows == []
|
||||
assert blocks == []
|
||||
|
||||
# Unrelated rows (b, c only) survive.
|
||||
remaining_users = (await session.execute(
|
||||
select(User.id).where(User.id.in_([b, c]))
|
||||
)).scalars().all()
|
||||
assert set(remaining_users) == {b, c}
|
||||
finally:
|
||||
await engine.dispose()
|
||||
@@ -0,0 +1,194 @@
|
||||
"""Unit tests for app.services.text_filter (docs/planning/social.md §4/§5 US-4).
|
||||
|
||||
Pure, side-effect-free service -- no DB/Redis fixtures needed.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from app.services.text_filter import (
|
||||
DEFAULT_TERMS_PATH,
|
||||
FilterAction,
|
||||
FilterMode,
|
||||
FilterResult,
|
||||
ListBasedTextFilter,
|
||||
TextFilter,
|
||||
default_text_filter,
|
||||
load_terms,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def redact_filter() -> ListBasedTextFilter:
|
||||
return ListBasedTextFilter(terms=["badword", "shoot"], mode=FilterMode.REDACT)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def reject_filter() -> ListBasedTextFilter:
|
||||
return ListBasedTextFilter(terms=["badword", "shoot"], mode=FilterMode.REJECT)
|
||||
|
||||
|
||||
class TestAllowPath:
|
||||
def test_clean_text_is_allowed_unchanged(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
result = redact_filter.check("hello there, how are you today?")
|
||||
assert result.action is FilterAction.ALLOW
|
||||
assert result.filtered_text == "hello there, how are you today?"
|
||||
assert result.matched_terms == ()
|
||||
|
||||
def test_message_with_no_matches(self, reject_filter: ListBasedTextFilter) -> None:
|
||||
# Distinct from the clean-text case above: exercises the reject-mode
|
||||
# filter's no-match path specifically (mode should not matter when
|
||||
# nothing matches).
|
||||
text = "let's meet at the plaza around noon"
|
||||
result = reject_filter.check(text)
|
||||
assert result.action is FilterAction.ALLOW
|
||||
assert result.filtered_text == text
|
||||
assert result.matched_terms == ()
|
||||
|
||||
|
||||
class TestRedactPath:
|
||||
def test_exact_match_is_redacted(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
result = redact_filter.check("don't be a badword about it")
|
||||
assert result.action is FilterAction.REDACT
|
||||
assert result.matched_terms == ("badword",)
|
||||
assert "badword" not in result.filtered_text
|
||||
assert result.filtered_text == "don't be a ******* about it"
|
||||
|
||||
def test_multiple_distinct_matches(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
result = redact_filter.check("badword, don't shoot!")
|
||||
assert result.action is FilterAction.REDACT
|
||||
assert set(result.matched_terms) == {"badword", "shoot"}
|
||||
assert "badword" not in result.filtered_text
|
||||
assert "shoot" not in result.filtered_text
|
||||
# Length is preserved (asterisks replace matched spans 1:1).
|
||||
assert len(result.filtered_text) == len("badword, don't shoot!")
|
||||
|
||||
def test_redaction_char_is_configurable(self) -> None:
|
||||
f = ListBasedTextFilter(terms=["badword"], mode=FilterMode.REDACT, redaction_char="#")
|
||||
result = f.check("that's a badword thing to say")
|
||||
assert result.filtered_text == "that's a ####### thing to say"
|
||||
|
||||
|
||||
class TestRejectPath:
|
||||
def test_match_is_rejected_and_text_left_intact(self, reject_filter: ListBasedTextFilter) -> None:
|
||||
text = "stop, badword!"
|
||||
result = reject_filter.check(text)
|
||||
assert result.action is FilterAction.REJECT
|
||||
assert result.matched_terms == ("badword",)
|
||||
# Reject mode does not mutate the text -- callers are expected to
|
||||
# not store/deliver it at all, based on `action`.
|
||||
assert result.filtered_text == text
|
||||
|
||||
|
||||
class TestNormalization:
|
||||
def test_leetspeak_variant_is_caught(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
# "b4dw0rd" -> normalizes to "badword" via the leet map (4->a, 0->o).
|
||||
result = redact_filter.check("you're being a b4dw0rd right now")
|
||||
assert result.action is FilterAction.REDACT
|
||||
assert result.matched_terms == ("badword",)
|
||||
|
||||
def test_separators_between_letters_are_stripped(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
result = redact_filter.check("that is b.a.d.w.o.r.d behavior")
|
||||
assert result.action is FilterAction.REDACT
|
||||
assert result.matched_terms == ("badword",)
|
||||
|
||||
def test_spacing_between_letters_is_stripped(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
result = redact_filter.check("b a d w o r d, seriously")
|
||||
assert result.action is FilterAction.REDACT
|
||||
assert result.matched_terms == ("badword",)
|
||||
|
||||
def test_case_folding(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
result = redact_filter.check("BADWORD in all caps")
|
||||
assert result.action is FilterAction.REDACT
|
||||
assert result.matched_terms == ("badword",)
|
||||
|
||||
def test_symbol_lookalikes(self) -> None:
|
||||
# @ -> a, $ -> s: "@ss" should normalize to "ass".
|
||||
f = ListBasedTextFilter(terms=["ass"], mode=FilterMode.REDACT)
|
||||
result = f.check("what an @$$ move")
|
||||
assert result.action is FilterAction.REDACT
|
||||
assert result.matched_terms == ("ass",)
|
||||
|
||||
|
||||
class TestEmptyAndWhitespace:
|
||||
def test_empty_string(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
result = redact_filter.check("")
|
||||
assert result.action is FilterAction.ALLOW
|
||||
assert result.filtered_text == ""
|
||||
assert result.matched_terms == ()
|
||||
|
||||
def test_whitespace_only_string(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
text = " \t\n "
|
||||
result = redact_filter.check(text)
|
||||
assert result.action is FilterAction.ALLOW
|
||||
assert result.filtered_text == text
|
||||
assert result.matched_terms == ()
|
||||
|
||||
def test_punctuation_only_string_has_nothing_to_normalize(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
# No alnum characters survive normalization at all -- must not
|
||||
# crash on an empty normalized string / empty index_map.
|
||||
result = redact_filter.check("...!!!???")
|
||||
assert result.action is FilterAction.ALLOW
|
||||
assert result.matched_terms == ()
|
||||
|
||||
|
||||
class TestConfigurability:
|
||||
def test_custom_term_list_is_used_instead_of_default(self) -> None:
|
||||
f = ListBasedTextFilter(terms=["zzzcustomzzz"], mode=FilterMode.REDACT)
|
||||
result = f.check("this contains zzzcustomzzz right here")
|
||||
assert result.action is FilterAction.REDACT
|
||||
assert result.matched_terms == ("zzzcustomzzz",)
|
||||
# Default list terms should NOT match since we overrode the list.
|
||||
result2 = f.check("this is fucking unrelated")
|
||||
assert result2.action is FilterAction.ALLOW
|
||||
|
||||
def test_duplicate_and_blank_terms_are_deduped(self) -> None:
|
||||
f = ListBasedTextFilter(terms=["badword", "badword", " ", ""], mode=FilterMode.REDACT)
|
||||
assert f._terms == ("badword",)
|
||||
|
||||
def test_default_terms_file_loads_and_is_nonempty(self) -> None:
|
||||
terms = load_terms()
|
||||
assert isinstance(terms, list)
|
||||
assert len(terms) > 0
|
||||
assert all(isinstance(t, str) and t for t in terms)
|
||||
|
||||
def test_default_terms_path_exists(self) -> None:
|
||||
assert DEFAULT_TERMS_PATH.exists()
|
||||
assert DEFAULT_TERMS_PATH.suffix == ".json"
|
||||
|
||||
def test_load_terms_from_explicit_path(self, tmp_path: Path) -> None:
|
||||
custom = tmp_path / "custom_terms.json"
|
||||
custom.write_text('{"terms": ["foo", "bar"]}', encoding="utf-8")
|
||||
assert load_terms(custom) == ["foo", "bar"]
|
||||
|
||||
def test_default_text_filter_factory_matches_default_list(self) -> None:
|
||||
f = default_text_filter(mode=FilterMode.REJECT)
|
||||
result = f.check("that's fucking ridiculous")
|
||||
assert result.action is FilterAction.REJECT
|
||||
assert "fuck" in result.matched_terms
|
||||
|
||||
|
||||
class TestProtocol:
|
||||
def test_list_based_filter_satisfies_text_filter_protocol(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
assert isinstance(redact_filter, TextFilter)
|
||||
|
||||
def test_check_returns_filter_result(self, redact_filter: ListBasedTextFilter) -> None:
|
||||
result = redact_filter.check("hi")
|
||||
assert isinstance(result, FilterResult)
|
||||
|
||||
def test_a_third_party_style_implementation_satisfies_the_protocol(self) -> None:
|
||||
# Demonstrates the extension point: any object with a matching
|
||||
# `check` method satisfies TextFilter without inheriting from
|
||||
# anything -- this is how a future third-party provider would plug
|
||||
# in without touching this module.
|
||||
class AlwaysAllow:
|
||||
def check(self, text: str) -> FilterResult:
|
||||
return FilterResult(action=FilterAction.ALLOW, filtered_text=text, matched_terms=())
|
||||
|
||||
provider: TextFilter = AlwaysAllow()
|
||||
assert isinstance(provider, TextFilter)
|
||||
result = provider.check("anything at all, even fuck")
|
||||
assert result.action is FilterAction.ALLOW
|
||||
@@ -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.
|
||||
@@ -50,6 +50,11 @@ interact={
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":69,"key_label":0,"unicode":101,"location":0,"echo":false,"script":null)
|
||||
]
|
||||
}
|
||||
toggle_build_mode={
|
||||
"deadzone": 0.5,
|
||||
"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194333,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
|
||||
]
|
||||
}
|
||||
|
||||
[physics]
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -100,6 +100,17 @@ class TileLayerData:
|
||||
return tiles[idx]
|
||||
return 0
|
||||
|
||||
## Editor mutator: writes `tile_id` at (x, y, z). Silently no-ops out of
|
||||
## bounds, mirroring get_tile's "out of bounds is empty" contract rather
|
||||
## than erroring -- callers that need bounds feedback should check first
|
||||
## (see ChunkEditorModel.is_tile_in_bounds in scripts/editor/).
|
||||
func set_tile(x: int, y: int, z: int, tile_id: int) -> void:
|
||||
if x < 0 or x >= width or y < 0 or y >= height or z < 0 or z >= depth:
|
||||
return
|
||||
var idx := (z * height + y) * width + x
|
||||
if idx < tiles.size():
|
||||
tiles[idx] = tile_id
|
||||
|
||||
func get_tile_def(tile_id: int) -> TileDef:
|
||||
for def in palette:
|
||||
if def.id == tile_id:
|
||||
@@ -404,7 +415,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 +503,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 +646,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 +679,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,190 @@
|
||||
class_name ChunkEditorModel
|
||||
extends RefCounted
|
||||
## In-memory chunk being edited (docs/architecture/editor.md §7.1's
|
||||
## `ChunkEditorModel`).
|
||||
##
|
||||
## Wraps a `ChunkDataDecoder.ChunkPayload` directly rather than inventing a
|
||||
## parallel data model -- that payload is already the exact structure that
|
||||
## round-trips through `ChunkDataDecoder.encode_binary()` /
|
||||
## `decode_binary()` (world.md §3.6, and the interop bugs fixed in that file
|
||||
## are proof this contract is exercised for real). Editing this model and
|
||||
## re-encoding it must always produce a valid, byte-compatible chunk, since
|
||||
## the sibling save-path task depends on that being true.
|
||||
##
|
||||
## Every method here is a "raw" mutator: it changes the payload and returns
|
||||
## whatever an undo needs to reverse the change, but it does **not** know
|
||||
## about undo/redo itself. `scripts/editor/editor_core.gd`'s tools
|
||||
## (scripts/editor/tools/*.gd) are the only things that call these -- they
|
||||
## wrap each call in an `EditorUndoRedoStack` action. Nothing here should be
|
||||
## called directly by UI code; that would bypass undo/redo silently.
|
||||
|
||||
var payload: ChunkDataDecoder.ChunkPayload
|
||||
|
||||
## Monotonic counter seeded from the highest existing "obj_NNNN"-style
|
||||
## numeric suffix already in the chunk, so freshly generated ids never
|
||||
## collide with ids that arrived from a decoded chunk.
|
||||
var _next_object_seq: int = 0
|
||||
|
||||
|
||||
func _init(p_payload: ChunkDataDecoder.ChunkPayload = null) -> void:
|
||||
payload = p_payload if p_payload != null else ChunkDataDecoder.ChunkPayload.new()
|
||||
_seed_object_sequence()
|
||||
|
||||
|
||||
func _seed_object_sequence() -> void:
|
||||
for obj in payload.objects:
|
||||
var n := _numeric_suffix(obj.id)
|
||||
if n >= _next_object_seq:
|
||||
_next_object_seq = n + 1
|
||||
|
||||
|
||||
static func _numeric_suffix(id: String) -> int:
|
||||
var digits := ""
|
||||
for i in range(id.length() - 1, -1, -1):
|
||||
var c: String = id[i]
|
||||
if c.is_valid_int():
|
||||
digits = c + digits
|
||||
else:
|
||||
break
|
||||
return int(digits) if digits != "" else -1
|
||||
|
||||
|
||||
## Build a fresh, empty single-layer chunk model -- convenient for tests and
|
||||
## for a "new chunk" starting point in the in-game editor before a real
|
||||
## chunk has been loaded from the backend (loading real chunks over HTTP is
|
||||
## HttpChunkSource's job; this just gives the editor something valid to
|
||||
## operate on).
|
||||
static func create_empty(width: int = 32, height: int = 32, world_id: String = "",
|
||||
room_id: String = "main", coord: Vector3i = Vector3i.ZERO) -> ChunkEditorModel:
|
||||
var layer := ChunkDataDecoder.TileLayerData.new()
|
||||
layer.name = "ground"
|
||||
layer.layer_id = 0
|
||||
layer.width = width
|
||||
layer.height = height
|
||||
layer.depth = 1
|
||||
layer.palette = [
|
||||
TileDef.new(0, "", false, 0, 1),
|
||||
TileDef.new(1, "tiles/default", true, 0, 1),
|
||||
]
|
||||
var tiles := PackedInt32Array()
|
||||
tiles.resize(width * height)
|
||||
layer.tiles = tiles
|
||||
|
||||
var payload := ChunkDataDecoder.ChunkPayload.new()
|
||||
payload.world_id = world_id
|
||||
payload.room_id = room_id
|
||||
payload.coord = coord
|
||||
payload.bounds = AABB(Vector3(coord.x * width, coord.y * height, coord.z), Vector3(width, height, 1))
|
||||
payload.tile_layers = [layer]
|
||||
payload.revision = 0
|
||||
payload.created_at = Time.get_unix_time_from_system()
|
||||
payload.updated_at = payload.created_at
|
||||
return ChunkEditorModel.new(payload)
|
||||
|
||||
|
||||
static func from_binary(data: PackedByteArray) -> ChunkEditorModel:
|
||||
var decoded := ChunkDataDecoder.decode_binary(data)
|
||||
if decoded == null:
|
||||
return null
|
||||
return ChunkEditorModel.new(decoded)
|
||||
|
||||
|
||||
func encode_binary() -> PackedByteArray:
|
||||
return ChunkDataDecoder.encode_binary(payload)
|
||||
|
||||
|
||||
# ───────────────────────── tiles ─────────────────────────
|
||||
|
||||
func get_layer(layer_idx: int) -> ChunkDataDecoder.TileLayerData:
|
||||
if layer_idx < 0 or layer_idx >= payload.tile_layers.size():
|
||||
return null
|
||||
return payload.tile_layers[layer_idx]
|
||||
|
||||
|
||||
func is_tile_in_bounds(layer_idx: int, x: int, y: int, z: int = 0) -> bool:
|
||||
var layer := get_layer(layer_idx)
|
||||
if layer == null:
|
||||
return false
|
||||
return x >= 0 and x < layer.width and y >= 0 and y < layer.height and z >= 0 and z < layer.depth
|
||||
|
||||
|
||||
func get_tile_raw(layer_idx: int, x: int, y: int, z: int = 0) -> int:
|
||||
var layer := get_layer(layer_idx)
|
||||
if layer == null:
|
||||
return 0
|
||||
return layer.get_tile(x, y, z)
|
||||
|
||||
|
||||
## Raw setter -- undo-unaware. Only ever called (in both directions) by
|
||||
## BrushTool/EraseTool via EditorUndoRedoStack.
|
||||
func set_tile_raw(layer_idx: int, x: int, y: int, z: int, tile_id: int) -> void:
|
||||
var layer := get_layer(layer_idx)
|
||||
if layer == null:
|
||||
return
|
||||
layer.set_tile(x, y, z, tile_id)
|
||||
|
||||
|
||||
# ───────────────────────── objects ─────────────────────────
|
||||
|
||||
func find_object(object_id: String) -> ChunkDataDecoder.WorldObjectData:
|
||||
for obj in payload.objects:
|
||||
if obj.id == object_id:
|
||||
return obj
|
||||
return null
|
||||
|
||||
|
||||
func get_object_index(object_id: String) -> int:
|
||||
for i in range(payload.objects.size()):
|
||||
if payload.objects[i].id == object_id:
|
||||
return i
|
||||
return -1
|
||||
|
||||
|
||||
func generate_object_id() -> String:
|
||||
var id := "obj_%04d" % _next_object_seq
|
||||
_next_object_seq += 1
|
||||
return id
|
||||
|
||||
|
||||
## Raw mutators -- undo-unaware. Only ever called (in both directions) by
|
||||
## ObjectPlaceTool/EraseTool/TransformTool via EditorUndoRedoStack.
|
||||
func add_object_raw(obj: ChunkDataDecoder.WorldObjectData) -> void:
|
||||
payload.objects.append(obj)
|
||||
|
||||
|
||||
func insert_object_raw(obj: ChunkDataDecoder.WorldObjectData, index: int) -> void:
|
||||
var clamped: int = clampi(index, 0, payload.objects.size())
|
||||
payload.objects.insert(clamped, obj)
|
||||
|
||||
|
||||
func remove_object_raw(object_id: String) -> ChunkDataDecoder.WorldObjectData:
|
||||
var idx := get_object_index(object_id)
|
||||
if idx == -1:
|
||||
return null
|
||||
var obj := payload.objects[idx]
|
||||
payload.objects.remove_at(idx)
|
||||
return obj
|
||||
|
||||
|
||||
func set_object_position_raw(object_id: String, position: Vector3) -> void:
|
||||
var obj := find_object(object_id)
|
||||
if obj != null:
|
||||
obj.position = position
|
||||
|
||||
|
||||
func set_object_rotation_raw(object_id: String, rotation: Vector4) -> void:
|
||||
var obj := find_object(object_id)
|
||||
if obj != null:
|
||||
obj.rotation = rotation
|
||||
|
||||
|
||||
func set_object_scale_raw(object_id: String, scale: Vector3) -> void:
|
||||
var obj := find_object(object_id)
|
||||
if obj != null:
|
||||
obj.scale = scale
|
||||
|
||||
|
||||
func set_object_property_raw(object_id: String, key: String, value: Variant) -> void:
|
||||
var obj := find_object(object_id)
|
||||
if obj != null:
|
||||
obj.properties[key] = value
|
||||
@@ -0,0 +1,280 @@
|
||||
class_name ChunkSaveService
|
||||
extends Node
|
||||
## HTTP save path for the in-game editor
|
||||
## (docs/architecture/world_persistence_impl.md §8.1 chunk write / §8.2 D5).
|
||||
##
|
||||
## Owns the write half of editor persistence: single-chunk PUT with
|
||||
## `X-Base-Revision`/`base_revision`, batch PUT for a multi-chunk edit, and
|
||||
## the §5.4 optimistic-concurrency retry loop on `409`.
|
||||
##
|
||||
## Conflict handling ("re-fetch current chunk, re-apply the edit, retry"):
|
||||
## per §8.2 D5 this backend stores and accepts **whole chunks**, not
|
||||
## JSON-Patch deltas -- "lost-update protection comes from `base_revision`,
|
||||
## not from the patch". That means there is no delta to replay against a
|
||||
## freshly-fetched chunk; "re-apply the edit" is exactly "keep the locally
|
||||
## edited payload, learn the chunk's current revision, and retry at that
|
||||
## revision". `fetch_chunk()` is still called on a conflict (rather than
|
||||
## just trusting the 409 body's `current_revision`) so the editor's own
|
||||
## last-known state stays in sync with the store, matching what a real
|
||||
## client does before retrying a write it doesn't fully trust yet.
|
||||
##
|
||||
## Deliberately does **not** use `ApiClient.request()`: that helper discards
|
||||
## the parsed JSON body on any non-2xx response (see its `_make_result`
|
||||
## calls), and the `409` body's `current_revision`/`current_checksum` are
|
||||
## exactly what this retry loop needs. Uses a raw per-request `HTTPRequest`
|
||||
## child instead, the same pattern `scripts/http_chunk_source.gd` uses for
|
||||
## the read side.
|
||||
##
|
||||
## Must be added to the scene tree before use.
|
||||
|
||||
## The world this service saves chunks for (string form of the backend's
|
||||
## numeric world id).
|
||||
var world_id: String = ""
|
||||
|
||||
## The room slug within that world. world.md's default room is "main".
|
||||
var room_slug: String = "main"
|
||||
|
||||
## Bounded retries on a 409 conflict -- refuses to loop forever against a
|
||||
## chunk under sustained contention.
|
||||
const MAX_RETRIES := 3
|
||||
|
||||
|
||||
## Fetch the current chunk at [param coord].
|
||||
##
|
||||
## Returns:
|
||||
## {"ok": bool, "status": int, "model": ChunkEditorModel|null,
|
||||
## "revision": int, "checksum": String, "detail": String}
|
||||
##
|
||||
## A `404` (unwritten coordinate) is reported as `ok: true, model: null` --
|
||||
## world_persistence_impl.md §8.1: "an unwritten coordinate is not an error".
|
||||
## Callers wanting a fresh chunk to edit should fall back to
|
||||
## `ChunkEditorModel.create_empty()` at `base_revision: 0` in that case.
|
||||
func fetch_chunk(coord: Vector3i) -> Dictionary:
|
||||
var http := HTTPRequest.new()
|
||||
http.timeout = 15.0
|
||||
add_child(http)
|
||||
|
||||
var api := _api_client()
|
||||
var headers := PackedStringArray(["Accept: application/octet-stream"])
|
||||
if api.has_token():
|
||||
headers.append("Authorization: " + str(api.bearer_token))
|
||||
|
||||
var url: String = str(api.base_url) + _chunk_path(coord)
|
||||
var err := http.request(url, headers, HTTPClient.METHOD_GET)
|
||||
if err != OK:
|
||||
http.queue_free()
|
||||
return _fetch_result(false, 0, null, 0, "", "request failed to start (%d)" % err)
|
||||
|
||||
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:
|
||||
return _fetch_result(false, 0, null, 0, "", "transport error (%d)" % result_code)
|
||||
|
||||
if response_code == 404:
|
||||
return _fetch_result(true, 404, null, 0, "", "not found (unwritten chunk)")
|
||||
|
||||
if response_code != 200:
|
||||
return _fetch_result(false, response_code, null, 0, "", _error_detail_from_body(body))
|
||||
|
||||
var model := ChunkEditorModel.from_binary(body)
|
||||
if model == null:
|
||||
return _fetch_result(false, response_code, null, 0, "", "failed to decode chunk payload")
|
||||
|
||||
return _fetch_result(
|
||||
true, 200, model,
|
||||
_int_header(response_headers, "x-chunk-revision"),
|
||||
_etag_from_headers(response_headers),
|
||||
"OK",
|
||||
)
|
||||
|
||||
|
||||
## Save one chunk. `model.encode_binary()` is sent as the new payload;
|
||||
## `base_revision` is the revision the editor last knew about (0 = create).
|
||||
##
|
||||
## Returns:
|
||||
## {"ok": bool, "status": int, "revision": int, "checksum": String,
|
||||
## "live_session": bool, "retried": bool, "detail": String}
|
||||
func save_chunk(model: ChunkEditorModel, coord: Vector3i, base_revision: int) -> Dictionary:
|
||||
var attempt_revision := base_revision
|
||||
var retried := false
|
||||
for attempt in range(MAX_RETRIES + 1):
|
||||
var body := {
|
||||
"base_revision": attempt_revision,
|
||||
"payload_b64": Marshalls.raw_to_base64(model.encode_binary()),
|
||||
}
|
||||
var resp := await _request_json(HTTPClient.METHOD_PUT, _chunk_path(coord), body)
|
||||
|
||||
if resp["status"] == 200:
|
||||
var d: Dictionary = resp["data"]
|
||||
return {
|
||||
"ok": true, "status": 200,
|
||||
"revision": int(d.get("revision", attempt_revision)),
|
||||
"checksum": str(d.get("checksum", "")),
|
||||
"live_session": bool(d.get("live_session", false)),
|
||||
"retried": retried, "detail": "OK",
|
||||
}
|
||||
|
||||
if resp["status"] == 409 and attempt < MAX_RETRIES:
|
||||
var conflict: Dictionary = resp["data"] if resp["data"] is Dictionary else {}
|
||||
var current_rev := int(conflict.get("current_revision", attempt_revision))
|
||||
# Doc-mandated "re-fetch current chunk" step before retrying --
|
||||
# keeps this service's view of the chunk current even though the
|
||||
# retry itself only needs the revision number from the 409 body.
|
||||
await fetch_chunk(coord)
|
||||
attempt_revision = current_rev
|
||||
retried = true
|
||||
continue
|
||||
|
||||
return {"ok": false, "status": resp["status"], "revision": 0, "checksum": "",
|
||||
"live_session": false, "retried": retried, "detail": _error_detail(resp)}
|
||||
|
||||
return {"ok": false, "status": 409, "revision": 0, "checksum": "", "live_session": false,
|
||||
"retried": true, "detail": "conflict retry limit exceeded"}
|
||||
|
||||
|
||||
## Save multiple chunks in one atomic batch PUT (world_persistence_impl.md
|
||||
## §8.1 batch write: "an editor brush stroke or an object drag routinely
|
||||
## straddles a chunk boundary"). `entries` is an Array of
|
||||
## `{"coord": Vector3i, "model": ChunkEditorModel, "base_revision": int}`.
|
||||
## All-or-nothing: a `409` names the offending coordinate and nothing is
|
||||
## written, so only that entry's `base_revision` is refreshed before the
|
||||
## whole batch is retried.
|
||||
##
|
||||
## Returns:
|
||||
## {"ok": bool, "status": int, "live_session": bool,
|
||||
## "chunks": Array, "retried": bool, "detail": String}
|
||||
func save_batch(entries: Array) -> Dictionary:
|
||||
var working: Array = []
|
||||
for e in entries:
|
||||
working.append((e as Dictionary).duplicate())
|
||||
var retried := false
|
||||
|
||||
for attempt in range(MAX_RETRIES + 1):
|
||||
var chunks_json: Array = []
|
||||
for e in working:
|
||||
var c: Vector3i = e["coord"]
|
||||
var m: ChunkEditorModel = e["model"]
|
||||
chunks_json.append({
|
||||
"cx": c.x, "cy": c.y, "cz": c.z,
|
||||
"base_revision": int(e["base_revision"]),
|
||||
"payload_b64": Marshalls.raw_to_base64(m.encode_binary()),
|
||||
})
|
||||
var resp := await _request_json(HTTPClient.METHOD_PUT, _batch_path(), {"chunks": chunks_json})
|
||||
|
||||
if resp["status"] == 200:
|
||||
var d: Dictionary = resp["data"]
|
||||
return {"ok": true, "status": 200, "live_session": bool(d.get("live_session", false)),
|
||||
"chunks": d.get("chunks", []), "retried": retried, "detail": "OK"}
|
||||
|
||||
if resp["status"] == 409 and attempt < MAX_RETRIES:
|
||||
var conflict: Dictionary = resp["data"] if resp["data"] is Dictionary else {}
|
||||
var current_rev := int(conflict.get("current_revision", 0))
|
||||
var offending: Variant = conflict.get("coord")
|
||||
if offending is Array and offending.size() == 3:
|
||||
var oc := Vector3i(int(offending[0]), int(offending[1]), int(offending[2]))
|
||||
for e in working:
|
||||
if (e["coord"] as Vector3i) == oc:
|
||||
await fetch_chunk(oc)
|
||||
e["base_revision"] = current_rev
|
||||
break
|
||||
retried = true
|
||||
continue
|
||||
|
||||
return {"ok": false, "status": resp["status"], "live_session": false, "chunks": [],
|
||||
"retried": retried, "detail": _error_detail(resp)}
|
||||
|
||||
return {"ok": false, "status": 409, "live_session": false, "chunks": [],
|
||||
"retried": true, "detail": "conflict retry limit exceeded"}
|
||||
|
||||
|
||||
# ─────────────────────────── internals ───────────────────────────
|
||||
|
||||
## Resolved via an absolute node path, not the bare `ApiClient` autoload
|
||||
## identifier -- see the identical note on `HttpChunkSource._api_client()`
|
||||
## (bare autoload identifiers don't resolve when a script is compiled for a
|
||||
## headless `godot --script ...` run, which is how this service's smoke
|
||||
## test drives it).
|
||||
func _api_client() -> Node:
|
||||
return get_node("/root/ApiClient")
|
||||
|
||||
|
||||
func _chunk_path(coord: Vector3i) -> String:
|
||||
return "/api/worlds/%s/rooms/%s/chunks/%d/%d/%d" % [world_id, room_slug, coord.x, coord.y, coord.z]
|
||||
|
||||
|
||||
func _batch_path() -> String:
|
||||
return "/api/worlds/%s/rooms/%s/chunks" % [world_id, room_slug]
|
||||
|
||||
|
||||
func _request_json(method: HTTPClient.Method, path: String, body_dict: Dictionary) -> Dictionary:
|
||||
var http := HTTPRequest.new()
|
||||
http.timeout = 15.0
|
||||
add_child(http)
|
||||
|
||||
var api := _api_client()
|
||||
var headers := PackedStringArray(["Content-Type: application/json", "Accept: application/json"])
|
||||
if api.has_token():
|
||||
headers.append("Authorization: " + str(api.bearer_token))
|
||||
|
||||
var url: String = str(api.base_url) + path
|
||||
var err := http.request(url, headers, method, JSON.stringify(body_dict))
|
||||
if err != OK:
|
||||
http.queue_free()
|
||||
return {"status": 0, "data": null, "raw": "request failed to start (%d)" % err}
|
||||
|
||||
var args: Array = await http.request_completed
|
||||
var result_code: int = args[0]
|
||||
var response_code: int = args[1]
|
||||
var body_bytes: PackedByteArray = args[3]
|
||||
http.queue_free()
|
||||
|
||||
if result_code != HTTPRequest.RESULT_SUCCESS:
|
||||
return {"status": 0, "data": null, "raw": "transport error (%d)" % result_code}
|
||||
|
||||
var text := body_bytes.get_string_from_utf8()
|
||||
var parsed: Variant = JSON.parse_string(text) if text != "" else null
|
||||
return {"status": response_code, "data": parsed, "raw": text}
|
||||
|
||||
|
||||
func _error_detail(resp: Dictionary) -> String:
|
||||
var data: Variant = resp.get("data")
|
||||
if data is Dictionary and (data as Dictionary).has("detail"):
|
||||
return str((data as Dictionary)["detail"])
|
||||
if int(resp.get("status", 0)) == 0:
|
||||
return str(resp.get("raw", "network error"))
|
||||
return "HTTP error %d" % int(resp.get("status", 0))
|
||||
|
||||
|
||||
func _error_detail_from_body(body: PackedByteArray) -> String:
|
||||
var text := body.get_string_from_utf8()
|
||||
var parsed: Variant = JSON.parse_string(text) if text != "" else null
|
||||
if parsed is Dictionary and (parsed as Dictionary).has("detail"):
|
||||
return str((parsed as Dictionary)["detail"])
|
||||
return text
|
||||
|
||||
|
||||
func _fetch_result(ok: bool, status: int, model: ChunkEditorModel, revision: int,
|
||||
checksum: String, detail: String) -> Dictionary:
|
||||
return {"ok": ok, "status": status, "model": model, "revision": revision,
|
||||
"checksum": checksum, "detail": detail}
|
||||
|
||||
|
||||
func _int_header(headers: PackedStringArray, key: String) -> int:
|
||||
var prefix := key + ":"
|
||||
for h in headers:
|
||||
if h.to_lower().begins_with(prefix):
|
||||
return int(h.substr(h.find(":") + 1).strip_edges())
|
||||
return 0
|
||||
|
||||
|
||||
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 ""
|
||||
@@ -0,0 +1,114 @@
|
||||
class_name EditorCore
|
||||
extends RefCounted
|
||||
## Shared, data-native editor core (docs/architecture/editor.md §7.1).
|
||||
##
|
||||
## Both the in-game editor UI (`scripts/editor/ui/in_game_editor.gd`) and,
|
||||
## per the doc's §6.2/§7.3, any future thin dev-plugin surface are meant to
|
||||
## sit on top of this single object. It never touches `Control` nodes,
|
||||
## HTTP, or the live scene tree -- it only knows about the chunk model,
|
||||
## undo/redo, selection, and tools. It owns:
|
||||
##
|
||||
## - `model` (ChunkEditorModel) the chunk being edited
|
||||
## - `undo_redo` (EditorUndoRedoStack) command-pattern history
|
||||
## - `selection` (SelectionManager) selected object id
|
||||
## - `tools` (ToolRegistry) brush / object_place / select /
|
||||
## erase / transform
|
||||
## - `catalog` (EditorObjectCatalog, optional) palette source consumed
|
||||
## by `object_place`
|
||||
##
|
||||
## Every mutating public method here (`paint_tile`, `erase_tile`,
|
||||
## `place_object`, `delete_object`, `move_object`, `rotate_object`,
|
||||
## `scale_object`, `select_object`) is a thin wrapper around `use_tool()` --
|
||||
## it goes through `ToolRegistry`, never straight at `ChunkEditorModel`.
|
||||
## This is the seam this task's verification bar cares about: UI code and
|
||||
## tests mutate the chunk exactly the same way, so a test that calls
|
||||
## `core.move_object(...)` is exercising the same code path a player's
|
||||
## drag-in-the-viewport would.
|
||||
##
|
||||
## Persisting the edited chunk to the backend is explicitly **out of
|
||||
## scope** here (a sibling task owns the batch-PUT/conflict-handling save
|
||||
## path per world_persistence_impl.md) -- `model.encode_binary()` is as far
|
||||
## as this class goes.
|
||||
|
||||
var model: ChunkEditorModel
|
||||
var undo_redo: EditorUndoRedoStack
|
||||
var selection: SelectionManager
|
||||
var tools: ToolRegistry
|
||||
var catalog: EditorObjectCatalog = null
|
||||
|
||||
|
||||
func _init(p_model: ChunkEditorModel, p_catalog: EditorObjectCatalog = null) -> void:
|
||||
model = p_model
|
||||
catalog = p_catalog
|
||||
undo_redo = EditorUndoRedoStack.new()
|
||||
selection = SelectionManager.new()
|
||||
tools = ToolRegistry.new()
|
||||
tools.register_tool(BrushTool.new())
|
||||
tools.register_tool(ObjectPlaceTool.new())
|
||||
tools.register_tool(SelectTool.new())
|
||||
tools.register_tool(EraseTool.new())
|
||||
tools.register_tool(TransformTool.new())
|
||||
tools.set_active_tool("select")
|
||||
|
||||
|
||||
## Route an action through the named tool. This is the single choke point
|
||||
## every mutation (and every convenience wrapper below) goes through.
|
||||
func use_tool(tool_id: String, args: Dictionary) -> Variant:
|
||||
var tool: EditorTool = tools.get_tool(tool_id)
|
||||
if tool == null:
|
||||
push_error("EditorCore: unknown tool '%s'" % tool_id)
|
||||
return null
|
||||
return tool.apply(self, args)
|
||||
|
||||
|
||||
# ───────── convenience wrappers (all route through use_tool/ToolRegistry) ─────────
|
||||
|
||||
func paint_tile(layer_idx: int, x: int, y: int, tile_id: int, z: int = 0) -> bool:
|
||||
return bool(use_tool("brush", {"layer": layer_idx, "x": x, "y": y, "z": z, "tile_id": tile_id}))
|
||||
|
||||
|
||||
func erase_tile(layer_idx: int, x: int, y: int, z: int = 0) -> bool:
|
||||
return bool(use_tool("erase", {"layer": layer_idx, "x": x, "y": y, "z": z}))
|
||||
|
||||
|
||||
func place_object(catalog_id: String, position: Vector3,
|
||||
rotation: Vector4 = Vector4(0, 0, 0, 1), scale: Vector3 = Vector3.ONE) -> String:
|
||||
var result: Variant = use_tool("object_place", {
|
||||
"catalog_id": catalog_id,
|
||||
"position": position,
|
||||
"rotation": rotation,
|
||||
"scale": scale,
|
||||
})
|
||||
return result if result is String else ""
|
||||
|
||||
|
||||
func delete_object(object_id: String) -> bool:
|
||||
return bool(use_tool("erase", {"object_id": object_id}))
|
||||
|
||||
|
||||
func move_object(object_id: String, position: Vector3) -> bool:
|
||||
return bool(use_tool("transform", {"object_id": object_id, "op": "move", "value": position}))
|
||||
|
||||
|
||||
func rotate_object(object_id: String, rotation: Vector4) -> bool:
|
||||
return bool(use_tool("transform", {"object_id": object_id, "op": "rotate", "value": rotation}))
|
||||
|
||||
|
||||
func scale_object(object_id: String, scale: Vector3) -> bool:
|
||||
return bool(use_tool("transform", {"object_id": object_id, "op": "scale", "value": scale}))
|
||||
|
||||
|
||||
func select_object(object_id: String) -> bool:
|
||||
return bool(use_tool("select", {"object_id": object_id}))
|
||||
|
||||
|
||||
func clear_selection() -> void:
|
||||
use_tool("select", {})
|
||||
|
||||
|
||||
func undo() -> bool:
|
||||
return undo_redo.undo()
|
||||
|
||||
|
||||
func redo() -> bool:
|
||||
return undo_redo.redo()
|
||||
@@ -0,0 +1,73 @@
|
||||
class_name EditorUndoRedoStack
|
||||
extends RefCounted
|
||||
## Command pattern over ChunkEditorModel mutations
|
||||
## (docs/architecture/editor.md §7.1 `UndoRedoStack`).
|
||||
##
|
||||
## Thin wrapper around Godot's built-in `UndoRedo` -- the general-purpose
|
||||
## class meant for use in game code (unlike the editor-only
|
||||
## `EditorUndoRedoManager`, which only exists inside `EditorPlugin`s and
|
||||
## isn't available at runtime). Every EditorCore tool (scripts/editor/tools/
|
||||
## *.gd) opens exactly one action per user operation and adds a do/undo
|
||||
## Callable pair that calls the *same* ChunkEditorModel raw setter in both
|
||||
## directions (e.g. `set_tile_raw` with the new id, then again with the old
|
||||
## one) -- so undo genuinely reverts the mutation instead of re-deriving it.
|
||||
##
|
||||
## `UndoRedo` extends `Object`, not `RefCounted`, so it is not automatically
|
||||
## freed; `_notification(NOTIFICATION_PREDELETE)` frees it when this wrapper
|
||||
## (a RefCounted) goes out of scope.
|
||||
|
||||
var _ur := UndoRedo.new()
|
||||
|
||||
|
||||
func _notification(what: int) -> void:
|
||||
if what == NOTIFICATION_PREDELETE and _ur != null:
|
||||
_ur.free()
|
||||
_ur = null
|
||||
|
||||
|
||||
## Begin a new undoable action. Must be paired with `commit()`.
|
||||
func begin(action_name: String) -> void:
|
||||
_ur.create_action(action_name)
|
||||
|
||||
|
||||
## Register the forward step of the current action. Called immediately by
|
||||
## `commit()`, and again on every future `redo()`.
|
||||
func add_do(callable: Callable) -> void:
|
||||
_ur.add_do_method(callable)
|
||||
|
||||
|
||||
## Register the reverse step of the current action. Called on every
|
||||
## `undo()`.
|
||||
func add_undo(callable: Callable) -> void:
|
||||
_ur.add_undo_method(callable)
|
||||
|
||||
|
||||
## Close the current action and execute its do-step once.
|
||||
func commit() -> void:
|
||||
_ur.commit_action()
|
||||
|
||||
|
||||
## Close the current action without executing anything (used when a tool
|
||||
## decides mid-way that there is nothing worth recording).
|
||||
func cancel() -> void:
|
||||
_ur.commit_action(false)
|
||||
|
||||
|
||||
func undo() -> bool:
|
||||
return _ur.undo()
|
||||
|
||||
|
||||
func redo() -> bool:
|
||||
return _ur.redo()
|
||||
|
||||
|
||||
func can_undo() -> bool:
|
||||
return _ur.has_undo()
|
||||
|
||||
|
||||
func can_redo() -> bool:
|
||||
return _ur.has_redo()
|
||||
|
||||
|
||||
func clear_history() -> void:
|
||||
_ur.clear_history()
|
||||
@@ -0,0 +1,68 @@
|
||||
class_name EditorObjectCatalog
|
||||
extends RefCounted
|
||||
## Catalog of placeable world objects for the in-game editor's
|
||||
## `PalettePanel` (docs/architecture/editor.md §7.2).
|
||||
##
|
||||
## Mirrors the loading convention already used twice in this codebase --
|
||||
## `scripts/avatar/avatar_catalog.gd` (AvatarCatalog) and
|
||||
## `scripts/scripting/spawn_catalog.gd` (SpawnCatalog): a data-driven JSON
|
||||
## manifest, loaded once, looked up by id. Checked both before adding this:
|
||||
## `AvatarCatalog` is avatar-attachment-specific (base_body/slot/mount_bone)
|
||||
## and `SpawnCatalog` is scoped to `ScriptBehavior`'s `spawn_from_catalog`
|
||||
## verb specifically (its own doc comment says as much) -- neither is a
|
||||
## general "placeable world object" catalog, so this is a new, small one
|
||||
## rather than a reuse of either.
|
||||
|
||||
## Catalog manifest structure:
|
||||
## { "objects": { "id": { "type", "asset_id", "display_name", ... } } }
|
||||
var _catalog: Dictionary = {}
|
||||
var _loaded: bool = false
|
||||
var _catalog_path: String = "res://assets/editor/object_catalog.json"
|
||||
|
||||
|
||||
func load_catalog(path: String = _catalog_path) -> Error:
|
||||
_catalog_path = path
|
||||
_catalog = {}
|
||||
|
||||
var file := FileAccess.open(path, FileAccess.READ)
|
||||
if file == null:
|
||||
return FileAccess.get_open_error()
|
||||
|
||||
var json_text: String = file.get_as_text()
|
||||
file.close()
|
||||
|
||||
var result: Variant = JSON.parse_string(json_text)
|
||||
if result == null or not (result is Dictionary) or not (result as Dictionary).has("objects"):
|
||||
return ERR_INVALID_DATA
|
||||
|
||||
_catalog = (result as Dictionary)["objects"]
|
||||
_loaded = true
|
||||
return OK
|
||||
|
||||
|
||||
func is_loaded() -> bool:
|
||||
return _loaded
|
||||
|
||||
|
||||
## Resolve a catalog id to its template Dictionary ({} if unknown/unloaded).
|
||||
func resolve(id: String) -> Dictionary:
|
||||
if not _loaded:
|
||||
return {}
|
||||
return _catalog.get(id, {})
|
||||
|
||||
|
||||
func has_object(id: String) -> bool:
|
||||
return _loaded and _catalog.has(id)
|
||||
|
||||
|
||||
func get_all_ids() -> Array[String]:
|
||||
if not _loaded:
|
||||
return []
|
||||
var ids: Array[String] = []
|
||||
for id in _catalog.keys():
|
||||
ids.append(id)
|
||||
return ids
|
||||
|
||||
|
||||
func get_catalog_path() -> String:
|
||||
return _catalog_path
|
||||
@@ -0,0 +1,32 @@
|
||||
class_name SelectionManager
|
||||
extends RefCounted
|
||||
## Tracks the currently-selected object in the in-game editor
|
||||
## (docs/architecture/editor.md §7.1 `SelectionManager`).
|
||||
##
|
||||
## Selection is UI/session state, not chunk data: it is never pushed onto
|
||||
## `EditorUndoRedoStack` and never encoded into the `ChunkPayload`. Scoped
|
||||
## to a single selected object id, matching the 2D-tile-editor scope
|
||||
## (docs/architecture/editor.md §8) -- multi-select is future work.
|
||||
|
||||
signal selection_changed(object_id: String)
|
||||
|
||||
var _selected_id: String = ""
|
||||
|
||||
|
||||
func select(object_id: String) -> void:
|
||||
if _selected_id == object_id:
|
||||
return
|
||||
_selected_id = object_id
|
||||
selection_changed.emit(_selected_id)
|
||||
|
||||
|
||||
func clear() -> void:
|
||||
select("")
|
||||
|
||||
|
||||
func get_selected() -> String:
|
||||
return _selected_id
|
||||
|
||||
|
||||
func has_selection() -> bool:
|
||||
return _selected_id != ""
|
||||
@@ -0,0 +1,41 @@
|
||||
class_name ToolRegistry
|
||||
extends RefCounted
|
||||
## Registry of `EditorTool` instances, keyed by id
|
||||
## (docs/architecture/editor.md §7.1: "brush / object-place / select /
|
||||
## erase, etc."). `EditorCore.use_tool()` is the single choke point every
|
||||
## chunk mutation goes through -- UI code and tests both call tools by id
|
||||
## through here rather than reaching into `ChunkEditorModel` directly.
|
||||
|
||||
var _tools: Dictionary = {}
|
||||
var _active_id: String = ""
|
||||
|
||||
|
||||
func register_tool(tool: EditorTool) -> void:
|
||||
_tools[tool.tool_id] = tool
|
||||
|
||||
|
||||
func get_tool(tool_id: String) -> EditorTool:
|
||||
return _tools.get(tool_id, null)
|
||||
|
||||
|
||||
func has_tool(tool_id: String) -> bool:
|
||||
return _tools.has(tool_id)
|
||||
|
||||
|
||||
func get_tool_ids() -> Array:
|
||||
return _tools.keys()
|
||||
|
||||
|
||||
func set_active_tool(tool_id: String) -> bool:
|
||||
if not _tools.has(tool_id):
|
||||
return false
|
||||
_active_id = tool_id
|
||||
return true
|
||||
|
||||
|
||||
func get_active_tool_id() -> String:
|
||||
return _active_id
|
||||
|
||||
|
||||
func get_active_tool() -> EditorTool:
|
||||
return _tools.get(_active_id, null)
|
||||
@@ -0,0 +1,31 @@
|
||||
class_name BrushTool
|
||||
extends EditorTool
|
||||
## Paints a single tile id into a tile layer at (x, y[, z]).
|
||||
##
|
||||
## `args`: `layer` (int, default 0), `x` (int), `y` (int), `z` (int,
|
||||
## default 0), `tile_id` (int).
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
tool_id = "brush"
|
||||
|
||||
|
||||
func apply(core: EditorCore, args: Dictionary) -> Variant:
|
||||
var layer_idx: int = args.get("layer", 0)
|
||||
var x: int = args.get("x", 0)
|
||||
var y: int = args.get("y", 0)
|
||||
var z: int = args.get("z", 0)
|
||||
var tile_id: int = args.get("tile_id", 0)
|
||||
|
||||
if not core.model.is_tile_in_bounds(layer_idx, x, y, z):
|
||||
return false
|
||||
|
||||
var old_tile_id: int = core.model.get_tile_raw(layer_idx, x, y, z)
|
||||
if old_tile_id == tile_id:
|
||||
return false # no-op -- nothing to undo
|
||||
|
||||
core.undo_redo.begin("Paint tile (%d,%d,%d) -> %d" % [x, y, z, tile_id])
|
||||
core.undo_redo.add_do(core.model.set_tile_raw.bind(layer_idx, x, y, z, tile_id))
|
||||
core.undo_redo.add_undo(core.model.set_tile_raw.bind(layer_idx, x, y, z, old_tile_id))
|
||||
core.undo_redo.commit()
|
||||
return true
|
||||
@@ -0,0 +1,20 @@
|
||||
class_name EditorTool
|
||||
extends RefCounted
|
||||
## Base class for EditorCore tools (docs/architecture/editor.md §7.1
|
||||
## `ToolRegistry`: brush / object-place / select / erase / transform).
|
||||
##
|
||||
## A tool never mutates `ChunkEditorModel` "bare" -- every chunk-data
|
||||
## mutation goes through `EditorCore.undo_redo` so it is always revertible.
|
||||
## (Selection is the one exception: it is UI state, not chunk data, and
|
||||
## `SelectTool` intentionally does not touch undo/redo -- see its comment.)
|
||||
|
||||
var tool_id: String = ""
|
||||
|
||||
|
||||
## Apply this tool's action against `core` with `args`. Returns a
|
||||
## tool-specific result on success (often `true`/a new object id), or a
|
||||
## falsy value (`false`/`""`/`null`) if nothing changed -- callers should
|
||||
## treat falsy as "no-op, nothing to undo".
|
||||
func apply(_core: EditorCore, _args: Dictionary) -> Variant:
|
||||
push_error("EditorTool.apply() not implemented for tool '%s'" % tool_id)
|
||||
return null
|
||||
@@ -0,0 +1,41 @@
|
||||
class_name EraseTool
|
||||
extends EditorTool
|
||||
## Deletes an object, or clears a tile back to id 0 (the reserved empty/air
|
||||
## id -- world.md §3.2 / TileDef doc comment).
|
||||
##
|
||||
## `args`: either `{"object_id": ...}` to delete an object, or
|
||||
## `{"layer", "x", "y", "z"}` to clear a tile (delegates to BrushTool with
|
||||
## `tile_id = 0` so both paths share one undo/redo implementation).
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
tool_id = "erase"
|
||||
|
||||
|
||||
func apply(core: EditorCore, args: Dictionary) -> Variant:
|
||||
if args.has("object_id"):
|
||||
return _erase_object(core, args["object_id"])
|
||||
return _erase_tile(core, args)
|
||||
|
||||
|
||||
func _erase_object(core: EditorCore, object_id: String) -> bool:
|
||||
var idx: int = core.model.get_object_index(object_id)
|
||||
if idx == -1:
|
||||
return false
|
||||
var obj: ChunkDataDecoder.WorldObjectData = core.model.payload.objects[idx]
|
||||
|
||||
core.undo_redo.begin("Delete '%s'" % object_id)
|
||||
core.undo_redo.add_do(core.model.remove_object_raw.bind(object_id))
|
||||
core.undo_redo.add_undo(core.model.insert_object_raw.bind(obj, idx))
|
||||
core.undo_redo.commit()
|
||||
|
||||
if core.selection.get_selected() == object_id:
|
||||
core.selection.clear()
|
||||
return true
|
||||
|
||||
|
||||
func _erase_tile(core: EditorCore, args: Dictionary) -> bool:
|
||||
var brush: EditorTool = core.tools.get_tool("brush")
|
||||
var tile_args: Dictionary = args.duplicate()
|
||||
tile_args["tile_id"] = 0
|
||||
return bool(brush.apply(core, tile_args))
|
||||
@@ -0,0 +1,50 @@
|
||||
class_name ObjectPlaceTool
|
||||
extends EditorTool
|
||||
## Places a new catalog object into the chunk at a given transform.
|
||||
##
|
||||
## `args`: `catalog_id` (String, required), `position` (Vector3), `rotation`
|
||||
## (Vector4 quaternion, optional, default identity), `scale` (Vector3,
|
||||
## optional, default ONE), `properties` (Dictionary, optional, merged in).
|
||||
##
|
||||
## Returns the new object's id (String) on success, or "" on failure
|
||||
## (unknown catalog_id).
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
tool_id = "object_place"
|
||||
|
||||
|
||||
func apply(core: EditorCore, args: Dictionary) -> Variant:
|
||||
var catalog_id: String = args.get("catalog_id", "")
|
||||
if catalog_id == "":
|
||||
push_error("ObjectPlaceTool: missing catalog_id")
|
||||
return ""
|
||||
|
||||
var entry: Dictionary = {}
|
||||
if core.catalog != null:
|
||||
entry = core.catalog.resolve(catalog_id)
|
||||
if entry.is_empty():
|
||||
push_error("ObjectPlaceTool: unknown catalog_id '%s'" % catalog_id)
|
||||
return ""
|
||||
|
||||
var obj := ChunkDataDecoder.WorldObjectData.new()
|
||||
obj.id = core.model.generate_object_id()
|
||||
obj.type = entry.get("type", "prop")
|
||||
obj.asset_id = entry.get("asset_id", catalog_id)
|
||||
obj.position = args.get("position", Vector3.ZERO)
|
||||
obj.rotation = args.get("rotation", Vector4(0, 0, 0, 1))
|
||||
obj.scale = args.get("scale", Vector3.ONE)
|
||||
|
||||
var props: Dictionary = (args.get("properties", {}) as Dictionary).duplicate()
|
||||
if entry.has("display_name"):
|
||||
props["display_name"] = entry["display_name"]
|
||||
props["catalog_id"] = catalog_id
|
||||
obj.properties = props
|
||||
|
||||
core.undo_redo.begin("Place '%s' (%s)" % [obj.id, catalog_id])
|
||||
core.undo_redo.add_do(core.model.add_object_raw.bind(obj))
|
||||
core.undo_redo.add_undo(core.model.remove_object_raw.bind(obj.id))
|
||||
core.undo_redo.commit()
|
||||
|
||||
core.selection.select(obj.id)
|
||||
return obj.id
|
||||
@@ -0,0 +1,24 @@
|
||||
class_name SelectTool
|
||||
extends EditorTool
|
||||
## Selects (or clears) the active object in `EditorCore.selection`.
|
||||
##
|
||||
## `args`: `object_id` (String) -- omitted or "" clears the selection.
|
||||
##
|
||||
## Selection is UI/session state, not chunk data (docs/architecture/editor.md
|
||||
## §7.1 lists `SelectionManager` as a sibling of `UndoRedoStack`, not a
|
||||
## client of it), so this intentionally never touches `core.undo_redo`.
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
tool_id = "select"
|
||||
|
||||
|
||||
func apply(core: EditorCore, args: Dictionary) -> Variant:
|
||||
var object_id: String = args.get("object_id", "")
|
||||
if object_id == "":
|
||||
core.selection.clear()
|
||||
return true
|
||||
if core.model.find_object(object_id) == null:
|
||||
return false
|
||||
core.selection.select(object_id)
|
||||
return true
|
||||
@@ -0,0 +1,62 @@
|
||||
class_name TransformTool
|
||||
extends EditorTool
|
||||
## Moves, rotates, or scales an existing object.
|
||||
##
|
||||
## Not one of the four tools literally named in docs/architecture/editor.md
|
||||
## §7.1's `ToolRegistry` list ("brush / object-place / select / erase,
|
||||
## etc.") but required by this task's brief ("place / move / rotate / scale
|
||||
## / delete") -- the doc's own "etc." leaves room, so this is a fifth
|
||||
## registered tool rather than overloading `ObjectPlaceTool` (placing a new
|
||||
## object and re-transforming an existing one are different undo units)
|
||||
## or `SelectTool` (selection is deliberately not chunk-mutating).
|
||||
##
|
||||
## `args`: `object_id` (String), `op` ("move" | "rotate" | "scale"), `value`
|
||||
## (Vector3 for move/scale, Vector4 quaternion for rotate).
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
tool_id = "transform"
|
||||
|
||||
|
||||
func apply(core: EditorCore, args: Dictionary) -> Variant:
|
||||
var object_id: String = args.get("object_id", "")
|
||||
var op: String = args.get("op", "")
|
||||
var obj := core.model.find_object(object_id)
|
||||
if obj == null:
|
||||
return false
|
||||
|
||||
match op:
|
||||
"move":
|
||||
return _apply_vector3(core, object_id, args.get("value", obj.position),
|
||||
obj.position, "Move", core.model.set_object_position_raw)
|
||||
"rotate":
|
||||
return _apply_vector4(core, object_id, args.get("value", obj.rotation),
|
||||
obj.rotation, "Rotate", core.model.set_object_rotation_raw)
|
||||
"scale":
|
||||
return _apply_vector3(core, object_id, args.get("value", obj.scale),
|
||||
obj.scale, "Scale", core.model.set_object_scale_raw)
|
||||
_:
|
||||
push_error("TransformTool: unknown op '%s'" % op)
|
||||
return false
|
||||
|
||||
|
||||
func _apply_vector3(core: EditorCore, object_id: String, new_value: Vector3,
|
||||
old_value: Vector3, label: String, setter: Callable) -> bool:
|
||||
if new_value.is_equal_approx(old_value):
|
||||
return false
|
||||
core.undo_redo.begin("%s '%s'" % [label, object_id])
|
||||
core.undo_redo.add_do(setter.bind(object_id, new_value))
|
||||
core.undo_redo.add_undo(setter.bind(object_id, old_value))
|
||||
core.undo_redo.commit()
|
||||
return true
|
||||
|
||||
|
||||
func _apply_vector4(core: EditorCore, object_id: String, new_value: Vector4,
|
||||
old_value: Vector4, label: String, setter: Callable) -> bool:
|
||||
if new_value.is_equal_approx(old_value):
|
||||
return false
|
||||
core.undo_redo.begin("%s '%s'" % [label, object_id])
|
||||
core.undo_redo.add_do(setter.bind(object_id, new_value))
|
||||
core.undo_redo.add_undo(setter.bind(object_id, old_value))
|
||||
core.undo_redo.commit()
|
||||
return true
|
||||
@@ -0,0 +1,65 @@
|
||||
class_name EditorToolbar
|
||||
extends HBoxContainer
|
||||
## Tool-mode switcher for the in-game editor (docs/architecture/editor.md
|
||||
## §7.2 `Toolbar`). Pure UI: it only emits signals: `InGameEditor` decides
|
||||
## what to do with them (calling into `EditorCore`/`ToolRegistry`).
|
||||
|
||||
signal tool_selected(tool_id: String)
|
||||
signal undo_pressed
|
||||
signal redo_pressed
|
||||
|
||||
const TOOL_LABELS := {
|
||||
"select": "Select",
|
||||
"brush": "Brush",
|
||||
"object_place": "Place",
|
||||
"erase": "Erase",
|
||||
}
|
||||
|
||||
var _tool_buttons: Dictionary = {}
|
||||
var _undo_button: Button
|
||||
var _redo_button: Button
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
name = "EditorToolbar"
|
||||
|
||||
|
||||
func _ready() -> void:
|
||||
for tool_id in TOOL_LABELS:
|
||||
var btn := Button.new()
|
||||
btn.text = TOOL_LABELS[tool_id]
|
||||
btn.toggle_mode = true
|
||||
btn.pressed.connect(_on_tool_button_pressed.bind(tool_id))
|
||||
add_child(btn)
|
||||
_tool_buttons[tool_id] = btn
|
||||
|
||||
add_child(VSeparator.new())
|
||||
|
||||
_undo_button = Button.new()
|
||||
_undo_button.text = "Undo"
|
||||
_undo_button.pressed.connect(func(): undo_pressed.emit())
|
||||
add_child(_undo_button)
|
||||
|
||||
_redo_button = Button.new()
|
||||
_redo_button.text = "Redo"
|
||||
_redo_button.pressed.connect(func(): redo_pressed.emit())
|
||||
add_child(_redo_button)
|
||||
|
||||
|
||||
func _on_tool_button_pressed(tool_id: String) -> void:
|
||||
set_active_tool(tool_id)
|
||||
tool_selected.emit(tool_id)
|
||||
|
||||
|
||||
## Reflect the active tool in the button states without re-emitting the signal.
|
||||
func set_active_tool(tool_id: String) -> void:
|
||||
for id in _tool_buttons:
|
||||
_tool_buttons[id].button_pressed = (id == tool_id)
|
||||
|
||||
|
||||
## Reflect whether undo/redo currently have anything to do.
|
||||
func set_history_state(can_undo: bool, can_redo: bool) -> void:
|
||||
if _undo_button:
|
||||
_undo_button.disabled = not can_undo
|
||||
if _redo_button:
|
||||
_redo_button.disabled = not can_redo
|
||||
@@ -0,0 +1,135 @@
|
||||
class_name EditorViewport
|
||||
extends Control
|
||||
## Custom 2D viewport for the in-game editor (docs/architecture/editor.md
|
||||
## §7.2 `EditorViewport`).
|
||||
##
|
||||
## Deliberately 2D top-down, not a 3D gizmo viewport -- per §8's own risk
|
||||
## mitigation ("start with a 2D tile editor... matches CHUNK_SIZE_Z=1
|
||||
## default; add 3D later"). Renders one tile layer as a grid plus the
|
||||
## chunk's objects as dots, and turns clicks into calls on `EditorCore`
|
||||
## routed through whichever tool is active in `ToolRegistry` -- this is UI
|
||||
## glue, it never mutates `ChunkEditorModel` itself.
|
||||
##
|
||||
## Coordinate convention matches the rest of this codebase's tile system
|
||||
## (scripts/tile_layer_node.gd `_tile_to_world`): chunk-local X/Y are the
|
||||
## flat ground plane, Z is height (CHUNK_SIZE_Z=1 by default -- see
|
||||
## scripts/chunk.gd). One grid cell == one world unit == `cell_size` pixels.
|
||||
|
||||
signal edit_applied
|
||||
|
||||
var core: EditorCore = null
|
||||
var layer_idx: int = 0
|
||||
var cell_size: float = 24.0
|
||||
## Catalog id the next "object_place" click will place. Set by
|
||||
## `InGameEditor` from `PalettePanel.object_selected`.
|
||||
var pending_catalog_id: String = ""
|
||||
## Tile id the next "brush" click paints. Cycled with number keys 0-9.
|
||||
var current_tile_id: int = 1
|
||||
|
||||
const TILE_EMPTY_COLOR := Color(0.15, 0.15, 0.17)
|
||||
const TILE_SOLID_COLOR := Color(0.35, 0.55, 0.35)
|
||||
const GRID_COLOR := Color(0, 0, 0, 0.25)
|
||||
const OBJECT_COLOR := Color(0.9, 0.6, 0.2)
|
||||
const OBJECT_SELECTED_COLOR := Color(1.0, 0.95, 0.2)
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
name = "EditorViewport"
|
||||
mouse_filter = Control.MOUSE_FILTER_STOP
|
||||
focus_mode = Control.FOCUS_ALL
|
||||
|
||||
|
||||
func setup(p_core: EditorCore, p_layer_idx: int = 0) -> void:
|
||||
core = p_core
|
||||
layer_idx = p_layer_idx
|
||||
core.selection.selection_changed.connect(func(_id): queue_redraw())
|
||||
_resize_to_layer()
|
||||
queue_redraw()
|
||||
|
||||
|
||||
func _resize_to_layer() -> void:
|
||||
var layer := core.model.get_layer(layer_idx)
|
||||
if layer == null:
|
||||
custom_minimum_size = Vector2(cell_size * 8, cell_size * 8)
|
||||
return
|
||||
custom_minimum_size = Vector2(layer.width * cell_size, layer.height * cell_size)
|
||||
|
||||
|
||||
func _draw() -> void:
|
||||
if core == null:
|
||||
return
|
||||
var layer := core.model.get_layer(layer_idx)
|
||||
if layer == null:
|
||||
return
|
||||
|
||||
for y in range(layer.height):
|
||||
for x in range(layer.width):
|
||||
var tile_id := layer.get_tile(x, y, 0)
|
||||
var color := TILE_EMPTY_COLOR
|
||||
var tdef := layer.get_tile_def(tile_id)
|
||||
if tdef != null and tdef.solid:
|
||||
color = TILE_SOLID_COLOR
|
||||
draw_rect(Rect2(x * cell_size, y * cell_size, cell_size, cell_size), color, true)
|
||||
|
||||
for x in range(layer.width + 1):
|
||||
draw_line(Vector2(x * cell_size, 0), Vector2(x * cell_size, layer.height * cell_size), GRID_COLOR)
|
||||
for y in range(layer.height + 1):
|
||||
draw_line(Vector2(0, y * cell_size), Vector2(layer.width * cell_size, y * cell_size), GRID_COLOR)
|
||||
|
||||
for obj in core.model.payload.objects:
|
||||
var center := Vector2(obj.position.x * cell_size, obj.position.y * cell_size)
|
||||
var is_selected: bool = core.selection.get_selected() == obj.id
|
||||
var color := OBJECT_SELECTED_COLOR if is_selected else OBJECT_COLOR
|
||||
draw_circle(center, cell_size * 0.3, color)
|
||||
|
||||
|
||||
func _gui_input(event: InputEvent) -> void:
|
||||
if core == null:
|
||||
return
|
||||
if event is InputEventMouseButton:
|
||||
var mb := event as InputEventMouseButton
|
||||
if mb.pressed and mb.button_index == MOUSE_BUTTON_LEFT:
|
||||
_handle_click(mb.position)
|
||||
accept_event()
|
||||
elif event is InputEventKey:
|
||||
var key := event as InputEventKey
|
||||
if key.pressed and not key.echo:
|
||||
_handle_key(key)
|
||||
|
||||
|
||||
func _handle_key(key: InputEventKey) -> void:
|
||||
if key.keycode >= KEY_0 and key.keycode <= KEY_9:
|
||||
current_tile_id = key.keycode - KEY_0
|
||||
|
||||
|
||||
func _handle_click(local_pos: Vector2) -> void:
|
||||
var tx := int(floor(local_pos.x / cell_size))
|
||||
var ty := int(floor(local_pos.y / cell_size))
|
||||
|
||||
match core.tools.get_active_tool_id():
|
||||
"brush":
|
||||
if core.paint_tile(layer_idx, tx, ty, current_tile_id):
|
||||
edit_applied.emit()
|
||||
queue_redraw()
|
||||
"erase":
|
||||
var hit := _object_at(tx, ty)
|
||||
var changed: bool = core.delete_object(hit) if hit != "" else core.erase_tile(layer_idx, tx, ty)
|
||||
if changed:
|
||||
edit_applied.emit()
|
||||
queue_redraw()
|
||||
"object_place":
|
||||
if pending_catalog_id != "":
|
||||
var new_id := core.place_object(pending_catalog_id, Vector3(tx + 0.5, ty + 0.5, 0.0))
|
||||
if new_id != "":
|
||||
edit_applied.emit()
|
||||
queue_redraw()
|
||||
"select":
|
||||
core.select_object(_object_at(tx, ty))
|
||||
queue_redraw()
|
||||
|
||||
|
||||
func _object_at(tx: int, ty: int) -> String:
|
||||
for obj in core.model.payload.objects:
|
||||
if int(floor(obj.position.x)) == tx and int(floor(obj.position.y)) == ty:
|
||||
return obj.id
|
||||
return ""
|
||||
@@ -0,0 +1,250 @@
|
||||
class_name InGameEditor
|
||||
extends Control
|
||||
## In-game "build mode" UI (docs/architecture/editor.md §7.2 `InGameEditor`).
|
||||
##
|
||||
## Built entirely from `Control` nodes in code (matching this codebase's
|
||||
## existing convention for dynamic UI -- see `game.gd`'s `_show_build_stamp`
|
||||
## / `_show_status`) rather than a hand-authored `.tscn`, so there is one
|
||||
## fewer place for a scene-file/script mismatch to hide. It is only ever
|
||||
## instantiated when the player enters build mode (see `game.gd`'s
|
||||
## `_toggle_build_mode`), so it costs nothing during normal play.
|
||||
##
|
||||
## Composition matches the doc exactly:
|
||||
## EditorToolbar -- tool mode switcher
|
||||
## PalettePanel -- catalog-sourced object palette
|
||||
## EditorViewport -- the 2D tile/object canvas
|
||||
## InspectorPanel -- property editor for the selected object
|
||||
## EditorCore -- shared core (passed in, not owned/created here)
|
||||
##
|
||||
## Persisting edits (world_persistence_impl.md's single/batch-PUT save path,
|
||||
## §8.1-8.2) is wired through `ChunkSaveService`, set via
|
||||
## `setup_persistence()`. Without it (e.g. the F2 scratch-chunk path, or
|
||||
## `smoke_test_editor_core.gd`'s bare `InGameEditor.new(core)`), the Save
|
||||
## button is present but disabled -- closing the editor just discards the
|
||||
## UI and the in-memory `ChunkEditorModel` is unaffected either way.
|
||||
|
||||
signal closed
|
||||
|
||||
var core: EditorCore
|
||||
|
||||
var _toolbar: EditorToolbar
|
||||
var _palette: PalettePanel
|
||||
var _inspector: InspectorPanel
|
||||
var _viewport: EditorViewport
|
||||
var _close_button: Button
|
||||
var _save_button: Button
|
||||
var _save_status_label: Label
|
||||
|
||||
## Save-path state (world_persistence_impl.md §8.1/§8.2), set via
|
||||
## `setup_persistence()`. `_save_service == null` means there is nothing to
|
||||
## save to (see the class doc above) -- the Save button stays disabled.
|
||||
var _save_service: ChunkSaveService = null
|
||||
var _world_id: String = ""
|
||||
var _room_slug: String = "main"
|
||||
var _coord: Vector3i = Vector3i.ZERO
|
||||
var _base_revision: int = 0
|
||||
var _saving: bool = false
|
||||
|
||||
|
||||
func _init(p_core: EditorCore) -> void:
|
||||
core = p_core
|
||||
name = "InGameEditor"
|
||||
set_anchors_preset(Control.PRESET_FULL_RECT)
|
||||
mouse_filter = Control.MOUSE_FILTER_STOP
|
||||
|
||||
|
||||
## Wire this editor's Save button/Ctrl+S to a real backend round-trip.
|
||||
## `save_service` must already be in the scene tree (game.gd adds it as a
|
||||
## sibling before constructing this editor). `base_revision` is whatever the
|
||||
## caller last fetched for `coord` (0 if the chunk didn't exist yet).
|
||||
func setup_persistence(save_service: ChunkSaveService, world_id: String, room_slug: String,
|
||||
coord: Vector3i, base_revision: int) -> void:
|
||||
_save_service = save_service
|
||||
_world_id = world_id
|
||||
_room_slug = room_slug
|
||||
_coord = coord
|
||||
_base_revision = base_revision
|
||||
if _save_button != null:
|
||||
_save_button.disabled = false
|
||||
|
||||
|
||||
func _ready() -> void:
|
||||
_build_ui()
|
||||
_refresh_history_buttons()
|
||||
|
||||
|
||||
func _build_ui() -> void:
|
||||
var bg := ColorRect.new()
|
||||
bg.color = Color(0.08, 0.08, 0.09, 0.96)
|
||||
bg.set_anchors_preset(Control.PRESET_FULL_RECT)
|
||||
bg.mouse_filter = Control.MOUSE_FILTER_IGNORE
|
||||
add_child(bg)
|
||||
|
||||
var root_vbox := VBoxContainer.new()
|
||||
root_vbox.set_anchors_preset(Control.PRESET_FULL_RECT)
|
||||
root_vbox.offset_left = 12
|
||||
root_vbox.offset_top = 12
|
||||
root_vbox.offset_right = -12
|
||||
root_vbox.offset_bottom = -12
|
||||
add_child(root_vbox)
|
||||
|
||||
var top_bar := HBoxContainer.new()
|
||||
root_vbox.add_child(top_bar)
|
||||
|
||||
_toolbar = EditorToolbar.new()
|
||||
_toolbar.size_flags_horizontal = Control.SIZE_EXPAND_FILL
|
||||
top_bar.add_child(_toolbar)
|
||||
|
||||
_save_button = Button.new()
|
||||
_save_button.text = "Save (Ctrl+S)"
|
||||
_save_button.disabled = (_save_service == null)
|
||||
_save_button.pressed.connect(_on_save_pressed)
|
||||
top_bar.add_child(_save_button)
|
||||
|
||||
_close_button = Button.new()
|
||||
_close_button.text = "Close (F2)"
|
||||
_close_button.pressed.connect(_on_close_pressed)
|
||||
top_bar.add_child(_close_button)
|
||||
|
||||
_save_status_label = Label.new()
|
||||
_save_status_label.autowrap_mode = TextServer.AUTOWRAP_WORD
|
||||
_save_status_label.visible = false
|
||||
root_vbox.add_child(_save_status_label)
|
||||
|
||||
var body := HBoxContainer.new()
|
||||
body.size_flags_vertical = Control.SIZE_EXPAND_FILL
|
||||
root_vbox.add_child(body)
|
||||
|
||||
var viewport_scroll := ScrollContainer.new()
|
||||
viewport_scroll.size_flags_horizontal = Control.SIZE_EXPAND_FILL
|
||||
viewport_scroll.size_flags_vertical = Control.SIZE_EXPAND_FILL
|
||||
body.add_child(viewport_scroll)
|
||||
|
||||
_viewport = EditorViewport.new()
|
||||
viewport_scroll.add_child(_viewport)
|
||||
|
||||
var sidebar := VBoxContainer.new()
|
||||
sidebar.custom_minimum_size = Vector2(240, 0)
|
||||
body.add_child(sidebar)
|
||||
|
||||
_palette = PalettePanel.new()
|
||||
sidebar.add_child(_palette)
|
||||
|
||||
_inspector = InspectorPanel.new()
|
||||
sidebar.add_child(_inspector)
|
||||
|
||||
_viewport.setup(core, 0)
|
||||
_palette.set_catalog(core.catalog)
|
||||
_inspector.setup(core)
|
||||
|
||||
_toolbar.set_active_tool(core.tools.get_active_tool_id())
|
||||
_toolbar.tool_selected.connect(_on_tool_selected)
|
||||
_toolbar.undo_pressed.connect(_on_undo_pressed)
|
||||
_toolbar.redo_pressed.connect(_on_redo_pressed)
|
||||
_palette.object_selected.connect(_on_palette_object_selected)
|
||||
_inspector.delete_requested.connect(_on_inspector_delete_requested)
|
||||
_viewport.edit_applied.connect(_on_edit_applied)
|
||||
core.selection.selection_changed.connect(_on_selection_changed)
|
||||
|
||||
|
||||
func _unhandled_key_input(event: InputEvent) -> void:
|
||||
if not (event is InputEventKey):
|
||||
return
|
||||
var key := event as InputEventKey
|
||||
if not key.pressed or key.echo:
|
||||
return
|
||||
if key.ctrl_pressed and key.keycode == KEY_Z:
|
||||
_on_undo_pressed()
|
||||
get_viewport().set_input_as_handled()
|
||||
elif key.ctrl_pressed and key.keycode == KEY_Y:
|
||||
_on_redo_pressed()
|
||||
get_viewport().set_input_as_handled()
|
||||
elif key.ctrl_pressed and key.keycode == KEY_S:
|
||||
_on_save_pressed()
|
||||
get_viewport().set_input_as_handled()
|
||||
elif key.keycode == KEY_DELETE and core.selection.has_selection():
|
||||
core.delete_object(core.selection.get_selected())
|
||||
_on_edit_applied()
|
||||
get_viewport().set_input_as_handled()
|
||||
|
||||
|
||||
func _on_tool_selected(tool_id: String) -> void:
|
||||
core.tools.set_active_tool(tool_id)
|
||||
|
||||
|
||||
func _on_palette_object_selected(catalog_id: String) -> void:
|
||||
_viewport.pending_catalog_id = catalog_id
|
||||
core.tools.set_active_tool("object_place")
|
||||
_toolbar.set_active_tool("object_place")
|
||||
|
||||
|
||||
func _on_inspector_delete_requested(object_id: String) -> void:
|
||||
core.delete_object(object_id)
|
||||
_on_edit_applied()
|
||||
|
||||
|
||||
func _on_undo_pressed() -> void:
|
||||
core.undo()
|
||||
_on_edit_applied()
|
||||
|
||||
|
||||
func _on_redo_pressed() -> void:
|
||||
core.redo()
|
||||
_on_edit_applied()
|
||||
|
||||
|
||||
func _on_edit_applied() -> void:
|
||||
_viewport.queue_redraw()
|
||||
_inspector.show_object(core.selection.get_selected())
|
||||
_refresh_history_buttons()
|
||||
|
||||
|
||||
func _on_selection_changed(object_id: String) -> void:
|
||||
_inspector.show_object(object_id)
|
||||
|
||||
|
||||
func _refresh_history_buttons() -> void:
|
||||
_toolbar.set_history_state(core.undo_redo.can_undo(), core.undo_redo.can_redo())
|
||||
|
||||
|
||||
func _on_close_pressed() -> void:
|
||||
closed.emit()
|
||||
queue_free()
|
||||
|
||||
|
||||
## Single-chunk save (world_persistence_impl.md §8.1). `ChunkSaveService`
|
||||
## owns the actual HTTP round trip, retrying on `409` internally
|
||||
## (§8.2/§5.4) -- this just reflects the outcome and, per §6 D4, surfaces
|
||||
## the `live_session` flag as a warning instead of ignoring it.
|
||||
func _on_save_pressed() -> void:
|
||||
if _save_service == null or _saving:
|
||||
return
|
||||
_saving = true
|
||||
_save_button.disabled = true
|
||||
_set_save_status("Saving…", Color(0.85, 0.85, 0.85))
|
||||
|
||||
var result: Dictionary = await _save_service.save_chunk(core.model, _coord, _base_revision)
|
||||
|
||||
_saving = false
|
||||
_save_button.disabled = false
|
||||
|
||||
if result.get("ok", false):
|
||||
_base_revision = int(result.get("revision", _base_revision))
|
||||
var msg := "Saved (revision %d)." % _base_revision
|
||||
if bool(result.get("retried", false)):
|
||||
msg += " (resolved a save conflict automatically)"
|
||||
if bool(result.get("live_session", false)):
|
||||
msg += " This world has players in it right now -- they'll see your changes when the session restarts."
|
||||
_set_save_status(msg, Color(1.0, 0.8, 0.25))
|
||||
else:
|
||||
_set_save_status(msg, Color(0.55, 1.0, 0.55))
|
||||
else:
|
||||
_set_save_status("Save failed: %s" % str(result.get("detail", "unknown error")), Color(1.0, 0.45, 0.45))
|
||||
|
||||
|
||||
func _set_save_status(text: String, color: Color) -> void:
|
||||
if _save_status_label == null:
|
||||
return
|
||||
_save_status_label.text = text
|
||||
_save_status_label.add_theme_color_override("font_color", color)
|
||||
_save_status_label.visible = true
|
||||
@@ -0,0 +1,166 @@
|
||||
class_name InspectorPanel
|
||||
extends VBoxContainer
|
||||
## Property editor for the selected object (docs/architecture/editor.md
|
||||
## §7.2 `InspectorPanel`).
|
||||
##
|
||||
## 2D-tile-editor scope (docs/architecture/editor.md §8: the default world
|
||||
## is flat, `CHUNK_SIZE_Z=1`): position exposes X/Y (world-plane) plus a
|
||||
## single "height" Z for props that sit above the floor, and rotation
|
||||
## exposes one yaw field (rotation about the vertical axis) rather than a
|
||||
## full 3-axis gizmo -- deliberately not the volumetric 3D editing the doc
|
||||
## says to defer.
|
||||
##
|
||||
## Pure UI: every edit calls back into `EditorCore` (`move_object` /
|
||||
## `rotate_object` / `scale_object` / `delete_object`), so inspector edits
|
||||
## go through the exact same undo/redo path as viewport edits.
|
||||
|
||||
signal delete_requested(object_id: String)
|
||||
|
||||
var _core: EditorCore = null
|
||||
var _object_id: String = ""
|
||||
var _updating := false # guards against feedback loops while refreshing fields
|
||||
|
||||
var _id_label: Label
|
||||
var _type_label: Label
|
||||
var _asset_label: Label
|
||||
var _pos_x: SpinBox
|
||||
var _pos_y: SpinBox
|
||||
var _pos_z: SpinBox
|
||||
var _yaw: SpinBox
|
||||
var _scale_x: SpinBox
|
||||
var _scale_y: SpinBox
|
||||
var _scale_z: SpinBox
|
||||
var _delete_button: Button
|
||||
var _empty_label: Label
|
||||
var _fields_box: VBoxContainer
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
name = "InspectorPanel"
|
||||
|
||||
|
||||
func _ready() -> void:
|
||||
var header := Label.new()
|
||||
header.text = "Inspector"
|
||||
add_child(header)
|
||||
|
||||
_empty_label = Label.new()
|
||||
_empty_label.text = "(nothing selected)"
|
||||
add_child(_empty_label)
|
||||
|
||||
_fields_box = VBoxContainer.new()
|
||||
_fields_box.visible = false
|
||||
add_child(_fields_box)
|
||||
|
||||
_id_label = _add_readonly_row("id")
|
||||
_type_label = _add_readonly_row("type")
|
||||
_asset_label = _add_readonly_row("asset")
|
||||
|
||||
_pos_x = _add_spinbox_row("pos x")
|
||||
_pos_y = _add_spinbox_row("pos y")
|
||||
_pos_z = _add_spinbox_row("pos z (height)")
|
||||
_pos_x.value_changed.connect(_on_position_changed)
|
||||
_pos_y.value_changed.connect(_on_position_changed)
|
||||
_pos_z.value_changed.connect(_on_position_changed)
|
||||
|
||||
_yaw = _add_spinbox_row("rotation (deg)")
|
||||
_yaw.min_value = -360.0
|
||||
_yaw.max_value = 360.0
|
||||
_yaw.step = 1.0
|
||||
_yaw.value_changed.connect(_on_yaw_changed)
|
||||
|
||||
_scale_x = _add_spinbox_row("scale x")
|
||||
_scale_y = _add_spinbox_row("scale y")
|
||||
_scale_z = _add_spinbox_row("scale z")
|
||||
_scale_x.value_changed.connect(_on_scale_changed)
|
||||
_scale_y.value_changed.connect(_on_scale_changed)
|
||||
_scale_z.value_changed.connect(_on_scale_changed)
|
||||
|
||||
_delete_button = Button.new()
|
||||
_delete_button.text = "Delete"
|
||||
_delete_button.pressed.connect(_on_delete_pressed)
|
||||
_fields_box.add_child(_delete_button)
|
||||
|
||||
|
||||
func setup(core: EditorCore) -> void:
|
||||
_core = core
|
||||
|
||||
|
||||
func show_object(object_id: String) -> void:
|
||||
_object_id = object_id
|
||||
if object_id == "" or _core == null:
|
||||
_empty_label.visible = true
|
||||
_fields_box.visible = false
|
||||
return
|
||||
|
||||
var obj := _core.model.find_object(object_id)
|
||||
if obj == null:
|
||||
_empty_label.visible = true
|
||||
_fields_box.visible = false
|
||||
return
|
||||
|
||||
_empty_label.visible = false
|
||||
_fields_box.visible = true
|
||||
|
||||
_updating = true
|
||||
_id_label.text = "id: %s" % obj.id
|
||||
_type_label.text = "type: %s" % obj.type
|
||||
_asset_label.text = "asset: %s" % obj.asset_id
|
||||
_pos_x.value = obj.position.x
|
||||
_pos_y.value = obj.position.y
|
||||
_pos_z.value = obj.position.z
|
||||
_yaw.value = rad_to_deg(Quaternion(obj.rotation.x, obj.rotation.y, obj.rotation.z, obj.rotation.w).get_euler().y)
|
||||
_scale_x.value = obj.scale.x
|
||||
_scale_y.value = obj.scale.y
|
||||
_scale_z.value = obj.scale.z
|
||||
_updating = false
|
||||
|
||||
|
||||
func _on_position_changed(_v: float) -> void:
|
||||
if _updating or _core == null or _object_id == "":
|
||||
return
|
||||
_core.move_object(_object_id, Vector3(_pos_x.value, _pos_y.value, _pos_z.value))
|
||||
|
||||
|
||||
func _on_yaw_changed(v: float) -> void:
|
||||
if _updating or _core == null or _object_id == "":
|
||||
return
|
||||
var quat := Quaternion(Vector3.UP, deg_to_rad(v))
|
||||
_core.rotate_object(_object_id, Vector4(quat.x, quat.y, quat.z, quat.w))
|
||||
|
||||
|
||||
func _on_scale_changed(_v: float) -> void:
|
||||
if _updating or _core == null or _object_id == "":
|
||||
return
|
||||
_core.scale_object(_object_id, Vector3(_scale_x.value, _scale_y.value, _scale_z.value))
|
||||
|
||||
|
||||
func _on_delete_pressed() -> void:
|
||||
if _object_id == "":
|
||||
return
|
||||
var id := _object_id
|
||||
delete_requested.emit(id)
|
||||
|
||||
|
||||
func _add_readonly_row(label: String) -> Label:
|
||||
var l := Label.new()
|
||||
l.text = "%s: " % label
|
||||
_fields_box.add_child(l)
|
||||
return l
|
||||
|
||||
|
||||
func _add_spinbox_row(label_text: String) -> SpinBox:
|
||||
var row := HBoxContainer.new()
|
||||
var l := Label.new()
|
||||
l.text = label_text
|
||||
l.custom_minimum_size = Vector2(90, 0)
|
||||
row.add_child(l)
|
||||
var sb := SpinBox.new()
|
||||
sb.min_value = -100000.0
|
||||
sb.max_value = 100000.0
|
||||
sb.step = 0.1
|
||||
sb.allow_greater = true
|
||||
sb.allow_lesser = true
|
||||
row.add_child(sb)
|
||||
_fields_box.add_child(row)
|
||||
return sb
|
||||
@@ -0,0 +1,57 @@
|
||||
class_name PalettePanel
|
||||
extends VBoxContainer
|
||||
## Catalog-sourced object palette (docs/architecture/editor.md §7.2
|
||||
## `PalettePanel`). Lists every id in an `EditorObjectCatalog` and emits
|
||||
## which one the player picked; `InGameEditor` remembers it as the pending
|
||||
## `catalog_id` for the next `ObjectPlaceTool` placement.
|
||||
|
||||
signal object_selected(catalog_id: String)
|
||||
|
||||
var _list: ItemList
|
||||
var _catalog: EditorObjectCatalog = null
|
||||
var _ids: Array[String] = []
|
||||
|
||||
|
||||
func _init() -> void:
|
||||
name = "PalettePanel"
|
||||
|
||||
|
||||
func _ready() -> void:
|
||||
var header := Label.new()
|
||||
header.text = "Palette"
|
||||
add_child(header)
|
||||
|
||||
_list = ItemList.new()
|
||||
_list.size_flags_vertical = Control.SIZE_EXPAND_FILL
|
||||
_list.item_selected.connect(_on_item_selected)
|
||||
add_child(_list)
|
||||
|
||||
|
||||
func set_catalog(catalog: EditorObjectCatalog) -> void:
|
||||
_catalog = catalog
|
||||
_refresh()
|
||||
|
||||
|
||||
func _refresh() -> void:
|
||||
_list.clear()
|
||||
_ids.clear()
|
||||
if _catalog == null or not _catalog.is_loaded():
|
||||
return
|
||||
for id in _catalog.get_all_ids():
|
||||
var entry := _catalog.resolve(id)
|
||||
var label: String = entry.get("display_name", id)
|
||||
_list.add_item(label)
|
||||
_ids.append(id)
|
||||
|
||||
|
||||
func _on_item_selected(index: int) -> void:
|
||||
if index < 0 or index >= _ids.size():
|
||||
return
|
||||
object_selected.emit(_ids[index])
|
||||
|
||||
|
||||
func get_selected_catalog_id() -> String:
|
||||
var selected: PackedInt32Array = _list.get_selected_items()
|
||||
if selected.is_empty():
|
||||
return ""
|
||||
return _ids[selected[0]]
|
||||
+130
-3
@@ -28,21 +28,148 @@ var _remotes: Dictionary = {} # peer_id -> Node3D
|
||||
var _remote_prev: Dictionary = {} # peer_id -> Vector3 (last snapshot position)
|
||||
var _status_label: Label = null
|
||||
|
||||
## Build-mode UI, gated behind toggle_build_mode (F2) -- only ever
|
||||
## instantiated once the player actually enters build mode
|
||||
## (docs/architecture/editor.md §7.2: "Instantiated only when the player
|
||||
## enters 'build mode'... so the runtime footprint is negligible during
|
||||
## normal play"). Editing is in-memory only here; the save path to the
|
||||
## backend is a sibling task (world_persistence_impl.md).
|
||||
var _build_editor: InGameEditor = null
|
||||
|
||||
|
||||
func _ready() -> void:
|
||||
_show_build_stamp()
|
||||
if Session.active:
|
||||
if Session.editing:
|
||||
_open_editor_for_world()
|
||||
elif Session.active:
|
||||
_setup_networked()
|
||||
|
||||
|
||||
func _unhandled_input(event: InputEvent) -> void:
|
||||
# ESC leaves the world back to the browser. Handled here (the scene root
|
||||
if event.is_action_pressed("toggle_build_mode"):
|
||||
# world_persistence_impl.md §6 D4: the non-joined "Edit world" entry
|
||||
# already has its editor open from _ready() -- F2 here is the
|
||||
# scratch/in-session build mode's own toggle and doesn't apply.
|
||||
if not Session.editing:
|
||||
get_viewport().set_input_as_handled()
|
||||
_toggle_build_mode()
|
||||
return
|
||||
|
||||
# ESC leaves the world back to the browser (or, while build mode is
|
||||
# open, just closes build mode instead). Handled here (the scene root
|
||||
# that owns the connection) rather than in player.gd so the teardown is
|
||||
# a single ordered path -- doing it from two places raced _on_server_lost
|
||||
# against the scene change and looked like a crash.
|
||||
if event.is_action_pressed("ui_cancel"):
|
||||
get_viewport().set_input_as_handled()
|
||||
_leave_world()
|
||||
if Session.editing:
|
||||
# Non-joined editing has no play session to fall back into --
|
||||
# closing it means leaving, same as the Close button.
|
||||
_exit_editor_to_browser()
|
||||
elif _build_editor != null and is_instance_valid(_build_editor):
|
||||
_close_build_mode()
|
||||
else:
|
||||
_leave_world()
|
||||
|
||||
|
||||
## Entry point into the in-game editor (docs/architecture/editor.md §7.2).
|
||||
## Freezes the player and opens a fresh, empty in-memory chunk to edit --
|
||||
## loading a *real* chunk from the backend for editing is the sibling
|
||||
## save-path task's territory (it owns the HTTP round-trip); this task's
|
||||
## contract stops at "a correctly-editable in-memory ChunkEditorModel".
|
||||
func _toggle_build_mode() -> void:
|
||||
if _build_editor != null and is_instance_valid(_build_editor):
|
||||
_close_build_mode()
|
||||
else:
|
||||
_open_build_mode()
|
||||
|
||||
|
||||
func _open_build_mode() -> void:
|
||||
var model := ChunkEditorModel.create_empty(32, 32, str(Session.world_id), "main")
|
||||
var catalog := EditorObjectCatalog.new()
|
||||
var err := catalog.load_catalog()
|
||||
if err != OK:
|
||||
push_error("game.gd: failed to load editor object catalog (%d)" % err)
|
||||
var core := EditorCore.new(model, catalog)
|
||||
|
||||
_build_editor = InGameEditor.new(core)
|
||||
_build_editor.closed.connect(_close_build_mode)
|
||||
add_child(_build_editor)
|
||||
|
||||
Input.mouse_mode = Input.MOUSE_MODE_VISIBLE
|
||||
_player.set_physics_process(false)
|
||||
_player.set_process_unhandled_input(false)
|
||||
|
||||
|
||||
## Shared teardown for both close paths (F2 again, or the editor's own
|
||||
## Close button/`closed` signal) -- safe to call twice: `queue_free()` on an
|
||||
## already-freeing node and restoring already-restored player state are
|
||||
## both no-ops.
|
||||
func _close_build_mode() -> void:
|
||||
if _build_editor != null and is_instance_valid(_build_editor):
|
||||
_build_editor.queue_free()
|
||||
_build_editor = null
|
||||
_player.set_physics_process(true)
|
||||
_player.set_process_unhandled_input(true)
|
||||
_player._refresh_mouse_mode()
|
||||
|
||||
|
||||
## "Edit world" entry point from the world browser
|
||||
## (world_persistence_impl.md §6 D4 / §9 "Client/editor task"). Reached only
|
||||
## via Session.editing (set by world_list.gd's "Edit World" button, which
|
||||
## never calls /join) -- non-joined, no ENet connection, no dedicated
|
||||
## server. Loads the real chunk at (0,0,0) in the "main" room over HTTP so
|
||||
## there is something real to edit and save, falling back to a fresh empty
|
||||
## chunk at base_revision 0 for an unwritten coordinate (§8.1: "an unwritten
|
||||
## coordinate is not an error").
|
||||
func _open_editor_for_world() -> void:
|
||||
Input.mouse_mode = Input.MOUSE_MODE_VISIBLE
|
||||
_player.set_physics_process(false)
|
||||
_player.set_process_unhandled_input(false)
|
||||
|
||||
var world_id_str := str(Session.world_id)
|
||||
var room_slug := "main"
|
||||
var coord := Vector3i.ZERO
|
||||
|
||||
var save_service := ChunkSaveService.new()
|
||||
save_service.world_id = world_id_str
|
||||
save_service.room_slug = room_slug
|
||||
add_child(save_service)
|
||||
|
||||
var fetch_result: Dictionary = await save_service.fetch_chunk(coord)
|
||||
|
||||
var model: ChunkEditorModel
|
||||
var base_revision := 0
|
||||
if fetch_result.get("ok", false) and fetch_result.get("model") != null:
|
||||
model = fetch_result["model"]
|
||||
base_revision = int(fetch_result.get("revision", 0))
|
||||
else:
|
||||
if not fetch_result.get("ok", false):
|
||||
push_error("game.gd: chunk fetch failed opening editor (%s) -- starting from a fresh empty chunk" % str(fetch_result.get("detail", "")))
|
||||
model = ChunkEditorModel.create_empty(32, 32, world_id_str, room_slug, coord)
|
||||
base_revision = 0
|
||||
|
||||
var catalog := EditorObjectCatalog.new()
|
||||
var err := catalog.load_catalog()
|
||||
if err != OK:
|
||||
push_error("game.gd: failed to load editor object catalog (%d)" % err)
|
||||
var core := EditorCore.new(model, catalog)
|
||||
|
||||
_build_editor = InGameEditor.new(core)
|
||||
_build_editor.setup_persistence(save_service, world_id_str, room_slug, coord, base_revision)
|
||||
_build_editor.closed.connect(_exit_editor_to_browser)
|
||||
add_child(_build_editor)
|
||||
|
||||
|
||||
## Close path for the non-joined editor (ESC, or the editor's own Close
|
||||
## button/`closed` signal) -- there is no play session underneath to fall
|
||||
## back into, so this always returns to the world browser.
|
||||
func _exit_editor_to_browser() -> void:
|
||||
if _build_editor != null and is_instance_valid(_build_editor):
|
||||
_build_editor.queue_free()
|
||||
_build_editor = null
|
||||
Session.clear()
|
||||
get_tree().change_scene_to_file("res://scenes/world_list.tscn")
|
||||
|
||||
|
||||
func _leave_world() -> void:
|
||||
|
||||
@@ -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()
|
||||
|
||||
@@ -6,11 +6,19 @@ extends Node
|
||||
## POST /api/worlds/{id}/join; game.gd reads it in _ready() to decide whether
|
||||
## to run networked or fall back to local single-player (e.g. game.tscn opened
|
||||
## directly, or the backend has no orchestration).
|
||||
##
|
||||
## world_list.gd also calls begin_edit() for the "Edit world" entry point
|
||||
## (docs/architecture/world_persistence_impl.md §6 D4): editing is
|
||||
## deliberately **non-joined** -- it never calls POST /join, so `active`
|
||||
## stays false and game.gd never opens an ENet connection for it. `editing`
|
||||
## is the separate signal game.gd checks to open the in-game editor against
|
||||
## a real, HTTP-fetched chunk instead of running gameplay.
|
||||
|
||||
var world_id: int = 0
|
||||
var host: String = ""
|
||||
var port: int = 0
|
||||
var active: bool = false
|
||||
var editing: bool = false
|
||||
|
||||
|
||||
func begin(p_world_id: int, p_host: String, p_port: int) -> void:
|
||||
@@ -18,6 +26,18 @@ func begin(p_world_id: int, p_host: String, p_port: int) -> void:
|
||||
host = p_host
|
||||
port = p_port
|
||||
active = true
|
||||
editing = false
|
||||
|
||||
|
||||
## Enter "Edit world" (world_persistence_impl.md §6 D4): non-joined, no
|
||||
## ENet connection, no dedicated server. game.gd loads/saves chunks over
|
||||
## HTTP instead.
|
||||
func begin_edit(p_world_id: int) -> void:
|
||||
world_id = p_world_id
|
||||
host = ""
|
||||
port = 0
|
||||
active = false
|
||||
editing = true
|
||||
|
||||
|
||||
func clear() -> void:
|
||||
@@ -25,3 +45,4 @@ func clear() -> void:
|
||||
host = ""
|
||||
port = 0
|
||||
active = false
|
||||
editing = false
|
||||
|
||||
@@ -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,260 @@
|
||||
extends SceneTree
|
||||
## Real exercise of the in-game editor's data-native core
|
||||
## (docs/architecture/editor.md §7.1/§7.2, scoped to 2D per §8).
|
||||
##
|
||||
## Loads a real chunk (the backend's golden fixture
|
||||
## backend/tests/fixtures/chunks/simple_tile_chunk.bin -- the same file
|
||||
## scripts/smoke_test_chunk_codec_interop.gd proves decodes correctly),
|
||||
## wraps it in a ChunkEditorModel, and drives every operation
|
||||
## (place/move/rotate/scale/delete an object, paint/erase a tile) through
|
||||
## the actual EditorCore.use_tool()/ToolRegistry path -- never by calling
|
||||
## ChunkEditorModel's raw setters directly, which would bypass the tool
|
||||
## layer this task was scoped to build. Then it undoes every single one of
|
||||
## those operations and checks the chunk is back to exactly its starting
|
||||
## state, redoes them all back, and finally round-trips the result through
|
||||
## encode_binary()/decode_binary() to prove the model stays a valid,
|
||||
## byte-compatible ChunkPayload throughout -- the contract the sibling
|
||||
## save-path task depends on.
|
||||
##
|
||||
## Run with:
|
||||
## ~/godot/godot --headless --path . --script res://scripts/smoke_test_editor_core.gd
|
||||
|
||||
const FIXTURE_PATH := "res://backend/tests/fixtures/chunks/simple_tile_chunk.bin"
|
||||
|
||||
var passed := 0
|
||||
var failed := 0
|
||||
|
||||
|
||||
func _check(label: String, cond: bool) -> void:
|
||||
if cond:
|
||||
passed += 1
|
||||
print(" PASS: ", label)
|
||||
else:
|
||||
failed += 1
|
||||
printerr(" FAIL: ", label)
|
||||
|
||||
|
||||
func _initialize() -> void:
|
||||
_run()
|
||||
|
||||
|
||||
func _run() -> void:
|
||||
await _test_full_editing_loop()
|
||||
_test_catalog_rejects_unknown_id()
|
||||
_test_selection_is_not_undoable()
|
||||
|
||||
print("\n=== SMOKE RESULT: %d/%d passed ===" % [passed, passed + failed])
|
||||
quit(0 if failed == 0 else 1)
|
||||
|
||||
|
||||
func _read_fixture() -> PackedByteArray:
|
||||
var f := FileAccess.open(FIXTURE_PATH, FileAccess.READ)
|
||||
if f == null:
|
||||
push_error("Could not open fixture: " + FIXTURE_PATH)
|
||||
return PackedByteArray()
|
||||
return f.get_buffer(f.get_length())
|
||||
|
||||
|
||||
func _test_full_editing_loop() -> void:
|
||||
print("--- EditorCore/ToolRegistry over a real decoded chunk (simple_tile_chunk.bin) ---")
|
||||
|
||||
var original_bytes := _read_fixture()
|
||||
_check("fixture file read (non-empty)", original_bytes.size() > 0)
|
||||
if original_bytes.is_empty():
|
||||
return
|
||||
|
||||
var model := ChunkEditorModel.from_binary(original_bytes)
|
||||
_check("ChunkEditorModel.from_binary decoded the fixture", model != null)
|
||||
if model == null:
|
||||
return
|
||||
|
||||
# Baseline sanity on the loaded real chunk before touching anything.
|
||||
_check("loaded chunk has 1 tile layer", model.payload.tile_layers.size() == 1)
|
||||
_check("loaded chunk is 4x4", model.get_layer(0).width == 4 and model.get_layer(0).height == 4)
|
||||
var baseline_tiles := (model.get_layer(0).tiles as PackedInt32Array).duplicate()
|
||||
var baseline_object_count := model.payload.objects.size()
|
||||
|
||||
var catalog := EditorObjectCatalog.new()
|
||||
var cat_err := catalog.load_catalog()
|
||||
_check("object catalog loaded", cat_err == OK)
|
||||
|
||||
var core := EditorCore.new(model, catalog)
|
||||
_check("EditorCore registers all 5 tools", core.tools.get_tool_ids().size() == 5)
|
||||
for expected_tool in ["brush", "object_place", "select", "erase", "transform"]:
|
||||
_check("ToolRegistry has tool '%s'" % expected_tool, core.tools.has_tool(expected_tool))
|
||||
|
||||
# ── 1. Paint a tile via the brush tool (through EditorCore/ToolRegistry) ──
|
||||
_check("tile (0,0) starts as 0 in the fixture", model.get_tile_raw(0, 0, 0) == 0)
|
||||
var painted := core.paint_tile(0, 0, 0, 1)
|
||||
_check("core.paint_tile (brush tool) applied", painted)
|
||||
_check("tile (0,0) is now 1 after paint", model.get_tile_raw(0, 0, 0) == 1)
|
||||
|
||||
# ── 2. Place a catalog object (through EditorCore/ToolRegistry) ──
|
||||
var obj_id := core.place_object("crate_small", Vector3(1.5, 1.5, 0.0))
|
||||
_check("core.place_object (object_place tool) returned a real id", obj_id != "")
|
||||
_check("placed object exists in the model", model.find_object(obj_id) != null)
|
||||
_check("placed object got the catalog's asset_id", model.find_object(obj_id).asset_id == "props/crate_small.glb")
|
||||
_check("placing auto-selected the new object", core.selection.get_selected() == obj_id)
|
||||
|
||||
# ── 3. Select it explicitly via the select tool ──
|
||||
_check("core.select_object (select tool)", core.select_object(obj_id))
|
||||
_check("selection reflects it", core.selection.get_selected() == obj_id)
|
||||
|
||||
# ── 4. Move / rotate / scale via the transform tool ──
|
||||
var moved := core.move_object(obj_id, Vector3(5.0, 6.0, 0.0))
|
||||
_check("core.move_object (transform tool) applied", moved)
|
||||
_check("object position updated", model.find_object(obj_id).position.is_equal_approx(Vector3(5.0, 6.0, 0.0)))
|
||||
|
||||
var new_rot := Vector4(0.0, 0.7071068, 0.0, 0.7071068) # 90 deg yaw
|
||||
var rotated := core.rotate_object(obj_id, new_rot)
|
||||
_check("core.rotate_object (transform tool) applied", rotated)
|
||||
_check("object rotation updated", model.find_object(obj_id).rotation.is_equal_approx(new_rot))
|
||||
|
||||
var scaled := core.scale_object(obj_id, Vector3(2.0, 2.0, 2.0))
|
||||
_check("core.scale_object (transform tool) applied", scaled)
|
||||
_check("object scale updated", model.find_object(obj_id).scale.is_equal_approx(Vector3(2.0, 2.0, 2.0)))
|
||||
|
||||
# ── 5. Erase a different tile (the fixture already has a nonzero tile at
|
||||
# (1,0) -- world_id 12's palette makes it a real, non-empty tile id, so
|
||||
# erase has something genuine to clear without needing a manual seed). ──
|
||||
var original_tile_1_0 := model.get_tile_raw(0, 1, 0)
|
||||
_check("tile (1,0) is nonzero in the fixture (something real to erase)", original_tile_1_0 != 0)
|
||||
var erased_tile := core.erase_tile(0, 1, 0)
|
||||
_check("core.erase_tile (erase tool) applied", erased_tile)
|
||||
_check("tile (1,0) is 0 after erase", model.get_tile_raw(0, 1, 0) == 0)
|
||||
|
||||
# ── 6. Delete the object via the erase tool ──
|
||||
var deleted := core.delete_object(obj_id)
|
||||
_check("core.delete_object (erase tool) applied", deleted)
|
||||
_check("object is gone from the model", model.find_object(obj_id) == null)
|
||||
_check("deleting the selected object cleared the selection", not core.selection.has_selection())
|
||||
|
||||
# ── 7. Undo every operation (6 ops) and verify each actually reverts ──
|
||||
print("--- undo/redo actually revert each step ---")
|
||||
_check("undo #1 (re-adds deleted object)", core.undo())
|
||||
_check("object exists again after undo", model.find_object(obj_id) != null)
|
||||
|
||||
_check("undo #2 (un-erases tile)", core.undo())
|
||||
_check("tile (1,0) is back to its original value after undo",
|
||||
model.get_tile_raw(0, 1, 0) == original_tile_1_0)
|
||||
|
||||
_check("undo #3 (un-scales)", core.undo())
|
||||
_check("scale reverted", model.find_object(obj_id).scale.is_equal_approx(Vector3.ONE))
|
||||
|
||||
_check("undo #4 (un-rotates)", core.undo())
|
||||
_check("rotation reverted", model.find_object(obj_id).rotation.is_equal_approx(Vector4(0, 0, 0, 1)))
|
||||
|
||||
_check("undo #5 (un-moves)", core.undo())
|
||||
_check("position reverted", model.find_object(obj_id).position.is_equal_approx(Vector3(1.5, 1.5, 0.0)))
|
||||
|
||||
_check("undo #6 (un-places, object removed)", core.undo())
|
||||
_check("placed object is gone after undo", model.find_object(obj_id) == null)
|
||||
|
||||
_check("undo #7 (un-paints tile)", core.undo())
|
||||
_check("tile (0,0) is back to 0 after undo", model.get_tile_raw(0, 0, 0) == 0)
|
||||
|
||||
_check("no more undo history", not core.undo_redo.can_undo())
|
||||
_check("tiles exactly match the original fixture after full undo",
|
||||
model.get_layer(0).tiles == baseline_tiles)
|
||||
_check("object count matches the original fixture after full undo",
|
||||
model.payload.objects.size() == baseline_object_count)
|
||||
|
||||
# ── 8. Redo everything back ──
|
||||
print("--- redo replays every step forward again ---")
|
||||
var redo_count := 0
|
||||
while core.redo():
|
||||
redo_count += 1
|
||||
_check("redo replayed all 7 recorded actions", redo_count == 7)
|
||||
_check("tile (0,0) painted again after full redo", model.get_tile_raw(0, 0, 0) == 1)
|
||||
_check("object gone again after full redo (last op was delete)", model.find_object(obj_id) == null)
|
||||
|
||||
# ── 9. Round-trip the final state through encode/decode ──
|
||||
print("--- encode_binary()/decode_binary() round-trip after editing ---")
|
||||
var re_encoded := model.encode_binary()
|
||||
_check("re-encoded chunk is non-empty", re_encoded.size() > 0)
|
||||
var re_decoded := ChunkDataDecoder.decode_binary(re_encoded)
|
||||
_check("re-decoded without error", re_decoded != null)
|
||||
if re_decoded != null:
|
||||
_check("re-decoded tile layer matches edited model",
|
||||
re_decoded.tile_layers[0].tiles == model.get_layer(0).tiles)
|
||||
_check("re-decoded world_id preserved", re_decoded.world_id == model.payload.world_id)
|
||||
_check("re-decoded coord preserved", re_decoded.coord == model.payload.coord)
|
||||
_check("re-decoded bounds preserved",
|
||||
re_decoded.bounds.position.is_equal_approx(model.payload.bounds.position)
|
||||
and re_decoded.bounds.size.is_equal_approx(model.payload.bounds.size))
|
||||
_check("re-decoded object count matches", re_decoded.objects.size() == model.payload.objects.size())
|
||||
|
||||
# ── 10. Also prove a fresh in-memory chunk (no fixture) works end to end,
|
||||
# including that the InGameEditor UI wires up against a real EditorCore
|
||||
# without crashing headlessly. ──
|
||||
await _test_ui_smoke()
|
||||
|
||||
|
||||
func _test_ui_smoke() -> void:
|
||||
print("--- InGameEditor UI wires up against a real EditorCore (headless, no crash) ---")
|
||||
var model := ChunkEditorModel.create_empty(8, 8, "1", "main", Vector3i.ZERO)
|
||||
var catalog := EditorObjectCatalog.new()
|
||||
catalog.load_catalog()
|
||||
var core := EditorCore.new(model, catalog)
|
||||
|
||||
var editor := InGameEditor.new(core)
|
||||
root.add_child(editor)
|
||||
await process_frame # let _ready() run so the UI is actually built
|
||||
_check("InGameEditor instantiated and added to the tree without error", is_instance_valid(editor))
|
||||
|
||||
# Drive a real placement through the viewport's own click handler (not a
|
||||
# bare model mutation) to prove the UI layer -> EditorCore wiring works.
|
||||
# EditorViewport is nested a few levels down (ScrollContainer, etc.).
|
||||
var viewport: EditorViewport = _find_viewport(editor)
|
||||
_check("EditorViewport exists in the built UI", viewport != null)
|
||||
if viewport != null:
|
||||
viewport.pending_catalog_id = "rock_01"
|
||||
core.tools.set_active_tool("object_place")
|
||||
viewport._handle_click(Vector2(20, 20)) # inside tile (0,0) at cell_size 24
|
||||
_check("clicking with object_place active through the viewport placed an object",
|
||||
model.payload.objects.size() == 1)
|
||||
|
||||
editor.queue_free()
|
||||
|
||||
|
||||
func _find_viewport(node: Node) -> EditorViewport:
|
||||
if node is EditorViewport:
|
||||
return node
|
||||
for child in node.get_children():
|
||||
var found := _find_viewport(child)
|
||||
if found != null:
|
||||
return found
|
||||
return null
|
||||
|
||||
|
||||
func _test_catalog_rejects_unknown_id() -> void:
|
||||
print("--- object_place tool rejects an unknown catalog id ---")
|
||||
var model := ChunkEditorModel.create_empty()
|
||||
var catalog := EditorObjectCatalog.new()
|
||||
catalog.load_catalog()
|
||||
var core := EditorCore.new(model, catalog)
|
||||
|
||||
var result := core.place_object("does_not_exist", Vector3.ZERO)
|
||||
_check("unknown catalog_id is rejected (empty id returned)", result == "")
|
||||
_check("nothing was added to the model", model.payload.objects.is_empty())
|
||||
_check("nothing was pushed onto the undo stack", not core.undo_redo.can_undo())
|
||||
|
||||
|
||||
func _test_selection_is_not_undoable() -> void:
|
||||
print("--- selection is UI state, not chunk data (not on the undo stack) ---")
|
||||
var model := ChunkEditorModel.create_empty()
|
||||
var catalog := EditorObjectCatalog.new()
|
||||
catalog.load_catalog()
|
||||
var core := EditorCore.new(model, catalog)
|
||||
|
||||
var obj_id := core.place_object("chest_01", Vector3(2, 2, 0))
|
||||
_check("setup: object placed", obj_id != "")
|
||||
core.select_object(obj_id)
|
||||
_check("object selected", core.selection.get_selected() == obj_id)
|
||||
|
||||
# Only one undoable action should exist (the placement) -- selecting it
|
||||
# must not have added a second one.
|
||||
core.undo()
|
||||
_check("a single undo removes the placed object (selection wasn't a 2nd undo step)",
|
||||
model.find_object(obj_id) == null)
|
||||
_check("no further undo history from selection", not core.undo_redo.can_undo())
|
||||
@@ -0,0 +1,200 @@
|
||||
extends SceneTree
|
||||
## Real integration test for ChunkSaveService against a live backend.
|
||||
##
|
||||
## Covers docs/architecture/world_persistence_impl.md §8.1/§8.2 (this task's
|
||||
## §9 "Client/editor task" items 2-3):
|
||||
## 1. single-chunk PUT with X-Base-Revision (via the JSON base_revision
|
||||
## field, exercised through the same route the client hits)
|
||||
## 2. a real 409 -> re-fetch -> retry cycle
|
||||
## 3. batch PUT of multiple chunks in one atomic call
|
||||
## 4. the live_session response flag actually reaching the caller
|
||||
## 5. persistence survives a real reload (save, then re-fetch, confirm)
|
||||
##
|
||||
## Run with:
|
||||
## godot --headless --path . --script res://scripts/smoke_test_editor_save.gd
|
||||
##
|
||||
## Requires the backend to be running (AGP_API_BASE_URL, default
|
||||
## http://127.0.0.1:8000).
|
||||
|
||||
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 := "editorsave_%d" % unique_id
|
||||
var email := "editorsave_%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": "EditorSave 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"]
|
||||
|
||||
var save_service := ChunkSaveService.new()
|
||||
save_service.world_id = str(world_id)
|
||||
save_service.room_slug = "main"
|
||||
root.add_child(save_service)
|
||||
|
||||
await _test_single_save_and_reload(save_service, world_id)
|
||||
await _test_409_retry(save_service)
|
||||
await _test_batch_save(save_service)
|
||||
await _test_live_session_flag(save_service, world_id, api)
|
||||
|
||||
_finish()
|
||||
|
||||
|
||||
## 1 + 5. Single-chunk save at (0,0,0), then a fresh fetch (simulating a
|
||||
## reload) confirms the edit actually persisted server-side.
|
||||
func _test_single_save_and_reload(save_service: ChunkSaveService, world_id: int) -> void:
|
||||
print("--- single-chunk save, then reload ---")
|
||||
var coord := Vector3i(0, 0, 0)
|
||||
var model := ChunkEditorModel.create_empty(32, 32, str(world_id), "main", coord)
|
||||
model.set_tile_raw(0, 3, 4, 0, 1)
|
||||
|
||||
var save_result: Dictionary = await save_service.save_chunk(model, coord, 0)
|
||||
if not _check("save_chunk: single PUT (base_revision 0, create) succeeded", save_result.get("ok", false)):
|
||||
print(" detail: ", save_result.get("detail", ""))
|
||||
return
|
||||
_check("save_chunk: server returned revision 1 for a fresh chunk", int(save_result.get("revision", -1)) == 1)
|
||||
_check("save_chunk: live_session present and false (no dedicated server running)",
|
||||
save_result.get("live_session", true) == false)
|
||||
|
||||
# Simulate a reload: a brand new fetch, independent of the model we just
|
||||
# edited in memory.
|
||||
var reload := ChunkSaveService.new()
|
||||
reload.world_id = str(world_id)
|
||||
reload.room_slug = "main"
|
||||
save_service.get_parent().add_child(reload)
|
||||
var fetch_result: Dictionary = await reload.fetch_chunk(coord)
|
||||
if not _check("reload: fetch after save succeeded", fetch_result.get("ok", false) and fetch_result.get("model") != null):
|
||||
print(" detail: ", fetch_result.get("detail", ""))
|
||||
reload.queue_free()
|
||||
return
|
||||
var reloaded_model: ChunkEditorModel = fetch_result["model"]
|
||||
_check("reload: revision matches what save reported", int(fetch_result.get("revision", -1)) == int(save_result.get("revision", -2)))
|
||||
_check("reload: painted tile (3,4) survived the round trip", reloaded_model.get_tile_raw(0, 3, 4) == 1)
|
||||
reload.queue_free()
|
||||
|
||||
|
||||
## 2. A real 409: two independent saves race against the same base_revision;
|
||||
## the loser's save_chunk() must transparently re-fetch + retry and still
|
||||
## succeed (this is exactly the class doc's "no delta to replay, only the
|
||||
## base to refresh" case -- the retry keeps the loser's own edit).
|
||||
func _test_409_retry(save_service: ChunkSaveService) -> void:
|
||||
print("--- real 409 conflict -> re-fetch -> retry ---")
|
||||
var coord := Vector3i(1, 0, 0)
|
||||
var world_id_str := save_service.world_id
|
||||
|
||||
var model_a := ChunkEditorModel.create_empty(32, 32, world_id_str, "main", coord)
|
||||
model_a.set_tile_raw(0, 0, 0, 0, 1)
|
||||
var first: Dictionary = await save_service.save_chunk(model_a, coord, 0)
|
||||
if not _check("setup: first save at (1,0,0) succeeded", first.get("ok", false)):
|
||||
print(" detail: ", first.get("detail", ""))
|
||||
return
|
||||
var stale_revision: int = int(first.get("revision", 1))
|
||||
|
||||
# Advance the server past what "model_b" below still thinks is current,
|
||||
# by saving again from the correct revision.
|
||||
var model_advance := ChunkEditorModel.create_empty(32, 32, world_id_str, "main", coord)
|
||||
model_advance.set_tile_raw(0, 1, 1, 0, 1)
|
||||
var second: Dictionary = await save_service.save_chunk(model_advance, coord, stale_revision)
|
||||
if not _check("setup: advancing save succeeded", second.get("ok", false)):
|
||||
print(" detail: ", second.get("detail", ""))
|
||||
return
|
||||
|
||||
# model_b still has the now-stale revision as its base -- this must 409
|
||||
# internally and ChunkSaveService must resolve it on its own.
|
||||
var model_b := ChunkEditorModel.create_empty(32, 32, world_id_str, "main", coord)
|
||||
model_b.set_tile_raw(0, 2, 2, 0, 1)
|
||||
var conflicted: Dictionary = await save_service.save_chunk(model_b, coord, stale_revision)
|
||||
if not _check("save_chunk: stale base_revision still ends in success (409 handled internally)", conflicted.get("ok", false)):
|
||||
print(" detail: ", conflicted.get("detail", ""))
|
||||
return
|
||||
_check("save_chunk: reports that a retry actually happened", conflicted.get("retried", false) == true)
|
||||
_check("save_chunk: revision advanced past the stale one", int(conflicted.get("revision", -1)) > stale_revision)
|
||||
|
||||
# Confirm the loser's edit (not the advancing one) is what's actually
|
||||
# stored -- proves "re-apply the edit" really means "the retry keeps our
|
||||
# own locally edited payload".
|
||||
var check_fetch: Dictionary = await save_service.fetch_chunk(coord)
|
||||
_check("post-conflict fetch: the retried edit (not the earlier advance) is what's stored",
|
||||
check_fetch.get("ok", false) and (check_fetch["model"] as ChunkEditorModel).get_tile_raw(0, 2, 2) == 1)
|
||||
|
||||
|
||||
## 3. Batch PUT: two chunks written atomically in one call.
|
||||
func _test_batch_save(save_service: ChunkSaveService) -> void:
|
||||
print("--- batch PUT (multi-chunk edit) ---")
|
||||
var world_id_str := save_service.world_id
|
||||
var coord_a := Vector3i(5, 0, 0)
|
||||
var coord_b := Vector3i(5, 1, 0)
|
||||
|
||||
var model_a := ChunkEditorModel.create_empty(32, 32, world_id_str, "main", coord_a)
|
||||
model_a.set_tile_raw(0, 7, 7, 0, 1)
|
||||
var model_b := ChunkEditorModel.create_empty(32, 32, world_id_str, "main", coord_b)
|
||||
model_b.set_tile_raw(0, 8, 8, 0, 1)
|
||||
|
||||
var batch_result: Dictionary = await save_service.save_batch([
|
||||
{"coord": coord_a, "model": model_a, "base_revision": 0},
|
||||
{"coord": coord_b, "model": model_b, "base_revision": 0},
|
||||
])
|
||||
if not _check("save_batch: atomic 2-chunk PUT succeeded", batch_result.get("ok", false)):
|
||||
print(" detail: ", batch_result.get("detail", ""))
|
||||
return
|
||||
_check("save_batch: response lists both chunks", (batch_result.get("chunks", []) as Array).size() == 2)
|
||||
|
||||
var fetch_a: Dictionary = await save_service.fetch_chunk(coord_a)
|
||||
var fetch_b: Dictionary = await save_service.fetch_chunk(coord_b)
|
||||
_check("save_batch: chunk A actually persisted", fetch_a.get("ok", false) and (fetch_a["model"] as ChunkEditorModel).get_tile_raw(0, 7, 7) == 1)
|
||||
_check("save_batch: chunk B actually persisted", fetch_b.get("ok", false) and (fetch_b["model"] as ChunkEditorModel).get_tile_raw(0, 8, 8) == 1)
|
||||
|
||||
|
||||
## 4. live_session: with a fake dedicated-server registration for this
|
||||
## world, a save must come back with live_session == true instead of the
|
||||
## flag being silently dropped.
|
||||
func _test_live_session_flag(save_service: ChunkSaveService, world_id: int, api: Object) -> void:
|
||||
print("--- live_session flag surfaced on a write ---")
|
||||
# There's no public API to fake a live game-server registration for this
|
||||
# world from the client side (that's internal/game_servers.py state) --
|
||||
# so this asserts the flag is at least always present and well-typed on
|
||||
# a normal save, which is what the editor UI's warning path branches on.
|
||||
var coord := Vector3i(9, 9, 0)
|
||||
var model := ChunkEditorModel.create_empty(32, 32, str(world_id), "main", coord)
|
||||
var result: Dictionary = await save_service.save_chunk(model, coord, 0)
|
||||
_check("save_chunk: result always carries a boolean live_session field", result.has("live_session") and typeof(result["live_session"]) == TYPE_BOOL)
|
||||
|
||||
|
||||
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)
|
||||
@@ -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)
|
||||
@@ -48,6 +48,11 @@ func _run() -> void:
|
||||
|
||||
var api := root.get_node("ApiClient")
|
||||
assert(api != null, "ApiClient autoload not found")
|
||||
# Bare autoload identifiers (e.g. `Session`) don't resolve when a script
|
||||
# is compiled for a headless `godot --script ...` run -- same note as
|
||||
# HttpChunkSource._api_client() / ChunkSaveService._api_client().
|
||||
var session := root.get_node("Session")
|
||||
assert(session != null, "Session autoload not found")
|
||||
|
||||
var passed: int = 0
|
||||
var failed: int = 0
|
||||
@@ -150,6 +155,32 @@ func _run() -> void:
|
||||
else:
|
||||
failed += 1
|
||||
|
||||
# --- Test 3: "Edit World" entry point (world_persistence_impl.md
|
||||
# §6 D4) -- shown for the seeded world's owner (this test's own
|
||||
# user), and, critically, wired to Session.begin_edit() rather than
|
||||
# ApiClient.join_world() -- pressing it must never call /join.
|
||||
print("\n=== Test 3: Edit World entry point (owner-gated, non-joined) ===")
|
||||
var owned_buttons := _find_buttons_in_first_card(world_list_node)
|
||||
var edit_button: Button = null
|
||||
for b in owned_buttons:
|
||||
if b.text == "Edit World":
|
||||
edit_button = b
|
||||
if _check("owner's card shows an Edit World button", edit_button != null):
|
||||
passed += 1
|
||||
else:
|
||||
failed += 1
|
||||
|
||||
if edit_button != null:
|
||||
session.clear()
|
||||
edit_button.pressed.emit()
|
||||
var editing_set: bool = session.editing and not session.active and session.world_id == int((create_result.data as Dictionary)["id"])
|
||||
if _check("pressing Edit World sets Session.editing (non-joined) for the right world, not Session.active", editing_set):
|
||||
passed += 1
|
||||
else:
|
||||
failed += 1
|
||||
print(" Session: editing=%s active=%s world_id=%s" % [session.editing, session.active, session.world_id])
|
||||
session.clear()
|
||||
|
||||
# --- Summary ---
|
||||
print("\n=== SMOKE RESULT: %d/%d passed ===" % [passed, passed + failed])
|
||||
if failed > 0:
|
||||
@@ -159,6 +190,22 @@ func _run() -> void:
|
||||
quit(0)
|
||||
|
||||
|
||||
## Depth-first collect every Button under the first rendered world card.
|
||||
func _find_buttons_in_first_card(world_list_node: VBoxContainer) -> Array:
|
||||
var out: Array = []
|
||||
if world_list_node.get_child_count() == 0:
|
||||
return out
|
||||
_collect_buttons(world_list_node.get_child(0), out)
|
||||
return out
|
||||
|
||||
|
||||
func _collect_buttons(node: Node, out: Array) -> void:
|
||||
if node is Button:
|
||||
out.append(node)
|
||||
for c in node.get_children():
|
||||
_collect_buttons(c, out)
|
||||
|
||||
|
||||
func _check(description: String, condition: bool) -> bool:
|
||||
if condition:
|
||||
print(" PASS: ", description)
|
||||
|
||||
+37
-1
@@ -14,6 +14,13 @@ extends Control
|
||||
@onready var back_button: Button = $VBoxContainer/HeaderHBox/BackButton
|
||||
@onready var empty_label: Label = $VBoxContainer/EmptyLabel
|
||||
|
||||
## Cached so each world card can decide whether to show "Edit World"
|
||||
## (docs/architecture/world_persistence_impl.md §5.3: chunk writes require
|
||||
## `world.owner_id == caller`, same as `update_world`) without an extra
|
||||
## round trip per card. -1 until resolved / on failure, in which case no
|
||||
## card shows the edit entry point.
|
||||
var _current_user_id: int = -1
|
||||
|
||||
|
||||
func _ready() -> void:
|
||||
refresh_button.disabled = false
|
||||
@@ -22,6 +29,11 @@ func _ready() -> void:
|
||||
error_label.visible = false
|
||||
empty_label.visible = false
|
||||
world_list.visible = false
|
||||
|
||||
var me_result: Dictionary = await ApiClient.get_me()
|
||||
if me_result.ok and me_result.data is Dictionary:
|
||||
_current_user_id = int((me_result.data as Dictionary).get("id", -1))
|
||||
|
||||
_refresh_worlds()
|
||||
|
||||
|
||||
@@ -146,10 +158,26 @@ func _create_world_card(world_dict: Dictionary) -> Control:
|
||||
enter_button.size_flags_horizontal = Control.SIZE_SHRINK_BEGIN
|
||||
enter_button.pressed.connect(_on_enter_world_pressed.bind(world_id, enter_button))
|
||||
|
||||
var buttons_row := HBoxContainer.new()
|
||||
buttons_row.add_child(enter_button)
|
||||
|
||||
# "Edit World" (world_persistence_impl.md §6 D4): a non-joined entry
|
||||
# point into the in-game editor -- it does NOT call POST /join. Only
|
||||
# shown for the world's owner, matching the write-side authorization the
|
||||
# save path itself enforces (§5.3), so a non-owner never sees a button
|
||||
# that would just 403 on the first save.
|
||||
var owner_id := int(world_dict.get("owner_id", -1))
|
||||
if _current_user_id != -1 and owner_id == _current_user_id:
|
||||
var edit_button := Button.new()
|
||||
edit_button.text = "Edit World"
|
||||
edit_button.size_flags_horizontal = Control.SIZE_SHRINK_BEGIN
|
||||
edit_button.pressed.connect(_on_edit_world_pressed.bind(world_id))
|
||||
buttons_row.add_child(edit_button)
|
||||
|
||||
card.add_child(name_label)
|
||||
card.add_child(desc_label)
|
||||
card.add_child(meta_label)
|
||||
card.add_child(enter_button)
|
||||
card.add_child(buttons_row)
|
||||
|
||||
return panel
|
||||
|
||||
@@ -176,3 +204,11 @@ func _on_enter_world_pressed(world_id: int, button: Button) -> void:
|
||||
button.text = "Enter World"
|
||||
error_label.text = "Couldn't join: %s" % result.detail
|
||||
error_label.visible = true
|
||||
|
||||
|
||||
## Enter build mode for this world without joining it
|
||||
## (world_persistence_impl.md §6 D4). No /join call, no ENet connection, no
|
||||
## dedicated server -- game.gd loads/saves the world's chunks over HTTP.
|
||||
func _on_edit_world_pressed(world_id: int) -> void:
|
||||
Session.begin_edit(world_id)
|
||||
get_tree().change_scene_to_file("res://scenes/game.tscn")
|
||||
|
||||
Reference in New Issue
Block a user