Merge pull request fastapi#31 from fastapilabs/09-13-_handle_deploying_to_non-existing_apps

✨ Handle deploying to non-existing apps

Author: patrick91

src/fastapi_cli/cli.py

@@ -1,4 +1,4 @@
-from logging import getLogger
+import logging
 from pathlib import Path
 from typing import Any, Union
 
@@ -20,8 +20,7 @@
 
 app = typer.Typer(rich_markup_mode="rich")
 
-setup_logging()
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 try:
@@ -45,6 +44,7 @@ def callback(
         ),
     ] = None,
     base_api_url: Union[str, None] = typer.Option(None, help="Base URL of the API"),
+    verbose: bool = typer.Option(False, help="Enable verbose output"),
 ) -> None:
     """
     FastAPI CLI - The [bold]fastapi[/bold] command line app. 😎
@@ -56,6 +56,10 @@ def callback(
     if base_api_url:
         settings.base_api_url = base_api_url
 
+    log_level = logging.DEBUG if verbose else logging.INFO
+
+    setup_logging(level=log_level)
+
 
 def _run(
     path: Union[Path, None] = None,

src/fastapi_cli/commands/deploy.py

@@ -6,7 +6,7 @@
 from enum import Enum
 from itertools import cycle
 from pathlib import Path
-from typing import Any, Dict, List, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 import rignore
 import typer
@@ -76,14 +76,12 @@ def _get_teams() -> List[Team]:
     return [Team.model_validate(team) for team in data]
 
 
-class CreateAppResponse(BaseModel):
-    name: str
+class AppResponse(BaseModel):
     id: str
-    team_id: str
     slug: str
 
 
-def _create_app(team_slug: str, app_name: str) -> CreateAppResponse:
+def _create_app(team_slug: str, app_name: str) -> AppResponse:
     with APIClient() as client:
         response = client.post(
             "/apps/",
@@ -92,7 +90,7 @@ def _create_app(team_slug: str, app_name: str) -> CreateAppResponse:
 
         response.raise_for_status()
 
-        return CreateAppResponse.model_validate(response.json())
+        return AppResponse.model_validate(response.json())
 
 
 class DeploymentStatus(str, Enum):
@@ -140,6 +138,20 @@ def _upload_deployment(deployment_id: str, archive_path: Path) -> None:
         response.raise_for_status()
 
 
+def _get_app(app_slug: str) -> Optional[AppResponse]:
+    with APIClient() as client:
+        response = client.get(f"/apps/{app_slug}")
+
+        if response.status_code == 404:
+            return None
+
+        response.raise_for_status()
+
+        data = response.json()
+
+    return AppResponse.model_validate(data)
+
+
 class DeploymentResponse(BaseModel):
     id: str
     app_id: str
@@ -179,7 +191,9 @@ def _get_deployment(app_id: str, deployment_id: str) -> DeploymentResponse:
 ]
 
 
-def _configure_app(toolkit: RichToolkit, path_to_deploy: Path) -> AppConfig:
+def _configure_app(
+    toolkit: RichToolkit, path_to_deploy: Path
+) -> Tuple[AppConfig, AppResponse]:
     if not toolkit.confirm(f"Setup and deploy [blue]{path_to_deploy}[/]?", tag="dir"):
         raise typer.Exit(0)
 
@@ -215,7 +229,7 @@ def _configure_app(toolkit: RichToolkit, path_to_deploy: Path) -> AppConfig:
 
         progress.log(f"App created successfully! App slug: {app_data.slug}")
 
-    return write_app_config(path_to_deploy, id=app_data.id, slug=app_data.slug)
+    return write_app_config(path_to_deploy, slug=app_data.slug), app_data
 
 
 def _wait_for_deployment(
@@ -297,19 +311,33 @@ def deploy(
         path_to_deploy = path or Path.cwd()
 
         app_config = get_app_config(path_to_deploy)
+        app_data: Optional[AppResponse] = None
 
         if not app_config:
-            app_config = _configure_app(toolkit, path_to_deploy=path_to_deploy)
+            app_config, app_data = _configure_app(
+                toolkit, path_to_deploy=path_to_deploy
+            )
         else:
             toolkit.print(f"Deploying app [blue]{app_config.slug}[blue]...")
+            toolkit.print_line()
+
+            with toolkit.progress("Checking app...", transient=True) as progress:
+                app_data = _get_app(app_config.slug)
+
+                if not app_data:
+                    progress.set_error(
+                        "App not found. Make sure you're logged in the correct account."
+                    )
+
+                    raise typer.Exit(1)
 
         toolkit.print_line()
 
         archive_path = archive(path or Path.cwd())  # noqa: F841
 
         with toolkit.progress(title="Creating deployment") as progress:
             with handle_http_errors(progress):
-                deployment = _create_deployment(app_config.id)
+                deployment = _create_deployment(app_data.id)
 
                 progress.log(
                     f"Deployment created successfully! Deployment slug: {deployment.slug}"
@@ -330,7 +358,7 @@ def deploy(
 
         if not skip_wait:
             _wait_for_deployment(
-                toolkit, app_config.id, deployment.id, check_deployment_url
+                toolkit, app_data.id, deployment.id, check_deployment_url
             )
         else:
             toolkit.print(

src/fastapi_cli/logging.py

@@ -5,7 +5,9 @@
 from rich.logging import RichHandler
 
 
-def setup_logging(terminal_width: Union[int, None] = None) -> None:
+def setup_logging(
+    terminal_width: Union[int, None] = None, level: int = logging.INFO
+) -> None:
     logger = logging.getLogger("fastapi_cli")
     console = Console(width=terminal_width) if terminal_width else None
     rich_handler = RichHandler(
@@ -19,5 +21,5 @@ def setup_logging(terminal_width: Union[int, None] = None) -> None:
     rich_handler.setFormatter(logging.Formatter("%(message)s"))
     logger.addHandler(rich_handler)
 
-    logger.setLevel(logging.INFO)
+    logger.setLevel(level)
     logger.propagate = False

src/fastapi_cli/utils/apps.py

@@ -6,7 +6,6 @@
 
 class AppConfig(BaseModel):
     slug: str
-    id: str
 
 
 def get_app_config(path_to_deploy: Path) -> Optional[AppConfig]:
@@ -18,11 +17,11 @@ def get_app_config(path_to_deploy: Path) -> Optional[AppConfig]:
     return AppConfig.model_validate_json(config_path.read_text(encoding="utf-8"))
 
 
-def write_app_config(path_to_deploy: Path, slug: str, id: str) -> AppConfig:
+def write_app_config(path_to_deploy: Path, slug: str) -> AppConfig:
     config_path = path_to_deploy / ".fastapi/cloud.json"
     config_path.parent.mkdir(parents=True, exist_ok=True)
 
-    app_config = AppConfig(slug=slug, id=id)
+    app_config = AppConfig(slug=slug)
 
     config_path.write_text(
         app_config.model_dump_json(),

src/fastapi_cli/utils/cli.py

@@ -47,6 +47,10 @@ def handle_http_errors(
     except HTTPError as e:
         logger.debug(e)
 
+        # Handle validation errors from Pydantic models, this should make it easier to debug :)
+        if isinstance(e, HTTPStatusError) and e.response.status_code == 422:
+            logger.debug(e.response.json())
+
         if isinstance(e, HTTPStatusError) and e.response.status_code in (401, 403):
             message = "The specified token is not valid. Use `fastapi login` to generate a new token."
 

tests/test_cli_deploy.py

@@ -339,6 +339,92 @@ def test_exists_successfully_when_deployment_is_done(
         assert "Ready the chicken! Your app is ready at" in result.output
 
 
+@pytest.mark.respx(base_url=settings.base_api_url)
+def test_exists_successfully_when_deployment_is_done_when_app_is_configured(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    config_path = tmp_path / ".fastapi" / "cloud.json"
+
+    config_path.parent.mkdir(parents=True, exist_ok=True)
+    config_path.write_text('{"slug": "demo"}')
+
+    respx_mock.get("/apps/demo").mock(
+        return_value=Response(200, json={"slug": "demo", "id": "1234"})
+    )
+
+    respx_mock.post(
+        "/apps/1234/deployments/",
+    ).mock(
+        return_value=Response(
+            201,
+            json={
+                "id": "deployment-1",
+                "app_id": "1234",
+                "slug": "demo",
+                "status": "waiting_upload",
+                "url": "http://test.com",
+            },
+        )
+    )
+    respx_mock.post(
+        "/deployments/deployment-1/upload",
+    ).mock(
+        return_value=Response(
+            200,
+            json={
+                "url": "http://test.com",
+                "fields": {"key": "value"},
+            },
+        )
+    )
+
+    respx_mock.post(
+        "http://test.com",
+        data={"key": "value"},
+    ).mock(return_value=Response(200))
+
+    respx_mock.get(
+        "/apps/1234/deployments/deployment-1",
+    ).mock(
+        return_value=Response(
+            200,
+            json={
+                "id": "deployment-1",
+                "app_id": "1234",
+                "slug": "demo",
+                "status": "success",
+                "url": "http://test.com",
+            },
+        )
+    )
+
+    with changing_dir(tmp_path):
+        result = runner.invoke(app, ["deploy"])
+
+        assert result.exit_code == 0
+
+        assert "Ready the chicken! Your app is ready at" in result.output
+
+
+@pytest.mark.respx(base_url=settings.base_api_url)
+def test_shows_error_when_app_does_not_exist(
+    logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter
+) -> None:
+    config_path = tmp_path / ".fastapi" / "cloud.json"
+
+    config_path.parent.mkdir(parents=True, exist_ok=True)
+    config_path.write_text('{"slug": "demo"}')
+
+    respx_mock.get("/apps/demo").mock(return_value=Response(404))
+
+    with changing_dir(tmp_path):
+        result = runner.invoke(app, ["deploy"])
+
+        assert result.exit_code == 1
+
+        assert "App not found" in result.output
+
+
 @pytest.mark.respx(base_url=settings.base_api_url)
 def test_can_skip_waiting(
     logged_in_cli: None, tmp_path: Path, respx_mock: respx.MockRouter