refactor: add AppError helpers and harden upload/download error handling

- refactor: replace inline AppError literals with model.New*Error
  constructors in service and handler layers
- feat: PromoteStaged falls back to copy/delete when os.Rename returns
  EXDEV (cross-device link)
- fix: upload error messages no longer leak internal multipart field
  names or parser implementation details
- fix: upload size violations are converted to domain error
  ErrUploadTooLarge at the handler boundary
- fix: download logs error and size mismatch when io.Copy fails or
  writes fewer bytes than expected
- test: add tests for field name leak prevention, parser error
  sanitization, read errors after response start, and EXDEV fallback
This commit is contained in:
2026-07-05 17:35:34 +08:00
parent fc2b9312fa
commit 28e17a5b08
7 changed files with 305 additions and 47 deletions
+2 -1
View File
@@ -81,8 +81,9 @@
| Staging before promotion | Storage backends write upload bytes to a staging path first, then promote the object to the long-term data path only after validation succeeds. | | Staging before promotion | Storage backends write upload bytes to a staging path first, then promote the object to the long-term data path only after validation succeeds. |
| Promote before DB create | The service promotes the object before creating the active file record, preventing visible DB rows from pointing at missing objects. If DB creation fails after promotion, the service best-effort deletes the promoted object. | | Promote before DB create | The service promotes the object before creating the active file record, preventing visible DB rows from pointing at missing objects. If DB creation fails after promotion, the service best-effort deletes the promoted object. |
| Upload parent location | Multipart upload `parent_id` is passed as a query parameter, keeping the multipart body focused on the file stream. | | Upload parent location | Multipart upload `parent_id` is passed as a query parameter, keeping the multipart body focused on the file stream. |
| Service-layer upload errors | HTTP transport errors are converted at the handler boundary; the file service only handles domain errors such as oversized uploads. |
**Consequences**: **Consequences**:
- Interrupted, malformed, and oversized uploads leave only staging objects, which are safe to clean by path prefix and age. - Interrupted, malformed, and oversized uploads leave only staging objects, which are safe to clean by path prefix and age.
- Local storage can promote with `os.Rename`; future S3 storage can implement promotion with copy/delete while keeping business visibility controlled by the DB row. - Local storage promotes with `os.Rename` and falls back to copy/delete on cross-device `EXDEV`; future S3 storage can implement promotion with copy/delete while keeping business visibility controlled by the DB row.
- A DB failure after promotion can still leave a long-term orphan object, but it is not visible through the file API and can be cleaned independently. - A DB failure after promotion can still leave a long-term orphan object, but it is not visible through the file API and can be cleaned independently.
+56 -7
View File
@@ -15,6 +15,7 @@ import (
"github.com/dhao2001/mygo/internal/api" "github.com/dhao2001/mygo/internal/api"
"github.com/dhao2001/mygo/internal/middleware" "github.com/dhao2001/mygo/internal/middleware"
"github.com/dhao2001/mygo/internal/model"
"github.com/dhao2001/mygo/internal/service" "github.com/dhao2001/mygo/internal/service"
) )
@@ -24,6 +25,13 @@ const (
multipartFileField = "file" multipartFileField = "file"
) )
var (
errMissingFileField = errors.New("missing file field")
errMissingFileName = errors.New("missing file name")
errUnexpectedMultipartField = errors.New("unexpected multipart field")
errInvalidMultipartForm = errors.New("invalid multipart form")
)
// FileHandler handles file management endpoints. // FileHandler handles file management endpoints.
type FileHandler struct { type FileHandler struct {
fileService *service.FileService fileService *service.FileService
@@ -111,12 +119,12 @@ func (h *FileHandler) Upload(c *gin.Context) {
api.Error(c, http.StatusRequestEntityTooLarge, "request body is too large") api.Error(c, http.StatusRequestEntityTooLarge, "request body is too large")
return return
} }
api.Error(c, http.StatusBadRequest, err.Error()) api.Error(c, http.StatusBadRequest, uploadPartErrorMessage(err))
return return
} }
defer part.Close() defer part.Close()
info, err := h.fileService.Upload(c.Request.Context(), userID, parentID, fileName, part) info, err := h.fileService.Upload(c.Request.Context(), userID, parentID, fileName, uploadBodyReader{reader: part})
if err != nil { if err != nil {
api.RespondError(c, err) api.RespondError(c, err)
return return
@@ -129,30 +137,55 @@ func nextUploadFilePart(reader *multipart.Reader) (*multipart.Part, string, erro
part, err := reader.NextPart() part, err := reader.NextPart()
if err != nil { if err != nil {
if err == io.EOF { if err == io.EOF {
return nil, "", errors.New("missing file field") return nil, "", errMissingFileField
} }
return nil, "", err return nil, "", fmt.Errorf("%w: %v", errInvalidMultipartForm, err)
} }
if part.FormName() != multipartFileField { if part.FormName() != multipartFileField {
part.Close() part.Close()
return nil, "", fmt.Errorf("unexpected multipart field %q", part.FormName()) return nil, "", fmt.Errorf("%w: %q", errUnexpectedMultipartField, part.FormName())
} }
fileName := part.FileName() fileName := part.FileName()
if fileName == "" { if fileName == "" {
part.Close() part.Close()
return nil, "", errors.New("missing file name") return nil, "", errMissingFileName
} }
return part, fileName, nil return part, fileName, nil
} }
func uploadPartErrorMessage(err error) string {
switch {
case errors.Is(err, errMissingFileField):
return "missing file field"
case errors.Is(err, errMissingFileName):
return "missing file name"
case errors.Is(err, errUnexpectedMultipartField):
return "unexpected multipart field"
default:
return "invalid multipart form"
}
}
func isRequestBodyTooLarge(err error) bool { func isRequestBodyTooLarge(err error) bool {
var maxBytesErr *http.MaxBytesError var maxBytesErr *http.MaxBytesError
return errors.As(err, &maxBytesErr) return errors.As(err, &maxBytesErr)
} }
type uploadBodyReader struct {
reader io.Reader
}
func (r uploadBodyReader) Read(p []byte) (int, error) {
n, err := r.reader.Read(p)
if isRequestBodyTooLarge(err) {
return n, model.ErrUploadTooLarge
}
return n, err
}
// List handles GET /api/v1/files. // List handles GET /api/v1/files.
func (h *FileHandler) List(c *gin.Context) { func (h *FileHandler) List(c *gin.Context) {
userID := middleware.MustGetUserID(c) userID := middleware.MustGetUserID(c)
@@ -223,7 +256,23 @@ func (h *FileHandler) Download(c *gin.Context) {
c.Header("Content-Length", strconv.FormatInt(info.Size, 10)) c.Header("Content-Length", strconv.FormatInt(info.Size, 10))
c.Status(http.StatusOK) c.Status(http.StatusOK)
io.Copy(c.Writer, reader) written, err := io.Copy(c.Writer, reader)
if err != nil {
slog.WarnContext(c.Request.Context(), "download copy failed",
"user_id", userID,
"file_id", fileID,
"written", written,
"expected_size", info.Size,
"error", err)
return
}
if written != info.Size {
slog.WarnContext(c.Request.Context(), "download size mismatch",
"user_id", userID,
"file_id", fileID,
"written", written,
"expected_size", info.Size)
}
} }
// Update handles PUT /api/v1/files/:id. // Update handles PUT /api/v1/files/:id.
+111 -5
View File
@@ -4,6 +4,7 @@ import (
"bytes" "bytes"
"context" "context"
"encoding/json" "encoding/json"
"errors"
"io" "io"
"mime/multipart" "mime/multipart"
"net/http" "net/http"
@@ -24,6 +25,7 @@ import (
// inMemStore implements storage.StorageBackend with an in-memory map. // inMemStore implements storage.StorageBackend with an in-memory map.
type inMemStore struct { type inMemStore struct {
files map[string][]byte files map[string][]byte
failReads bool
} }
func newInMemStore() *inMemStore { func newInMemStore() *inMemStore {
@@ -54,6 +56,9 @@ func (s *inMemStore) Open(_ context.Context, path string) (io.ReadCloser, error)
if !ok { if !ok {
return nil, &fsNotFoundError{path} return nil, &fsNotFoundError{path}
} }
if s.failReads {
return io.NopCloser(&errorAfterReader{data: data, err: errors.New("download read failed")}), nil
}
return io.NopCloser(bytes.NewReader(data)), nil return io.NopCloser(bytes.NewReader(data)), nil
} }
@@ -70,13 +75,27 @@ type fsNotFoundError struct{ path string }
func (e *fsNotFoundError) Error() string { return "file not found on disk: " + e.path } func (e *fsNotFoundError) Error() string { return "file not found on disk: " + e.path }
type errorAfterReader struct {
data []byte
err error
}
func (r *errorAfterReader) Read(p []byte) (int, error) {
if len(r.data) == 0 {
return 0, r.err
}
n := copy(p, r.data)
r.data = r.data[n:]
return n, nil
}
var _ storage.StorageBackend = (*inMemStore)(nil) var _ storage.StorageBackend = (*inMemStore)(nil)
func setupFileHandler(t *testing.T) *FileHandler { func setupFileHandler(t *testing.T) (*FileHandler, *inMemStore) {
return setupFileHandlerWithMaxUploadSize(t, 0) return setupFileHandlerWithMaxUploadSize(t, 0)
} }
func setupFileHandlerWithMaxUploadSize(t *testing.T, maxUploadSize int64) *FileHandler { func setupFileHandlerWithMaxUploadSize(t *testing.T, maxUploadSize int64) (*FileHandler, *inMemStore) {
t.Helper() t.Helper()
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{}) db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
@@ -91,7 +110,7 @@ func setupFileHandlerWithMaxUploadSize(t *testing.T, maxUploadSize int64) *FileH
store := newInMemStore() store := newInMemStore()
fileService := service.NewFileService(fileRepo, store, maxUploadSize, nil) fileService := service.NewFileService(fileRepo, store, maxUploadSize, nil)
return NewFileHandler(fileService) return NewFileHandler(fileService), store
} }
func setupFileRouter(t *testing.T) *gin.Engine { func setupFileRouter(t *testing.T) *gin.Engine {
@@ -99,9 +118,14 @@ func setupFileRouter(t *testing.T) *gin.Engine {
} }
func setupFileRouterWithMaxUploadSize(t *testing.T, maxUploadSize int64) *gin.Engine { func setupFileRouterWithMaxUploadSize(t *testing.T, maxUploadSize int64) *gin.Engine {
r, _ := setupFileRouterWithMaxUploadSizeAndStore(t, maxUploadSize)
return r
}
func setupFileRouterWithMaxUploadSizeAndStore(t *testing.T, maxUploadSize int64) (*gin.Engine, *inMemStore) {
t.Helper() t.Helper()
handler := setupFileHandlerWithMaxUploadSize(t, maxUploadSize) handler, store := setupFileHandlerWithMaxUploadSize(t, maxUploadSize)
gin.SetMode(gin.TestMode) gin.SetMode(gin.TestMode)
r := gin.New() r := gin.New()
@@ -125,7 +149,7 @@ func setupFileRouterWithMaxUploadSize(t *testing.T, maxUploadSize int64) *gin.En
files.DELETE("/:id", handler.Delete) files.DELETE("/:id", handler.Delete)
} }
return r return r, store
} }
func TestFileHandler_Upload(t *testing.T) { func TestFileHandler_Upload(t *testing.T) {
@@ -234,6 +258,52 @@ func TestFileHandler_UploadNoFile(t *testing.T) {
} }
} }
func TestFileHandler_UploadUnexpectedFieldDoesNotEchoFieldName(t *testing.T) {
r := setupFileRouter(t)
body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
part, _ := writer.CreateFormField("secret_token")
part.Write([]byte("secret"))
writer.Close()
req := httptest.NewRequest(http.MethodPost, "/api/v1/files", body)
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Set("X-User-ID", "user1")
rec := httptest.NewRecorder()
r.ServeHTTP(rec, req)
if rec.Code != http.StatusBadRequest {
t.Fatalf("status = %d, want %d; body = %s", rec.Code, http.StatusBadRequest, rec.Body.String())
}
if !strings.Contains(rec.Body.String(), "unexpected multipart field") {
t.Errorf("body = %s, want safe unexpected field message", rec.Body.String())
}
if strings.Contains(rec.Body.String(), "secret_token") {
t.Errorf("body leaks multipart field name: %s", rec.Body.String())
}
}
func TestFileHandler_UploadMalformedMultipartDoesNotLeakParserError(t *testing.T) {
r := setupFileRouter(t)
req := httptest.NewRequest(http.MethodPost, "/api/v1/files", strings.NewReader("not a valid multipart body"))
req.Header.Set("Content-Type", "multipart/form-data; boundary=mygo-boundary")
req.Header.Set("X-User-ID", "user1")
rec := httptest.NewRecorder()
r.ServeHTTP(rec, req)
if rec.Code != http.StatusBadRequest {
t.Fatalf("status = %d, want %d; body = %s", rec.Code, http.StatusBadRequest, rec.Body.String())
}
if !strings.Contains(rec.Body.String(), "invalid multipart form") {
t.Errorf("body = %s, want safe invalid multipart message", rec.Body.String())
}
if strings.Contains(rec.Body.String(), "NextPart") || strings.Contains(rec.Body.String(), "EOF") {
t.Errorf("body leaks parser internals: %s", rec.Body.String())
}
}
func TestFileHandler_CreateDir(t *testing.T) { func TestFileHandler_CreateDir(t *testing.T) {
r := setupFileRouter(t) r := setupFileRouter(t)
@@ -380,6 +450,42 @@ func TestFileHandler_Download(t *testing.T) {
} }
} }
func TestFileHandler_DownloadReadErrorAfterResponseStarted(t *testing.T) {
r, store := setupFileRouterWithMaxUploadSizeAndStore(t, 0)
body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
part, _ := writer.CreateFormFile("file", "download-error.txt")
content := []byte("partial response")
part.Write(content)
writer.Close()
req := httptest.NewRequest(http.MethodPost, "/api/v1/files", body)
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Set("X-User-ID", "user1")
rec := httptest.NewRecorder()
r.ServeHTTP(rec, req)
var uploaded service.FileInfo
if err := json.Unmarshal(rec.Body.Bytes(), &uploaded); err != nil {
t.Fatalf("unmarshal upload: %v", err)
}
store.failReads = true
req = httptest.NewRequest(http.MethodGet, "/api/v1/files/"+uploaded.ID+"/content", nil)
req.Header.Set("X-User-ID", "user1")
rec = httptest.NewRecorder()
r.ServeHTTP(rec, req)
if rec.Code != http.StatusOK {
t.Errorf("status = %d, want %d", rec.Code, http.StatusOK)
}
if !bytes.Equal(rec.Body.Bytes(), content) {
t.Errorf("content = %q, want %q", rec.Body.String(), content)
}
}
func TestFileHandler_Update(t *testing.T) { func TestFileHandler_Update(t *testing.T) {
r := setupFileRouter(t) r := setupFileRouter(t)
+26
View File
@@ -11,6 +11,7 @@ var (
ErrDuplicate = errors.New("resource already exists") ErrDuplicate = errors.New("resource already exists")
ErrUnauthorized = errors.New("unauthorized") ErrUnauthorized = errors.New("unauthorized")
ErrForbidden = errors.New("forbidden") ErrForbidden = errors.New("forbidden")
ErrUploadTooLarge = errors.New("upload exceeds maximum size")
) )
// AppError is a service-layer error that carries an HTTP status, a user-safe // AppError is a service-layer error that carries an HTTP status, a user-safe
@@ -25,6 +26,31 @@ type AppError struct {
func (e *AppError) Error() string { return e.Message } func (e *AppError) Error() string { return e.Message }
func (e *AppError) Unwrap() error { return e.Err } func (e *AppError) Unwrap() error { return e.Err }
// NewBadRequestError creates a 400 AppError.
func NewBadRequestError(message string) *AppError {
return &AppError{Status: http.StatusBadRequest, Message: message}
}
// NewConflictError creates a 409 AppError.
func NewConflictError(message string) *AppError {
return &AppError{Status: http.StatusConflict, Message: message}
}
// NewNotFoundError creates a 404 AppError.
func NewNotFoundError(message string, cause error) *AppError {
return &AppError{Status: http.StatusNotFound, Message: message, Err: cause}
}
// NewForbiddenError creates a 403 AppError.
func NewForbiddenError(message string, cause error) *AppError {
return &AppError{Status: http.StatusForbidden, Message: message, Err: cause}
}
// NewPayloadTooLargeError creates a 413 AppError.
func NewPayloadTooLargeError(message string, cause error) *AppError {
return &AppError{Status: http.StatusRequestEntityTooLarge, Message: message, Err: cause}
}
// NewInternalError creates a 500 AppError with a wrapped internal cause. // NewInternalError creates a 500 AppError with a wrapped internal cause.
// msg describes the operation that failed; cause is the underlying error. // msg describes the operation that failed; cause is the underlying error.
func NewInternalError(msg string, cause error) *AppError { func NewInternalError(msg string, cause error) *AppError {
+21 -28
View File
@@ -9,7 +9,6 @@ import (
"fmt" "fmt"
"io" "io"
"log/slog" "log/slog"
"net/http"
"strings" "strings"
"time" "time"
@@ -41,8 +40,6 @@ type FileList struct {
Total int64 `json:"total"` Total int64 `json:"total"`
} }
var errUploadTooLarge = errors.New("upload exceeds maximum size")
// FileService handles file management business logic. // FileService handles file management business logic.
type FileService struct { type FileService struct {
fileRepo repository.FileRepository fileRepo repository.FileRepository
@@ -90,7 +87,7 @@ func (s *FileService) Upload(ctx context.Context, userID string, parentID *strin
// Check for name conflicts in the target directory. // Check for name conflicts in the target directory.
if _, err := s.fileRepo.FindByNameAndParent(ctx, userID, parentID, fileName); err == nil { if _, err := s.fileRepo.FindByNameAndParent(ctx, userID, parentID, fileName); err == nil {
return nil, &model.AppError{Status: http.StatusConflict, Message: "a file with this name already exists in this directory"} return nil, model.NewConflictError("a file with this name already exists in this directory")
} else if !errors.Is(err, model.ErrNotFound) { } else if !errors.Is(err, model.ErrNotFound) {
return nil, model.NewInternalError("check name conflict", err) return nil, model.NewInternalError("check name conflict", err)
} }
@@ -156,7 +153,7 @@ func (s *FileService) Upload(ctx context.Context, userID string, parentID *strin
// Compensate: remove the promoted file. // Compensate: remove the promoted file.
_ = s.storage.Delete(ctx, storagePath) _ = s.storage.Delete(ctx, storagePath)
if errors.Is(err, model.ErrDuplicate) { if errors.Is(err, model.ErrDuplicate) {
return nil, &model.AppError{Status: http.StatusConflict, Message: "a file with this name already exists in this directory"} return nil, model.NewConflictError("a file with this name already exists in this directory")
} }
return nil, model.NewInternalError("create file record", err) return nil, model.NewInternalError("create file record", err)
} }
@@ -179,7 +176,7 @@ func (r *uploadLimitReader) Read(p []byte) (int, error) {
n, err := r.reader.Read(one[:]) n, err := r.reader.Read(one[:])
if n > 0 { if n > 0 {
p[0] = one[0] p[0] = one[0]
return 1, errUploadTooLarge return 1, model.ErrUploadTooLarge
} }
return 0, err return 0, err
} }
@@ -197,18 +194,14 @@ func isUploadTooLargeError(err error) bool {
if err == nil { if err == nil {
return false return false
} }
if errors.Is(err, errUploadTooLarge) { return errors.Is(err, model.ErrUploadTooLarge)
return true
}
var maxBytesErr *http.MaxBytesError
return errors.As(err, &maxBytesErr)
} }
func uploadTooLargeError(maxUploadSize int64) *model.AppError { func uploadTooLargeError(maxUploadSize int64) *model.AppError {
if maxUploadSize > 0 { if maxUploadSize > 0 {
return &model.AppError{Status: http.StatusRequestEntityTooLarge, Message: fmt.Sprintf("file size exceeds the maximum allowed size of %d bytes", maxUploadSize)} return model.NewPayloadTooLargeError(fmt.Sprintf("file size exceeds the maximum allowed size of %d bytes", maxUploadSize), model.ErrUploadTooLarge)
} }
return &model.AppError{Status: http.StatusRequestEntityTooLarge, Message: "request body is too large"} return model.NewPayloadTooLargeError("request body is too large", model.ErrUploadTooLarge)
} }
// Download returns a reader for the file's content and its metadata. // Download returns a reader for the file's content and its metadata.
@@ -220,7 +213,7 @@ func (s *FileService) Download(ctx context.Context, userID, fileID string) (io.R
} }
if file.IsDir { if file.IsDir {
return nil, nil, &model.AppError{Status: http.StatusBadRequest, Message: "cannot download a directory"} return nil, nil, model.NewBadRequestError("cannot download a directory")
} }
reader, err := s.storage.Open(ctx, file.StoragePath) reader, err := s.storage.Open(ctx, file.StoragePath)
@@ -279,7 +272,7 @@ func (s *FileService) Update(ctx context.Context, userID, fileID string, newName
// If parent is changing, verify the new parent. // If parent is changing, verify the new parent.
if newParentID != nil { if newParentID != nil {
if *newParentID == fileID { if *newParentID == fileID {
return nil, &model.AppError{Status: http.StatusBadRequest, Message: "cannot move a directory into itself"} return nil, model.NewBadRequestError("cannot move a directory into itself")
} }
if err := s.verifyParent(ctx, userID, *newParentID); err != nil { if err := s.verifyParent(ctx, userID, *newParentID); err != nil {
return nil, err return nil, err
@@ -291,7 +284,7 @@ func (s *FileService) Update(ctx context.Context, userID, fileID string, newName
if newName != "" || newParentID != nil { if newName != "" || newParentID != nil {
conflict, err := s.fileRepo.FindByNameAndParent(ctx, userID, file.ParentID, file.Name) conflict, err := s.fileRepo.FindByNameAndParent(ctx, userID, file.ParentID, file.Name)
if err == nil && conflict.ID != fileID { if err == nil && conflict.ID != fileID {
return nil, &model.AppError{Status: http.StatusConflict, Message: "a file with this name already exists in the target directory"} return nil, model.NewConflictError("a file with this name already exists in the target directory")
} else if err != nil && !errors.Is(err, model.ErrNotFound) { } else if err != nil && !errors.Is(err, model.ErrNotFound) {
return nil, model.NewInternalError("check name conflict", err) return nil, model.NewInternalError("check name conflict", err)
} }
@@ -299,7 +292,7 @@ func (s *FileService) Update(ctx context.Context, userID, fileID string, newName
if err := s.fileRepo.Update(ctx, file); err != nil { if err := s.fileRepo.Update(ctx, file); err != nil {
if errors.Is(err, model.ErrDuplicate) { if errors.Is(err, model.ErrDuplicate) {
return nil, &model.AppError{Status: http.StatusConflict, Message: "a file with this name already exists in the target directory"} return nil, model.NewConflictError("a file with this name already exists in the target directory")
} }
return nil, model.NewInternalError("update file", err) return nil, model.NewInternalError("update file", err)
} }
@@ -325,7 +318,7 @@ func (s *FileService) Delete(ctx context.Context, userID, fileID string) error {
return model.NewInternalError("check directory contents", err) return model.NewInternalError("check directory contents", err)
} }
if total > 0 { if total > 0 {
return &model.AppError{Status: http.StatusConflict, Message: "directory is not empty"} return model.NewConflictError("directory is not empty")
} }
} }
@@ -350,7 +343,7 @@ func (s *FileService) CreateDir(ctx context.Context, userID string, parentID *st
// Check for name conflicts in the target directory. // Check for name conflicts in the target directory.
if _, err := s.fileRepo.FindByNameAndParent(ctx, userID, parentID, dirName); err == nil { if _, err := s.fileRepo.FindByNameAndParent(ctx, userID, parentID, dirName); err == nil {
return nil, &model.AppError{Status: http.StatusConflict, Message: "a file with this name already exists in this directory"} return nil, model.NewConflictError("a file with this name already exists in this directory")
} else if !errors.Is(err, model.ErrNotFound) { } else if !errors.Is(err, model.ErrNotFound) {
return nil, model.NewInternalError("check name conflict", err) return nil, model.NewInternalError("check name conflict", err)
} }
@@ -366,7 +359,7 @@ func (s *FileService) CreateDir(ctx context.Context, userID string, parentID *st
if err := s.fileRepo.Create(ctx, dir); err != nil { if err := s.fileRepo.Create(ctx, dir); err != nil {
if errors.Is(err, model.ErrDuplicate) { if errors.Is(err, model.ErrDuplicate) {
return nil, &model.AppError{Status: http.StatusConflict, Message: "a file with this name already exists in this directory"} return nil, model.NewConflictError("a file with this name already exists in this directory")
} }
return nil, model.NewInternalError("create directory record", err) return nil, model.NewInternalError("create directory record", err)
} }
@@ -379,13 +372,13 @@ func (s *FileService) getOwnedFile(ctx context.Context, userID, fileID string) (
file, err := s.fileRepo.FindByID(ctx, fileID) file, err := s.fileRepo.FindByID(ctx, fileID)
if err != nil { if err != nil {
if errors.Is(err, model.ErrNotFound) { if errors.Is(err, model.ErrNotFound) {
return nil, &model.AppError{Status: http.StatusNotFound, Message: "file not found", Err: model.ErrNotFound} return nil, model.NewNotFoundError("file not found", model.ErrNotFound)
} }
return nil, model.NewInternalError("find file", err) return nil, model.NewInternalError("find file", err)
} }
if file.UserID != userID { if file.UserID != userID {
return nil, &model.AppError{Status: http.StatusForbidden, Message: "access denied", Err: model.ErrForbidden} return nil, model.NewForbiddenError("access denied", model.ErrForbidden)
} }
return file, nil return file, nil
@@ -396,17 +389,17 @@ func (s *FileService) verifyParent(ctx context.Context, userID, parentID string)
parent, err := s.fileRepo.FindByID(ctx, parentID) parent, err := s.fileRepo.FindByID(ctx, parentID)
if err != nil { if err != nil {
if errors.Is(err, model.ErrNotFound) { if errors.Is(err, model.ErrNotFound) {
return &model.AppError{Status: http.StatusNotFound, Message: "parent directory not found"} return model.NewNotFoundError("parent directory not found", model.ErrNotFound)
} }
return model.NewInternalError("find parent", err) return model.NewInternalError("find parent", err)
} }
if parent.UserID != userID { if parent.UserID != userID {
return &model.AppError{Status: http.StatusForbidden, Message: "access denied", Err: model.ErrForbidden} return model.NewForbiddenError("access denied", model.ErrForbidden)
} }
if !parent.IsDir { if !parent.IsDir {
return &model.AppError{Status: http.StatusBadRequest, Message: "parent is not a directory"} return model.NewBadRequestError("parent is not a directory")
} }
return nil return nil
@@ -416,13 +409,13 @@ func (s *FileService) verifyParent(ctx context.Context, userID, parentID string)
// null bytes, or are reserved names "." and "..". // null bytes, or are reserved names "." and "..".
func validateFileName(name string) error { func validateFileName(name string) error {
if name == "" { if name == "" {
return &model.AppError{Status: http.StatusBadRequest, Message: "file name must not be empty"} return model.NewBadRequestError("file name must not be empty")
} }
if strings.ContainsAny(name, "/\\\x00") { if strings.ContainsAny(name, "/\\\x00") {
return &model.AppError{Status: http.StatusBadRequest, Message: "file name contains invalid characters"} return model.NewBadRequestError("file name contains invalid characters")
} }
if name == "." || name == ".." { if name == "." || name == ".." {
return &model.AppError{Status: http.StatusBadRequest, Message: fmt.Sprintf("file name is reserved: %s", name)} return model.NewBadRequestError(fmt.Sprintf("file name is reserved: %s", name))
} }
return nil return nil
} }
+39 -1
View File
@@ -2,11 +2,13 @@ package storage
import ( import (
"context" "context"
"errors"
"fmt" "fmt"
"io" "io"
"os" "os"
"path/filepath" "path/filepath"
"strings" "strings"
"syscall"
) )
const ( const (
@@ -14,6 +16,8 @@ const (
stagingPathPrefix = "staging" stagingPathPrefix = "staging"
) )
var renameLocalFile = os.Rename
// LocalStorage implements StorageBackend using the local filesystem. // LocalStorage implements StorageBackend using the local filesystem.
type LocalStorage struct { type LocalStorage struct {
basePath string basePath string
@@ -87,13 +91,47 @@ func (s *LocalStorage) PromoteStaged(_ context.Context, stagedPath, finalPath st
return fmt.Errorf("create parent directory: %w", err) return fmt.Errorf("create parent directory: %w", err)
} }
if err := os.Rename(fullStagedPath, fullFinalPath); err != nil { if err := renameLocalFile(fullStagedPath, fullFinalPath); err != nil {
if errors.Is(err, syscall.EXDEV) {
return promoteByCopy(fullStagedPath, fullFinalPath)
}
return fmt.Errorf("promote staged file: %w", err) return fmt.Errorf("promote staged file: %w", err)
} }
return nil return nil
} }
func promoteByCopy(stagedPath, finalPath string) error {
source, err := os.Open(stagedPath)
if err != nil {
return fmt.Errorf("open staged file: %w", err)
}
defer source.Close()
destination, err := os.OpenFile(finalPath, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0666)
if err != nil {
return fmt.Errorf("create final file: %w", err)
}
if _, err := io.Copy(destination, source); err != nil {
destination.Close()
os.Remove(finalPath)
return fmt.Errorf("copy staged file: %w", err)
}
if err := destination.Close(); err != nil {
os.Remove(finalPath)
return fmt.Errorf("close final file: %w", err)
}
if err := os.Remove(stagedPath); err != nil {
os.Remove(finalPath)
return fmt.Errorf("delete staged file after copy: %w", err)
}
return nil
}
// Open returns a reader for the file at path under the storage root. // Open returns a reader for the file at path under the storage root.
func (s *LocalStorage) Open(_ context.Context, path string) (io.ReadCloser, error) { func (s *LocalStorage) Open(_ context.Context, path string) (io.ReadCloser, error) {
fullPath := filepath.Join(s.basePath, path) fullPath := filepath.Join(s.basePath, path)
+45
View File
@@ -5,6 +5,7 @@ import (
"io" "io"
"os" "os"
"strings" "strings"
"syscall"
"testing" "testing"
) )
@@ -179,6 +180,50 @@ func TestPromoteRequiresDataFinalPrefix(t *testing.T) {
} }
} }
func TestPromoteStagedFallsBackToCopyOnEXDEV(t *testing.T) {
dir := t.TempDir()
store, err := NewLocalStorage(dir)
if err != nil {
t.Fatalf("NewLocalStorage: %v", err)
}
ctx := context.Background()
content := "copy across filesystems"
_, err = store.SaveStaged(ctx, "staging/cross-device.txt", strings.NewReader(content))
if err != nil {
t.Fatalf("SaveStaged: %v", err)
}
originalRename := renameLocalFile
renameLocalFile = func(_, _ string) error {
return &os.LinkError{Op: "rename", Err: syscall.EXDEV}
}
t.Cleanup(func() {
renameLocalFile = originalRename
})
if err := store.PromoteStaged(ctx, "staging/cross-device.txt", "data/cross-device.txt"); err != nil {
t.Fatalf("PromoteStaged: %v", err)
}
reader, err := store.Open(ctx, "data/cross-device.txt")
if err != nil {
t.Fatalf("Open promoted file: %v", err)
}
got, err := io.ReadAll(reader)
reader.Close()
if err != nil {
t.Fatalf("ReadAll: %v", err)
}
if string(got) != content {
t.Errorf("content = %q, want %q", string(got), content)
}
if _, err := os.Stat(dir + "/staging/cross-device.txt"); !os.IsNotExist(err) {
t.Errorf("staged file should be removed after fallback promote, stat err = %v", err)
}
}
func TestOpenMissingFile(t *testing.T) { func TestOpenMissingFile(t *testing.T) {
dir := t.TempDir() dir := t.TempDir()
store, err := NewLocalStorage(dir) store, err := NewLocalStorage(dir)