Skip to content

Modern Docker Management, Designed for Everyone

fix: unable to save project due to env miss-validation

Kyle Mendell35e436630045
diff --git a/backend/internal/services/project_service.go b/backend/internal/services/project_service.go
index b7bf7c3af..5ae7ffd8b 100644
--- a/backend/internal/services/project_service.go
+++ b/backend/internal/services/project_service.go
@@ -1783,102 +1783,160 @@ func (s *ProjectService) RestartProject(ctx context.Context, projectID string, u
}
func (s *ProjectService) UpdateProject(ctx context.Context, projectID string, name *string, composeContent, envContent *string, user models.User) (*models.Project, error) {
+ proj, projectsDirectory, err := s.getProjectForUpdate(ctx, projectID)
+ if err != nil {
+ return nil, err
+ }
+
+ if err := s.withProjectRenameRollback(ctx, &proj, func() error {
+ if err := s.applyProjectRenameIfNeeded(&proj, name, projectsDirectory); err != nil {
+ return err
+ }
+ if err := s.persistUpdatedProjectFiles(ctx, &proj, projectsDirectory, composeContent, envContent); err != nil {
+ return err
+ }
+ if err := s.db.WithContext(ctx).Save(&proj).Error; err != nil {
+ return fmt.Errorf("failed to update project: %w", err)
+ }
+ return nil
+ }); err != nil {
+ return nil, err
+ }
+
+ metadata := models.JSON{
+ "action": "update",
+ "projectID": proj.ID,
+ "projectName": proj.Name,
+ }
+ if composeContent != nil {
+ metadata["composeUpdated"] = true
+ }
+ if envContent != nil {
+ metadata["envUpdated"] = true
+ }
+ if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectUpdate, proj.ID, proj.Name, user.ID, user.Username, "0", metadata); logErr != nil {
+ slog.ErrorContext(ctx, "could not log project update action", "error", logErr)
+ }
+
+ slog.InfoContext(ctx, "project updated", "projectID", proj.ID, "name", proj.Name)
+ return &proj, nil
+}
+
+func (s *ProjectService) getProjectForUpdate(ctx context.Context, projectID string) (models.Project, string, error) {
var proj models.Project
if err := s.db.WithContext(ctx).First(&proj, "id = ?", projectID).Error; err != nil {
if errors.Is(err, gorm.ErrRecordNotFound) {
- return nil, fmt.Errorf("project not found")
+ return models.Project{}, "", fmt.Errorf("project not found")
}
- return nil, fmt.Errorf("failed to get project: %w", err)
+ return models.Project{}, "", fmt.Errorf("failed to get project: %w", err)
}
- // Get projects directory for security validation
projectsDirectory, err := fs.GetProjectsDirectory(ctx, s.settingsService.GetStringSetting(ctx, "projectsDirectory", "/app/data/projects"))
if err != nil {
- return nil, fmt.Errorf("failed to get projects directory: %w", err)
+ return models.Project{}, "", fmt.Errorf("failed to get projects directory: %w", err)
}
- // Ensure the project's path is under the projects root (repair legacy relative paths)
+
if err := s.ensureProjectPathUnderRoot(ctx, &proj, false); err != nil {
- return nil, err
+ return models.Project{}, "", err
}
+ return proj, projectsDirectory, nil
+}
+
+func (s *ProjectService) withProjectRenameRollback(ctx context.Context, proj *models.Project, run func() error) error {
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
+ if err := run(); err != nil {
+ if proj.Path != originalPath {
+ if renameErr := os.Rename(proj.Path, originalPath); renameErr != nil {
+ slog.WarnContext(ctx, "failed to rollback project directory rename", "from", proj.Path, "to", originalPath, "error", renameErr)
+ return err
+ }
+ proj.Path = originalPath
+ proj.DirName = originalDirName
+ }
+ return err
}
+ return nil
+}
+
+func (s *ProjectService) persistUpdatedProjectFiles(ctx context.Context, proj *models.Project, projectsDirectory string, composeContent, envContent *string) error {
switch {
case composeContent != nil:
- // Validate compose content before writing to disk to surface syntax errors early.
- // compose-go can panic on malformed inputs (e.g. invalid depends_on format), so we
- // catch both returned errors and panics here.
- var composeValidateErr error
- validationProjectName := normalizeComposeProjectName(proj.Name)
- func() {
- defer func() {
- if r := recover(); r != nil {
- composeValidateErr = fmt.Errorf("compose file contains invalid syntax: %v", r)
- }
- }()
- cfg := composetypes.ConfigDetails{
- Version: api.ComposeVersion,
- ConfigFiles: []composetypes.ConfigFile{
- {Filename: "compose.yaml", Content: []byte(*composeContent)},
- },
- }
- _, composeValidateErr = loader.LoadWithContext(ctx, cfg, func(opts *loader.Options) {
- if validationProjectName != "" {
- opts.SetProjectName(validationProjectName, true)
- }
- })
- }()
- if composeValidateErr != nil {
- return nil, fmt.Errorf("invalid compose file: %w", composeValidateErr)
+ if err := s.validateComposeContentForUpdate(ctx, proj.Path, proj.Name, *composeContent, envContent); err != nil {
+ return fmt.Errorf("invalid compose file: %w", err)
}
if err := fs.SaveOrUpdateProjectFiles(projectsDirectory, proj.Path, *composeContent, envContent); err != nil {
- return nil, fmt.Errorf("failed to save project files: %w", err)
+ return fmt.Errorf("failed to save project files: %w", err)
}
case envContent != nil:
if err := fs.WriteEnvFile(projectsDirectory, proj.Path, *envContent); err != nil {
- return nil, err
+ return err
}
}
- if err := s.db.WithContext(ctx).Save(&proj).Error; err != nil {
- return nil, fmt.Errorf("failed to update project: %w", err)
+ return nil
+}
+
+func (s *ProjectService) validateComposeContentForUpdate(ctx context.Context, projectPath, projectName, composeContent string, envContent *string) (err error) {
+ cleanup, err := prepareComposeValidationEnvFile(ctx, projectPath, envContent)
+ if err != nil {
+ return err
+ }
+ if cleanup != nil {
+ defer cleanup()
}
- committed = true
- metadata := models.JSON{
- "action": "update",
- "projectID": proj.ID,
- "projectName": proj.Name,
+ defer func() {
+ if recovered := recover(); recovered != nil {
+ err = fmt.Errorf("compose file contains invalid syntax: %v", recovered)
+ }
+ }()
+
+ validationProjectName := normalizeComposeProjectName(projectName)
+ cfg := composetypes.ConfigDetails{
+ Version: api.ComposeVersion,
+ WorkingDir: projectPath,
+ ConfigFiles: []composetypes.ConfigFile{
+ {Filename: filepath.Join(projectPath, "compose.yaml"), Content: []byte(composeContent)},
+ },
}
- if composeContent != nil {
- metadata["composeUpdated"] = true
+
+ _, err = loader.LoadWithContext(ctx, cfg, func(opts *loader.Options) {
+ if validationProjectName != "" {
+ opts.SetProjectName(validationProjectName, true)
+ }
+ })
+
+ return err
+}
+
+func prepareComposeValidationEnvFile(ctx context.Context, projectPath string, envContent *string) (func(), error) {
+ validationEnvPath := filepath.Join(projectPath, ".env")
+ if _, err := os.Stat(validationEnvPath); err == nil {
+ return nil, nil
+ } else if !os.IsNotExist(err) {
+ return nil, fmt.Errorf("failed to stat project env file: %w", err)
}
+
+ validationEnvContent := ""
if envContent != nil {
- metadata["envUpdated"] = true
+ validationEnvContent = *envContent
}
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectUpdate, proj.ID, proj.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project update action", "error", logErr)
+
+ if err := fs.WriteFileWithPerm(validationEnvPath, validationEnvContent, common.FilePerm); err != nil {
+ return nil, fmt.Errorf("failed to prepare env file for compose validation: %w", err)
}
- slog.InfoContext(ctx, "project updated", "projectID", proj.ID, "name", proj.Name)
- return &proj, nil
+ cleanup := func() {
+ if err := os.Remove(validationEnvPath); err != nil && !os.IsNotExist(err) {
+ slog.WarnContext(ctx, "failed to remove temporary env file after compose validation", "path", validationEnvPath, "error", err)
+ }
+ }
+
+ return cleanup, nil
}
func (s *ProjectService) applyProjectRenameIfNeeded(proj *models.Project, name *string, projectsDirectory string) error {
diff --git a/backend/internal/services/project_service_test.go b/backend/internal/services/project_service_test.go
index e7ae2d314..7072540ee 100644
--- a/backend/internal/services/project_service_test.go
+++ b/backend/internal/services/project_service_test.go
@@ -518,6 +518,96 @@ services:
assert.Equal(t, "demo", updated.Name)
}
+func TestProjectService_UpdateProject_AllowsMissingEnvFileDuringComposeValidation(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, nil)
+
+ dirName := "env-required"
+ projectPath := filepath.Join(projectsDir, dirName)
+ require.NoError(t, os.MkdirAll(projectPath, 0o755))
+
+ project := &models.Project{
+ BaseModel: models.BaseModel{ID: "proj-env-file"},
+ Name: "env-required",
+ DirName: &dirName,
+ Path: projectPath,
+ Status: models.ProjectStatusStopped,
+ }
+ require.NoError(t, db.Create(project).Error)
+
+ compose := `services:
+ app:
+ image: nginx:alpine
+ env_file:
+ - .env
+`
+
+ updated, err := svc.UpdateProject(ctx, project.ID, nil, ptr(compose), nil, models.User{
+ BaseModel: models.BaseModel{ID: "u1"},
+ Username: "tester",
+ })
+ require.NoError(t, err)
+ require.NotNil(t, updated)
+
+ _, statErr := os.Stat(filepath.Join(projectPath, ".env"))
+ require.NoError(t, statErr)
+}
+
+func TestProjectService_UpdateProject_UsesExistingEnvFileDuringComposeValidation(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, nil)
+
+ dirName := "env-existing"
+ projectPath := filepath.Join(projectsDir, dirName)
+ require.NoError(t, os.MkdirAll(projectPath, 0o755))
+ require.NoError(t, os.WriteFile(filepath.Join(projectPath, ".env"), []byte("FOO=bar\n"), 0o600))
+
+ project := &models.Project{
+ BaseModel: models.BaseModel{ID: "proj-existing-env-file"},
+ Name: "env-existing",
+ DirName: &dirName,
+ Path: projectPath,
+ Status: models.ProjectStatusStopped,
+ }
+ require.NoError(t, db.Create(project).Error)
+
+ compose := `services:
+ app:
+ image: nginx:alpine
+ env_file:
+ - .env
+`
+
+ updated, err := svc.UpdateProject(ctx, project.ID, nil, ptr(compose), nil, models.User{
+ BaseModel: models.BaseModel{ID: "u1"},
+ Username: "tester",
+ })
+ require.NoError(t, err)
+ require.NotNil(t, updated)
+
+ envBytes, readErr := os.ReadFile(filepath.Join(projectPath, ".env"))
+ require.NoError(t, readErr)
+ assert.Equal(t, "FOO=bar\n", string(envBytes))
+}
+
func TestProjectService_MergeBuildTags(t *testing.T) {
tags := mergeBuildTags("example/app:latest", []string{"example/app:sha", "example/app:latest", " "})
assert.Equal(t, []string{"example/app:latest", "example/app:sha"}, tags)