🐛 #290 - fix: fix a bug that could cause the application to show incorrect data on the destruction list detail page if editing mode was closed with filters being active

Author: svenvandescheur

backend/src/openarchiefbeheer/destruction/tests/e2e/issues/__init__.py

@@ -0,0 +1,36 @@
+# fmt: off
+from django.test import tag
+
+from openarchiefbeheer.utils.tests.e2e import browser_page
+from openarchiefbeheer.utils.tests.gherkin import GherkinLikeTestCase
+
+from ....constants import ListStatus
+
+
+@tag("e2e")
+class Issue290CancelFilteredEditMode(GherkinLikeTestCase):
+    async def test_scenario_user_cancels_filtered_edit_mode(self):
+        async with browser_page() as page:
+            await self.given.list_exists(
+                name="Destruction list to edit",
+                status=ListStatus.new,
+                uuid="00000000-0000-0000-0000-000000000000",
+            )
+
+            await self.when.record_manager_logs_in(page)
+            await self.then.path_should_be(page, "/destruction-lists")
+
+            await self.when.user_clicks_button(page, "Destruction list to edit")
+            await self.then.path_should_be(page, "/destruction-lists/00000000-0000-0000-0000-000000000000")
+            await self.then.page_should_contain_text(page, "Zaak-")
+
+            await self.when.user_clicks_button(page, "Bewerken")
+            await self.then.path_should_be(page, "/destruction-lists/00000000-0000-0000-0000-000000000000?page=1&is_editing=true")
+            await self.when.user_fills_form_field(page, "Identificatie", "non-matching-identifier", "textbox")
+
+            await self.then.url_should_contain_text(page, ".*non-matching-identifier.*")
+            await self.then.not_.page_should_contain_text(page, "Zaak-")
+
+            await self.when.user_clicks_button(page, "Annuleren")
+            await self.then.path_should_be(page, "/destruction-lists/00000000-0000-0000-0000-000000000000")
+            await self.then.page_should_contain_text(page, "Zaak-")

backend/src/openarchiefbeheer/destruction/tests/e2e/issues/test_290_closing_edit_mode_removes_filters.py

@@ -1,3 +1,5 @@
+import re
+
 from asgiref.sync import sync_to_async
 from playwright.async_api import expect
 
@@ -318,7 +320,7 @@ async def _user_clicks(self, role, page, name, index=0):
             await element.wait_for()
             await element.click()
 
-        async def user_fills_form_field(self, page, label, value):
+        async def user_fills_form_field(self, page, label, value, role=None):
             select = await page.query_selector(f'.mykn-select[title="{label}"]')
             if select:  # has content so select?
                 await select.click()
@@ -331,7 +333,11 @@ async def user_fills_form_field(self, page, label, value):
 
                 return
 
-            locator = page.get_by_label(label)
+            if role:
+                locator = page.get_by_label(label).and_(page.get_by_role("textbox"))
+            else:
+                locator = page.get_by_label(label)
+
             await locator.fill(value)
 
     class Then:
@@ -348,6 +354,29 @@ class Then:
         def __init__(self, testcase):
             self.testcase = testcase
 
+        @property
+        def not_(self):
+            class InvertedThen:
+                def __init__(self, then):
+                    self.then = then
+
+                def __getattr__(self, item):
+                    method = getattr(self.then, item)
+
+                    async def inverted_method(*args, **kwargs):
+                        try:
+                            await method(*args, **kwargs)
+                        except AssertionError:
+                            return
+
+                        raise AssertionError(
+                            f'Expected {method.__name__} to raise an AssertionError due to "not_".'
+                        )
+
+                    return inverted_method
+
+            return InvertedThen(self)
+
         async def list_should_have_assignee(self, page, destruction_list, assignee):
             @sync_to_async()
             def refresh_list():
@@ -379,3 +408,6 @@ async def path_should_be(self, page, path):
 
         async def url_should_be(self, page, url):
             await expect(page).to_have_url(url)
+
+        async def url_should_contain_text(self, page, text):
+            await expect(page).to_have_url(re.compile(text))

backend/src/openarchiefbeheer/utils/tests/gherkin.py

@@ -64,10 +64,8 @@ export function DestructionListEdit() {
    */
   const handleEditSetEditing = (value: boolean) => {
     urlSearchParams.set("page", "1");
-    value
-      ? urlSearchParams.set("is_editing", "true")
-      : urlSearchParams.delete("is_editing");
-    setUrlSearchParams(urlSearchParams);
+    urlSearchParams.set("is_editing", "true");
+    setUrlSearchParams(value ? urlSearchParams : {});
   };
 
   /**