forked from cardosofelipe/fast-next-template
feat(memory): add working memory implementation (Issue #89)
Implements session-scoped ephemeral memory with: Storage Backends: - InMemoryStorage: Thread-safe fallback with TTL support and capacity limits - RedisStorage: Primary storage with connection pooling and JSON serialization - Auto-fallback from Redis to in-memory when unavailable WorkingMemory Class: - Key-value storage with TTL and reserved key protection - Task state tracking with progress updates - Scratchpad for reasoning steps with timestamps - Checkpoint/snapshot support for recovery - Factory methods for auto-configured storage Tests: - 55 unit tests covering all functionality - Tests for basic ops, TTL, capacity, concurrency - Tests for task state, scratchpad, checkpoints 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -94,6 +94,22 @@ class MemoryStorageError(MemoryError):
|
||||
self.backend = backend
|
||||
|
||||
|
||||
class MemoryConnectionError(MemoryError):
|
||||
"""Raised when memory storage connection fails."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
message: str = "Memory connection failed",
|
||||
*,
|
||||
backend: str | None = None,
|
||||
host: str | None = None,
|
||||
**kwargs: Any,
|
||||
) -> None:
|
||||
super().__init__(message, **kwargs)
|
||||
self.backend = backend
|
||||
self.host = host
|
||||
|
||||
|
||||
class MemorySerializationError(MemoryError):
|
||||
"""Raised when memory serialization/deserialization fails."""
|
||||
|
||||
|
||||
@@ -1,8 +1,16 @@
|
||||
# app/services/memory/working/__init__.py
|
||||
"""
|
||||
Working Memory
|
||||
Working Memory Implementation.
|
||||
|
||||
Session-scoped ephemeral memory for current task state,
|
||||
variables, and scratchpad.
|
||||
Provides short-term memory storage with Redis primary and in-memory fallback.
|
||||
"""
|
||||
|
||||
# Will be populated in #89
|
||||
from .memory import WorkingMemory
|
||||
from .storage import InMemoryStorage, RedisStorage, WorkingMemoryStorage
|
||||
|
||||
__all__ = [
|
||||
"InMemoryStorage",
|
||||
"RedisStorage",
|
||||
"WorkingMemory",
|
||||
"WorkingMemoryStorage",
|
||||
]
|
||||
|
||||
543
backend/app/services/memory/working/memory.py
Normal file
543
backend/app/services/memory/working/memory.py
Normal file
@@ -0,0 +1,543 @@
|
||||
# app/services/memory/working/memory.py
|
||||
"""
|
||||
Working Memory Implementation.
|
||||
|
||||
Provides session-scoped ephemeral memory with:
|
||||
- Key-value storage with TTL
|
||||
- Task state tracking
|
||||
- Scratchpad for reasoning steps
|
||||
- Checkpoint/snapshot support
|
||||
"""
|
||||
|
||||
import logging
|
||||
import uuid
|
||||
from dataclasses import asdict
|
||||
from datetime import UTC, datetime
|
||||
from typing import Any
|
||||
|
||||
from app.services.memory.config import get_memory_settings
|
||||
from app.services.memory.exceptions import (
|
||||
MemoryConnectionError,
|
||||
MemoryNotFoundError,
|
||||
)
|
||||
from app.services.memory.types import ScopeContext, ScopeLevel, TaskState
|
||||
|
||||
from .storage import InMemoryStorage, RedisStorage, WorkingMemoryStorage
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# Reserved key prefixes for internal use
|
||||
_TASK_STATE_KEY = "_task_state"
|
||||
_SCRATCHPAD_KEY = "_scratchpad"
|
||||
_CHECKPOINT_PREFIX = "_checkpoint:"
|
||||
_METADATA_KEY = "_metadata"
|
||||
|
||||
|
||||
class WorkingMemory:
|
||||
"""
|
||||
Session-scoped working memory.
|
||||
|
||||
Provides ephemeral storage for agent's current task context:
|
||||
- Variables and intermediate data
|
||||
- Task state (current step, status, progress)
|
||||
- Scratchpad for reasoning steps
|
||||
- Checkpoints for recovery
|
||||
|
||||
Uses Redis as primary storage with in-memory fallback.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
scope: ScopeContext,
|
||||
storage: WorkingMemoryStorage,
|
||||
default_ttl_seconds: int | None = None,
|
||||
) -> None:
|
||||
"""
|
||||
Initialize working memory for a scope.
|
||||
|
||||
Args:
|
||||
scope: The scope context (session, agent instance, etc.)
|
||||
storage: Storage backend (use create() factory for auto-configuration)
|
||||
default_ttl_seconds: Default TTL for keys (None = no expiration)
|
||||
"""
|
||||
self._scope = scope
|
||||
self._storage: WorkingMemoryStorage = storage
|
||||
self._default_ttl = default_ttl_seconds
|
||||
self._using_fallback = False
|
||||
self._initialized = False
|
||||
|
||||
@classmethod
|
||||
async def create(
|
||||
cls,
|
||||
scope: ScopeContext,
|
||||
default_ttl_seconds: int | None = None,
|
||||
) -> "WorkingMemory":
|
||||
"""
|
||||
Factory method to create WorkingMemory with auto-configured storage.
|
||||
|
||||
Attempts Redis first, falls back to in-memory if unavailable.
|
||||
"""
|
||||
settings = get_memory_settings()
|
||||
key_prefix = f"wm:{scope.to_key_prefix()}:"
|
||||
storage: WorkingMemoryStorage
|
||||
|
||||
# Try Redis first
|
||||
if settings.working_memory_backend == "redis":
|
||||
redis_storage = RedisStorage(key_prefix=key_prefix)
|
||||
try:
|
||||
if await redis_storage.is_healthy():
|
||||
logger.debug(f"Using Redis storage for scope {scope.scope_id}")
|
||||
instance = cls(
|
||||
scope=scope,
|
||||
storage=redis_storage,
|
||||
default_ttl_seconds=default_ttl_seconds
|
||||
or settings.working_memory_default_ttl_seconds,
|
||||
)
|
||||
await instance._initialize()
|
||||
return instance
|
||||
except MemoryConnectionError:
|
||||
logger.warning("Redis unavailable, falling back to in-memory storage")
|
||||
await redis_storage.close()
|
||||
|
||||
# Fall back to in-memory
|
||||
storage = InMemoryStorage(
|
||||
max_keys=settings.working_memory_max_items_per_session
|
||||
)
|
||||
instance = cls(
|
||||
scope=scope,
|
||||
storage=storage,
|
||||
default_ttl_seconds=default_ttl_seconds
|
||||
or settings.working_memory_default_ttl_seconds,
|
||||
)
|
||||
instance._using_fallback = True
|
||||
await instance._initialize()
|
||||
return instance
|
||||
|
||||
@classmethod
|
||||
async def for_session(
|
||||
cls,
|
||||
session_id: str,
|
||||
project_id: str | None = None,
|
||||
agent_instance_id: str | None = None,
|
||||
) -> "WorkingMemory":
|
||||
"""
|
||||
Convenience factory for session-scoped working memory.
|
||||
|
||||
Args:
|
||||
session_id: Unique session identifier
|
||||
project_id: Optional project context
|
||||
agent_instance_id: Optional agent instance context
|
||||
"""
|
||||
# Build scope hierarchy
|
||||
parent = None
|
||||
if project_id:
|
||||
parent = ScopeContext(
|
||||
scope_type=ScopeLevel.PROJECT,
|
||||
scope_id=project_id,
|
||||
)
|
||||
if agent_instance_id:
|
||||
parent = ScopeContext(
|
||||
scope_type=ScopeLevel.AGENT_INSTANCE,
|
||||
scope_id=agent_instance_id,
|
||||
parent=parent,
|
||||
)
|
||||
|
||||
scope = ScopeContext(
|
||||
scope_type=ScopeLevel.SESSION,
|
||||
scope_id=session_id,
|
||||
parent=parent,
|
||||
)
|
||||
|
||||
return await cls.create(scope=scope)
|
||||
|
||||
async def _initialize(self) -> None:
|
||||
"""Initialize working memory metadata."""
|
||||
if self._initialized:
|
||||
return
|
||||
|
||||
metadata = {
|
||||
"scope_type": self._scope.scope_type.value,
|
||||
"scope_id": self._scope.scope_id,
|
||||
"created_at": datetime.now(UTC).isoformat(),
|
||||
"using_fallback": self._using_fallback,
|
||||
}
|
||||
await self._storage.set(_METADATA_KEY, metadata)
|
||||
self._initialized = True
|
||||
|
||||
@property
|
||||
def scope(self) -> ScopeContext:
|
||||
"""Get the scope context."""
|
||||
return self._scope
|
||||
|
||||
@property
|
||||
def is_using_fallback(self) -> bool:
|
||||
"""Check if using fallback in-memory storage."""
|
||||
return self._using_fallback
|
||||
|
||||
# =========================================================================
|
||||
# Basic Key-Value Operations
|
||||
# =========================================================================
|
||||
|
||||
async def set(
|
||||
self,
|
||||
key: str,
|
||||
value: Any,
|
||||
ttl_seconds: int | None = None,
|
||||
) -> None:
|
||||
"""
|
||||
Store a value.
|
||||
|
||||
Args:
|
||||
key: The key to store under
|
||||
value: The value to store (must be JSON-serializable)
|
||||
ttl_seconds: Optional TTL (uses default if not specified)
|
||||
"""
|
||||
if key.startswith("_"):
|
||||
raise ValueError("Keys starting with '_' are reserved for internal use")
|
||||
|
||||
ttl = ttl_seconds if ttl_seconds is not None else self._default_ttl
|
||||
await self._storage.set(key, value, ttl)
|
||||
|
||||
async def get(self, key: str, default: Any = None) -> Any:
|
||||
"""
|
||||
Get a value.
|
||||
|
||||
Args:
|
||||
key: The key to retrieve
|
||||
default: Default value if key not found
|
||||
|
||||
Returns:
|
||||
The stored value or default
|
||||
"""
|
||||
result = await self._storage.get(key)
|
||||
return result if result is not None else default
|
||||
|
||||
async def delete(self, key: str) -> bool:
|
||||
"""
|
||||
Delete a key.
|
||||
|
||||
Args:
|
||||
key: The key to delete
|
||||
|
||||
Returns:
|
||||
True if the key existed
|
||||
"""
|
||||
if key.startswith("_"):
|
||||
raise ValueError("Cannot delete internal keys directly")
|
||||
return await self._storage.delete(key)
|
||||
|
||||
async def exists(self, key: str) -> bool:
|
||||
"""
|
||||
Check if a key exists.
|
||||
|
||||
Args:
|
||||
key: The key to check
|
||||
|
||||
Returns:
|
||||
True if the key exists
|
||||
"""
|
||||
return await self._storage.exists(key)
|
||||
|
||||
async def list_keys(self, pattern: str = "*") -> list[str]:
|
||||
"""
|
||||
List keys matching a pattern.
|
||||
|
||||
Args:
|
||||
pattern: Glob-style pattern (default "*" for all)
|
||||
|
||||
Returns:
|
||||
List of matching keys (excludes internal keys)
|
||||
"""
|
||||
all_keys = await self._storage.list_keys(pattern)
|
||||
return [k for k in all_keys if not k.startswith("_")]
|
||||
|
||||
async def get_all(self) -> dict[str, Any]:
|
||||
"""
|
||||
Get all user key-value pairs.
|
||||
|
||||
Returns:
|
||||
Dictionary of all key-value pairs (excludes internal keys)
|
||||
"""
|
||||
all_data = await self._storage.get_all()
|
||||
return {k: v for k, v in all_data.items() if not k.startswith("_")}
|
||||
|
||||
async def clear(self) -> int:
|
||||
"""
|
||||
Clear all user keys (preserves internal state).
|
||||
|
||||
Returns:
|
||||
Number of keys deleted
|
||||
"""
|
||||
# Save internal state
|
||||
task_state = await self._storage.get(_TASK_STATE_KEY)
|
||||
scratchpad = await self._storage.get(_SCRATCHPAD_KEY)
|
||||
metadata = await self._storage.get(_METADATA_KEY)
|
||||
|
||||
count = await self._storage.clear()
|
||||
|
||||
# Restore internal state
|
||||
if metadata is not None:
|
||||
await self._storage.set(_METADATA_KEY, metadata)
|
||||
if task_state is not None:
|
||||
await self._storage.set(_TASK_STATE_KEY, task_state)
|
||||
if scratchpad is not None:
|
||||
await self._storage.set(_SCRATCHPAD_KEY, scratchpad)
|
||||
|
||||
# Adjust count for preserved keys
|
||||
preserved = sum(1 for x in [task_state, scratchpad, metadata] if x is not None)
|
||||
return max(0, count - preserved)
|
||||
|
||||
# =========================================================================
|
||||
# Task State Operations
|
||||
# =========================================================================
|
||||
|
||||
async def set_task_state(self, state: TaskState) -> None:
|
||||
"""
|
||||
Set the current task state.
|
||||
|
||||
Args:
|
||||
state: The task state to store
|
||||
"""
|
||||
state.updated_at = datetime.now(UTC)
|
||||
await self._storage.set(_TASK_STATE_KEY, asdict(state))
|
||||
|
||||
async def get_task_state(self) -> TaskState | None:
|
||||
"""
|
||||
Get the current task state.
|
||||
|
||||
Returns:
|
||||
The current TaskState or None if not set
|
||||
"""
|
||||
data = await self._storage.get(_TASK_STATE_KEY)
|
||||
if data is None:
|
||||
return None
|
||||
|
||||
# Convert datetime strings back to datetime objects
|
||||
if isinstance(data.get("started_at"), str):
|
||||
data["started_at"] = datetime.fromisoformat(data["started_at"])
|
||||
if isinstance(data.get("updated_at"), str):
|
||||
data["updated_at"] = datetime.fromisoformat(data["updated_at"])
|
||||
|
||||
return TaskState(**data)
|
||||
|
||||
async def update_task_progress(
|
||||
self,
|
||||
current_step: int | None = None,
|
||||
progress_percent: float | None = None,
|
||||
status: str | None = None,
|
||||
) -> TaskState | None:
|
||||
"""
|
||||
Update task progress fields.
|
||||
|
||||
Args:
|
||||
current_step: New current step number
|
||||
progress_percent: New progress percentage (0.0 to 100.0)
|
||||
status: New status string
|
||||
|
||||
Returns:
|
||||
Updated TaskState or None if no task state exists
|
||||
"""
|
||||
state = await self.get_task_state()
|
||||
if state is None:
|
||||
return None
|
||||
|
||||
if current_step is not None:
|
||||
state.current_step = current_step
|
||||
if progress_percent is not None:
|
||||
state.progress_percent = min(100.0, max(0.0, progress_percent))
|
||||
if status is not None:
|
||||
state.status = status
|
||||
|
||||
await self.set_task_state(state)
|
||||
return state
|
||||
|
||||
# =========================================================================
|
||||
# Scratchpad Operations
|
||||
# =========================================================================
|
||||
|
||||
async def append_scratchpad(self, content: str) -> None:
|
||||
"""
|
||||
Append content to the scratchpad.
|
||||
|
||||
Args:
|
||||
content: Text to append
|
||||
"""
|
||||
settings = get_memory_settings()
|
||||
entries = await self._storage.get(_SCRATCHPAD_KEY) or []
|
||||
|
||||
# Check capacity
|
||||
if len(entries) >= settings.working_memory_max_items_per_session:
|
||||
# Remove oldest entries
|
||||
entries = entries[-(settings.working_memory_max_items_per_session - 1) :]
|
||||
|
||||
entry = {
|
||||
"content": content,
|
||||
"timestamp": datetime.now(UTC).isoformat(),
|
||||
}
|
||||
entries.append(entry)
|
||||
await self._storage.set(_SCRATCHPAD_KEY, entries)
|
||||
|
||||
async def get_scratchpad(self) -> list[str]:
|
||||
"""
|
||||
Get all scratchpad entries.
|
||||
|
||||
Returns:
|
||||
List of scratchpad content strings (ordered by time)
|
||||
"""
|
||||
entries = await self._storage.get(_SCRATCHPAD_KEY) or []
|
||||
return [e["content"] for e in entries]
|
||||
|
||||
async def get_scratchpad_with_timestamps(self) -> list[dict[str, Any]]:
|
||||
"""
|
||||
Get all scratchpad entries with timestamps.
|
||||
|
||||
Returns:
|
||||
List of dicts with 'content' and 'timestamp' keys
|
||||
"""
|
||||
return await self._storage.get(_SCRATCHPAD_KEY) or []
|
||||
|
||||
async def clear_scratchpad(self) -> int:
|
||||
"""
|
||||
Clear the scratchpad.
|
||||
|
||||
Returns:
|
||||
Number of entries cleared
|
||||
"""
|
||||
entries = await self._storage.get(_SCRATCHPAD_KEY) or []
|
||||
count = len(entries)
|
||||
await self._storage.set(_SCRATCHPAD_KEY, [])
|
||||
return count
|
||||
|
||||
# =========================================================================
|
||||
# Checkpoint Operations
|
||||
# =========================================================================
|
||||
|
||||
async def create_checkpoint(self, description: str = "") -> str:
|
||||
"""
|
||||
Create a checkpoint of current state.
|
||||
|
||||
Args:
|
||||
description: Optional description of the checkpoint
|
||||
|
||||
Returns:
|
||||
Checkpoint ID for later restoration
|
||||
"""
|
||||
checkpoint_id = str(uuid.uuid4())[:8]
|
||||
checkpoint_key = f"{_CHECKPOINT_PREFIX}{checkpoint_id}"
|
||||
|
||||
# Capture all current state
|
||||
all_data = await self._storage.get_all()
|
||||
|
||||
checkpoint = {
|
||||
"id": checkpoint_id,
|
||||
"description": description,
|
||||
"created_at": datetime.now(UTC).isoformat(),
|
||||
"data": all_data,
|
||||
}
|
||||
|
||||
await self._storage.set(checkpoint_key, checkpoint)
|
||||
logger.debug(f"Created checkpoint {checkpoint_id}")
|
||||
return checkpoint_id
|
||||
|
||||
async def restore_checkpoint(self, checkpoint_id: str) -> None:
|
||||
"""
|
||||
Restore state from a checkpoint.
|
||||
|
||||
Args:
|
||||
checkpoint_id: ID of the checkpoint to restore
|
||||
|
||||
Raises:
|
||||
MemoryNotFoundError: If checkpoint not found
|
||||
"""
|
||||
checkpoint_key = f"{_CHECKPOINT_PREFIX}{checkpoint_id}"
|
||||
checkpoint = await self._storage.get(checkpoint_key)
|
||||
|
||||
if checkpoint is None:
|
||||
raise MemoryNotFoundError(f"Checkpoint {checkpoint_id} not found")
|
||||
|
||||
# Clear current state
|
||||
await self._storage.clear()
|
||||
|
||||
# Restore all data from checkpoint
|
||||
for key, value in checkpoint["data"].items():
|
||||
await self._storage.set(key, value)
|
||||
|
||||
# Keep the checkpoint itself
|
||||
await self._storage.set(checkpoint_key, checkpoint)
|
||||
|
||||
logger.debug(f"Restored checkpoint {checkpoint_id}")
|
||||
|
||||
async def list_checkpoints(self) -> list[dict[str, Any]]:
|
||||
"""
|
||||
List all available checkpoints.
|
||||
|
||||
Returns:
|
||||
List of checkpoint metadata (id, description, created_at)
|
||||
"""
|
||||
checkpoint_keys = await self._storage.list_keys(f"{_CHECKPOINT_PREFIX}*")
|
||||
checkpoints = []
|
||||
|
||||
for key in checkpoint_keys:
|
||||
data = await self._storage.get(key)
|
||||
if data:
|
||||
checkpoints.append(
|
||||
{
|
||||
"id": data["id"],
|
||||
"description": data["description"],
|
||||
"created_at": data["created_at"],
|
||||
}
|
||||
)
|
||||
|
||||
# Sort by creation time
|
||||
checkpoints.sort(key=lambda x: x["created_at"])
|
||||
return checkpoints
|
||||
|
||||
async def delete_checkpoint(self, checkpoint_id: str) -> bool:
|
||||
"""
|
||||
Delete a checkpoint.
|
||||
|
||||
Args:
|
||||
checkpoint_id: ID of the checkpoint to delete
|
||||
|
||||
Returns:
|
||||
True if checkpoint existed
|
||||
"""
|
||||
checkpoint_key = f"{_CHECKPOINT_PREFIX}{checkpoint_id}"
|
||||
return await self._storage.delete(checkpoint_key)
|
||||
|
||||
# =========================================================================
|
||||
# Health and Lifecycle
|
||||
# =========================================================================
|
||||
|
||||
async def is_healthy(self) -> bool:
|
||||
"""Check if the working memory storage is healthy."""
|
||||
return await self._storage.is_healthy()
|
||||
|
||||
async def close(self) -> None:
|
||||
"""Close the working memory storage."""
|
||||
if self._storage:
|
||||
await self._storage.close()
|
||||
|
||||
async def get_stats(self) -> dict[str, Any]:
|
||||
"""
|
||||
Get working memory statistics.
|
||||
|
||||
Returns:
|
||||
Dictionary with stats about current state
|
||||
"""
|
||||
all_keys = await self._storage.list_keys("*")
|
||||
user_keys = [k for k in all_keys if not k.startswith("_")]
|
||||
checkpoint_keys = [k for k in all_keys if k.startswith(_CHECKPOINT_PREFIX)]
|
||||
scratchpad = await self._storage.get(_SCRATCHPAD_KEY) or []
|
||||
|
||||
return {
|
||||
"scope_type": self._scope.scope_type.value,
|
||||
"scope_id": self._scope.scope_id,
|
||||
"using_fallback": self._using_fallback,
|
||||
"total_keys": len(all_keys),
|
||||
"user_keys": len(user_keys),
|
||||
"checkpoint_count": len(checkpoint_keys),
|
||||
"scratchpad_entries": len(scratchpad),
|
||||
"has_task_state": await self._storage.exists(_TASK_STATE_KEY),
|
||||
}
|
||||
406
backend/app/services/memory/working/storage.py
Normal file
406
backend/app/services/memory/working/storage.py
Normal file
@@ -0,0 +1,406 @@
|
||||
# app/services/memory/working/storage.py
|
||||
"""
|
||||
Working Memory Storage Backends.
|
||||
|
||||
Provides abstract storage interface and implementations:
|
||||
- RedisStorage: Primary storage using Redis with connection pooling
|
||||
- InMemoryStorage: Fallback storage when Redis is unavailable
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import fnmatch
|
||||
import json
|
||||
import logging
|
||||
from abc import ABC, abstractmethod
|
||||
from datetime import UTC, datetime, timedelta
|
||||
from typing import Any
|
||||
|
||||
from app.services.memory.config import get_memory_settings
|
||||
from app.services.memory.exceptions import (
|
||||
MemoryConnectionError,
|
||||
MemoryStorageError,
|
||||
)
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class WorkingMemoryStorage(ABC):
|
||||
"""Abstract base class for working memory storage backends."""
|
||||
|
||||
@abstractmethod
|
||||
async def set(
|
||||
self,
|
||||
key: str,
|
||||
value: Any,
|
||||
ttl_seconds: int | None = None,
|
||||
) -> None:
|
||||
"""Store a value with optional TTL."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
async def get(self, key: str) -> Any | None:
|
||||
"""Get a value by key, returns None if not found or expired."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
async def delete(self, key: str) -> bool:
|
||||
"""Delete a key, returns True if existed."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
async def exists(self, key: str) -> bool:
|
||||
"""Check if a key exists and is not expired."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
async def list_keys(self, pattern: str = "*") -> list[str]:
|
||||
"""List all keys matching a pattern."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
async def get_all(self) -> dict[str, Any]:
|
||||
"""Get all key-value pairs."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
async def clear(self) -> int:
|
||||
"""Clear all keys, returns count of deleted keys."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
async def is_healthy(self) -> bool:
|
||||
"""Check if the storage backend is healthy."""
|
||||
...
|
||||
|
||||
@abstractmethod
|
||||
async def close(self) -> None:
|
||||
"""Close the storage connection."""
|
||||
...
|
||||
|
||||
|
||||
class InMemoryStorage(WorkingMemoryStorage):
|
||||
"""
|
||||
In-memory storage backend for working memory.
|
||||
|
||||
Used as fallback when Redis is unavailable. Data is not persisted
|
||||
across restarts and is not shared between processes.
|
||||
"""
|
||||
|
||||
def __init__(self, max_keys: int = 10000) -> None:
|
||||
"""Initialize in-memory storage."""
|
||||
self._data: dict[str, Any] = {}
|
||||
self._expirations: dict[str, datetime] = {}
|
||||
self._max_keys = max_keys
|
||||
self._lock = asyncio.Lock()
|
||||
|
||||
def _is_expired(self, key: str) -> bool:
|
||||
"""Check if a key has expired."""
|
||||
if key not in self._expirations:
|
||||
return False
|
||||
return datetime.now(UTC) > self._expirations[key]
|
||||
|
||||
def _cleanup_expired(self) -> None:
|
||||
"""Remove all expired keys."""
|
||||
now = datetime.now(UTC)
|
||||
expired_keys = [
|
||||
key for key, exp_time in self._expirations.items() if now > exp_time
|
||||
]
|
||||
for key in expired_keys:
|
||||
self._data.pop(key, None)
|
||||
self._expirations.pop(key, None)
|
||||
|
||||
async def set(
|
||||
self,
|
||||
key: str,
|
||||
value: Any,
|
||||
ttl_seconds: int | None = None,
|
||||
) -> None:
|
||||
"""Store a value with optional TTL."""
|
||||
async with self._lock:
|
||||
# Cleanup expired keys periodically
|
||||
if len(self._data) % 100 == 0:
|
||||
self._cleanup_expired()
|
||||
|
||||
# Check capacity
|
||||
if key not in self._data and len(self._data) >= self._max_keys:
|
||||
# Evict expired keys first
|
||||
self._cleanup_expired()
|
||||
if len(self._data) >= self._max_keys:
|
||||
raise MemoryStorageError(
|
||||
f"Working memory capacity exceeded: {self._max_keys} keys"
|
||||
)
|
||||
|
||||
self._data[key] = value
|
||||
if ttl_seconds is not None:
|
||||
self._expirations[key] = datetime.now(UTC) + timedelta(
|
||||
seconds=ttl_seconds
|
||||
)
|
||||
elif key in self._expirations:
|
||||
# Remove existing expiration if no TTL specified
|
||||
del self._expirations[key]
|
||||
|
||||
async def get(self, key: str) -> Any | None:
|
||||
"""Get a value by key."""
|
||||
async with self._lock:
|
||||
if key not in self._data:
|
||||
return None
|
||||
if self._is_expired(key):
|
||||
del self._data[key]
|
||||
del self._expirations[key]
|
||||
return None
|
||||
return self._data[key]
|
||||
|
||||
async def delete(self, key: str) -> bool:
|
||||
"""Delete a key."""
|
||||
async with self._lock:
|
||||
existed = key in self._data
|
||||
self._data.pop(key, None)
|
||||
self._expirations.pop(key, None)
|
||||
return existed
|
||||
|
||||
async def exists(self, key: str) -> bool:
|
||||
"""Check if a key exists and is not expired."""
|
||||
async with self._lock:
|
||||
if key not in self._data:
|
||||
return False
|
||||
if self._is_expired(key):
|
||||
del self._data[key]
|
||||
del self._expirations[key]
|
||||
return False
|
||||
return True
|
||||
|
||||
async def list_keys(self, pattern: str = "*") -> list[str]:
|
||||
"""List all keys matching a pattern."""
|
||||
async with self._lock:
|
||||
self._cleanup_expired()
|
||||
if pattern == "*":
|
||||
return list(self._data.keys())
|
||||
return [key for key in self._data.keys() if fnmatch.fnmatch(key, pattern)]
|
||||
|
||||
async def get_all(self) -> dict[str, Any]:
|
||||
"""Get all key-value pairs."""
|
||||
async with self._lock:
|
||||
self._cleanup_expired()
|
||||
return dict(self._data)
|
||||
|
||||
async def clear(self) -> int:
|
||||
"""Clear all keys."""
|
||||
async with self._lock:
|
||||
count = len(self._data)
|
||||
self._data.clear()
|
||||
self._expirations.clear()
|
||||
return count
|
||||
|
||||
async def is_healthy(self) -> bool:
|
||||
"""In-memory storage is always healthy."""
|
||||
return True
|
||||
|
||||
async def close(self) -> None:
|
||||
"""No cleanup needed for in-memory storage."""
|
||||
|
||||
|
||||
class RedisStorage(WorkingMemoryStorage):
|
||||
"""
|
||||
Redis storage backend for working memory.
|
||||
|
||||
Primary storage with connection pooling, automatic reconnection,
|
||||
and proper serialization of Python objects.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
key_prefix: str = "",
|
||||
connection_timeout: float = 5.0,
|
||||
socket_timeout: float = 5.0,
|
||||
) -> None:
|
||||
"""
|
||||
Initialize Redis storage.
|
||||
|
||||
Args:
|
||||
key_prefix: Prefix for all keys (e.g., "session:abc123:")
|
||||
connection_timeout: Timeout for establishing connections
|
||||
socket_timeout: Timeout for socket operations
|
||||
"""
|
||||
self._key_prefix = key_prefix
|
||||
self._connection_timeout = connection_timeout
|
||||
self._socket_timeout = socket_timeout
|
||||
self._redis: Any = None
|
||||
self._lock = asyncio.Lock()
|
||||
|
||||
def _make_key(self, key: str) -> str:
|
||||
"""Add prefix to key."""
|
||||
return f"{self._key_prefix}{key}"
|
||||
|
||||
def _strip_prefix(self, key: str) -> str:
|
||||
"""Remove prefix from key."""
|
||||
if key.startswith(self._key_prefix):
|
||||
return key[len(self._key_prefix) :]
|
||||
return key
|
||||
|
||||
def _serialize(self, value: Any) -> str:
|
||||
"""Serialize a Python value to JSON string."""
|
||||
return json.dumps(value, default=str)
|
||||
|
||||
def _deserialize(self, data: str | bytes | None) -> Any | None:
|
||||
"""Deserialize a JSON string to Python value."""
|
||||
if data is None:
|
||||
return None
|
||||
if isinstance(data, bytes):
|
||||
data = data.decode("utf-8")
|
||||
return json.loads(data)
|
||||
|
||||
async def _get_client(self) -> Any:
|
||||
"""Get or create Redis client."""
|
||||
if self._redis is not None:
|
||||
return self._redis
|
||||
|
||||
async with self._lock:
|
||||
if self._redis is not None:
|
||||
return self._redis
|
||||
|
||||
try:
|
||||
import redis.asyncio as aioredis
|
||||
except ImportError as e:
|
||||
raise MemoryConnectionError(
|
||||
"redis package not installed. Install with: pip install redis"
|
||||
) from e
|
||||
|
||||
settings = get_memory_settings()
|
||||
redis_url = settings.redis_url
|
||||
|
||||
try:
|
||||
self._redis = await aioredis.from_url(
|
||||
redis_url,
|
||||
encoding="utf-8",
|
||||
decode_responses=True,
|
||||
socket_connect_timeout=self._connection_timeout,
|
||||
socket_timeout=self._socket_timeout,
|
||||
)
|
||||
# Test connection
|
||||
await self._redis.ping()
|
||||
logger.info("Connected to Redis for working memory")
|
||||
return self._redis
|
||||
except Exception as e:
|
||||
self._redis = None
|
||||
raise MemoryConnectionError(f"Failed to connect to Redis: {e}") from e
|
||||
|
||||
async def set(
|
||||
self,
|
||||
key: str,
|
||||
value: Any,
|
||||
ttl_seconds: int | None = None,
|
||||
) -> None:
|
||||
"""Store a value with optional TTL."""
|
||||
try:
|
||||
client = await self._get_client()
|
||||
full_key = self._make_key(key)
|
||||
serialized = self._serialize(value)
|
||||
|
||||
if ttl_seconds is not None:
|
||||
await client.setex(full_key, ttl_seconds, serialized)
|
||||
else:
|
||||
await client.set(full_key, serialized)
|
||||
except MemoryConnectionError:
|
||||
raise
|
||||
except Exception as e:
|
||||
raise MemoryStorageError(f"Failed to set key {key}: {e}") from e
|
||||
|
||||
async def get(self, key: str) -> Any | None:
|
||||
"""Get a value by key."""
|
||||
try:
|
||||
client = await self._get_client()
|
||||
full_key = self._make_key(key)
|
||||
data = await client.get(full_key)
|
||||
return self._deserialize(data)
|
||||
except MemoryConnectionError:
|
||||
raise
|
||||
except Exception as e:
|
||||
raise MemoryStorageError(f"Failed to get key {key}: {e}") from e
|
||||
|
||||
async def delete(self, key: str) -> bool:
|
||||
"""Delete a key."""
|
||||
try:
|
||||
client = await self._get_client()
|
||||
full_key = self._make_key(key)
|
||||
result = await client.delete(full_key)
|
||||
return bool(result)
|
||||
except MemoryConnectionError:
|
||||
raise
|
||||
except Exception as e:
|
||||
raise MemoryStorageError(f"Failed to delete key {key}: {e}") from e
|
||||
|
||||
async def exists(self, key: str) -> bool:
|
||||
"""Check if a key exists."""
|
||||
try:
|
||||
client = await self._get_client()
|
||||
full_key = self._make_key(key)
|
||||
result = await client.exists(full_key)
|
||||
return bool(result)
|
||||
except MemoryConnectionError:
|
||||
raise
|
||||
except Exception as e:
|
||||
raise MemoryStorageError(f"Failed to check key {key}: {e}") from e
|
||||
|
||||
async def list_keys(self, pattern: str = "*") -> list[str]:
|
||||
"""List all keys matching a pattern."""
|
||||
try:
|
||||
client = await self._get_client()
|
||||
full_pattern = self._make_key(pattern)
|
||||
keys = await client.keys(full_pattern)
|
||||
return [self._strip_prefix(key) for key in keys]
|
||||
except MemoryConnectionError:
|
||||
raise
|
||||
except Exception as e:
|
||||
raise MemoryStorageError(f"Failed to list keys: {e}") from e
|
||||
|
||||
async def get_all(self) -> dict[str, Any]:
|
||||
"""Get all key-value pairs."""
|
||||
try:
|
||||
client = await self._get_client()
|
||||
full_pattern = self._make_key("*")
|
||||
keys = await client.keys(full_pattern)
|
||||
|
||||
if not keys:
|
||||
return {}
|
||||
|
||||
values = await client.mget(*keys)
|
||||
result = {}
|
||||
for key, value in zip(keys, values, strict=False):
|
||||
stripped_key = self._strip_prefix(key)
|
||||
result[stripped_key] = self._deserialize(value)
|
||||
return result
|
||||
except MemoryConnectionError:
|
||||
raise
|
||||
except Exception as e:
|
||||
raise MemoryStorageError(f"Failed to get all keys: {e}") from e
|
||||
|
||||
async def clear(self) -> int:
|
||||
"""Clear all keys with this prefix."""
|
||||
try:
|
||||
client = await self._get_client()
|
||||
full_pattern = self._make_key("*")
|
||||
keys = await client.keys(full_pattern)
|
||||
|
||||
if not keys:
|
||||
return 0
|
||||
|
||||
return await client.delete(*keys)
|
||||
except MemoryConnectionError:
|
||||
raise
|
||||
except Exception as e:
|
||||
raise MemoryStorageError(f"Failed to clear keys: {e}") from e
|
||||
|
||||
async def is_healthy(self) -> bool:
|
||||
"""Check if Redis connection is healthy."""
|
||||
try:
|
||||
client = await self._get_client()
|
||||
await client.ping()
|
||||
return True
|
||||
except Exception:
|
||||
return False
|
||||
|
||||
async def close(self) -> None:
|
||||
"""Close the Redis connection."""
|
||||
if self._redis is not None:
|
||||
await self._redis.close()
|
||||
self._redis = None
|
||||
Reference in New Issue
Block a user