✨ Add deployment presigned url service and logic (#239)

Co-authored-by: github-actions <[email protected]>

Author: estebanx64

.env

@@ -41,3 +41,6 @@ SENTRY_DSN="https://[email protected]
 # Configure these with your own Docker registry images
 DOCKER_IMAGE_BACKEND=backend
 DOCKER_IMAGE_FRONTEND=frontend
+
+# AWS
+AWS_DEPLOYMENT_BUCKET=s3-deployment-customer-apps

backend/app/api/routes/deployments.py

@@ -1,18 +1,21 @@
 import uuid
 from typing import Any, Literal
 
-from fastapi import APIRouter, HTTPException, UploadFile
+from fastapi import APIRouter, HTTPException
 from sqlalchemy import func
 from sqlmodel import col, select
 
 from app.api.deps import CurrentUser, SessionDep
+from app.api.utils.aws_s3 import generate_presigned_url_post
+from app.core.config import settings
 from app.crud import get_user_team_link_by_user_id_and_team_slug
 from app.models import (
     App,
     Deployment,
     DeploymentPublic,
     DeploymentsPublic,
     DeploymentStatus,
+    DeploymentUploadOut,
 )
 
 router = APIRouter()
@@ -94,12 +97,44 @@ def create_deployment(
     return new_deployment
 
 
-@router.post("/deployments/{deployment_id}/upload")
+@router.post("/deployments/{deployment_id}/upload", response_model=DeploymentUploadOut)
 def upload_deployment_artifact(
-    deployment_id: uuid.UUID,  # noqa F841
-    upload_file: UploadFile,
+    session: SessionDep,
+    current_user: CurrentUser,
+    deployment_id: uuid.UUID,
 ) -> Any:
     """
     Upload a new deployment artifact.
     """
-    return {"filename": upload_file.filename}
+    deployment = session.exec(
+        select(Deployment).where(Deployment.id == deployment_id)
+    ).first()
+    if not deployment:
+        raise HTTPException(status_code=404, detail="Deployment not found")
+
+    app = session.exec(select(App).where(App.id == deployment.app_id)).first()
+    if not app:
+        raise HTTPException(status_code=404, detail="App not found")
+
+    user_team_link = get_user_team_link_by_user_id_and_team_slug(
+        session=session, user_id=current_user.id, team_slug=app.team.slug
+    )
+    if not user_team_link:
+        raise HTTPException(
+            status_code=404, detail="Team not found for the current user"
+        )
+
+    object_name = f"{app.id}/{deployment.id}.tar"
+
+    presigned_url = generate_presigned_url_post(
+        bucket_name=settings.AWS_DEPLOYMENT_BUCKET,
+        object_name=object_name,
+    )
+    if not presigned_url:
+        raise HTTPException(status_code=500, detail="Error generating presigned URL")
+
+    deployment_url = DeploymentUploadOut(
+        url=presigned_url["url"], fields=presigned_url["fields"]
+    )
+
+    return deployment_url

backend/app/api/utils/aws_s3.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+import boto3
+from botocore.exceptions import ClientError
+
+
+def generate_presigned_url_post(
+    bucket_name: str, object_name: str, expiration: int = 600
+) -> dict[str, Any] | None:
+    """
+    Generate a presigned POST URL to upload a file to an S3 bucket
+    """
+    s3_client = boto3.client("s3")
+    try:
+        response = s3_client.generate_presigned_post(
+            Bucket=bucket_name,
+            Key=object_name,
+            ExpiresIn=expiration,
+        )
+    except ClientError as e:
+        print(f"Error generating presigned POST URL: {e}")
+        return None
+
+    return response

backend/app/core/config.py

@@ -138,5 +138,7 @@ def _enforce_non_default_secrets(self) -> Self:
 
         return self
 
+    AWS_DEPLOYMENT_BUCKET: str
+
 
 settings = Settings()  # type: ignore

backend/app/models.py

@@ -1,6 +1,7 @@
 import uuid
 from datetime import datetime
 from enum import Enum
+from typing import Any
 
 from pydantic import EmailStr, computed_field
 from sqlalchemy.ext.hybrid import hybrid_property
@@ -319,3 +320,8 @@ class DeploymentPublic(SQLModel):
 class DeploymentsPublic(SQLModel):
     data: list[DeploymentPublic]
     count: int
+
+
+class DeploymentUploadOut(SQLModel):
+    url: str
+    fields: dict[str, Any]

backend/poetry.lock

@@ -27,6 +27,8 @@ pydantic-settings = "^2.2.1"
 sentry-sdk = {extras = ["fastapi"], version = "^1.40.6"}
 pyjwt = "^2.8.0"
 redis = {extras = ["hiredis"], version = "^5.0.7"}
+boto3-stubs = {extras = ["s3"], version = "^1.35.10"}
+boto3 = "^1.35.10"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.3"

backend/pyproject.toml

@@ -37,12 +37,6 @@ export type AuthorizeDeviceIn = {
 
 
 
-export type Body_deployments_upload_deployment_artifact = {
-	upload_file: Blob | File;
-};
-
-
-
 export type Body_login_device_authorization = {
 	client_id: string;
 };
@@ -84,6 +78,13 @@ export type DeploymentStatus = 'waiting_upload' | 'building' | 'deploying' | 'su
 
 
 
+export type DeploymentUploadOut = {
+	url: string;
+	fields: Record<string, unknown>;
+};
+
+
+
 export type DeploymentsPublic = {
 	data: Array<DeploymentPublic>;
 	count: number;

frontend/src/client/models.ts

@@ -90,16 +90,6 @@ export const $AuthorizeDeviceIn = {
 	},
 } as const;
 
-export const $Body_deployments_upload_deployment_artifact = {
-	properties: {
-		upload_file: {
-	type: 'binary',
-	isRequired: true,
-	format: 'binary',
-},
-	},
-} as const;
-
 export const $Body_login_device_authorization = {
 	properties: {
 		client_id: {
@@ -207,6 +197,23 @@ export const $DeploymentStatus = {
 	enum: ['waiting_upload','building','deploying','success','failed',],
 } as const;
 
+export const $DeploymentUploadOut = {
+	properties: {
+		url: {
+	type: 'string',
+	isRequired: true,
+},
+		fields: {
+	type: 'dictionary',
+	contains: {
+	properties: {
+	},
+},
+	isRequired: true,
+},
+	},
+} as const;
+
 export const $DeploymentsPublic = {
 	properties: {
 		data: {

frontend/src/client/schemas.ts

@@ -2,7 +2,7 @@ import type { CancelablePromise } from './core/CancelablePromise';
 import { OpenAPI } from './core/OpenAPI';
 import { request as __request } from './core/request';
 
-import type { AccessTokenWithUserMe,AuthorizeDeviceIn,Body_login_device_authorization,Body_login_login_access_token,Body_login_login_token,DeviceAuthorizationInfo,DeviceAuthorizationResponse,Message,NewPassword,Token,UserPublic,EmailVerificationToken,UpdatePassword,UserMePublic,UserRegister,UserUpdateEmailMe,UserUpdateMe,HealthCheckResponse,TeamCreate,TeamPublic,TeamsPublic,TeamUpdate,TeamUpdateMember,TeamWithUserPublic,UserTeamLinkPublic,InvitationCreate,InvitationPublic,InvitationsPublic,InvitationStatus,InvitationToken,AppCreate,AppPublic,AppsPublic,Body_deployments_upload_deployment_artifact,DeploymentPublic,DeploymentsPublic } from './models';
+import type { AccessTokenWithUserMe,AuthorizeDeviceIn,Body_login_device_authorization,Body_login_login_access_token,Body_login_login_token,DeviceAuthorizationInfo,DeviceAuthorizationResponse,Message,NewPassword,Token,UserPublic,EmailVerificationToken,UpdatePassword,UserMePublic,UserRegister,UserUpdateEmailMe,UserUpdateMe,HealthCheckResponse,TeamCreate,TeamPublic,TeamsPublic,TeamUpdate,TeamUpdateMember,TeamWithUserPublic,UserTeamLinkPublic,InvitationCreate,InvitationPublic,InvitationsPublic,InvitationStatus,InvitationToken,AppCreate,AppPublic,AppsPublic,DeploymentPublic,DeploymentsPublic,DeploymentUploadOut } from './models';
 
 export type TDataLoginAccessToken = {
                 formData: Body_login_login_access_token
@@ -1007,7 +1007,6 @@ export type TDataCreateDeployment = {
             }
 export type TDataUploadDeploymentArtifact = {
                 deploymentId: string
-formData: Body_deployments_upload_deployment_artifact
 
             }
 
@@ -1067,22 +1066,19 @@ appId,
 	/**
 	 * Upload Deployment Artifact
 	 * Upload a new deployment artifact.
-	 * @returns unknown Successful Response
+	 * @returns DeploymentUploadOut Successful Response
 	 * @throws ApiError
 	 */
-	public static uploadDeploymentArtifact(data: TDataUploadDeploymentArtifact): CancelablePromise<unknown> {
+	public static uploadDeploymentArtifact(data: TDataUploadDeploymentArtifact): CancelablePromise<DeploymentUploadOut> {
 		const {
 deploymentId,
-formData,
 } = data;
 		return __request(OpenAPI, {
 			method: 'POST',
 			url: '/api/v1/deployments/{deployment_id}/upload',
 			path: {
 				deployment_id: deploymentId
 			},
-			formData: formData,
-			mediaType: 'multipart/form-data',
 			errors: {
 				422: `Validation Error`,
 			},