add slugs to profile list

environment-dev.yml

@@ -19,5 +19,6 @@ dependencies:
   - streamlit
   - tornado>=5.1
   - traitlets
+  - python-slugify
   - pip:
       - gradio

jhub_apps/service/app.py

@@ -5,7 +5,7 @@
 from fastapi import FastAPI
 from fastapi.staticfiles import StaticFiles
 
-from .service import router
+from .routes import router
 
 ### When managed by Jupyterhub, the actual endpoints
 ### will be served out prefixed by /services/:name.

jhub_apps/service/utils.py

@@ -8,6 +8,7 @@
 from traitlets.config import LazyConfigValue
 
 from jhub_apps.spawner.types import FrameworkConf, FRAMEWORKS_MAPPING
+from slugify import slugify
 
 
 logger = logging.getLogger(__name__)
@@ -56,6 +57,21 @@ async def get_auth_state():
     return fake_spawner
 
 
+def _slugify_profile_list(profile_list):
+    # this is replicating the following:
+    # https://github.com/jupyterhub/kubespawner/blob/a4b9b190f0335406c33c6de11b5d1b687842dd89/kubespawner/spawner.py#L3279
+    # Since we are not inside spawner yet, the profiles might not be slugified yet
+    if not profile_list:
+        # empty profile lists are just returned
+        return profile_list
+
+    for profile in profile_list:
+        # generate missing slug fields from display_name
+        if 'slug' not in profile:
+            profile['slug'] = slugify(profile['display_name'])
+    return profile_list
+
+
 async def get_spawner_profiles(config, auth_state=None):
     """This will extract spawner profiles from the JupyterHub config
     If the Spawner is KubeSpawner
@@ -68,7 +84,8 @@ async def get_spawner_profiles(config, auth_state=None):
     elif callable(profile_list):
         try:
             logger.info("config.KubeSpawner.profile_list is a callable, calling now..")
-            return await profile_list(get_fake_spawner_object(auth_state))
+            profile_list = await profile_list(get_fake_spawner_object(auth_state))
+            return _slugify_profile_list(profile_list)
         except Exception as e:
             logger.exception(e)
             return []

pyproject.toml

@@ -24,6 +24,7 @@ dependencies = [
     "panel",
     "bokeh",
     "traitlets",
+    "python-slugify",
     "PyJWT",
 ]
 dynamic = ["version"]

ui/src/data/api.ts

@@ -15,9 +15,9 @@ export const frameworks: AppFrameworkProps[] = [
 export const environments = ['env-1', 'env-2', 'env-3', 'env-4', 'env-5'];
 
 export const profiles: AppProfileProps[] = [
-  { display_name: 'Small' },
-  { display_name: 'Medium' },
-  { display_name: 'Large' },
+  { display_name: 'Small', slug: 'small' },
+  { display_name: 'Medium', slug: 'medium' },
+  { display_name: 'Large', slug: 'large' },
 ];
 
 export const app: AppQueryGetProps = {

ui/src/pages/home/app-form/app-form.tsx

@@ -388,7 +388,7 @@ export const AppForm = ({
                 options={[
                   { value: '', label: 'Select...' },
                   ...profiles.map((profile: AppProfileProps) => ({
-                    value: profile.display_name,
+                    value: profile.slug,
                     label: profile.display_name,
                   })),
                 ]}

ui/src/types/api.ts

@@ -46,4 +46,5 @@ export interface AppFrameworkProps {
 
 export interface AppProfileProps {
   display_name: string;
+  slug: string;
 }