Handled multiple sessions for one context

Author: chris-adam

CHANGES.rst

@@ -29,6 +29,8 @@ Changelog
   [chris-adam]
 - Added external watchers for esign sessions.
   [chris-adam, sgeulette]
+- Added possibility to have elements of the same context to belong to different sessions.
+  [chris-adam]
 
 1.0a2 (2026-02-06)
 ------------------

src/imio/esign/browser/templates/macros.pt

@@ -40,7 +40,7 @@
 <tr metal:define-macro="signers" i18n:domain="imio.esign">
     <td class="table_widget_label"><label i18n:translate="">Signers</label></td>
     <td class="table_widget_value">
-        <table id="context_viewlet_signers_table" class="no-border no-style-table listing"
+        <table class="no-border no-style-table listing context_viewlet_signers_table"
                  tal:define="signers python:session.get('signers', [])">
             <thead>
             <tr>

src/imio/esign/browser/templates/session_info.pt

@@ -4,19 +4,21 @@
       xmlns:i18n="http://xml.zope.org/namespaces/i18n"
       lang="en"
       i18n:domain="imio.esign">
-  <div class="faceted-session-info" tal:condition="python: view.available()">
-    <div id="session-info"
-        onclick="toggleDetails('collapsible-session-info', toggle_parent_active=true);"
-        tal:attributes="class python: view.collapsible_css_default()">
+  <div class="faceted-session-info"
+       tal:condition="python: view.available()"
+       tal:define="session_id python: str(view.session.get('id', ''))">
+    <div tal:attributes="id string:session-info-${session_id};
+                         onclick string:toggleDetails('collapsible-session-info-${session_id}', toggle_parent_active=true);
+                         class python: view.collapsible_css_default()">
       <span i18n:translate="">Session information (<img i18n:name="icon_url" tal:attributes="src string:${view/portal_url}/++resource++imio.esign/parapheo.svg" /> Parapheo)</span>
     </div>
-    <div id="collapsible-session-info"
-         tal:attributes="class python: view.collapsible_content_css_default()">
+    <div tal:attributes="id string:collapsible-session-info-${session_id};
+                         class python: view.collapsible_content_css_default()">
       <div class="collapsible-inner-content session-info-container"
            tal:define="template python: context.unrestrictedTraverse('@@esign-macros').index;
                        session python: view.session">
         <div class="session-info-column">
-            <table id="context_viewlet_session_table" class="no-style-table table-view-widgets">
+            <table class="no-style-table table-view-widgets">
                 <tbody>
                 <tal:block tal:repeat="macro_name python:view.get_table_rows(1)">
                     <metal:render_cell use-macro="python: template.macros[macro_name]" />
@@ -26,15 +28,15 @@
         </div>
 
         <div class="session-info-column">
-            <table id="context_viewlet_session_signers" class="no-style-table table-view-widgets">
+            <table class="no-style-table table-view-widgets">
                 <tbody>
                 <tal:block tal:repeat="macro_name python:view.get_table_rows(2)">
                     <metal:render_cell use-macro="python: template.macros[macro_name]" />
                 </tal:block>
                 </tbody>
             </table>
         </div>
-        <script>$('table#context_viewlet_signers_table').each(setoddeven);</script>
+        <script>$('table.context_viewlet_signers_table').each(setoddeven);</script>
       </div>
     </div>
   </div>

src/imio/esign/browser/views.py

@@ -252,27 +252,43 @@ def get_state_description(self, state):
 
 
 class ItemSessionInfoViewlet(FacetedSessionInfoViewlet):
-    """Show selected session info for an item."""
+    """Show session info for all sessions linked to a context item."""
 
     def available(self):
         """Global availability of the viewlet."""
         return True
 
-    def render(self):
-        """Render the viewlet."""
-        if self.session:
-            return self.index()
-        return ""
-
     @property
-    def session(self):
+    def sessions(self):
+        """Return all sessions that contain files from this context."""
         annot = get_session_annotation()
+        result = []
+        seen = set()
         for f_uid in annot["c_uids"].get(self.context.UID(), []):
-            if f_uid in annot["uids"]:
-                session = annot["sessions"].get(annot["uids"][f_uid], {})
-                session["id"] = annot["uids"][f_uid]
-                return session
-        return {}
+            session_id = annot["uids"].get(f_uid)
+            if session_id is not None and session_id not in seen:
+                seen.add(session_id)
+                session = dict(annot["sessions"].get(session_id, {}))
+                session["id"] = session_id
+                result.append(session)
+        return result
+
+    @property
+    def session(self):
+        """Current session during render loop; also used by base template."""
+        return getattr(self, "_current_session", None) or {}
+
+    def render(self):
+        """Render viewlet once per session linked to this context."""
+        sessions = self.sessions
+        if not sessions:
+            return ""
+        parts = []
+        for s in sessions:
+            self._current_session = s
+            parts.append(self.index())
+        self._current_session = None
+        return "\n".join(parts)
 
 
 @implementer(IPublishTraverse)

src/imio/esign/tests/test_browser_views.py

@@ -6,6 +6,7 @@
 from datetime import timedelta
 from imio.esign.browser.views import DownloadFileView
 from imio.esign.browser.views import ExternalSessionCreateView
+from imio.esign.browser.views import ItemSessionInfoViewlet
 from imio.esign.browser.views import SessionDeleteView
 from imio.esign.testing import IMIO_ESIGN_FUNCTIONAL_TESTING
 from imio.esign.testing import IMIO_ESIGN_INTEGRATION_TESTING
@@ -393,3 +394,96 @@ def test_download_file_view(self):
         self.assertIn("The corresponding file identifier cannot be retrieved (aabbccddee)", browser.contents)
         browser.open("{}/download-file/{}".format(portal_url, "aabbccddee?param=value"))
         self.assertIn("The corresponding file identifier cannot be retrieved (aabbccddee)", browser.contents)
+
+
+class TestItemSessionInfoViewlet(unittest.TestCase):
+    """Test ItemSessionInfoViewlet multi-session support."""
+
+    layer = IMIO_ESIGN_INTEGRATION_TESTING
+
+    def setUp(self):
+        self.portal = self.layer["portal"]
+        self.request = self.portal.REQUEST
+        setRoles(self.portal, TEST_USER_ID, ["Manager"])
+        at_folder = api.content.create(
+            container=self.portal, id="annexes_types", title="Annexes Types",
+            type="ContentCategoryConfiguration", exclude_from_nav=True,
+        )
+        category_group = api.content.create(
+            type="ContentCategoryGroup", title="Annexes",
+            container=at_folder, id="annexes",
+        )
+        icon_path = os.path.join(
+            os.path.dirname(collective.iconifiedcategory.__file__), "tests", u"ic\xf4ne1.png"
+        )
+        with open(icon_path, "rb") as fl:
+            api.content.create(
+                type="ContentCategory", title="To sign",
+                container=category_group,
+                icon=NamedBlobImage(fl.read(), filename=u"ic\xf4ne1.png"),
+                id="to_sign", predefined_title="To be signed",
+                to_sign=True, show_preview=False,
+            )
+        api.user.create(email="user1@sign.com", username="user1", password="password1")
+        self.folder = api.content.create(
+            container=self.portal, type="Folder",
+            id="test_folder", title="Test Folder",
+        )
+        tests_dir = os.path.dirname(__file__)
+        self.annexes = []
+        for i in range(2):
+            with open(os.path.join(tests_dir, "annex1.pdf"), "rb") as f:
+                annex = api.content.create(
+                    container=self.folder, type="annex",
+                    id="annex{}".format(i), title="Annex {}".format(i),
+                    content_category=calculate_category_id(
+                        self.portal["annexes_types"]["annexes"]["to_sign"]
+                    ),
+                    scan_id="0123456000000{:02d}".format(i),
+                    file=NamedBlobFile(
+                        data=f.read(), filename=u"annex{}.pdf".format(i),
+                        contentType="application/pdf",
+                    ),
+                )
+                self.annexes.append(annex)
+        self.signers = [("user1", "user1@sign.com", "User 1", "Position 1")]
+        for key in list(self.request.form.keys()):
+            del self.request.form[key]
+
+    def test_sessions_empty(self):
+        """No files in esign annotation → sessions returns empty list."""
+        viewlet = ItemSessionInfoViewlet(self.folder, self.request, None, None)
+        self.assertEqual(viewlet.sessions, [])
+        self.assertEqual(viewlet.render(), "")
+
+    def test_sessions_single_session(self):
+        """All context files in one session → sessions returns one dict."""
+        uids = [a.UID() for a in self.annexes]
+        add_files_to_session(self.signers, uids)
+        viewlet = ItemSessionInfoViewlet(self.folder, self.request, None, None)
+        sessions = viewlet.sessions
+        self.assertEqual(len(sessions), 1)
+        self.assertEqual(sessions[0]["id"], 0)
+
+    def test_sessions_multiple_sessions(self):
+        """Files in two sessions (different discriminators) → sessions returns two dicts."""
+        add_files_to_session(self.signers, [self.annexes[0].UID()], discriminators=("a",))
+        add_files_to_session(self.signers, [self.annexes[1].UID()], discriminators=("b",))
+        viewlet = ItemSessionInfoViewlet(self.folder, self.request, None, None)
+        sessions = viewlet.sessions
+        self.assertEqual(len(sessions), 2)
+        session_ids = {s["id"] for s in sessions}
+        self.assertEqual(session_ids, {0, 1})
+
+        rendered_ids = []
+        def mock_index():
+            rendered_ids.append(viewlet._current_session["id"])
+            return u"<div>session {}</div>".format(viewlet._current_session["id"])
+        viewlet.index = mock_index
+        result = viewlet.render()
+        self.assertEqual(len(rendered_ids), 2)
+        self.assertIn(0, rendered_ids)
+        self.assertIn(1, rendered_ids)
+        self.assertIn(u"<div>session 0</div>", result)
+        self.assertIn(u"<div>session 1</div>", result)
+        self.assertIsNone(viewlet._current_session)