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

apps/forms/custom.py

@@ -1,9 +1,13 @@
+from crispy_forms.bootstrap import Accordion, AccordionGroup, PrependedText
 from crispy_forms.layout import HTML, Div, Field, Layout, MultiField
 from django import forms
+from django.core.exceptions import ValidationError
+from django.utils.safestring import mark_safe
 
 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"]
@@ -15,11 +19,24 @@ 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")
+
     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(
+            (
+                "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"
+                " navigates to the root URL, they will see an empty page there."
+            )
+        )
+
     def _setup_form_helper(self):
         super()._setup_form_helper()
 
@@ -40,10 +57,32 @@ def _setup_form_helper(self):
             ),
             SRVCommonDivField("port", placeholder="8000"),
             SRVCommonDivField("image"),
+            Accordion(
+                AccordionGroup(
+                    "Advanced settings",
+                    PrependedText(
+                        "custom_default_url",
+                        "Subdomain/",
+                        template="apps/partials/srv_prepend_input_group_custom_app.html",
+                    ),
+                    active=False,
+                ),
+            ),
             css_class="card-body",
         )
         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()
 
@@ -81,6 +120,7 @@ class Meta:
             "port",
             "image",
             "tags",
+            "custom_default_url",
         ]
         labels = {
             "note_on_linkonly_privacy": "Reason for choosing the link only option",

apps/helpers.py

@@ -221,12 +221,15 @@ def update_status_time(status_object, status_ts, event_msg=None):
         status_object.save(update_fields=["time", "info"])
 
 
-def get_URI(values):
+def get_URI(instance):
+    values = instance.k8s_values
     # Subdomain is empty if app is already deleted
     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)
     return URI
 
 
@@ -261,7 +264,16 @@ def create_instance_from_form(form, project, app_slug, app_id=None):
         do_deploy = True
     else:
         # Only re-deploy existing apps if one of the following fields was changed:
-        redeployment_fields = ["subdomain", "volume", "path", "flavor", "port", "image", "access", "shiny_site_dir"]
+        redeployment_fields = [
+            "subdomain",
+            "volume",
+            "path",
+            "flavor",
+            "port",
+            "image",
+            "access",
+            "shiny_site_dir",
+        ]
         logger.debug(f"An existing app has changed. The changed form fields: {form.changed_data}")
 
         # Because not all forms contain all fields, we check if the supposedly changed field
@@ -357,5 +369,5 @@ def save_instance_and_related_data(instance, form):
     instance.save()
     form.save_m2m()
     instance.set_k8s_values()
-    instance.url = get_URI(instance.k8s_values)
+    instance.url = get_URI(instance)
     instance.save(update_fields=["k8s_values", "url"])

apps/migrations/0018_customappinstance_custom_default_url_and_more.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.1.1 on 2024-10-29 14:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("apps", "0017_alter_streamlitinstance_port"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="customappinstance",
+            name="custom_default_url",
+            field=models.CharField(blank=True, default="", max_length=255),
+        ),
+    ]

apps/models/app_types/custom/custom.py

@@ -1,3 +1,5 @@
+from django.db import models
+
 from apps.models import AppInstanceManager, BaseAppInstance
 
 from .base import AbstractCustomAppInstance
@@ -8,4 +10,5 @@ class CustomAppInstanceManager(AppInstanceManager):
 
 
 class CustomAppInstance(AbstractCustomAppInstance, BaseAppInstance):
+    custom_default_url = models.CharField(max_length=255, default="", blank=True)
     objects = CustomAppInstanceManager()

apps/tests/test_forms.py

@@ -44,6 +44,7 @@ def setUp(self):
             "port": 8000,
             "image": "ghcr.io/scilifelabdatacentre/image:tag",
             "tags": ["tag1", "tag2", "tag3"],
+            "custom_default_url": "valid-custom_default_url/",
         }
 
     def test_form_valid_data(self):

apps/types_/url_additional_path_validation.py

@@ -0,0 +1,46 @@
+import regex as re
+from django.core.exceptions import ValidationError
+
+
+class UrlAdditionalPathValidation:
+    """
+    Validating a custom url path addition to the existing URL.
+    The validation limits to that additional part only.
+    For example, if the original URL is: https://xyz.serve-dev.scilifelab.se,
+    and we want to add a path so that it becomes https://xyz.serve-dev.scilifelab.se/new-path,
+    then it will only validate 'new-path' part.
+    """
+
+    __name = None
+
+    def __init__(self, name: str):
+        self.__name = name
+
+    def is_valid(self) -> bool:
+        """Determines if the proposed path addition is valid."""
+        try:
+            self.validate_candidate()
+            return True
+        except ValidationError:
+            return False
+
+    def validate_candidate(self):
+        """
+        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, self.__name):
+            raise ValidationError(error_message)

portal/views.py

@@ -79,7 +79,6 @@ def get_unique_apps(queryset, app_ids_to_exclude):
     app_orms = (app_model for app_model in APP_REGISTRY.iter_orm_models() if issubclass(app_model, SocialMixin))
 
     for app_orm in app_orms:
-        logger.info("Processing: %s", app_orm)
         filters = ~Q(app_status__status="Deleted") & Q(access="public")
         if collection:
             filters &= Q(collections__slug=collection)

templates/apps/partials/srv_prepend_input_group_custom_app.html

@@ -0,0 +1,41 @@
+{% 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);
+
+</script>