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(views): saved views onto the typed-error contract

Juan Denis7c1edf595eed
diff --git a/backend/app/api/views.py b/backend/app/api/views.py
index 6ed6de45..551be831 100644
--- a/backend/app/api/views.py
+++ b/backend/app/api/views.py
@@ -20,15 +20,13 @@ def list_views():
@jwt_required()
def create_view():
body = request.get_json(silent=True) or {}
- view, err = saved_view_service.create_view(
+ view = saved_view_service.create_view(
get_jwt_identity(),
body.get('page'),
body.get('name'),
body.get('state'),
is_default=bool(body.get('is_default')),
)
- if err:
- return jsonify({'error': err}), 400
return jsonify(view), 201
@@ -36,17 +34,12 @@ def create_view():
@jwt_required()
def update_view(view_id):
body = request.get_json(silent=True) or {}
- view, err = saved_view_service.update_view(get_jwt_identity(), view_id, body)
- if err:
- code = 404 if 'not found' in err.lower() else 400
- return jsonify({'error': err}), code
+ view = saved_view_service.update_view(get_jwt_identity(), view_id, body)
return jsonify(view)
@views_bp.route('/<int:view_id>', methods=['DELETE'])
@jwt_required()
def delete_view(view_id):
- _, err = saved_view_service.delete_view(get_jwt_identity(), view_id)
- if err:
- return jsonify({'error': err}), 404
+ saved_view_service.delete_view(get_jwt_identity(), view_id)
return jsonify({'success': True})
diff --git a/backend/app/services/saved_view_service.py b/backend/app/services/saved_view_service.py
index 2c3ae234..1dfa8ec1 100644
--- a/backend/app/services/saved_view_service.py
+++ b/backend/app/services/saved_view_service.py
@@ -1,6 +1,7 @@
import logging
from app import db
+from app.exceptions import ConflictError, NotFoundError, ValidationError
from app.models.saved_view import SavedView
from app.utils.slug import slugify as _slugify, unique_slug
@@ -54,14 +55,13 @@ def list_views(user_id, page):
def _validate(page, name, state):
if not page or not isinstance(page, str) or len(page) > 80:
- return 'A view needs a page key (max 80 chars)'
+ raise ValidationError('A view needs a page key (max 80 chars)')
if not name or not isinstance(name, str) or not name.strip():
- return 'A view needs a name'
+ raise ValidationError('A view needs a name')
if len(name) > 120:
- return 'View names are limited to 120 characters'
+ raise ValidationError('View names are limited to 120 characters')
if not isinstance(state, dict):
- return 'View state must be an object'
- return None
+ raise ValidationError('View state must be an object')
def _clear_default(user_id, page):
@@ -71,15 +71,13 @@ def _clear_default(user_id, page):
def create_view(user_id, page, name, state, is_default=False):
- """Create a saved view. Returns ``(view_dict, error)``."""
- err = _validate(page, name, state)
- if err:
- return None, err
+ """Create a saved view and return its dict; raises typed errors."""
+ _validate(page, name, state)
name = name.strip()
if SavedView.query_active().filter_by(user_id=user_id, page=page).count() >= MAX_VIEWS_PER_PAGE:
- return None, f'You can save at most {MAX_VIEWS_PER_PAGE} views per page'
+ raise ValidationError(f'You can save at most {MAX_VIEWS_PER_PAGE} views per page')
if SavedView.query_active().filter_by(user_id=user_id, page=page, name=name).first():
- return None, f'You already have a "{name}" view on this page'
+ raise ConflictError(f'You already have a "{name}" view on this page')
if is_default:
_clear_default(user_id, page)
view = SavedView(user_id=user_id, page=page, name=name, state=state,
@@ -87,32 +85,30 @@ def create_view(user_id, page, name, state, is_default=False):
is_default=bool(is_default))
db.session.add(view)
db.session.commit()
- return view.to_dict(), None
+ return view.to_dict()
def update_view(user_id, view_id, data):
- """Rename / restate / (un)default a saved view. Returns ``(view_dict, error)``."""
+ """Rename / restate / (un)default a saved view; raises typed errors."""
view = SavedView.query_active().filter_by(id=view_id, user_id=user_id).first()
if not view:
- return None, 'View not found'
+ raise NotFoundError('View not found')
if 'name' in data:
- err = _validate(view.page, data['name'], view.state or {})
- if err:
- return None, err
+ _validate(view.page, data['name'], view.state or {})
name = data['name'].strip()
clash = (SavedView.query_active()
.filter_by(user_id=user_id, page=view.page, name=name)
.filter(SavedView.id != view.id)
.first())
if clash:
- return None, f'You already have a "{name}" view on this page'
+ raise ConflictError(f'You already have a "{name}" view on this page')
view.name = name
view.slug = _unique_slug(user_id, view.page, name, exclude_id=view.id)
if 'state' in data:
if not isinstance(data['state'], dict):
- return None, 'View state must be an object'
+ raise ValidationError('View state must be an object')
view.state = data['state']
if 'is_default' in data:
@@ -121,18 +117,17 @@ def update_view(user_id, view_id, data):
view.is_default = bool(data['is_default'])
db.session.commit()
- return view.to_dict(), None
+ return view.to_dict()
def delete_view(user_id, view_id):
- """Send a saved view to the Recycle Bin. Returns ``(True, error)``.
+ """Send a saved view to the Recycle Bin; raises NotFoundError if absent.
Soft, not destructive: a view is a piece of work someone tuned, and the
only way to get it back used to be rebuilding it from memory.
"""
view = SavedView.query_active().filter_by(id=view_id, user_id=user_id).first()
if not view:
- return None, 'View not found'
+ raise NotFoundError('View not found')
view.soft_delete(user_id=user_id)
db.session.commit()
- return True, None
diff --git a/backend/tests/STATUS_SNIFFING_CEILING b/backend/tests/STATUS_SNIFFING_CEILING
index b4de3947..f599e28b 100644
--- a/backend/tests/STATUS_SNIFFING_CEILING
+++ b/backend/tests/STATUS_SNIFFING_CEILING
@@ -1 +1 @@
-11
+10
diff --git a/backend/tests/test_recycle_bin.py b/backend/tests/test_recycle_bin.py
index bb6b528d..2cfd64cb 100644
--- a/backend/tests/test_recycle_bin.py
+++ b/backend/tests/test_recycle_bin.py
@@ -129,8 +129,7 @@ def test_unknown_kind_raises(app):
def test_deleting_a_view_sends_it_to_the_bin(app):
with app.app_context():
- view, err = saved_view_service.create_view(1, 'domains', 'SSL expiring', {'sorts': []})
- assert err is None
+ view = saved_view_service.create_view(1, 'domains', 'SSL expiring', {'sorts': []})
saved_view_service.delete_view(1, view['id'])
assert saved_view_service.list_views(1, 'domains') == []
@@ -139,8 +138,8 @@ def test_deleting_a_view_sends_it_to_the_bin(app):
def test_view_slug_is_derived_and_deduped(app):
with app.app_context():
- a, _ = saved_view_service.create_view(1, 'domains', 'SSL expiring', {})
- b, _ = saved_view_service.create_view(1, 'services', 'SSL expiring', {})
+ a = saved_view_service.create_view(1, 'domains', 'SSL expiring', {})
+ b = saved_view_service.create_view(1, 'services', 'SSL expiring', {})
assert a['slug'] == 'ssl-expiring'
assert b['slug'] == 'ssl-expiring' # different page, no clash
@@ -150,11 +149,10 @@ def test_view_slug_is_derived_and_deduped(app):
def test_a_deleted_view_frees_its_name_and_slug(app):
with app.app_context():
- first, _ = saved_view_service.create_view(1, 'domains', 'Triage', {})
+ first = saved_view_service.create_view(1, 'domains', 'Triage', {})
saved_view_service.delete_view(1, first['id'])
- again, err = saved_view_service.create_view(1, 'domains', 'Triage', {})
- assert err is None
+ again = saved_view_service.create_view(1, 'domains', 'Triage', {})
assert again['slug'] == 'triage' # not 'triage-2'
assert saved_view_service.get_by_slug(1, 'domains', 'triage')['id'] == again['id']
@@ -281,7 +279,7 @@ def test_restoring_a_view_is_refused_when_the_name_was_reused(app):
"""Deleting a view frees its name and slug, so either can be taken by the
time you press Restore — that must be a refusal, not an IntegrityError."""
with app.app_context():
- first, _ = saved_view_service.create_view(1, 'domains', 'Triage', {})
+ first = saved_view_service.create_view(1, 'domains', 'Triage', {})
saved_view_service.delete_view(1, first['id'])
saved_view_service.create_view(1, 'domains', 'Triage', {}) # reuses name + slug
diff --git a/backend/tests/test_views.py b/backend/tests/test_views.py
index b944c02b..95533969 100644
--- a/backend/tests/test_views.py
+++ b/backend/tests/test_views.py
@@ -51,7 +51,8 @@ def test_create_validates_input(client, auth_headers):
def test_duplicate_name_rejected(client, auth_headers):
assert _create(client, auth_headers).status_code == 201
resp = _create(client, auth_headers)
- assert resp.status_code == 400
+ # ConflictError under the typed-error contract (was a generic 400).
+ assert resp.status_code == 409
assert 'already' in resp.get_json()['error']