feat: refactor (#7)

Co-authored-by: Abhik Ray <abhikaboy@gmail.com>

Author: garrettladley

backend/.golangci.yml

@@ -0,0 +1,28 @@
+linters-settings:
+  # from https://betterstack.com/community/guides/logging/logging-in-go/#best-practices-for-writing-and-storing-go-logs
+  sloglint:
+    # Enforce not mixing key-value pairs and attributes.
+    # Default: true
+    no-mixed-args: false
+    # Enforce using key-value pairs only (overrides no-mixed-args, incompatible with attr-only).
+    # Default: false
+    kv-only: true
+    # Enforce using attributes only (overrides no-mixed-args, incompatible with kv-only).
+    # Default: false
+    attr-only: true
+    # Enforce using methods that accept a context.
+    # Default: ""
+    context: all
+    # Enforce using static values for log messages.
+    # Default: false
+    static-msg: true
+    # Enforce using constants instead of raw keys.
+    # Default: false
+    no-raw-keys: true
+    # Enforce a single key naming convention.
+    # Values: snake, kebab, camel, pascal
+    # Default: ""
+    key-naming-case: snake
+    # Enforce putting arguments on separate lines.
+    # Default: false
+    args-on-sep-lines: true

backend/cmd/db/example/main.go

@@ -0,0 +1,55 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"log/slog"
+	"os"
+
+	"github.com/GenerateNU/platemate/internal/config"
+	"github.com/GenerateNU/platemate/internal/storage/mongo"
+	"github.com/GenerateNU/platemate/internal/xslog"
+	"github.com/joho/godotenv"
+)
+
+/*
+Adds two example fields to the collection passed via
+the collection flag.
+Example usage: go run cmd/db/example/main.go -collection=collectionName
+Applies empty strings as default values
+*/
+func main() {
+	ctx := context.Background()
+	collection := flag.String("collection", "users", "collection to add example fields to")
+	flag.Parse()
+	if *collection == "" {
+		fatal(ctx, "collection flag is required", nil)
+	}
+
+	if err := godotenv.Load(); err != nil {
+		fatal(ctx, "Failed to load .env", err)
+	}
+	config, err := config.Load()
+	if err != nil {
+		fatal(ctx, "Failed to load config", err)
+	}
+
+	db, err := mongo.New(ctx, config.Atlas)
+	if err != nil {
+		fatal(ctx, "Failed to connect to MongoDB", err)
+	}
+
+	if err := db.CreateExampleFields(ctx, *collection); err != nil {
+		fatal(ctx, "Failed to add example fields", err)
+	}
+}
+
+func fatal(ctx context.Context, msg string, err error) {
+	slog.LogAttrs(
+		ctx,
+		slog.LevelError,
+		msg,
+		xslog.Error(err),
+	)
+	os.Exit(1)
+}

backend/cmd/server/main.go

@@ -0,0 +1,107 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"io"
+	"log/slog"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/GenerateNU/platemate/internal/config"
+	"github.com/GenerateNU/platemate/internal/server"
+	"github.com/GenerateNU/platemate/internal/storage/mongo"
+	"github.com/GenerateNU/platemate/internal/xslog"
+	"github.com/joho/godotenv"
+)
+
+func main() {
+	run(os.Stderr, os.Args[1:])
+}
+
+func run(stderr io.Writer, args []string) {
+	cmd := flag.NewFlagSet("", flag.ExitOnError)
+	verboseFlag := cmd.Bool("v", false, "")
+	logLevelFlag := cmd.String("log-level", slog.LevelDebug.String(), "")
+	if err := cmd.Parse(args); err != nil {
+		fmt.Fprint(stderr, err)
+		os.Exit(1)
+	}
+	logger := newLogger(*logLevelFlag, *verboseFlag, stderr)
+	slog.SetDefault(logger)
+
+	ctx := context.Background()
+
+	if err := godotenv.Load(); err != nil {
+		fatal(ctx, "Failed to load .env", err)
+	}
+	
+	config, err := config.Load()
+	if err != nil {
+		fatal(ctx, "Failed to load config", err)
+	}
+
+	db, err := mongo.New(ctx, config.Atlas)
+	if err != nil {
+		fatal(ctx, "Failed to connect to MongoDB", err)
+	}
+
+	app := server.New(db.Collections)
+
+	go func() {
+		if err := app.Listen(":" + config.App.Port); err != nil {
+			fatal(ctx, "Failed to start server", err)
+		}
+	}()
+
+	quit := make(chan os.Signal, 1)
+	signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
+
+	<-quit
+	slog.LogAttrs(
+		ctx,
+		slog.LevelInfo,
+		"Stopping server",
+	)
+
+	if err := app.Shutdown(); err != nil {
+		fatal(ctx, "Failed to shutdown server", err)
+	}
+
+	slog.LogAttrs(
+		ctx,
+		slog.LevelInfo,
+		"Server shutdown",
+	)
+}
+
+func newLogger(logLevel string, verbose bool, stderr io.Writer) *slog.Logger {
+	if verbose {
+		logLevel = "debug"
+	}
+	level := slog.LevelInfo.Level()
+	switch logLevel {
+	case "debug":
+		level = slog.LevelDebug.Level()
+	case "warn":
+		level = slog.LevelWarn.Level()
+	case "error":
+		level = slog.LevelError.Level()
+	}
+	return slog.New(slog.NewJSONHandler(stderr, &slog.HandlerOptions{
+		AddSource: logLevel == "debug",
+		Level:     level,
+	}))
+}
+
+func fatal(ctx context.Context, msg string, err error) {
+	slog.LogAttrs(
+		ctx,
+		slog.LevelError,
+		msg,
+		xslog.Error(err),
+	)
+	os.Exit(1)
+}

backend/cmd/server/main_test.go

@@ -0,0 +1,92 @@
+package main
+
+import (
+	"context"
+	"io"
+	"net/http"
+	"path/filepath"
+	"testing"
+
+	"github.com/GenerateNU/platemate/internal/config"
+	"github.com/GenerateNU/platemate/internal/server"
+	"github.com/GenerateNU/platemate/internal/storage/mongo"
+	"github.com/gofiber/fiber/v2"
+	"github.com/joho/godotenv"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestIndexRoute(t *testing.T) {
+	t.Parallel()
+	tests := []struct {
+		name          string
+		desc          string
+		route         string
+		expectedError bool
+		expectedCode  int
+		expectedBody  string
+	}{
+		{
+			name:          "index",
+			desc:          "test index route",
+			route:         "/",
+			expectedError: false,
+			expectedCode:  200,
+			expectedBody:  "Welcome to PlateMate!",
+		},
+	}
+
+	app := setup(t)
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			req, err := http.NewRequest(
+				http.MethodGet,
+				tt.route,
+				nil,
+			)
+			assert.NoErrorf(t, err, tt.desc)
+
+			// Perform the request plain with the app. The -1 disables request latency.
+			res, err := app.Test(req, -1)
+			if !tt.expectedError {
+				assert.NoErrorf(t, err, tt.desc)
+			}
+
+			// As expected errors lead to broken responses, the next test case needs to be processed.
+			if tt.expectedError {
+				return
+			}
+
+			assert.Equalf(t, tt.expectedCode, res.StatusCode, tt.desc)
+
+			body, err := io.ReadAll(res.Body)
+			assert.NoErrorf(t, err, tt.desc)
+			assert.Equalf(t, tt.expectedBody, string(body), tt.desc)
+		})
+	}
+
+	t.Cleanup(func() {
+		if err := app.Shutdown(); err != nil {
+			t.Fatalf("Failed to shutdown server: %v", err)
+		}
+	})
+}
+
+func setup(t *testing.T) *fiber.App {
+	t.Helper()
+	if err := godotenv.Load(filepath.Join("..", "..", ".env")); err != nil {
+		t.Fatal("Failed to load .env")
+	}
+	cfg := config.Atlas{
+		User:        "test",
+		Pass:        "platemate-test-pw",
+		Cluster:     "Development",
+		Environment: "Test",
+	}
+	db, err := mongo.New(context.Background(), cfg)
+	if err != nil {
+		t.Fatalf("Failed to connect to MongoDB: %v", err)
+	}
+	return server.New(db.Collections)
+}

backend/errs/http.go

@@ -12,6 +12,7 @@ require (
 
 require (
 	github.com/andybalholm/brotli v1.1.1 // indirect
+	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
@@ -30,7 +31,7 @@ require (
 	github.com/xdg-go/stringprep v1.0.4 // indirect
 	github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 // indirect
 	golang.org/x/crypto v0.29.0 // indirect
-	golang.org/x/sync v0.9.0 // indirect
+	golang.org/x/sync v0.9.0
 	golang.org/x/sys v0.28.0 // indirect
 	golang.org/x/text v0.20.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

backend/go.mod

@@ -1,5 +1,7 @@
 github.com/andybalholm/brotli v1.1.1 h1:PR2pgnyFznKEugtsUo0xLdDop5SKXd5Qf5ysW+7XdTA=
 github.com/andybalholm/brotli v1.1.1/go.mod h1:05ib4cKhjx3OQYUY22hTVd34Bc8upXjOLL2rKwwZBoA=
+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/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=

backend/go.sum

@@ -0,0 +1,5 @@
+package config
+
+type App struct {
+	Port string `env:"PORT" envDefault:"8080"`
+}

backend/internal/config/app.go

@@ -0,0 +1,16 @@
+package config
+
+import "fmt"
+
+type Atlas struct {
+	User        string `env:"USER"`
+	Pass        string `env:"PASS"`
+	Cluster     string `env:"CLUSTER"`
+	Environment string `env:"ENVIRONMENT"`
+}
+
+const placeholderURI string = "mongodb+srv://%s:%s@development.t8bgq.mongodb.net/?retryWrites=true&w=majority&appName=%s"
+
+func (a *Atlas) URI() string {
+	return fmt.Sprintf(placeholderURI, a.User, a.Pass, a.Cluster)
+}

backend/internal/config/atlas.go

@@ -0,0 +1,12 @@
+package config
+
+import "github.com/caarlos0/env/v11"
+
+type Config struct {
+	App   `envPrefix:"APP_"`
+	Atlas `envPrefix:"ATLAS_"`
+}
+
+func Load() (Config, error) {
+	return env.ParseAs[Config]()
+}