Merge pull request #8157 from 4teamwork/amo/TI-TI-2279/dossier_inactive_responsible_filter

Filtering by inactive dossier responsible is now available.

Author: Abdu-moustafa

changes/TI-2279.other

@@ -0,0 +1 @@
+extend @listing endpoint with inactive user filter .[amo]

docs/public/dev-manual/api/api_changelog.rst

@@ -12,7 +12,7 @@ Breaking Changes
 
 Other Changes
 ^^^^^^^^^^^^^
-
+``@listing``: Filtering by inactive dossier responsible is now available.
 
 2025.6.0 (2025-04-07)
 ---------------------

opengever/api/listing.py

@@ -7,6 +7,7 @@
 from opengever.document.behaviors.customproperties import IDocumentCustomProperties
 from opengever.dossier.behaviors.customproperties import IDossierCustomProperties
 from opengever.dossier.indexers import ParticipationIndexHelper
+from opengever.ogds.models.service import ogds_service
 from plone.registry.interfaces import IRegistry
 from plone.uuid.interfaces import IUUID
 from zExceptions import BadRequest
@@ -190,6 +191,13 @@ def preprocess_filters(self, filters):
                         helper.participant_id_and_role_to_index_value(
                             participant_id, role))
             filters['participations'] = participations
+
+        if 'inactive_responsibles' in filters:
+            inactive_responsibles_flag = filters.pop('inactive_responsibles')
+            if inactive_responsibles_flag:
+                if 'responsible' not in filters:
+                    inactive_responsibles = ogds_service().inactive_users()
+                    filters['responsible'] = [user.userid for user in inactive_responsibles]
         return filters
 
     def extract_sort(self, params, query):

opengever/api/tests/test_listing.py

@@ -989,6 +989,136 @@ def test_filter_supports_unicode(self, browser):
              u'Abgeschlossene Vertr\xe4ge'],
             titles)
 
+    @browsing
+    def test_filter_by_responsible(self, browser):
+        self.login(self.regular_user, browser=browser)
+
+        view = ('@listing?name=dossiers&columns:list=title&columns:list=responsible')
+        browser.open(self.leaf_repofolder, view=view, headers=self.api_headers)
+        items = browser.json['items']
+
+        # Assert all items
+        self.assertEqual(17, len(items))
+
+        # filter by dossier_responsible
+        view = (
+            '@listing?name=dossiers'
+            '&columns:list=title'
+            '&columns:list=responsible'
+            '&filters.responsible:record:list={}'.format(self.dossier_responsible))
+        browser.open(self.leaf_repofolder, view=view, headers=self.api_headers)
+        items = browser.json['items']
+
+        self.assertEqual(10, len(items))
+        self.assertTrue([dossier["responsible"] == self.dossier_responsible for dossier in items])
+
+    @browsing
+    def test_filter_by_dossier_inactive_responsible(self, browser):
+        self.login(self.regular_user, browser=browser)
+        inactive_user_1 = create(
+            Builder('ogds_user')
+            .having(active=False, userid="inactive_user_1")
+        )
+        inactive_user_2 = create(
+            Builder('ogds_user')
+            .having(active=False, userid="inactive_user_2")
+        )
+
+        create(
+            Builder('dossier')
+            .titled(u'Dossier with inactive responsible 1')
+            .within(self.leaf_repofolder)
+            .having(responsible="{}".format(inactive_user_1.userid))
+        )
+        create(
+            Builder('dossier')
+            .titled(u'Dossier with inactive responsible 2')
+            .within(self.leaf_repofolder)
+            .having(responsible="{}".format(inactive_user_2.userid))
+        )
+
+        self.commit_solr()
+
+        view = ('@listing?name=dossiers&columns:list=title&columns:list=responsible')
+        browser.open(self.leaf_repofolder, view=view, headers=self.api_headers)
+        items = browser.json['items']
+
+        # Assert all items
+        self.assertEqual(19, len(items))
+
+        # filter by inactive users
+        view = (
+            '@listing?name=dossiers'
+            '&columns:list=title'
+            '&columns:list=responsible'
+            '&filters.inactive_responsibles:record:boolean=true')
+        browser.open(self.leaf_repofolder, view=view, headers=self.api_headers)
+        items = browser.json['items']
+
+        self.assertEqual(2, len(items))
+        self.assertTrue([dossier["responsible"] == [inactive_user_1, inactive_user_2] for dossier in items])
+
+    @browsing
+    def test_filter_by_dossier_inactive_responsible_with_specific_user(self, browser):
+        self.login(self.regular_user, browser=browser)
+        inactive_user_1 = create(
+            Builder('ogds_user')
+            .having(active=False, userid="inactive_user_1")
+        )
+        inactive_user_2 = create(
+            Builder('ogds_user')
+            .having(active=False, userid="inactive_user_2")
+        )
+
+        create(
+            Builder('dossier')
+            .titled(u'Dossier with inactive responsible 1')
+            .within(self.leaf_repofolder)
+            .having(responsible="{}".format(inactive_user_1.userid))
+        )
+        create(
+            Builder('dossier')
+            .titled(u'Dossier with inactive responsible 2')
+            .within(self.leaf_repofolder)
+            .having(responsible="{}".format(inactive_user_2.userid))
+        )
+
+        self.commit_solr()
+        self.login(self.regular_user, browser=browser)
+
+        view = ('@listing?name=dossiers&columns:list=title&columns:list=responsible')
+        browser.open(self.leaf_repofolder, view=view, headers=self.api_headers)
+        items = browser.json['items']
+
+        # Assert all items
+        self.assertEqual(19, len(items))
+
+        # filter by inactive users
+        view = (
+            '@listing?name=dossiers'
+            '&columns:list=title'
+            '&columns:list=responsible'
+            '&filters.inactive_responsibles:record:boolean=true')
+        browser.open(self.leaf_repofolder, view=view, headers=self.api_headers)
+        items = browser.json['items']
+
+        self.assertEqual(2, len(items))
+        self.assertTrue([dossier["responsible"] == [inactive_user_1, inactive_user_2] for dossier in items])
+
+        # filter by specific inactive user
+        view = (
+            '@listing?name=dossiers'
+            '&columns:list=title'
+            '&columns:list=responsible'
+            '&filters.inactive_responsibles:record:boolean=true'
+            '&filters.responsible:record:list={}'.format(inactive_user_1.userid))
+        browser.open(self.leaf_repofolder, view=view, headers=self.api_headers)
+        items = browser.json['items']
+
+        self.assertEqual(1, len(items))
+        self.assertTrue([dossier["responsible"] == inactive_user_1 for dossier in items])
+        self.assertTrue([dossier["title"] == 'Dossier with inactive responsible 1' for dossier in items])
+
     @browsing
     def test_workspaces_listing(self, browser):
         self.login(self.workspace_member, browser=browser)