feat(screenshot): add change events for screenshot unit assignment and removal (#17067)

Implement proper change event tracking for screenshot-unit relationships to enable autotranslate
functionality with screenshot filters. Add SCREENSHOT_REMOVED action event for tracking unit
removal.

Author: amCap1712

docs/specs/openapi.yaml

@@ -105,6 +105,7 @@ def change_event(self, change: Change, activity_log_id: int | None = None) -> No
         elif change.action in {
             ActionEvents.SCREENSHOT_UPLOADED,
             ActionEvents.SCREENSHOT_ADDED,
+            ActionEvents.SCREENSHOT_REMOVED,
         }:
             if change.screenshot is not None:
                 units.extend(change.screenshot.units.all())

weblate/addons/autotranslate.py

@@ -5109,6 +5109,13 @@ def test_create(self) -> None:
                 },
             )
         self.assertEqual(Screenshot.objects.count(), 2)
+        self.assertEqual(
+            Change.objects.filter(
+                action=ActionEvents.SCREENSHOT_UPLOADED,
+                screenshot__name="Test create screenshot",
+            ).count(),
+            1,
+        )
 
     def test_patch_screenshot(self) -> None:
         self.do_request(
@@ -5185,36 +5192,52 @@ def test_units_invalid(self) -> None:
 
     def test_units(self) -> None:
         self.authenticate(True)
+        screenshot = Screenshot.objects.get()
         unit = self.component.source_translation.unit_set.all()[0]
         response = self.client.post(
-            reverse("api:screenshot-units", kwargs={"pk": Screenshot.objects.get().pk}),
+            reverse("api:screenshot-units", kwargs={"pk": screenshot.pk}),
             {"unit_id": unit.pk},
         )
         self.assertEqual(response.status_code, 200)
         self.assertIn(str(unit.pk), response.data["units"][0])
+        added_changes = Change.objects.filter(
+            action=ActionEvents.SCREENSHOT_ADDED,
+            screenshot=screenshot,
+            unit=unit,
+        )
+        self.assertEqual(added_changes.count(), 1)
+        self.assertEqual(added_changes[0].user, self.user)
 
     def test_units_delete(self) -> None:
         self.authenticate(True)
+        screenshot = Screenshot.objects.get()
         unit = self.component.source_translation.unit_set.all()[0]
         self.client.post(
-            reverse("api:screenshot-units", kwargs={"pk": Screenshot.objects.get().pk}),
+            reverse("api:screenshot-units", kwargs={"pk": screenshot.pk}),
             {"unit_id": unit.pk},
         )
         response = self.client.delete(
             reverse(
                 "api:screenshot-delete-units",
-                kwargs={"pk": Screenshot.objects.get().pk, "unit_id": 100000},
+                kwargs={"pk": screenshot.pk, "unit_id": 100000},
             ),
         )
         self.assertEqual(response.status_code, 404)
         response = self.client.delete(
             reverse(
                 "api:screenshot-delete-units",
-                kwargs={"pk": Screenshot.objects.get().pk, "unit_id": unit.pk},
+                kwargs={"pk": screenshot.pk, "unit_id": unit.pk},
             ),
         )
         self.assertEqual(response.status_code, 204)
-        self.assertEqual(Screenshot.objects.get().units.all().count(), 0)
+        self.assertEqual(screenshot.units.all().count(), 0)
+        removed_changes = Change.objects.filter(
+            action=ActionEvents.SCREENSHOT_REMOVED,
+            screenshot=screenshot,
+            unit=unit,
+        )
+        self.assertEqual(removed_changes.count(), 1)
+        self.assertEqual(removed_changes[0].user, self.user)
 
 
 class ChangeAPITest(APIBaseTest):

weblate/api/tests.py

@@ -2310,7 +2310,7 @@ def units(self, request: Request, **kwargs):
         except (Unit.DoesNotExist, ValueError) as error:
             raise ValidationError({"unit_id": str(error)}) from error
 
-        obj.units.add(unit)
+        obj.add_unit(unit, user=request.user)
         serializer = ScreenshotSerializer(obj, context={"request": request})
 
         return Response(serializer.data, status=HTTP_200_OK)
@@ -2329,7 +2329,7 @@ def delete_units(self, request: Request, pk, unit_id):
             unit = obj.translation.unit_set.get(pk=unit_id)
         except Unit.DoesNotExist as error:
             raise Http404(str(error)) from error
-        obj.units.remove(unit)
+        obj.remove_unit(unit, user=request.user)
         return Response(status=HTTP_204_NO_CONTENT)
 
     def create(self, request: Request, *args, **kwargs):
@@ -2359,11 +2359,21 @@ def create(self, request: Request, *args, **kwargs):
             )
             serializer.is_valid(raise_exception=True)
             instance = serializer.save(translation=translation, user=request.user)
+
             instance.change_set.create(
-                action=ActionEvents.SCREENSHOT_ADDED,
+                action=ActionEvents.SCREENSHOT_UPLOADED,
                 user=request.user,
                 target=instance.name,
             )
+
+            for unit in instance.units.all():
+                instance.change_set.create(
+                    action=ActionEvents.SCREENSHOT_ADDED,
+                    user=request.user,
+                    target=instance.name,
+                    unit=unit,
+                )
+
             return Response(serializer.data, status=HTTP_201_CREATED)
 
     def update(self, request: Request, *args, **kwargs):

weblate/api/views.py

@@ -22,6 +22,7 @@
 from weblate.auth.models import get_anonymous
 from weblate.checks.flags import Flags
 from weblate.screenshots.fields import ScreenshotField
+from weblate.trans.actions import ActionEvents
 from weblate.trans.mixins import UserDisplayMixin
 from weblate.trans.models import Translation, Unit
 from weblate.trans.models.alert import update_alerts
@@ -99,6 +100,26 @@ def get_absolute_url(self) -> str:
     def filter_name(self) -> str:
         return f"screenshot:{Flags.format_value(self.name)}"
 
+    def add_unit(self, unit: Unit, user: User | None = None) -> None:
+        """Add a unit to this screenshot and create a change event."""
+        self.units.add(unit)
+        self.change_set.create(
+            action=ActionEvents.SCREENSHOT_ADDED,
+            user=user or self.user,
+            target=self.name,
+            unit=unit,
+        )
+
+    def remove_unit(self, unit: Unit, user: User | None = None) -> None:
+        """Remove a unit from this screenshot and create a change event."""
+        self.units.remove(unit)
+        self.change_set.create(
+            action=ActionEvents.SCREENSHOT_REMOVED,
+            user=user or self.user,
+            target=self.name,
+            unit=unit,
+        )
+
 
 @receiver(m2m_changed, sender=Screenshot.units.through)
 @disable_for_loaddata

weblate/screenshots/models.py

@@ -21,6 +21,8 @@
 from weblate.lang.models import Language
 from weblate.screenshots.models import Screenshot
 from weblate.screenshots.views import get_tesseract, ocr_get_strings
+from weblate.trans.actions import ActionEvents
+from weblate.trans.models import Change
 from weblate.trans.tests.test_models import RepoTestCase
 from weblate.trans.tests.test_views import FixtureTestCase
 from weblate.trans.tests.utils import create_test_user, get_test_file
@@ -57,6 +59,12 @@ def test_upload(self) -> None:
         response = self.do_upload()
         self.assertContains(response, "Obrazek")
         self.assertEqual(Screenshot.objects.count(), 1)
+        uploaded_changes = Change.objects.filter(
+            action=ActionEvents.SCREENSHOT_UPLOADED,
+            screenshot=Screenshot.objects.get(),
+        )
+        self.assertEqual(uploaded_changes.count(), 1)
+        self.assertEqual(uploaded_changes[0].user, self.user)
 
     def test_upload_fail(self) -> None:
         self.make_manager()
@@ -74,6 +82,19 @@ def test_upload_source(self) -> None:
         screenshot = Screenshot.objects.all()[0]
         self.assertEqual(screenshot.name, "Obrazek")
         self.assertEqual(screenshot.units.count(), 1)
+        uploaded_changes = Change.objects.filter(
+            action=ActionEvents.SCREENSHOT_UPLOADED,
+            screenshot=screenshot,
+        )
+        self.assertEqual(uploaded_changes.count(), 1)
+        self.assertEqual(uploaded_changes[0].user, self.user)
+        added_changes = Change.objects.filter(
+            action=ActionEvents.SCREENSHOT_ADDED,
+            screenshot=screenshot,
+            unit=source,
+        )
+        self.assertEqual(added_changes.count(), 1)
+        self.assertEqual(added_changes[0].user, self.user)
 
     def test_upload_source_invalid(self) -> None:
         self.make_manager()
@@ -133,6 +154,13 @@ def test_source_manipulations(self) -> None:
         self.assertEqual(data["responseCode"], 200)
         self.assertEqual(data["status"], True)
         self.assertEqual(screenshot.units.count(), 1)
+        added_changes = Change.objects.filter(
+            action=ActionEvents.SCREENSHOT_ADDED,
+            screenshot=screenshot,
+            unit_id=source_pk,
+        )
+        self.assertEqual(added_changes.count(), 1)
+        self.assertEqual(added_changes[0].user, self.user)
 
         # Updated listing
         response = self.client.get(
@@ -146,6 +174,13 @@ def test_source_manipulations(self) -> None:
             {"source": source_pk},
         )
         self.assertEqual(screenshot.units.count(), 0)
+        removed_changes = Change.objects.filter(
+            action=ActionEvents.SCREENSHOT_REMOVED,
+            screenshot=screenshot,
+            unit_id=source_pk,
+        )
+        self.assertEqual(removed_changes.count(), 1)
+        self.assertEqual(removed_changes[0].user, self.user)
 
     def test_ocr_backend(self) -> None:
         # Extract strings

weblate/screenshots/tests.py

@@ -193,7 +193,7 @@ def try_add_source(request: AuthenticatedHttpRequest, obj) -> bool:
     except (Unit.DoesNotExist, ValueError):
         return False
 
-    obj.units.add(source)
+    obj.add_unit(source, user=request.user)
     return True
 
 
@@ -231,7 +231,7 @@ def post(self, request: AuthenticatedHttpRequest, **kwargs):
             )
             request.user.profile.increase_count("uploaded")
             obj.change_set.create(
-                action=ActionEvents.SCREENSHOT_ADDED,
+                action=ActionEvents.SCREENSHOT_UPLOADED,
                 user=request.user,
                 target=obj.name,
             )
@@ -322,7 +322,13 @@ def get_screenshot(request: AuthenticatedHttpRequest, pk):
 def remove_source(request: AuthenticatedHttpRequest, pk):
     obj = get_screenshot(request, pk)
 
-    obj.units.remove(request.POST["source"])
+    try:
+        unit = obj.translation.unit_set.get(pk=int(request.POST["source"]))
+    except (Unit.DoesNotExist, ValueError):
+        messages.error(request, gettext("Invalid unit."))
+        return redirect(obj)
+
+    obj.remove_unit(unit, user=request.user)
 
     messages.success(request, gettext("Source has been removed."))
 

weblate/screenshots/views.py

@@ -172,6 +172,8 @@ class ActionEvents(IntegerChoices):
     FORCE_SYNC = 83, gettext_lazy("Forced synchronization of translations")
     # Translators: Name of event in the history
     FORCE_SCAN = 84, gettext_lazy("Forced rescan of translations")
+    # Translators: Name of event in the history
+    SCREENSHOT_REMOVED = 85, gettext_lazy("Screenshot removed")
 
 
 # Actions which are logged