Compare commits

...

3 commits

17 changed files with 1793 additions and 1017 deletions

View file

@ -2,7 +2,7 @@ files: src|tests
exclude: ^$
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v6.0.0
hooks:
- id: trailing-whitespace
args: [ --markdown-linebreak-ext=md ]

View file

@ -2,7 +2,24 @@
All notable changes to this project will be documented in this file.
## [unreleased]
## [0.3.6] - 2025-06-06
### 🚀 Features
- Add `Quote.is_active` field
## [0.3.5] - 2025-05-27
### 🚀 Features
- Implement remaining repo methods for chatbot and quote
- Add ANO_PREFIX bot response
### ⚙️ Miscellaneous Tasks
- Add renovate lockFileMaintenance
## [0.3.3] - 2025-03-06
### 🐛 Bug Fixes

View file

@ -16,7 +16,7 @@ ENV PYTHONPATH="$APP_PATH"
ENV PATH="$APP_HOME/.local/bin:$PATH"
# hadolint ignore=DL3001,DL3008,DL3018
RUN apk add --no-cache make python3~=3.12 curl \
RUN apk add --no-cache make python3~=3.13 curl git \
&& adduser -S -u "$USERID" -h "$APP_HOME" "$USERNAME" \
&& mkdir -p "$APP_PATH" \
&& chown -R "$USERID:$GROUPID" "$APP_PATH"

View file

@ -11,6 +11,9 @@ fmt--mypy:
fmt--add-noqa:
uvx ruff check --add-noqa .
fmt--autoupdate:
uvx pre-commit autoupdate
.PHONY: tests
tests:

View file

@ -1,6 +1,6 @@
apiVersion: v2
appVersion: 0.3.5
appVersion: 0.3.7
description: A Helm chart for Kubernetes
name: huesoporro
type: application
version: 0.3.5
version: 0.3.7

View file

@ -8,7 +8,7 @@ fullnameOverride: ''
image:
pullPolicy: Always
repository: git.roboces.dev/catalin/huesoporro
tag: 0.3.5
tag: 0.3.7
imagePullSecrets: []
ingress:
annotations: {}

View file

@ -0,0 +1,21 @@
"""
This module contains a Caribou migration.
Migration Name: active_quotes
Migration Version: 20250606143836
"""
def upgrade(connection):
# add `is_active` column to the `quotes` table
sql = """
ALTER TABLE quotes
ADD COLUMN is_active BOOLEAN DEFAULT TRUE;
"""
connection.execute(sql)
connection.commit()
def downgrade(connection):
# add your downgrade step here
pass

View file

@ -1,6 +1,6 @@
[project]
name = "huesoporro"
version = "0.3.5"
version = "0.3.7"
description = "Misc Twitch bot"
readme = "README.md"
authors = [
@ -19,12 +19,13 @@ dependencies = [
"caribou>=0.4.1",
"aiosqlite>=0.20.0",
"pyjwt>=2.10.1",
"twitchio>=2.10.0",
"twitchio==2.10.0",
"redis>=5.2.1",
"pytz>=2024.2",
"discord-py>=2.4.0",
"tenacity>=9.0.0",
"uvicorn>=0.34.0",
"sniffio>=1.3.1",
]
[project.scripts]

View file

@ -12,8 +12,14 @@ class CreateQuoteAction(BaseModel):
create_quote_svc: CreateQuoteSvc
is_mod_svc: IsModSvc
async def run(
self, user: User, channel: str, quote: str, author: str, username: str
async def run( # noqa: PLR0913
self,
user: User,
channel: str,
quote: str,
author: str,
username: str,
is_active: bool = True,
) -> Quote | None:
if not await self.is_mod_svc.run(user=user, username=username, channel=channel):
return None
@ -23,6 +29,7 @@ class CreateQuoteAction(BaseModel):
author=author,
channel_name=channel,
created_at=datetime.datetime.now(datetime.UTC),
is_active=is_active,
last_updated_at=datetime.datetime.now(datetime.UTC),
)
return await self.create_quote_svc.run(new_quote)

View file

@ -11,7 +11,7 @@ from tenacity import (
stop_after_attempt,
wait_exponential,
)
from twitchio import Channel
from twitchio import Channel, Message
from twitchio.ext import commands, routines
from huesoporro.actions.quotes.create_quote_action import CreateQuoteAction
@ -172,6 +172,12 @@ class MessageHandler:
"xdd",
"xdding",
]
self.ano_suffix_reply_patterns = [
"me la agarras con la mano. venga, tira",
"me la agarras con la mano, espabila",
"me la agarras con la mano y te falta calle",
"vegetasmile",
]
self.send = channel_send_func
def get_message_type(self, content: str) -> MessageType:
@ -188,9 +194,12 @@ class MessageHandler:
return MessageType.LAUGH
return MessageType.OTHER
async def handle_laugh(self) -> str:
def handle_laugh(self) -> str:
return random.choice(self.laugh_patterns) # noqa: S311
def handle_ano_suffix(self) -> str:
return random.choice(self.ano_suffix_reply_patterns) # noqa: S311
class SaveMessagesCog(commands.Cog):
def __init__(self, bot: Bot):
@ -226,6 +235,36 @@ class SaveMessagesCog(commands.Cog):
if hasattr(self, "current_message"):
await self.current_message.channel.send(content)
def is_bot_mention(self, tok: str) -> bool:
return tok.lower() == str(self.bot.nick).lower()
async def _handle_bot_mention(self, message: Message) -> str | None:
content = (message.content or "").strip()
if not content:
return None
tokens = content.split()
contains_mention = any(self.is_bot_mention(t) for t in tokens)
if not contains_mention:
return None
# Find the first non-mention token as seed
non_mention_tokens = (
t.strip(".,!?;:") for t in tokens if not self.is_bot_mention(t)
)
seed = next((t for t in non_mention_tokens if t), None)
if not seed:
return None
sentence = await self.generate_svc.run(seed)
if not sentence:
return None
await message.channel.send(f"@{message.author.name} {sentence}")
return sentence
@commands.Cog.event()
async def event_message(self, message):
"""Main message event handler"""
@ -236,6 +275,13 @@ class SaveMessagesCog(commands.Cog):
await self.store_svc.run(message.content)
# If the message contains a mention to this bot, reply by generating
# a sentence from the first word that is not the bot username itself.
if await self._handle_bot_mention(message):
# If the bot actually replies with something, it should not try to send
# any other type of reply
return
msg_type = self.message_handler.get_message_type(message.content)
response = None
@ -248,10 +294,10 @@ class SaveMessagesCog(commands.Cog):
case MessageType.WHAT:
response = "WHAT Ramon"
case MessageType.LAUGH:
response = await self.message_handler.handle_laugh()
response = self.message_handler.handle_laugh()
case MessageType.ANO_SUFFIX:
response = (
f"@{message.author.name} me la agarras con la mano. venga, tira"
f"@{message.author.name} {self.message_handler.handle_ano_suffix()}"
)
case MessageType.OTHER:
return

View file

@ -62,7 +62,9 @@ class UserRepo(IRepo[User]):
self.get_client(auto_commit=auto_commit) as db,
await db.execute(
"""
SELECT * FROM users WHERE id = ?
SELECT *
FROM users
WHERE id = ?
""",
(obj_id.hex,),
) as cursor,
@ -79,8 +81,7 @@ class UserRepo(IRepo[User]):
self.get_client(auto_commit=auto_commit) as db,
await db.execute(
"""INSERT INTO users (id, username, external_auth, created_at, last_updated_at)
VALUES (?, ?, ?, ?, ?)
RETURNING *
VALUES (?, ?, ?, ?, ?) RETURNING *
""",
(
obj.id.hex,
@ -106,8 +107,7 @@ class UserRepo(IRepo[User]):
SET username = ?,
external_auth = ?,
last_updated_at = ?
WHERE id = ?
RETURNING *
WHERE id = ? RETURNING *
""",
(
obj.username,
@ -124,7 +124,9 @@ class UserRepo(IRepo[User]):
async with self.get_client(auto_commit=auto_commit) as db:
await db.execute(
"""
DELETE FROM users WHERE id = ?
DELETE
FROM users
WHERE id = ?
""",
(obj.id.hex,),
)
@ -134,7 +136,9 @@ class UserRepo(IRepo[User]):
self.get_client(auto_commit=auto_commit) as db,
db.execute(
"""
SELECT * FROM users WHERE username = ?
SELECT *
FROM users
WHERE username = ?
""",
(user,),
) as cursor,
@ -169,6 +173,7 @@ class QuoteRepo(IRepo[Quote]):
channel_name=data["channel"],
created_at=data["created_at"],
last_updated_at=data["last_updated_at"],
is_active=data["is_active"],
)
async def create(self, obj: Quote, auto_commit=True) -> Quote:
@ -178,9 +183,8 @@ class QuoteRepo(IRepo[Quote]):
self.get_client(auto_commit=auto_commit) as db,
await db.execute(
"""
INSERT INTO quotes (id, quote, author, channel, created_at, last_updated_at)
VALUES (?, ?, ?, ?, ?, ?)
RETURNING *
INSERT INTO quotes (id, quote, author, channel, created_at, is_active, last_updated_at)
VALUES (?, ?, ?, ?, ?, ?, ?) RETURNING *
""",
(
obj.id.hex,
@ -188,6 +192,7 @@ class QuoteRepo(IRepo[Quote]):
obj.author,
obj.channel_name,
obj.created_at,
obj.is_active,
obj.last_updated_at,
),
) as cursor,
@ -206,14 +211,15 @@ class QuoteRepo(IRepo[Quote]):
SET quote = ?,
author = ?,
channel = ?,
is_active = ?,
last_updated_at = ?
WHERE id = ?
RETURNING *
WHERE id = ? RETURNING *
""",
(
obj.quote,
obj.author,
obj.channel_name,
obj.is_active,
utils.get_utc_now(),
obj.id.hex,
),
@ -226,7 +232,9 @@ class QuoteRepo(IRepo[Quote]):
async with self.get_client(auto_commit=auto_commit) as db:
await db.execute(
"""
DELETE FROM quotes WHERE id = ?
DELETE
FROM quotes
WHERE id = ?
""",
(obj.id.hex,),
)
@ -236,7 +244,9 @@ class QuoteRepo(IRepo[Quote]):
self.get_client(auto_commit=auto_commit) as db,
db.execute(
"""
SELECT * FROM quotes WHERE id = ?
SELECT *
FROM quotes
WHERE id = ?
""",
(obj_id.hex,),
) as cursor,
@ -251,7 +261,9 @@ class QuoteRepo(IRepo[Quote]):
self.get_client(auto_commit=auto_commit) as db,
db.execute(
"""
SELECT * FROM quotes WHERE quote = ?
SELECT *
FROM quotes
WHERE quote = ?
""",
(quote,),
) as cursor,
@ -277,10 +289,11 @@ class QuoteRepo(IRepo[Quote]):
self.get_client(auto_commit=auto_commit) as db,
db.execute(
"""
SELECT * FROM quotes
SELECT *
FROM quotes
WHERE channel = ?
ORDER BY RANDOM()
LIMIT 1
AND is_active = 1
ORDER BY RANDOM() LIMIT 1
""",
(channel_name,),
) as cursor,
@ -310,16 +323,14 @@ class ChatbotRepo(IRepo[Chatbot]):
async with (
self.get_client(auto_commit=auto_commit) as db,
await db.execute(
"""INSERT INTO chatbot (
id,
"""INSERT INTO chatbot (id,
user_id,
automatic_generation_timer,
automatic_quote_timer,
mods,
created_at,
last_updated_at
) VALUES(?,?,?,?,?,?,?)
RETURNING *
last_updated_at)
VALUES (?, ?, ?, ?, ?, ?, ?) RETURNING *
""",
(
obj.id.hex,
@ -341,13 +352,12 @@ class ChatbotRepo(IRepo[Chatbot]):
async with (
self.get_client(auto_commit=auto_commit) as db,
await db.execute(
"""UPDATE chatbot SET
automatic_generation_timer = ?,
"""UPDATE chatbot
SET automatic_generation_timer = ?,
automatic_quote_timer = ?,
mods = ?,
last_updated_at = ?
WHERE user_id = ?
RETURNING *
WHERE user_id = ? RETURNING *
""",
(
obj.automatic_generation_timer,

View file

@ -105,6 +105,7 @@ class Quote(BaseModel):
quote: str
author: str
channel_name: str
is_active: bool = True
created_at: datetime.datetime = Field(default_factory=utils.get_utc_now)
last_updated_at: datetime.datetime = Field(default_factory=utils.get_utc_now)

View file

@ -1,5 +1,5 @@
import tempfile
from collections.abc import Generator
from collections.abc import Iterator
from pathlib import Path
import yt_dlp
@ -9,7 +9,7 @@ from pydantic import BaseModel
class DownloadClosedCaptionsSvc(BaseModel):
@staticmethod
def run(youtube_url: str, sub_lang: str = "es") -> Generator[Path, None, None]:
def run(youtube_url: str, sub_lang: str = "es") -> Iterator[Path]:
"""Download closed captions from a yt video and save it to a temp file
Args:

View file

@ -176,7 +176,7 @@ async def five_chatbots(chatbot_factory, user):
@pytest.fixture
async def persisted_five_chatbots(five_chatbots, chatbot_repo):
return [await chatbot_repo.create(chatbot) for chat in five_chatbots]
return [await chatbot_repo.create(chatbot) for chatbot in five_chatbots]
@pytest.fixture
@ -221,6 +221,7 @@ async def five_quotes(quote_factory):
@pytest.fixture
async def persisted_quote(quote_repo, quote):
quote.is_active = True
return await quote_repo.create(quote)

View file

@ -234,6 +234,7 @@ async def test_create_quote_action(
username=user.username,
channel=user.username,
quote=quote.quote,
is_active=quote.is_active,
author=quote.author,
)
assert new_quote

149
tests/test_bot_mentions.py Normal file
View file

@ -0,0 +1,149 @@
import types
import pytest
from huesoporro.bot import SaveMessagesCog
class DummyDB:
def __init__(self, *args, **kwargs):
pass
class FakeChannel:
def __init__(self):
self.sent: list[str] = []
async def send(self, content: str):
self.sent.append(content)
class FakeAuthor:
def __init__(self, name: str):
self.name = name
class FakeMessage:
def __init__(self, content: str | None, author_name: str = "alice"):
self.content = content
self.author = FakeAuthor(author_name)
self.channel = FakeChannel()
class FakeBot:
def __init__(self, nick: str = "Junie", channel: str = "testchan"):
self.nick = nick
self.channel = channel
@pytest.fixture(autouse=True)
def patch_markov_and_svcs(monkeypatch):
monkeypatch.setattr("huesoporro.bot.MarkovDatabase", DummyDB)
class _DummyStoreSvc:
def __init__(self, db):
self.db = db
async def run(self, content: str | None):
return None
class _DummyGenSvc:
def __init__(self, db):
self.db = db
async def run(self, seed: str):
return None
monkeypatch.setattr("huesoporro.bot.SentenceStorerSvc", _DummyStoreSvc)
monkeypatch.setattr("huesoporro.bot.SentenceGeneratorSvc", _DummyGenSvc)
@pytest.fixture
def cog(monkeypatch) -> SaveMessagesCog:
bot = FakeBot()
return SaveMessagesCog(bot) # type: ignore[arg-type]
def make_async_fn(result=None, exc: Exception | None = None):
async def _fn(*args, **kwargs):
if exc:
raise exc
return result
return _fn
@pytest.mark.asyncio
async def test_handle_bot_mention_returns_none_on_empty_content(cog: SaveMessagesCog):
msg = FakeMessage(content=None)
res = await cog._handle_bot_mention(msg) # type: ignore[attr-defined]
assert res is None
assert msg.channel.sent == []
@pytest.mark.asyncio
async def test_handle_bot_mention_returns_none_when_no_mention(cog: SaveMessagesCog):
msg = FakeMessage(content="hello world")
res = await cog._handle_bot_mention(msg) # type: ignore[attr-defined]
assert res is None
assert msg.channel.sent == []
@pytest.mark.asyncio
async def test_handle_bot_mention_returns_none_when_only_mention(
cog: SaveMessagesCog, monkeypatch
):
msg = FakeMessage(content=cog.bot.nick) # type: ignore[attr-defined]
res = await cog._handle_bot_mention(msg) # type: ignore[attr-defined]
assert res is None
assert msg.channel.sent == []
@pytest.mark.asyncio
async def test_handle_bot_mention_generates_and_sends_reply(
cog: SaveMessagesCog, monkeypatch
):
msg = FakeMessage(content="juNie hello there")
monkeypatch.setattr(
cog, "generate_svc", types.SimpleNamespace(run=make_async_fn("foo bar"))
)
res = await cog._handle_bot_mention(msg) # type: ignore[attr-defined]
assert res == "foo bar"
assert len(msg.channel.sent) == 1
assert msg.channel.sent[0].startswith(f"@{msg.author.name} ")
assert msg.channel.sent[0].endswith("foo bar")
@pytest.mark.asyncio
async def test_handle_bot_mention_no_send_when_generator_returns_none(
cog: SaveMessagesCog, monkeypatch
):
msg = FakeMessage(content=f"{cog.bot.nick} hello") # type: ignore[attr-defined]
monkeypatch.setattr(
cog, "generate_svc", types.SimpleNamespace(run=make_async_fn(None))
)
res = await cog._handle_bot_mention(msg) # type: ignore[attr-defined]
assert res is None
assert msg.channel.sent == []
@pytest.mark.asyncio
async def test_handle_bot_mention_swallows_exceptions_and_returns_none(
cog: SaveMessagesCog, monkeypatch
):
msg = FakeMessage(content=f"{cog.bot.nick} hello") # type: ignore[attr-defined]
monkeypatch.setattr(
cog,
"generate_svc",
types.SimpleNamespace(run=make_async_fn(exc=RuntimeError("boom"))),
)
res = await cog._handle_bot_mention(msg) # type: ignore[attr-defined]
assert res is None
assert msg.channel.sent == []

2359
uv.lock generated

File diff suppressed because it is too large Load diff