fix: reply command (#148)

* fix: reply empty command

* docs: update changelog with reply fix

* fix: fix reply command

* chore : restore comment

* test: add test case for reply

* fix: remove invalid configuration include_trailing_comma

* chore: update CHANGELOG

* chore: black formatting

---------

Co-authored-by: Ernesto Casablanca <[email protected]>

.github/CHANGELOG.md

@@ -13,7 +13,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The database backup periodically sent to the admin can now be encrypted with a key (see `crypto_key` in the _settings.yaml_ file)
 - Added utility script `f_crypto` to encrypt/decrypt files with a key or generate a new key
 
-### Changes
+### Fixed
+
+- The **/reply** command supports the bot tag after the slash and correctly parses the text to send to the user
+
+### Changed
 
 - Added readme overview page in the docs
 - Added Privacy Policy in the docs. It is referenced in the bot **/start** command

pyproject.toml

@@ -97,7 +97,6 @@ testpaths = ["tests"]
 [tool.black]
 target-version = ['py38', 'py39', 'py310', 'py311']
 line-length = 120
-include_trailing_comma = false
 include = '(src|tests)\/.*\.py'
 
 # Isort configuration (import sorter)

src/spotted/__init__.py

@@ -1,4 +1,5 @@
 """Modules used in this bot"""
+
 from telegram.ext import Application
 
 from spotted.data import Config, init_db

src/spotted/__main__.py

@@ -1,4 +1,5 @@
 """Main module"""
+
 import argparse
 from typing import TYPE_CHECKING
 

src/spotted/data/__init__.py

@@ -1,4 +1,5 @@
 """Modules that work with the data section"""
+
 from telegram.ext import Application
 
 from .config import Config

src/spotted/data/config.py

@@ -1,4 +1,5 @@
 """Read the bot configuration from the settings.yaml and the autoreplies.yaml files"""
+
 import logging
 import os
 import re

src/spotted/data/data_reader.py

@@ -1,4 +1,5 @@
 """Read data from files"""
+
 import os
 from importlib import resources
 

src/spotted/data/db_manager.py

@@ -1,4 +1,5 @@
 """Handles the management of databases"""
+
 import logging
 import os
 import sqlite3

src/spotted/data/pending_post.py

@@ -1,4 +1,5 @@
 """Pending post management"""
+
 from dataclasses import dataclass
 from datetime import datetime, timezone
 

src/spotted/data/post_data.py

@@ -1,4 +1,5 @@
 """Data management for the bot"""
+
 from .db_manager import DbManager
 
 

src/spotted/data/published_post.py

@@ -1,4 +1,5 @@
 """Published post management"""
+
 from dataclasses import dataclass
 from datetime import datetime
 

src/spotted/data/report.py

@@ -1,4 +1,5 @@
 """Reports management"""
+
 from dataclasses import dataclass
 from datetime import datetime
 

src/spotted/data/user.py

@@ -1,4 +1,5 @@
 """Users management"""
+
 from dataclasses import dataclass
 from datetime import datetime
 from random import choice

src/spotted/debug/__init__.py

@@ -1,2 +1,3 @@
 """Modules used during debug"""
+
 from .log_manager import error_handler, log_message, logger

src/spotted/debug/log_manager.py

@@ -1,4 +1,5 @@
 """Handles the logging of events"""
+
 import html
 import logging
 import traceback

src/spotted/handlers/__init__.py

@@ -1,4 +1,5 @@
 """Modules that handle the events the bot recognizes and reacts to"""
+
 from datetime import time
 from warnings import filterwarnings
 

src/spotted/handlers/anonym_comment.py

@@ -1,4 +1,5 @@
 """Anonym Comment on a post in the comment group"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/approve.py

@@ -1,4 +1,5 @@
 """Approve actions the admin can take on a pending post."""
+
 import logging
 
 from telegram import Update

src/spotted/handlers/autoreply.py

@@ -1,4 +1,5 @@
 """/autoreply command"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/ban.py

@@ -1,4 +1,5 @@
 """/ban command"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/cancel.py

@@ -1,4 +1,5 @@
 """/cancel command"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/clean_pending.py

@@ -1,4 +1,5 @@
 """/clean_pending command"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/constants.py

@@ -1,4 +1,5 @@
 """Constants used by the bot handlers"""
+
 from enum import Enum, auto, unique
 
 CHAT_PRIVATE_ERROR = "Non puoi usare quest comando ora\nMandami un messaggio in privato"

src/spotted/handlers/db_backup.py

@@ -1,4 +1,5 @@
 """/db_backup command"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/follow_comment.py

@@ -1,4 +1,5 @@
 """Detect Comment on a post in the comment group"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/forwarded_post.py

@@ -1,4 +1,5 @@
 """Message forwarded by the telegram channel"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/help.py

@@ -1,4 +1,5 @@
 """/help command"""
+
 from telegram import Update
 from telegram.constants import ParseMode
 from telegram.ext import CallbackContext

src/spotted/handlers/job_handlers.py

@@ -1,4 +1,5 @@
 """Scheduled jobs of the bot"""
+
 from base64 import b64decode
 from binascii import Error as BinasciiError
 from datetime import datetime, timedelta, timezone

src/spotted/handlers/purge.py

@@ -1,4 +1,5 @@
 """/purge command"""
+
 from time import sleep
 
 from telegram import Update

src/spotted/handlers/reload.py

@@ -1,4 +1,5 @@
 """/reload command"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 

src/spotted/handlers/reply.py

@@ -1,4 +1,5 @@
 """/reply command"""
+
 from telegram import Update
 from telegram.ext import CallbackContext
 
@@ -15,25 +16,25 @@ async def reply_cmd(update: Update, context: CallbackContext):
         context: context passed by the handler
     """
     info = EventInfo.from_message(update, context)
-
-    if len(info.text) <= 7:  # the reply is empty
+    if len(info.args) == 0:  # the reply is empty
         await info.bot.send_message(
             chat_id=info.chat_id,
             text="La reply è vuota\n"
             "Per mandare un messaggio ad un utente, rispondere al suo post o report con /reply "
             "seguito da ciò che gli si vuole dire",
         )
         return
-
+    ### build the reply text from the args
+    reply_text = " ".join(info.args)
     g_message_id = update.message.reply_to_message.message_id
     if (pending_post := PendingPost.from_group(admin_group_id=info.chat_id, g_message_id=g_message_id)) is not None:
         await info.bot.send_message(
             chat_id=pending_post.user_id,
-            text="COMUNICAZIONE DEGLI ADMIN SUL TUO ULTIMO POST:\n" + info.text[7:].strip(),
+            text=f"COMUNICAZIONE DEGLI ADMIN SUL TUO ULTIMO POST:\n{reply_text}",
         )
     elif (report := Report.from_group(admin_group_id=info.chat_id, g_message_id=g_message_id)) is not None:
         await info.bot.send_message(
-            chat_id=report.user_id, text="COMUNICAZIONE DEGLI ADMIN SUL TUO ULTIMO REPORT:\n" + info.text[7:].strip()
+            chat_id=report.user_id, text=f"COMUNICAZIONE DEGLI ADMIN SUL TUO ULTIMO REPORT:\n{reply_text}"
         )
     else:  # the reply does not refer to a pending post or a report
         await info.bot.send_message(

src/spotted/handlers/report_spot.py

@@ -1,4 +1,5 @@
 """report callback"""
+
 from telegram import Update
 from telegram.error import Forbidden
 from telegram.ext import (

src/spotted/handlers/report_user.py

@@ -1,4 +1,5 @@
 """/report command"""
+
 from telegram import Update
 from telegram.ext import (
     CallbackContext,

src/spotted/handlers/rules.py

@@ -1,4 +1,5 @@
 """/rules command"""
+
 from telegram import Update
 from telegram.constants import ParseMode
 from telegram.ext import CallbackContext

src/spotted/handlers/sban.py

@@ -1,4 +1,5 @@
 """/sban command"""
+
 from telegram import Update
 from telegram.error import Forbidden
 from telegram.ext import CallbackContext

src/spotted/handlers/settings.py

@@ -1,4 +1,5 @@
 """/settings command"""
+
 import logging
 
 from telegram import Update

src/spotted/handlers/spot.py

@@ -1,4 +1,5 @@
 """/spot command"""
+
 from random import choice
 
 from telegram import Update

src/spotted/handlers/start.py

@@ -1,4 +1,5 @@
 """/start command"""
+
 from telegram import Update
 from telegram.constants import ParseMode
 from telegram.ext import CallbackContext

src/spotted/utils/__init__.py

@@ -1,4 +1,5 @@
 """Modules that provide various util"""
+
 from .conversation_util import conv_cancel, conv_fail
 from .info_util import EventInfo
 from .keyboard_util import (

src/spotted/utils/conversation_util.py

@@ -1,4 +1,5 @@
 """Common functions needed in conversation handlers"""
+
 from typing import Callable
 
 from telegram import Update

src/spotted/utils/info_util.py

@@ -1,4 +1,5 @@
 """Common info needed in both command and callback handlers"""
+
 from telegram import Bot, CallbackQuery, Chat, InlineKeyboardMarkup, Message, Update
 from telegram.error import BadRequest
 from telegram.ext import CallbackContext

src/spotted/utils/keyboard_util.py

@@ -1,5 +1,6 @@
 """Creates the inlinekeyboard sent by the bot in its messages.
 Callback_data format: <callback_family>_<callback_name>,[arg]"""
+
 from itertools import islice, zip_longest
 
 from telegram import Bot, InlineKeyboardButton, InlineKeyboardMarkup

tests/integration/telegram_simulator.py

@@ -112,8 +112,7 @@ async def send_command(
         user: "User" = None,
         chat: "Chat" = None,
         reply_to_message: "Message | int | None" = None,
-    ) -> "Message":
-        ...
+    ) -> "Message": ...
 
     async def send_command(
         self,
@@ -147,12 +146,10 @@ async def send_message(
         entities: "list[MessageEntity] | None" = None,
         reply_to_message: "Message | int | None" = None,
         message_thread_id: "int | None" = None,
-    ) -> "Message":
-        ...
+    ) -> "Message": ...
 
     @overload
-    async def send_message(self, message: "Message") -> "Message":
-        ...
+    async def send_message(self, message: "Message") -> "Message": ...
 
     async def send_message(
         self,

tests/integration/test_bot.py

@@ -285,9 +285,20 @@ async def test_reply_post_cmd(self, telegram: TelegramSimulator, admin_group: Ch
             """Tests the /reply command.
             The bot sends a message to the user on behalf of the admin
             """
-            await telegram.send_message("/reply TEST", chat=admin_group, reply_to_message=pending_post)
+            await telegram.send_message("/reply TEST Test2", chat=admin_group, reply_to_message=pending_post)
             assert telegram.messages[-2].text.startswith("COMUNICAZIONE DEGLI ADMIN SUL TUO ULTIMO POST:\n")
-            assert telegram.messages[-2].text.endswith("TEST")
+            assert telegram.messages[-2].text.endswith("TEST Test2")
+            assert telegram.last_message.text == "L'utente ha ricevuto il messaggio"
+
+        async def test_reply_bot_tag_post_cmd(
+            self, telegram: TelegramSimulator, admin_group: Chat, pending_post: Message
+        ):
+            """Tests the /reply command with the bot tag.
+            The bot sends a message to the user on behalf of the admin
+            """
+            await telegram.send_message("/reply@bot_tag TEST1 Test2", chat=admin_group, reply_to_message=pending_post)
+            assert telegram.messages[-2].text.startswith("COMUNICAZIONE DEGLI ADMIN SUL TUO ULTIMO POST:\n")
+            assert telegram.messages[-2].text.endswith("TEST1 Test2")
             assert telegram.last_message.text == "L'utente ha ricevuto il messaggio"
 
         async def test_autoreply_list_cmd(self, telegram: TelegramSimulator, admin_group: Chat, pending_post: Message):

tests/unit/test_db.py

@@ -16,8 +16,8 @@ def db_results(create_test_db: DbManager) -> dict:
     Yields:
         Iterator[dict]: dictionary containing the results for the test queries
     """
-    create_test_db.row_factory = (
-        lambda cursor, row: list(row) if cursor.description[0][0] != "number" else {"number": row[0]}
+    create_test_db.row_factory = lambda cursor, row: (
+        list(row) if cursor.description[0][0] != "number" else {"number": row[0]}
     )
     create_test_db.query_from_file("config/db/db_test.sql")