Skip to content

πŸ™Œ OpenHands: AI-Driven Development

Fix SaaS routes shadowed by frontend mount (#14279)

Xingyao Wangd3864d9992c4
diff --git a/enterprise/saas_server.py b/enterprise/saas_server.py
index ea041d2412..1ece55a4b7 100644
--- a/enterprise/saas_server.py
+++ b/enterprise/saas_server.py
@@ -8,6 +8,10 @@ load_dotenv()
if not os.getenv('OPENHANDS_CONFIG_CLS'):
os.environ['OPENHANDS_CONFIG_CLS'] = 'server.config.SaaSServerConfig'
+# SaaS registers enterprise routes below, then mounts the frontend last. Avoid
+# the base app's import-time SPA mount from shadowing those routes.
+os.environ['SERVE_FRONTEND'] = 'false'
+
from fastapi import Request, status # noqa: E402
from fastapi.middleware.cors import CORSMiddleware # noqa: E402
from fastapi.responses import JSONResponse # noqa: E402
diff --git a/enterprise/tests/unit/test_saas_server.py b/enterprise/tests/unit/test_saas_server.py
new file mode 100644
index 0000000000..a6f8bb448b
--- /dev/null
+++ b/enterprise/tests/unit/test_saas_server.py
@@ -0,0 +1,61 @@
+import os
+import subprocess
+import sys
+import textwrap
+from pathlib import Path
+
+
+def test_oauth_callback_route_precedes_spa_mount(tmp_path):
+ frontend_build = tmp_path / 'frontend' / 'build'
+ frontend_build.mkdir(parents=True)
+ (frontend_build / 'index.html').write_text('<html></html>')
+
+ repo_root = Path(__file__).resolve().parents[3]
+ env = os.environ.copy()
+ env['FRONTEND_DIRECTORY'] = str(frontend_build)
+ env['PYTHONPATH'] = (
+ f"{repo_root / 'enterprise'}:{repo_root}:{env.get('PYTHONPATH', '')}"
+ )
+ env['OPENHANDS_SUPPRESS_BANNER'] = '1'
+ env['POSTHOG_CLIENT_KEY'] = 'test-posthog-key'
+ env['SERVE_FRONTEND'] = 'true'
+
+ script = textwrap.dedent(
+ """
+ from starlette.routing import Match
+
+ import saas_server
+
+ scope = {
+ 'type': 'http',
+ 'path': '/oauth/keycloak/callback',
+ 'root_path': '',
+ 'method': 'GET',
+ 'scheme': 'http',
+ 'server': ('testserver', 80),
+ 'client': ('testclient', 50000),
+ 'headers': [],
+ 'query_string': b'',
+ }
+
+ for route in saas_server.app.router.routes:
+ match, _ = route.matches(scope)
+ if match != Match.NONE:
+ print(getattr(route, 'name', None))
+ break
+ else:
+ raise SystemExit('no route matched')
+ """
+ )
+
+ result = subprocess.run(
+ [sys.executable, '-c', script],
+ cwd=tmp_path,
+ env=env,
+ text=True,
+ capture_output=True,
+ check=True,
+ )
+ matched_route = result.stdout.strip().splitlines()[-1]
+
+ assert matched_route == 'keycloak_callback'