feat: deprecation warning on Stop messages

Author: David-Lor

Diff for: sample.env

@@ -13,6 +13,8 @@ USER_RATE_LIMIT_AMOUNT=5
 USER_RATE_LIMIT_TIME=1
 TYPING_SAFE_LIMIT_TIME=30
 INLINE_CACHE_TIME=300
+STOP_MESSAGES_DEPRECATION_REMINDER_AFTER_SECONDS=300  # 300s = 5 minutes
+STOP_MESSAGES_DEPRECATION_REMINDER_LOOP_DELAY_SECONDS=30
 
 # Bus API
 API_URL=http://localhost:5000

Diff for: static/messages.yaml

@@ -91,6 +91,7 @@ stop:
       :heavy_plus_sign:Buses
     less_buses:
       :heavy_minus_sign:Buses
+  deprecated_warning: :warning:<b>Este mensaje lleva más de 5 minutos desactualizado</b>, pulsa sobre :arrows_counterclockwise:<b>Actualizar</b> para refrescarlo
 stop_rename:
   request: |-
     :pencil2:¿Qué nombre deseas darle a la parada <b>#{stop_id} ({stop_name})</b>?

Diff for: vigobusbot/entrypoint.py

@@ -11,17 +11,16 @@
 from vigobusbot.settings_handler import telegram_settings as settings
 from vigobusbot.logger import logger
 
-__all__ = ("run",)
-
 
 def run():
     load_static_files()
     bot = get_bot()
     asyncio.get_event_loop().run_until_complete(bot.set_commands())
+    asyncio.get_event_loop().run_until_complete(bot.start_background_services())
 
     if settings.method == "webhook":
         logger.debug("Starting the bot with the Webhook method...")
-        pass
+        raise Exception("Webhook method not yet implemented")
     else:
         logger.debug("Starting the bot with the Polling method...")
         start_polling(bot)

Diff for: vigobusbot/persistence_api/saved_stops/services/encoder.py

@@ -2,18 +2,13 @@
 Functions to encode data from raw (Bot to Persist API)
 """
 
-# # Native # #
 import hashlib
 
-# # Package # #
 from .key_generator import *
 
-# # Project # #
 from vigobusbot.persistence_api.saved_stops.entities import SavedStop, SavedStopEncoded
 from vigobusbot.settings_handler import persistence_settings as settings
 
-__all__ = ("encode_user_id", "encode_stop", "encode_string")
-
 
 def encode_user_id(user_id: int) -> str:
     sha512 = hashlib.sha512()
@@ -26,10 +21,14 @@ def encode_string(data: str, key: Fernet) -> str:
     return key.encrypt(data.encode()).decode()
 
 
-def encode_stop(raw_stop: SavedStop, user_id: int) -> SavedStopEncoded:
+def encode_string_for_user(user_id: int, data: str) -> str:
     key = get_user_key(user_id)
+    return encode_string(data, key)
+
+
+def encode_stop(raw_stop: SavedStop, user_id: int) -> SavedStopEncoded:
     return SavedStopEncoded(
         stop_id=raw_stop.stop_id,
         user_id=encode_user_id(user_id=user_id),
-        stop_name=encode_string(key=key, data=raw_stop.stop_name) if raw_stop.stop_name else None
+        stop_name=encode_string_for_user(user_id, raw_stop.stop_name) if raw_stop.stop_name else None
     )

Diff for: vigobusbot/settings_handler/__init__.py

@@ -2,14 +2,11 @@
 Load settings from dotenv file or environment variables
 """
 
-# # Native # #
 from typing import Optional
 
-# # Installed # #
 import pydantic
 import aiogram.bot.api
 
-# # Package # #
 from .helpers import *
 
 __all__ = ("telegram_settings", "api_settings", "persistence_settings", "mongo_settings", "system_settings")
@@ -37,6 +34,11 @@ class TelegramSettings(BaseBotSettings):
     typing_safe_limit_time: float = 30
     """Timeout for a Typing chat action to end"""
     inline_cache_time: int = 300
+    stop_messages_deprecation_reminder_after_seconds: int = 0
+    """Time for a Stop message to be considered deprecated, thus update with a warning about it being deprecated.
+    If 0, disable this feature."""
+    stop_messages_deprecation_reminder_loop_delay_seconds: int = 60
+    """Delay for the loop that checks for deprecated Stop messages."""
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)

Diff for: vigobusbot/telegram_bot/bot.py

@@ -2,22 +2,17 @@
 Bot class and bot instance getter and generator
 """
 
-# # Native # #
+import asyncio
 from typing import Optional
 
-# # Installed # #
 import aiogram
 
-# # Package # #
 from .handlers import register_handlers
-
-# # Project # #
+from vigobusbot.telegram_bot.services.stop_messages_deprecation_reminder import stop_messages_deprecation_reminder_worker
 from vigobusbot.settings_handler import telegram_settings as settings
 from vigobusbot.static_handler import get_messages
 from vigobusbot.logger import logger
 
-__all__ = ("Bot", "get_bot")
-
 
 class Bot(aiogram.Bot):
     def __init__(self, **kwargs):
@@ -55,6 +50,10 @@ async def set_commands(self) -> bool:
             logger.opt(exception=True).warning("Bot commands could not be set")
             return False
 
+    async def start_background_services(self):
+        # noinspection PyAsyncCall
+        asyncio.create_task(stop_messages_deprecation_reminder_worker(self))
+
 
 _bot: Optional[Bot] = None
 

Diff for: vigobusbot/telegram_bot/handlers/callback_handlers.py

@@ -2,17 +2,15 @@
 Callback Handlers for the Callback Queries, produced when users press buttons from the inline keyboards on messages
 """
 
-# # Native # #
 import asyncio
 
-# # Installed # #
 import aiogram
 
-# # Project # #
 from vigobusbot.telegram_bot.services import request_handler
 from vigobusbot.telegram_bot.services.status_sender import start_typing, stop_typing
 from vigobusbot.telegram_bot.services.stop_rename_request_handler import StopRenameRequestContext
 from vigobusbot.telegram_bot.services.stop_rename_request_handler import register_stop_rename_request
+from vigobusbot.telegram_bot.services.sent_messages_persistence import persist_sent_stop_message
 from vigobusbot.telegram_bot.services.message_generators import *
 from vigobusbot.persistence_api import saved_stops
 from vigobusbot.static_handler import get_messages
@@ -53,18 +51,20 @@ async def stop_refresh(callback_query: aiogram.types.CallbackQuery, callback_dat
                 **callback_data
             )
 
+        # TODO Review:
         # For now, not sending "typing" status, since after message is updated it can still show "typing"...
         # await start_typing(bot=callback_query.bot, chat_id=chat_id)
 
         text, markup = await generate_stop_message(context)
 
-        await callback_query.bot.edit_message_text(
+        msg = await callback_query.bot.edit_message_text(
             text=text,
             chat_id=chat_id,
             message_id=message_id,
             inline_message_id=inline_message_id,
             reply_markup=markup
         )
+        await persist_sent_stop_message(msg)
 
     except MessageNotModified:
         # MessageNotModified exceptions can be triggered when user presses Update button many times too quickly,
@@ -89,11 +89,12 @@ async def stop_get(callback_query: aiogram.types.CallbackQuery, callback_data: d
         await start_typing(bot=callback_query.bot, chat_id=chat_id)
         text, markup = await generate_stop_message(context)
 
-        await callback_query.bot.send_message(
+        msg = await callback_query.bot.send_message(
             chat_id=chat_id,
             text=text,
             reply_markup=markup
         )
+        await persist_sent_stop_message(msg)
 
     finally:
         stop_typing(chat_id)

Diff for: vigobusbot/telegram_bot/handlers/inline_handlers.py

@@ -9,6 +9,7 @@
 from vigobusbot.telegram_bot.services.message_generators import generate_search_stops_inline_responses
 from vigobusbot.telegram_bot.services.message_generators import generate_stop_message
 from vigobusbot.telegram_bot.services.message_generators import SourceContext
+from vigobusbot.telegram_bot.services.sent_messages_persistence import persist_sent_message, PersistMessageTypes
 from vigobusbot.telegram_bot.services import request_handler
 from vigobusbot.settings_handler import telegram_settings as settings
 from vigobusbot.logger import logger
@@ -42,11 +43,15 @@ async def stop_search_chosen_result(chosen_inline_query: aiogram.types.ChosenInl
     )
     text, markup = await generate_stop_message(context)
 
-    await chosen_inline_query.bot.edit_message_text(
+    msg = await chosen_inline_query.bot.edit_message_text(
         inline_message_id=chosen_inline_query.inline_message_id,
         text=text,
         reply_markup=markup
     )
+    persist_sent_message(
+        msg_type=PersistMessageTypes.STOP,
+        message=msg,
+    )
 
 
 def register_handlers(dispatcher: aiogram.Dispatcher):

Diff for: vigobusbot/telegram_bot/handlers/message_handlers.py

@@ -2,16 +2,11 @@
 Telegram Bot Message Handlers: functions that handle incoming messages, depending on their command or content.
 """
 
-# # Native # #
 import asyncio
 
-# # Installed # #
 import aiogram
 
-# # Package # #
 from . import test_message_handlers
-
-# # Project # #
 from vigobusbot.telegram_bot.services import request_handler
 from vigobusbot.telegram_bot.services.status_sender import start_typing, stop_typing
 from vigobusbot.telegram_bot.services.feedback_request_handler import get_feedback_request_context
@@ -24,6 +19,7 @@
 from vigobusbot.telegram_bot.services.message_generators import SourceContext, FeedbackForceReply
 from vigobusbot.telegram_bot.services.message_generators import generate_stop_message, generate_saved_stops_message
 from vigobusbot.telegram_bot.services.message_generators import generate_search_stops_message
+from vigobusbot.telegram_bot.services.sent_messages_persistence import persist_sent_stop_message
 from vigobusbot.persistence_api.saved_stops import delete_all_stops
 from vigobusbot.settings_handler import system_settings
 from vigobusbot.static_handler import get_messages
@@ -128,11 +124,12 @@ async def command_stop(message: Message, *args, **kwargs):
         await start_typing(bot=message.bot, chat_id=chat_id)
         text, markup = await generate_stop_message(context)
 
-        await message.bot.send_message(
+        msg = await message.bot.send_message(
             chat_id=chat_id,
             text=text,
             reply_markup=markup
         )
+        await persist_sent_stop_message(msg)
 
     except (ValueError, StopIteration):
         await message.reply(get_messages().stop.not_valid)

Diff for: vigobusbot/telegram_bot/services/sent_messages_persistence.py

@@ -0,0 +1,65 @@
+"""SENT MESSAGES PERSISTENCE
+Persist certain messages sent by the bot to users.
+"""
+
+import asyncio
+import datetime
+from typing import Dict
+
+import pydantic
+from aiogram.types.message import Message
+
+from vigobusbot.persistence_api.saved_stops.services.encoder import encode_user_id
+from vigobusbot.utils import get_datetime_now_utc
+
+
+class PersistMessageTypes:
+    STOP = "stop"
+
+
+class MessagePersist(pydantic.BaseModel):
+    message_type: str
+    message: Message
+    published_on: datetime.datetime
+
+    # Fields generated from complete_fields() method:
+    message_key: str = ""
+    chat_id_encoded: str = ""
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.complete_fields()
+
+    def complete_fields(self):
+        user_id = self.message.chat.id
+        message_id = self.message.message_id
+        self.chat_id_encoded = encode_user_id(user_id)
+        self.message_key = f"{self.message_type}_{self.chat_id_encoded}_{message_id}"
+
+    def is_expired(self, now: datetime.datetime, ttl_seconds: int) -> bool:
+        return (now - self.published_on).seconds >= ttl_seconds
+
+    class Config:
+        arbitrary_types_allowed = True
+
+
+sent_messages_cache: Dict[str, MessagePersist] = dict()
+"""`{ message_key : message }`"""
+sent_messages_cache_lock = asyncio.Lock()
+
+
+async def persist_sent_message(msg_type: str, message: Message):
+    message_persist = MessagePersist(
+        message_type=msg_type,
+        message=message,
+        published_on=get_datetime_now_utc(),
+    )
+    async with sent_messages_cache_lock:
+        sent_messages_cache[message_persist.message_key] = message_persist
+
+
+async def persist_sent_stop_message(message: Message):
+    """When any Stop message is sent or edited, it must be passed to this method.
+    """
+    # noinspection PyAsyncCall
+    asyncio.create_task(persist_sent_message(msg_type=PersistMessageTypes.STOP, message=message))

Diff for: vigobusbot/telegram_bot/services/stop_messages_deprecation_reminder.py

@@ -0,0 +1,58 @@
+"""STOP MESSAGES DEPRECATION REMINDER
+For the Stop messages sent to users, modify them with a warning/reminder when the messages are outdated for a long time.
+"""
+
+import asyncio
+
+import aiogram
+
+from .sent_messages_persistence import sent_messages_cache, sent_messages_cache_lock, MessagePersist, PersistMessageTypes
+from vigobusbot.static_handler import get_messages
+from vigobusbot.settings_handler import telegram_settings
+from vigobusbot.utils import get_datetime_now_utc
+from vigobusbot.logger import logger
+
+
+async def stop_messages_deprecation_reminder_worker(bot: aiogram.Bot):
+    if telegram_settings.stop_messages_deprecation_reminder_after_seconds <= 0:
+        logger.info("Stop messages deprecation reminder is disabled")
+        return
+
+    while True:
+        await asyncio.sleep(telegram_settings.stop_messages_deprecation_reminder_loop_delay_seconds)
+
+        now = get_datetime_now_utc()
+        ttl = telegram_settings.stop_messages_deprecation_reminder_after_seconds
+
+        async with sent_messages_cache_lock:
+            cached_messages = list(sent_messages_cache.values())
+
+        for msg in cached_messages:
+            if msg.message_type == PersistMessageTypes.STOP and msg.is_expired(now=now, ttl_seconds=ttl):
+                async with sent_messages_cache_lock:
+                    # noinspection PyAsyncCall
+                    asyncio.create_task(_process_deprecated_stop_message(bot, msg))
+                    sent_messages_cache.pop(msg.message_key)
+
+
+async def _process_deprecated_stop_message(bot: aiogram.Bot, message: MessagePersist):
+    with logger.contextualize(user_id_encoded=message.chat_id_encoded, message_id=message.message.message_id):
+        logger.debug("Processing deprecated Stop message...")
+        text = message.message.html_text
+        text += "\n" + get_messages().stop.deprecated_warning
+
+        # noinspection PyBroadException
+        try:
+            await bot.edit_message_text(
+                chat_id=message.message.chat.id,
+                message_id=message.message.message_id,
+                text=text,
+                reply_markup=message.message.reply_markup,
+            )
+            logger.debug("Deprecated Stop message updated with warning")
+
+        except aiogram.exceptions.MessageToEditNotFound:
+            logger.debug("Deprecated Stop message deleted by the user")
+
+        except Exception:
+            logger.opt(exception=True).error("Failed updating deprecated Stop message")