Merge branch 'fix-auto-archiving' into 'main'

Fix auto archiving task

See merge request reportcreator/reportcreator!471

CHANGELOG.md

@@ -8,6 +8,7 @@
 * Prevent cutting off spellcheck error underlines in string fields
 * Add more language variants for spellcheck
 * Allow duplicating finding templates
+* Fix error in periodic task for automatic project archiving
 
 
 ## v2024.16 - 2024-02-22

api/src/reportcreator_api/pentests/querysets.py

@@ -23,6 +23,7 @@
 from reportcreator_api.users.models import PentestUser
 from reportcreator_api.utils.files import normalize_filename
 from reportcreator_api.utils.history import bulk_create_with_history, bulk_delete_with_history, bulk_update_with_history, history_context
+from reportcreator_api.utils.models import SubqueryCount
 from reportcreator_api.utils.utils import groupby_to_dict, omit_keys, get_key_or_attr, set_key_or_attr
 from reportcreator_api.archive.crypto import pgp
 
@@ -459,12 +460,10 @@ def filter_projects_can_be_archived(self, projects):
         archive_user_count = PentestUser.objects \
             .filter(models.Q(is_global_archiver=True) | models.Q(projectmemberinfo__project=models.OuterRef('pk'))) \
             .only_active() \
-            .only_with_public_keys() \
-            .annotate(user_count=models.Count('id', distinct=True)) \
-            .values('user_count')
+            .only_with_public_keys()
 
         return projects \
-            .annotate(archive_user_count=models.Subquery(archive_user_count)) \
+            .annotate(archive_user_count=SubqueryCount(archive_user_count)) \
             .filter(archive_user_count__gte=settings.ARCHIVING_THRESHOLD)
 
     @transaction.atomic()

api/src/reportcreator_api/pentests/tasks.py

@@ -168,20 +168,20 @@ def reset_stale_archive_restores(task_info):
 
 
 async def automatically_archive_projects(task_info):
-    if not settings.AUTOMATICALLY_ARCHIVE_PROJECTS_AFTER or not license.is_professional():
+    if not settings.AUTOMATICALLY_ARCHIVE_PROJECTS_AFTER or not await license.ais_professional():
         return
 
     projects_to_archive = PentestProject.objects \
+        .only_archivable() \
         .filter(readonly=True) \
         .filter(readonly_since__lt=timezone.now() - settings.AUTOMATICALLY_ARCHIVE_PROJECTS_AFTER) \
-        .only_archivable()
 
     async for p in projects_to_archive:
         await sync_to_async(ArchivedProject.objects.create_from_project)(p)
 
 
 async def automatically_delete_archived_projects(task_info):
-    if not settings.AUTOMATICALLY_DELETE_ARCHIVED_PROJECTS_AFTER or not license.is_professional():
+    if not settings.AUTOMATICALLY_DELETE_ARCHIVED_PROJECTS_AFTER or not await license.ais_professional():
         return
 
     await ArchivedProject.objects \

api/src/reportcreator_api/tests/test_periodic_tasks.py

@@ -396,6 +396,7 @@ def setUp(self):
             yield
 
     def test_archived(self):
+        create_user(public_key=True, is_global_archiver=True)
         project_active = create_project(readonly=False, members=[self.user])
 
         with mock_time(after=timedelta(days=40)):

api/src/reportcreator_api/utils/license.py

@@ -144,6 +144,10 @@ def is_professional():
     return check_license().get('type', LicenseType.COMMUNITY) == LicenseType.PROFESSIONAL
 
 
+async def ais_professional():
+    return (await acheck_license()).get('type', LicenseType.COMMUNITY) == LicenseType.PROFESSIONAL
+
+
 def validate_login_allowed(user):
     if not is_professional() and not user.is_superuser:
         raise LicenseError('Only superusers are allowed to login. A Professional license is required to enable user roles.')

api/src/reportcreator_api/utils/models.py

@@ -94,3 +94,9 @@ def wrapper(*args, **kwargs):
             return
         signal_handler(*args, **kwargs)
     return wrapper
+
+
+class SubqueryCount(models.Subquery):
+    template = "(SELECT count(*) FROM (%(subquery)s) _count)"
+    output_field = models.PositiveIntegerField()
+