Implement backup and restore

.github/copilot/new-api-endpoint.prompt.md → .agents/skills/new-api-endpoint/SKILL.md

@@ -1,3 +1,8 @@
+---
+name: new-api-endpoint
+description: Guide for adding new API endpoints in GOMP. Use this when asked to create or update API endpoints.
+---
+
 # New API Endpoint Checklist
 
 Use this checklist when adding a new API endpoint to GOMP.

.github/copilot/new-db-migration.prompt.md → .agents/skills/new-db-migration/SKILL.md

@@ -1,3 +1,8 @@
+---
+name: new-db-migration
+description: Guide for creating new database migrations in GOMP. Use this when asked to add or update database schema.
+---
+
 # New DB Migration Checklist
 
 Use this checklist when making schema changes.

.github/copilot/writing-tests.prompt.md → .agents/skills/writing-tests/SKILL.md

@@ -1,10 +1,17 @@
+---
+name: writing-tests
+description: Guide for writing tests in GOMP. Use this when asked to create or run tests.
+---
+
 # Writing Tests in GOMP
 
+**ALWAYS use this skill when asked to write or add tests.**
+
 Use this guide for consistent tests across API, DB, and middleware layers.
 
 ## Core Patterns
-- Prefer table-driven tests for input/output coverage.
-- Keep tests in package-local `*_test.go` files near the implementation.
+- For Go, **always** use table-driven tests when testing multiple input/output scenarios.
+- For Go, Keep tests in package-local `*_test.go` files near the implementation.
 - Focus on behavior and contract verification over implementation detail.
 
 ## API Layer Tests (`api/`)

Makefile

@@ -27,7 +27,7 @@ CLIENT_CODEGEN_DIR:=static/src/generated
 MODELS_CODEGEN_FILE:=models/models.gen.go
 API_CODEGEN_FILE:=api/routes.gen.go
 MOCKS_CODEGEN_DIR:=mocks
-CODEGEN_FILES=$(API_CODEGEN_FILE) $(MODELS_CODEGEN_FILE) $(MOCKS_CODEGEN_DIR)/db/mocks.gen.go $(MOCKS_CODEGEN_DIR)/upload/mocks.gen.go
+CODEGEN_FILES=$(API_CODEGEN_FILE) $(MODELS_CODEGEN_FILE) $(MOCKS_CODEGEN_DIR)/db/mocks.gen.go $(MOCKS_CODEGEN_DIR)/fileaccess/mocks.gen.go
 
 # Source files
 GO_FILES:=$(shell find . -type f -name "*.go" ! -name "*.gen.go")
@@ -87,7 +87,7 @@ lint-client: $(CLIENT_INSTALL_DIR) $(CLIENT_CODEGEN_DIR)
 lint-server: $(CODEGEN_FILES)
 	mkdir -p $(ROOT_BUILD_DIR)
 	go vet ./...
-	go tool revive -config=revive.toml ./... > $(ROOT_BUILD_DIR)/revive.golint
+	go tool revive -exclude static/... -config=revive.toml ./... > $(ROOT_BUILD_DIR)/revive.golint
 	go tool gosec -no-fail -fmt=sonarqube -out=$(ROOT_BUILD_DIR)/gosec.json -stdout ./...
 
 

README.md

@@ -133,27 +133,27 @@ spec:
 The following table summarizes the available configuration settings, which are settable through environment variables.
 Unless otherwise specified, for settings that are arrays, multiple values should be separated by commas.
 
-ENV                     |Value(s)        |Default                                  |Description
-------------------------|----------------|-----------------------------------------|------------
-BASE_ASSETS_PATH        |string          |static                                   |The base path to the client assets.
-DATABASE_DRIVER         |postgres, sqlite|<empty>                            |Which database/sql driver to use. If blank, the app will attempt to infer it based on the value of DATABASE_URL.
-DATABASE_URL            |string          |file:data/data.db?_pragma=foreign_keys(1)|The url (path, connection string, etc) to use with the associated database driver when opening the database connection.
-IS_DEVELOPMENT          |0, 1            |0                                        |Defines whether to run the application in "development mode". Development mode turns on additional features, such as logging, that may not be desirable in a production environment.
-MIGRATIONS_FORCE_VERSION|int             |-1                                       |A version to force the migrations to on startup (will not run any of the migrations themselves). Set to a negative number to skip forcing a version.
-MIGRATIONS_TABLE_NAME   |string          |&lt;empty&gt;                            |The name of the database migrations table to use. Leave blank to use the default from <https://github.com/golang-migrate/migrate.>
-PORT                    |uint            |5000                                     |The port number under which the site is being hosted.
-SECURE_KEY              |[]string        |ChangeMe                                 |Used for session authentication. Recommended to be 32 or 64 ASCII characters.
-TRUSTED_PROXIES         |[]string        |&lt;empty&gt;                            |List of IP addresses or CIDR ranges that are considered trusted proxies. When determining the client IP address, if the request comes from a trusted proxy, the `X-Forwarded-For` header will be used to determine the original client IP.
-UPLOAD_PATH             |string          |data/uploads                             |The path (full or relative) under which to store uploads.
-IMAGE_QUALITY           |original, high, medium, low|original                      |The quality level for recipe images. Original quality falls back to High if the uploaded image is not a JPEG. JPEG Qualities: High == 92, Medium == 80, Low == 70. Resizing Algorithm: High = CatmullRom, Medium = BiLinear, Low = NearestNeighbor.
-IMAGE_SIZE              |uint            |2000                                     |The size of the bounding box to fit recipe images to. Ignored if IMAGE_QUALITY == original.
-THUMBNAIL_QUALITY       |high, medium, low|medium                                  |The quality level for the thumbnails of recipe images. JPEG Qualities: High == 92, Medium == 80, Low == 70. Low also uses the Nearest Neighbor instead of the Box resizing algorithm.
-THUMBNAIL_SIZE          |uint            |500                                      |The size of the bounding box to fit the thumbnails of recipe images to.
+ENV                     |Value(s)                   |Default                                  |Description
+------------------------|---------------------------|-----------------------------------------|------------
+BASE_ASSETS_PATH        |string                     |static                                   |The base path to the client assets.
+DATABASE_DRIVER         |postgres, sqlite           |&lt;empty&gt;                            |Which database/sql driver to use. If blank, the app will attempt to infer it based on the value of DATABASE_URL.
+DATABASE_URL            |string                     |file:data/data.db?_pragma=foreign_keys(1)|The url (path, connection string, etc) to use with the associated database driver when opening the database connection.
+IS_DEVELOPMENT          |0, 1                       |0                                        |Defines whether to run the application in "development mode". Development mode turns on additional features, such as logging, that may not be desirable in a production environment.
+MIGRATIONS_FORCE_VERSION|int                        |-1                                       |A version to force the migrations to on startup (will not run any of the migrations themselves). Set to a negative number to skip forcing a version.
+MIGRATIONS_TABLE_NAME   |string                     |&lt;empty&gt;                            |The name of the database migrations table to use. Leave blank to use the default from <https://github.com/golang-migrate/migrate.>
+PORT                    |uint                       |5000                                     |The port number under which the site is being hosted.
+SECURE_KEY              |[]string                   |ChangeMe                                 |Used for session authentication. Recommended to be 32 or 64 ASCII characters.
+TRUSTED_PROXIES         |[]string                   |&lt;empty&gt;                            |List of IP addresses or CIDR ranges that are considered trusted proxies. When determining the client IP address, if the request comes from a trusted proxy, the `X-Forwarded-For` header will be used to determine the original client IP.
+FILES_PATH              |string                     |data                                     |The path (full or relative) under which to store file data.
+IMAGE_QUALITY           |original, high, medium, low|original                                 |The quality level for recipe images. Original quality falls back to High if the uploaded image is not a JPEG. JPEG Qualities: High == 92, Medium == 80, Low == 70. Resizing Algorithm: High = CatmullRom, Medium = BiLinear, Low = NearestNeighbor.
+IMAGE_SIZE              |uint                       |2000                                     |The size of the bounding box to fit recipe images to. Ignored if IMAGE_QUALITY == original.
+THUMBNAIL_QUALITY       |high, medium, low          |medium                                   |The quality level for the thumbnails of recipe images. JPEG Qualities: High == 92, Medium == 80, Low == 70. Low also uses the Nearest Neighbor instead of the Box resizing algorithm.
+THUMBNAIL_SIZE          |uint                       |500                                      |The size of the bounding box to fit the thumbnails of recipe images to.
 
 All environment variables can also be prefixed with "GOMP_" (e.g., GOMP_IS_DEVELOPMENT=1) in cases where there is a need to avoid collisions with other applications.
 The name with "GOMP_" is prefered if both are present.
 
-For values that allow releative paths (e.g., BASE_ASSETS_PATH, DATABASE_URL for SQLite, and UPLOAD_PATH for the fs driver), they are always relative to the application working directory.
+For values that allow releative paths (e.g., BASE_ASSETS_PATH, DATABASE_URL for SQLite, and FILES_PATH), they are always relative to the application working directory.
 When using docker, this is "/var/app/gomp", so anything at or below the "data/" relative path is in the exposed "/var/app/gomp/data" volume.
 
 ## Database Support

api/api.go

@@ -8,12 +8,11 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"log/slog"
 	"net/http"
 
 	"github.com/chadweimer/gomp/db"
-	"github.com/chadweimer/gomp/middleware"
-	"github.com/chadweimer/gomp/upload"
+	"github.com/chadweimer/gomp/fileaccess"
+	"github.com/chadweimer/gomp/infra"
 )
 
 // ---- Begin Standard Errors ----
@@ -24,26 +23,22 @@ var errMismatchedID = errors.New("id in the path does not match the one specifie
 
 // ---- Begin Context Keys ----
 
-type contextKey string
-
-func (k contextKey) String() string {
-	return "gomp context key: " + string(k)
-}
-
-const currentUserIDCtxKey = contextKey("current-user-id")
+const currentUserIDCtxKey = infra.ContextKey("current-user-id")
 
 // ---- End Context Keys ----
 
 type apiHandler struct {
 	secureKeys []string
-	upl        *upload.ImageUploader
+	fs         fileaccess.Driver
+	upl        *fileaccess.ImageUploader
 	db         db.Driver
 }
 
 // NewHandler returns a new instance of http.Handler
-func NewHandler(secureKeys []string, upl *upload.ImageUploader, drDriver db.Driver) http.Handler {
+func NewHandler(secureKeys []string, upl *fileaccess.ImageUploader, drDriver db.Driver, fs fileaccess.Driver) http.Handler {
 	h := apiHandler{
 		secureKeys: secureKeys,
+		fs:         fs,
 		upl:        upl,
 		db:         drDriver,
 	}
@@ -68,14 +63,10 @@ func NewHandler(secureKeys []string, upl *upload.ImageUploader, drDriver db.Driv
 		})
 }
 
-func logger(ctx context.Context) *slog.Logger {
-	return middleware.GetLoggerFromContext(ctx)
-}
-
 func writeJSONResponse(w http.ResponseWriter, r *http.Request, status int, v any) {
 	buf := new(bytes.Buffer)
 	if err := json.NewEncoder(buf).Encode(v); err != nil {
-		logger(r.Context()).
+		infra.GetLoggerFromContext(r.Context()).
 			Error("Failed to encode response",
 				"error", err,
 				"original-status", status)
@@ -92,12 +83,12 @@ func writeJSONResponse(w http.ResponseWriter, r *http.Request, status int, v any
 }
 
 func writeErrorResponse(w http.ResponseWriter, r *http.Request, status int, err error) {
-	logger(r.Context()).Error("failure on request", "error", err)
+	infra.GetLoggerFromContext(r.Context()).Error("failure on request", "error", err)
 	status = getStatusFromError(err, status)
 	writeJSONResponse(w, r, status, http.StatusText(status))
 }
 
-func getResourceIDFromCtx(ctx context.Context, idKey contextKey) (int64, error) {
+func getResourceIDFromCtx(ctx context.Context, idKey infra.ContextKey) (int64, error) {
 	idVal := ctx.Value(idKey)
 
 	id, ok := idVal.(int64)

api/api_test.go

@@ -11,6 +11,7 @@ import (
 	"testing"
 
 	"github.com/chadweimer/gomp/db"
+	"github.com/chadweimer/gomp/infra"
 )
 
 func Test_getStatusFromError(t *testing.T) {
@@ -56,16 +57,16 @@ func Test_getStatusFromError(t *testing.T) {
 
 func Test_getResourceIDFromCtx(t *testing.T) {
 	type getResourceIDFromCtxTest struct {
-		key    contextKey
+		key    infra.ContextKey
 		val    int64
 		usePtr bool
 	}
 
 	// Arrange
 	tests := []getResourceIDFromCtxTest{
-		{contextKey("the-item"), 10, false},
-		{contextKey("the-item"), 10, true},
-		{contextKey("the-item"), -1, false},
+		{infra.ContextKey("the-item"), 10, false},
+		{infra.ContextKey("the-item"), 10, true},
+		{infra.ContextKey("the-item"), -1, false},
 	}
 
 	for i, test := range tests {

api/app.go

@@ -9,8 +9,8 @@ import (
 
 func (apiHandler) GetInfo(_ context.Context, _ GetInfoRequestObject) (GetInfoResponseObject, error) {
 	return GetInfo200JSONResponse{
-		Copyright: &metadata.Copyright,
-		Version:   &metadata.BuildVersion,
+		Copyright: metadata.Copyright,
+		Version:   metadata.BuildVersion,
 	}, nil
 }
 

api/app_test.go

@@ -4,11 +4,11 @@ import (
 	"errors"
 	"testing"
 
+	"github.com/chadweimer/gomp/fileaccess"
 	"github.com/chadweimer/gomp/metadata"
 	"github.com/chadweimer/gomp/mocks/db"
-	uploadmock "github.com/chadweimer/gomp/mocks/upload"
+	fileaccessmock "github.com/chadweimer/gomp/mocks/fileaccess"
 	"github.com/chadweimer/gomp/models"
-	"github.com/chadweimer/gomp/upload"
 	"go.uber.org/mock/gomock"
 )
 
@@ -30,8 +30,8 @@ func Test_GetInfo(t *testing.T) {
 		if !ok {
 			t.Fatal("invalid response")
 		}
-		if typedResp.Version != &metadata.BuildVersion {
-			t.Errorf("unexpected version: %s", *typedResp.Version)
+		if typedResp.Version != metadata.BuildVersion {
+			t.Errorf("unexpected version: %s", typedResp.Version)
 		}
 	}
 }
@@ -106,14 +106,14 @@ func getMockAppConfigurationAPI(ctrl *gomock.Controller) (apiHandler, *db.MockAp
 	dbDriver := db.NewMockDriver(ctrl)
 	appDriver := db.NewMockAppConfigurationDriver(ctrl)
 	dbDriver.EXPECT().AppConfiguration().AnyTimes().Return(appDriver)
-	uplDriver := uploadmock.NewMockDriver(ctrl)
-	imgCfg := upload.ImageConfig{
-		ImageQuality:     upload.ImageQualityOriginal,
+	uplDriver := fileaccessmock.NewMockDriver(ctrl)
+	imgCfg := fileaccess.ImageConfig{
+		ImageQuality:     fileaccess.ImageQualityOriginal,
 		ImageSize:        2000,
-		ThumbnailQuality: upload.ImageQualityMedium,
+		ThumbnailQuality: fileaccess.ImageQualityMedium,
 		ThumbnailSize:    500,
 	}
-	upl, _ := upload.CreateImageUploader(uplDriver, imgCfg)
+	upl, _ := fileaccess.CreateImageUploader(uplDriver, imgCfg)
 
 	api := apiHandler{
 		secureKeys: []string{},

api/authentication.go

@@ -12,6 +12,7 @@ import (
 	"time"
 
 	"github.com/chadweimer/gomp/db"
+	"github.com/chadweimer/gomp/infra"
 	"github.com/chadweimer/gomp/models"
 	"github.com/golang-jwt/jwt/v4"
 	"github.com/samber/lo"
@@ -27,7 +28,7 @@ func (h apiHandler) Authenticate(ctx context.Context, request AuthenticateReques
 	credentials := request.Body
 	user, err := h.db.Users().Authenticate(ctx, credentials.Username, credentials.Password)
 	if err != nil {
-		logger(ctx).Error("failure authenticating", "error", err)
+		infra.GetLoggerFromContext(ctx).Error("failure authenticating", "error", err)
 		return Authenticate401Response{}, nil
 	}
 
@@ -43,7 +44,7 @@ func (h apiHandler) RefreshToken(ctx context.Context, _ RefreshTokenRequestObjec
 	return withCurrentUser[RefreshTokenResponseObject](ctx, RefreshToken401Response{}, func(userID int64) (RefreshTokenResponseObject, error) {
 		user, err := h.db.Users().Read(ctx, userID)
 		if err != nil {
-			logger(ctx).Error("failure refreshing token", "error", err)
+			infra.GetLoggerFromContext(ctx).Error("failure refreshing token", "error", err)
 			return RefreshToken401Response{}, nil
 		}
 
@@ -101,7 +102,7 @@ func (h apiHandler) checkScopes(next http.Handler) http.Handler {
 }
 
 func (h apiHandler) isAuthenticated(ctx context.Context, header http.Header) (*models.User, *gompClaims, error) {
-	logger := logger(ctx)
+	logger := infra.GetLoggerFromContext(ctx)
 
 	token, err := h.getAuthTokenFromRequest(header, logger)
 	if err != nil {
@@ -250,7 +251,7 @@ func getUserIDFromClaims(claims jwt.RegisteredClaims, logger *slog.Logger) (int6
 func withCurrentUser[TResponse any](ctx context.Context, invalidUserResponse TResponse, do func(userID int64) (TResponse, error)) (TResponse, error) {
 	userID, err := getResourceIDFromCtx(ctx, currentUserIDCtxKey)
 	if err != nil {
-		logger(ctx).Error("failed to get current user from request context", "error", err)
+		infra.GetLoggerFromContext(ctx).Error("failed to get current user from request context", "error", err)
 		return invalidUserResponse, nil
 	}