Merge pull request 'feat/chat-history-upgrade' (#2) from feat/chat-history-upgrade into dev
Reviewed-on: #2
This commit was merged in pull request #2.
This commit is contained in:
@@ -164,6 +164,11 @@ def register_blueprints(app: Flask) -> None:
|
||||
app.register_blueprint(npcs_bp)
|
||||
logger.info("NPCs API blueprint registered")
|
||||
|
||||
# Import and register Chat API blueprint
|
||||
from app.api.chat import chat_bp
|
||||
app.register_blueprint(chat_bp)
|
||||
logger.info("Chat API blueprint registered")
|
||||
|
||||
# TODO: Register additional blueprints as they are created
|
||||
# from app.api import combat, marketplace, shop
|
||||
# app.register_blueprint(combat.bp, url_prefix='/api/v1/combat')
|
||||
|
||||
320
api/app/api/chat.py
Normal file
320
api/app/api/chat.py
Normal file
@@ -0,0 +1,320 @@
|
||||
"""
|
||||
Chat API Endpoints.
|
||||
|
||||
Provides REST API for accessing player-NPC conversation history,
|
||||
searching messages, and managing chat data.
|
||||
"""
|
||||
|
||||
from flask import Blueprint, request
|
||||
from datetime import datetime, timezone
|
||||
|
||||
from app.utils.auth import require_auth, get_current_user
|
||||
from app.services.chat_message_service import (
|
||||
get_chat_message_service,
|
||||
ChatMessageNotFound,
|
||||
ChatMessagePermissionDenied
|
||||
)
|
||||
from app.services.npc_loader import get_npc_loader
|
||||
from app.models.chat_message import MessageContext
|
||||
from app.utils.response import (
|
||||
success_response,
|
||||
error_response,
|
||||
not_found_response,
|
||||
validation_error_response
|
||||
)
|
||||
from app.utils.logging import get_logger
|
||||
|
||||
logger = get_logger(__file__)
|
||||
|
||||
chat_bp = Blueprint('chat', __name__)
|
||||
|
||||
|
||||
@chat_bp.route('/api/v1/characters/<character_id>/chats', methods=['GET'])
|
||||
@require_auth
|
||||
def get_conversations_summary(character_id: str):
|
||||
"""
|
||||
Get summary of all NPC conversations for a character.
|
||||
|
||||
Returns list of NPCs the character has talked to, with message counts,
|
||||
last message timestamp, and preview of most recent exchange.
|
||||
|
||||
Path params:
|
||||
character_id: Character ID
|
||||
|
||||
Query params:
|
||||
None
|
||||
|
||||
Returns:
|
||||
JSON response with list of conversation summaries
|
||||
"""
|
||||
try:
|
||||
user = get_current_user()
|
||||
|
||||
# Get conversation summaries
|
||||
chat_service = get_chat_message_service()
|
||||
summaries = chat_service.get_all_conversations_summary(character_id, user.id)
|
||||
|
||||
# Convert to dict for JSON response
|
||||
conversations = [summary.to_dict() for summary in summaries]
|
||||
|
||||
logger.info("Retrieved conversation summaries",
|
||||
user_id=user.id,
|
||||
character_id=character_id,
|
||||
count=len(conversations))
|
||||
|
||||
return success_response({"conversations": conversations})
|
||||
|
||||
except ChatMessagePermissionDenied as e:
|
||||
logger.warning("Permission denied getting conversations",
|
||||
user_id=user.id if 'user' in locals() else None,
|
||||
character_id=character_id)
|
||||
return error_response(str(e), 403)
|
||||
except Exception as e:
|
||||
logger.error("Failed to get conversations summary",
|
||||
character_id=character_id,
|
||||
error=str(e))
|
||||
return error_response(f"Failed to retrieve conversations: {str(e)}", 500)
|
||||
|
||||
|
||||
@chat_bp.route('/api/v1/characters/<character_id>/chats/<npc_id>', methods=['GET'])
|
||||
@require_auth
|
||||
def get_conversation_history(character_id: str, npc_id: str):
|
||||
"""
|
||||
Get full conversation history between character and specific NPC.
|
||||
|
||||
Returns paginated list of messages ordered by timestamp DESC (most recent first).
|
||||
|
||||
Path params:
|
||||
character_id: Character ID
|
||||
npc_id: NPC ID
|
||||
|
||||
Query params:
|
||||
limit: Maximum messages to return (default 50, max 100)
|
||||
offset: Number of messages to skip (default 0)
|
||||
|
||||
Returns:
|
||||
JSON response with messages and pagination info
|
||||
"""
|
||||
try:
|
||||
user = get_current_user()
|
||||
|
||||
# Get query parameters
|
||||
limit = request.args.get('limit', 50, type=int)
|
||||
offset = request.args.get('offset', 0, type=int)
|
||||
|
||||
# Validate parameters
|
||||
if limit < 1:
|
||||
return validation_error_response("limit must be at least 1")
|
||||
if offset < 0:
|
||||
return validation_error_response("offset must be at least 0")
|
||||
|
||||
# Get conversation history
|
||||
chat_service = get_chat_message_service()
|
||||
messages = chat_service.get_conversation_history(
|
||||
character_id=character_id,
|
||||
user_id=user.id,
|
||||
npc_id=npc_id,
|
||||
limit=limit,
|
||||
offset=offset
|
||||
)
|
||||
|
||||
# Get NPC name if available
|
||||
npc_loader = get_npc_loader()
|
||||
npc = npc_loader.load_npc(npc_id)
|
||||
npc_name = npc.name if npc else npc_id.replace('_', ' ').title()
|
||||
|
||||
# Convert messages to dict
|
||||
message_dicts = [msg.to_dict() for msg in messages]
|
||||
|
||||
result = {
|
||||
"npc_id": npc_id,
|
||||
"npc_name": npc_name,
|
||||
"total_messages": len(messages), # Count in this batch
|
||||
"messages": message_dicts,
|
||||
"pagination": {
|
||||
"limit": limit,
|
||||
"offset": offset,
|
||||
"has_more": len(messages) == limit # If we got a full batch, there might be more
|
||||
}
|
||||
}
|
||||
|
||||
logger.info("Retrieved conversation history",
|
||||
user_id=user.id,
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
count=len(messages))
|
||||
|
||||
return success_response(result)
|
||||
|
||||
except ChatMessagePermissionDenied as e:
|
||||
logger.warning("Permission denied getting conversation",
|
||||
user_id=user.id if 'user' in locals() else None,
|
||||
character_id=character_id,
|
||||
npc_id=npc_id)
|
||||
return error_response(str(e), 403)
|
||||
except Exception as e:
|
||||
logger.error("Failed to get conversation history",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
error=str(e))
|
||||
return error_response(f"Failed to retrieve conversation: {str(e)}", 500)
|
||||
|
||||
|
||||
@chat_bp.route('/api/v1/characters/<character_id>/chats/search', methods=['GET'])
|
||||
@require_auth
|
||||
def search_messages(character_id: str):
|
||||
"""
|
||||
Search messages by text with optional filters.
|
||||
|
||||
Query params:
|
||||
q (required): Search text to find in player_message and npc_response
|
||||
npc_id (optional): Filter by specific NPC
|
||||
context (optional): Filter by message context (dialogue, quest_offered, shop, etc.)
|
||||
date_from (optional): Start date ISO format (e.g., 2025-11-25T00:00:00Z)
|
||||
date_to (optional): End date ISO format
|
||||
limit (optional): Maximum messages to return (default 50, max 100)
|
||||
offset (optional): Number of messages to skip (default 0)
|
||||
|
||||
Returns:
|
||||
JSON response with matching messages
|
||||
"""
|
||||
try:
|
||||
user = get_current_user()
|
||||
|
||||
# Get query parameters
|
||||
search_text = request.args.get('q')
|
||||
npc_id = request.args.get('npc_id')
|
||||
context_str = request.args.get('context')
|
||||
date_from = request.args.get('date_from')
|
||||
date_to = request.args.get('date_to')
|
||||
limit = request.args.get('limit', 50, type=int)
|
||||
offset = request.args.get('offset', 0, type=int)
|
||||
|
||||
# Validate required parameters
|
||||
if not search_text:
|
||||
return validation_error_response("q (search text) is required")
|
||||
|
||||
# Validate optional parameters
|
||||
if limit < 1:
|
||||
return validation_error_response("limit must be at least 1")
|
||||
if offset < 0:
|
||||
return validation_error_response("offset must be at least 0")
|
||||
|
||||
# Parse context enum if provided
|
||||
context = None
|
||||
if context_str:
|
||||
try:
|
||||
context = MessageContext(context_str)
|
||||
except ValueError:
|
||||
valid_contexts = [c.value for c in MessageContext]
|
||||
return validation_error_response(
|
||||
f"Invalid context. Must be one of: {', '.join(valid_contexts)}"
|
||||
)
|
||||
|
||||
# Search messages
|
||||
chat_service = get_chat_message_service()
|
||||
messages = chat_service.search_messages(
|
||||
character_id=character_id,
|
||||
user_id=user.id,
|
||||
search_text=search_text,
|
||||
npc_id=npc_id,
|
||||
context=context,
|
||||
date_from=date_from,
|
||||
date_to=date_to,
|
||||
limit=limit,
|
||||
offset=offset
|
||||
)
|
||||
|
||||
# Convert messages to dict
|
||||
message_dicts = [msg.to_dict() for msg in messages]
|
||||
|
||||
result = {
|
||||
"search_text": search_text,
|
||||
"filters": {
|
||||
"npc_id": npc_id,
|
||||
"context": context_str,
|
||||
"date_from": date_from,
|
||||
"date_to": date_to
|
||||
},
|
||||
"total_results": len(messages),
|
||||
"messages": message_dicts,
|
||||
"pagination": {
|
||||
"limit": limit,
|
||||
"offset": offset,
|
||||
"has_more": len(messages) == limit
|
||||
}
|
||||
}
|
||||
|
||||
logger.info("Search completed",
|
||||
user_id=user.id,
|
||||
character_id=character_id,
|
||||
search_text=search_text,
|
||||
results=len(messages))
|
||||
|
||||
return success_response(result)
|
||||
|
||||
except ChatMessagePermissionDenied as e:
|
||||
logger.warning("Permission denied searching messages",
|
||||
user_id=user.id if 'user' in locals() else None,
|
||||
character_id=character_id)
|
||||
return error_response(str(e), 403)
|
||||
except Exception as e:
|
||||
logger.error("Failed to search messages",
|
||||
character_id=character_id,
|
||||
error=str(e))
|
||||
return error_response(f"Search failed: {str(e)}", 500)
|
||||
|
||||
|
||||
@chat_bp.route('/api/v1/characters/<character_id>/chats/<message_id>', methods=['DELETE'])
|
||||
@require_auth
|
||||
def delete_message(character_id: str, message_id: str):
|
||||
"""
|
||||
Soft delete a message (sets is_deleted=True).
|
||||
|
||||
Used for privacy/moderation. Message remains in database but filtered from queries.
|
||||
|
||||
Path params:
|
||||
character_id: Character ID (for ownership validation)
|
||||
message_id: Message ID to delete
|
||||
|
||||
Returns:
|
||||
JSON response with success confirmation
|
||||
"""
|
||||
try:
|
||||
user = get_current_user()
|
||||
|
||||
# Soft delete message
|
||||
chat_service = get_chat_message_service()
|
||||
success = chat_service.soft_delete_message(
|
||||
message_id=message_id,
|
||||
character_id=character_id,
|
||||
user_id=user.id
|
||||
)
|
||||
|
||||
logger.info("Message deleted",
|
||||
user_id=user.id,
|
||||
character_id=character_id,
|
||||
message_id=message_id)
|
||||
|
||||
return success_response({
|
||||
"message_id": message_id,
|
||||
"deleted": success
|
||||
})
|
||||
|
||||
except ChatMessageNotFound as e:
|
||||
logger.warning("Message not found for deletion",
|
||||
message_id=message_id,
|
||||
character_id=character_id)
|
||||
return not_found_response(str(e))
|
||||
except ChatMessagePermissionDenied as e:
|
||||
logger.warning("Permission denied deleting message",
|
||||
user_id=user.id if 'user' in locals() else None,
|
||||
character_id=character_id,
|
||||
message_id=message_id)
|
||||
return error_response(str(e), 403)
|
||||
except Exception as e:
|
||||
logger.error("Failed to delete message",
|
||||
message_id=message_id,
|
||||
character_id=character_id,
|
||||
error=str(e))
|
||||
return error_response(f"Delete failed: {str(e)}", 500)
|
||||
@@ -70,8 +70,20 @@ class Character:
|
||||
current_location: Optional[str] = None # Set to origin starting location on creation
|
||||
|
||||
# NPC interaction tracking (persists across sessions)
|
||||
# Each entry: {npc_id: {interaction_count, relationship_level, dialogue_history, ...}}
|
||||
# dialogue_history: List[{player_line: str, npc_response: str}]
|
||||
# Each entry: {
|
||||
# npc_id: str,
|
||||
# first_met: str (ISO timestamp),
|
||||
# last_interaction: str (ISO timestamp),
|
||||
# interaction_count: int,
|
||||
# revealed_secrets: List[int],
|
||||
# relationship_level: int (0-100, 50=neutral),
|
||||
# custom_flags: Dict[str, Any],
|
||||
# recent_messages: List[Dict] (last 3 messages for AI context),
|
||||
# format: [{player_message: str, npc_response: str, timestamp: str}, ...],
|
||||
# total_messages: int (total conversation message count),
|
||||
# dialogue_history: List[Dict] (DEPRECATED, use ChatMessageService for full history)
|
||||
# }
|
||||
# Full conversation history stored in chat_messages collection (unlimited)
|
||||
npc_interactions: Dict[str, Dict] = field(default_factory=dict)
|
||||
|
||||
def get_effective_stats(self, active_effects: Optional[List[Effect]] = None) -> Stats:
|
||||
|
||||
172
api/app/models/chat_message.py
Normal file
172
api/app/models/chat_message.py
Normal file
@@ -0,0 +1,172 @@
|
||||
"""
|
||||
Chat Message Data Models.
|
||||
|
||||
This module defines the data structures for player-NPC chat messages,
|
||||
stored in the Appwrite chat_messages collection for unlimited conversation history.
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, field, asdict
|
||||
from datetime import datetime
|
||||
from enum import Enum
|
||||
from typing import Dict, Any, Optional
|
||||
import uuid
|
||||
|
||||
|
||||
class MessageContext(Enum):
|
||||
"""
|
||||
Context type for chat messages.
|
||||
|
||||
Indicates the type of interaction that generated this message,
|
||||
useful for filtering and quest/faction tracking.
|
||||
"""
|
||||
DIALOGUE = "dialogue" # General conversation
|
||||
QUEST_OFFERED = "quest_offered" # Quest offering dialogue
|
||||
QUEST_COMPLETED = "quest_completed" # Quest completion dialogue
|
||||
SHOP = "shop" # Merchant transaction
|
||||
LOCATION_REVEALED = "location_revealed" # New location discovered through chat
|
||||
LORE = "lore" # Lore/backstory reveals
|
||||
|
||||
|
||||
@dataclass
|
||||
class ChatMessage:
|
||||
"""
|
||||
Represents a single message exchange between a player and an NPC.
|
||||
|
||||
This is the core data model for the chat log system. Each message
|
||||
represents a complete exchange: what the player said and how the NPC responded.
|
||||
|
||||
Stored in: Appwrite chat_messages collection
|
||||
Indexed by: character_id, npc_id, timestamp, session_id, context
|
||||
|
||||
Attributes:
|
||||
message_id: Unique identifier (UUID)
|
||||
character_id: Player's character ID
|
||||
npc_id: NPC identifier
|
||||
player_message: What the player said to the NPC
|
||||
npc_response: NPC's reply
|
||||
timestamp: When the message was created (ISO 8601)
|
||||
session_id: Game session reference (optional, for session-based queries)
|
||||
location_id: Where conversation happened (optional)
|
||||
context: Type of interaction (dialogue, quest, shop, etc.)
|
||||
metadata: Extensible JSON field for quest_id, faction_id, item_id, etc.
|
||||
is_deleted: Soft delete flag (for privacy/moderation)
|
||||
"""
|
||||
message_id: str
|
||||
character_id: str
|
||||
npc_id: str
|
||||
player_message: str
|
||||
npc_response: str
|
||||
timestamp: str # ISO 8601 format
|
||||
context: MessageContext
|
||||
session_id: Optional[str] = None
|
||||
location_id: Optional[str] = None
|
||||
metadata: Dict[str, Any] = field(default_factory=dict)
|
||||
is_deleted: bool = False
|
||||
|
||||
@staticmethod
|
||||
def create(
|
||||
character_id: str,
|
||||
npc_id: str,
|
||||
player_message: str,
|
||||
npc_response: str,
|
||||
context: MessageContext = MessageContext.DIALOGUE,
|
||||
session_id: Optional[str] = None,
|
||||
location_id: Optional[str] = None,
|
||||
metadata: Optional[Dict[str, Any]] = None
|
||||
) -> "ChatMessage":
|
||||
"""
|
||||
Factory method to create a new ChatMessage with auto-generated ID and timestamp.
|
||||
|
||||
Args:
|
||||
character_id: Player's character ID
|
||||
npc_id: NPC identifier
|
||||
player_message: What the player said
|
||||
npc_response: NPC's reply
|
||||
context: Type of interaction (default: DIALOGUE)
|
||||
session_id: Optional game session reference
|
||||
location_id: Optional location where conversation happened
|
||||
metadata: Optional extensible metadata (quest_id, faction_id, etc.)
|
||||
|
||||
Returns:
|
||||
New ChatMessage instance with generated ID and current timestamp
|
||||
"""
|
||||
return ChatMessage(
|
||||
message_id=str(uuid.uuid4()),
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
player_message=player_message,
|
||||
npc_response=npc_response,
|
||||
timestamp=datetime.utcnow().isoformat() + "Z",
|
||||
context=context,
|
||||
session_id=session_id,
|
||||
location_id=location_id,
|
||||
metadata=metadata or {},
|
||||
is_deleted=False
|
||||
)
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""
|
||||
Convert ChatMessage to dictionary for JSON serialization.
|
||||
|
||||
Returns:
|
||||
Dictionary representation with MessageContext converted to string
|
||||
"""
|
||||
data = asdict(self)
|
||||
data["context"] = self.context.value # Convert enum to string
|
||||
return data
|
||||
|
||||
@staticmethod
|
||||
def from_dict(data: Dict[str, Any]) -> "ChatMessage":
|
||||
"""
|
||||
Create ChatMessage from dictionary (Appwrite document).
|
||||
|
||||
Args:
|
||||
data: Dictionary from Appwrite document
|
||||
|
||||
Returns:
|
||||
ChatMessage instance
|
||||
"""
|
||||
# Convert context string to enum
|
||||
if isinstance(data.get("context"), str):
|
||||
data["context"] = MessageContext(data["context"])
|
||||
|
||||
return ChatMessage(**data)
|
||||
|
||||
def to_preview(self) -> Dict[str, str]:
|
||||
"""
|
||||
Convert to lightweight preview format for character.npc_interactions.recent_messages.
|
||||
|
||||
Returns:
|
||||
Dictionary with only player_message, npc_response, timestamp
|
||||
"""
|
||||
return {
|
||||
"player_message": self.player_message,
|
||||
"npc_response": self.npc_response,
|
||||
"timestamp": self.timestamp
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class ConversationSummary:
|
||||
"""
|
||||
Summary of all messages with a specific NPC.
|
||||
|
||||
Used for the "conversations list" UI to show all NPCs
|
||||
the character has talked to.
|
||||
|
||||
Attributes:
|
||||
npc_id: NPC identifier
|
||||
npc_name: NPC display name (fetched from NPC data)
|
||||
last_message_timestamp: When the last message was sent
|
||||
message_count: Total number of messages exchanged
|
||||
recent_preview: Short preview of most recent NPC response
|
||||
"""
|
||||
npc_id: str
|
||||
npc_name: str
|
||||
last_message_timestamp: str
|
||||
message_count: int
|
||||
recent_preview: str
|
||||
|
||||
def to_dict(self) -> Dict[str, Any]:
|
||||
"""Convert to dictionary for JSON serialization."""
|
||||
return asdict(self)
|
||||
@@ -982,7 +982,14 @@ class CharacterService:
|
||||
limit: int = 5
|
||||
) -> List[Dict[str, str]]:
|
||||
"""
|
||||
Get recent dialogue history with an NPC.
|
||||
Get recent dialogue history with an NPC from recent_messages cache.
|
||||
|
||||
This method reads from character.npc_interactions[npc_id].recent_messages
|
||||
which contains the last 3 messages for quick AI context. For full conversation
|
||||
history, use ChatMessageService.get_conversation_history().
|
||||
|
||||
Backward Compatibility: Falls back to dialogue_history if recent_messages
|
||||
doesn't exist (for characters created before chat_messages system).
|
||||
|
||||
Args:
|
||||
character_id: Character ID
|
||||
@@ -991,16 +998,46 @@ class CharacterService:
|
||||
limit: Maximum number of recent exchanges to return (default 5)
|
||||
|
||||
Returns:
|
||||
List of dialogue exchanges [{player_line: str, npc_response: str}, ...]
|
||||
List of dialogue exchanges [{player_message: str, npc_response: str, timestamp: str}, ...]
|
||||
OR legacy format [{player_line: str, npc_response: str}, ...]
|
||||
"""
|
||||
try:
|
||||
character = self.get_character(character_id, user_id)
|
||||
|
||||
interaction = character.npc_interactions.get(npc_id, {})
|
||||
dialogue_history = interaction.get("dialogue_history", [])
|
||||
|
||||
# Return most recent exchanges (up to limit)
|
||||
return dialogue_history[-limit:] if dialogue_history else []
|
||||
# NEW: Try recent_messages first (last 3 messages cache)
|
||||
recent_messages = interaction.get("recent_messages")
|
||||
if recent_messages is not None:
|
||||
# Return most recent exchanges (up to limit, but recent_messages is already capped at 3)
|
||||
return recent_messages[-limit:] if recent_messages else []
|
||||
|
||||
# DEPRECATED: Fall back to dialogue_history for backward compatibility
|
||||
# This field will be removed after full migration to chat_messages system
|
||||
dialogue_history = interaction.get("dialogue_history", [])
|
||||
if dialogue_history:
|
||||
logger.debug("Using deprecated dialogue_history field",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id)
|
||||
# Convert old format to new format if needed
|
||||
# Old format: {player_line, npc_response}
|
||||
# New format: {player_message, npc_response, timestamp}
|
||||
converted = []
|
||||
for entry in dialogue_history[-limit:]:
|
||||
if "player_message" in entry:
|
||||
# Already new format
|
||||
converted.append(entry)
|
||||
else:
|
||||
# Old format, convert
|
||||
converted.append({
|
||||
"player_message": entry.get("player_line", ""),
|
||||
"npc_response": entry.get("npc_response", ""),
|
||||
"timestamp": "" # No timestamp available in old format
|
||||
})
|
||||
return converted
|
||||
|
||||
# No dialogue history at all
|
||||
return []
|
||||
|
||||
except CharacterNotFound:
|
||||
raise
|
||||
|
||||
564
api/app/services/chat_message_service.py
Normal file
564
api/app/services/chat_message_service.py
Normal file
@@ -0,0 +1,564 @@
|
||||
"""
|
||||
Chat Message Service.
|
||||
|
||||
This service handles all business logic for player-NPC conversation history,
|
||||
including saving messages, retrieving conversations, searching, and managing
|
||||
the recent_messages cache in character documents.
|
||||
"""
|
||||
|
||||
import json
|
||||
from typing import List, Dict, Any, Optional
|
||||
from datetime import datetime
|
||||
|
||||
from appwrite.query import Query
|
||||
from appwrite.exception import AppwriteException
|
||||
from appwrite.id import ID
|
||||
|
||||
from app.models.chat_message import ChatMessage, MessageContext, ConversationSummary
|
||||
from app.services.database_service import get_database_service
|
||||
from app.services.character_service import CharacterService
|
||||
from app.utils.logging import get_logger
|
||||
|
||||
logger = get_logger(__file__)
|
||||
|
||||
|
||||
# Custom Exceptions
|
||||
class ChatMessageNotFound(Exception):
|
||||
"""Raised when a chat message is not found."""
|
||||
pass
|
||||
|
||||
|
||||
class ChatMessagePermissionDenied(Exception):
|
||||
"""Raised when user doesn't have permission to access/modify a chat message."""
|
||||
pass
|
||||
|
||||
|
||||
class ChatMessageService:
|
||||
"""
|
||||
Service for managing player-NPC chat messages.
|
||||
|
||||
This service provides:
|
||||
- Saving dialogue exchanges to chat_messages collection
|
||||
- Updating recent_messages cache in character documents
|
||||
- Retrieving conversation history with pagination
|
||||
- Searching messages by text, NPC, context, date range
|
||||
- Getting conversation summaries for UI
|
||||
- Soft deleting messages for privacy/moderation
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize the chat message service with database and character service."""
|
||||
self.db = get_database_service()
|
||||
self.character_service = CharacterService()
|
||||
logger.info("ChatMessageService initialized")
|
||||
|
||||
def save_dialogue_exchange(
|
||||
self,
|
||||
character_id: str,
|
||||
user_id: str,
|
||||
npc_id: str,
|
||||
player_message: str,
|
||||
npc_response: str,
|
||||
context: MessageContext = MessageContext.DIALOGUE,
|
||||
metadata: Optional[Dict[str, Any]] = None,
|
||||
session_id: Optional[str] = None,
|
||||
location_id: Optional[str] = None
|
||||
) -> ChatMessage:
|
||||
"""
|
||||
Save a dialogue exchange to chat_messages collection and update character's recent_messages cache.
|
||||
|
||||
This method:
|
||||
1. Creates a ChatMessage document in the chat_messages collection
|
||||
2. Updates character.npc_interactions[npc_id].recent_messages with the last 3 messages
|
||||
3. Updates character.npc_interactions[npc_id].total_messages counter
|
||||
|
||||
Args:
|
||||
character_id: Player's character ID
|
||||
user_id: User ID (for ownership validation)
|
||||
npc_id: NPC identifier
|
||||
player_message: What the player said
|
||||
npc_response: NPC's reply
|
||||
context: Type of interaction (default: DIALOGUE)
|
||||
metadata: Optional extensible metadata (quest_id, faction_id, etc.)
|
||||
session_id: Optional game session reference
|
||||
location_id: Optional location where conversation happened
|
||||
|
||||
Returns:
|
||||
Saved ChatMessage instance
|
||||
|
||||
Raises:
|
||||
ChatMessagePermissionDenied: If user doesn't own the character
|
||||
AppwriteException: If database operation fails
|
||||
"""
|
||||
try:
|
||||
# Validate ownership
|
||||
self._validate_ownership(character_id, user_id)
|
||||
|
||||
# Create chat message
|
||||
chat_message = ChatMessage.create(
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
player_message=player_message,
|
||||
npc_response=npc_response,
|
||||
context=context,
|
||||
session_id=session_id,
|
||||
location_id=location_id,
|
||||
metadata=metadata
|
||||
)
|
||||
|
||||
# Save to database
|
||||
message_data = chat_message.to_dict()
|
||||
# Convert metadata dict to JSON string for storage (Appwrite requires string type)
|
||||
# Always convert, even if empty dict (empty dict {} is falsy in Python!)
|
||||
message_data['metadata'] = json.dumps(message_data.get('metadata') or {})
|
||||
|
||||
self.db.create_row(
|
||||
table_id='chat_messages',
|
||||
data=message_data,
|
||||
row_id=chat_message.message_id
|
||||
)
|
||||
|
||||
logger.info("Chat message saved",
|
||||
message_id=chat_message.message_id,
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
context=context.value)
|
||||
|
||||
# Update character's recent_messages cache
|
||||
self._update_recent_messages_preview(character_id, user_id, npc_id, chat_message)
|
||||
|
||||
return chat_message
|
||||
|
||||
except ChatMessagePermissionDenied:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("Failed to save dialogue exchange",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
error=str(e))
|
||||
raise
|
||||
|
||||
def get_conversation_history(
|
||||
self,
|
||||
character_id: str,
|
||||
user_id: str,
|
||||
npc_id: str,
|
||||
limit: int = 50,
|
||||
offset: int = 0
|
||||
) -> List[ChatMessage]:
|
||||
"""
|
||||
Get paginated conversation history between character and specific NPC.
|
||||
|
||||
Args:
|
||||
character_id: Player's character ID
|
||||
user_id: User ID (for ownership validation)
|
||||
npc_id: NPC identifier
|
||||
limit: Maximum messages to return (default 50, max 100)
|
||||
offset: Number of messages to skip for pagination
|
||||
|
||||
Returns:
|
||||
List of ChatMessage instances ordered by timestamp DESC (most recent first)
|
||||
|
||||
Raises:
|
||||
ChatMessagePermissionDenied: If user doesn't own the character
|
||||
AppwriteException: If database query fails
|
||||
"""
|
||||
try:
|
||||
# Validate ownership
|
||||
self._validate_ownership(character_id, user_id)
|
||||
|
||||
# Clamp limit to max 100
|
||||
limit = min(limit, 100)
|
||||
|
||||
# Build query
|
||||
queries = [
|
||||
Query.equal('character_id', character_id),
|
||||
Query.equal('npc_id', npc_id),
|
||||
Query.equal('is_deleted', False),
|
||||
Query.order_desc('timestamp'),
|
||||
Query.limit(limit),
|
||||
Query.offset(offset)
|
||||
]
|
||||
|
||||
# Fetch messages
|
||||
rows = self.db.list_rows(
|
||||
table_id='chat_messages',
|
||||
queries=queries
|
||||
)
|
||||
|
||||
# Convert to ChatMessage objects
|
||||
messages = []
|
||||
for row in rows:
|
||||
message_data = row.data
|
||||
# Parse JSON metadata if present
|
||||
if message_data.get('metadata') and isinstance(message_data['metadata'], str):
|
||||
message_data['metadata'] = json.loads(message_data['metadata'])
|
||||
messages.append(ChatMessage.from_dict(message_data))
|
||||
|
||||
logger.info("Retrieved conversation history",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
count=len(messages),
|
||||
limit=limit,
|
||||
offset=offset)
|
||||
|
||||
return messages
|
||||
|
||||
except ChatMessagePermissionDenied:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("Failed to get conversation history",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
error=str(e))
|
||||
raise
|
||||
|
||||
def search_messages(
|
||||
self,
|
||||
character_id: str,
|
||||
user_id: str,
|
||||
search_text: str,
|
||||
npc_id: Optional[str] = None,
|
||||
context: Optional[MessageContext] = None,
|
||||
date_from: Optional[str] = None,
|
||||
date_to: Optional[str] = None,
|
||||
limit: int = 50,
|
||||
offset: int = 0
|
||||
) -> List[ChatMessage]:
|
||||
"""
|
||||
Search messages by text with optional filters.
|
||||
|
||||
Note: Appwrite's full-text search may be limited. This performs basic filtering.
|
||||
For production use, consider implementing a dedicated search service.
|
||||
|
||||
Args:
|
||||
character_id: Player's character ID
|
||||
user_id: User ID (for ownership validation)
|
||||
search_text: Text to search for in player_message and npc_response
|
||||
npc_id: Optional filter by specific NPC
|
||||
context: Optional filter by message context type
|
||||
date_from: Optional start date (ISO format)
|
||||
date_to: Optional end date (ISO format)
|
||||
limit: Maximum messages to return (default 50)
|
||||
offset: Number of messages to skip for pagination
|
||||
|
||||
Returns:
|
||||
List of matching ChatMessage instances
|
||||
|
||||
Raises:
|
||||
ChatMessagePermissionDenied: If user doesn't own the character
|
||||
AppwriteException: If database query fails
|
||||
"""
|
||||
try:
|
||||
# Validate ownership
|
||||
self._validate_ownership(character_id, user_id)
|
||||
|
||||
# Build base query
|
||||
queries = [
|
||||
Query.equal('character_id', character_id),
|
||||
Query.equal('is_deleted', False)
|
||||
]
|
||||
|
||||
# Add optional filters
|
||||
if npc_id:
|
||||
queries.append(Query.equal('npc_id', npc_id))
|
||||
|
||||
if context:
|
||||
queries.append(Query.equal('context', context.value))
|
||||
|
||||
if date_from:
|
||||
queries.append(Query.greater_than_equal('timestamp', date_from))
|
||||
|
||||
if date_to:
|
||||
queries.append(Query.less_than_equal('timestamp', date_to))
|
||||
|
||||
# Add search (Appwrite uses Query.search() if available)
|
||||
if search_text:
|
||||
try:
|
||||
queries.append(Query.search('player_message', search_text))
|
||||
except:
|
||||
# Fallback: will filter in Python if search not supported
|
||||
pass
|
||||
|
||||
queries.extend([
|
||||
Query.order_desc('timestamp'),
|
||||
Query.limit(min(limit, 100)),
|
||||
Query.offset(offset)
|
||||
])
|
||||
|
||||
# Fetch messages
|
||||
rows = self.db.list_rows(
|
||||
table_id='chat_messages',
|
||||
queries=queries
|
||||
)
|
||||
|
||||
# Convert to ChatMessage objects and apply text filter if needed
|
||||
messages = []
|
||||
for row in rows:
|
||||
message_data = row.data
|
||||
# Parse JSON metadata if present
|
||||
if message_data.get('metadata') and isinstance(message_data['metadata'], str):
|
||||
message_data['metadata'] = json.loads(message_data['metadata'])
|
||||
|
||||
# Filter by search text in Python if not handled by database
|
||||
if search_text:
|
||||
player_msg = message_data.get('player_message', '').lower()
|
||||
npc_msg = message_data.get('npc_response', '').lower()
|
||||
if search_text.lower() not in player_msg and search_text.lower() not in npc_msg:
|
||||
continue
|
||||
|
||||
messages.append(ChatMessage.from_dict(message_data))
|
||||
|
||||
logger.info("Search completed",
|
||||
character_id=character_id,
|
||||
search_text=search_text,
|
||||
npc_id=npc_id,
|
||||
context=context.value if context else None,
|
||||
results=len(messages))
|
||||
|
||||
return messages
|
||||
|
||||
except ChatMessagePermissionDenied:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("Failed to search messages",
|
||||
character_id=character_id,
|
||||
search_text=search_text,
|
||||
error=str(e))
|
||||
raise
|
||||
|
||||
def get_all_conversations_summary(
|
||||
self,
|
||||
character_id: str,
|
||||
user_id: str
|
||||
) -> List[ConversationSummary]:
|
||||
"""
|
||||
Get summary of all NPC conversations for a character.
|
||||
|
||||
Returns list of NPCs the character has talked to, with message counts,
|
||||
last message timestamp, and preview of most recent exchange.
|
||||
|
||||
Args:
|
||||
character_id: Player's character ID
|
||||
user_id: User ID (for ownership validation)
|
||||
|
||||
Returns:
|
||||
List of ConversationSummary instances
|
||||
|
||||
Raises:
|
||||
ChatMessagePermissionDenied: If user doesn't own the character
|
||||
"""
|
||||
try:
|
||||
# Validate ownership
|
||||
self._validate_ownership(character_id, user_id)
|
||||
|
||||
# Get character to access npc_interactions
|
||||
character = self.character_service.get_character(character_id, user_id)
|
||||
|
||||
# Build summaries from character's npc_interactions
|
||||
summaries = []
|
||||
for npc_id, interaction in character.npc_interactions.items():
|
||||
# Get NPC name (if available from NPC data, otherwise use npc_id)
|
||||
# TODO: When NPC service is available, fetch NPC name
|
||||
npc_name = npc_id.replace('_', ' ').title()
|
||||
|
||||
# Get last message timestamp and preview from recent_messages
|
||||
recent_messages = interaction.get('recent_messages', [])
|
||||
last_timestamp = interaction.get('last_interaction', '')
|
||||
recent_preview = ''
|
||||
|
||||
if recent_messages:
|
||||
last_msg = recent_messages[-1]
|
||||
last_timestamp = last_msg.get('timestamp', last_timestamp)
|
||||
recent_preview = last_msg.get('npc_response', '')[:100] # First 100 chars
|
||||
|
||||
# Get total message count
|
||||
total_messages = interaction.get('total_messages', interaction.get('interaction_count', 0))
|
||||
|
||||
summary = ConversationSummary(
|
||||
npc_id=npc_id,
|
||||
npc_name=npc_name,
|
||||
last_message_timestamp=last_timestamp,
|
||||
message_count=total_messages,
|
||||
recent_preview=recent_preview
|
||||
)
|
||||
summaries.append(summary)
|
||||
|
||||
# Sort by most recent first
|
||||
summaries.sort(key=lambda s: s.last_message_timestamp, reverse=True)
|
||||
|
||||
logger.info("Retrieved conversation summaries",
|
||||
character_id=character_id,
|
||||
conversation_count=len(summaries))
|
||||
|
||||
return summaries
|
||||
|
||||
except ChatMessagePermissionDenied:
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("Failed to get conversation summaries",
|
||||
character_id=character_id,
|
||||
error=str(e))
|
||||
raise
|
||||
|
||||
def soft_delete_message(
|
||||
self,
|
||||
message_id: str,
|
||||
character_id: str,
|
||||
user_id: str
|
||||
) -> bool:
|
||||
"""
|
||||
Soft delete a message by setting is_deleted=True.
|
||||
|
||||
Used for privacy/moderation. Message remains in database but filtered from queries.
|
||||
|
||||
Args:
|
||||
message_id: Message ID to delete
|
||||
character_id: Character ID (for ownership validation)
|
||||
user_id: User ID (for ownership validation)
|
||||
|
||||
Returns:
|
||||
True if successful
|
||||
|
||||
Raises:
|
||||
ChatMessageNotFound: If message not found
|
||||
ChatMessagePermissionDenied: If user doesn't own the character/message
|
||||
"""
|
||||
try:
|
||||
# Validate ownership
|
||||
self._validate_ownership(character_id, user_id)
|
||||
|
||||
# Fetch message to verify it belongs to this character
|
||||
message_row = self.db.get_row(table_id='chat_messages', row_id=message_id)
|
||||
|
||||
if not message_row:
|
||||
raise ChatMessageNotFound(f"Message {message_id} not found")
|
||||
|
||||
if message_row.data.get('character_id') != character_id:
|
||||
raise ChatMessagePermissionDenied("Message does not belong to this character")
|
||||
|
||||
# Update message to set is_deleted=True
|
||||
self.db.update_row(
|
||||
table_id='chat_messages',
|
||||
row_id=message_id,
|
||||
data={'is_deleted': True}
|
||||
)
|
||||
|
||||
logger.info("Message soft deleted",
|
||||
message_id=message_id,
|
||||
character_id=character_id)
|
||||
|
||||
return True
|
||||
|
||||
except (ChatMessageNotFound, ChatMessagePermissionDenied):
|
||||
raise
|
||||
except Exception as e:
|
||||
logger.error("Failed to soft delete message",
|
||||
message_id=message_id,
|
||||
error=str(e))
|
||||
raise
|
||||
|
||||
# Helper Methods
|
||||
|
||||
def _update_recent_messages_preview(
|
||||
self,
|
||||
character_id: str,
|
||||
user_id: str,
|
||||
npc_id: str,
|
||||
new_message: ChatMessage
|
||||
) -> None:
|
||||
"""
|
||||
Update the recent_messages cache in character.npc_interactions[npc_id].
|
||||
|
||||
Maintains the last 3 messages for quick AI context retrieval without querying
|
||||
the chat_messages collection.
|
||||
|
||||
Args:
|
||||
character_id: Character ID
|
||||
user_id: User ID
|
||||
npc_id: NPC ID
|
||||
new_message: New message to add to preview
|
||||
"""
|
||||
try:
|
||||
# Get character
|
||||
character = self.character_service.get_character(character_id, user_id)
|
||||
|
||||
# Get or create NPC interaction
|
||||
if npc_id not in character.npc_interactions:
|
||||
character.npc_interactions[npc_id] = {
|
||||
'npc_id': npc_id,
|
||||
'first_met': new_message.timestamp,
|
||||
'last_interaction': new_message.timestamp,
|
||||
'interaction_count': 0,
|
||||
'revealed_secrets': [],
|
||||
'relationship_level': 50,
|
||||
'custom_flags': {},
|
||||
'recent_messages': [],
|
||||
'total_messages': 0
|
||||
}
|
||||
|
||||
interaction = character.npc_interactions[npc_id]
|
||||
|
||||
# Add new message to recent_messages
|
||||
recent_messages = interaction.get('recent_messages', [])
|
||||
recent_messages.append(new_message.to_preview())
|
||||
|
||||
# Keep only last 3 messages
|
||||
interaction['recent_messages'] = recent_messages[-3:]
|
||||
|
||||
# Update total message count
|
||||
interaction['total_messages'] = interaction.get('total_messages', 0) + 1
|
||||
|
||||
# Update last_interaction timestamp
|
||||
interaction['last_interaction'] = new_message.timestamp
|
||||
|
||||
# Save character
|
||||
self.character_service.update_character(character_id, user_id, character)
|
||||
|
||||
logger.debug("Updated recent_messages preview",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
recent_count=len(interaction['recent_messages']))
|
||||
|
||||
except Exception as e:
|
||||
logger.error("Failed to update recent_messages preview",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
error=str(e))
|
||||
# Don't raise - this is a cache update, not critical
|
||||
|
||||
def _validate_ownership(self, character_id: str, user_id: str) -> None:
|
||||
"""
|
||||
Validate that the user owns the character.
|
||||
|
||||
Args:
|
||||
character_id: Character ID
|
||||
user_id: User ID
|
||||
|
||||
Raises:
|
||||
ChatMessagePermissionDenied: If user doesn't own the character
|
||||
"""
|
||||
try:
|
||||
self.character_service.get_character(character_id, user_id)
|
||||
except Exception as e:
|
||||
logger.warning("Ownership validation failed",
|
||||
character_id=character_id,
|
||||
user_id=user_id)
|
||||
raise ChatMessagePermissionDenied(f"User {user_id} does not own character {character_id}")
|
||||
|
||||
|
||||
# Global instance for convenience
|
||||
_service_instance: Optional[ChatMessageService] = None
|
||||
|
||||
|
||||
def get_chat_message_service() -> ChatMessageService:
|
||||
"""
|
||||
Get the global ChatMessageService instance.
|
||||
|
||||
Returns:
|
||||
Singleton ChatMessageService instance
|
||||
"""
|
||||
global _service_instance
|
||||
if _service_instance is None:
|
||||
_service_instance = ChatMessageService()
|
||||
return _service_instance
|
||||
@@ -97,6 +97,15 @@ class DatabaseInitService:
|
||||
logger.error("Failed to initialize ai_usage_logs table", error=str(e))
|
||||
results['ai_usage_logs'] = False
|
||||
|
||||
# Initialize chat_messages table
|
||||
try:
|
||||
self.init_chat_messages_table()
|
||||
results['chat_messages'] = True
|
||||
logger.info("Chat messages table initialized successfully")
|
||||
except Exception as e:
|
||||
logger.error("Failed to initialize chat_messages table", error=str(e))
|
||||
results['chat_messages'] = False
|
||||
|
||||
success_count = sum(1 for v in results.values() if v)
|
||||
total_count = len(results)
|
||||
|
||||
@@ -536,6 +545,207 @@ class DatabaseInitService:
|
||||
code=e.code)
|
||||
raise
|
||||
|
||||
def init_chat_messages_table(self) -> bool:
|
||||
"""
|
||||
Initialize the chat_messages table for storing player-NPC conversation history.
|
||||
|
||||
Table schema:
|
||||
- message_id (string, required): Unique message identifier (UUID)
|
||||
- character_id (string, required): Player's character ID
|
||||
- npc_id (string, required): NPC identifier
|
||||
- player_message (string, required): What the player said
|
||||
- npc_response (string, required): NPC's reply
|
||||
- timestamp (string, required): ISO timestamp when message was created
|
||||
- session_id (string, optional): Game session reference
|
||||
- location_id (string, optional): Where conversation happened
|
||||
- context (string, required): Message context type (dialogue, quest, shop, etc.)
|
||||
- metadata (string, optional): JSON metadata for quest_id, faction_id, etc.
|
||||
- is_deleted (boolean, default=False): Soft delete flag
|
||||
|
||||
Indexes:
|
||||
- character_id + npc_id + timestamp: Primary query pattern (conversation history)
|
||||
- character_id + timestamp: All character messages
|
||||
- session_id + timestamp: Session-based queries
|
||||
- context: Filter by interaction type
|
||||
- timestamp: Date range queries
|
||||
|
||||
Returns:
|
||||
True if successful
|
||||
|
||||
Raises:
|
||||
AppwriteException: If table creation fails
|
||||
"""
|
||||
table_id = 'chat_messages'
|
||||
|
||||
logger.info("Initializing chat_messages table", table_id=table_id)
|
||||
|
||||
try:
|
||||
# Check if table already exists
|
||||
try:
|
||||
self.tables_db.get_table(
|
||||
database_id=self.database_id,
|
||||
table_id=table_id
|
||||
)
|
||||
logger.info("Chat messages table already exists", table_id=table_id)
|
||||
return True
|
||||
except AppwriteException as e:
|
||||
if e.code != 404:
|
||||
raise
|
||||
logger.info("Chat messages table does not exist, creating...")
|
||||
|
||||
# Create table
|
||||
logger.info("Creating chat_messages table")
|
||||
table = self.tables_db.create_table(
|
||||
database_id=self.database_id,
|
||||
table_id=table_id,
|
||||
name='Chat Messages'
|
||||
)
|
||||
logger.info("Chat messages table created", table_id=table['$id'])
|
||||
|
||||
# Create columns
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='message_id',
|
||||
column_type='string',
|
||||
size=36, # UUID length
|
||||
required=True
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='character_id',
|
||||
column_type='string',
|
||||
size=100,
|
||||
required=True
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='npc_id',
|
||||
column_type='string',
|
||||
size=100,
|
||||
required=True
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='player_message',
|
||||
column_type='string',
|
||||
size=2000, # Player input limit
|
||||
required=True
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='npc_response',
|
||||
column_type='string',
|
||||
size=5000, # AI-generated response
|
||||
required=True
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='timestamp',
|
||||
column_type='string',
|
||||
size=50, # ISO timestamp format
|
||||
required=True
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='session_id',
|
||||
column_type='string',
|
||||
size=100,
|
||||
required=False
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='location_id',
|
||||
column_type='string',
|
||||
size=100,
|
||||
required=False
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='context',
|
||||
column_type='string',
|
||||
size=50, # MessageContext enum values
|
||||
required=True
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='metadata',
|
||||
column_type='string',
|
||||
size=1000, # JSON metadata
|
||||
required=False
|
||||
)
|
||||
|
||||
self._create_column(
|
||||
table_id=table_id,
|
||||
column_id='is_deleted',
|
||||
column_type='boolean',
|
||||
required=False,
|
||||
default=False
|
||||
)
|
||||
|
||||
# Wait for columns to fully propagate
|
||||
logger.info("Waiting for columns to propagate before creating indexes...")
|
||||
time.sleep(2)
|
||||
|
||||
# Create indexes for efficient querying
|
||||
# Most common query: get conversation between character and specific NPC
|
||||
self._create_index(
|
||||
table_id=table_id,
|
||||
index_id='idx_character_npc_time',
|
||||
index_type='key',
|
||||
attributes=['character_id', 'npc_id', 'timestamp']
|
||||
)
|
||||
|
||||
# Get all messages for a character (across all NPCs)
|
||||
self._create_index(
|
||||
table_id=table_id,
|
||||
index_id='idx_character_time',
|
||||
index_type='key',
|
||||
attributes=['character_id', 'timestamp']
|
||||
)
|
||||
|
||||
# Session-based queries
|
||||
self._create_index(
|
||||
table_id=table_id,
|
||||
index_id='idx_session_time',
|
||||
index_type='key',
|
||||
attributes=['session_id', 'timestamp']
|
||||
)
|
||||
|
||||
# Filter by context (quest, shop, lore, etc.)
|
||||
self._create_index(
|
||||
table_id=table_id,
|
||||
index_id='idx_context',
|
||||
index_type='key',
|
||||
attributes=['context']
|
||||
)
|
||||
|
||||
# Date range queries
|
||||
self._create_index(
|
||||
table_id=table_id,
|
||||
index_id='idx_timestamp',
|
||||
index_type='key',
|
||||
attributes=['timestamp']
|
||||
)
|
||||
|
||||
logger.info("Chat messages table initialized successfully", table_id=table_id)
|
||||
return True
|
||||
|
||||
except AppwriteException as e:
|
||||
logger.error("Failed to initialize chat_messages table",
|
||||
table_id=table_id,
|
||||
error=str(e),
|
||||
code=e.code)
|
||||
raise
|
||||
|
||||
def _create_column(
|
||||
self,
|
||||
table_id: str,
|
||||
|
||||
@@ -51,6 +51,8 @@ from app.models.ai_usage import TaskType as UsageTaskType
|
||||
from app.ai.response_parser import parse_ai_response, ParsedAIResponse, GameStateChanges
|
||||
from app.services.item_validator import get_item_validator, ItemValidationError
|
||||
from app.services.character_service import get_character_service
|
||||
from app.services.chat_message_service import get_chat_message_service
|
||||
from app.models.chat_message import MessageContext
|
||||
|
||||
# Import for template rendering
|
||||
from app.ai.prompt_templates import get_prompt_templates
|
||||
@@ -732,28 +734,37 @@ def _process_npc_dialogue_task(
|
||||
"conversation_history": previous_dialogue, # History before this exchange
|
||||
}
|
||||
|
||||
# Save dialogue exchange to character's conversation history
|
||||
if character_id:
|
||||
# Save dialogue exchange to chat_messages collection and update character's recent_messages cache
|
||||
if character_id and npc_id:
|
||||
try:
|
||||
if npc_id:
|
||||
character_service = get_character_service()
|
||||
character_service.add_npc_dialogue_exchange(
|
||||
# Extract location from game_state if available
|
||||
location_id = context.get('game_state', {}).get('current_location')
|
||||
|
||||
# Save to chat_messages collection (also updates character's recent_messages)
|
||||
chat_service = get_chat_message_service()
|
||||
chat_service.save_dialogue_exchange(
|
||||
character_id=character_id,
|
||||
user_id=user_id,
|
||||
npc_id=npc_id,
|
||||
player_line=context['conversation_topic'],
|
||||
npc_response=response.narrative
|
||||
player_message=context['conversation_topic'],
|
||||
npc_response=response.narrative,
|
||||
context=MessageContext.DIALOGUE, # Default context, can be enhanced based on quest/shop interactions
|
||||
metadata={}, # Can add quest_id, item_id, etc. when those systems are implemented
|
||||
session_id=session_id,
|
||||
location_id=location_id
|
||||
)
|
||||
logger.debug(
|
||||
"NPC dialogue exchange saved",
|
||||
"NPC dialogue exchange saved to chat_messages",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id
|
||||
npc_id=npc_id,
|
||||
location_id=location_id
|
||||
)
|
||||
except Exception as e:
|
||||
# Don't fail the task if history save fails
|
||||
logger.warning(
|
||||
"Failed to save NPC dialogue exchange",
|
||||
character_id=character_id,
|
||||
npc_id=npc_id,
|
||||
error=str(e)
|
||||
)
|
||||
|
||||
|
||||
@@ -1550,6 +1550,211 @@ The NPC API enables interaction with persistent NPCs. NPCs have personalities, k
|
||||
|
||||
---
|
||||
|
||||
## Chat / Conversation History
|
||||
|
||||
The Chat API provides access to complete player-NPC conversation history. All dialogue exchanges are stored in the `chat_messages` collection for unlimited history, with the most recent 3 messages cached in character documents for quick AI context.
|
||||
|
||||
### Get All Conversations Summary
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Endpoint** | `GET /api/v1/characters/<character_id>/chats` |
|
||||
| **Description** | Get summary of all NPC conversations for a character |
|
||||
| **Auth Required** | Yes |
|
||||
|
||||
**Response (200 OK):**
|
||||
```json
|
||||
{
|
||||
"app": "Code of Conquest",
|
||||
"version": "0.1.0",
|
||||
"status": 200,
|
||||
"timestamp": "2025-11-25T14:30:00Z",
|
||||
"result": {
|
||||
"conversations": [
|
||||
{
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"npc_name": "Grom Ironbeard",
|
||||
"last_message_timestamp": "2025-11-25T14:30:00Z",
|
||||
"message_count": 15,
|
||||
"recent_preview": "Aye, the rats in the cellar have been causing trouble..."
|
||||
},
|
||||
{
|
||||
"npc_id": "npc_mira_swiftfoot",
|
||||
"npc_name": "Mira Swiftfoot",
|
||||
"last_message_timestamp": "2025-11-25T12:15:00Z",
|
||||
"message_count": 8,
|
||||
"recent_preview": "*leans in and whispers* I've heard rumors about the mayor..."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Get Conversation with Specific NPC
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Endpoint** | `GET /api/v1/characters/<character_id>/chats/<npc_id>` |
|
||||
| **Description** | Get paginated conversation history with a specific NPC |
|
||||
| **Auth Required** | Yes |
|
||||
|
||||
**Query Parameters:**
|
||||
- `limit` (optional): Maximum messages to return (default: 50, max: 100)
|
||||
- `offset` (optional): Number of messages to skip (default: 0)
|
||||
|
||||
**Response (200 OK):**
|
||||
```json
|
||||
{
|
||||
"app": "Code of Conquest",
|
||||
"version": "0.1.0",
|
||||
"status": 200,
|
||||
"timestamp": "2025-11-25T14:30:00Z",
|
||||
"result": {
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"npc_name": "Grom Ironbeard",
|
||||
"total_messages": 15,
|
||||
"messages": [
|
||||
{
|
||||
"message_id": "msg_abc123",
|
||||
"character_id": "char_123",
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"player_message": "What rumors have you heard?",
|
||||
"npc_response": "*leans in* Strange folk been coming through lately...",
|
||||
"timestamp": "2025-11-25T14:30:00Z",
|
||||
"context": "dialogue",
|
||||
"location_id": "crossville_tavern",
|
||||
"session_id": "sess_789",
|
||||
"metadata": {},
|
||||
"is_deleted": false
|
||||
},
|
||||
{
|
||||
"message_id": "msg_abc122",
|
||||
"character_id": "char_123",
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"player_message": "Hello there!",
|
||||
"npc_response": "*nods gruffly* Welcome to the Rusty Anchor.",
|
||||
"timestamp": "2025-11-25T14:25:00Z",
|
||||
"context": "dialogue",
|
||||
"location_id": "crossville_tavern",
|
||||
"session_id": "sess_789",
|
||||
"metadata": {},
|
||||
"is_deleted": false
|
||||
}
|
||||
],
|
||||
"pagination": {
|
||||
"limit": 50,
|
||||
"offset": 0,
|
||||
"has_more": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Message Context Types:**
|
||||
- `dialogue` - General conversation
|
||||
- `quest_offered` - Quest offering dialogue
|
||||
- `quest_completed` - Quest completion dialogue
|
||||
- `shop` - Merchant transaction
|
||||
- `location_revealed` - New location discovered
|
||||
- `lore` - Lore/backstory reveals
|
||||
|
||||
### Search Messages
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Endpoint** | `GET /api/v1/characters/<character_id>/chats/search` |
|
||||
| **Description** | Search messages by text with optional filters |
|
||||
| **Auth Required** | Yes |
|
||||
|
||||
**Query Parameters:**
|
||||
- `q` (required): Search text to find in player_message and npc_response
|
||||
- `npc_id` (optional): Filter by specific NPC
|
||||
- `context` (optional): Filter by message context type
|
||||
- `date_from` (optional): Start date in ISO format (e.g., 2025-11-25T00:00:00Z)
|
||||
- `date_to` (optional): End date in ISO format
|
||||
- `limit` (optional): Maximum messages to return (default: 50, max: 100)
|
||||
- `offset` (optional): Number of messages to skip (default: 0)
|
||||
|
||||
**Example Request:**
|
||||
```
|
||||
GET /api/v1/characters/char_123/chats/search?q=quest&npc_id=npc_grom_ironbeard&context=quest_offered
|
||||
```
|
||||
|
||||
**Response (200 OK):**
|
||||
```json
|
||||
{
|
||||
"app": "Code of Conquest",
|
||||
"version": "0.1.0",
|
||||
"status": 200,
|
||||
"timestamp": "2025-11-25T14:30:00Z",
|
||||
"result": {
|
||||
"search_text": "quest",
|
||||
"filters": {
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"context": "quest_offered",
|
||||
"date_from": null,
|
||||
"date_to": null
|
||||
},
|
||||
"total_results": 2,
|
||||
"messages": [
|
||||
{
|
||||
"message_id": "msg_abc125",
|
||||
"character_id": "char_123",
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"player_message": "Do you have any work for me?",
|
||||
"npc_response": "*sighs heavily* Aye, there's rats in me cellar. Big ones.",
|
||||
"timestamp": "2025-11-25T13:00:00Z",
|
||||
"context": "quest_offered",
|
||||
"location_id": "crossville_tavern",
|
||||
"session_id": "sess_789",
|
||||
"metadata": {
|
||||
"quest_id": "quest_cellar_rats"
|
||||
},
|
||||
"is_deleted": false
|
||||
}
|
||||
],
|
||||
"pagination": {
|
||||
"limit": 50,
|
||||
"offset": 0,
|
||||
"has_more": false
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Delete Message (Soft Delete)
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Endpoint** | `DELETE /api/v1/characters/<character_id>/chats/<message_id>` |
|
||||
| **Description** | Soft delete a message (privacy/moderation) |
|
||||
| **Auth Required** | Yes |
|
||||
|
||||
**Response (200 OK):**
|
||||
```json
|
||||
{
|
||||
"app": "Code of Conquest",
|
||||
"version": "0.1.0",
|
||||
"status": 200,
|
||||
"timestamp": "2025-11-25T14:30:00Z",
|
||||
"result": {
|
||||
"message_id": "msg_abc123",
|
||||
"deleted": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Notes:**
|
||||
- Messages are soft deleted (is_deleted=true), not removed from database
|
||||
- Deleted messages are filtered from all queries
|
||||
- Only the character owner can delete their own messages
|
||||
|
||||
**Error Responses:**
|
||||
- `403` - User does not own the character
|
||||
- `404` - Message not found
|
||||
|
||||
---
|
||||
|
||||
## Combat
|
||||
|
||||
### Attack
|
||||
|
||||
459
api/docs/CHAT_SYSTEM.md
Normal file
459
api/docs/CHAT_SYSTEM.md
Normal file
@@ -0,0 +1,459 @@
|
||||
# Chat / Conversation History System
|
||||
|
||||
## Overview
|
||||
|
||||
The Chat System provides complete player-NPC conversation history tracking with unlimited storage, fast AI context retrieval, and powerful search capabilities. It replaces the previous inline dialogue_history with a scalable, performant architecture.
|
||||
|
||||
**Key Features:**
|
||||
- Unlimited conversation history (no 10-message cap)
|
||||
- Hybrid storage for performance (cache + full history)
|
||||
- Quest and faction tracking ready
|
||||
- Full-text search with filters
|
||||
- Soft delete for privacy/moderation
|
||||
- Future-ready for player-to-player chat
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
### Hybrid Storage Design
|
||||
|
||||
The system uses a **two-tier storage approach** for optimal performance:
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────┐
|
||||
│ Character Document │
|
||||
│ │
|
||||
│ npc_interactions[npc_id]: │
|
||||
│ └─ recent_messages: [last 3 messages] │ ← AI Context (fast)
|
||||
│ └─ total_messages: 15 │
|
||||
│ └─ relationship_level, flags, etc. │
|
||||
└─────────────────────────────────────────────────┘
|
||||
│
|
||||
│ Updates on each new message
|
||||
▼
|
||||
┌─────────────────────────────────────────────────┐
|
||||
│ chat_messages Collection │
|
||||
│ │
|
||||
│ ┌─────────────────────────────────────────┐ │
|
||||
│ │ Message 1 (oldest) │ │
|
||||
│ │ Message 2 │ │
|
||||
│ │ ... │ │ ← Full History (queries)
|
||||
│ │ Message 15 (newest) │ │
|
||||
│ └─────────────────────────────────────────┘ │
|
||||
│ │
|
||||
│ Indexes: character+npc+time, session, context │
|
||||
└─────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
**Benefits:**
|
||||
- **90% of queries** (AI context) read from character document cache → No database query
|
||||
- **10% of queries** (user browsing history, search) use indexed collection → Fast retrieval
|
||||
- Character documents stay small (3 messages vs unlimited)
|
||||
- No performance degradation as conversations grow
|
||||
|
||||
### Data Flow
|
||||
|
||||
**Saving a New Message:**
|
||||
```
|
||||
User talks to NPC
|
||||
│
|
||||
▼
|
||||
POST /api/v1/npcs/{npc_id}/talk
|
||||
│
|
||||
▼
|
||||
AI generates dialogue (background task)
|
||||
│
|
||||
▼
|
||||
ChatMessageService.save_dialogue_exchange()
|
||||
│
|
||||
├─→ 1. Save to chat_messages collection (UUID, full data)
|
||||
│
|
||||
└─→ 2. Update character.npc_interactions[npc_id]:
|
||||
- Append to recent_messages (keep last 3)
|
||||
- Increment total_messages counter
|
||||
- Update last_interaction timestamp
|
||||
```
|
||||
|
||||
**Reading for AI Context:**
|
||||
```
|
||||
AI needs conversation history
|
||||
│
|
||||
▼
|
||||
CharacterService.get_npc_dialogue_history()
|
||||
│
|
||||
└─→ Returns character.npc_interactions[npc_id].recent_messages
|
||||
(Already loaded in memory, instant access)
|
||||
```
|
||||
|
||||
**Reading for User UI:**
|
||||
```
|
||||
User views conversation history
|
||||
│
|
||||
▼
|
||||
GET /api/v1/characters/{char_id}/chats/{npc_id}?limit=50&offset=0
|
||||
│
|
||||
▼
|
||||
ChatMessageService.get_conversation_history()
|
||||
│
|
||||
└─→ Query chat_messages collection
|
||||
WHERE character_id = X AND npc_id = Y
|
||||
ORDER BY timestamp DESC
|
||||
LIMIT 50 OFFSET 0
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Database Schema
|
||||
|
||||
### Collection: `chat_messages`
|
||||
|
||||
| Column | Type | Size | Indexed | Description |
|
||||
|--------|------|------|---------|-------------|
|
||||
| `message_id` | string | 36 | Primary | UUID |
|
||||
| `character_id` | string | 100 | Yes | Player character |
|
||||
| `npc_id` | string | 100 | Yes | NPC identifier |
|
||||
| `player_message` | string | 2000 | No | Player input |
|
||||
| `npc_response` | string | 5000 | No | AI-generated reply |
|
||||
| `timestamp` | datetime | - | Yes | ISO 8601 format |
|
||||
| `session_id` | string | 100 | Yes | Game session |
|
||||
| `location_id` | string | 100 | No | Where conversation happened |
|
||||
| `context` | string | 50 | Yes | MessageContext enum |
|
||||
| `metadata` | string (JSON) | 1000 | No | Extensible (quest_id, etc.) |
|
||||
| `is_deleted` | boolean | - | No | Soft delete flag |
|
||||
|
||||
### Indexes
|
||||
|
||||
1. **idx_character_npc_time** (character_id + npc_id + timestamp DESC)
|
||||
- **Purpose**: Get conversation between character and specific NPC
|
||||
- **Query**: "Show me my chat with Grom"
|
||||
- **Used by**: `get_conversation_history()`
|
||||
|
||||
2. **idx_character_time** (character_id + timestamp DESC)
|
||||
- **Purpose**: Get all messages for a character across all NPCs
|
||||
- **Query**: "Show me all my conversations"
|
||||
- **Used by**: `get_all_conversations_summary()`
|
||||
|
||||
3. **idx_session_time** (session_id + timestamp DESC)
|
||||
- **Purpose**: Get all chat messages from a specific game session
|
||||
- **Query**: "What did I discuss during this session?"
|
||||
- **Used by**: Session replay, analytics
|
||||
|
||||
4. **idx_context** (context)
|
||||
- **Purpose**: Filter messages by interaction type
|
||||
- **Query**: "Show me all quest offers"
|
||||
- **Used by**: `search_messages()` with context filter
|
||||
|
||||
5. **idx_timestamp** (timestamp DESC)
|
||||
- **Purpose**: Date range queries
|
||||
- **Query**: "Show messages from last week"
|
||||
- **Used by**: `search_messages()` with date filters
|
||||
|
||||
---
|
||||
|
||||
## Integration Points
|
||||
|
||||
### 1. NPC Dialogue Generation (`/api/app/tasks/ai_tasks.py`)
|
||||
|
||||
**Old Flow (Deprecated):**
|
||||
```python
|
||||
# Saved to character.npc_interactions[npc_id].dialogue_history
|
||||
character_service.add_npc_dialogue_exchange(
|
||||
character_id, npc_id, player_line, npc_response
|
||||
)
|
||||
```
|
||||
|
||||
**New Flow:**
|
||||
```python
|
||||
# Saves to chat_messages + updates recent_messages cache
|
||||
chat_service = get_chat_message_service()
|
||||
chat_service.save_dialogue_exchange(
|
||||
character_id=character_id,
|
||||
user_id=user_id,
|
||||
npc_id=npc_id,
|
||||
player_message=player_line,
|
||||
npc_response=npc_response,
|
||||
context=MessageContext.DIALOGUE,
|
||||
metadata={}, # Can include quest_id, item_id when available
|
||||
session_id=session_id,
|
||||
location_id=current_location
|
||||
)
|
||||
```
|
||||
|
||||
### 2. Character Service (`/api/app/services/character_service.py`)
|
||||
|
||||
**Updated Method:**
|
||||
```python
|
||||
def get_npc_dialogue_history(character_id, user_id, npc_id, limit=5):
|
||||
"""
|
||||
Get recent dialogue history from recent_messages cache.
|
||||
Falls back to dialogue_history for backward compatibility.
|
||||
"""
|
||||
interaction = character.npc_interactions.get(npc_id, {})
|
||||
|
||||
# NEW: Read from recent_messages (last 3 messages)
|
||||
recent_messages = interaction.get("recent_messages")
|
||||
if recent_messages is not None:
|
||||
return recent_messages[-limit:]
|
||||
|
||||
# DEPRECATED: Fall back to old dialogue_history field
|
||||
dialogue_history = interaction.get("dialogue_history", [])
|
||||
return dialogue_history[-limit:]
|
||||
```
|
||||
|
||||
### 3. Character Document Structure
|
||||
|
||||
**Updated `npc_interactions` Field:**
|
||||
```python
|
||||
{
|
||||
"npc_grom_ironbeard": {
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"first_met": "2025-11-25T10:00:00Z",
|
||||
"last_interaction": "2025-11-25T14:30:00Z",
|
||||
"interaction_count": 5,
|
||||
"revealed_secrets": [0, 2],
|
||||
"relationship_level": 65,
|
||||
"custom_flags": {"helped_with_rats": true},
|
||||
|
||||
# NEW FIELDS
|
||||
"recent_messages": [ # Last 3 messages for AI context
|
||||
{
|
||||
"player_message": "What rumors have you heard?",
|
||||
"npc_response": "*leans in* Strange folk...",
|
||||
"timestamp": "2025-11-25T14:30:00Z"
|
||||
}
|
||||
],
|
||||
"total_messages": 15, # Total count for UI display
|
||||
|
||||
# DEPRECATED (kept for backward compatibility)
|
||||
"dialogue_history": [] # Will be removed after full migration
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API Endpoints
|
||||
|
||||
See `API_REFERENCE.md` for complete endpoint documentation.
|
||||
|
||||
**Summary:**
|
||||
- `GET /api/v1/characters/{char_id}/chats` - All conversations summary
|
||||
- `GET /api/v1/characters/{char_id}/chats/{npc_id}` - Full conversation with pagination
|
||||
- `GET /api/v1/characters/{char_id}/chats/search` - Search with filters
|
||||
- `DELETE /api/v1/characters/{char_id}/chats/{msg_id}` - Soft delete
|
||||
|
||||
---
|
||||
|
||||
## Performance Characteristics
|
||||
|
||||
### Storage Estimates
|
||||
|
||||
| Scenario | Messages | Storage per Character |
|
||||
|----------|----------|----------------------|
|
||||
| Casual player | 50 messages across 5 NPCs | ~25 KB |
|
||||
| Active player | 200 messages across 10 NPCs | ~100 KB |
|
||||
| Heavy player | 1000 messages across 20 NPCs | ~500 KB |
|
||||
|
||||
**Character Document Impact:**
|
||||
- Recent messages (3 per NPC): ~1.5 KB per NPC
|
||||
- 10 NPCs: ~15 KB total (vs ~50 KB for old 10-message history)
|
||||
- 67% reduction in character document size
|
||||
|
||||
### Query Performance
|
||||
|
||||
**AI Context Retrieval:**
|
||||
- **Old**: ~50ms database query + deserialization
|
||||
- **New**: ~1ms (read from already-loaded character object)
|
||||
- **Improvement**: 50x faster
|
||||
|
||||
**User History Browsing:**
|
||||
- **Old**: Limited to last 10 messages (no pagination)
|
||||
- **New**: Unlimited with pagination (50ms per page)
|
||||
- **Improvement**: Unlimited history with same performance
|
||||
|
||||
**Search:**
|
||||
- **Old**: Not available (would require scanning all character docs)
|
||||
- **New**: ~100ms for filtered search across thousands of messages
|
||||
- **Improvement**: Previously impossible
|
||||
|
||||
### Scalability
|
||||
|
||||
**Growth Characteristics:**
|
||||
- Character document size: O(1) - Fixed at 3 messages per NPC
|
||||
- Chat collection size: O(n) - Linear growth with message count
|
||||
- Query performance: O(log n) - Indexed queries remain fast
|
||||
|
||||
**Capacity Estimate:**
|
||||
- 1000 active players
|
||||
- Average 500 messages per player
|
||||
- Total: 500,000 messages = ~250 MB
|
||||
- Appwrite easily handles this scale
|
||||
|
||||
---
|
||||
|
||||
## Future Extensions
|
||||
|
||||
### Quest Tracking
|
||||
```python
|
||||
# Save quest offer with metadata
|
||||
chat_service.save_dialogue_exchange(
|
||||
...,
|
||||
context=MessageContext.QUEST_OFFERED,
|
||||
metadata={"quest_id": "quest_cellar_rats"}
|
||||
)
|
||||
|
||||
# Query all quest offers
|
||||
results = chat_service.search_messages(
|
||||
...,
|
||||
context=MessageContext.QUEST_OFFERED
|
||||
)
|
||||
```
|
||||
|
||||
### Faction Tracking
|
||||
```python
|
||||
# Save reputation change with metadata
|
||||
chat_service.save_dialogue_exchange(
|
||||
...,
|
||||
context=MessageContext.DIALOGUE,
|
||||
metadata={
|
||||
"faction_id": "crossville_guard",
|
||||
"reputation_change": +10
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
### Player-to-Player Chat
|
||||
```python
|
||||
# Add message_type enum to distinguish chat types
|
||||
class MessageType(Enum):
|
||||
PLAYER_TO_NPC = "player_to_npc"
|
||||
NPC_TO_PLAYER = "npc_to_player"
|
||||
PLAYER_TO_PLAYER = "player_to_player"
|
||||
SYSTEM = "system"
|
||||
|
||||
# Extend ChatMessage with message_type field
|
||||
# Extend indexes with sender_id + recipient_id
|
||||
```
|
||||
|
||||
### Read Receipts
|
||||
```python
|
||||
# Add read_at field to ChatMessage
|
||||
# Update when player views conversation
|
||||
# Show "unread" badge in UI
|
||||
```
|
||||
|
||||
### Chat Channels
|
||||
```python
|
||||
# Add channel_id field (party, guild, global)
|
||||
# Index by channel_id for group chats
|
||||
# Support broadcasting to multiple recipients
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Migration Strategy
|
||||
|
||||
### Phase 1: Dual Write (Current)
|
||||
- ✅ New messages saved to both locations
|
||||
- ✅ Old dialogue_history field still maintained
|
||||
- ✅ Reads prefer recent_messages, fallback to dialogue_history
|
||||
- ✅ Zero downtime migration
|
||||
|
||||
### Phase 2: Data Backfill (Optional)
|
||||
- Migrate existing dialogue_history to chat_messages
|
||||
- Script: `/api/scripts/migrate_dialogue_history.py`
|
||||
- Can be run anytime without disrupting service
|
||||
|
||||
### Phase 3: Deprecation (Future)
|
||||
- Stop writing to dialogue_history field
|
||||
- Remove field from Character model
|
||||
- Remove add_npc_dialogue_exchange() method
|
||||
|
||||
**Timeline:** Phase 2-3 can wait until full testing complete. No rush.
|
||||
|
||||
---
|
||||
|
||||
## Security & Privacy
|
||||
|
||||
**Access Control:**
|
||||
- Users can only access their own character's messages
|
||||
- Ownership validated on every request
|
||||
- Character service validates user_id matches
|
||||
|
||||
**Soft Delete:**
|
||||
- Messages marked is_deleted=true, not removed
|
||||
- Filtered from all queries automatically
|
||||
- Preserved for audit/moderation if needed
|
||||
|
||||
**Data Retention:**
|
||||
- No automatic cleanup implemented
|
||||
- Messages persist indefinitely
|
||||
- Future: Could add retention policy per user preference
|
||||
|
||||
---
|
||||
|
||||
## Monitoring & Analytics
|
||||
|
||||
**Usage Tracking:**
|
||||
- Total messages per character (total_messages field)
|
||||
- Interaction counts per NPC (interaction_count field)
|
||||
- Message context distribution (via context field)
|
||||
|
||||
**Performance Metrics:**
|
||||
- Query latency (via logging)
|
||||
- Cache hit rate (recent_messages vs full query)
|
||||
- Storage growth (collection size monitoring)
|
||||
|
||||
**Business Metrics:**
|
||||
- Most-contacted NPCs
|
||||
- Average conversation length
|
||||
- Quest offer acceptance rate (via context tracking)
|
||||
- Player engagement (messages per session)
|
||||
|
||||
---
|
||||
|
||||
## Development Notes
|
||||
|
||||
**File Locations:**
|
||||
- Model: `/app/models/chat_message.py`
|
||||
- Service: `/app/services/chat_message_service.py`
|
||||
- API: `/app/api/chat.py`
|
||||
- Database Init: `/app/services/database_init.py` (init_chat_messages_table)
|
||||
|
||||
**Testing:**
|
||||
- Unit tests: `/tests/test_chat_message_service.py`
|
||||
- Integration tests: `/tests/test_chat_api.py`
|
||||
- Manual testing: See API_REFERENCE.md for curl examples
|
||||
|
||||
**Dependencies:**
|
||||
- Appwrite SDK (database operations)
|
||||
- Character Service (ownership validation)
|
||||
- NPC Loader (NPC name resolution)
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Issue: Messages not appearing in history**
|
||||
- Check chat_messages collection exists (run init_database.py)
|
||||
- Verify ChatMessageService is being called in ai_tasks.py
|
||||
- Check logs for errors during save_dialogue_exchange()
|
||||
|
||||
**Issue: Slow queries**
|
||||
- Verify indexes exist (check Appwrite console)
|
||||
- Monitor query patterns (check logs)
|
||||
- Consider adjusting pagination limits
|
||||
|
||||
**Issue: Character document too large**
|
||||
- Should not happen (recent_messages capped at 3)
|
||||
- If occurring, check for old dialogue_history accumulation
|
||||
- Run migration script to clean up old data
|
||||
|
||||
---
|
||||
|
||||
## References
|
||||
|
||||
- API_REFERENCE.md - Chat API endpoints
|
||||
- DATA_MODELS.md - ChatMessage model details
|
||||
- APPWRITE_SETUP.md - Database configuration
|
||||
@@ -321,18 +321,25 @@ Tracks a character's interaction history with an NPC. Stored on Character record
|
||||
| `revealed_secrets` | List[int] | Indices of secrets revealed |
|
||||
| `relationship_level` | int | 0-100 scale (50 is neutral) |
|
||||
| `custom_flags` | Dict[str, Any] | Arbitrary flags for special conditions |
|
||||
| `dialogue_history` | List[Dict] | Recent conversation exchanges (max 10 per NPC) |
|
||||
| `recent_messages` | List[Dict] | **Last 3 messages for quick AI context** |
|
||||
| `total_messages` | int | **Total conversation message count** |
|
||||
| `dialogue_history` | List[Dict] | **DEPRECATED** - Use ChatMessageService for full history |
|
||||
|
||||
**Dialogue History Entry Format:**
|
||||
**Recent Messages Entry Format:**
|
||||
```json
|
||||
{
|
||||
"player_line": "What have you heard about the old mines?",
|
||||
"player_message": "What have you heard about the old mines?",
|
||||
"npc_response": "Aye, strange noises coming from there lately...",
|
||||
"timestamp": "2025-11-24T10:30:00Z"
|
||||
"timestamp": "2025-11-25T10:30:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
The dialogue history enables bidirectional NPC conversations - players can respond to NPC dialogue and continue conversations with context. The system maintains the last 10 exchanges per NPC to provide conversation context without excessive storage.
|
||||
**Conversation History Architecture:**
|
||||
- **Recent Messages Cache**: Last 3 messages stored in `recent_messages` field for quick AI context (no database query)
|
||||
- **Full History**: Complete unlimited conversation history stored in `chat_messages` collection
|
||||
- **Deprecated Field**: `dialogue_history` maintained for backward compatibility, will be removed after full migration
|
||||
|
||||
The recent messages cache enables fast AI dialogue generation by providing immediate context without querying the chat_messages collection. For full conversation history, use the ChatMessageService (see Chat/Conversation History API endpoints).
|
||||
|
||||
**Relationship Levels:**
|
||||
- 0-20: Hostile
|
||||
@@ -415,6 +422,177 @@ merchants = loader.get_npcs_by_tag("merchant")
|
||||
|
||||
---
|
||||
|
||||
## Chat / Conversation History System
|
||||
|
||||
The chat system stores complete player-NPC conversation history in a dedicated `chat_messages` collection for unlimited history, with a performance-optimized cache in character documents.
|
||||
|
||||
### ChatMessage
|
||||
|
||||
Complete message exchange between player and NPC.
|
||||
|
||||
**Location:** `/app/models/chat_message.py`
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `message_id` | str | Unique identifier (UUID) |
|
||||
| `character_id` | str | Player's character ID |
|
||||
| `npc_id` | str | NPC identifier |
|
||||
| `player_message` | str | What the player said (max 2000 chars) |
|
||||
| `npc_response` | str | NPC's reply (max 5000 chars) |
|
||||
| `timestamp` | str | ISO 8601 timestamp |
|
||||
| `session_id` | Optional[str] | Game session reference |
|
||||
| `location_id` | Optional[str] | Where conversation happened |
|
||||
| `context` | MessageContext | Type of interaction (enum) |
|
||||
| `metadata` | Dict[str, Any] | Extensible metadata (quest_id, item_id, etc.) |
|
||||
| `is_deleted` | bool | Soft delete flag (default: False) |
|
||||
|
||||
**Storage:**
|
||||
- Stored in Appwrite `chat_messages` collection
|
||||
- Indexed by character_id, npc_id, timestamp for fast queries
|
||||
- Unlimited history (no cap on message count)
|
||||
|
||||
**Example:**
|
||||
```json
|
||||
{
|
||||
"message_id": "550e8400-e29b-41d4-a716-446655440000",
|
||||
"character_id": "char_123",
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"player_message": "What rumors have you heard?",
|
||||
"npc_response": "*leans in* Strange folk been coming through lately...",
|
||||
"timestamp": "2025-11-25T14:30:00Z",
|
||||
"context": "dialogue",
|
||||
"location_id": "crossville_tavern",
|
||||
"session_id": "sess_789",
|
||||
"metadata": {},
|
||||
"is_deleted": false
|
||||
}
|
||||
```
|
||||
|
||||
### MessageContext (Enum)
|
||||
|
||||
Type of interaction that generated the message.
|
||||
|
||||
| Value | Description |
|
||||
|-------|-------------|
|
||||
| `dialogue` | General conversation |
|
||||
| `quest_offered` | Quest offering dialogue |
|
||||
| `quest_completed` | Quest completion dialogue |
|
||||
| `shop` | Merchant transaction |
|
||||
| `location_revealed` | New location discovered through chat |
|
||||
| `lore` | Lore/backstory reveals |
|
||||
|
||||
**Usage:**
|
||||
```python
|
||||
from app.models.chat_message import MessageContext
|
||||
|
||||
context = MessageContext.QUEST_OFFERED
|
||||
```
|
||||
|
||||
### ConversationSummary
|
||||
|
||||
Summary of all messages with a specific NPC for UI display.
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `npc_id` | str | NPC identifier |
|
||||
| `npc_name` | str | NPC display name |
|
||||
| `last_message_timestamp` | str | When the last message was sent |
|
||||
| `message_count` | int | Total number of messages exchanged |
|
||||
| `recent_preview` | str | Short preview of most recent NPC response |
|
||||
|
||||
**Example:**
|
||||
```json
|
||||
{
|
||||
"npc_id": "npc_grom_ironbeard",
|
||||
"npc_name": "Grom Ironbeard",
|
||||
"last_message_timestamp": "2025-11-25T14:30:00Z",
|
||||
"message_count": 15,
|
||||
"recent_preview": "Aye, the rats in the cellar have been causing trouble..."
|
||||
}
|
||||
```
|
||||
|
||||
### ChatMessageService
|
||||
|
||||
Service for managing player-NPC conversation history.
|
||||
|
||||
**Location:** `/app/services/chat_message_service.py`
|
||||
|
||||
**Core Methods:**
|
||||
|
||||
```python
|
||||
from app.services.chat_message_service import get_chat_message_service
|
||||
from app.models.chat_message import MessageContext
|
||||
|
||||
service = get_chat_message_service()
|
||||
|
||||
# Save a dialogue exchange (also updates character's recent_messages cache)
|
||||
message = service.save_dialogue_exchange(
|
||||
character_id="char_123",
|
||||
user_id="user_456",
|
||||
npc_id="npc_grom_ironbeard",
|
||||
player_message="What rumors have you heard?",
|
||||
npc_response="*leans in* Strange folk...",
|
||||
context=MessageContext.DIALOGUE,
|
||||
metadata={},
|
||||
session_id="sess_789",
|
||||
location_id="crossville_tavern"
|
||||
)
|
||||
|
||||
# Get conversation history with pagination
|
||||
messages = service.get_conversation_history(
|
||||
character_id="char_123",
|
||||
user_id="user_456",
|
||||
npc_id="npc_grom_ironbeard",
|
||||
limit=50,
|
||||
offset=0
|
||||
)
|
||||
|
||||
# Search messages with filters
|
||||
results = service.search_messages(
|
||||
character_id="char_123",
|
||||
user_id="user_456",
|
||||
search_text="quest",
|
||||
npc_id="npc_grom_ironbeard",
|
||||
context=MessageContext.QUEST_OFFERED,
|
||||
date_from="2025-11-01T00:00:00Z",
|
||||
date_to="2025-11-30T23:59:59Z",
|
||||
limit=50,
|
||||
offset=0
|
||||
)
|
||||
|
||||
# Get all conversations summary for UI
|
||||
summaries = service.get_all_conversations_summary(
|
||||
character_id="char_123",
|
||||
user_id="user_456"
|
||||
)
|
||||
|
||||
# Soft delete a message (privacy/moderation)
|
||||
success = service.soft_delete_message(
|
||||
message_id="msg_abc123",
|
||||
character_id="char_123",
|
||||
user_id="user_456"
|
||||
)
|
||||
```
|
||||
|
||||
**Performance Architecture:**
|
||||
- **Recent Messages Cache**: Last 3 messages stored in `character.npc_interactions[npc_id].recent_messages`
|
||||
- **Full History**: All messages in dedicated `chat_messages` collection
|
||||
- **AI Context**: Reads from cache (no database query) for 90% of cases
|
||||
- **User Queries**: Reads from collection with pagination and filters
|
||||
|
||||
**Database Indexes:**
|
||||
1. `idx_character_npc_time` - character_id + npc_id + timestamp DESC
|
||||
2. `idx_character_time` - character_id + timestamp DESC
|
||||
3. `idx_session_time` - session_id + timestamp DESC
|
||||
4. `idx_context` - context
|
||||
5. `idx_timestamp` - timestamp DESC
|
||||
|
||||
**See Also:**
|
||||
- Chat API endpoints in API_REFERENCE.md
|
||||
- CHAT_SYSTEM.md for architecture details
|
||||
|
||||
---
|
||||
|
||||
## Character System
|
||||
|
||||
### Stats
|
||||
|
||||
@@ -12,6 +12,7 @@ import structlog
|
||||
import yaml
|
||||
import os
|
||||
from pathlib import Path
|
||||
from datetime import datetime, timezone
|
||||
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
@@ -61,6 +62,34 @@ def create_app():
|
||||
app.register_blueprint(character_bp)
|
||||
app.register_blueprint(game_bp)
|
||||
|
||||
# Register Jinja filters
|
||||
def format_timestamp(iso_string: str) -> str:
|
||||
"""Convert ISO timestamp to relative time (e.g., '2 mins ago')"""
|
||||
if not iso_string:
|
||||
return ""
|
||||
try:
|
||||
timestamp = datetime.fromisoformat(iso_string.replace('Z', '+00:00'))
|
||||
now = datetime.now(timezone.utc)
|
||||
diff = now - timestamp
|
||||
|
||||
seconds = diff.total_seconds()
|
||||
if seconds < 60:
|
||||
return "Just now"
|
||||
elif seconds < 3600:
|
||||
mins = int(seconds / 60)
|
||||
return f"{mins} min{'s' if mins != 1 else ''} ago"
|
||||
elif seconds < 86400:
|
||||
hours = int(seconds / 3600)
|
||||
return f"{hours} hr{'s' if hours != 1 else ''} ago"
|
||||
else:
|
||||
days = int(seconds / 86400)
|
||||
return f"{days} day{'s' if days != 1 else ''} ago"
|
||||
except Exception as e:
|
||||
logger.warning("timestamp_format_failed", iso_string=iso_string, error=str(e))
|
||||
return iso_string
|
||||
|
||||
app.jinja_env.filters['format_timestamp'] = format_timestamp
|
||||
|
||||
# Register dev blueprint only in development
|
||||
env = os.getenv("FLASK_ENV", "development")
|
||||
if env == "development":
|
||||
|
||||
@@ -506,6 +506,10 @@ def poll_job(session_id: str, job_id: str):
|
||||
"""Poll job status - returns updated partial."""
|
||||
client = get_api_client()
|
||||
|
||||
# Get hx_target and hx_swap from query params (passed through from original request)
|
||||
hx_target = request.args.get('_hx_target')
|
||||
hx_swap = request.args.get('_hx_swap')
|
||||
|
||||
try:
|
||||
response = client.get(f'/api/v1/jobs/{job_id}/status')
|
||||
result = response.get('result', {})
|
||||
@@ -540,11 +544,14 @@ def poll_job(session_id: str, job_id: str):
|
||||
|
||||
else:
|
||||
# Still processing - return polling partial to continue
|
||||
# Pass through hx_target and hx_swap to maintain targeting
|
||||
return render_template(
|
||||
'game/partials/job_polling.html',
|
||||
session_id=session_id,
|
||||
job_id=job_id,
|
||||
status=status
|
||||
status=status,
|
||||
hx_target=hx_target,
|
||||
hx_swap=hx_swap
|
||||
)
|
||||
|
||||
except APIError as e:
|
||||
@@ -683,10 +690,66 @@ def do_travel(session_id: str):
|
||||
return f'<div class="error">Travel failed: {e}</div>', 500
|
||||
|
||||
|
||||
@game_bp.route('/session/<session_id>/npc/<npc_id>')
|
||||
@require_auth
|
||||
def npc_chat_page(session_id: str, npc_id: str):
|
||||
"""
|
||||
Dedicated NPC chat page (mobile-friendly full page view).
|
||||
Used on mobile devices for better UX.
|
||||
"""
|
||||
client = get_api_client()
|
||||
|
||||
try:
|
||||
# Get session to find character
|
||||
session_response = client.get(f'/api/v1/sessions/{session_id}')
|
||||
session_data = session_response.get('result', {})
|
||||
character_id = session_data.get('character_id')
|
||||
|
||||
# Get NPC details with relationship info
|
||||
npc_response = client.get(f'/api/v1/npcs/{npc_id}?character_id={character_id}')
|
||||
npc_data = npc_response.get('result', {})
|
||||
|
||||
npc = {
|
||||
'npc_id': npc_data.get('npc_id'),
|
||||
'name': npc_data.get('name'),
|
||||
'role': npc_data.get('role'),
|
||||
'appearance': npc_data.get('appearance', {}).get('brief', ''),
|
||||
'tags': npc_data.get('tags', []),
|
||||
'image_url': npc_data.get('image_url')
|
||||
}
|
||||
|
||||
# Get relationship info
|
||||
interaction_summary = npc_data.get('interaction_summary', {})
|
||||
relationship_level = interaction_summary.get('relationship_level', 50)
|
||||
interaction_count = interaction_summary.get('interaction_count', 0)
|
||||
|
||||
# Conversation history would come from character's npc_interactions
|
||||
# For now, we'll leave it empty - the API returns it in dialogue responses
|
||||
conversation_history = []
|
||||
|
||||
return render_template(
|
||||
'game/npc_chat_page.html',
|
||||
session_id=session_id,
|
||||
npc=npc,
|
||||
conversation_history=conversation_history,
|
||||
relationship_level=relationship_level,
|
||||
interaction_count=interaction_count
|
||||
)
|
||||
|
||||
except APINotFoundError:
|
||||
return render_template('errors/404.html', message="NPC not found"), 404
|
||||
except APIError as e:
|
||||
logger.error("failed_to_load_npc_chat_page", session_id=session_id, npc_id=npc_id, error=str(e))
|
||||
return render_template('errors/500.html', message=f"Failed to load NPC: {e}"), 500
|
||||
|
||||
|
||||
@game_bp.route('/session/<session_id>/npc/<npc_id>/chat')
|
||||
@require_auth
|
||||
def npc_chat_modal(session_id: str, npc_id: str):
|
||||
"""Get NPC chat modal with conversation history."""
|
||||
"""
|
||||
Get NPC chat modal with conversation history.
|
||||
Used on desktop for modal overlay experience.
|
||||
"""
|
||||
client = get_api_client()
|
||||
|
||||
try:
|
||||
@@ -741,6 +804,40 @@ def npc_chat_modal(session_id: str, npc_id: str):
|
||||
'''
|
||||
|
||||
|
||||
@game_bp.route('/session/<session_id>/npc/<npc_id>/history')
|
||||
@require_auth
|
||||
def npc_chat_history(session_id: str, npc_id: str):
|
||||
"""Get last 5 chat messages for history sidebar."""
|
||||
client = get_api_client()
|
||||
|
||||
try:
|
||||
# Get session to find character_id
|
||||
session_response = client.get(f'/api/v1/sessions/{session_id}')
|
||||
session_data = session_response.get('result', {})
|
||||
character_id = session_data.get('character_id')
|
||||
|
||||
# Fetch last 5 messages from chat service
|
||||
# API endpoint: GET /api/v1/characters/{character_id}/chats/{npc_id}?limit=5
|
||||
history_response = client.get(
|
||||
f'/api/v1/characters/{character_id}/chats/{npc_id}',
|
||||
params={'limit': 5, 'offset': 0}
|
||||
)
|
||||
result_data = history_response.get('result', {})
|
||||
messages = result_data.get('messages', []) # Extract messages array from result
|
||||
|
||||
# Render history partial
|
||||
return render_template(
|
||||
'game/partials/npc_chat_history.html',
|
||||
messages=messages,
|
||||
session_id=session_id,
|
||||
npc_id=npc_id
|
||||
)
|
||||
|
||||
except APIError as e:
|
||||
logger.error("failed_to_load_chat_history", session_id=session_id, npc_id=npc_id, error=str(e))
|
||||
return '<div class="history-empty">Failed to load history</div>', 500
|
||||
|
||||
|
||||
@game_bp.route('/session/<session_id>/npc/<npc_id>/talk', methods=['POST'])
|
||||
@require_auth
|
||||
def talk_to_npc(session_id: str, npc_id: str):
|
||||
@@ -767,12 +864,15 @@ def talk_to_npc(session_id: str, npc_id: str):
|
||||
job_id = result.get('job_id')
|
||||
if job_id:
|
||||
# Return job polling partial for the chat area
|
||||
# Use hx-target="this" and hx-swap="outerHTML" to replace loading div with response in-place
|
||||
return render_template(
|
||||
'game/partials/job_polling.html',
|
||||
job_id=job_id,
|
||||
session_id=session_id,
|
||||
status='queued',
|
||||
is_npc_dialogue=True
|
||||
is_npc_dialogue=True,
|
||||
hx_target='this', # Target the loading div itself
|
||||
hx_swap='outerHTML' # Replace entire loading div with response
|
||||
)
|
||||
|
||||
# Immediate response (if AI is sync or cached)
|
||||
|
||||
380
public_web/docs/RESPONSIVE_MODALS.md
Normal file
380
public_web/docs/RESPONSIVE_MODALS.md
Normal file
@@ -0,0 +1,380 @@
|
||||
# Responsive Modal Pattern
|
||||
|
||||
## Overview
|
||||
|
||||
This pattern provides an optimal UX for modal-like content by adapting to screen size:
|
||||
- **Desktop (>1024px)**: Displays content in modal overlays
|
||||
- **Mobile (≤1024px)**: Navigates to dedicated full pages
|
||||
|
||||
This addresses common mobile modal UX issues: cramped space, nested scrolling, keyboard conflicts, and lack of native back button support.
|
||||
|
||||
---
|
||||
|
||||
## When to Use This Pattern
|
||||
|
||||
Use this pattern when:
|
||||
- Content requires significant interaction (forms, chat, complex data)
|
||||
- Mobile users need better scroll/keyboard handling
|
||||
- The interaction benefits from full-screen on mobile
|
||||
- Desktop users benefit from keeping context visible
|
||||
|
||||
**Don't use** for:
|
||||
- Simple confirmations/alerts (use standard modals)
|
||||
- Very brief interactions (dropdowns, tooltips)
|
||||
- Content that must overlay the game state
|
||||
|
||||
---
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
### 1. Create Shared Content Partial
|
||||
|
||||
Extract the actual content into a reusable partial template that both the modal and page can use.
|
||||
|
||||
**File**: `templates/game/partials/[feature]_content.html`
|
||||
|
||||
```html
|
||||
{# Shared content partial #}
|
||||
<div class="feature-container">
|
||||
<!-- Your content here -->
|
||||
<!-- This will be used by both modal and page -->
|
||||
</div>
|
||||
```
|
||||
|
||||
### 2. Create Two Routes
|
||||
|
||||
Create both a modal route and a page route in your view:
|
||||
|
||||
**File**: `app/views/game_views.py`
|
||||
|
||||
```python
|
||||
@game_bp.route('/session/<session_id>/feature/<feature_id>')
|
||||
@require_auth
|
||||
def feature_page(session_id: str, feature_id: str):
|
||||
"""
|
||||
Dedicated page view (mobile-friendly).
|
||||
Used on mobile devices for better UX.
|
||||
"""
|
||||
# Fetch data
|
||||
data = get_feature_data(session_id, feature_id)
|
||||
|
||||
return render_template(
|
||||
'game/feature_page.html',
|
||||
session_id=session_id,
|
||||
feature=data
|
||||
)
|
||||
|
||||
|
||||
@game_bp.route('/session/<session_id>/feature/<feature_id>/modal')
|
||||
@require_auth
|
||||
def feature_modal(session_id: str, feature_id: str):
|
||||
"""
|
||||
Modal view (desktop overlay).
|
||||
Used on desktop for quick interactions.
|
||||
"""
|
||||
# Fetch same data
|
||||
data = get_feature_data(session_id, feature_id)
|
||||
|
||||
return render_template(
|
||||
'game/partials/feature_modal.html',
|
||||
session_id=session_id,
|
||||
feature=data
|
||||
)
|
||||
```
|
||||
|
||||
### 3. Create Page Template
|
||||
|
||||
Create a dedicated page template with header, back button, and shared content.
|
||||
|
||||
**File**: `templates/game/feature_page.html`
|
||||
|
||||
```html
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block title %}{{ feature.name }} - Code of Conquest{% endblock %}
|
||||
|
||||
{% block extra_head %}
|
||||
<link rel="stylesheet" href="{{ url_for('static', filename='css/play.css') }}">
|
||||
{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="feature-page">
|
||||
{# Page Header with Back Button #}
|
||||
<div class="feature-header">
|
||||
<a href="{{ url_for('game.play_session', session_id=session_id) }}"
|
||||
class="feature-back-btn">
|
||||
<svg><!-- Back arrow icon --></svg>
|
||||
Back
|
||||
</a>
|
||||
<h1 class="feature-title">{{ feature.name }}</h1>
|
||||
</div>
|
||||
|
||||
{# Include shared content #}
|
||||
{% include 'game/partials/feature_content.html' %}
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
||||
{% block scripts %}
|
||||
<script>
|
||||
// Add any feature-specific JavaScript here
|
||||
</script>
|
||||
{% endblock %}
|
||||
```
|
||||
|
||||
### 4. Update Modal Template
|
||||
|
||||
Update your modal template to use the shared content partial.
|
||||
|
||||
**File**: `templates/game/partials/feature_modal.html`
|
||||
|
||||
```html
|
||||
{# Modal wrapper #}
|
||||
<div class="modal-overlay" onclick="if(event.target === this) closeModal()">
|
||||
<div class="modal-content modal-content--xl">
|
||||
{# Modal Header #}
|
||||
<div class="modal-header">
|
||||
<h3 class="modal-title">{{ feature.name }}</h3>
|
||||
<button class="modal-close" onclick="closeModal()">×</button>
|
||||
</div>
|
||||
|
||||
{# Modal Body - Uses shared content #}
|
||||
<div class="modal-body">
|
||||
{% include 'game/partials/feature_content.html' %}
|
||||
</div>
|
||||
|
||||
{# Modal Footer (optional) #}
|
||||
<div class="modal-footer">
|
||||
<button class="btn btn--secondary" onclick="closeModal()">
|
||||
Close
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
### 5. Add Responsive Navigation
|
||||
|
||||
Update the trigger element to use responsive navigation JavaScript.
|
||||
|
||||
**File**: `templates/game/partials/sidebar_features.html`
|
||||
|
||||
```html
|
||||
<div class="feature-item"
|
||||
data-feature-id="{{ feature.id }}"
|
||||
onclick="navigateResponsive(
|
||||
event,
|
||||
'{{ url_for('game.feature_page', session_id=session_id, feature_id=feature.id) }}',
|
||||
'{{ url_for('game.feature_modal', session_id=session_id, feature_id=feature.id) }}'
|
||||
)"
|
||||
style="cursor: pointer;">
|
||||
<div class="feature-name">{{ feature.name }}</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
### 6. Add Mobile-Friendly CSS
|
||||
|
||||
Add CSS for the dedicated page with mobile optimizations.
|
||||
|
||||
**File**: `static/css/play.css`
|
||||
|
||||
```css
|
||||
/* Feature Page */
|
||||
.feature-page {
|
||||
min-height: 100vh;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
background: var(--bg-secondary);
|
||||
}
|
||||
|
||||
/* Page Header with Back Button */
|
||||
.feature-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 1rem;
|
||||
padding: 1rem;
|
||||
background: var(--bg-primary);
|
||||
border-bottom: 2px solid var(--play-border);
|
||||
position: sticky;
|
||||
top: 0;
|
||||
z-index: 100;
|
||||
}
|
||||
|
||||
.feature-back-btn {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
padding: 0.5rem 1rem;
|
||||
background: var(--bg-input);
|
||||
color: var(--text-primary);
|
||||
text-decoration: none;
|
||||
border-radius: 4px;
|
||||
border: 1px solid var(--play-border);
|
||||
transition: all 0.2s ease;
|
||||
}
|
||||
|
||||
.feature-back-btn:hover {
|
||||
background: var(--bg-tertiary);
|
||||
border-color: var(--accent-gold);
|
||||
color: var(--accent-gold);
|
||||
}
|
||||
|
||||
.feature-title {
|
||||
flex: 1;
|
||||
margin: 0;
|
||||
font-family: var(--font-heading);
|
||||
font-size: 1.5rem;
|
||||
color: var(--accent-gold);
|
||||
}
|
||||
|
||||
/* Responsive layout */
|
||||
@media (min-width: 1025px) {
|
||||
.feature-page .feature-container {
|
||||
max-width: 1400px;
|
||||
margin: 0 auto;
|
||||
padding: 2rem;
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 1024px) {
|
||||
.feature-page .feature-container {
|
||||
padding: 1rem;
|
||||
flex: 1;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 7. Include JavaScript
|
||||
|
||||
Ensure the responsive modals JavaScript is included in your play page template.
|
||||
|
||||
**File**: `templates/game/play.html`
|
||||
|
||||
```html
|
||||
{% block scripts %}
|
||||
<!-- Existing scripts -->
|
||||
<script>
|
||||
// Your existing JavaScript
|
||||
</script>
|
||||
|
||||
<!-- Responsive Modal Navigation -->
|
||||
<script src="{{ url_for('static', filename='js/responsive-modals.js') }}"></script>
|
||||
{% endblock %}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## JavaScript API
|
||||
|
||||
The responsive navigation is handled by `responsive-modals.js`:
|
||||
|
||||
### Functions
|
||||
|
||||
#### `navigateResponsive(event, pageUrl, modalUrl)`
|
||||
|
||||
Navigates responsively based on screen size.
|
||||
|
||||
**Parameters:**
|
||||
- `event` (Event): Click event (will be prevented)
|
||||
- `pageUrl` (string): Full page URL for mobile navigation
|
||||
- `modalUrl` (string): Modal content URL for desktop HTMX loading
|
||||
|
||||
**Example:**
|
||||
```javascript
|
||||
navigateResponsive(
|
||||
event,
|
||||
'/game/session/123/npc/456', // Page route
|
||||
'/game/session/123/npc/456/chat' // Modal route
|
||||
)
|
||||
```
|
||||
|
||||
#### `isMobile()`
|
||||
|
||||
Returns true if viewport is ≤1024px.
|
||||
|
||||
**Example:**
|
||||
```javascript
|
||||
if (isMobile()) {
|
||||
// Mobile-specific behavior
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Breakpoint
|
||||
|
||||
The mobile/desktop breakpoint is **1024px** to match the CSS media query:
|
||||
|
||||
```javascript
|
||||
const MOBILE_BREAKPOINT = 1024;
|
||||
```
|
||||
|
||||
This ensures consistent behavior between JavaScript navigation and CSS responsive layouts.
|
||||
|
||||
---
|
||||
|
||||
## Example: NPC Chat
|
||||
|
||||
See the NPC chat implementation for a complete working example:
|
||||
|
||||
**Routes:**
|
||||
- Page: `/game/session/<session_id>/npc/<npc_id>` (public_web/app/views/game_views.py:695)
|
||||
- Modal: `/game/session/<session_id>/npc/<npc_id>/chat` (public_web/app/views/game_views.py:746)
|
||||
|
||||
**Templates:**
|
||||
- Shared content: `templates/game/partials/npc_chat_content.html`
|
||||
- Page: `templates/game/npc_chat_page.html`
|
||||
- Modal: `templates/game/partials/npc_chat_modal.html`
|
||||
|
||||
**Trigger:**
|
||||
- `templates/game/partials/sidebar_npcs.html` (line 11)
|
||||
|
||||
**CSS:**
|
||||
- Page styles: `static/css/play.css` (lines 1809-1956)
|
||||
|
||||
---
|
||||
|
||||
## Testing Checklist
|
||||
|
||||
When implementing this pattern, test:
|
||||
|
||||
- [ ] Desktop (>1024px): Modal opens correctly
|
||||
- [ ] Desktop: Modal closes with X button, overlay click, and Escape key
|
||||
- [ ] Desktop: Game screen remains visible behind modal
|
||||
- [ ] Mobile (≤1024px): Navigates to dedicated page
|
||||
- [ ] Mobile: Back button returns to game
|
||||
- [ ] Mobile: Content scrolls naturally
|
||||
- [ ] Mobile: Keyboard doesn't break layout
|
||||
- [ ] Both: Shared content renders identically
|
||||
- [ ] Both: HTMX interactions work correctly
|
||||
- [ ] Resize: Behavior adapts when crossing breakpoint
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Always share content**: Use a partial template to avoid duplication
|
||||
2. **Keep routes parallel**: Use consistent URL patterns (`/feature` and `/feature/modal`)
|
||||
3. **Test both views**: Ensure feature parity between modal and page
|
||||
4. **Mobile-first CSS**: Design for mobile, enhance for desktop
|
||||
5. **Consistent breakpoint**: Always use 1024px to match the JavaScript
|
||||
6. **Document examples**: Link to working implementations in this doc
|
||||
|
||||
---
|
||||
|
||||
## Future Improvements
|
||||
|
||||
Potential enhancements to this pattern:
|
||||
|
||||
- [ ] Add transition animations for modal open/close
|
||||
- [ ] Support deep linking to modals on desktop
|
||||
- [ ] Add browser back button handling for desktop modals
|
||||
- [ ] Support customizable breakpoints per feature
|
||||
- [ ] Add analytics tracking for modal vs page usage
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **HTMX_PATTERNS.md** - HTMX integration patterns
|
||||
- **TEMPLATES.md** - Template structure and conventions
|
||||
- **TESTING.md** - Manual testing procedures
|
||||
@@ -1033,7 +1033,7 @@
|
||||
.modal-content--sm { max-width: 400px; }
|
||||
.modal-content--md { max-width: 500px; }
|
||||
.modal-content--lg { max-width: 700px; }
|
||||
.modal-content--xl { max-width: 900px; }
|
||||
.modal-content--xl { max-width: 1000px; } /* Expanded for 3-column NPC chat */
|
||||
|
||||
@keyframes slideUp {
|
||||
from { transform: translateY(20px); opacity: 0; }
|
||||
@@ -1434,6 +1434,14 @@
|
||||
min-height: 400px;
|
||||
}
|
||||
|
||||
/* 3-column layout for chat modal with history sidebar */
|
||||
.npc-modal-body--three-col {
|
||||
display: grid;
|
||||
grid-template-columns: 200px 1fr 280px; /* Profile | Chat | History */
|
||||
gap: 1rem;
|
||||
max-height: 70vh;
|
||||
}
|
||||
|
||||
/* NPC Profile (Left Column) */
|
||||
.npc-profile {
|
||||
width: 200px;
|
||||
@@ -1587,18 +1595,20 @@
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
/* NPC Conversation (Right Column) */
|
||||
/* NPC Conversation (Middle Column) */
|
||||
.npc-conversation {
|
||||
flex: 1;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
min-width: 0;
|
||||
min-height: 0; /* Important for grid child to enable scrolling */
|
||||
}
|
||||
|
||||
.npc-conversation .chat-history {
|
||||
flex: 1;
|
||||
min-height: 250px;
|
||||
max-height: none;
|
||||
max-height: 500px; /* Set max height to enable scrolling */
|
||||
overflow-y: auto; /* Enable vertical scroll */
|
||||
}
|
||||
|
||||
.chat-empty-state {
|
||||
@@ -1608,6 +1618,107 @@
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* ===== NPC CHAT HISTORY SIDEBAR ===== */
|
||||
.npc-history-panel {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
border-left: 1px solid var(--play-border);
|
||||
padding-left: 1rem;
|
||||
overflow-y: auto;
|
||||
max-height: 70vh;
|
||||
}
|
||||
|
||||
.history-header {
|
||||
font-size: 0.875rem;
|
||||
font-weight: 600;
|
||||
color: var(--text-muted);
|
||||
text-transform: uppercase;
|
||||
margin-bottom: 0.75rem;
|
||||
letter-spacing: 0.05em;
|
||||
}
|
||||
|
||||
.history-list {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
/* Compact history cards */
|
||||
.history-card {
|
||||
background: var(--bg-secondary);
|
||||
border: 1px solid var(--play-border);
|
||||
border-radius: 4px;
|
||||
padding: 0.5rem;
|
||||
font-size: 0.8rem;
|
||||
transition: background 0.2s;
|
||||
}
|
||||
|
||||
.history-card:hover {
|
||||
background: var(--bg-tertiary);
|
||||
}
|
||||
|
||||
.history-timestamp {
|
||||
font-size: 0.7rem;
|
||||
color: var(--text-muted);
|
||||
margin-bottom: 0.25rem;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.history-player {
|
||||
color: var(--text-primary);
|
||||
margin-bottom: 0.125rem;
|
||||
line-height: 1.4;
|
||||
}
|
||||
|
||||
.history-player strong {
|
||||
color: var(--accent-gold);
|
||||
}
|
||||
|
||||
.history-npc {
|
||||
color: var(--text-primary);
|
||||
line-height: 1.4;
|
||||
}
|
||||
|
||||
.history-npc strong {
|
||||
color: var(--accent-gold);
|
||||
}
|
||||
|
||||
.history-empty {
|
||||
text-align: center;
|
||||
color: var(--text-muted);
|
||||
font-size: 0.875rem;
|
||||
padding: 2rem 0;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.loading-state-small {
|
||||
text-align: center;
|
||||
color: var(--text-muted);
|
||||
font-size: 0.875rem;
|
||||
padding: 1rem 0;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* HTMX Loading Indicator */
|
||||
.history-loading {
|
||||
text-align: center;
|
||||
color: var(--text-muted);
|
||||
font-size: 0.875rem;
|
||||
padding: 1rem 0;
|
||||
font-style: italic;
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* Show loading indicator when HTMX is making a request */
|
||||
.htmx-indicator.htmx-request .history-loading {
|
||||
display: block;
|
||||
}
|
||||
|
||||
/* Hide other content while loading */
|
||||
.htmx-indicator.htmx-request > *:not(.history-loading) {
|
||||
opacity: 0.5;
|
||||
}
|
||||
|
||||
/* Responsive NPC Modal */
|
||||
@media (max-width: 700px) {
|
||||
.npc-modal-body {
|
||||
@@ -1650,6 +1761,31 @@
|
||||
}
|
||||
}
|
||||
|
||||
/* Responsive: 3-column modal stacks on smaller screens */
|
||||
@media (max-width: 1024px) {
|
||||
.npc-modal-body--three-col {
|
||||
grid-template-columns: 1fr; /* Single column */
|
||||
grid-template-rows: auto 1fr auto;
|
||||
}
|
||||
|
||||
.npc-profile {
|
||||
order: 1;
|
||||
}
|
||||
|
||||
.npc-conversation {
|
||||
order: 2;
|
||||
}
|
||||
|
||||
.npc-history-panel {
|
||||
order: 3;
|
||||
border-left: none;
|
||||
border-top: 1px solid var(--play-border);
|
||||
padding-left: 0;
|
||||
padding-top: 1rem;
|
||||
max-height: 200px; /* Shorter on mobile */
|
||||
}
|
||||
}
|
||||
|
||||
/* ===== UTILITY CLASSES FOR PLAY SCREEN ===== */
|
||||
.play-hidden {
|
||||
display: none !important;
|
||||
@@ -1689,3 +1825,152 @@
|
||||
.chat-history::-webkit-scrollbar-thumb:hover {
|
||||
background: var(--text-muted);
|
||||
}
|
||||
|
||||
/* ===== NPC CHAT DEDICATED PAGE ===== */
|
||||
/* Mobile-friendly full page view for NPC conversations */
|
||||
|
||||
.npc-chat-page {
|
||||
min-height: 100vh;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
background: var(--bg-secondary);
|
||||
}
|
||||
|
||||
/* Page Header with Back Button */
|
||||
.npc-chat-header {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 1rem;
|
||||
padding: 1rem;
|
||||
background: var(--bg-primary);
|
||||
border-bottom: 2px solid var(--play-border);
|
||||
position: sticky;
|
||||
top: 0;
|
||||
z-index: 100;
|
||||
}
|
||||
|
||||
.npc-chat-back-btn {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
padding: 0.5rem 1rem;
|
||||
background: var(--bg-input);
|
||||
color: var(--text-primary);
|
||||
text-decoration: none;
|
||||
border-radius: 4px;
|
||||
border: 1px solid var(--play-border);
|
||||
font-family: var(--font-heading);
|
||||
font-size: 0.9rem;
|
||||
transition: all 0.2s ease;
|
||||
}
|
||||
|
||||
.npc-chat-back-btn:hover {
|
||||
background: var(--bg-tertiary);
|
||||
border-color: var(--accent-gold);
|
||||
color: var(--accent-gold);
|
||||
}
|
||||
|
||||
.npc-chat-back-btn svg {
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
}
|
||||
|
||||
.npc-chat-title {
|
||||
flex: 1;
|
||||
margin: 0;
|
||||
font-family: var(--font-heading);
|
||||
font-size: 1.5rem;
|
||||
color: var(--accent-gold);
|
||||
}
|
||||
|
||||
/* Chat Container - Full Height Layout */
|
||||
.npc-chat-page .npc-chat-container {
|
||||
flex: 1;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
padding: 1rem;
|
||||
gap: 1rem;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Responsive Layout for NPC Chat Content */
|
||||
/* Desktop: 3-column grid */
|
||||
@media (min-width: 1025px) {
|
||||
.npc-chat-page .npc-chat-container {
|
||||
display: grid;
|
||||
grid-template-columns: 250px 1fr 300px;
|
||||
gap: 1.5rem;
|
||||
max-width: 1400px;
|
||||
margin: 0 auto;
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
|
||||
/* Mobile: Stacked layout */
|
||||
@media (max-width: 1024px) {
|
||||
.npc-chat-page .npc-chat-container {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 1rem;
|
||||
}
|
||||
|
||||
/* Compact profile on mobile */
|
||||
.npc-chat-page .npc-profile {
|
||||
flex-direction: row;
|
||||
flex-wrap: wrap;
|
||||
align-items: flex-start;
|
||||
gap: 1rem;
|
||||
}
|
||||
|
||||
.npc-chat-page .npc-portrait {
|
||||
width: 80px;
|
||||
height: 80px;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.npc-chat-page .npc-profile-info {
|
||||
flex: 1;
|
||||
min-width: 150px;
|
||||
}
|
||||
|
||||
.npc-chat-page .npc-relationship,
|
||||
.npc-chat-page .npc-profile-tags,
|
||||
.npc-chat-page .npc-interaction-stats {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
/* Conversation takes most of the vertical space */
|
||||
.npc-chat-page .npc-conversation {
|
||||
flex: 1;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
min-height: 400px;
|
||||
}
|
||||
|
||||
/* History panel is collapsible on mobile */
|
||||
.npc-chat-page .npc-history-panel {
|
||||
max-height: 200px;
|
||||
overflow-y: auto;
|
||||
border-top: 1px solid var(--play-border);
|
||||
padding-top: 1rem;
|
||||
}
|
||||
}
|
||||
|
||||
/* Ensure chat history fills available space on page */
|
||||
.npc-chat-page .chat-history {
|
||||
flex: 1;
|
||||
overflow-y: auto;
|
||||
min-height: 300px;
|
||||
}
|
||||
|
||||
/* Fix chat input to bottom on mobile */
|
||||
@media (max-width: 1024px) {
|
||||
.npc-chat-page .chat-input-form {
|
||||
position: sticky;
|
||||
bottom: 0;
|
||||
background: var(--bg-secondary);
|
||||
padding: 0.75rem 0;
|
||||
border-top: 1px solid var(--play-border);
|
||||
margin-top: 0.5rem;
|
||||
}
|
||||
}
|
||||
|
||||
81
public_web/static/js/responsive-modals.js
Normal file
81
public_web/static/js/responsive-modals.js
Normal file
@@ -0,0 +1,81 @@
|
||||
/**
|
||||
* Responsive Modal Navigation
|
||||
*
|
||||
* Provides smart navigation that uses modals on desktop (>1024px)
|
||||
* and full page navigation on mobile (<=1024px) for better UX.
|
||||
*
|
||||
* Usage:
|
||||
* Instead of using hx-get directly on elements, use:
|
||||
* onclick="navigateResponsive(event, '/page/url', '/modal/url')"
|
||||
*/
|
||||
|
||||
// Breakpoint for mobile vs desktop (matches CSS @media query)
|
||||
const MOBILE_BREAKPOINT = 1024;
|
||||
|
||||
/**
|
||||
* Check if current viewport is mobile size
|
||||
*/
|
||||
function isMobile() {
|
||||
return window.innerWidth <= MOBILE_BREAKPOINT;
|
||||
}
|
||||
|
||||
/**
|
||||
* Navigate responsively based on screen size
|
||||
*
|
||||
* @param {Event} event - Click event (will be prevented)
|
||||
* @param {string} pageUrl - Full page URL for mobile
|
||||
* @param {string} modalUrl - Modal content URL for desktop (HTMX)
|
||||
*/
|
||||
function navigateResponsive(event, pageUrl, modalUrl) {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
|
||||
if (isMobile()) {
|
||||
// Mobile: Navigate to full page
|
||||
window.location.href = pageUrl;
|
||||
} else {
|
||||
// Desktop: Load modal via HTMX
|
||||
const target = event.currentTarget;
|
||||
|
||||
// Trigger HTMX request programmatically
|
||||
htmx.ajax('GET', modalUrl, {
|
||||
target: '#modal-container',
|
||||
swap: 'innerHTML'
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Setup responsive navigation for NPC items
|
||||
* Call this after NPCs are loaded
|
||||
*/
|
||||
function setupNPCResponsiveNav(sessionId) {
|
||||
document.querySelectorAll('.npc-item').forEach(item => {
|
||||
const npcId = item.getAttribute('data-npc-id');
|
||||
if (!npcId) return;
|
||||
|
||||
const pageUrl = `/game/session/${sessionId}/npc/${npcId}`;
|
||||
const modalUrl = `/game/session/${sessionId}/npc/${npcId}/chat`;
|
||||
|
||||
// Remove HTMX attributes and add responsive navigation
|
||||
item.removeAttribute('hx-get');
|
||||
item.removeAttribute('hx-target');
|
||||
item.removeAttribute('hx-swap');
|
||||
|
||||
item.style.cursor = 'pointer';
|
||||
item.onclick = (e) => navigateResponsive(e, pageUrl, modalUrl);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle window resize to adapt navigation behavior
|
||||
* Debounced to avoid excessive calls
|
||||
*/
|
||||
let resizeTimeout;
|
||||
window.addEventListener('resize', () => {
|
||||
clearTimeout(resizeTimeout);
|
||||
resizeTimeout = setTimeout(() => {
|
||||
// Re-setup navigation if needed
|
||||
console.log('Viewport resized:', isMobile() ? 'Mobile' : 'Desktop');
|
||||
}, 250);
|
||||
});
|
||||
@@ -16,6 +16,8 @@
|
||||
<script src="https://unpkg.com/htmx.org@1.9.10"></script>
|
||||
<!-- HTMX JSON encoding extension -->
|
||||
<script src="https://unpkg.com/htmx.org@1.9.10/dist/ext/json-enc.js"></script>
|
||||
<!-- Hyperscript for custom events -->
|
||||
<script src="https://unpkg.com/hyperscript.org@0.9.12"></script>
|
||||
|
||||
{% block extra_head %}{% endblock %}
|
||||
</head>
|
||||
|
||||
44
public_web/templates/game/npc_chat_page.html
Normal file
44
public_web/templates/game/npc_chat_page.html
Normal file
@@ -0,0 +1,44 @@
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block title %}{{ npc.name }} - Code of Conquest{% endblock %}
|
||||
|
||||
{% block extra_head %}
|
||||
<!-- Play screen styles for NPC chat -->
|
||||
<link rel="stylesheet" href="{{ url_for('static', filename='css/play.css') }}">
|
||||
{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="npc-chat-page">
|
||||
{# Page Header with Back Button #}
|
||||
<div class="npc-chat-header">
|
||||
<a href="{{ url_for('game.play_session', session_id=session_id) }}" class="npc-chat-back-btn">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path d="M19 12H5M12 19l-7-7 7-7"/>
|
||||
</svg>
|
||||
Back
|
||||
</a>
|
||||
<h1 class="npc-chat-title">{{ npc.name }}</h1>
|
||||
</div>
|
||||
|
||||
{# Include shared NPC chat content #}
|
||||
{% include 'game/partials/npc_chat_content.html' %}
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
||||
{% block scripts %}
|
||||
<script>
|
||||
// Clear chat input after submission
|
||||
document.body.addEventListener('htmx:afterSwap', function(e) {
|
||||
if (e.target.closest('.chat-history')) {
|
||||
const form = document.querySelector('.chat-input-form');
|
||||
if (form) {
|
||||
const input = form.querySelector('.chat-input');
|
||||
if (input) {
|
||||
input.value = '';
|
||||
input.focus();
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
</script>
|
||||
{% endblock %}
|
||||
@@ -10,10 +10,10 @@ Shows loading state while waiting for AI response, auto-polls for completion
|
||||
{% endif %}
|
||||
|
||||
<div class="loading-state"
|
||||
hx-get="{{ url_for('game.poll_job', session_id=session_id, job_id=job_id) }}"
|
||||
hx-get="{{ url_for('game.poll_job', session_id=session_id, job_id=job_id, _hx_target=hx_target, _hx_swap=hx_swap) }}"
|
||||
hx-trigger="load delay:1s"
|
||||
hx-swap="innerHTML"
|
||||
hx-target="#narrative-content">
|
||||
hx-swap="{{ hx_swap|default('innerHTML') }}"
|
||||
hx-target="{{ hx_target|default('#narrative-content') }}">
|
||||
<div class="loading-spinner-large"></div>
|
||||
<p class="loading-text">
|
||||
{% if status == 'queued' %}
|
||||
|
||||
120
public_web/templates/game/partials/npc_chat_content.html
Normal file
120
public_web/templates/game/partials/npc_chat_content.html
Normal file
@@ -0,0 +1,120 @@
|
||||
{#
|
||||
NPC Chat Content (Shared Partial)
|
||||
Used by both modal and dedicated page views
|
||||
Displays NPC profile, conversation interface, and message history
|
||||
#}
|
||||
<div class="npc-chat-container">
|
||||
{# Left Column: NPC Profile #}
|
||||
<div class="npc-profile">
|
||||
{# NPC Portrait #}
|
||||
<div class="npc-portrait">
|
||||
{% if npc.image_url %}
|
||||
<img src="{{ npc.image_url }}" alt="{{ npc.name }}">
|
||||
{% else %}
|
||||
<div class="npc-portrait-placeholder">
|
||||
{{ npc.name[0] }}
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
{# NPC Info #}
|
||||
<div class="npc-profile-info">
|
||||
<div class="npc-profile-role">{{ npc.role }}</div>
|
||||
{% if npc.appearance %}
|
||||
<div class="npc-profile-appearance">{{ npc.appearance }}</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
{# NPC Tags #}
|
||||
{% if npc.tags %}
|
||||
<div class="npc-profile-tags">
|
||||
{% for tag in npc.tags %}
|
||||
<span class="npc-profile-tag">{{ tag }}</span>
|
||||
{% endfor %}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
{# Relationship Meter #}
|
||||
<div class="npc-relationship">
|
||||
<div class="relationship-header">
|
||||
<span class="relationship-label">Relationship</span>
|
||||
<span class="relationship-value">{{ relationship_level|default(50) }}/100</span>
|
||||
</div>
|
||||
<div class="relationship-bar">
|
||||
<div class="relationship-fill" style="width: {{ relationship_level|default(50) }}%"></div>
|
||||
</div>
|
||||
<div class="relationship-status">
|
||||
{% set level = relationship_level|default(50) %}
|
||||
{% if level >= 80 %}
|
||||
<span class="status-friendly">Trusted Ally</span>
|
||||
{% elif level >= 60 %}
|
||||
<span class="status-friendly">Friendly</span>
|
||||
{% elif level >= 40 %}
|
||||
<span class="status-neutral">Neutral</span>
|
||||
{% elif level >= 20 %}
|
||||
<span class="status-unfriendly">Wary</span>
|
||||
{% else %}
|
||||
<span class="status-unfriendly">Hostile</span>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{# Interaction Stats #}
|
||||
<div class="npc-interaction-stats">
|
||||
<div class="interaction-stat">
|
||||
<span class="stat-label">Conversations</span>
|
||||
<span class="stat-value">{{ interaction_count|default(0) }}</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{# Center Column: Conversation #}
|
||||
<div class="npc-conversation">
|
||||
{# Conversation History #}
|
||||
<div class="chat-history" id="chat-history-{{ npc.npc_id }}">
|
||||
{% if conversation_history %}
|
||||
{% for msg in conversation_history %}
|
||||
<div class="chat-message chat-message--{{ msg.speaker }}">
|
||||
<strong>{{ msg.speaker_name }}:</strong> {{ msg.text }}
|
||||
</div>
|
||||
{% endfor %}
|
||||
{% else %}
|
||||
<div class="chat-empty-state">
|
||||
Start a conversation with {{ npc.name }}
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
{# Chat Input #}
|
||||
<form class="chat-input-form"
|
||||
hx-post="{{ url_for('game.talk_to_npc', session_id=session_id, npc_id=npc.npc_id) }}"
|
||||
hx-target="#chat-history-{{ npc.npc_id }}"
|
||||
hx-swap="beforeend">
|
||||
<input type="text"
|
||||
name="player_response"
|
||||
class="chat-input"
|
||||
placeholder="Say something..."
|
||||
autocomplete="off"
|
||||
autofocus>
|
||||
<button type="submit" class="chat-send-btn">Send</button>
|
||||
<button type="button"
|
||||
class="chat-greet-btn"
|
||||
hx-post="{{ url_for('game.talk_to_npc', session_id=session_id, npc_id=npc.npc_id) }}"
|
||||
hx-vals='{"topic": "greeting"}'
|
||||
hx-target="#chat-history-{{ npc.npc_id }}"
|
||||
hx-swap="beforeend">
|
||||
Greet
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
|
||||
{# Right Column: Message History Sidebar #}
|
||||
<aside class="npc-history-panel htmx-indicator"
|
||||
id="npc-history-{{ npc.npc_id }}"
|
||||
hx-get="{{ url_for('game.npc_chat_history', session_id=session_id, npc_id=npc.npc_id) }}"
|
||||
hx-trigger="load, newMessage from:body"
|
||||
hx-swap="innerHTML">
|
||||
{# History loaded via HTMX #}
|
||||
<div class="history-loading">Loading history...</div>
|
||||
</aside>
|
||||
</div>
|
||||
29
public_web/templates/game/partials/npc_chat_history.html
Normal file
29
public_web/templates/game/partials/npc_chat_history.html
Normal file
@@ -0,0 +1,29 @@
|
||||
{#
|
||||
NPC Chat History Sidebar
|
||||
Shows last 5 messages in compact cards with timestamps
|
||||
#}
|
||||
<div class="chat-history-sidebar">
|
||||
<h4 class="history-header">Recent Messages</h4>
|
||||
|
||||
{% if messages %}
|
||||
<div class="history-list">
|
||||
{% for msg in messages|reverse %}
|
||||
<div class="history-card">
|
||||
<div class="history-timestamp">
|
||||
{{ msg.timestamp|format_timestamp }}
|
||||
</div>
|
||||
<div class="history-player">
|
||||
<strong>You:</strong> {{ msg.player_message|truncate(60) }}
|
||||
</div>
|
||||
<div class="history-npc">
|
||||
<strong>NPC:</strong> {{ msg.npc_response|truncate(60) }}
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
{% else %}
|
||||
<div class="history-empty">
|
||||
No previous messages
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
@@ -1,120 +1,19 @@
|
||||
{#
|
||||
NPC Chat Modal (Expanded)
|
||||
Shows NPC profile with portrait, relationship meter, and conversation interface
|
||||
Uses shared content partial for consistency with dedicated page view
|
||||
#}
|
||||
<div class="modal-overlay" onclick="if(event.target === this) closeModal()">
|
||||
<div class="modal-content modal-content--lg">
|
||||
<div class="modal-content modal-content--xl">
|
||||
{# Modal Header #}
|
||||
<div class="modal-header">
|
||||
<h3 class="modal-title">{{ npc.name }}</h3>
|
||||
<button class="modal-close" onclick="closeModal()">×</button>
|
||||
</div>
|
||||
|
||||
{# Modal Body - Two Column Layout #}
|
||||
<div class="modal-body npc-modal-body">
|
||||
{# Left Column: NPC Profile #}
|
||||
<div class="npc-profile">
|
||||
{# NPC Portrait #}
|
||||
<div class="npc-portrait">
|
||||
{% if npc.image_url %}
|
||||
<img src="{{ npc.image_url }}" alt="{{ npc.name }}">
|
||||
{% else %}
|
||||
<div class="npc-portrait-placeholder">
|
||||
{{ npc.name[0] }}
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
{# NPC Info #}
|
||||
<div class="npc-profile-info">
|
||||
<div class="npc-profile-role">{{ npc.role }}</div>
|
||||
{% if npc.appearance %}
|
||||
<div class="npc-profile-appearance">{{ npc.appearance }}</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
{# NPC Tags #}
|
||||
{% if npc.tags %}
|
||||
<div class="npc-profile-tags">
|
||||
{% for tag in npc.tags %}
|
||||
<span class="npc-profile-tag">{{ tag }}</span>
|
||||
{% endfor %}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
{# Relationship Meter #}
|
||||
<div class="npc-relationship">
|
||||
<div class="relationship-header">
|
||||
<span class="relationship-label">Relationship</span>
|
||||
<span class="relationship-value">{{ relationship_level|default(50) }}/100</span>
|
||||
</div>
|
||||
<div class="relationship-bar">
|
||||
<div class="relationship-fill" style="width: {{ relationship_level|default(50) }}%"></div>
|
||||
</div>
|
||||
<div class="relationship-status">
|
||||
{% set level = relationship_level|default(50) %}
|
||||
{% if level >= 80 %}
|
||||
<span class="status-friendly">Trusted Ally</span>
|
||||
{% elif level >= 60 %}
|
||||
<span class="status-friendly">Friendly</span>
|
||||
{% elif level >= 40 %}
|
||||
<span class="status-neutral">Neutral</span>
|
||||
{% elif level >= 20 %}
|
||||
<span class="status-unfriendly">Wary</span>
|
||||
{% else %}
|
||||
<span class="status-unfriendly">Hostile</span>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{# Interaction Stats #}
|
||||
<div class="npc-interaction-stats">
|
||||
<div class="interaction-stat">
|
||||
<span class="stat-label">Conversations</span>
|
||||
<span class="stat-value">{{ interaction_count|default(0) }}</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{# Right Column: Conversation #}
|
||||
<div class="npc-conversation">
|
||||
{# Conversation History #}
|
||||
<div class="chat-history" id="chat-history-{{ npc.npc_id }}">
|
||||
{% if conversation_history %}
|
||||
{% for msg in conversation_history %}
|
||||
<div class="chat-message chat-message--{{ msg.speaker }}">
|
||||
<strong>{{ msg.speaker_name }}:</strong> {{ msg.text }}
|
||||
</div>
|
||||
{% endfor %}
|
||||
{% else %}
|
||||
<div class="chat-empty-state">
|
||||
Start a conversation with {{ npc.name }}
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
{# Chat Input #}
|
||||
<form class="chat-input-form"
|
||||
hx-post="{{ url_for('game.talk_to_npc', session_id=session_id, npc_id=npc.npc_id) }}"
|
||||
hx-target="#chat-history-{{ npc.npc_id }}"
|
||||
hx-swap="beforeend">
|
||||
<input type="text"
|
||||
name="player_response"
|
||||
class="chat-input"
|
||||
placeholder="Say something..."
|
||||
autocomplete="off"
|
||||
autofocus>
|
||||
<button type="submit" class="chat-send-btn">Send</button>
|
||||
<button type="button"
|
||||
class="chat-greet-btn"
|
||||
hx-post="{{ url_for('game.talk_to_npc', session_id=session_id, npc_id=npc.npc_id) }}"
|
||||
hx-vals='{"topic": "greeting"}'
|
||||
hx-target="#chat-history-{{ npc.npc_id }}"
|
||||
hx-swap="beforeend">
|
||||
Greet
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
{# Modal Body - Uses shared content partial #}
|
||||
<div class="modal-body npc-modal-body npc-modal-body--three-col">
|
||||
{% include 'game/partials/npc_chat_content.html' %}
|
||||
</div>
|
||||
|
||||
{# Modal Footer #}
|
||||
|
||||
@@ -11,46 +11,23 @@ Expected context:
|
||||
- session_id: For any follow-up actions
|
||||
#}
|
||||
|
||||
<div class="npc-dialogue-response">
|
||||
<div class="npc-dialogue-header">
|
||||
<span class="npc-dialogue-title">{{ npc_name }} says:</span>
|
||||
</div>
|
||||
|
||||
<div class="npc-dialogue-content">
|
||||
{# Show conversation history if present #}
|
||||
{% if conversation_history %}
|
||||
<div class="conversation-history">
|
||||
{% for exchange in conversation_history[-3:] %}
|
||||
<div class="history-exchange">
|
||||
<div class="history-player">
|
||||
<span class="speaker player">{{ character_name }}:</span>
|
||||
<span class="text">{{ exchange.player_line }}</span>
|
||||
</div>
|
||||
<div class="history-npc">
|
||||
<span class="speaker npc">{{ npc_name }}:</span>
|
||||
<span class="text">{{ exchange.npc_response }}</span>
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
{# Show current exchange #}
|
||||
<div class="current-exchange">
|
||||
{# Only show CURRENT exchange (removed conversation_history loop) #}
|
||||
<div class="current-exchange">
|
||||
{% if player_line %}
|
||||
<div class="player-message">
|
||||
<span class="speaker player">{{ character_name }}:</span>
|
||||
<span class="text">{{ player_line }}</span>
|
||||
<div class="chat-message chat-message--player">
|
||||
<strong>{{ character_name }}:</strong> {{ player_line }}
|
||||
</div>
|
||||
{% endif %}
|
||||
<div class="npc-message">
|
||||
<span class="speaker npc">{{ npc_name }}:</span>
|
||||
<span class="text">{{ dialogue }}</span>
|
||||
</div>
|
||||
</div>
|
||||
<div class="chat-message chat-message--npc">
|
||||
<strong>{{ npc_name }}:</strong> {{ dialogue }}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{# Trigger history refresh after new message #}
|
||||
<div hx-trigger="load"
|
||||
_="on load trigger newMessage on body"
|
||||
style="display: none;"></div>
|
||||
|
||||
{# Trigger sidebar refreshes after NPC dialogue #}
|
||||
<div hx-get="{{ url_for('game.npcs_accordion', session_id=session_id) }}"
|
||||
hx-trigger="load"
|
||||
|
||||
@@ -1,14 +1,15 @@
|
||||
{#
|
||||
NPCs Accordion Content
|
||||
Shows NPCs at current location with click to chat
|
||||
Uses responsive navigation: modals on desktop, full pages on mobile
|
||||
#}
|
||||
{% if npcs %}
|
||||
<div class="npc-list">
|
||||
{% for npc in npcs %}
|
||||
<div class="npc-item"
|
||||
hx-get="{{ url_for('game.npc_chat_modal', session_id=session_id, npc_id=npc.npc_id) }}"
|
||||
hx-target="#modal-container"
|
||||
hx-swap="innerHTML">
|
||||
data-npc-id="{{ npc.npc_id }}"
|
||||
onclick="navigateResponsive(event, '{{ url_for('game.npc_chat_page', session_id=session_id, npc_id=npc.npc_id) }}', '{{ url_for('game.npc_chat_modal', session_id=session_id, npc_id=npc.npc_id) }}')"
|
||||
style="cursor: pointer;">
|
||||
<div class="npc-name">{{ npc.name }}</div>
|
||||
<div class="npc-role">{{ npc.role }}</div>
|
||||
<div class="npc-appearance">{{ npc.appearance }}</div>
|
||||
|
||||
@@ -149,4 +149,7 @@ document.addEventListener('keydown', function(e) {
|
||||
}
|
||||
});
|
||||
</script>
|
||||
|
||||
<!-- Responsive Modal Navigation -->
|
||||
<script src="{{ url_for('static', filename='js/responsive-modals.js') }}"></script>
|
||||
{% endblock %}
|
||||
|
||||
Reference in New Issue
Block a user