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

…ps (#249)

Co-authored-by: Arnold Kochari <[email protected]>

Source: https://scilifelab.atlassian.net/browse/SS-1176

when we deploy an app it show app-subdomain.serve.scilifelab.se but if user wants the base page to be app-subdomain.serve.scilifelab.se/docs then that should be configurable.

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

@@ -1,5 +1,9 @@
+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.urls import reverse
+from django.utils.safestring import mark_safe
 
 from apps.forms.base import AppBaseForm
 from apps.forms.field.common import SRVCommonDivField
@@ -14,12 +18,23 @@ class CustomAppForm(AppBaseForm):
     port = forms.IntegerField(min_value=3000, max_value=9999, required=True)
     image = forms.CharField(max_length=255, required=True)
     path = forms.CharField(max_length=255, required=False)
+    default_url_subpath = forms.CharField(max_length=255, required=False, label="Custom URL subpath")
 
     def _setup_form_fields(self):
         # Handle Volume field
         super()._setup_form_fields()
         self.fields["volume"].initial = None
 
+        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."
+        apps_url = reverse("portal:apps")
+        self.fields["default_url_subpath"].bottom_help_text = mark_safe(
+            (
+                f"<span class='fw-bold'>Note:</span> This changes the URL connected to the Open button for an app"
+                f" on the Serve <a href='{apps_url}'>Apps & Models</a> page."
+            )
+        )
+
     def _setup_form_helper(self):
         super()._setup_form_helper()
 
@@ -40,6 +55,17 @@ def _setup_form_helper(self):
             ),
             SRVCommonDivField("port", placeholder="8000"),
             SRVCommonDivField("image"),
+            Accordion(
+                AccordionGroup(
+                    "Advanced settings",
+                    PrependedText(
+                        "default_url_subpath",
+                        mark_safe("<span id='id_custom_default_url_prepend'>Subdomain/</span>"),
+                        template="apps/partials/srv_prepend_append_input_group.html",
+                    ),
+                    active=False,
+                ),
+            ),
             css_class="card-body",
         )
         self.helper.layout = Layout(body, self.footer)
@@ -81,6 +107,7 @@ class Meta:
             "port",
             "image",
             "tags",
+            "default_url_subpath",
         ]
         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, "default_url_subpath") and instance.default_url_subpath != "":
+        URI = URI + "/" + instance.default_url_subpath
+        logger.info("Modified URI by adding custom default url for the custom app: %s", 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_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,11 +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 URL subpath 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):
+    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,6 +47,7 @@ def setUp(self):
             "port": 8000,
             "image": "ghcr.io/scilifelabdatacentre/image:tag",
             "tags": ["tag1", "tag2", "tag3"],
+            "default_url_subpath": "valid-default_url_subpath/",
         }
 
     def test_form_valid_data(self):
@@ -192,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

cypress/e2e/ui-tests/test-project-as-contributor.cy.js

@@ -226,7 +226,7 @@ describe("Test project contributor user functionality", () => {
 
     it("limit on number of apps per project is enforced", () => {
         // Names of objects to create
-        const project_name = "e2e-create-proj-test"
+        const project_name = "e2e-create-proj-test-1"
 
         // Create a project
         cy.visit("/projects/")
@@ -268,14 +268,14 @@ describe("Test project contributor user functionality", () => {
 
     it("limit on number of projects per user is enforced", () => {
         // Names of projects to create
-        const project_name = "e2e-create-proj-test"
+        const project_name = "e2e-create-proj-test-2"
 
         // Create 10 projects (current limit)
-        Cypress._.times(10, () => {
+        Cypress._.times(10, (i) => {
             cy.visit("/projects/")
             cy.get("a").contains('New project').click()
             cy.get("a").contains('Create').first().click()
-            cy.get('input[name=name]').type(project_name)
+            cy.get('input[name=name]').type(`${project_name}-${i + 1}`);
             cy.get("input[name=save]").contains('Create project').click()
         });
         cy.wait(5000) // sometimes it takes a while to create a project but just waiting once at the end should be enough
@@ -467,7 +467,7 @@ describe("Test project contributor user functionality", () => {
     })
 
     it("can create a file management instance", { defaultCommandTimeout: defaultCmdTimeoutMs }, () => {
-        const project_name = "e2e-create-proj-test"
+        const project_name = "e2e-create-proj-test-3"
 
         cy.logf("Creating a blank project", Cypress.currentTest)
         cy.createBlankProject(project_name)

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/create_base.html

@@ -5,7 +5,7 @@
 {% load crispy_forms_tags %}
 
 {% block content %}
-
+{% load get_setting %}
 {% include "breadcrumbs/bc_app_create.html" %}
 
 <div class="row d-flex justify-content-center mt-2">
@@ -122,6 +122,19 @@ <h1 class="h3 mb-3 card-title">Create {{ form.model_name }}</h1>
         }
     }
 
+    // SS-1176 Users are able to set a custom default start URL for their apps
+    const subdomainInput = document.getElementById("id_subdomain");
+    const customDefaultUrlFormModifiedUrlText = document.getElementById("id_custom_default_url_prepend");
+
+    function updateUrlWithSubdomain() {
+        try {
+            const subdomainValue = subdomainInput.value.trim();
+            const displayValue = subdomainValue || "subdomain_name";
+            customDefaultUrlFormModifiedUrlText.innerHTML = `${displayValue}.{% get_setting 'DOMAIN' %}/</b>`;
+        } catch (error) {
+            console.log("No custom url subpath option in this app type.");
+        }
+    }
 
     // User is "finished typing," do something
     function doneTyping () {
@@ -141,6 +154,7 @@ <h1 class="h3 mb-3 card-title">Create {{ form.model_name }}</h1>
             // OK because the input form and the server does the same.
             checkSubdomainValidity(subdomain_input.toLowerCase());
         }
+        updateUrlWithSubdomain();
     }
     function selectValidation(event) {
         doneTyping(event.target.value);
@@ -183,6 +197,7 @@ <h1 class="h3 mb-3 card-title">Create {{ form.model_name }}</h1>
     });
     htmx.onLoad(function(content) {
         runScript();
+        updateUrlWithSubdomain();
     })
     </script>
 

templates/apps/partials/srv_prepend_append_input_group.html

@@ -2,7 +2,7 @@
 <div>
   <div class="input-group">
     {% if crispy_prepended_text %}
-      <span class="input-group-text">{{ crispy_prepended_text }}</span>
+    <span class="input-group-text fw-bold">{{ crispy_prepended_text }}</span>
     {% endif %}
     {{ field }}
     {% if crispy_appended_text %}