aa-killtracker 0.18.0a2__py3-none-any.whl → 1.0.0a1__py3-none-any.whl

{aa_killtracker-0.18.0a2.dist-info → aa_killtracker-1.0.0a1.dist-info}/METADATA

@@ -1,13 +1,12 @@
 Metadata-Version: 2.4
 Name: aa-killtracker
-Version: 0.18.0a2
+Version: 1.0.0a1
 Summary: An app for running killmail trackers with Alliance Auth and Discord.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 4.0
 Classifier: Framework :: Django :: 4.2
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: License :: OSI Approved :: MIT License
@@ -17,15 +16,16 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 License-File: LICENSE
-Requires-Dist: allianceauth-app-utils>=1.19.0
-Requires-Dist: allianceauth>=3
+Requires-Dist: allianceauth-app-utils>=1.26
+Requires-Dist: allianceauth>=4,<5
 Requires-Dist: dacite
-Requires-Dist: dhooks-lite>=1.0
-Requires-Dist: django-eveuniverse>=1.3
-Requires-Dist: redis-simple-mq>=0.5
+Requires-Dist: dhooks-lite>=1.1
+Requires-Dist: django-eveuniverse>=1.5
+Requires-Dist: redis-simple-mq>=1.0
 Project-URL: Home, https://gitlab.com/ErikKalkoken/aa-killtracker
 
 # Killtracker

{aa_killtracker-0.18.0a2.dist-info → aa_killtracker-1.0.0a1.dist-info}/RECORD

@@ -1,19 +1,20 @@
-killtracker/__init__.py,sha256=6BDL-xJ19nYjor-SkiCJL5oH0bqet4neHQ2sXqb_Hm8,357
-killtracker/admin.py,sha256=HkpfXq0KhqgLjt4kpe8PigonZ-5_ZKQ6D-Z_l3b3jB0,14235
-killtracker/app_settings.py,sha256=lJ0T86Nmh2dP050mM5hu-OfqIhjic_H5GveYAAKWI3c,4016
+killtracker/__init__.py,sha256=wIg1n4zLhPPBnSm9Q9U1g_FFh1IGzAzKfJQMohSx95s,356
+killtracker/admin.py,sha256=IH04Q1etHUnXSJIhm3bnGfIbSU6lPSSaltLERb-OkYg,14229
+killtracker/app_settings.py,sha256=KqWSS4OVKIa7DmBAa5AbwxFVXw5EQebPfBtPo1UJYgY,4295
 killtracker/apps.py,sha256=lWolk2CVEHPNIMEylbK2fSuCSTRW1n6LBmiDjLoqqq4,384
 killtracker/checks.py,sha256=ytqWlhIbCsvGKi3xFbUvAZzbUlgOhiOrB67PZ2WfxM4,1311
 killtracker/constants.py,sha256=W7-VARE3B4_sdzV_9k7qunUzlxTcdSAeSp_ZJVnbUhw,2514
-killtracker/exceptions.py,sha256=aFY6qxQOta1V-qvgKp19Cgy6M16O7Si8moc2205OsX0,846
 killtracker/forms.py,sha256=SUM0U-Sa6FPcGVpsYJbVxHfEtf7hb1Qc_l92Zfa1OLk,5193
-killtracker/managers.py,sha256=lufSPdNrU7KXLfhwvFU82hEsBH--eNMSlCVlFuZYYuI,4422
+killtracker/managers.py,sha256=hrmpiuMzK-7p-AsT4ee0mMEhQv4b57AGmhlRTxEl7wk,4416
 killtracker/providers.py,sha256=3DiOlklBq5kLGDV9nMlMbP2-S8AodNgR6gtB4cWWCUo,358
-killtracker/signals.py,sha256=IgULFrfq7m6-glWGyWisNjnom9_q40-XK56Yld1lNi8,906
-killtracker/tasks.py,sha256=sIZsWrJM8QR2aDXEmjH8u_FT8gjzqlKifaQoTPSxnXo,9208
+killtracker/signals.py,sha256=rFCg-WYMVPmAhuqX8KHNaicsP1nyj_HYA2O4Qr8wqhk,892
+killtracker/tasks.py,sha256=9ZqItmm2tlzVA-lelNTyzpPuBYCUvfZR2nCV16Xu6fA,9267
 killtracker/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-killtracker/core/discord_messages.py,sha256=zepZ90-xtfvPafG0dIZYUWprozOi5I4Kjoj0jEQG5_U,16602
-killtracker/core/killmails.py,sha256=6n2nuhiPbIQXJUf63E_3coGOQmJajx2QeDofO5FioRs,21842
-killtracker/core/worker_shutdown.py,sha256=HHLR5DjLV67Sb3TDssoUnoOWO6_gcUkoov2aKV5qRNE,1289
+killtracker/core/discord.py,sha256=cJY1qZ1ULlndliqn304B2deZkgL8VRqnAN_E5bXbTPk,5330
+killtracker/core/helpers.py,sha256=Ulwhz96IopCCNPD6m7ylz9IGnxknIvLSCfcLrmJ8uDE,335
+killtracker/core/trackers.py,sha256=ZENNdZ96L9AP3nIaP3_s9uFIVRgq_kLPGLK-rKT5gig,14693
+killtracker/core/workers.py,sha256=m9Vp7C-eXSfQpf0ugzTfuqcPBPKvarfds_4mb-JwJ-o,1278
+killtracker/core/zkb.py,sha256=n9eD9RT5xZ3Mc88ItoaQE_1lJAniqpr_oyps47sdGYQ,21481
 killtracker/management/commands/killtracker_load_eve.py,sha256=5P2wr6LU-EMl9_gG-DKP2yw3eFXOU7ApeuGAWEbvCKk,1159
 killtracker/migrations/0001_initial_new.py,sha256=WszI5DmNFtk45IZ2Zul3_Ak-VXmye9ffJKFAsGIxoXA,27818
 killtracker/migrations/0001_squashed_all.py,sha256=KXwOcRayjGGGmleg7-aTcXeIi-92Mn4BaGkEY3iE9Vc,26221
@@ -31,41 +32,43 @@ killtracker/migrations/0009_remove_old_models.py,sha256=bDIz0hywpFKbHYhdXFXzra5D
 killtracker/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 killtracker/models/__init__.py,sha256=WL6VD9MK7EsZot_RLPz0nX8WxJkp7RtQpw_mYpnVqu8,188
 killtracker/models/killmails.py,sha256=CCdrHkwUSoTOGqavG-TpMxDRleF9UEacOTui8v3-VT8,5181
-killtracker/models/trackers.py,sha256=ATbwaQRYO6WgVt5rY3WZicB7D-08EmdDKdJ3WN949dY,31121
-killtracker/models/webhooks.py,sha256=J4e5VupEpvcC-hWDg8BZ4ZrCSkqGFinGUDx95FKe52U,7593
+killtracker/models/trackers.py,sha256=wo6KWl1GOASOquTTdAeo5DaZgRzKai1ek1GjQ49oOhY,31154
+killtracker/models/webhooks.py,sha256=6S1wXwlOMth56oU0hsYH5PiimECMwZyLXiKok2yQo_g,5850
 killtracker/static/killtracker/killtracker_logo.png,sha256=3jc9zmYHqP60Np5piP5RfkX0_II-315DNjZ4FRGbqKc,74625
 killtracker/static/killtracker/zkb_icon.png,sha256=wuVfgyTbTs9qS4KGbDAH3Q9KVPgHqYV5eaVrjEmTjsE,328
 killtracker/templates/admin/killtracker/tracker/killmail_test.html,sha256=TI2ON8qf9pW4rX6G7pT990ZadkipwncQgGUC0FPcWQY,649
 killtracker/tests/__init__.py,sha256=CEt5qqp6ptDrx1lwuA6epZ5bzh1CwUJYXeMZqWK9jT0,278
 killtracker/tests/test_admin.py,sha256=XFAlF_Q4h5Z_agkmRtB30GmCayqQPblLolFrN41xu7Q,5659
 killtracker/tests/test_admin_2.py,sha256=rP0EscM9qUil_ZuXute3R8TQY2P5XSjmxHLbziCGcVw,1140
-killtracker/tests/test_exceptions.py,sha256=wheTwm0JOBqYVI-DJM4KK2usFAZT1Q-O52VMOnSAz8Y,326
-killtracker/tests/test_integration.py,sha256=d1W7102L1_fOUmQJpvPE_5ldJf9iZRrj3LfMsTvtGBo,3245
-killtracker/tests/test_tasks.py,sha256=eaxmImSJvYZneQqv5pYb5due0oS90JvLR0DHtGvyEh4,15990
-killtracker/tests/utils.py,sha256=lpWD3peOyxiwq7z8kO4GLQl98kZ4mEcWgyuUTCUSp_Y,442
+killtracker/tests/test_integration.py,sha256=fOAOu-lKYFAk0hYYT-V4F3KgmPcrD7JgcR-w-z3lStg,3516
+killtracker/tests/test_tasks.py,sha256=hTxXKoza-hgAUsK2zj5qMkl4igHKB7SB2OkPFJtgXeA,16274
+killtracker/tests/test_utils.py,sha256=1TA0pzCpq8CAKRBTi_xZ9_45n3rPx7UclkgFPzT1VFY,1130
+killtracker/tests/utils.py,sha256=auwXHSpLwI_Qi3NmQUOCrIAcEsuw04ZaNJW82-jD4DU,1139
 killtracker/tests/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-killtracker/tests/core/test_discord_messages_1.py,sha256=P-s-zmStMi6fd0yrtKQJxiCVnD1GFF4JJ6ffrIXzYOw,4624
-killtracker/tests/core/test_discord_messages_2.py,sha256=r-NwE_bpJSnedw3nIyad9XWgLa5ly6UPgYB-A7Mba30,4782
-killtracker/tests/core/test_killmails.py,sha256=S08P50xMgq_hiKLeuryAcOI0hN3CnI-jzHKQaN9G5UU,16114
-killtracker/tests/core/test_worker_shutdown.py,sha256=wg0fJQKVPibpRbBfoPCQZycl4rRSGRr6hrYxcRhtEnc,1014
+killtracker/tests/core/test_discord.py,sha256=w_QU1kVfo4uKl1xbj1C5NFQuPqASiveMjf0Q0fEIRWY,6163
+killtracker/tests/core/test_helpers.py,sha256=pQSi9QBOZWOem9NMzcO-qmc_EIWyhyA_aOevuLXrBk4,613
+killtracker/tests/core/test_tracker_1.py,sha256=EjGX2XyHDMAfhevUwi90YcPBSUhTlDv1c7bMgv4qUX0,3528
+killtracker/tests/core/test_tracker_2.py,sha256=ZQ3bZ4tvG3Xf_z8pMQllVlAcWOaltSP2BzqmJAezBEc,4748
+killtracker/tests/core/test_workers.py,sha256=stId22PF5VgrSOpCJV5ZiDak7eKM5rNOS7pbx1QNp6Q,1722
+killtracker/tests/core/test_zkb.py,sha256=lfsJlQgtX-V4rmnkwF60-c2IeRO2tRdead0RAS6WMQg,16557
 killtracker/tests/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-killtracker/tests/models/test_killmails.py,sha256=0ytwIGbTPb1OTzmK8B9VnR1ylxMuaYtp2tvCXzNOwNc,8293
-killtracker/tests/models/test_trackers_1.py,sha256=7DqrF7LE0jJn1ATOQRU8BPcqsvgUIx2ccabOUYsCN-o,42794
-killtracker/tests/models/test_trackers_2.py,sha256=kPCZuS9N3GUtoauMR96aZv9VI5ShAIQpJZLyo0SPOQM,5473
-killtracker/tests/models/test_webhook.py,sha256=VeBm5qdBUHcauFfH2-OoaD8uplqv4D3l2TtVrS5iQzc,6116
+killtracker/tests/models/test_killmails.py,sha256=pNJ7vSLqSl6BbokePdJnQNFWIDwbxkxugpP-QVoJcKQ,8247
+killtracker/tests/models/test_trackers_1.py,sha256=gqywaysnijyF_DT2TdiSJuLc1FUegftnO1pYECMX_Tc,42788
+killtracker/tests/models/test_trackers_2.py,sha256=-iVWnyFvoRb9Y7yKskjc5mmUl3XX53jdQYo8fri4TgA,5458
+killtracker/tests/models/test_webhooks.py,sha256=PtbTxNfYH-NKpLnLZrzbOOqHlJ9vY4Gy19tf2TsHbzI,2597
 killtracker/tests/testdata/__init__.py,sha256=9aQhf8V-DseZMWjJ_QMXOba6CypoHFSVpYRZEUh-oFc,212
 killtracker/tests/testdata/create_eveuniverse.py,sha256=Ewr5OBiQwjK1kwDCRh3A3f0Z-CCPi8Gp8dpsPgVAU4A,966
 killtracker/tests/testdata/evealliances.json,sha256=i6udrtUnWQjn71Iw17WWz9Eb1fdGUNhI1UYLt0hZHog,307
 killtracker/tests/testdata/evecorporations.json,sha256=Hk4WuplZl69rQcquOU-15lgUyvHRMZW0fnYfKz8oeWw,1229
 killtracker/tests/testdata/eveentities.json,sha256=0yStlAMEhednEiMKvKOYFsyRovtsGxw6IpWAyvnQXv4,1459
 killtracker/tests/testdata/eveuniverse.json,sha256=JagrJ-asKlkxrqj3dtAth6d5bhIpeEmlvBHgXjLTMSI,36117
-killtracker/tests/testdata/factories.py,sha256=WqmIthF6kgrdQrV5CSlub4hBYo42lC_8UORzZ8sGAp0,11019
-killtracker/tests/testdata/helpers.py,sha256=5T35ITnh16pTswR1O4t4IdVSpokC3x8_Me_vk3CgBB8,4741
+killtracker/tests/testdata/factories.py,sha256=MEJLfslB13J_UnN7TXASL6poH1fkQ1NW5dQX_xtfPvA,11013
+killtracker/tests/testdata/helpers.py,sha256=bsHv2HlbORuw5kU8qZ806nXPM0hqNUuj0qVQCm4KoZ8,4735
 killtracker/tests/testdata/killmails.json,sha256=HKfpXQJ_ikymBSewh4wWixYpLwC3kNBqi04cCms1AjA,45366
 killtracker/tests/testdata/load_eveuniverse.py,sha256=FitVc12E_ob56ezK5Y1q07Kbyc7N8poHiCNaLRGU4Jg,388
 killtracker/tools/drop_tables_killtracker.sql,sha256=fJrGY23NKRunpYC3hI-klFkWub4sBuhfP8TaT__zjPg,1726
 killtracker/tools/generate_conditions_text.py,sha256=LxAtTQIX-IbuqaNDMV1XHhq5AbrrlwxLWgXa1M7DWQo,767
-aa_killtracker-0.18.0a2.dist-info/licenses/LICENSE,sha256=XZiwB_S_40_HhnvLg5xvtBb3g1oGjPrk0rpFwk8iInE,1070
-aa_killtracker-0.18.0a2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-aa_killtracker-0.18.0a2.dist-info/METADATA,sha256=7xoqmIUN3AAKkHhGvuL04Fd3wP9QLCZEkPm4o2oH4l0,13929
-aa_killtracker-0.18.0a2.dist-info/RECORD,,
+aa_killtracker-1.0.0a1.dist-info/licenses/LICENSE,sha256=XZiwB_S_40_HhnvLg5xvtBb3g1oGjPrk0rpFwk8iInE,1070
+aa_killtracker-1.0.0a1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+aa_killtracker-1.0.0a1.dist-info/METADATA,sha256=D8mZwY0eM39wkvv8FcnkgaomKJ6KbQhb6cxew0iVqEo,13941
+aa_killtracker-1.0.0a1.dist-info/RECORD,,

killtracker/__init__.py

@@ -3,7 +3,7 @@
 # pylint: disable = invalid-name
 default_app_config = "killtracker.apps.KillmailsConfig"
 
-__version__ = "0.18.0a2"
+__version__ = "1.0.0a1"
 __title__ = "Killtracker"
 
 APP_NAME = "aa-killtracker"

killtracker/admin.py

@@ -12,7 +12,7 @@ from django.utils.safestring import mark_safe
 from allianceauth import NAME as site_header
 
 from killtracker import tasks
-from killtracker.core.killmails import Killmail
+from killtracker.core.zkb import Killmail
 from killtracker.forms import (
     TrackerAdminForm,
     TrackerAdminKillmailIdForm,

killtracker/app_settings.py

@@ -13,13 +13,8 @@ sometimes killmails appear belated on ZKB,
 this feature ensures they don't create new alerts.
 """
 
-KILLTRACKER_MAX_KILLMAILS_PER_RUN = clean_setting(
-    "KILLTRACKER_MAX_KILLMAILS_PER_RUN", 500
-)
-"""Maximum number of killmails retrieved from ZKB by task run."""
-
 KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS = clean_setting(
-    "KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS", 30
+    "KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS", default_value=30, min_value=0
 )
 """Killmails older than set number of days will be purged from the database.
 If you want to keep all killmails set this to 0.
@@ -103,9 +98,21 @@ KILLTRACKER_STORAGE_KILLMAILS_LIFETIME = clean_setting(
 )
 """Max lifetime of killmails in temporary storage in seconds."""
 
-KILLTRACKER_ZKB_REQUEST_DELAY = clean_setting("KILLTRACKER_ZKB_REQUEST_DELAY", 500)
+KILLTRACKER_ZKB_REQUEST_DELAY = clean_setting(
+    "KILLTRACKER_ZKB_REQUEST_DELAY", default_value=500, min_value=500
+)
 """Delay between subsequent calls to ZKB API in milliseconds.
 
 This delay ensures the app does not breach the CloudFlare rate limit of currently
 two (2) requests per second per IP address.
 """
+
+KILLTRACKER_MAX_KILLMAILS_PER_RUN = clean_setting(
+    "KILLTRACKER_MAX_KILLMAILS_PER_RUN", default_value=500, min_value=1
+)
+"""Maximum number of killmails retrieved from ZKB by task run."""
+
+KILLTRACKER_MAX_MESSAGES_SENT_PER_RUN = clean_setting(
+    "KILLTRACKER_MAX_MESSAGES_SENT_PER_RUN", default_value=10, min_value=1
+)
+"""Maximum number of messages processed per task run."""

killtracker/core/discord.py

@@ -0,0 +1,162 @@
+"""Send messages to Discord webhooks."""
+
+import datetime as dt
+import json
+from copy import copy
+from dataclasses import dataclass
+from http import HTTPStatus
+from time import sleep
+from typing import List, Optional
+
+import dhooks_lite
+
+from django.core.cache import cache
+from django.utils.timezone import now
+
+from allianceauth.services.hooks import get_extension_logger
+from app_utils.json import JSONDateTimeDecoder, JSONDateTimeEncoder
+from app_utils.logging import LoggerAddTag
+
+from killtracker import APP_NAME, HOMEPAGE_URL, __title__, __version__
+from killtracker.app_settings import KILLTRACKER_DISCORD_SEND_DELAY
+from killtracker.core.helpers import datetime_or_none
+
+_DEFAULT_429_TIMEOUT = 600
+
+logger = LoggerAddTag(get_extension_logger(__name__), __title__)
+
+
+class HTTPError(Exception):
+    """A HTTP error."""
+
+    def __init__(self, status_code: int):
+        self.status_code = status_code
+
+
+class WebhookRateLimitExhausted(Exception):
+    """The rate limit of a webhook has been exhausted."""
+
+    def __init__(self, retry_at: dt.datetime, is_original: bool = True):
+        self.retry_at = retry_at
+        self.is_original = is_original
+
+
+@dataclass
+class DiscordMessage:
+    """A Discord message created from a Killmail."""
+
+    avatar_url: Optional[str] = None
+    content: Optional[str] = None
+    embeds: Optional[List[dhooks_lite.Embed]] = None
+    killmail_id: int = 0  # Killmail ID this message from created from
+    username: Optional[str] = None
+
+    def __post_init__(self):
+        if not self.content and not self.embeds:
+            raise ValueError("Message must have content or embeds to be valid")
+
+    def to_json(self) -> str:
+        """Converts a Discord message into a JSON object and returns it."""
+
+        if self.embeds:
+            embeds_list = [obj.asdict() for obj in self.embeds]
+        else:
+            embeds_list = None
+
+        message = {}
+        if self.killmail_id:
+            message["killmail_id"] = self.killmail_id
+        if self.content:
+            message["content"] = self.content
+        if embeds_list:
+            message["embeds"] = embeds_list
+        if self.username:
+            message["username"] = self.username
+        if self.avatar_url:
+            message["avatar_url"] = self.avatar_url
+
+        return json.dumps(message, cls=JSONDateTimeEncoder)
+
+    @classmethod
+    def from_json(cls, s: str) -> "DiscordMessage":
+        """Creates a DiscordMessage object from an JSON object and returns it."""
+        message1: dict = json.loads(s, cls=JSONDateTimeDecoder)
+        message2 = copy(message1)
+        if message1.get("embeds"):
+            message2["embeds"] = [
+                dhooks_lite.Embed.from_dict(embed_dict)
+                for embed_dict in message1.get("embeds")
+            ]
+        else:
+            message2["embeds"] = None
+        return cls(**message2)
+
+
+def send_message_to_webhook(name: str, url: str, message: DiscordMessage) -> int:
+    """Send a message to a Discord webhook and returns the ID of new message."""
+
+    key_retry_at = _make_key_retry_at(url)
+    retry_at = datetime_or_none(cache.get(key_retry_at))
+    if retry_at is not None and retry_at > now():
+        raise WebhookRateLimitExhausted(retry_at=retry_at, is_original=False)
+
+    key_last_request = _make_key_last_request(url)
+    last_request = datetime_or_none(cache.get(key_last_request))
+    if last_request is not None:
+        next_slot = last_request + dt.timedelta(seconds=KILLTRACKER_DISCORD_SEND_DELAY)
+        seconds = (next_slot - now()).total_seconds()
+        if seconds > 0:
+            logger.debug(
+                "%s: Waiting %f seconds for next free slot for webhook", name, seconds
+            )
+            sleep(seconds)
+
+    hook = dhooks_lite.Webhook(
+        url=url,
+        user_agent=dhooks_lite.UserAgent(
+            name=APP_NAME, url=HOMEPAGE_URL, version=__version__
+        ),
+    )
+    response = hook.execute(
+        content=message.content,
+        embeds=message.embeds,
+        username=message.username,
+        avatar_url=message.avatar_url,
+        wait_for_response=True,
+        max_retries=0,  # we will handle retries ourselves
+    )
+    cache.set(key_last_request, now(), timeout=KILLTRACKER_DISCORD_SEND_DELAY + 30)
+    logger.debug(
+        "%s: Response from Discord for creating message from killmail %d: %s %s %s",
+        name,
+        message.killmail_id,
+        response.status_code,
+        response.headers,
+        response.content,
+    )
+    if not response.status_ok:
+        if response.status_code == HTTPStatus.TOO_MANY_REQUESTS:
+            try:
+                retry_after = int(response.headers["Retry-After"])
+            except KeyError:
+                retry_after = _DEFAULT_429_TIMEOUT
+            retry_at = now() + dt.timedelta(seconds=retry_after)
+            cache.set(key_retry_at, retry_at, timeout=retry_after + 60)
+            raise WebhookRateLimitExhausted(retry_at=retry_at, is_original=True)
+
+        raise HTTPError(response.status_code)
+
+    try:
+        message_id = int(response.content.get("id"))
+    except (AttributeError, ValueError):
+        message_id = 0
+
+    return message_id
+
+
+def _make_key_last_request(url):
+    return f"killtracker-webhook-last-request-{url}"
+
+
+def _make_key_retry_at(url):
+    return f"killtracker-webhook-retry-at-{url}"

killtracker/core/helpers.py

@@ -0,0 +1,13 @@
+"""Helper functions for core modules."""
+
+import datetime as dt
+from typing import Any, Optional
+
+
+def datetime_or_none(v: Any) -> Optional[dt.datetime]:
+    """Returns as datetime when it is a datetime else returns None."""
+    if v is None:
+        return None
+    if not isinstance(v, dt.datetime):
+        return None
+    return v

killtracker/core/{discord_messages.py → trackers.py}

@@ -1,14 +1,12 @@
-"""This module allows to create Discord messages from killmails."""
+"""Generate Discord messages from tracked killmails."""
 
 from __future__ import annotations
 
-import json
-from copy import copy
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, List, Optional
+from typing import TYPE_CHECKING, Optional
 
 import dhooks_lite
-from requests.exceptions import HTTPError
+import requests
 
 from eveuniverse.helpers import EveEntityNameResolver
 from eveuniverse.models import EveEntity, EveSolarSystem
@@ -16,89 +14,32 @@ from eveuniverse.models import EveEntity, EveSolarSystem
 from allianceauth.eveonline.evelinks import dotlan, eveimageserver, zkillboard
 from allianceauth.services.hooks import get_extension_logger
 from app_utils.django import app_labels
-from app_utils.json import JSONDateTimeDecoder, JSONDateTimeEncoder
 from app_utils.logging import LoggerAddTag
 from app_utils.urls import static_file_absolute_url
 from app_utils.views import humanize_value
 
 from killtracker import __title__
-
-from .killmails import ZKB_KILLMAIL_BASEURL, Killmail, TrackerInfo
+from killtracker.core.discord import DiscordMessage
+from killtracker.core.zkb import ZKB_KILLMAIL_BASEURL, Killmail, TrackerInfo
 
 if TYPE_CHECKING:
     from killtracker.models import Tracker
 
-
 _ICON_SIZE = 128
 
-
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
 
 
-@dataclass
-class DiscordMessage:
-    """A Discord message created from a Killmail."""
-
-    avatar_url: Optional[str] = None
-    content: Optional[str] = None
-    embeds: Optional[List[dhooks_lite.Embed]] = None
-    killmail_id: int = 0  # Killmail ID this message from created from
-    tts: Optional[bool] = None
-    username: Optional[str] = None
-
-    def __post_init__(self):
-        if not self.content and not self.embeds:
-            raise ValueError("Message must have content or embeds to be valid")
-
-    def to_json(self) -> str:
-        """Converts a Discord message into a JSON object and returns it."""
-
-        if self.embeds:
-            embeds_list = [obj.asdict() for obj in self.embeds]
-        else:
-            embeds_list = None
-
-        message = {}
-        if self.killmail_id:
-            message["killmail_id"] = self.killmail_id
-        if self.content:
-            message["content"] = self.content
-        if embeds_list:
-            message["embeds"] = embeds_list
-        if self.tts:
-            message["tts"] = self.tts
-        if self.username:
-            message["username"] = self.username
-        if self.avatar_url:
-            message["avatar_url"] = self.avatar_url
-
-        return json.dumps(message, cls=JSONDateTimeEncoder)
-
-    @classmethod
-    def from_json(cls, s: str) -> "DiscordMessage":
-        """Creates a DiscordMessage object from an JSON object and returns it."""
-        message1: dict = json.loads(s, cls=JSONDateTimeDecoder)
-        message2 = copy(message1)
-        if message1.get("embeds"):
-            message2["embeds"] = [
-                dhooks_lite.Embed.from_dict(embed_dict)
-                for embed_dict in message1.get("embeds")
-            ]
-        else:
-            message2["embeds"] = None
-        return cls(**message2)
-
-    @classmethod
-    def from_killmail(
-        cls, tracker: Tracker, killmail: Killmail, intro_text: Optional[str] = None
-    ) -> "DiscordMessage":
-        """Creates a DiscordMessage object from a Killmail and returns it."""
-        m = DiscordMessage(
-            killmail_id=killmail.id,
-            content=_create_content(tracker, intro_text),
-            embeds=[_create_embed(tracker, killmail)],
-        )
-        return m
+def create_discord_message_from_killmail(
+    tracker: Tracker, killmail: Killmail, intro_text: Optional[str] = None
+) -> "DiscordMessage":
+    """Creates a Discord message from a Killmail and returns it."""
+    m = DiscordMessage(
+        killmail_id=killmail.id,
+        content=_create_content(tracker, intro_text),
+        embeds=[_create_embed(tracker, killmail)],
+    )
+    return m
 
 
 @dataclass(frozen=True)
@@ -154,7 +95,7 @@ def _create_content(tracker: Tracker, intro_text: Optional[str] = None) -> str:
             for group in tracker.ping_groups.all():
                 try:
                     role = DiscordUser.objects.group_to_role(group)  # type: ignore
-                except HTTPError:
+                except requests.exceptions.HTTPError:
                     logger.warning(
                         "Failed to get Discord roles. Can not ping groups.",
                         exc_info=True,

killtracker/core/{worker_shutdown.py → workers.py}

@@ -1,5 +1,4 @@
-"""Module worker_shutdown allows tasks to find out
-whether their worker is currently shutting down.
+"""Allows tasks to find out whether their worker is currently shutting down.
 
 This enables long running tasks to abort early,
 which helps to speed up a warm worker shutdown.
@@ -19,12 +18,12 @@ _TIMEOUT_SECONDS = 120
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
 
 
-def reset(hostname: str) -> None:
+def state_reset(hostname: str) -> None:
     """Resets the shutting down state for a worker."""
     cache.delete(_make_key(hostname))
 
 
-def set(hostname: str) -> None:
+def state_set(hostname: str) -> None:
     """Sets a worker into the shutting down state."""
     cache.set(_make_key(hostname), "shutting down", timeout=_TIMEOUT_SECONDS)
 

killtracker/core/{killmails.py → zkb.py}

@@ -1,4 +1,4 @@
-"""Fetching killmails from ZKB."""
+"""Fetch killmails from zKillboard."""
 
 # pylint: disable = redefined-builtin
 
@@ -32,19 +32,22 @@ from killtracker.app_settings import (
     KILLTRACKER_STORAGE_KILLMAILS_LIFETIME,
     KILLTRACKER_ZKB_REQUEST_DELAY,
 )
-from killtracker.exceptions import KillmailDoesNotExist
+from killtracker.core.helpers import datetime_or_none
 from killtracker.providers import esi
 
-logger = LoggerAddTag(get_extension_logger(__name__), __title__)
-
-ZKB_REDISQ_URL = "https://zkillredisq.stream/listen.php"
-ZKB_API_URL = "https://zkillboard.com/api/"
 ZKB_KILLMAIL_BASEURL = "https://zkillboard.com/kill/"
-REQUESTS_TIMEOUT = (5, 30)
-DEFAULT_429_TIMEOUT = 10
 
-MAIN_MINIMUM_COUNT = 2
-MAIN_MINIMUM_SHARE = 0.25
+_KEY_RETRY_AT = "killtracker-zkb-retry-at"
+_KEY_LAST_REQUEST = "killtracker-zkb-last-request"
+_MAIN_MINIMUM_COUNT = 2
+_MAIN_MINIMUM_SHARE = 0.25
+_REQUESTS_TIMEOUT = (5, 30)
+_ZKB_429_DEFAULT_TIMEOUT = 10
+_ZKB_API_URL = "https://zkillboard.com/api/"
+_ZKB_REDISQ_URL = "https://zkillredisq.stream/listen.php"
+
+logger = LoggerAddTag(get_extension_logger(__name__), __title__)
+
 
 # TODO: Factor out logic for accessing the API to another module
 
@@ -57,6 +60,10 @@ class ZKBTooManyRequestsError(Exception):
         self.is_original = is_original
 
 
+class KillmailDoesNotExist(Exception):
+    """Killmail does not exist in storage."""
+
+
 @dataclass
 class _KillmailBase:
     """Base class for all Killmail."""
@@ -264,8 +271,8 @@ class Killmail(_KillmailBase):
         jumps: Optional[int] = None,
         distance: Optional[float] = None,
         matching_ship_type_ids: Optional[List[int]] = None,
-        minimum_count: int = MAIN_MINIMUM_COUNT,
-        minimum_share: float = MAIN_MINIMUM_SHARE,
+        minimum_count: int = _MAIN_MINIMUM_COUNT,
+        minimum_share: float = _MAIN_MINIMUM_SHARE,
     ) -> "Killmail":
         """Clone this killmail and add tracker info."""
         main_ship_group = self._calc_main_attacker_ship_group(
@@ -419,45 +426,30 @@ class Killmail(_KillmailBase):
         if "," in KILLTRACKER_QUEUE_ID:
             raise ImproperlyConfigured("A queue ID must not contains commas.")
 
-        key_retry_at = "killtracker-retry-at"
-        if (v := cache.get(key_retry_at)) is not None:
-            try:
-                retry_at = dt.datetime.fromisoformat(v)
-            except (TypeError, ValueError):
-                cache.delete(key_retry_at)
-                logger.warning("unable to parse timestamp of retry at")
-                return None
-
-            if retry_at > now():
-                raise ZKBTooManyRequestsError(retry_at=retry_at, is_original=False)
-
-        key_last_request = "killtracker-last-request"
-        if (v := cache.get(key_last_request)) is not None:
-            try:
-                last_request = dt.datetime.fromisoformat(v)
-            except (TypeError, ValueError):
-                cache.delete(key_last_request)
-                logger.warning("unable to parse timestamp of last request")
-                last_request = now()
+        retry_at = datetime_or_none(cache.get(_KEY_RETRY_AT))
+        if retry_at is not None and retry_at > now():
+            raise ZKBTooManyRequestsError(retry_at=retry_at, is_original=False)
 
+        last_request = datetime_or_none(cache.get(_KEY_LAST_REQUEST))
+        if last_request is not None:
             next_slot = last_request + dt.timedelta(
                 milliseconds=KILLTRACKER_ZKB_REQUEST_DELAY
             )
             seconds = (next_slot - now()).total_seconds()
             if seconds > 0:
-                logger.debug("Waiting %f seconds to for next free slot", seconds)
+                logger.debug("ZKB API: Waiting %f seconds for next free slot", seconds)
                 sleep(seconds)
 
         response = requests.get(
-            ZKB_REDISQ_URL,
+            _ZKB_REDISQ_URL,
             params={
                 "queueID": quote_plus(KILLTRACKER_QUEUE_ID),
                 "ttw": KILLTRACKER_REDISQ_TTW,
             },
-            timeout=REQUESTS_TIMEOUT,
+            timeout=_REQUESTS_TIMEOUT,
             headers={"User-Agent": USER_AGENT_TEXT},
         )
-        cache.set(key_last_request, dt.datetime.isoformat(now()), timeout=30)
+        cache.set(_KEY_LAST_REQUEST, now(), timeout=KILLTRACKER_ZKB_REQUEST_DELAY + 30)
         logger.debug(
             "Response from ZKB API: %d %s %s",
             response.status_code,
@@ -473,9 +465,9 @@ class Killmail(_KillmailBase):
                 try:
                     retry_after = int(response.headers["Retry-After"])
                 except KeyError:
-                    retry_after = DEFAULT_429_TIMEOUT
+                    retry_after = _ZKB_429_DEFAULT_TIMEOUT
                 retry_at = now() + dt.timedelta(seconds=retry_after)
-                cache.set(key_retry_at, retry_at.isoformat(), timeout=retry_after + 60)
+                cache.set(_KEY_RETRY_AT, retry_at, timeout=retry_after + 60)
                 raise ZKBTooManyRequestsError(retry_at=retry_at, is_original=True)
 
             return None
@@ -514,9 +506,9 @@ class Killmail(_KillmailBase):
             "Trying to fetch killmail from ZKB API with killmail ID %d ...",
             killmail_id,
         )
-        url = f"{ZKB_API_URL}killID/{killmail_id}/"
+        url = f"{_ZKB_API_URL}killID/{killmail_id}/"
         response = requests.get(
-            url, timeout=REQUESTS_TIMEOUT, headers={"User-Agent": USER_AGENT_TEXT}
+            url, timeout=_REQUESTS_TIMEOUT, headers={"User-Agent": USER_AGENT_TEXT}
         )
         response.raise_for_status()
         zkb_data = response.json()