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(workspaces): lenient workspace resolution for safe header-driven context (#33)

Juan Denis45aeb507e49a
diff --git a/backend/app/api/apps.py b/backend/app/api/apps.py
index 1db7ed53..a65356dc 100644
--- a/backend/app/api/apps.py
+++ b/backend/app/api/apps.py
@@ -315,10 +315,8 @@ def get_apps():
# prior behavior (admin -> all, else -> own); with ?workspace_id / X-Workspace-Id
# it filters to that workspace (membership-checked).
from app.services.workspace_service import WorkspaceService
- ws_id, werr = WorkspaceService.resolve_workspace_id(
+ ws_id = WorkspaceService.resolve_workspace_id(
user, request.headers.get('X-Workspace-Id') or request.args.get('workspace_id'))
- if werr:
- return jsonify({'error': werr[0]}), werr[1]
query = WorkspaceService.scope_query(Application.query, Application, user,
workspace_id=ws_id, owner_attr='user_id')
@@ -539,10 +537,8 @@ def create_app():
# Stamp the workspace (#33): the requested one (membership-checked) or the default.
from app.services.workspace_service import WorkspaceService
user = User.query.get(current_user_id)
- ws_id, werr = WorkspaceService.resolve_workspace_id(
+ ws_id = WorkspaceService.resolve_workspace_id(
user, request.headers.get('X-Workspace-Id') or request.args.get('workspace_id'))
- if werr:
- return jsonify({'error': werr[0]}), werr[1]
if ws_id is None:
ws_id = WorkspaceService.ensure_default_workspace().id
diff --git a/backend/app/api/servers.py b/backend/app/api/servers.py
index efc411f0..19498934 100644
--- a/backend/app/api/servers.py
+++ b/backend/app/api/servers.py
@@ -257,10 +257,8 @@ def list_servers():
from app.models import User
from app.services.workspace_service import WorkspaceService
user = User.query.get(get_jwt_identity())
- ws_id, werr = WorkspaceService.resolve_workspace_id(
+ ws_id = WorkspaceService.resolve_workspace_id(
user, request.headers.get('X-Workspace-Id') or request.args.get('workspace_id'))
- if werr:
- return jsonify({'error': werr[0]}), werr[1]
query = WorkspaceService.scope_query(Server.query, Server, user,
workspace_id=ws_id, owner_attr=None)
@@ -324,10 +322,8 @@ def create_server():
from app.models import User
from app.services.workspace_service import WorkspaceService
user = User.query.get(user_id)
- ws_id, werr = WorkspaceService.resolve_workspace_id(
+ ws_id = WorkspaceService.resolve_workspace_id(
user, request.headers.get('X-Workspace-Id') or request.args.get('workspace_id'))
- if werr:
- return jsonify({'error': werr[0]}), werr[1]
if ws_id is None:
ws_id = WorkspaceService.ensure_default_workspace().id
diff --git a/backend/app/services/workspace_service.py b/backend/app/services/workspace_service.py
index 23059dca..8b6282bf 100644
--- a/backend/app/services/workspace_service.py
+++ b/backend/app/services/workspace_service.py
@@ -47,30 +47,30 @@ class WorkspaceService:
@staticmethod
def resolve_workspace_id(user, requested):
- """Validate an optionally-requested workspace context.
-
- Returns (workspace_id|None, error|None) where error is a (message, status)
- tuple. A None workspace_id means "no active context" — callers then keep
- their existing non-workspace behavior. A truthy error means the request
- named a workspace the user may not use; callers should surface it.
+ """Resolve an optionally-requested workspace context to a usable workspace
+ id, or None for "no active context".
+
+ LENIENT by design: an unparsable, unknown, deactivated-account, or
+ not-permitted request degrades to None (no scoping) rather than raising,
+ so a stale `X-Workspace-Id` header (deleted workspace, removed member)
+ can never break the UI. This is safe because falling back to None only
+ ever shows the user their OWN resources and stamps the default workspace
+ on create — it never grants access to, or creates in, a workspace the
+ user doesn't belong to.
"""
if requested in (None, '', 'all'):
- return None, None
- # A deactivated account must not drive workspace resolution (the admin
- # bypass / membership check below key off this token-loaded user). Gated
- # only on the workspace path so the no-context behavior is unchanged.
+ return None
if not getattr(user, 'is_active', True):
- return None, ('Account is deactivated', 403)
+ return None
try:
ws_id = int(requested)
except (ValueError, TypeError):
- return None, ('Invalid workspace id', 400)
- ws = Workspace.query.get(ws_id)
- if not ws:
- return None, ('Workspace not found', 404)
+ return None
+ if Workspace.query.get(ws_id) is None:
+ return None
if not user.is_admin and WorkspaceService.get_user_role(ws_id, user.id) is None:
- return None, ('Workspace access denied', 403)
- return ws_id, None
+ return None
+ return ws_id
@staticmethod
def scope_query(query, model, user, workspace_id=None, owner_attr=None):
diff --git a/backend/tests/test_workspace_scope.py b/backend/tests/test_workspace_scope.py
index 12968f63..8434080b 100644
--- a/backend/tests/test_workspace_scope.py
+++ b/backend/tests/test_workspace_scope.py
@@ -41,34 +41,29 @@ def test_resolve_workspace_id_branches(app):
outsider = _mk_user(db, 'r_outsider', 'developer')
# No active context.
- assert WorkspaceService.resolve_workspace_id(outsider, None) == (None, None)
- assert WorkspaceService.resolve_workspace_id(outsider, '') == (None, None)
- assert WorkspaceService.resolve_workspace_id(outsider, 'all') == (None, None)
+ assert WorkspaceService.resolve_workspace_id(outsider, None) is None
+ assert WorkspaceService.resolve_workspace_id(outsider, '') is None
+ assert WorkspaceService.resolve_workspace_id(outsider, 'all') is None
- # Malformed / missing.
- wsid, err = WorkspaceService.resolve_workspace_id(outsider, 'abc')
- assert wsid is None and err[1] == 400
- wsid, err = WorkspaceService.resolve_workspace_id(outsider, 99999)
- assert wsid is None and err[1] == 404
+ # Malformed / unknown -> lenient fall back to no scope (never raises).
+ assert WorkspaceService.resolve_workspace_id(outsider, 'abc') is None
+ assert WorkspaceService.resolve_workspace_id(outsider, 99999) is None
# A workspace owned by `owner` (creator becomes owner-member).
ws = WorkspaceService.create_workspace({'name': 'Acme'}, owner.id)
- # A non-member non-admin is denied.
- wsid, err = WorkspaceService.resolve_workspace_id(outsider, ws.id)
- assert wsid is None and err[1] == 403
+ # A non-member non-admin falls back to no scope (no error, but no access either).
+ assert WorkspaceService.resolve_workspace_id(outsider, ws.id) is None
- # An admin who is NOT a member is allowed (admin bypass).
- wsid, err = WorkspaceService.resolve_workspace_id(admin, ws.id)
- assert wsid == ws.id and err is None
+ # An admin who is NOT a member resolves it (admin bypass).
+ assert WorkspaceService.resolve_workspace_id(admin, ws.id) == ws.id
- # A member is allowed.
+ # A member resolves it.
WorkspaceService.add_member(ws.id, outsider.id, 'member')
- wsid, err = WorkspaceService.resolve_workspace_id(outsider, ws.id)
- assert wsid == ws.id and err is None
+ assert WorkspaceService.resolve_workspace_id(outsider, ws.id) == ws.id
-def test_resolve_rejects_deactivated_user_on_workspace_path(app):
+def test_resolve_deactivated_user_falls_back(app):
from app import db
from app.services.workspace_service import WorkspaceService
@@ -79,11 +74,9 @@ def test_resolve_rejects_deactivated_user_on_workspace_path(app):
member.is_active = False
db.session.commit()
- # Requesting a workspace as a deactivated account is rejected...
- wsid, err = WorkspaceService.resolve_workspace_id(member, ws.id)
- assert wsid is None and err[1] == 403
- # ...but the no-context path is unchanged (no new behavior there).
- assert WorkspaceService.resolve_workspace_id(member, None) == (None, None)
+ # A deactivated account doesn't drive workspace scoping — it falls back to no scope.
+ assert WorkspaceService.resolve_workspace_id(member, ws.id) is None
+ assert WorkspaceService.resolve_workspace_id(member, None) is None
# ---- scope_query ----------------------------------------------------------
@@ -142,9 +135,11 @@ def test_get_apps_scoping_api(app, client):
assert r.status_code == 200
assert {a['name'] for a in r.get_json()['apps']} == {'in-ws', 'other-ws'}
- # Requesting a workspace the dev isn't a member of -> 403.
+ # Requesting a workspace the dev isn't a member of -> lenient fall back to no
+ # scope (stale/forbidden context never breaks the page; shows own apps).
r = client.get('/api/v1/apps', headers={**_token(dev.id), 'X-Workspace-Id': str(ws.id)})
- assert r.status_code == 403
+ assert r.status_code == 200
+ assert {a['name'] for a in r.get_json()['apps']} == {'in-ws', 'other-ws'}
# Once a member, the list is filtered to that workspace.
WorkspaceService.add_member(ws.id, dev.id, 'member')