feat: database utility scripts (#17)

Author: abhikaboy

backend/cmd/db/apply_schema/main.go

@@ -0,0 +1,58 @@
+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()
+	name := flag.String("coll", "users", "name of the collection to apply schema to")
+
+	flag.Parse()
+	if *name == "" {
+		fatal(ctx, "name 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 in main", err)
+	}
+
+	if err := db.ApplySchema(ctx, *name); err != nil {
+		fatal(ctx, "Failed to apply schema", err)
+	} else {
+		slog.LogAttrs(ctx, slog.LevelInfo, "Schema applied to", slog.String("collection", *name), slog.String("Environment", db.DB.Name()))
+	}
+}
+
+func fatal(ctx context.Context, msg string, err error) {
+	slog.LogAttrs(
+		ctx,
+		slog.LevelError,
+		msg,
+		xslog.Error(err),
+	)
+	os.Exit(1)
+}

backend/cmd/db/apply_schema/script.sh

@@ -0,0 +1,2 @@
+read -p "Enter Collection Name: " name
+go run cmd/db/apply_schema/main.go -coll $name

backend/cmd/db/clone_prod/main.go

@@ -0,0 +1,58 @@
+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()
+	name := flag.String("name", "users", "name of the new copy of production")
+
+	flag.Parse()
+	if *name == "" {
+		fatal(ctx, "name 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)
+	}
+
+	config.Atlas.Environment = "Production"
+
+	db, err := mongo.New(ctx, config.Atlas)
+	if err != nil {
+		fatal(ctx, "Failed to connect to MongoDB in main", err)
+	}
+
+	if err := db.Clone(ctx, db.Collections, *name, 200); 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/db/clone_prod/script.sh

@@ -0,0 +1,2 @@
+read -p "Enter New Environment Name: " name
+go run cmd/db/clone_prod/main.go -name $name

backend/cmd/db/example/main.go backend/cmd/db/script/main.gobackend/cmd/db/example/main.go renamed to backend/cmd/db/script/main.go

@@ -39,8 +39,10 @@ func main() {
 		fatal(ctx, "Failed to connect to MongoDB", err)
 	}
 
-	if err := db.CreateExampleFields(ctx, *collection); err != nil {
-		fatal(ctx, "Failed to add example fields", err)
+	if err := db.CreateCollection(ctx, "users"); err != nil {
+		fatal(ctx, "Failed to create collection", err)
+	} else {
+		slog.LogAttrs(ctx, slog.LevelInfo, "Collection created", slog.String("Collection", "users"), slog.String("Environment", db.DB.Name()))
 	}
 }
 

backend/internal/storage/mongo/bulk.go

@@ -3,6 +3,7 @@ package mongo
 import (
 	"context"
 	"fmt"
+	"log/slog"
 	"slices"
 
 	"go.mongodb.org/mongo-driver/bson"
@@ -13,6 +14,12 @@ Perform a collection operation across all environments
   - Do not preform unless given approval from a Tech Lead
 */
 func (db *DB) BulkOperation(ctx context.Context, operation CollectionOperation, arg string) error {
+	slog.LogAttrs(
+		ctx,
+		slog.LevelInfo,
+		"Performing bulk operation",
+		slog.String("arg", arg),
+	)
 	databaseNames, err := db.Client.ListDatabaseNames(ctx, bson.D{})
 	databaseNames = filterSystemDatabases(databaseNames)
 
@@ -22,13 +29,20 @@ func (db *DB) BulkOperation(ctx context.Context, operation CollectionOperation,
 	for _, name := range databaseNames {
 		if err := operation(ctx, arg); err != nil {
 			return fmt.Errorf("failed to perform operation on %s: %w", name, err)
+		} else {
+			slog.LogAttrs(
+				ctx,
+				slog.LevelInfo,
+				"Successfully performed operation on database",
+				slog.String("database_name", name),
+			)
 		}
 	}
 	return nil
 }
 
 func filterSystemDatabases(databases []string) []string { 
-	systemNames := []string{"local","admin"}
+systemNames := []string{"local","admin","encryption", "config"}
 	ret := make([]string,0);
 	for _, v := range databases {
 		if !slices.Contains(systemNames,v){

nix_modules/devenv.nix

@@ -64,7 +64,21 @@
               cd "$DEVENV_ROOT"/backend
               ${pkgs.gum}/bin/gum spin --spinner dot --title "go mod tidy" -- go mod tidy
               ${pkgs.rubyPackages.dotenv}/bin/dotenv -i -f ""$DEVENV_ROOT"/.env" -- \
-              go run cmd/db/example/main.go
+              go run cmd/db/script/main.go
+            '';
+          };
+          "database-clone" = {
+            description = "Clone the production database for testing";
+            exec = ''
+              cd "$DEVENV_ROOT"/backend
+              sh ./cmd/db/clone_prod/script.sh
+            '';
+          };
+          "database-apply-schema" = {
+            description = "Apply a schema to a given collection";
+            exec = ''
+              cd "$DEVENV_ROOT"/backend
+              sh ./cmd/db/apply_schema/script.sh
             '';
           };
           "frontend-lint" = {