Skip to content

ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.

refactor(services): centralize slug generation on app.utils.slug

Juan Denis415eba218725
diff --git a/backend/app/services/environment_domain_service.py b/backend/app/services/environment_domain_service.py
index 8f09c872..0b8978ca 100644
--- a/backend/app/services/environment_domain_service.py
+++ b/backend/app/services/environment_domain_service.py
@@ -11,6 +11,8 @@ import re
import subprocess
from typing import Dict
+from app.utils.slug import slugify as _slugify
+
class EnvironmentDomainService:
"""Service for managing per-environment domains and Nginx configs."""
@@ -358,10 +360,7 @@ class EnvironmentDomainService:
Returns:
Lowercase slug with only alphanumeric chars and hyphens
"""
- text = text.lower()
- text = re.sub(r'[^a-z0-9]+', '-', text)
- text = text.strip('-')
- return text
+ return _slugify(text)
@classmethod
def _reload_nginx(cls) -> Dict:
diff --git a/backend/app/services/environment_pipeline_service.py b/backend/app/services/environment_pipeline_service.py
index ffa25e69..ae591dd9 100644
--- a/backend/app/services/environment_pipeline_service.py
+++ b/backend/app/services/environment_pipeline_service.py
@@ -31,6 +31,7 @@ from app.models.promotion_job import PromotionJob
from app.services.environment_docker_service import EnvironmentDockerService
from app.services.environment_domain_service import EnvironmentDomainService
from app.services.db_sync_service import DatabaseSyncService
+from app.utils.slug import slugify
class EnvironmentPipelineService:
@@ -1810,11 +1811,7 @@ class EnvironmentPipelineService:
@staticmethod
def _slugify(text: str) -> str:
"""Convert text to a URL/filesystem-safe slug."""
- import re
- text = text.lower()
- text = re.sub(r'[^a-z0-9]+', '-', text)
- text = text.strip('-')
- return text or 'site'
+ return slugify(text) or 'site'
@staticmethod
def _generate_password(length: int = 32) -> str:
diff --git a/backend/app/services/marketplace_service.py b/backend/app/services/marketplace_service.py
index b94babc4..91b2070f 100644
--- a/backend/app/services/marketplace_service.py
+++ b/backend/app/services/marketplace_service.py
@@ -1,6 +1,7 @@
import logging
from app import db
from app.models.marketplace import Extension, ExtensionInstall
+from app.utils.slug import unique_slug
logger = logging.getLogger(__name__)
@@ -40,9 +41,12 @@ class MarketplaceService:
@staticmethod
def create_extension(data, user_id=None):
- slug = data.get('slug', data['name'].lower().replace(' ', '-'))
- if Extension.query.filter_by(slug=slug).first():
- raise ValueError(f"Extension '{slug}' already exists")
+ base = data.get('slug') or data['name']
+ slug = unique_slug(
+ base,
+ lambda s: Extension.query.filter_by(slug=s).first() is not None,
+ default='extension',
+ )
ext = Extension(
name=data['name'],
diff --git a/backend/app/services/secret_vault_service.py b/backend/app/services/secret_vault_service.py
index 1937d0f3..4a35141a 100644
--- a/backend/app/services/secret_vault_service.py
+++ b/backend/app/services/secret_vault_service.py
@@ -9,23 +9,17 @@ from typing import Dict, List, Optional
from app import db
from app.models import Secret, SecretVault
from app.utils.crypto import encrypt_secret, decrypt_secret_safe
+from app.utils.slug import unique_slug
logger = logging.getLogger(__name__)
-def _slugify(name: str) -> str:
- base = re.sub(r'[^a-z0-9]+', '-', name.lower()).strip('-')
- return base or 'vault'
-
-
def _unique_slug(name: str) -> str:
- base = _slugify(name)
- slug = base
- counter = 1
- while SecretVault.query.filter_by(slug=slug).first():
- slug = f'{base}-{counter}'
- counter += 1
- return slug
+ return unique_slug(
+ name,
+ lambda s: SecretVault.query.filter_by(slug=s).first() is not None,
+ default='vault',
+ )
class SecretVaultService:
diff --git a/backend/app/services/site_domain_service.py b/backend/app/services/site_domain_service.py
index 10f9ea06..c1ffb0a3 100644
--- a/backend/app/services/site_domain_service.py
+++ b/backend/app/services/site_domain_service.py
@@ -13,11 +13,10 @@ development that defaults to ``lvh.me``, a public resolver that maps
zero DNS setup. When no base domain is configured the helpers return ``None``
and callers fall back to the legacy ``localhost:<port>`` behaviour.
"""
-import re
-
from flask import current_app
from app.models.system_settings import SystemSettings
+from app.utils.slug import slugify as _slugify
class SiteDomainService:
@@ -68,10 +67,7 @@ class SiteDomainService:
@staticmethod
def slugify(name):
"""Turn a site name into a DNS-safe label (a-z, 0-9, single dashes)."""
- s = (name or '').strip().lower()
- s = re.sub(r'[^a-z0-9-]', '-', s)
- s = re.sub(r'-+', '-', s).strip('-')
- return s or 'site'
+ return _slugify(name) or 'site'
@classmethod
def subdomain_for(cls, name):
diff --git a/backend/app/services/status_page_service.py b/backend/app/services/status_page_service.py
index b97d8774..d293a890 100644
--- a/backend/app/services/status_page_service.py
+++ b/backend/app/services/status_page_service.py
@@ -1,5 +1,4 @@
import logging
-import re
import socket
import time
from datetime import datetime, timedelta
@@ -7,6 +6,7 @@ from app import db
from app.models.status_page import (
StatusPage, StatusComponent, HealthCheck, StatusIncident, StatusIncidentUpdate
)
+from app.utils.slug import validate_slug
logger = logging.getLogger(__name__)
@@ -14,19 +14,9 @@ logger = logging.getLogger(__name__)
class StatusPageService:
"""Service for public status pages and automated health checks."""
- SLUG_PATTERN = re.compile(r'^[a-z0-9]+(?:-[a-z0-9]+)*$')
-
@staticmethod
def normalize_slug(value):
- slug = (value or '').strip().lower()
- slug = re.sub(r'[\s_]+', '-', slug)
- slug = re.sub(r'[^a-z0-9-]', '', slug)
- slug = re.sub(r'-{2,}', '-', slug).strip('-')
- if not slug:
- raise ValueError('Slug is required')
- if not StatusPageService.SLUG_PATTERN.match(slug):
- raise ValueError('Slug can only contain lowercase letters, numbers, and hyphens')
- return slug
+ return validate_slug(value)
# --- Pages ---
diff --git a/backend/app/services/upload_service.py b/backend/app/services/upload_service.py
index 60b1a8f2..8f4d9527 100644
--- a/backend/app/services/upload_service.py
+++ b/backend/app/services/upload_service.py
@@ -1,5 +1,4 @@
import os
-import re
import shutil
import zipfile
import logging
@@ -7,6 +6,7 @@ from datetime import datetime
from werkzeug.utils import secure_filename
from app import paths
+from app.utils.slug import slugify
logger = logging.getLogger(__name__)
@@ -17,10 +17,6 @@ MAX_UPLOAD_SIZE = 100 * 1024 * 1024
VALID_APP_TYPES = {'docker', 'flask', 'django', 'php', 'static', 'node'}
-def slugify(value):
- return re.sub(r'[^a-z0-9-]+', '-', (value or '').strip().lower()).strip('-')
-
-
def detect_app_type(directory):
"""Inspect extracted archive contents and guess the runtime."""
if os.path.exists(os.path.join(directory, 'docker-compose.yml')):
diff --git a/backend/app/services/webhook_gateway_service.py b/backend/app/services/webhook_gateway_service.py
index ddbaf3cd..1d8779c6 100644
--- a/backend/app/services/webhook_gateway_service.py
+++ b/backend/app/services/webhook_gateway_service.py
@@ -3,7 +3,6 @@ import hashlib
import hmac
import json
import logging
-import re
import secrets
import uuid
from datetime import datetime
@@ -13,6 +12,7 @@ import requests
from app import db
from app.models import WebhookEndpoint, WebhookDelivery
+from app.utils.slug import unique_slug
logger = logging.getLogger(__name__)
@@ -35,20 +35,13 @@ class WebhookGatewayService:
def get_endpoint_by_slug(cls, slug: str) -> Optional[WebhookEndpoint]:
return WebhookEndpoint.query.filter_by(slug=slug, is_active=True).first()
- @classmethod
- def _slugify(cls, name: str) -> str:
- base = re.sub(r'[^a-z0-9]+', '-', name.lower()).strip('-')
- return base or 'endpoint'
-
@classmethod
def _unique_slug(cls, name: str) -> str:
- base = cls._slugify(name)
- slug = base
- counter = 1
- while WebhookEndpoint.query.filter_by(slug=slug).first():
- slug = f'{base}-{counter}'
- counter += 1
- return slug
+ return unique_slug(
+ name,
+ lambda s: WebhookEndpoint.query.filter_by(slug=s).first() is not None,
+ default='endpoint',
+ )
@classmethod
def create_endpoint(cls, name: str, secret: str = None, forward_url: str = None,
diff --git a/backend/app/services/workspace_service.py b/backend/app/services/workspace_service.py
index a3ccb1b2..61ce8201 100644
--- a/backend/app/services/workspace_service.py
+++ b/backend/app/services/workspace_service.py
@@ -1,11 +1,11 @@
import hashlib
import logging
import secrets
-import re
from datetime import datetime
from app import db
from app.models.workspace import Workspace, WorkspaceMember, WorkspaceApiKey
from app.models.user import User
+from app.utils.slug import unique_slug
logger = logging.getLogger(__name__)
@@ -15,11 +15,6 @@ class WorkspaceService:
DEFAULT_WORKSPACE_SLUG = 'default'
- @staticmethod
- def _slugify(name):
- slug = re.sub(r'[^a-z0-9]+', '-', name.lower()).strip('-')
- return slug or 'workspace'
-
# --- Scoping (#33 foundation) ---
#
# These three helpers centralize resource scoping so the admin-vs-owner-vs-
@@ -161,13 +156,11 @@ class WorkspaceService:
if not name:
raise ValueError('Workspace name required')
- slug = WorkspaceService._slugify(name)
- # Ensure unique slug
- base_slug = slug
- counter = 1
- while Workspace.query.filter_by(slug=slug).first():
- slug = f'{base_slug}-{counter}'
- counter += 1
+ slug = unique_slug(
+ name,
+ lambda s: Workspace.query.filter_by(slug=s).first() is not None,
+ default='workspace',
+ )
workspace = Workspace(
name=name,
diff --git a/backend/app/utils/slug.py b/backend/app/utils/slug.py
index 1f9b3c06..4033edb6 100644
--- a/backend/app/utils/slug.py
+++ b/backend/app/utils/slug.py
@@ -2,6 +2,9 @@
import re
+SLUG_PATTERN = re.compile(r'^[a-z0-9]+(?:-[a-z0-9]+)*$')
+
+
def slugify(text):
"""Convert a string to a URL-safe slug.
@@ -20,16 +23,22 @@ def slugify(text):
return text
-def unique_slug(base, exists):
+def unique_slug(base, exists, default='untitled'):
"""Return a unique slug based on `base`.
`exists` is a callable that takes a slug and returns True if it is already
in use. If `base` is taken, appends `-1`, `-2`, etc. until a free slug is
found.
+
+ Args:
+ base: The text or slug to start from.
+ exists: Callable(slug: str) -> bool.
+ default: Fallback string when `base` slugifies to something empty.
+
+ Returns:
+ A unique slug string.
"""
- base_slug = slugify(base)
- if not base_slug:
- base_slug = 'untitled'
+ base_slug = slugify(base) or default
if not exists(base_slug):
return base_slug
@@ -39,3 +48,25 @@ def unique_slug(base, exists):
if not exists(candidate):
return candidate
counter += 1
+
+
+def is_valid_slug(value):
+ """Return True if `value` is a non-empty, well-formed slug."""
+ return bool(value and SLUG_PATTERN.match(value))
+
+
+def validate_slug(value):
+ """Validate a slug and return a normalized value or raise ValueError.
+
+ This is stricter than `slugify`: it rejects empty values and values that
+ contain characters outside `[a-z0-9-]`, rather than converting them.
+ """
+ slug = (value or '').strip().lower()
+ slug = re.sub(r'[\s_]+', '-', slug)
+ slug = re.sub(r'[^a-z0-9-]', '', slug)
+ slug = re.sub(r'-{2,}', '-', slug).strip('-')
+ if not slug:
+ raise ValueError('Slug is required')
+ if not SLUG_PATTERN.match(slug):
+ raise ValueError('Slug can only contain lowercase letters, numbers, and hyphens')
+ return slug