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.

feat(queue-bus): auto-generate slugs and resolve duplicates

Juan Denis440a215b5e39
diff --git a/backend/app/api/queue_bus.py b/backend/app/api/queue_bus.py
index 27868dee..545edd60 100644
--- a/backend/app/api/queue_bus.py
+++ b/backend/app/api/queue_bus.py
@@ -63,8 +63,8 @@ def create_group():
owner_id = data.get('owner_id')
config = data.get('config')
- if not slug:
- return jsonify({'error': 'slug is required'}), 400
+ if not slug and not name:
+ return jsonify({'error': 'name or slug is required'}), 400
user = _current_user()
if not _is_admin(user):
@@ -149,8 +149,8 @@ def create_queue(group_slug):
description = data.get('description')
config = data.get('config')
- if not slug:
- return jsonify({'error': 'slug is required'}), 400
+ if not slug and not name:
+ return jsonify({'error': 'name or slug is required'}), 400
queue = QueueBusService.create_queue(
group_slug=group_slug,
diff --git a/backend/app/queue_bus/service.py b/backend/app/queue_bus/service.py
index 768d0a46..aec04969 100644
--- a/backend/app/queue_bus/service.py
+++ b/backend/app/queue_bus/service.py
@@ -2,6 +2,7 @@
import logging
from app.queue_bus.sqlalchemy_broker import SQLAlchemyBroker, QueueBusError
+from app.utils.slug import unique_slug
logger = logging.getLogger(__name__)
@@ -31,10 +32,14 @@ class QueueBusService:
# Groups
# ------------------------------------------------------------------
@classmethod
- def create_group(cls, slug, name=None, description=None, owner_type='system', owner_id=None, config=None):
+ def create_group(cls, slug=None, name=None, description=None, owner_type='system', owner_id=None, config=None):
+ base = slug or name
+ if not base:
+ raise QueueBusError('Either slug or name is required', 400)
+ generated_slug = unique_slug(base, lambda s: cls.broker().get_group(s) is not None)
return cls.broker().create_group(
- slug=slug,
- name=name or slug,
+ slug=generated_slug,
+ name=name or generated_slug,
description=description,
owner_type=owner_type,
owner_id=owner_id,
@@ -61,11 +66,15 @@ class QueueBusService:
# Queues
# ------------------------------------------------------------------
@classmethod
- def create_queue(cls, group_slug, slug, name=None, description=None, config=None):
+ def create_queue(cls, group_slug, slug=None, name=None, description=None, config=None):
+ base = slug or name
+ if not base:
+ raise QueueBusError('Either slug or name is required', 400)
+ generated_slug = unique_slug(base, lambda s: cls.broker().get_queue(group_slug, s) is not None)
return cls.broker().create_queue(
group_slug=group_slug,
- slug=slug,
- name=name or slug,
+ slug=generated_slug,
+ name=name or generated_slug,
description=description,
config=config,
)
diff --git a/backend/app/utils/slug.py b/backend/app/utils/slug.py
new file mode 100644
index 00000000..1f9b3c06
--- /dev/null
+++ b/backend/app/utils/slug.py
@@ -0,0 +1,41 @@
+"""Slug generation utilities."""
+import re
+
+
+def slugify(text):
+ """Convert a string to a URL-safe slug.
+
+ Examples:
+ 'Hello World' -> 'hello-world'
+ 'My Queue Group!' -> 'my-queue-group'
+ ' Multiple spaces ' -> 'multiple-spaces'
+ """
+ if not text:
+ return ''
+ text = str(text).lower().strip()
+ # Replace any run of non-alphanumeric characters with a single hyphen
+ text = re.sub(r'[^a-z0-9]+', '-', text)
+ # Strip leading/trailing hyphens
+ text = text.strip('-')
+ return text
+
+
+def unique_slug(base, exists):
+ """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.
+ """
+ base_slug = slugify(base)
+ if not base_slug:
+ base_slug = 'untitled'
+ if not exists(base_slug):
+ return base_slug
+
+ counter = 1
+ while True:
+ candidate = f'{base_slug}-{counter}'
+ if not exists(candidate):
+ return candidate
+ counter += 1
diff --git a/backend/tests/test_queue_bus.py b/backend/tests/test_queue_bus.py
index c3c91576..552a3910 100644
--- a/backend/tests/test_queue_bus.py
+++ b/backend/tests/test_queue_bus.py
@@ -25,11 +25,15 @@ class TestGroups:
assert group['name'] == 'My Group'
assert QueueGroup.query.filter_by(slug='my-group').first() is not None
- def test_create_group_duplicate_fails(self, app):
+ def test_create_group_from_name(self, app):
+ group = QueueBusService.create_group(name='My Queue Group!')
+ assert group['slug'] == 'my-queue-group'
+ assert group['name'] == 'My Queue Group!'
+
+ def test_create_group_duplicate_gets_unique_slug(self, app):
QueueBusService.create_group('my-group')
- with pytest.raises(QueueBusError) as exc:
- QueueBusService.create_group('my-group')
- assert exc.value.status_code == 409
+ group = QueueBusService.create_group('my-group')
+ assert group['slug'] == 'my-group-1'
def test_list_groups(self, app):
QueueBusService.create_group('g1')
@@ -59,12 +63,11 @@ class TestQueues:
assert queue['slug'] == 'q1'
assert queue['config']['visibility_timeout_ms'] == 60000
- def test_create_queue_duplicate_fails(self, app):
+ def test_create_queue_duplicate_gets_unique_slug(self, app):
QueueBusService.create_group('g1')
QueueBusService.create_queue('g1', 'q1')
- with pytest.raises(QueueBusError) as exc:
- QueueBusService.create_queue('g1', 'q1')
- assert exc.value.status_code == 409
+ queue = QueueBusService.create_queue('g1', 'q1')
+ assert queue['slug'] == 'q1-1'
def test_list_queues(self, app):
QueueBusService.create_group('g1')
diff --git a/frontend/src/pages/QueueOperations.jsx b/frontend/src/pages/QueueOperations.jsx
index 04701689..4cf2de15 100644
--- a/frontend/src/pages/QueueOperations.jsx
+++ b/frontend/src/pages/QueueOperations.jsx
@@ -101,10 +101,13 @@ const QueueOperations = () => {
const handleCreateGroup = async (e) => {
e.preventDefault();
try {
- await api.createQueueGroup(groupForm);
+ await api.createQueueGroup({
+ name: groupForm.name,
+ description: groupForm.description,
+ });
toast.success('Queue group created');
setShowGroupModal(false);
- setGroupForm({ slug: '', name: '', description: '' });
+ setGroupForm({ name: '', description: '' });
loadData();
} catch (err) {
toast.error(err.message);
@@ -144,14 +147,13 @@ const QueueOperations = () => {
return;
}
await api.createQueue(selectedGroup, {
- slug: queueForm.slug,
name: queueForm.name,
description: queueForm.description,
config,
});
toast.success('Queue created');
setShowQueueModal(false);
- setQueueForm({ slug: '', name: '', description: '', config: '{}' });
+ setQueueForm({ name: '', description: '', config: '{}' });
loadQueues(selectedGroup);
} catch (err) {
toast.error(err.message);
@@ -555,10 +557,6 @@ const QueueOperations = () => {
</div>
<form onSubmit={handleCreateGroup}>
<div className="modal-body">
- <div className="form-group">
- <Label htmlFor="group-slug">Slug</Label>
- <Input id="group-slug" value={groupForm.slug} onChange={(e) => setGroupForm({ ...groupForm, slug: e.target.value })} required />
- </div>
<div className="form-group">
<Label htmlFor="group-name">Name</Label>
<Input id="group-name" value={groupForm.name} onChange={(e) => setGroupForm({ ...groupForm, name: e.target.value })} required />
@@ -600,10 +598,6 @@ const QueueOperations = () => {
{groups.map(g => <option key={g.id} value={g.slug}>{g.name}</option>)}
</select>
</div>
- <div className="form-group">
- <Label htmlFor="queue-slug">Slug</Label>
- <Input id="queue-slug" value={queueForm.slug} onChange={(e) => setQueueForm({ ...queueForm, slug: e.target.value })} required />
- </div>
<div className="form-group">
<Label htmlFor="queue-name">Name</Label>
<Input id="queue-name" value={queueForm.name} onChange={(e) => setQueueForm({ ...queueForm, name: e.target.value })} required />