feat: S3 bucket POST/GET endpoints (#27)

Co-authored-by: Ben Petrillo <benpetrillo.bp@gmail.com>

Author: sierrawelsch

backend/go.mod

@@ -3,14 +3,26 @@ module github.com/GenerateNU/platemate
 go 1.23.4
 
 require (
+	github.com/aws/aws-sdk-go-v2 v1.33.0
+	github.com/aws/aws-sdk-go-v2/credentials v1.17.54
+	github.com/aws/aws-sdk-go-v2/service/s3 v1.73.2
 	github.com/goccy/go-json v0.10.4
-	github.com/gofiber/fiber/v2 v2.52.5
+	github.com/gofiber/fiber/v2 v2.52.6
 	github.com/joho/godotenv v1.5.1
 	github.com/stretchr/testify v1.10.0
 	go.mongodb.org/mongo-driver v1.17.1
 )
 
 require (
+	github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.7 // indirect
+	github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.28 // indirect
+	github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.28 // indirect
+	github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.28 // indirect
+	github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1 // indirect
+	github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.5.2 // indirect
+	github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.9 // indirect
+	github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.9 // indirect
+	github.com/aws/smithy-go v1.22.1 // indirect
 	github.com/kr/pretty v0.3.1 // indirect
 	github.com/rogpeppe/go-internal v1.11.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
@@ -21,7 +33,7 @@ require (
 	github.com/caarlos0/env/v11 v11.3.1
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
-	github.com/google/uuid v1.6.0 // indirect
+	github.com/google/uuid v1.6.0
 	github.com/klauspost/compress v1.17.11 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect

backend/go.sum

@@ -1,14 +1,38 @@
 github.com/andybalholm/brotli v1.1.1 h1:PR2pgnyFznKEugtsUo0xLdDop5SKXd5Qf5ysW+7XdTA=
 github.com/andybalholm/brotli v1.1.1/go.mod h1:05ib4cKhjx3OQYUY22hTVd34Bc8upXjOLL2rKwwZBoA=
+github.com/aws/aws-sdk-go-v2 v1.33.0 h1:Evgm4DI9imD81V0WwD+TN4DCwjUMdc94TrduMLbgZJs=
+github.com/aws/aws-sdk-go-v2 v1.33.0/go.mod h1:P5WJBrYqqbWVaOxgH0X/FYYD47/nooaPOZPlQdmiN2U=
+github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.7 h1:lL7IfaFzngfx0ZwUGOZdsFFnQ5uLvR0hWqqhyE7Q9M8=
+github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.7/go.mod h1:QraP0UcVlQJsmHfioCrveWOC1nbiWUl3ej08h4mXWoc=
+github.com/aws/aws-sdk-go-v2/credentials v1.17.54 h1:4UmqeOqJPvdvASZWrKlhzpRahAulBfyTJQUaYy4+hEI=
+github.com/aws/aws-sdk-go-v2/credentials v1.17.54/go.mod h1:RTdfo0P0hbbTxIhmQrOsC/PquBZGabEPnCaxxKRPSnI=
+github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.28 h1:igORFSiH3bfq4lxKFkTSYDhJEUCYo6C8VKiWJjYwQuQ=
+github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.28/go.mod h1:3So8EA/aAYm36L7XIvCVwLa0s5N0P7o2b1oqnx/2R4g=
+github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.28 h1:1mOW9zAUMhTSrMDssEHS/ajx8JcAj/IcftzcmNlmVLI=
+github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.28/go.mod h1:kGlXVIWDfvt2Ox5zEaNglmq0hXPHgQFNMix33Tw22jA=
+github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.28 h1:7kpeALOUeThs2kEjlAxlADAVfxKmkYAedlpZ3kdoSJ4=
+github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.28/go.mod h1:pyaOYEdp1MJWgtXLy6q80r3DhsVdOIOZNB9hdTcJIvI=
+github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1 h1:iXtILhvDxB6kPvEXgsDhGaZCSC6LQET5ZHSdJozeI0Y=
+github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.1/go.mod h1:9nu0fVANtYiAePIBh2/pFUSwtJ402hLnp854CNoDOeE=
+github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.5.2 h1:e6um6+DWYQP1XCa+E9YVtG/9v1qk5lyAOelMOVwSyO8=
+github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.5.2/go.mod h1:dIW8puxSbYLSPv/ju0d9A3CpwXdtqvJtYKDMVmPLOWE=
+github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.9 h1:TQmKDyETFGiXVhZfQ/I0cCFziqqX58pi4tKJGYGFSz0=
+github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.9/go.mod h1:HVLPK2iHQBUx7HfZeOQSEu3v2ubZaAY2YPbAm5/WUyY=
+github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.9 h1:2aInXbh02XsbO0KobPGMNXyv2QP73VDKsWPNJARj/+4=
+github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.9/go.mod h1:dgXS1i+HgWnYkPXqNoPIPKeUsUUYHaUbThC90aDnNiE=
+github.com/aws/aws-sdk-go-v2/service/s3 v1.73.2 h1:F3h8VYq9ZLBXYurmwrT8W0SPhgCcU0q+0WZJfT1dFt0=
+github.com/aws/aws-sdk-go-v2/service/s3 v1.73.2/go.mod h1:jGJ/v7FIi7Ys9t54tmEFnrxuaWeJLpwNgKp2DXAVhOU=
+github.com/aws/smithy-go v1.22.1 h1:/HPHZQ0g7f4eUeK6HKglFz8uwVfZKgoI25rb/J+dnro=
+github.com/aws/smithy-go v1.22.1/go.mod h1:irrKGvNn1InZwb2d7fkIRNucdfwR8R+Ts3wxYa/cJHg=
 github.com/caarlos0/env/v11 v11.3.1 h1:cArPWC15hWmEt+gWk7YBi7lEXTXCvpaSdCiZE2X5mCA=
 github.com/caarlos0/env/v11 v11.3.1/go.mod h1:qupehSf/Y0TUTsxKywqRt/vJjN5nz6vauiYEUUr8P4U=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/goccy/go-json v0.10.4 h1:JSwxQzIqKfmFX1swYPpUThQZp/Ka4wzJdK0LWVytLPM=
 github.com/goccy/go-json v0.10.4/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
-github.com/gofiber/fiber/v2 v2.52.5 h1:tWoP1MJQjGEe4GB5TUGOi7P2E0ZMMRx5ZTG4rT+yGMo=
-github.com/gofiber/fiber/v2 v2.52.5/go.mod h1:KEOE+cXMhXG0zHc9d8+E38hoX+ZN7bhOtgeF2oT6jrQ=
+github.com/gofiber/fiber/v2 v2.52.6 h1:Rfp+ILPiYSvvVuIPvxrBns+HJp8qGLDnLJawAu27XVI=
+github.com/gofiber/fiber/v2 v2.52.6/go.mod h1:YEcBbO/FB+5M1IZNBP9FO3J9281zgPAreiI1oqg8nDw=
 github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM=
 github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=

backend/internal/config/aws.go

@@ -0,0 +1,8 @@
+package config
+
+type AWS struct {
+	BucketName      string `env:"BUCKET_NAME"`
+	Region          string `env:"REGION"`
+	AccessKeyID     string `env:"ACCESS_KEY_ID"`
+	SecretAccessKey string `env:"SECRET_ACCESS_KEY"`
+}

backend/internal/config/config.go

@@ -5,6 +5,7 @@ import "github.com/caarlos0/env/v11"
 type Config struct {
 	App   `envPrefix:"APP_"`
 	Atlas `envPrefix:"ATLAS_"`
+	AWS   `envPrefix:"AWS_"`
 }
 
 func Load() (Config, error) {

backend/internal/handlers/health/health.go

@@ -16,6 +16,7 @@ func (h *Handler) GetHealth(c *fiber.Ctx) error {
 }
 
 func (h *Handler) Ping(c *fiber.Ctx) error {
+	// access query params with c
 	err := h.service.InsertDocumentToHealth()
 	if err != nil {
 		return err

backend/internal/handlers/s3bucket/routes.go

@@ -0,0 +1,36 @@
+package s3bucket
+
+import (
+	"github.com/GenerateNU/platemate/internal/config"
+	"github.com/aws/aws-sdk-go-v2/service/s3"
+	"github.com/gofiber/fiber/v2"
+	"log"
+)
+
+type Service struct {
+	Presigner *s3.PresignClient
+}
+
+func newService(presigner *s3.PresignClient) *Service {
+	return &Service{
+		Presigner: presigner,
+	}
+}
+
+func Routes(app *fiber.App, presigner *s3.PresignClient) {
+	cfg, err := config.Load()
+	if err != nil {
+		log.Fatalf("Failed to load configuration: %v", err)
+	}
+
+	service := newService(presigner)
+	handler := &Handler{
+		service: service,
+		config:  cfg,
+	}
+
+	assets := app.Group("/api/v1/assets")
+
+	assets.Get("/:key/url", handler.GetPresignedUrlHandler)
+	assets.Post("/upload", handler.PostPresignedUrlHandler)
+}

backend/internal/handlers/s3bucket/s3bucket.go

@@ -0,0 +1,78 @@
+package s3bucket
+
+import (
+	"encoding/json"
+	"fmt"
+	"github.com/GenerateNU/platemate/internal/config"
+	"github.com/gofiber/fiber/v2"
+)
+
+type GetParams struct {
+	Bucket string
+	Key    string
+}
+
+type PostParams struct {
+	Bucket   string
+	Filetype string
+}
+
+type Handler struct {
+	service *Service
+	config  config.Config
+}
+
+func (h *Handler) GetPresignedUrlHandler(c *fiber.Ctx) error {
+	key := c.Params("key")
+
+	// get the name of the bucket
+	bucketName := h.config.AWS.BucketName
+	if bucketName == "" {
+		return fmt.Errorf("S3_BUCKET environment variable is not set")
+	}
+
+	object := &GetParams{
+		Bucket: bucketName,
+		Key:    key,
+	}
+	url, err := h.service.GetPresignedUrl(object)
+	if err != nil {
+		return err
+	}
+	jsonData, err := json.MarshalIndent(url, "", " ")
+	if err != nil {
+		return err
+	}
+	c.Set("Content-Type", "application/json")
+	return c.Send(jsonData)
+}
+
+func (h *Handler) PostPresignedUrlHandler(c *fiber.Ctx) error {
+	fileType := c.Query("fileType")
+	if fileType == "" {
+		return c.Status(fiber.StatusBadRequest).JSON(fiber.Map{
+			"error": "fileType query parameter is required",
+		})
+	}
+
+	bucketName := h.config.AWS.BucketName
+	if bucketName == "" {
+		return fmt.Errorf("S3_BUCKET environment variable is not set")
+	}
+
+	object := &PostParams{
+		Bucket:   bucketName,
+		Filetype: fileType,
+	}
+
+	urlAndKey, err := h.service.CreateUrlAndKey(object)
+	if err != nil {
+		return err
+	}
+	jsonData, err := json.MarshalIndent(urlAndKey, "", " ")
+	if err != nil {
+		return err
+	}
+	c.Set("Content-Type", "application/json")
+	return c.Send(jsonData)
+}

backend/internal/handlers/s3bucket/service.go

@@ -0,0 +1,51 @@
+package s3bucket
+
+import (
+	"context"
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/service/s3"
+	"github.com/google/uuid"
+)
+
+type DownloadUrl struct {
+	URL string `json:"download_url"`
+}
+
+type UploadUrl struct {
+	URL string `json:"upload_url"`
+	Key string `json:"key"`
+}
+
+func (s *Service) GetPresignedUrl(inputs *GetParams) (*DownloadUrl, error) {
+	// generate a presigned URL
+	req, err := s.Presigner.PresignGetObject(context.Background(), &s3.GetObjectInput{
+		Bucket: aws.String(inputs.Bucket),
+		Key:    aws.String(inputs.Key),
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return &DownloadUrl{
+		URL: req.URL,
+	}, nil
+}
+
+func (s *Service) CreateUrlAndKey(inputs *PostParams) (*UploadUrl, error) {
+	// generate uuid
+	fileUUID := uuid.New().String()
+	fileKey := fileUUID + "." + inputs.Filetype
+
+	req, err := s.Presigner.PresignPutObject(context.Background(), &s3.PutObjectInput{
+		Bucket: aws.String(inputs.Bucket),
+		Key:    aws.String(fileKey),
+	})
+	if err != nil {
+		return nil, err
+	}
+	urlAndKey := &UploadUrl{
+		URL: req.URL,
+		Key: fileKey,
+	}
+	return urlAndKey, nil
+}

backend/internal/server/server.go

@@ -1,9 +1,14 @@
 package server
 
 import (
+	"github.com/GenerateNU/platemate/internal/config"
 	"github.com/GenerateNU/platemate/internal/handlers/health"
 	"github.com/GenerateNU/platemate/internal/handlers/menu_items"
+	"github.com/GenerateNU/platemate/internal/handlers/s3bucket"
 	"github.com/GenerateNU/platemate/internal/xerr"
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/credentials"
+	"github.com/aws/aws-sdk-go-v2/service/s3"
 	gojson "github.com/goccy/go-json"
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/compress"
@@ -13,12 +18,36 @@ import (
 	"github.com/gofiber/fiber/v2/middleware/recover"
 	"github.com/gofiber/fiber/v2/middleware/requestid"
 	"go.mongodb.org/mongo-driver/mongo"
+	"log"
 )
 
 func New(collections map[string]*mongo.Collection) *fiber.App {
+	cfg, err := config.Load()
+	if err != nil {
+		log.Fatalf("Failed to load configuration: %v", err)
+	}
+
 	app := setupApp()
 
+	awsConfig := aws.Config{
+		Region: cfg.AWS.Region,
+		Credentials: credentials.NewStaticCredentialsProvider(
+			cfg.AWS.AccessKeyID,
+			cfg.AWS.SecretAccessKey,
+			"",
+		),
+	}
+	if err != nil {
+		log.Fatalf("Failed to load AWS config: %v", err)
+	}
+
+	// create a S3 presign client
+	s3Client := s3.NewFromConfig(awsConfig)
+	presigner := s3.NewPresignClient(s3Client)
+
 	health.Routes(app, collections)
+	s3bucket.Routes(app, presigner)
+
 	menu_items.Routes(app, collections)
 	return app
 }

go.mod

@@ -0,0 +1,3 @@
+module platemate
+
+go 1.23.4