SS-1176 Users are able to set a custom default start URL for their apps

apps/admin.py

@@ -103,7 +103,7 @@ def deploy_resources(self, request, queryset):
 
         for instance in queryset:
             instance.set_k8s_values()
-            instance.url = get_URI(instance.k8s_values)
+            instance.url = get_URI(instance)
             instance.save(update_fields=["k8s_values", "url"])
 
             deploy_resource.delay(instance.serialize())

apps/forms/custom.py

@@ -7,7 +7,6 @@
 from apps.forms.base import AppBaseForm
 from apps.forms.field.common import SRVCommonDivField
 from apps.models import CustomAppInstance, VolumeInstance
-from apps.types_.url_additional_path_validation import UrlAdditionalPathValidation
 from projects.models import Flavor
 
 __all__ = ["CustomAppForm"]
@@ -19,20 +18,20 @@ class CustomAppForm(AppBaseForm):
     image = forms.CharField(max_length=255, required=True)
     path = forms.CharField(max_length=255, required=False)
 
-    custom_default_url = forms.CharField(max_length=255, required=False, label="Custom default start URL")
+    default_url_subpath = forms.CharField(max_length=255, required=False, label="Custom default url subpath")
 
     def _setup_form_fields(self):
         # Handle Volume field
         super()._setup_form_fields()
         self.fields["volume"].initial = None
 
-        self.fields["custom_default_url"].widget.attrs.update({"class": "textinput form-control"})
-        self.fields["custom_default_url"].help_text = "Specify a non-default start URL if your app requires that."
-        self.fields["custom_default_url"].bottom_help_text = mark_safe(
+        self.fields["default_url_subpath"].widget.attrs.update({"class": "textinput form-control"})
+        self.fields["default_url_subpath"].help_text = "Specify a non-default start URL if your app requires that."
+        self.fields["default_url_subpath"].bottom_help_text = mark_safe(
             (
                 "We will display this URL for your app in our app catalogue."
                 " Keep in mind that when your app does not have anything on the root URL"
-                " (<span id='id_custom_default_url_form_help_text'></span>), if a user manually"
+                " (<span id='id_custom_default_url_subpath_form_help_text'></span>), if a user manually"
                 " navigates to the root URL, they will see an empty page there."
             )
         )
@@ -61,7 +60,7 @@ def _setup_form_helper(self):
                 AccordionGroup(
                     "Advanced settings",
                     PrependedText(
-                        "custom_default_url",
+                        "default_url_subpath",
                         "Subdomain/",
                         template="apps/partials/srv_prepend_input_group_custom_app.html",
                     ),
@@ -72,17 +71,6 @@ def _setup_form_helper(self):
         )
         self.helper.layout = Layout(body, self.footer)
 
-    def clean_custom_default_url(self):
-        cleaned_data = super().clean()
-
-        custom_url = cleaned_data.get("custom_default_url", None)
-        custom_url_candidate = UrlAdditionalPathValidation(custom_url)
-        try:
-            custom_url_candidate.validate_candidate()
-            return custom_url
-        except ValidationError as e:
-            self.add_error("custom_default_url", e)
-
     def clean_path(self):
         cleaned_data = super().clean()
 
@@ -120,7 +108,7 @@ class Meta:
             "port",
             "image",
             "tags",
-            "custom_default_url",
+            "default_url_subpath",
         ]
         labels = {
             "note_on_linkonly_privacy": "Reason for choosing the link only option",

apps/helpers.py

@@ -227,9 +227,9 @@ def get_URI(instance):
     subdomain = values["subdomain"] if "subdomain" in values else ""
     URI = f"https://{subdomain}.{values['global']['domain']}"
     URI = URI.strip("/")
-    if hasattr(instance, "custom_default_url") and instance.custom_default_url != "":
-        URI = URI + "/" + instance.custom_default_url
-        logger.info("Modified URI by adding custom default url for the custom app: " + URI)
+    if hasattr(instance, "default_url_subpath") and instance.default_url_subpath != "":
+        URI = URI + "/" + instance.default_url_subpath
+        logger.info("Modified URI by adding default url subpath for the custom app: " + URI)
     return URI
 
 

apps/migrations/0018_customappinstance_default_url_subpath.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.1.1 on 2024-11-19 13:27
+
+import apps.models.app_types.custom.custom
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("apps", "0017_alter_streamlitinstance_port"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="customappinstance",
+            name="default_url_subpath",
+            field=models.CharField(
+                blank=True,
+                default="",
+                max_length=255,
+                validators=[apps.models.app_types.custom.custom.validate_default_url_subpath],
+            ),
+        ),
+    ]

apps/models/app_types/custom/custom.py

@@ -1,14 +1,40 @@
+import regex as re
+from django.core.exceptions import ValidationError
 from django.db import models
 
 from apps.models import AppInstanceManager, BaseAppInstance
 
 from .base import AbstractCustomAppInstance
 
 
+def validate_default_url_subpath(candidate):
+    """
+    Validates a custom default url path addition.
+    The RegexValidator will raise a ValidationError if the input does not match the regular expression.
+    It is up to the caller to handle the raised exception if desired.
+    """
+    error_message = (
+        "Your custom default URL is not valid, please correct it. "
+        "It must be 1-53 characters long."
+        " It can contain only Unicode letters, digits, hyphens"
+        " ( - ), forward slashes ( / ), and underscores ( _ )."
+        " It cannot start or end with a hyphen ( - ) and "
+        "cannot start with a forward slash ( / )."
+        " It cannot contain consecutive forward slashes ( // )."
+    )
+
+    pattern = r"^(?!-)(?!/)(?!.*//)[\p{Letter}\p{Mark}0-9-/_]{1,53}(?<!-)$|^$"
+
+    if not re.match(pattern, candidate):
+        raise ValidationError(error_message)
+
+
 class CustomAppInstanceManager(AppInstanceManager):
     model_type = "customappinstance"
 
 
 class CustomAppInstance(AbstractCustomAppInstance, BaseAppInstance):
-    custom_default_url = models.CharField(max_length=255, default="", blank=True)
+    default_url_subpath = models.CharField(
+        validators=[validate_default_url_subpath], max_length=255, default="", blank=True
+    )
     objects = CustomAppInstanceManager()

apps/tests/test_forms.py

@@ -1,9 +1,12 @@
+import pytest
 from django.contrib.auth import get_user_model
+from django.core.exceptions import ValidationError
 from django.template import Context, Template
 from django.test import TestCase
 
 from apps.forms import CustomAppForm
 from apps.models import Apps, AppStatus, Subdomain, VolumeInstance
+from apps.models.app_types.custom.custom import validate_default_url_subpath
 from projects.models import Flavor, Project
 
 User = get_user_model()
@@ -44,7 +47,7 @@ def setUp(self):
             "port": 8000,
             "image": "ghcr.io/scilifelabdatacentre/image:tag",
             "tags": ["tag1", "tag2", "tag3"],
-            "custom_default_url": "valid-custom_default_url/",
+            "default_url_subpath": "valid-default_url_subpath/",
         }
 
     def test_form_valid_data(self):
@@ -193,3 +196,47 @@ def test_form_rendering(self):
         self.assertIn('value="private"', rendered_form)
         self.assertIn('value="link"', rendered_form)
         self.assertIn('value="public"', rendered_form)
+
+
+invalid_default_url_subpath_list = [
+    "invalid space",
+    'invalid_"_double_quote',
+    "invalid_<_less_than_sign",
+    "invalid_\\_backslash",
+    "invalid_|_pipe",
+    "invalid_^_caret",
+    "invalid_{_left_curly_brace",
+    "invalid_?_question_mark",
+]
+
+valid_default_url_subpath_list = [
+    "valid_ÄÄ_unicode_charecters",
+    "valid_aa/_forward_slash",
+    "valid_____underscore",
+    "_aa/bb/c_format",
+    "valid_-_hiphen",
+    "_ad-frt/fgh_cd_",
+    "ÅÄaad1234",
+]
+
+
+@pytest.mark.parametrize("valid_default_url_subpath", valid_default_url_subpath_list)
+def test_valid_default_url_subpath(valid_default_url_subpath):
+    valid_check = True
+    try:
+        validate_default_url_subpath(valid_default_url_subpath)
+    except ValidationError:
+        valid_check = False
+
+    assert valid_check
+
+
+@pytest.mark.parametrize("invalid_default_url_subpath", invalid_default_url_subpath_list)
+def test_invalid_default_url_subpath(invalid_default_url_subpath):
+    valid_check = True
+    try:
+        validate_default_url_subpath(invalid_default_url_subpath)
+    except ValidationError:
+        valid_check = False
+
+    assert not valid_check

templates/apps/partials/srv_prepend_input_group_custom_app.html

@@ -1,41 +1,46 @@
 {% include "apps/partials/div_label_with_help_toggle.html" with help_message=field.help_text %}
 {% load get_setting %}
-<div>
-  <div class="input-group">
-    {% if crispy_prepended_text %}
-      <span class="input-group-text" id="id_original_url_custom_default_url_form"></span>
-    {% endif %}
-    {{ field }}
-  </div>
-  {% if field.field.bottom_help_text %}
-    <small class="form-text text-muted">{{ field.field.bottom_help_text }}</small>
-  {% endif %}
-
-  {% if field.errors %}
-    {% for error in field.errors %}
-      <div class="client-validation-feedback client-validation-invalid">
-        {{ error }}
-      </div>
-    {% endfor %}
-  {% endif %}
-</div>
-
-<script>
-
-  const subdomainInput = document.getElementById("id_subdomain");
-  const customDefaultUrlFormModifiedUrlText = document.getElementById("id_original_url_custom_default_url_form");
-  const customDefaultUrlFormModifiedHelpTextUrl = document.getElementById("id_custom_default_url_form_help_text");
-
-  function updateUrlWithSubdomain() {
-    const subdomainValue = subdomainInput.value.trim();
-    const displayValue = subdomainValue || "subdomain_name";
 
-    customDefaultUrlFormModifiedUrlText.innerHTML = `https://${displayValue}.{% get_setting 'DOMAIN' %}/`;
-    customDefaultUrlFormModifiedHelpTextUrl.innerHTML = `https://${displayValue}.{% get_setting 'DOMAIN' %}/</b>`;
-  }
-
-  updateUrlWithSubdomain();
-
-  subdomainInput.addEventListener("blur", updateUrlWithSubdomain);
+<head>
+  <script>
+    document.addEventListener("DOMContentLoaded", function () {
+      const subdomainInput = document.getElementById("id_subdomain");
+      const customDefaultUrlFormModifiedUrlText = document.getElementById("id_original_default_url_subpath_form");
+      const customDefaultUrlFormModifiedHelpTextUrl = document.getElementById("id_custom_default_url_subpath_form_help_text");
+
+      function updateUrlWithSubdomain() {
+        const subdomainValue = subdomainInput.value.trim();
+        const displayValue = subdomainValue || "subdomain_name";
+
+        customDefaultUrlFormModifiedUrlText.innerHTML = `${displayValue}.{% get_setting 'DOMAIN' %}/`;
+        customDefaultUrlFormModifiedHelpTextUrl.innerHTML = `${displayValue}.{% get_setting 'DOMAIN' %}/</b>`;
+      }
+
+      updateUrlWithSubdomain();
+
+      subdomainInput.addEventListener("blur", updateUrlWithSubdomain);
+    });
+  </script>
+</head>
+
+<body>
+  <div>
+    <div class="input-group">
+      {% if crispy_prepended_text %}
+        <span class="input-group-text" id="id_original_default_url_subpath_form"></span>
+      {% endif %}
+      {{ field }}
+    </div>
+    {% if field.field.bottom_help_text %}
+      <small class="form-text text-muted">{{ field.field.bottom_help_text }}</small>
+    {% endif %}
 
-</script>
+    {% if field.errors %}
+      {% for error in field.errors %}
+        <div class="client-validation-feedback client-validation-invalid">
+          {{ error }}
+        </div>
+      {% endfor %}
+    {% endif %}
+  </div>
+</body>