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.

Sweep retired extension leftovers at boot

Juan Denis0c8c5781213b
diff --git a/backend/app/__init__.py b/backend/app/__init__.py
index 19e297fd..3e9983cb 100644
--- a/backend/app/__init__.py
+++ b/backend/app/__init__.py
@@ -569,6 +569,16 @@ def create_app(config_name=None):
import logging
logging.getLogger(__name__).warning(f'Flagship seed: {e}')
+ # Sweep files/rows of retired extensions (e.g. serverkit-workflows)
+ # BEFORE the loader, so they are never loaded, never "repaired" back,
+ # and never carried forward into the next update's frontend build.
+ try:
+ from app.services.extension_migration import remove_retired_extensions
+ remove_retired_extensions()
+ except Exception as e:
+ import logging
+ logging.getLogger(__name__).warning(f'Retired extension sweep: {e}')
+
# Load installed plugins (dynamic blueprints) AFTER migrations,
# so the installed_plugins table exists.
try:
diff --git a/backend/app/services/extension_migration.py b/backend/app/services/extension_migration.py
index 0efbaa32..6311700b 100644
--- a/backend/app/services/extension_migration.py
+++ b/backend/app/services/extension_migration.py
@@ -18,6 +18,7 @@ the marker only governs whether the contribution is switched on.
"""
import json
import logging
+import os
import shutil
from app import db
@@ -28,13 +29,52 @@ logger = logging.getLogger(__name__)
# Builtin extensions that were previously shipped as core pages. Append a slug
# here when its page is converted; existing panels then auto-install it once.
CONVERTED_BUILTIN_SLUGS = [
- 'serverkit-workflows',
'serverkit-ftp',
'serverkit-cloud-provision',
'serverkit-remote-access',
'serverkit-status',
]
+# Extensions deliberately deleted from the product (replaced or retired) — the
+# Workflow Builder was superseded by serverkit-tramo (plan 45). Their leftover
+# copy-installed files must be swept from the live tree: update.sh's plugin
+# carry-forward would otherwise preserve them into every fresh deploy, where
+# their dead imports (workflows → reactflow) sink the bundle build. The updater
+# has its own skip list (RETIRED_PLUGIN_SLUGS in scripts/update.sh); this sweep
+# is the backstop for trees updated by an older/offline updater.
+RETIRED_EXTENSION_SLUGS = [
+ 'serverkit-workflows',
+]
+
+
+def remove_retired_extensions():
+ """Sweep files and DB rows of retired extensions. Idempotent, best-effort.
+
+ Runs at boot BEFORE the plugin loader so a retired backend plugin is never
+ loaded and the repair pass never tries to resurrect its row.
+ """
+ from app.services.plugin_service import (
+ BACKEND_PLUGINS_DIR,
+ FRONTEND_PLUGINS_DIR,
+ )
+ for slug in RETIRED_EXTENSION_SLUGS:
+ for base in (BACKEND_PLUGINS_DIR, FRONTEND_PLUGINS_DIR):
+ path = os.path.join(base, slug)
+ if os.path.isdir(path):
+ try:
+ shutil.rmtree(path)
+ logger.info(f'Removed retired extension files: {path}')
+ except OSError as e:
+ logger.warning(f'Could not remove retired extension {path}: {e}')
+ try:
+ row = InstalledPlugin.query.filter_by(slug=slug).first()
+ if row:
+ db.session.delete(row)
+ db.session.commit()
+ logger.info(f'Removed retired extension row: {slug}')
+ except Exception as e: # noqa: BLE001
+ logger.warning(f'Could not remove retired extension row {slug}: {e}')
+
def _email_was_configured():
"""True if this panel actually ran a mail server before the extraction — any
diff --git a/backend/tests/test_extension_migration.py b/backend/tests/test_extension_migration.py
index 1bdff29f..c19095af 100644
--- a/backend/tests/test_extension_migration.py
+++ b/backend/tests/test_extension_migration.py
@@ -132,3 +132,42 @@ def test_upgrade_with_gpu_installs(app, gated_gpu_builtin, monkeypatch):
p = InstalledPlugin.query.filter_by(slug='serverkit-gpu').first()
assert p is not None
assert p.status == InstalledPlugin.STATUS_ACTIVE
+
+
+def retired_leftovers(tmp_path, monkeypatch):
+ """Plant leftover files for a retired extension slug in both plugin dirs."""
+ backend = tmp_path / 'backend_plugins'
+ frontend = tmp_path / 'frontend_plugins'
+ for d in (backend, frontend):
+ (d / 'serverkit-oldthing').mkdir(parents=True)
+ (backend / 'serverkit-oldthing' / '__init__.py').write_text('')
+ (frontend / 'serverkit-oldthing' / 'index.jsx').write_text("import 'gone';\n")
+ monkeypatch.setattr(plugin_service, 'BACKEND_PLUGINS_DIR', str(backend))
+ monkeypatch.setattr(plugin_service, 'FRONTEND_PLUGINS_DIR', str(frontend))
+ monkeypatch.setattr(extension_migration, 'RETIRED_EXTENSION_SLUGS',
+ ['serverkit-oldthing'])
+ return backend, frontend
+
+
+def test_retired_extension_sweep(app, retired_leftovers):
+ """Retired leftovers (files + row) are swept at boot; the sweep is idempotent.
+
+ This is the serverkit-workflows scenario: a stale dir in the live tree was
+ carried into every update by the plugin preservation step, where its dead
+ imports broke the frontend build.
+ """
+ backend, frontend = retired_leftovers
+ db.session.add(InstalledPlugin(
+ name='serverkit-oldthing', display_name='Old Thing',
+ slug='serverkit-oldthing', version='1.0.0'))
+ db.session.commit()
+
+ extension_migration.remove_retired_extensions()
+
+ assert not (backend / 'serverkit-oldthing').exists()
+ assert not (frontend / 'serverkit-oldthing').exists()
+ assert InstalledPlugin.query.filter_by(slug='serverkit-oldthing').first() is None
+
+ # Second sweep on an already-clean tree is a quiet no-op.
+ extension_migration.remove_retired_extensions()