feat: validate material list to be empty before deletion

api/fixtures/materialLists.yml

@@ -2,7 +2,7 @@ App\Entity\MaterialList:
   materialList1:
     camp: '@camp1'
     name: Baumarkt
-  materialList2:
+  materialList2WithNoItems:
     camp: '@camp1'
     name: Packliste
   materialList3Manager:

api/src/Entity/MaterialList.php

@@ -42,6 +42,11 @@ class MaterialList extends BaseEntity implements BelongsToCampInterface, CopyFro
     /**
      * The items that are part of this list.
      */
+    #[Assert\Count(
+        exactly: 0,
+        exactMessage: 'It\'s not possible to delete a material list as long as it has items linked to it.',
+        groups: ['delete']
+    )]
     #[ApiProperty(writable: false, example: '["/material_items/1a2b3c4d"]')]
     #[Groups(['read'])]
     #[ORM\OneToMany(targetEntity: MaterialItem::class, mappedBy: 'materialList')]

api/tests/Api/MaterialItems/UpdateMaterialItemTest.php

@@ -14,7 +14,7 @@ class UpdateMaterialItemTest extends ECampApiTestCase {
     public function testPatchMaterialItemIsDeniedForAnonymousUser() {
         $materialItem = static::$fixtures['materialItem1'];
         static::createBasicClient()->request('PATCH', '/material_items/'.$materialItem->getId(), ['json' => [
-            'materialList' => $this->getIriFor('materialList2'),
+            'materialList' => $this->getIriFor('materialList2WithNoItems'),
             'period' => $this->getIriFor('period1'),
             'materialNode' => null,
             'article' => 'Mehl',
@@ -31,7 +31,7 @@ public function testPatchMaterialItemIsDeniedForUnrelatedUser() {
         $materialItem = static::$fixtures['materialItem1'];
         static::createClientWithCredentials(['username' => static::$fixtures['user4unrelated']->getUsername()])
             ->request('PATCH', '/material_items/'.$materialItem->getId(), ['json' => [
-                'materialList' => $this->getIriFor('materialList2'),
+                'materialList' => $this->getIriFor('materialList2WithNoItems'),
                 'period' => $this->getIriFor('period1'),
                 'materialNode' => null,
                 'article' => 'Mehl',
@@ -50,7 +50,7 @@ public function testPatchMaterialItemIsDeniedForInactiveCollaborator() {
         $materialItem = static::$fixtures['materialItem1'];
         static::createClientWithCredentials(['username' => static::$fixtures['user5inactive']->getUsername()])
             ->request('PATCH', '/material_items/'.$materialItem->getId(), ['json' => [
-                'materialList' => $this->getIriFor('materialList2'),
+                'materialList' => $this->getIriFor('materialList2WithNoItems'),
                 'period' => $this->getIriFor('period1'),
                 'materialNode' => null,
                 'article' => 'Mehl',
@@ -69,7 +69,7 @@ public function testPatchMaterialItemIsDeniedForGuest() {
         $materialItem = static::$fixtures['materialItem1'];
         static::createClientWithCredentials(['username' => static::$fixtures['user3guest']->getUsername()])
             ->request('PATCH', '/material_items/'.$materialItem->getId(), ['json' => [
-                'materialList' => $this->getIriFor('materialList2'),
+                'materialList' => $this->getIriFor('materialList2WithNoItems'),
                 'period' => $this->getIriFor('period1'),
                 'materialNode' => null,
                 'article' => 'Mehl',
@@ -88,7 +88,7 @@ public function testPatchMaterialItemIsAllowedForMember() {
         $materialItem = static::$fixtures['materialItem1'];
         static::createClientWithCredentials(['username' => static::$fixtures['user2member']->getUsername()])
             ->request('PATCH', '/material_items/'.$materialItem->getId(), ['json' => [
-                'materialList' => $this->getIriFor('materialList2'),
+                'materialList' => $this->getIriFor('materialList2WithNoItems'),
                 'period' => $this->getIriFor('period1'),
                 'materialNode' => null,
                 'article' => 'Mehl',
@@ -102,7 +102,7 @@ public function testPatchMaterialItemIsAllowedForMember() {
             'quantity' => 1500,
             'unit' => 'g',
             '_links' => [
-                'materialList' => ['href' => $this->getIriFor('materialList2')],
+                'materialList' => ['href' => $this->getIriFor('materialList2WithNoItems')],
                 'period' => ['href' => $this->getIriFor('period1')],
                 // 'materialNode' => null,
             ],
@@ -112,7 +112,7 @@ public function testPatchMaterialItemIsAllowedForMember() {
     public function testPatchMaterialItemIsAllowedForManager() {
         $materialItem = static::$fixtures['materialItem1'];
         static::createClientWithCredentials()->request('PATCH', '/material_items/'.$materialItem->getId(), ['json' => [
-            'materialList' => $this->getIriFor('materialList2'),
+            'materialList' => $this->getIriFor('materialList2WithNoItems'),
             'period' => $this->getIriFor('period1'),
             'materialNode' => null,
             'article' => 'Mehl',
@@ -125,7 +125,7 @@ public function testPatchMaterialItemIsAllowedForManager() {
             'quantity' => 1500,
             'unit' => 'g',
             '_links' => [
-                'materialList' => ['href' => $this->getIriFor('materialList2')],
+                'materialList' => ['href' => $this->getIriFor('materialList2WithNoItems')],
                 'period' => ['href' => $this->getIriFor('period1')],
                 // 'materialNode' => null,
             ],

api/tests/Api/MaterialLists/DeleteMaterialListTest.php

@@ -10,7 +10,7 @@
  */
 class DeleteMaterialListTest extends ECampApiTestCase {
     public function testDeleteMaterialListIsDeniedForAnonymousUser() {
-        $materialList = static::$fixtures['materialList1'];
+        $materialList = static::$fixtures['materialList2WithNoItems'];
         static::createBasicClient()->request('DELETE', '/material_lists/'.$materialList->getId());
         $this->assertResponseStatusCodeSame(401);
         $this->assertJsonContains([
@@ -20,7 +20,7 @@ public function testDeleteMaterialListIsDeniedForAnonymousUser() {
     }
 
     public function testDeleteMaterialListIsDeniedForUnrelatedUser() {
-        $materialList = static::$fixtures['materialList1'];
+        $materialList = static::$fixtures['materialList2WithNoItems'];
         static::createClientWithCredentials(['username' => static::$fixtures['user4unrelated']->getUsername()])
             ->request('DELETE', '/material_lists/'.$materialList->getId())
         ;
@@ -33,7 +33,7 @@ public function testDeleteMaterialListIsDeniedForUnrelatedUser() {
     }
 
     public function testDeleteMaterialListIsDeniedForInactiveCollaborator() {
-        $materialList = static::$fixtures['materialList1'];
+        $materialList = static::$fixtures['materialList2WithNoItems'];
         static::createClientWithCredentials(['username' => static::$fixtures['user5inactive']->getUsername()])
             ->request('DELETE', '/material_lists/'.$materialList->getId())
         ;
@@ -46,7 +46,7 @@ public function testDeleteMaterialListIsDeniedForInactiveCollaborator() {
     }
 
     public function testDeleteMaterialListIsDeniedForGuest() {
-        $materialList = static::$fixtures['materialList1'];
+        $materialList = static::$fixtures['materialList2WithNoItems'];
         static::createClientWithCredentials(['username' => static::$fixtures['user3guest']->getUsername()])
             ->request('DELETE', '/material_lists/'.$materialList->getId())
         ;
@@ -59,7 +59,7 @@ public function testDeleteMaterialListIsDeniedForGuest() {
     }
 
     public function testDeleteMaterialListIsAllowedForMember() {
-        $materialList = static::$fixtures['materialList1'];
+        $materialList = static::$fixtures['materialList2WithNoItems'];
         static::createClientWithCredentials(['username' => static::$fixtures['user2member']->getUsername()])
             ->request('DELETE', '/material_lists/'.$materialList->getId())
         ;
@@ -68,7 +68,7 @@ public function testDeleteMaterialListIsAllowedForMember() {
     }
 
     public function testDeleteMaterialListIsAllowedForManager() {
-        $materialList = static::$fixtures['materialList1'];
+        $materialList = static::$fixtures['materialList2WithNoItems'];
         static::createClientWithCredentials()->request('DELETE', '/material_lists/'.$materialList->getId());
         $this->assertResponseStatusCodeSame(204);
         $this->assertNull($this->getEntityManager()->getRepository(MaterialList::class)->find($materialList->getId()));
@@ -84,4 +84,15 @@ public function testDeleteMaterialListFromCampPrototypeIsDeniedForUnrelatedUser(
             'detail' => 'Access Denied.',
         ]);
     }
+
+    public function testDeleteMaterialListValidatesThatListHasNoItems() {
+        $materialList = static::$fixtures['materialList1'];
+        static::createClientWithCredentials()->request('DELETE', '/material_lists/'.$materialList->getId());
+
+        $this->assertResponseStatusCodeSame(422);
+        $this->assertJsonContains([
+            'title' => 'An error occurred',
+            'detail' => 'materialItems: It\'s not possible to delete a material list as long as it has items linked to it.',
+        ]);
+    }
 }

api/tests/Api/MaterialLists/ListMaterialListsTest.php

@@ -34,7 +34,7 @@ public function testListMaterialListsIsAllowedForLoggedInUserButFiltered() {
         ]);
         $this->assertEqualsCanonicalizing([
             ['href' => $this->getIriFor('materialList1')],
-            ['href' => $this->getIriFor('materialList2')],
+            ['href' => $this->getIriFor('materialList2WithNoItems')],
             ['href' => $this->getIriFor('materialList3Manager')],
             ['href' => $this->getIriFor('materialList1camp2')],
             ['href' => $this->getIriFor('materialList1campPrototype')],
@@ -56,7 +56,7 @@ public function testListMaterialListsFilteredByCampIsAllowedForCollaborator() {
         ]);
         $this->assertEqualsCanonicalizing([
             ['href' => $this->getIriFor('materialList1')],
-            ['href' => $this->getIriFor('materialList2')],
+            ['href' => $this->getIriFor('materialList2WithNoItems')],
             ['href' => $this->getIriFor('materialList3Manager')],
         ], $response->toArray()['_links']['items']);
     }

frontend/src/components/campAdmin/CampCategories.vue

@@ -60,7 +60,7 @@ Displays all periods of a single camp and allows to edit them & create new ones
             <v-item-group>
               <v-list-item-action>
                 <dialog-entity-delete :entity="category">
-                  {{ $tc('components.camp.CampCategories.deleteCategoryQuestion') }}
+                  {{ $tc('components.camp.campCategories.deleteCategoryQuestion') }}
                   <ul>
                     <li>
                       {{ category.short }}: {{ category.name }}
@@ -70,7 +70,7 @@ Displays all periods of a single camp and allows to edit them & create new ones
                     <button-delete v-on="on" />
                   </template>
                   <template v-if="findActivities(category).length > 0" #error>
-                    {{ $tc('components.camp.CampCategories.deleteCategoryNotPossibleInUse') }}
+                    {{ $tc('components.camp.campCategories.deleteCategoryNotPossibleInUse') }}
                     <ul>
                       <li v-for="activity in findActivities(category)" :key="activity._meta.self">
                         {{ activity.title }}

frontend/src/components/campAdmin/CampMaterialLists.vue

@@ -17,7 +17,7 @@
     <v-skeleton-loader v-if="camp().materialLists()._meta.loading" type="article" />
     <v-list>
       <camp-material-lists-item
-        v-for="materialList in materialLists.items"
+        v-for="materialList in materialLists.allItems"
         :key="materialList._meta.self"
         class="px-0"
         :material-list="materialList"

frontend/src/components/campAdmin/CampMaterialListsItem.vue

@@ -23,7 +23,7 @@
       <v-card>
         <v-item-group>
           <v-list-item-action>
-            <dialog-entity-delete :entity="materialList">
+            <dialog-entity-delete :entity="materialList" :error-handler="deleteErrorHandler">
               <template #activator="{ on }">
                 <button-delete v-on="on" />
               </template>
@@ -54,6 +54,15 @@ export default {
   props: {
     materialList: { type: Object, required: true },
     disabled: { type: Boolean, default: false }
+  },
+  methods: {
+    deleteErrorHandler (e) {
+      if (e?.response?.status === 422 /* Validation Error */) {
+        return this.$tc('components.camp.campMaterialListsItem.deleteError')
+      }
+
+      return null
+    }
   }
 }
 </script>

frontend/src/components/dialog/DialogBase.vue

@@ -1,6 +1,11 @@
 <script>
 export default {
   name: 'DialogBase',
+  props: {
+    // manual error handler to generate error message
+    // should return an error message as string (or null, in which case the default error message is displayed)
+    errorHandler: { type: Function, required: false, default: null }
+  },
   data () {
     return {
       // specifies entity properties available in the form
@@ -20,6 +25,7 @@ export default {
       showDialog: false,
       loading: true,
       error: null
+
     }
   },
   watch: {
@@ -108,15 +114,24 @@ export default {
       this.$emit('error', e)
       this._events = eventHandlers
 
-      this.error = e.message
+      // default error message
+      let defaultMessage = e.message
       if (e.response) {
         if (e.response.status === 409 /* Conflict */) {
-          this.error = this.$tc('global.serverError.409')
+          defaultMessage = this.$tc('global.serverError.409')
         }
         if (e.response.status === 422 /* Validation Error */) {
-          this.error = e
+          defaultMessage = e
         }
       }
+
+      // overwrite with manual error message from errorHandler
+      let errorHandlerMessage = null
+      if (this.errorHandler) {
+        errorHandlerMessage = this.errorHandler(e)
+      }
+
+      this.error = errorHandlerMessage || defaultMessage
     }
   }
 }

frontend/src/components/dialog/DialogEntityDelete.vue

@@ -3,6 +3,7 @@
     v-model="showDialog"
     :icon="icon"
     :title="$tc('components.dialog.dialogEntityDelete.title')"
+    :error="error"
     max-width="600px"
     :submit-action="del"
     :submit-enabled="submitEnabled && !$slots.error"
@@ -39,6 +40,7 @@ export default {
   created () {
     this.entityUri = this.entity._meta.self
   }
+
 }
 </script>
 

frontend/src/locales/de.json

@@ -88,6 +88,14 @@
       "campInvitations": {
         "title": "Einladen"
       },
+      "campMaterialLists": {
+        "createMaterialList": "Materialliste erstellen",
+        "title": "Materiallisten"
+      },
+      "campMaterialListsItem": {
+        "deleteWarning": "Möchtest du diese Materialliste wirklich löschen?",
+        "deleteError": "Materialliste konnte nicht gelöscht werden. Überprüfe vor dem Löschen, dass die Liste leer ist."
+      },
       "campMembers": {
         "title": "Mitglieder"
       },
@@ -361,4 +369,4 @@
       "profile": "Profil"
     }
   }
-}
+}

frontend/src/locales/en.json

@@ -134,7 +134,8 @@
         "title": "Material lists"
       },
       "campMaterialListsItem": {
-        "deleteWarning": "Do you really want to delete this material list?"
+        "deleteWarning": "Do you really want to delete this material list?",
+        "deleteError": "Could not delete the material list. Check if the list is empty before deleting it."
       },
       "campMembers": {
         "title": "Members"
@@ -463,4 +464,4 @@
       "profile": "Profile"
     }
   }
-}
+}