major-domo-v2/commands/voice/tracker.py
Cal Corum 5616cfec3a CLAUDE: Add automatic scorecard unpublishing when voice channels are cleaned up
This enhancement automatically unpublishes scorecards when their associated
voice channels are deleted by the cleanup service, ensuring data synchronization
and reducing unnecessary API calls to Google Sheets for inactive games.

Implementation:
- Added gameplay commands package with scorebug/scorecard functionality
- Created ScorebugService for reading live game data from Google Sheets
- VoiceChannelTracker now stores text_channel_id for voice-to-text association
- VoiceChannelCleanupService integrates ScorecardTracker for automatic cleanup
- LiveScorebugTracker monitors published scorecards and updates displays
- Bot initialization includes gameplay commands and live scorebug tracker

Key Features:
- Voice channels track associated text channel IDs
- cleanup_channel() unpublishes scorecards during normal cleanup
- verify_tracked_channels() unpublishes scorecards for stale entries on startup
- get_voice_channel_for_text_channel() enables reverse lookup
- LiveScorebugTracker logging improved (debug level for missing channels)

Testing:
- Added comprehensive test coverage (2 new tests, 19 total pass)
- Tests verify scorecard unpublishing in cleanup and verification scenarios

Documentation:
- Updated commands/voice/CLAUDE.md with scorecard cleanup integration
- Updated commands/gameplay/CLAUDE.md with background task integration
- Updated tasks/CLAUDE.md with automatic cleanup details

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-21 07:18:21 -05:00

250 lines
9.0 KiB
Python

"""
Voice Channel Tracker
Provides persistent tracking of bot-created voice channels using JSON file storage.
"""
import json
import logging
from datetime import datetime, timedelta, UTC
from pathlib import Path
from typing import Dict, List, Optional, Any
import discord
logger = logging.getLogger(f'{__name__}.VoiceChannelTracker')
class VoiceChannelTracker:
"""
Tracks bot-created voice channels with JSON file persistence.
Features:
- Persistent storage across bot restarts
- Channel creation and status tracking
- Cleanup candidate identification
- Automatic stale entry removal
"""
def __init__(self, data_file: str = "data/voice_channels.json"):
"""
Initialize the voice channel tracker.
Args:
data_file: Path to the JSON data file
"""
self.data_file = Path(data_file)
self.data_file.parent.mkdir(exist_ok=True)
self._data: Dict[str, Any] = {}
self.load_data()
def load_data(self) -> None:
"""Load channel data from JSON file."""
try:
if self.data_file.exists():
with open(self.data_file, 'r') as f:
self._data = json.load(f)
logger.debug(f"Loaded {len(self._data.get('voice_channels', {}))} tracked channels")
else:
self._data = {"voice_channels": {}}
logger.info("No existing voice channel data found, starting fresh")
except Exception as e:
logger.error(f"Failed to load voice channel data: {e}")
self._data = {"voice_channels": {}}
def save_data(self) -> None:
"""Save channel data to JSON file."""
try:
with open(self.data_file, 'w') as f:
json.dump(self._data, f, indent=2, default=str)
logger.debug("Voice channel data saved successfully")
except Exception as e:
logger.error(f"Failed to save voice channel data: {e}")
def add_channel(
self,
channel: discord.VoiceChannel,
channel_type: str,
creator_id: int,
text_channel_id: Optional[int] = None
) -> None:
"""
Add a new channel to tracking.
Args:
channel: Discord voice channel object
channel_type: Type of channel ('public' or 'private')
creator_id: Discord user ID who created the channel
text_channel_id: Optional Discord text channel ID associated with this voice channel
"""
self._data.setdefault("voice_channels", {})[str(channel.id)] = {
"channel_id": str(channel.id),
"guild_id": str(channel.guild.id),
"name": channel.name,
"type": channel_type,
"created_at": datetime.now(UTC).isoformat(),
"last_checked": datetime.now(UTC).isoformat(),
"empty_since": None,
"creator_id": str(creator_id),
"text_channel_id": str(text_channel_id) if text_channel_id else None
}
self.save_data()
logger.info(f"Added channel to tracking: {channel.name} (ID: {channel.id})")
def update_channel_status(self, channel_id: int, is_empty: bool) -> None:
"""
Update channel empty status.
Args:
channel_id: Discord channel ID
is_empty: Whether the channel is currently empty
"""
channels = self._data.get("voice_channels", {})
channel_key = str(channel_id)
if channel_key in channels:
channel_data = channels[channel_key]
channel_data["last_checked"] = datetime.now(UTC).isoformat()
if is_empty and channel_data["empty_since"] is None:
# Channel just became empty
channel_data["empty_since"] = datetime.now(UTC).isoformat()
logger.debug(f"Channel {channel_data['name']} became empty")
elif not is_empty and channel_data["empty_since"] is not None:
# Channel is no longer empty
channel_data["empty_since"] = None
logger.debug(f"Channel {channel_data['name']} is no longer empty")
self.save_data()
def remove_channel(self, channel_id: int) -> None:
"""
Remove channel from tracking.
Args:
channel_id: Discord channel ID
"""
channels = self._data.get("voice_channels", {})
channel_key = str(channel_id)
if channel_key in channels:
channel_name = channels[channel_key]["name"]
del channels[channel_key]
self.save_data()
logger.info(f"Removed channel from tracking: {channel_name} (ID: {channel_id})")
def get_channels_for_cleanup(self, empty_threshold_minutes: int = 15) -> List[Dict[str, Any]]:
"""
Get channels that should be deleted based on empty duration.
Args:
empty_threshold_minutes: Minutes a channel must be empty before cleanup
Returns:
List of channel data dictionaries ready for cleanup
"""
cleanup_candidates = []
cutoff_time = datetime.now(UTC) - timedelta(minutes=empty_threshold_minutes)
# Remove timezone info for comparison (to match existing naive timestamps)
cutoff_time = cutoff_time.replace(tzinfo=None)
for channel_data in self._data.get("voice_channels", {}).values():
if channel_data["empty_since"]:
try:
# Parse empty_since timestamp
empty_since_str = channel_data["empty_since"]
# Handle both with and without timezone info
if empty_since_str.endswith('Z'):
empty_since_str = empty_since_str[:-1] + '+00:00'
empty_since = datetime.fromisoformat(empty_since_str.replace('Z', '+00:00'))
# Remove timezone info for comparison (both times are UTC)
if empty_since.tzinfo:
empty_since = empty_since.replace(tzinfo=None)
if empty_since <= cutoff_time:
cleanup_candidates.append(channel_data)
logger.debug(f"Channel {channel_data['name']} ready for cleanup (empty since {empty_since})")
except (ValueError, TypeError) as e:
logger.warning(f"Invalid timestamp for channel {channel_data.get('name', 'unknown')}: {e}")
return cleanup_candidates
def get_all_tracked_channels(self) -> List[Dict[str, Any]]:
"""
Get all currently tracked channels.
Returns:
List of all tracked channel data dictionaries
"""
return list(self._data.get("voice_channels", {}).values())
def get_tracked_channel(self, channel_id: int) -> Optional[Dict[str, Any]]:
"""
Get data for a specific tracked channel.
Args:
channel_id: Discord channel ID
Returns:
Channel data dictionary or None if not tracked
"""
channels = self._data.get("voice_channels", {})
return channels.get(str(channel_id))
def get_voice_channel_for_text_channel(self, text_channel_id: int) -> Optional[int]:
"""
Get voice channel ID associated with a text channel.
Args:
text_channel_id: Discord text channel ID
Returns:
Voice channel ID if found, None otherwise
"""
channels = self._data.get("voice_channels", {})
for voice_channel_id_str, channel_data in channels.items():
stored_text_channel_id = channel_data.get("text_channel_id")
if stored_text_channel_id:
try:
if int(stored_text_channel_id) == text_channel_id:
return int(voice_channel_id_str)
except (ValueError, TypeError):
continue
return None
def cleanup_stale_entries(self, valid_channel_ids: List[int]) -> int:
"""
Remove tracking entries for channels that no longer exist.
Args:
valid_channel_ids: List of channel IDs that still exist in Discord
Returns:
Number of stale entries removed
"""
channels = self._data.get("voice_channels", {})
stale_entries = []
for channel_id_str, channel_data in channels.items():
try:
channel_id = int(channel_id_str)
if channel_id not in valid_channel_ids:
stale_entries.append(channel_id_str)
except (ValueError, TypeError):
logger.warning(f"Invalid channel ID in tracking data: {channel_id_str}")
stale_entries.append(channel_id_str)
# Remove stale entries
for channel_id_str in stale_entries:
channel_name = channels[channel_id_str].get("name", "unknown")
del channels[channel_id_str]
logger.info(f"Removed stale tracking entry: {channel_name} (ID: {channel_id_str})")
if stale_entries:
self.save_data()
return len(stale_entries)