Add document version count to listing and index it

Author: Abdu-moustafa

changes/TI-2442.other

@@ -0,0 +1 @@
+Add new listing field: "document_version_count". [amo]

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

@@ -13,6 +13,7 @@ Breaking Changes
 Other Changes
 ^^^^^^^^^^^^^
 - ``@possible-watchers``: endpoint only returns users having view permission on the given context.
+- ``@listing``: New field `document_version_count` is now available.
 
 2025.7.0 (2025-06-06)
 ---------------------

opengever/api/listing.py

@@ -37,6 +37,7 @@
     'location',
     'related_items',
     'is_locked_by_copy_to_workspace',
+    'document_version_count',
     'progress',
 ])
 

opengever/api/tests/test_listing.py

@@ -1822,6 +1822,22 @@ def test_dossier_checklist_progress_ordering(self, browser):
             [('Testdossier B', 1.0), ('Testdossier A', 0.5), ('Testdossier C', None)],
             [(item['title'], item['progress']) for item in browser.json['items']])
 
+    @browsing
+    def test_document_version_count(self, browser):
+        self.login(self.regular_user, browser=browser)
+        versioner = Versioner(self.document)
+        versioner.create_version('Initial version')
+        versioner.create_version('Second version')
+        self.commit_solr()
+
+        view = '@listing?name=documents&columns:list=document_version_count'
+        browser.open(self.dossier, view=view, headers=self.api_headers)
+        self.assertEqual(
+            {u'@id': self.document.absolute_url(),
+             u'UID': IUUID(self.document),
+             u'document_version_count': 1},
+            browser.json['items'][0])
+
 
 class TestPloneDossierParticipationsInListingWithRealSolr(SolrIntegrationTestCase):
 

opengever/base/solr/fields.py

@@ -733,6 +733,11 @@ def hide_facet(self, facet):
         additional_required_fields=['portal_type', 'Title'],
         title=dossier_mf(u'label_title', default=u'Title'),
     ),
+    ListingField(
+        'document_version_count',
+        index='document_version_count',
+        title=document_mf(u'label_document_version_count'),
+    ),
     DateListingField(
         'touched',
         title=base_mf(u'label_last_modified', default=u'Last modified'),

opengever/core/upgrades/20250613143257_add_document_version_count_index/__init__.py

@@ -0,0 +1,18 @@
+from ftw.upgrade import UpgradeStep
+from opengever.core.upgrade import NightlyIndexer
+from opengever.document.behaviors import IBaseDocument
+
+
+class AddDocumentVersionCountIndex(UpgradeStep):
+    """Add document version count index.
+    """
+
+    def __call__(self):
+        query = {'object_provides': [
+            IBaseDocument.__identifier__,
+        ]}
+
+        with NightlyIndexer(idxs=["document_version_count"],
+                            index_in_solr_only=True) as indexer:
+            for brain in self.brains(query, 'Index document version count in Solr'):
+                indexer.add_by_brain(brain)

opengever/core/upgrades/20250613143257_add_document_version_count_index/upgrade.py

@@ -384,6 +384,11 @@
       name="is_locked_by_copy_to_workspace"
       />
 
+  <adapter
+      factory=".indexers.document_version_count"
+      name="document_version_count"
+      />
+
   <adapter factory=".document.UploadValidator" />
 
   <adapter factory=".fileactions.BaseDocumentFileActions" />

opengever/document/configure.zcml

@@ -280,3 +280,8 @@ def is_locked_by_copy_to_workspace(obj):
         return False
 
     return obj.is_locked_by_copy_to_workspace()
+
+
+@indexer(IBaseDocument)
+def document_version_count(obj):
+    return obj.get_current_version_id(missing_as_zero=True)

opengever/document/indexers.py

@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: 1.0\n"
-"POT-Creation-Date: 2024-09-12 08:50+0000\n"
+"POT-Creation-Date: 2025-06-13 12:43+0000\n"
 "PO-Revision-Date: 2017-10-13 14:27+0200\n"
 "Last-Translator: Jonas Baumann <j.baumann@4teamwork.ch>\n"
 "Language-Team: 4teamwork <info@4teamwork.ch>\n"
@@ -501,6 +501,9 @@ msgstr "Dokument signiert"
 msgid "label_document_type"
 msgstr "Dokumenttyp"
 
+msgid "label_document_version_count"
+msgstr "Anzahl Versionen"
+
 #. Default: "Added as watcher of the document"
 #: ./opengever/document/activities.py
 msgid "label_document_watcher_added"