Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
fix: global env not be resolved on project edits (#2097)
Kyle Mendell1a863c469ca8
diff --git a/backend/internal/services/project_service.go b/backend/internal/services/project_service.goindex c3744de7f..3df6b9c53 100644--- a/backend/internal/services/project_service.go+++ b/backend/internal/services/project_service.go@@ -13,6 +13,7 @@ import ("strings""time"+ "github.com/compose-spec/compose-go/v2/dotenv""github.com/compose-spec/compose-go/v2/loader"composetypes "github.com/compose-spec/compose-go/v2/types""github.com/docker/compose/v5/pkg/api"@@ -1874,7 +1875,7 @@ func (s *ProjectService) ApplyGitSyncProjectFiles(ctx context.Context, projectIDreturn nil, fmt.Errorf("failed to resolve git env state: %w", err)}- if err := s.validateComposeContentForUpdate(ctx, proj.Path, proj.Name, composeContent, envUpdate.effectiveContent); err != nil {+ if err := s.validateComposeContentForUpdate(ctx, projectsDirectory, proj.Path, proj.Name, composeContent, envUpdate.effectiveContent); err != nil {return nil, fmt.Errorf("invalid compose file: %w", err)}@@ -1952,7 +1953,7 @@ func (s *ProjectService) persistUpdatedProjectFiles(ctx context.Context, proj *mif err != nil {return fmt.Errorf("invalid compose file: %w", err)}- if err := s.validateComposeContentForUpdate(ctx, proj.Path, proj.Name, *composeContent, effectiveEnvContent); err != nil {+ if err := s.validateComposeContentForUpdate(ctx, projectsDirectory, proj.Path, proj.Name, *composeContent, effectiveEnvContent); err != nil {return fmt.Errorf("invalid compose file: %w", err)}if err := projects.WriteComposeFile(projectsDirectory, proj.Path, *composeContent); err != nil {@@ -1974,35 +1975,16 @@ func (s *ProjectService) persistUpdatedProjectFiles(ctx context.Context, proj *mreturn nil}-func (s *ProjectService) validateComposeContentForUpdate(ctx context.Context, projectPath, projectName, composeContent string, effectiveEnvContent *string) (err error) {+func (s *ProjectService) validateComposeContentForUpdate(ctx context.Context, projectsDirectory, projectPath, projectName, composeContent string, effectiveEnvContent *string) (err error) {defer func() {if recovered := recover(); recovered != nil {err = fmt.Errorf("compose file contains invalid syntax: %v", recovered)}}()- // Load safe environment variables for ${VAR} interpolation during validation.- // Only the project's own .env is used — host process env and .env.global are- // both intentionally excluded to prevent leaking Arcane secrets.- fullEnvMap := make(projects.EnvMap)- if absWorkdir, absErr := filepath.Abs(projectPath); absErr == nil {- fullEnvMap["PWD"] = absWorkdir- }-- // Prefer the provided effective environment content if available, otherwise read from disk.- if effectiveEnvContent != nil {- if fileEnv, envErr := projects.ParseProjectEnvContent(*effectiveEnvContent, fullEnvMap); envErr != nil {- return fmt.Errorf("parse provided env content: %w", envErr)- } else {- maps.Copy(fullEnvMap, fileEnv)- }- } else {- projectEnvPath := filepath.Join(projectPath, ".env")- if fileEnv, envErr := projects.ParseProjectEnvFile(projectEnvPath, fullEnvMap); envErr != nil {- return fmt.Errorf("parse project env file: %w", envErr)- } else {- maps.Copy(fullEnvMap, fileEnv)- }+ fullEnvMap, envErr := buildComposeValidationEnvironment(projectsDirectory, projectPath, effectiveEnvContent)+ if envErr != nil {+ return envErr}validationProjectName := normalizeComposeProjectName(projectName)@@ -2027,6 +2009,72 @@ func (s *ProjectService) validateComposeContentForUpdate(ctx context.Context, prreturn err}+func buildComposeValidationEnvironment(projectsDirectory, projectPath string, effectiveEnvContent *string) (projects.EnvMap, error) {+ // Validation should match project-visible env sources without inheriting the+ // Arcane process environment, which may contain unrelated secrets.+ fullEnvMap := make(projects.EnvMap)+ if absWorkdir, absErr := filepath.Abs(projectPath); absErr == nil {+ fullEnvMap["PWD"] = absWorkdir+ } else {+ fullEnvMap["PWD"] = projectPath+ }++ globalEnvPath := filepath.Join(projectsDirectory, projects.GlobalEnvFileName)+ globalEnv, err := parseComposeValidationEnvFile(globalEnvPath, fullEnvMap)+ if err != nil {+ return nil, fmt.Errorf("parse global env file: %w", err)+ }+ maps.Copy(fullEnvMap, globalEnv)++ if effectiveEnvContent != nil {+ projectEnv, err := parseComposeValidationEnvContent(*effectiveEnvContent, fullEnvMap)+ if err != nil {+ return nil, fmt.Errorf("parse provided env content: %w", err)+ }+ maps.Copy(fullEnvMap, projectEnv)+ return fullEnvMap, nil+ }++ projectEnvPath := filepath.Join(projectPath, ".env")+ projectEnv, err := parseComposeValidationEnvFile(projectEnvPath, fullEnvMap)+ if err != nil {+ return nil, fmt.Errorf("parse project env file: %w", err)+ }+ maps.Copy(fullEnvMap, projectEnv)++ return fullEnvMap, nil+}++func parseComposeValidationEnvFile(path string, contextEnv projects.EnvMap) (projects.EnvMap, error) {+ if _, err := os.Stat(path); err != nil {+ if os.IsNotExist(err) {+ return nil, nil+ }+ return nil, fmt.Errorf("stat file: %w", err)+ }++ content, err := os.ReadFile(path)+ if err != nil {+ return nil, fmt.Errorf("read file: %w", err)+ }++ return parseComposeValidationEnvContent(string(content), contextEnv)+}++func parseComposeValidationEnvContent(content string, contextEnv projects.EnvMap) (projects.EnvMap, error) {+ lookupFn := func(key string) (string, bool) {+ value, ok := contextEnv[key]+ return value, ok+ }++ envMap, err := dotenv.ParseWithLookup(strings.NewReader(content), lookupFn)+ if err != nil {+ return nil, fmt.Errorf("parse env: %w", err)+ }++ return projects.EnvMap(envMap), nil+}+func withTransientValidationEnvFile(projectPath string, effectiveEnvContent *string, run func() error) (err error) {envPath := filepath.Join(projectPath, ".env")originalContent, readErr := os.ReadFile(envPath)diff --git a/backend/internal/services/project_service_test.go b/backend/internal/services/project_service_test.goindex 527c96b54..a98343970 100644--- a/backend/internal/services/project_service_test.go+++ b/backend/internal/services/project_service_test.go@@ -716,6 +716,97 @@ func TestProjectService_UpdateProject_ReturnsEnvParseErrorDuringComposeValidatioassert.Contains(t, err.Error(), "parse env")}+func TestProjectService_UpdateProject_UsesGlobalEnvDuringComposeValidation(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 := "global-env-update"+ projectPath := filepath.Join(projectsDir, dirName)+ require.NoError(t, os.MkdirAll(projectPath, 0o755))+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, projects.GlobalEnvFileName), []byte("DATA_NAS_FOLDER=/srv/media\nMYPATH=/containers/\n"), 0o600))++ project := &models.Project{+ BaseModel: models.BaseModel{ID: "proj-global-env-update"},+ Name: dirName,+ DirName: &dirName,+ Path: projectPath,+ Status: models.ProjectStatusStopped,+ }+ require.NoError(t, db.Create(project).Error)++ compose := `services:+ cats:+ image: mikesir87/cats:1.0+ volumes:+ - ${DATA_NAS_FOLDER}:/data+ - ${MYPATH}cats/templates:/app/templates+`++ updated, err := svc.UpdateProject(ctx, project.ID, nil, new(compose), nil, models.User{+ BaseModel: models.BaseModel{ID: "u1"},+ Username: "tester",+ })+ require.NoError(t, err)+ require.NotNil(t, updated)++ composeBytes, readErr := os.ReadFile(filepath.Join(projectPath, "compose.yaml"))+ require.NoError(t, readErr)+ assert.Equal(t, compose, string(composeBytes))+}++func TestProjectService_UpdateProject_DoesNotResolveHostEnvThroughGlobalEnvDuringComposeValidation(t *testing.T) {+ db := setupProjectTestDB(t)+ ctx := context.Background()++ projectsDir := t.TempDir()+ t.Setenv("PROJECTS_DIRECTORY", projectsDir)+ t.Setenv("HOST_ONLY_PATH", "/host/secret")++ settingsService, err := NewSettingsService(ctx, db)+ require.NoError(t, err)++ eventService := NewEventService(db, nil, nil)+ svc := NewProjectService(db, settingsService, eventService, nil, nil, nil)++ dirName := "host-env-guard"+ projectPath := filepath.Join(projectsDir, dirName)+ require.NoError(t, os.MkdirAll(projectPath, 0o755))+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, projects.GlobalEnvFileName), []byte("DATA_NAS_FOLDER=${HOST_ONLY_PATH}\n"), 0o600))++ project := &models.Project{+ BaseModel: models.BaseModel{ID: "proj-host-env-guard"},+ Name: dirName,+ DirName: &dirName,+ Path: projectPath,+ Status: models.ProjectStatusStopped,+ }+ require.NoError(t, db.Create(project).Error)++ compose := `services:+ app:+ image: nginx:alpine+ volumes:+ - ${DATA_NAS_FOLDER}:/data+`++ updated, err := svc.UpdateProject(ctx, project.ID, nil, new(compose), nil, models.User{+ BaseModel: models.BaseModel{ID: "u1"},+ Username: "tester",+ })+ require.Error(t, err)+ assert.Nil(t, updated)+ assert.Contains(t, err.Error(), "invalid compose file")+}+func TestProjectService_UpdateProject_DerivesProjectOverrideEnvWhenGitSourceExists(t *testing.T) {db := setupProjectTestDB(t)ctx := context.Background()@@ -1007,6 +1098,53 @@ func TestProjectService_ApplyGitSyncProjectFiles_RemovesGitEnvSource(t *testing.assert.Equal(t, "BASE=git\n", string(effectiveBytes))}+func TestProjectService_ApplyGitSyncProjectFiles_UsesGlobalEnvDuringComposeValidation(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 := "git-sync-global-env"+ projectPath := filepath.Join(projectsDir, dirName)+ require.NoError(t, os.MkdirAll(projectPath, 0o755))+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, projects.GlobalEnvFileName), []byte("DATA_NAS_FOLDER=/srv/media\nMYPATH=/containers/\n"), 0o600))++ project := &models.Project{+ BaseModel: models.BaseModel{ID: "proj-git-sync-global-env"},+ Name: dirName,+ DirName: &dirName,+ Path: projectPath,+ Status: models.ProjectStatusStopped,+ }+ require.NoError(t, db.Create(project).Error)++ compose := `services:+ cats:+ image: mikesir87/cats:1.0+ volumes:+ - ${DATA_NAS_FOLDER}:/data+ - ${MYPATH}cats/templates:/app/templates+`++ updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, compose, nil, models.User{+ BaseModel: models.BaseModel{ID: "u1"},+ Username: "tester",+ })+ require.NoError(t, err)+ require.NotNil(t, updated)++ composeBytes, readErr := os.ReadFile(filepath.Join(projectPath, "compose.yaml"))+ require.NoError(t, readErr)+ assert.Equal(t, compose, string(composeBytes))+}+func TestProjectService_PersistGitSyncEnvFiles_UsesPreparedState(t *testing.T) {db := setupProjectTestDB(t)ctx := context.Background()