Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
fix: prevent projects from disappearing when projects folder is unreadable (#2641)
Kyle Mendell65be89dad96a
diff --git a/backend/api/handlers/settings.go b/backend/api/handlers/settings.goindex 74f6a88af..804792562 100644--- a/backend/api/handlers/settings.go+++ b/backend/api/handlers/settings.go@@ -3,7 +3,9 @@ package handlersimport ("context""errors"+ "fmt""net/http"+ "os""strconv""strings"@@ -355,6 +357,21 @@ func (h *SettingsHandler) updateSettingsForRemoteEnvironment(ctx context.Context}func (h *SettingsHandler) updateSettingsForLocalEnvironment(ctx context.Context, input settings.Update) (*UpdateSettingsOutput, error) {+ if input.ProjectsDirectory != nil && *input.ProjectsDirectory != "" {+ currentDir := h.settingsService.GetSettingsConfig().ProjectsDirectory.Value+ if *input.ProjectsDirectory != currentDir {+ resolved, err := projects.GetProjectsDirectory(ctx, strings.TrimSpace(*input.ProjectsDirectory))+ if err != nil {+ return nil, huma.Error400BadRequest(fmt.Sprintf("cannot use projects directory %q: %v", *input.ProjectsDirectory, err))+ }+ f, err := os.Open(resolved)+ if err != nil {+ return nil, huma.Error400BadRequest(fmt.Sprintf("cannot read projects directory %q: %v", resolved, err))+ }+ f.Close()+ }+ }+updatedSettings, err := h.settingsService.UpdateSettings(ctx, input)if err != nil {return nil, huma.Error500InternalServerError((&common.SettingsUpdateError{Err: err}).Error())diff --git a/backend/api/handlers/settings_test.go b/backend/api/handlers/settings_test.goindex 677148ac5..89fa455f2 100644--- a/backend/api/handlers/settings_test.go+++ b/backend/api/handlers/settings_test.go@@ -1,13 +1,23 @@package handlersimport (+ "context"+ "os""path/filepath"+ "runtime"+ "strings""testing"+ "github.com/danielgtaylor/huma/v2""github.com/getarcaneapp/arcane/backend/internal/config"+ "github.com/getarcaneapp/arcane/backend/internal/database"+ "github.com/getarcaneapp/arcane/backend/internal/models"+ "github.com/getarcaneapp/arcane/backend/internal/services""github.com/getarcaneapp/arcane/backend/pkg/libarcane/edge"apitypes "github.com/getarcaneapp/arcane/types/settings"+ glsqlite "github.com/glebarez/sqlite""github.com/stretchr/testify/require"+ "gorm.io/gorm")func TestSettingsHandler_AppendRuntimeSettings(t *testing.T) {@@ -52,6 +62,43 @@ func TestSettingsHandler_AppendRuntimeSettings_DoesNotGenerateEdgeMTLSCA(t *testrequire.NoFileExists(t, filepath.Join(assetsDir, "ca.key"))}+func TestSettingsHandler_UpdateLocalEnvironment_RejectsUnreadableProjectsDirectory(t *testing.T) {+ if runtime.GOOS == "windows" {+ t.Skip("POSIX permission-denied behavior is not portable to Windows")+ }+ if os.Geteuid() == 0 {+ t.Skip("test requires a non-root UID to trigger permission-denied on ReadDir")+ }++ ctx := context.Background()++ db, err := gorm.Open(glsqlite.Open(":memory:"), &gorm.Config{})+ require.NoError(t, err)+ require.NoError(t, db.AutoMigrate(&models.SettingVariable{}))++ settingsSvc, err := services.NewSettingsService(ctx, &database.DB{DB: db})+ require.NoError(t, err)++ originalDir := settingsSvc.GetSettingsConfig().ProjectsDirectory.Value++ unreadable := t.TempDir()+ require.NoError(t, os.Chmod(unreadable, 0))+ t.Cleanup(func() { _ = os.Chmod(unreadable, 0o700) })++ handler := &SettingsHandler{settingsService: settingsSvc, cfg: &config.Config{}}++ dirPtr := unreadable+ _, err = handler.updateSettingsForLocalEnvironment(ctx, apitypes.Update{ProjectsDirectory: &dirPtr})+ require.Error(t, err)++ var statusErr huma.StatusError+ require.ErrorAs(t, err, &statusErr, "expected a huma status error")+ require.Equal(t, 400, statusErr.GetStatus())+ require.True(t, strings.Contains(err.Error(), "cannot read projects directory"), "error message should explain the failure: %s", err.Error())++ require.Equal(t, originalDir, settingsSvc.GetSettingsConfig().ProjectsDirectory.Value, "projectsDirectory must not be persisted on validation failure")+}+func runtimeSettingKeysInternal(settings []apitypes.PublicSetting) map[string]string {keys := make(map[string]string, len(settings))for _, setting := range settings {diff --git a/backend/internal/common/errors.go b/backend/internal/common/errors.goindex 66b7d324e..fa4e23f4c 100644--- a/backend/internal/common/errors.go+++ b/backend/internal/common/errors.go@@ -827,6 +827,19 @@ func (e *ProjectComposeFileNotFoundError) Error() string {return fmt.Sprintf("Project compose file not found: %v", e.Err)}+type ProjectDiscoveryError struct {+ Dir string+ Err error+}++func (e *ProjectDiscoveryError) Error() string {+ return fmt.Sprintf("Failed to discover projects in %q: %v", e.Dir, e.Err)+}++func (e *ProjectDiscoveryError) Unwrap() error {+ return e.Err+}+type ProjectRedeploymentError struct {Err error}diff --git a/backend/internal/services/project_service.go b/backend/internal/services/project_service.goindex e83d1ec5b..a8cd72dc0 100644--- a/backend/internal/services/project_service.go+++ b/backend/internal/services/project_service.go@@ -1489,8 +1489,7 @@ func (s *ProjectService) SyncProjectsFromFileSystem(ctx context.Context) error {if os.IsNotExist(discoveryErr) {return nil}- slog.WarnContext(ctx, "failed to discover projects directory contents", "dir", projectsDir, "error", discoveryErr)- return nil+ return &common.ProjectDiscoveryError{Dir: projectsDir, Err: discoveryErr}}seen := map[string]struct{}{}diff --git a/backend/internal/services/project_service_test.go b/backend/internal/services/project_service_test.goindex 45bff7279..f60620c2f 100644--- a/backend/internal/services/project_service_test.go+++ b/backend/internal/services/project_service_test.go@@ -12,6 +12,7 @@ import ("net/url""os""path/filepath"+ "runtime""strings""testing""time"@@ -3427,6 +3428,47 @@ func TestProjectService_SyncProjectsFromFileSystem_RemovesDeletedNestedProject(tassert.Empty(t, items)}+func TestProjectService_SyncProjectsFromFileSystem_PreservesDBRecordsWhenDirectoryUnreadable(t *testing.T) {+ if runtime.GOOS == "windows" {+ t.Skip("POSIX permission-denied behavior is not portable to Windows")+ }+ if os.Geteuid() == 0 {+ t.Skip("test requires a non-root UID to trigger permission-denied on ReadDir")+ }++ db := setupProjectTestDB(t)+ ctx := context.Background()++ settingsService, err := NewSettingsService(ctx, db)+ require.NoError(t, err)++ projectsRoot := t.TempDir()+ createComposeProjectDir(t, projectsRoot, "project1")++ require.NoError(t, settingsService.SetStringSetting(ctx, "projectsDirectory", projectsRoot))++ svc := NewProjectService(db, settingsService, nil, nil, nil, nil, config.Load())+ require.NoError(t, svc.SyncProjectsFromFileSystem(ctx))++ before, err := svc.ListAllProjects(ctx)+ require.NoError(t, err)+ require.Len(t, before, 1)++ unreadable := t.TempDir()+ require.NoError(t, os.Chmod(unreadable, 0))+ t.Cleanup(func() { _ = os.Chmod(unreadable, 0o700) })++ require.NoError(t, settingsService.SetStringSetting(ctx, "projectsDirectory", unreadable))++ syncErr := svc.SyncProjectsFromFileSystem(ctx)+ require.Error(t, syncErr, "sync should propagate the permission-denied error")++ after, err := svc.ListAllProjects(ctx)+ require.NoError(t, err)+ assert.Len(t, after, 1, "DB records must not be wiped when discovery fails")+ assert.Equal(t, before[0].Path, after[0].Path)+}+func TestProjectService_SyncProjectsFromFileSystem_AllowsDuplicateLeafDirectoriesInDifferentParents(t *testing.T) {db := setupProjectTestDB(t)ctx := context.Background()