feat: upgrade step to clean TS api URL in registry to keep only base URL

CITI-15

Author: remdub

CHANGES.rst

@@ -5,7 +5,8 @@ Changelog
 1.2.12 (unreleased)
 -------------------
 
-- Nothing changed yet.
+- CITI-15 : Add upgrade step to clean TS api URL in registry to keep only base URL.
+  [remdub]
 
 
 1.2.11 (2025-09-26)

src/imio/smartweb/policy/profiles/default/metadata.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <metadata>
-  <version>1038</version>
+  <version>1039</version>
   <dependencies>
     <dependency>profile-plone.app.contenttypes:plone-content</dependency>
     <dependency>profile-plone.app.caching:default</dependency>

src/imio/smartweb/policy/tests/test_utils.py

@@ -0,0 +1,39 @@
+from imio.smartweb.policy.testing import (
+    IMIO_SMARTWEB_POLICY_INTEGRATION_TESTING,
+)  # noqa: E501
+from unittest.mock import patch
+from imio.smartweb.policy.utils import get_ts_api_base_url
+
+import unittest
+
+
+class TestGetTsApiBaseUrl(unittest.TestCase):
+
+    layer = IMIO_SMARTWEB_POLICY_INTEGRATION_TESTING
+
+    @patch("imio.smartweb.core.utils.get_value_from_registry")
+    @patch("imio.smartweb.core.utils.is_valid_url")
+    @patch("imio.smartweb.policy.utils.urlparse")
+    def test_valid_url(self, mock_urlparse, mock_is_valid_url, mock_get_value):
+        mock_get_value.return_value = "https://kamoulox.be/formsdefs/something"
+        mock_is_valid_url.return_value = True
+        mock_urlparse.return_value.scheme = "https"
+        mock_urlparse.return_value.netloc = "kamoulox.be"
+        result = get_ts_api_base_url()
+        self.assertEqual(result, "https://kamoulox.be/")
+
+    @patch("imio.smartweb.core.utils.get_value_from_registry")
+    @patch("imio.smartweb.core.utils.is_valid_url")
+    def test_invalid_url(self, mock_is_valid_url, mock_get_value):
+        mock_get_value.return_value = "not-a-valid-url"
+        mock_is_valid_url.return_value = False
+        result = get_ts_api_base_url()
+        self.assertIsNone(result)
+
+    @patch("imio.smartweb.core.utils.get_value_from_registry")
+    @patch("imio.smartweb.core.utils.is_valid_url")
+    def test_empty_url(self, mock_is_valid_url, mock_get_value):
+        mock_get_value.return_value = ""
+        mock_is_valid_url.return_value = False
+        result = get_ts_api_base_url()
+        self.assertIsNone(result)

src/imio/smartweb/policy/upgrades/configure.zcml

@@ -586,4 +586,13 @@
     profile="imio.smartweb.policy:default"
     />
 
+  <genericsetup:upgradeStep
+    title="Clean TS api URL"
+    description="Clean TS api URL in registry to keep only base URL"
+    source="1038"
+    destination="1039"
+    handler=".upgrades.clean_ts_api_url"
+    profile="imio.smartweb.policy:default"
+    />
+
 </configure>

src/imio/smartweb/policy/upgrades/upgrades.py

@@ -61,3 +61,25 @@ def set_keycloak_login_group(context):
         oidc.allowed_groups = ["iA.Smartweb"]
     else:
         logger.warning("OIDC plugin not found in acl_users; cannot set allowed_groups.")
+
+
+def clean_ts_api_url(context):
+    from imio.smartweb.policy.utils import get_ts_api_base_url
+
+    url_before = api.portal.get_registry_record("smartweb.url_ts")
+    if url_before is None:
+        logger.info("TS api URL is empty in registry, nothing to clean.")
+        return
+    url_after = get_ts_api_base_url()
+    if url_before == url_after:
+        logger.info(
+            f"TS api URL {url_before} is already clean in registry, nothing to do."
+        )
+        return
+    if url_after is None:
+        logger.warning(
+            f"TS api URL {url_before} is not valid, cannot be cleaned. Please check the value in the registry."
+        )
+        return
+    api.portal.set_registry_record("smartweb.url_ts", url_after)
+    logger.info(f"TS api URL {url_before} cleaned in registry. New value: {url_after}.")

src/imio/smartweb/policy/utils.py

@@ -5,6 +5,7 @@
 from plone import api
 from plone.portlets.interfaces import IPortletAssignmentMapping
 from plone.portlets.interfaces import IPortletManager
+from urllib.parse import urlparse
 from z3c.form.interfaces import IFormLayer
 from zope.component import getMultiAdapter
 from zope.component import getUtility
@@ -171,3 +172,15 @@ def get_cookie_policy_content():
     <p>Pour supprimer rapidement les cookies, certains navigateurs (Firefox, Chrome, Edge, Internet Explorer) proposent un raccourci clavier par l'appui simultané sur les touches CTRL/CMD, MAJ et DELETE.</p>
     """
     return cookie_policy_html
+
+
+def get_ts_api_base_url() -> str | None:
+    """Get the base url of the ts api."""
+    from imio.smartweb.core.utils import get_value_from_registry
+    from imio.smartweb.core.utils import is_valid_url
+
+    url_ts = get_value_from_registry("smartweb.url_ts")
+    if is_valid_url(url_ts):
+        parsed_url = urlparse(url_ts)
+        return f"{parsed_url.scheme}://{parsed_url.netloc}/"
+    return None