aa-structures 3.2.2__tar.gz → 3.3.1__tar.gz

{aa_structures-3.2.2 → aa_structures-3.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aa-structures
-Version: 3.2.2
+Version: 3.3.1
 Summary: App for managing Eve Online structures with Alliance Auth.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8
@@ -20,14 +20,14 @@ 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.27
+Requires-Dist: allianceauth-app-utils>=1.29.1
 Requires-Dist: allianceauth>=4,<5
 Requires-Dist: dhooks-lite>=1.0
-Requires-Dist: django-eveuniverse>=1.5.2
+Requires-Dist: django-eveuniverse>=1.6
 Requires-Dist: django-multiselectfield
 Requires-Dist: django-navhelper
 Requires-Dist: pytz!=2022.2
-Requires-Dist: redis-simple-mq>=1.0
+Requires-Dist: redis-simple-mq>=1.1
 Requires-Dist: humanize>=4.7
 Project-URL: Changelog, https://gitlab.com/ErikKalkoken/aa-structures/-/blob/master/CHANGELOG.md
 Project-URL: Documentation, https://aa-structures.readthedocs.io/en/latest/

{aa_structures-3.2.2 → aa_structures-3.3.1}/pyproject.toml

@@ -26,14 +26,14 @@ classifiers = [
     "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
 ]
 dependencies = [
-    "allianceauth-app-utils>=1.27",
+    "allianceauth-app-utils>=1.29.1",
     "allianceauth>=4,<5",
     "dhooks-lite>=1.0",
-    "django-eveuniverse>=1.5.2",
+    "django-eveuniverse>=1.6",
     "django-multiselectfield",
     "django-navhelper",
     "pytz!=2022.2",
-    "redis-simple-mq>=1.0",
+    "redis-simple-mq>=1.1",
     "humanize>=4.7",
 ]
 

{aa_structures-3.2.2 → aa_structures-3.3.1}/structures/__init__.py

@@ -3,5 +3,5 @@
 # pylint: disable = invalid-name
 default_app_config = "structures.apps.StructuresConfig"
 
-__version__ = "3.2.2"
+__version__ = "3.3.1"
 __title__ = "Structures"

{aa_structures-3.2.2 → aa_structures-3.3.1}/structures/tasks.py

@@ -2,14 +2,15 @@
 
 from typing import Iterable, Optional
 
-from celery import chain, shared_task
+from celery import Task, chain, shared_task
 
 from django.contrib.auth.models import User
+from django.db.models import QuerySet
 
 from allianceauth.notifications import notify
 from allianceauth.services.hooks import get_extension_logger
 from allianceauth.services.tasks import QueueOnce
-from app_utils.esi import fetch_esi_status
+from app_utils.esi import retry_task_on_esi_error_and_offline
 from app_utils.logging import LoggerAddTag
 
 from . import __title__
@@ -19,6 +20,7 @@ from .models import (
     EveSovereigntyMap,
     FuelAlertConfig,
     JumpFuelAlertConfig,
+    Notification,
     Owner,
     Webhook,
 )
@@ -35,19 +37,14 @@ def update_all_structures():
     Main task for starting regular update of all structures
     and related data from ESI.
     """
-    if not fetch_esi_status().is_ok:
-        logger.warning("ESI currently not available. Aborting.")
-        return
     chain(update_sov_map.si(), update_structures.si()).delay()
 
 
-@shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
-def update_sov_map():
+@shared_task(bind=True, base=QueueOnce, time_limit=STRUCTURES_TASKS_TIME_LIMIT)
+def update_sov_map(self: Task):
     """Update sovereignty map from ESI."""
-    if not fetch_esi_status().is_ok:
-        logger.warning("ESI currently not available. Aborting.")
-        return
-    EveSovereigntyMap.objects.update_or_create_all_from_esi()
+    with retry_task_on_esi_error_and_offline(self):
+        EveSovereigntyMap.objects.update_or_create_all_from_esi()
 
 
 @shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
@@ -68,7 +65,7 @@ def update_structures():
 
 
 @shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
-def update_all_for_owner(owner_pk, user_pk: Optional[int] = None):
+def update_all_for_owner(owner_pk: int, user_pk: Optional[int] = None):
     """Update structures and notifications for owner from ESI."""
     chain(
         update_structures_for_owner.si(owner_pk, user_pk),
@@ -77,44 +74,64 @@ def update_all_for_owner(owner_pk, user_pk: Optional[int] = None):
 
 
 @shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
-def update_structures_for_owner(owner_pk, user_pk: Optional[int] = None):
+def update_structures_for_owner(owner_pk: int, user_pk: Optional[int] = None):
     """Fetch all structures for owner and update related corp assets from ESI."""
-    if not fetch_esi_status().is_ok:
-        logger.warning("ESI currently not available. Aborting.")
-    else:
-        chain(
-            update_structures_esi_for_owner.si(owner_pk, user_pk),
-            update_structures_assets_for_owner.si(owner_pk, user_pk),
-        ).delay()
+    chain(
+        update_structures_esi_for_owner.si(owner_pk, user_pk),
+        update_structures_assets_for_owner.si(owner_pk, user_pk),
+    ).delay()
 
 
-@shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
-def update_structures_esi_for_owner(owner_pk, user_pk: Optional[int] = None):
-    """Update all structures for owner for ESI."""
+@shared_task(
+    bind=True,
+    base=QueueOnce,
+    once={"keys": ["owner_pk"], "graceful": True},
+    time_limit=STRUCTURES_TASKS_TIME_LIMIT,
+)
+def update_structures_esi_for_owner(
+    self: Task, owner_pk: int, user_pk: Optional[int] = None
+):
+    """Update all structures for an owner from ESI.
+
+    Optionally notify user_pk about the result.
+    """
     owner = Owner.objects.get(pk=owner_pk)
-    owner.update_structures_esi(_get_user(user_pk))
+    with retry_task_on_esi_error_and_offline(self):
+        owner.update_structures_esi(_get_user(user_pk))
 
 
-@shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
-def update_structures_assets_for_owner(owner_pk, user_pk: Optional[int] = None):
-    """Update all related assets for owner."""
+@shared_task(
+    bind=True,
+    base=QueueOnce,
+    once={"keys": ["owner_pk"], "graceful": True},
+    time_limit=STRUCTURES_TASKS_TIME_LIMIT,
+)
+def update_structures_assets_for_owner(
+    self: Task, owner_pk: int, user_pk: Optional[int] = None
+):
+    """Update all related assets for an owner from ESI.
+
+    Optionally notify user_pk about the result.
+    """
     owner = Owner.objects.get(pk=owner_pk)
-    owner.update_asset_esi(_get_user(user_pk))
+    with retry_task_on_esi_error_and_offline(self):
+        owner.update_asset_esi(_get_user(user_pk))
 
 
 @shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
 def fetch_all_notifications():
     """Fetch notifications for all owners and send new fuel notifications."""
-    for owner in Owner.objects.all():
-        if owner.is_active:
-            owner.update_is_up()
-            process_notifications_for_owner.apply_async(
-                kwargs={"owner_pk": owner.pk}, priority=TASK_PRIORITY_HIGH
-            )
+    for owner in Owner.objects.filter(is_active=True):
+        owner.update_is_up()
+        process_notifications_for_owner.apply_async(
+            kwargs={"owner_pk": owner.pk}, priority=TASK_PRIORITY_HIGH
+        )
+
     for config_pk in FuelAlertConfig.objects.filter(is_enabled=True).values_list(
         "pk", flat=True
     ):
         send_structure_fuel_notifications_for_config.delay(config_pk)
+
     for config_pk in JumpFuelAlertConfig.objects.filter(is_enabled=True).values_list(
         "pk", flat=True
     ):
@@ -124,9 +141,6 @@ def fetch_all_notifications():
 @shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
 def process_notifications_for_owner(owner_pk: int, user_pk: Optional[int] = None):
     """Fetch all notification for owner from ESI and processes them."""
-    if not fetch_esi_status().is_ok:
-        logger.warning("ESI currently not available. Aborting.")
-        return
     chain(
         fetch_notification_for_owner.si(owner_pk=owner_pk, user_pk=user_pk).set(
             priority=TASK_PRIORITY_HIGH
@@ -143,11 +157,22 @@ def process_notifications_for_owner(owner_pk: int, user_pk: Optional[int] = None
     ).delay()
 
 
-@shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
-def fetch_notification_for_owner(owner_pk: int, user_pk: Optional[int] = None):
-    """Fetch notifications from ESI."""
+@shared_task(
+    bind=True,
+    base=QueueOnce,
+    once={"keys": ["owner_pk"], "graceful": True},
+    time_limit=STRUCTURES_TASKS_TIME_LIMIT,
+)
+def fetch_notification_for_owner(
+    self: Task, owner_pk: int, user_pk: Optional[int] = None
+):
+    """Fetch notifications from ESI.
+
+    Optionally notify user_pk about the result.
+    """
     owner = Owner.objects.get(pk=owner_pk)
-    owner.fetch_notifications_esi(_get_user(user_pk))
+    with retry_task_on_esi_error_and_offline(self):
+        owner.fetch_notifications_esi(_get_user(user_pk))
 
 
 @shared_task(time_limit=STRUCTURES_TASKS_TIME_LIMIT)
@@ -157,7 +182,7 @@ def update_notifications_structure_relations(owner_pk: int) -> int:
     Returns number of updated notifications.
     """
     owner = Owner.objects.get(pk=owner_pk)
-    notif_need_update_qs = owner.notification_set.filter(
+    notif_need_update_qs: QuerySet[Notification] = owner.notification_set.filter(
         notif_type__in=NotificationType.structure_related(), structures__isnull=True
     )
     notif_need_update_count = notif_need_update_qs.count()
@@ -213,7 +238,7 @@ def send_queued_messages_for_webhooks(webhooks: Iterable[Webhook]):
             )
 
 
-@shared_task(base=QueueOnce)
+@shared_task(base=QueueOnce, time_limit=STRUCTURES_TASKS_TIME_LIMIT)
 def send_messages_for_webhook(webhook_pk: int) -> None:
     """Send all currently queued messages for given webhook to Discord."""
     Webhook.objects.send_queued_messages_for_webhook(webhook_pk)

{aa_structures-3.2.2 → aa_structures-3.3.1}/structures/tests/integration/test_tasks.py

@@ -10,8 +10,8 @@ from django.utils.timezone import now
 from eveuniverse.models import EvePlanet, EveSolarSystem
 
 from app_utils.django import app_labels
-from app_utils.esi import EsiStatus
 from app_utils.esi_testing import EsiClientStub, EsiEndpoint
+from app_utils.testing import reset_celery_once_locks
 
 from structures import tasks
 from structures.core.notification_types import NotificationType
@@ -54,7 +54,6 @@ TASKS_PATH = "structures.tasks"
 @patch(OWNERS_PATH + ".STRUCTURES_FEATURE_CUSTOMS_OFFICES", True)
 @patch(OWNERS_PATH + ".STRUCTURES_FEATURE_STARBASES", True)
 @patch("structures.webhooks.core.dhooks_lite.Webhook.execute", spec=True)
-@patch(TASKS_PATH + ".fetch_esi_status", lambda: EsiStatus(True, 99, 60))
 @patch(MANAGERS_PATH + ".esi")
 @patch(OWNERS_PATH + ".esi")
 class TestTasks(TestCase):
@@ -62,6 +61,7 @@ class TestTasks(TestCase):
     def setUpClass(cls):
         super().setUpClass()
         load_eveuniverse()
+        reset_celery_once_locks("structures")
 
     def test_should_fetch_new_upwell_structure_from_esi(
         self, mock_esi_2, mock_esi, mock_execute

{aa_structures-3.2.2 → aa_structures-3.3.1}/structures/tests/test_tasks.py

@@ -3,9 +3,12 @@ from unittest.mock import patch
 from django.contrib.auth.models import User
 from django.test import TestCase, override_settings
 
-from app_utils.esi import EsiStatus
 from app_utils.testdata_factories import UserFactory
-from app_utils.testing import NoSocketsTestCase, generate_invalid_pk
+from app_utils.testing import (
+    NoSocketsTestCase,
+    generate_invalid_pk,
+    reset_celery_once_locks,
+)
 
 from structures import tasks
 from structures.core.notification_types import NotificationType
@@ -24,37 +27,40 @@ MODULE_PATH = "structures.tasks"
 MODULE_PATH_MODELS_OWNERS = "structures.models.owners"
 
 
+@override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
 @patch(MODULE_PATH + ".Webhook.send_queued_messages", spec=True)
 class TestSendMessagesForWebhook(TestCase):
     @classmethod
-    def setUpClass(cls):  # Can not be setUpTestData due to conflict with redis client
+    def setUpClass(cls):
         super().setUpClass()
         cls.webhook = WebhookFactory()
+        reset_celery_once_locks("structures")
 
     def test_normal(self, mock_send_queued_messages):
-        tasks.send_messages_for_webhook(self.webhook.pk)
+        tasks.send_messages_for_webhook.delay(self.webhook.pk)
         self.assertEqual(mock_send_queued_messages.call_count, 1)
 
     def test_invalid_pk(self, mock_send_queued_messages):
-        tasks.send_messages_for_webhook(generate_invalid_pk(Webhook))
+        tasks.send_messages_for_webhook.delay(generate_invalid_pk(Webhook))
         self.assertEqual(mock_send_queued_messages.call_count, 0)
 
     def test_disabled_webhook(self, mock_send_queued_messages):
         self.webhook.is_active = False
         self.webhook.save()
 
-        tasks.send_messages_for_webhook(self.webhook.pk)
+        tasks.send_messages_for_webhook.delay(self.webhook.pk)
         self.assertEqual(mock_send_queued_messages.call_count, 0)
 
 
 @override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
 @patch(MODULE_PATH + ".Owner.update_structures_esi", spec=True)
-class TestUpdateStructuresEsi(NoSocketsTestCase):
+class TestUpdateStructuresEsi(TestCase):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
         cls.user = UserMainDefaultOwnerFactory()
         cls.owner = OwnerFactory(user=cls.user, is_alliance_main=True)
+        reset_celery_once_locks("structures")
 
     def test_call_structure_update_with_owner_only(self, mock_update_structures_esi):
         """TODO: Investigate how to call the top level method that contains the chains()"""
@@ -85,12 +91,13 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
 
 @override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
 @patch(MODULE_PATH + ".update_structures_for_owner", spec=True)
-class TestUpdateStructuresForOwner(NoSocketsTestCase):
+class TestUpdateStructuresForOwner(TestCase):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
         cls.user = UserMainDefaultOwnerFactory()
         cls.owner = OwnerFactory(user=cls.user, is_alliance_main=True)
+        reset_celery_once_locks("structures")
 
     def test_can_update_structures_for_all_owners(
         self, mock_update_structures_for_owner
@@ -117,19 +124,22 @@ class TestUpdateStructuresForOwner(NoSocketsTestCase):
         self.assertSetEqual(owner_pks, {self.owner.pk})
 
 
+# TODO: Investigate how to call the top level method that contains the chains()
+
+
 @override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
-class TestUpdateOwnerAsset(NoSocketsTestCase):
+class TestUpdateOwnerAsset(TestCase):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
         cls.user = UserMainDefaultOwnerFactory()
         cls.owner = OwnerFactory(user=cls.user, is_alliance_main=True)
+        reset_celery_once_locks("structures")
 
     @patch(MODULE_PATH + ".Owner.update_asset_esi")
     def test_call_structure_asset_update_with_owner_and_user(
         self, mock_update_asset_esi
     ):
-        """TODO: Investigate how to call the top level method that contains the chains()"""
         tasks.update_structures_assets_for_owner(self.owner.pk, self.user.pk)
         first, _ = mock_update_asset_esi.call_args
         self.assertEqual(first[0], self.user)
@@ -138,19 +148,14 @@ class TestUpdateOwnerAsset(NoSocketsTestCase):
     def test_call_structure_asset_update_with_owner_and_ignores_invalid_user(
         self, mock_update_asset_esi
     ):
-        """TODO: Investigate how to call the top level method that contains the chains()"""
         tasks.update_structures_assets_for_owner(
             self.owner.pk, generate_invalid_pk(User)
         )
         first, _ = mock_update_asset_esi.call_args
         self.assertIsNone(first[0])
 
-    @override_settings(
-        CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True
-    )
     def test_raises_exception_if_owner_is_unknown(self):
         with self.assertRaises(Owner.DoesNotExist):
-            """TODO: Investigate how to call the top level method that contains the chains()"""
             tasks.update_structures_assets_for_owner(
                 owner_pk=generate_invalid_pk(Owner)
             )
@@ -317,15 +322,15 @@ class TestUpdateNotificationsStructureRelations(NoSocketsTestCase):
         self.assertEqual(result, 0)
 
 
-@patch(MODULE_PATH + ".fetch_esi_status", lambda: EsiStatus(True))
-class TestOtherTasks(NoSocketsTestCase):
+@override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
+class TestOtherTasks(TestCase):
     @patch(
         MODULE_PATH + ".EveSovereigntyMap.objects.update_or_create_all_from_esi",
         spec=True,
     )
     def test_should_call_update_sov_map_from_esi(self, mock_update_from_esi):
         # when
-        tasks.update_sov_map()
+        tasks.update_sov_map.delay()
         # then
         self.assertTrue(mock_update_from_esi.called)
 
@@ -334,7 +339,7 @@ class TestOtherTasks(NoSocketsTestCase):
         # given
         owner = OwnerFactory()
         # when
-        tasks.fetch_notification_for_owner(owner.pk)
+        tasks.fetch_notification_for_owner.delay(owner.pk)
         # then
         self.assertTrue(mock_fetch_notifications_esi.called)
 
@@ -346,7 +351,7 @@ class TestOtherTasks(NoSocketsTestCase):
         # given
         owner = OwnerFactory()
         # when
-        tasks.send_new_notifications_for_owner(owner.pk)
+        tasks.send_new_notifications_for_owner.delay(owner.pk)
         # then
         self.assertTrue(mock_send_new_notifications.called)
         self.assertTrue(mock_send_queued_messages_for_webhooks.called)
@@ -359,7 +364,7 @@ class TestOtherTasks(NoSocketsTestCase):
         # given
         config = FuelAlertConfigFactory()
         # when
-        tasks.send_structure_fuel_notifications_for_config(config.pk)
+        tasks.send_structure_fuel_notifications_for_config.delay(config.pk)
         # then
         self.assertTrue(mock_send_new_notifications.called)
         self.assertTrue(mock_send_queued_messages_for_webhooks.called)
@@ -372,7 +377,7 @@ class TestOtherTasks(NoSocketsTestCase):
         # given
         config = JumpFuelAlertConfigFactory()
         # when
-        tasks.send_jump_fuel_notifications_for_config(config.pk)
+        tasks.send_jump_fuel_notifications_for_config.delay(config.pk)
         # then
         self.assertTrue(mock_send_new_notifications.called)
         self.assertTrue(mock_send_queued_messages_for_webhooks.called)