didier/database/utils/caches.py

155 lines
5.1 KiB
Python

from abc import ABC, abstractmethod
from discord import app_commands
from overrides import overrides
from sqlalchemy.ext.asyncio import AsyncSession
from database.crud import easter_eggs, links, memes, ufora_courses
from database.schemas import EasterEgg
__all__ = ["CacheManager", "EasterEggCache", "LinkCache", "UforaCourseCache"]
class DatabaseCache(ABC):
"""Base class for a simple cache-like structure
The goal of this class is to store data for Discord auto-completion results
that would otherwise potentially put heavy load on the database.
This only stores strings, to avoid having to constantly refresh these objects.
Once a choice has been made, it can just be pulled out of the database.
Considering the fact that a user isn't obligated to choose something from the suggestions,
chances are high we have to go to the database for the final action either way.
Also stores the data in lowercase to allow fast searching.
"""
data: list[str] = []
data_transformed: list[str] = []
def clear(self):
"""Remove everything"""
self.data.clear()
@abstractmethod
async def invalidate(self, database_session: AsyncSession):
"""Invalidate the data stored in this cache"""
def get_autocomplete_suggestions(self, query: str) -> list[app_commands.Choice[str]]:
"""Filter the cache to find everything that matches the search query"""
query = query.lower()
# Return the original (non-transformed) version of the data for pretty display in Discord
suggestions = [self.data[index] for index, value in enumerate(self.data_transformed) if query in value][:25]
return [app_commands.Choice(name=suggestion, value=suggestion.lower()) for suggestion in suggestions]
class EasterEggCache(DatabaseCache):
"""Cache to store easter eggs invoked by messages"""
easter_eggs: list[EasterEgg] = []
@overrides
async def clear(self):
self.easter_eggs.clear()
@overrides
async def invalidate(self, database_session: AsyncSession):
"""Invalidate the data stored in this cache"""
await self.clear()
self.easter_eggs = await easter_eggs.get_all_easter_eggs(database_session)
class LinkCache(DatabaseCache):
"""Cache to store the names of links"""
@overrides
async def invalidate(self, database_session: AsyncSession):
self.clear()
all_links = await links.get_all_links(database_session)
self.data = list(map(lambda l: l.name, all_links))
self.data.sort()
self.data_transformed = list(map(str.lower, self.data))
class MemeCache(DatabaseCache):
"""Cache to store the names of meme templates"""
@overrides
async def invalidate(self, database_session: AsyncSession):
self.clear()
all_memes = await memes.get_all_memes(database_session)
self.data = list(map(lambda m: m.name, all_memes))
self.data.sort()
self.data_transformed = list(map(str.lower, self.data))
class UforaCourseCache(DatabaseCache):
"""Cache to store the names of Ufora courses"""
# Also store the aliases to add additional support
aliases: dict[str, str] = {}
@overrides
def clear(self):
self.aliases.clear()
super().clear()
@overrides
async def invalidate(self, database_session: AsyncSession):
self.clear()
courses = await ufora_courses.get_all_courses(database_session)
self.data = list(map(lambda c: c.name, courses))
# Load the aliases
for course in courses:
for alias in course.aliases:
# Store aliases in lowercase
self.aliases[alias.alias.lower()] = course.name
self.data.sort()
self.data_transformed = list(map(str.lower, self.data))
@overrides
def get_autocomplete_suggestions(self, query: str) -> list[app_commands.Choice[str]]:
query = query.lower()
results = set()
# Return the original (not-lowercase) version
for index, course in enumerate(self.data_transformed):
if query in course:
results.add(self.data[index])
for alias, course in self.aliases.items():
if query in alias:
results.add(course)
suggestions = sorted(list(results))[:25]
return [app_commands.Choice(name=suggestion, value=suggestion.lower()) for suggestion in suggestions]
class CacheManager:
"""Class that keeps track of all caches"""
easter_eggs: EasterEggCache
links: LinkCache
memes: MemeCache
ufora_courses: UforaCourseCache
def __init__(self):
self.easter_eggs = EasterEggCache()
self.links = LinkCache()
self.memes = MemeCache()
self.ufora_courses = UforaCourseCache()
async def initialize_caches(self, postgres_session: AsyncSession):
"""Initialize the contents of all caches"""
await self.easter_eggs.invalidate(postgres_session)
await self.links.invalidate(postgres_session)
await self.memes.invalidate(postgres_session)
await self.ufora_courses.invalidate(postgres_session)