refactor: don't show entire stacktrace when missing env vars

Author: janbritz

questionpy_sdk/commands/run.py

@@ -12,6 +12,7 @@
 from questionpy_sdk.constants import DEFAULT_STATE_STORAGE_PATH
 from questionpy_sdk.watcher import Watcher
 from questionpy_sdk.webserver import WebServer
+from questionpy_sdk.webserver.errors import EnvironmentVariablesMissingError
 from questionpy_sdk.webserver.server import WebServerArgs
 from questionpy_server.worker.impl.subprocess import SubprocessWorker
 from questionpy_server.worker.impl.thread import ThreadWorker
@@ -94,4 +95,8 @@ def run(
     else:
         coro = async_run(webserver_args)
 
-    asyncio.run(coro)
+    try:
+        asyncio.run(coro)
+    except EnvironmentVariablesMissingError as e:
+        msg = f"The following environment variables are required to run the package: {', '.join(e.missing)}"
+        raise click.ClickException(msg) from e

questionpy_sdk/webserver/errors.py

@@ -36,6 +36,11 @@ class MissingAttemptDataError(MissingStateError):
     message = "The attempt data is missing."
 
 
+class EnvironmentVariablesMissingError(Exception):
+    def __init__(self, missing: set[str]) -> None:
+        self.missing = missing
+
+
 @dataclass(config=ConfigDict(use_attribute_docstrings=True))
 class DetailedServerError:
     """Represents a server-side error serialized for client display."""

questionpy_sdk/webserver/server.py

@@ -24,6 +24,7 @@
 from questionpy_server.worker.runtime.package_location import PackageLocation
 
 from .constants import API_PATH_PREFIX, USE_VITE_DEV_SERVER, WEBSERVER_KEY
+from .errors import EnvironmentVariablesMissingError
 from .manifest import read_manifest
 
 log = logging.getLogger("questionpy-sdk:web-server")
@@ -63,8 +64,7 @@ async def __aenter__(self) -> Self:
         # Check if required environment variables are set
         requested_environment_variables = self._manifest.environment_variables or set()
         if missing_environment_variables := requested_environment_variables - os.environ.keys():
-            msg = f"Required environment variables not set: {missing_environment_variables}"
-            raise ValueError(msg)
+            raise EnvironmentVariablesMissingError(missing=missing_environment_variables)
 
         # Assemble worker permissions
         permissions = CompletePackagePermissions()