When bulk-unassigning tag, emit sentry warning instead of returning error

Author: pylipp

back/boxtribute_server/business_logic/warehouse/box/mutations.py

@@ -3,6 +3,7 @@
 from ariadne import MutationType
 from flask import g
 from peewee import JOIN
+from sentry_sdk import capture_message as emit_sentry_message
 
 from ....authz import authorize, authorized_bases_filter, handle_unauthorized
 from ....enums import TaggableObjectType, TagType
@@ -201,9 +202,24 @@ def resolve_unassign_tag_from_boxes(*_, update_input):
         return ResourceDoesNotExist(name="Tag", id=tag_id)
     authorize(permission="tag_relation:assign", base_id=tag.base_id)
     if tag.deleted_on is not None:
-        return DeletedTag(name=tag.name)
+        # When a tag is deleted, it is also unassigned from any resource, hence in
+        # theory unassigning a deleted tag should not happen. However we have to deal
+        # with legacy data (there are 1.3k boxes assigned to deleted tags) and want to
+        # be notified about it.
+        emit_sentry_message(
+            "User unassigned deleted tag from boxes",
+            level="warning",
+            extras={"tag_id": tag_id},
+        )
     if tag.type == TagType.Beneficiary:
-        return TagTypeMismatch(expected_type=TagType.Box)
+        # When a tag type changes, it is also unassigned from any resource, hence in
+        # theory boxes assigned with a Beneficiary tag should not occur. However we have
+        # to deal with legacy data and want to be notified about it.
+        emit_sentry_message(
+            "User unassigned Beneficiary-type tag from boxes",
+            level="warning",
+            extras={"tag_id": tag_id},
+        )
 
     label_identifiers = set(update_input["label_identifiers"])
     boxes = (

back/boxtribute_server/graph_ql/definitions/protected/types.graphql

@@ -611,7 +611,7 @@ type DeletedTagError {
 
 union MoveBoxesResult = BoxResult | InsufficientPermissionError | ResourceDoesNotExistError | UnauthorizedForBaseError | DeletedLocationError
 union AssignTagToBoxesResult = BoxResult | InsufficientPermissionError | ResourceDoesNotExistError | UnauthorizedForBaseError | TagTypeMismatchError | DeletedTagError
-union UnassignTagFromBoxesResult = BoxResult | InsufficientPermissionError | ResourceDoesNotExistError | UnauthorizedForBaseError | TagTypeMismatchError | DeletedTagError
+union UnassignTagFromBoxesResult = BoxResult | InsufficientPermissionError | ResourceDoesNotExistError | UnauthorizedForBaseError
 union DeleteBoxesResult = BoxResult | InsufficientPermissionError
 union CreateCustomProductResult = Product | InsufficientPermissionError | ResourceDoesNotExistError | UnauthorizedForBaseError | InvalidPriceError | EmptyNameError
 union EditCustomProductResult = Product | InsufficientPermissionError | ResourceDoesNotExistError | UnauthorizedForBaseError | InvalidPriceError | EmptyNameError | ProductTypeMismatchError

back/test/endpoint_tests/test_box.py

@@ -423,9 +423,15 @@ def test_box_mutations(
     # Test case 8.2.24h
     mutation = f"""mutation {{ unassignTagFromBoxes( updateInput: {{
             labelIdentifiers: [{label_identifiers}], tagId: {beneficiary_tag_id} }} ) {{
-                ...on TagTypeMismatchError {{ expectedType }} }} }}"""
+                ...on BoxResult {{
+                    updatedBoxes {{ id }}
+                    invalidBoxLabelIdentifiers
+                }} }} }}"""
     response = assert_successful_request(client, mutation)
-    assert response == {"expectedType": TagType.Box.name}
+    assert response == {
+        "updatedBoxes": [],
+        "invalidBoxLabelIdentifiers": raw_label_identifiers,
+    }
 
     # Test case 8.2.23i
     deleted_tag_id = str(tags[4]["id"])
@@ -439,9 +445,15 @@ def test_box_mutations(
     # Test case 8.2.24i
     mutation = f"""mutation {{ unassignTagFromBoxes( updateInput: {{
             labelIdentifiers: [{label_identifiers}], tagId: {deleted_tag_id} }} ) {{
-                ...on DeletedTagError {{ name }} }} }}"""
+                ...on BoxResult {{
+                    updatedBoxes {{ id }}
+                    invalidBoxLabelIdentifiers
+                }} }} }}"""
     response = assert_successful_request(client, mutation)
-    assert response == {"name": tag_name}
+    assert response == {
+        "updatedBoxes": [],
+        "invalidBoxLabelIdentifiers": raw_label_identifiers,
+    }
 
     # Test case 8.2.25
     mutation = f"""mutation {{ deleteBoxes( labelIdentifiers: [{label_identifiers}] ) {{

front/src/types/generated/graphql.ts

@@ -2010,7 +2010,7 @@ export enum TransferAgreementType {
   SendingTo = 'SendingTo'
 }
 
-export type UnassignTagFromBoxesResult = BoxResult | DeletedTagError | InsufficientPermissionError | ResourceDoesNotExistError | TagTypeMismatchError | UnauthorizedForBaseError;
+export type UnassignTagFromBoxesResult = BoxResult | InsufficientPermissionError | ResourceDoesNotExistError | UnauthorizedForBaseError;
 
 export type UnauthorizedForBaseError = {
   __typename?: 'UnauthorizedForBaseError';