Skip to content

Modern Docker Management, Designed for Everyone

fix: project folder not renamed when project name is updated (#1858)

Kyle Mendell897624af341c
diff --git a/backend/internal/services/project_service.go b/backend/internal/services/project_service.go
index cf38419c3..496e9b7ab 100644
--- a/backend/internal/services/project_service.go
+++ b/backend/internal/services/project_service.go
@@ -1203,10 +1203,23 @@ func (s *ProjectService) UpdateProject(ctx context.Context, projectID string, na
return nil, err
}
- if name != nil {
- if newName := strings.TrimSpace(*name); newName != "" && proj.Name != newName {
- proj.Name = newName
+ originalPath := proj.Path
+ originalDirName := proj.DirName
+ committed := false
+ defer func() {
+ if committed || proj.Path == originalPath {
+ return
}
+ if err := os.Rename(proj.Path, originalPath); err != nil {
+ slog.WarnContext(ctx, "failed to rollback project directory rename", "from", proj.Path, "to", originalPath, "error", err)
+ return
+ }
+ proj.Path = originalPath
+ proj.DirName = originalDirName
+ }()
+
+ if err := s.applyProjectRenameIfNeeded(&proj, name, projectsDirectory); err != nil {
+ return nil, err
}
switch {
@@ -1223,6 +1236,7 @@ func (s *ProjectService) UpdateProject(ctx context.Context, projectID string, na
if err := s.db.WithContext(ctx).Save(&proj).Error; err != nil {
return nil, fmt.Errorf("failed to update project: %w", err)
}
+ committed = true
metadata := models.JSON{
"action": "update",
@@ -1243,6 +1257,46 @@ func (s *ProjectService) UpdateProject(ctx context.Context, projectID string, na
return &proj, nil
}
+func (s *ProjectService) applyProjectRenameIfNeeded(proj *models.Project, name *string, projectsDirectory string) error {
+ if name == nil {
+ return nil
+ }
+
+ newName := strings.TrimSpace(*name)
+ if newName == "" || proj.Name == newName {
+ return nil
+ }
+
+ if proj.Status != models.ProjectStatusStopped {
+ return fmt.Errorf("project must be stopped before renaming (current status: %s)", proj.Status)
+ }
+
+ newDirName := fs.SanitizeProjectName(newName)
+ if newDirName == "" || strings.Trim(newDirName, "_") == "" {
+ return fmt.Errorf("invalid project name: results in empty directory name")
+ }
+
+ currentPath := filepath.Clean(proj.Path)
+ targetPath := filepath.Clean(filepath.Join(projectsDirectory, newDirName))
+ if currentPath != targetPath {
+ if _, statErr := os.Stat(targetPath); statErr == nil {
+ return fmt.Errorf("project directory already exists: %s", targetPath)
+ } else if !os.IsNotExist(statErr) {
+ return fmt.Errorf("failed to check project directory rename target: %w", statErr)
+ }
+
+ if err := os.Rename(currentPath, targetPath); err != nil {
+ return fmt.Errorf("failed to rename project directory: %w", err)
+ }
+
+ proj.Path = targetPath
+ }
+
+ proj.DirName = &newDirName
+ proj.Name = newName
+ return nil
+}
+
func (s *ProjectService) UpdateProjectIncludeFile(ctx context.Context, projectID, relativePath, content string, user models.User) error {
proj, err := s.GetProjectFromDatabaseByID(ctx, projectID)
if err != nil {
diff --git a/backend/internal/services/project_service_test.go b/backend/internal/services/project_service_test.go
index 28bbcbc59..8ef8b1460 100644
--- a/backend/internal/services/project_service_test.go
+++ b/backend/internal/services/project_service_test.go
@@ -2,6 +2,8 @@ package services
import (
"context"
+ "os"
+ "path/filepath"
"testing"
"time"
@@ -334,3 +336,143 @@ func TestBuildProjectImagePullPlan(t *testing.T) {
assert.Equal(t, imagePullModeAlways, plan["redis:latest"])
assert.Equal(t, imagePullModeNever, plan["nginx:latest"])
}
+
+func TestProjectService_UpdateProject_RenamesDirectoryWhenNameChanges(t *testing.T) {
+ db := setupProjectTestDB(t)
+ ctx := context.Background()
+
+ projectsDir := t.TempDir()
+ t.Setenv("PROJECTS_DIRECTORY", projectsDir)
+
+ settingsService, err := NewSettingsService(ctx, db)
+ require.NoError(t, err)
+
+ eventService := NewEventService(db, nil, nil)
+ svc := NewProjectService(db, settingsService, eventService, nil, nil)
+
+ originalDirName := "Foo"
+ originalPath := filepath.Join(projectsDir, originalDirName)
+ require.NoError(t, os.MkdirAll(originalPath, 0o755))
+
+ project := &models.Project{
+ BaseModel: models.BaseModel{ID: "proj-1"},
+ Name: "Foo",
+ DirName: &originalDirName,
+ Path: originalPath,
+ Status: models.ProjectStatusStopped,
+ }
+ require.NoError(t, db.Create(project).Error)
+
+ updatedName := "bar"
+ updated, err := svc.UpdateProject(ctx, project.ID, &updatedName, nil, nil, models.User{
+ BaseModel: models.BaseModel{ID: "u1"},
+ Username: "tester",
+ })
+ require.NoError(t, err)
+
+ expectedPath := filepath.Join(projectsDir, "bar")
+ assert.Equal(t, "bar", updated.Name)
+ assert.Equal(t, expectedPath, updated.Path)
+ require.NotNil(t, updated.DirName)
+ assert.Equal(t, "bar", *updated.DirName)
+ assert.NoDirExists(t, originalPath)
+ assert.DirExists(t, expectedPath)
+
+ var fromDB models.Project
+ require.NoError(t, db.First(&fromDB, "id = ?", project.ID).Error)
+ assert.Equal(t, "bar", fromDB.Name)
+ assert.Equal(t, expectedPath, fromDB.Path)
+ require.NotNil(t, fromDB.DirName)
+ assert.Equal(t, "bar", *fromDB.DirName)
+}
+
+func TestProjectService_UpdateProject_RenameFailsWhenTargetDirectoryExists(t *testing.T) {
+ db := setupProjectTestDB(t)
+ ctx := context.Background()
+
+ projectsDir := t.TempDir()
+ t.Setenv("PROJECTS_DIRECTORY", projectsDir)
+
+ settingsService, err := NewSettingsService(ctx, db)
+ require.NoError(t, err)
+
+ eventService := NewEventService(db, nil, nil)
+ svc := NewProjectService(db, settingsService, eventService, nil, nil)
+
+ originalDirName := "Foo"
+ originalPath := filepath.Join(projectsDir, originalDirName)
+ require.NoError(t, os.MkdirAll(originalPath, 0o755))
+
+ targetPath := filepath.Join(projectsDir, "bar")
+ require.NoError(t, os.MkdirAll(targetPath, 0o755))
+
+ project := &models.Project{
+ BaseModel: models.BaseModel{ID: "proj-2"},
+ Name: "Foo",
+ DirName: &originalDirName,
+ Path: originalPath,
+ Status: models.ProjectStatusStopped,
+ }
+ require.NoError(t, db.Create(project).Error)
+
+ updatedName := "bar"
+ _, err = svc.UpdateProject(ctx, project.ID, &updatedName, nil, nil, models.User{
+ BaseModel: models.BaseModel{ID: "u1"},
+ Username: "tester",
+ })
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), "project directory already exists")
+ assert.DirExists(t, originalPath)
+ assert.DirExists(t, targetPath)
+
+ var fromDB models.Project
+ require.NoError(t, db.First(&fromDB, "id = ?", project.ID).Error)
+ assert.Equal(t, "Foo", fromDB.Name)
+ assert.Equal(t, originalPath, fromDB.Path)
+ require.NotNil(t, fromDB.DirName)
+ assert.Equal(t, "Foo", *fromDB.DirName)
+}
+
+func TestProjectService_UpdateProject_RenameFailsWhenProjectRunning(t *testing.T) {
+ db := setupProjectTestDB(t)
+ ctx := context.Background()
+
+ projectsDir := t.TempDir()
+ t.Setenv("PROJECTS_DIRECTORY", projectsDir)
+
+ settingsService, err := NewSettingsService(ctx, db)
+ require.NoError(t, err)
+
+ eventService := NewEventService(db, nil, nil)
+ svc := NewProjectService(db, settingsService, eventService, nil, nil)
+
+ originalDirName := "Foo"
+ originalPath := filepath.Join(projectsDir, originalDirName)
+ require.NoError(t, os.MkdirAll(originalPath, 0o755))
+
+ project := &models.Project{
+ BaseModel: models.BaseModel{ID: "proj-3"},
+ Name: "Foo",
+ DirName: &originalDirName,
+ Path: originalPath,
+ Status: models.ProjectStatusRunning,
+ }
+ require.NoError(t, db.Create(project).Error)
+
+ updatedName := "bar"
+ _, err = svc.UpdateProject(ctx, project.ID, &updatedName, nil, nil, models.User{
+ BaseModel: models.BaseModel{ID: "u1"},
+ Username: "tester",
+ })
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), "project must be stopped before renaming (current status: running)")
+ assert.DirExists(t, originalPath)
+ assert.NoDirExists(t, filepath.Join(projectsDir, "bar"))
+
+ var fromDB models.Project
+ require.NoError(t, db.First(&fromDB, "id = ?", project.ID).Error)
+ assert.Equal(t, "Foo", fromDB.Name)
+ assert.Equal(t, originalPath, fromDB.Path)
+ require.NotNil(t, fromDB.DirName)
+ assert.Equal(t, "Foo", *fromDB.DirName)
+}