Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
fix: hide phantom projects from showing in the frontend when deleted (#3136)
Kyle Mendellfd24f8104c5e
diff --git a/backend/internal/bootstrap/bootstrap.go b/backend/internal/bootstrap/bootstrap.goindex 4266efcd6..0403549a0 100644--- a/backend/internal/bootstrap/bootstrap.go+++ b/backend/internal/bootstrap/bootstrap.go@@ -145,16 +145,6 @@ func initializeStartupState(appCtx context.Context, cfg *config.Config, appServiAgentMode: cfg.AgentMode,})startup.InitializeDefaultSettings(appCtx, runtimeCfg, appServices.Settings)- if appServices.GitOpsSync != nil {- // Sweep leaked gitops scratch dirs before the filesystem watcher can import- // them as phantom projects and before the directory-sync reconcile runs.- if err := appServices.GitOpsSync.CleanupLeakedScratchDirsOnStartup(appCtx); err != nil {- slog.WarnContext(appCtx, "Failed to clean up leaked GitOps scratch directories on startup", "error", err)- }- if err := appServices.GitOpsSync.ReconcileDirectorySyncProjectsOnStartup(appCtx); err != nil {- slog.WarnContext(appCtx, "Failed to reconcile directory GitOps projects on startup", "error", err)- }- }if err := appServices.Settings.NormalizeProjectsDirectory(appCtx, cfg.ProjectsDirectory); err != nil {slog.WarnContext(appCtx, "Failed to normalize projects directory", "error", err)@@ -167,6 +157,7 @@ func initializeStartupState(appCtx context.Context, cfg *config.Config, appServiif err := appServices.Environment.EnsureLocalEnvironment(appCtx, cfg.AppUrl); err != nil {slog.WarnContext(appCtx, "Failed to ensure local environment", "error", err)}+ initializeGitOpsStartupStateInternal(appCtx, appServices.GitOpsSync)if appServices.Project != nil {if err := appServices.Project.RecoverProjectRenameJournals(appCtx); err != nil {slog.WarnContext(appCtx, "Failed to recover interrupted project rename operations on startup", "error", err)@@ -233,6 +224,23 @@ func initializeStartupState(appCtx context.Context, cfg *config.Config, appServi}}+func initializeGitOpsStartupStateInternal(appCtx context.Context, gitOpsSync *services.GitOpsSyncService) {+ if gitOpsSync == nil {+ return+ }+ if err := gitOpsSync.CleanupOrphanedSyncsOnStartup(appCtx); err != nil {+ slog.WarnContext(appCtx, "Failed to clean up orphaned GitOps syncs on startup", "error", err)+ }+ // Sweep leaked gitops scratch dirs before the filesystem watcher can import+ // them as phantom projects and before the directory-sync reconcile runs.+ if err := gitOpsSync.CleanupLeakedScratchDirsOnStartup(appCtx); err != nil {+ slog.WarnContext(appCtx, "Failed to clean up leaked GitOps scratch directories on startup", "error", err)+ }+ if err := gitOpsSync.ReconcileDirectorySyncProjectsOnStartup(appCtx); err != nil {+ slog.WarnContext(appCtx, "Failed to reconcile directory GitOps projects on startup", "error", err)+ }+}+func runRoleStartupTasks(ctx context.Context, roleService *services.RoleService, cfg *config.Config, agentMode bool) {if roleService == nil {returndiff --git a/backend/internal/services/environment_service.go b/backend/internal/services/environment_service.goindex f5e86e070..f4c913a88 100644--- a/backend/internal/services/environment_service.go+++ b/backend/internal/services/environment_service.go@@ -1038,11 +1038,42 @@ func (s *EnvironmentService) DeleteEnvironment(ctx context.Context, id string, u// Stop the per-environment health job before the row is removed.s.removeHealthJobInternal(ctx, id)- if err := s.db.WithContext(ctx).Delete(&models.Environment{}, "id = ?", id).Error; err != nil {+ var syncIDs []string+ if err := s.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {+ if err := tx.Model(&models.GitOpsSync{}).+ Where("environment_id = ?", id).+ Pluck("id", &syncIDs).Error; err != nil {+ return fmt.Errorf("failed to list environment gitops syncs: %w", err)+ }++ if len(syncIDs) > 0 {+ if err := tx.Model(&models.Project{}).+ Where("gitops_managed_by IN ?", syncIDs).+ Update("gitops_managed_by", nil).Error; err != nil {+ return fmt.Errorf("failed to clear environment gitops project references: %w", err)+ }+ if err := tx.Where("environment_id = ?", id).Delete(&models.GitOpsSync{}).Error; err != nil {+ return fmt.Errorf("failed to delete environment gitops syncs: %w", err)+ }+ }++ if err := tx.Delete(&models.Environment{}, "id = ?", id).Error; err != nil {+ return fmt.Errorf("failed to delete environment: %w", err)+ }++ return nil+ }); err != nil {if env.Enabled {s.registerHealthJobInternal(ctx, env.ID)}- return fmt.Errorf("failed to delete environment: %w", err)+ return err+ }++ if s.scheduler != nil {+ schedulerCtx := s.schedulerCtxInternal(ctx)+ for _, syncID := range syncIDs {+ s.scheduler.RemoveJob(schedulerCtx, gitOpsSyncJobNameInternal(syncID))+ }}s.invalidateEnvironmentTokenInternal(id)diff --git a/backend/internal/services/environment_service_test.go b/backend/internal/services/environment_service_test.goindex 9a037d8ff..77eef8ff5 100644--- a/backend/internal/services/environment_service_test.go+++ b/backend/internal/services/environment_service_test.go@@ -41,6 +41,8 @@ func setupEnvironmentServiceTestDB(t *testing.T) *database.DB {&models.SettingVariable{},&models.User{},&models.ApiKey{},+ &models.Project{},+ &models.GitOpsSync{},))sqlDB, err := db.DB()@@ -120,6 +122,46 @@ func createTestEnvironmentWithState(t *testing.T, db *database.DB, id, apiURL, srequire.NoError(t, db.WithContext(context.Background()).Create(env).Error)}+func TestEnvironmentService_DeleteEnvironment_CascadesGitOpsSyncs(t *testing.T) {+ ctx := context.Background()+ db := setupEnvironmentServiceTestDB(t)+ require.NoError(t, db.AutoMigrate(&models.Project{}, &models.GitOpsSync{}))++ createTestEnvironment(t, db, "env-delete-gitops", "http://env.example", nil)+ syncID := "sync-delete-env"+ require.NoError(t, db.Create(&models.GitOpsSync{+ BaseModel: models.BaseModel{ID: syncID},+ Name: "delete-env-sync",+ EnvironmentID: "env-delete-gitops",+ RepositoryID: "repo-1",+ ComposePath: "compose.yml",+ ProjectName: "demo",+ SyncInterval: 15,+ }).Error)+ require.NoError(t, db.Create(&models.Project{+ BaseModel: models.BaseModel{ID: "project-managed-by-deleted-env"},+ Name: "demo",+ Path: "/tmp/demo",+ Status: models.ProjectStatusStopped,+ GitOpsManagedBy: &syncID,+ }).Error)++ scheduler := &gitOpsSyncTestSchedulerInternal{}+ svc := NewEnvironmentService(db, nil, nil, nil, nil, nil)+ svc.SetScheduler(ctx, scheduler)++ require.NoError(t, svc.DeleteEnvironment(ctx, "env-delete-gitops", nil, nil))++ var syncCount int64+ require.NoError(t, db.Model(&models.GitOpsSync{}).Where("id = ?", syncID).Count(&syncCount).Error)+ require.Zero(t, syncCount)++ var project models.Project+ require.NoError(t, db.First(&project, "id = ?", "project-managed-by-deleted-env").Error)+ require.Nil(t, project.GitOpsManagedBy)+ require.Contains(t, scheduler.removed, gitOpsSyncJobNameInternal(syncID))+}+func createTestRegistry(t *testing.T, db *database.DB, id string) {t.Helper()diff --git a/backend/internal/services/gitops_sync_service.go b/backend/internal/services/gitops_sync_service.goindex c0a71264d..c95cd678b 100644--- a/backend/internal/services/gitops_sync_service.go+++ b/backend/internal/services/gitops_sync_service.go@@ -458,7 +458,7 @@ func (s *GitOpsSyncService) RegisterAutoSyncJobsOnStartup(ctx context.Context) {}var syncs []models.GitOpsSyncif err := s.db.WithContext(ctx).- Where("auto_sync = ?", true).+ Where("auto_sync = ? AND environment_id IN (SELECT id FROM environments)", true).Find(&syncs).Error; err != nil {slog.ErrorContext(ctx, "Failed to load auto-sync jobs on startup", "error", err)return@@ -1266,6 +1266,35 @@ func (s *GitOpsSyncService) CleanupLeakedScratchDirsOnStartup(ctx context.Contexreturn nil}+func (s *GitOpsSyncService) CleanupOrphanedSyncsOnStartup(ctx context.Context) error {+ var syncIDs []string+ if err := s.db.WithContext(ctx).Model(&models.GitOpsSync{}).+ Where("environment_id NOT IN (SELECT id FROM environments)").+ Pluck("id", &syncIDs).Error; err != nil {+ return fmt.Errorf("failed to list orphaned gitops syncs: %w", err)+ }+ if len(syncIDs) == 0 {+ return nil+ }++ if err := s.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {+ if err := tx.Model(&models.Project{}).+ Where("gitops_managed_by IN ?", syncIDs).+ Update("gitops_managed_by", nil).Error; err != nil {+ return fmt.Errorf("failed to clear orphaned gitops project references: %w", err)+ }+ if err := tx.Where("id IN ?", syncIDs).Delete(&models.GitOpsSync{}).Error; err != nil {+ return fmt.Errorf("failed to delete orphaned gitops syncs: %w", err)+ }+ return nil+ }); err != nil {+ return err+ }++ slog.InfoContext(ctx, "Cleaned up orphaned GitOps syncs on startup", "syncIds", syncIDs)+ return nil+}+func (s *GitOpsSyncService) ReconcileDirectorySyncProjectsOnStartup(ctx context.Context) error {var syncs []models.GitOpsSyncif err := s.db.WithContext(ctx).diff --git a/backend/internal/services/gitops_sync_service_test.go b/backend/internal/services/gitops_sync_service_test.goindex 68bf0e4fd..f2a5d812f 100644--- a/backend/internal/services/gitops_sync_service_test.go+++ b/backend/internal/services/gitops_sync_service_test.go@@ -7,6 +7,7 @@ import ("os""path/filepath""testing"+ "time""github.com/getarcaneapp/arcane/backend/v2/internal/common""github.com/getarcaneapp/arcane/backend/v2/internal/config"@@ -41,10 +42,12 @@ func setupGitOpsSyncDirectoryTestService(t *testing.T) (*GitOpsSyncService, *dat}type gitOpsSyncTestSchedulerInternal struct {+ added []stringremoved []string}-func (s *gitOpsSyncTestSchedulerInternal) AddJob(_ context.Context, _ schedulertypes.Job) error {+func (s *gitOpsSyncTestSchedulerInternal) AddJob(_ context.Context, job schedulertypes.Job) error {+ s.added = append(s.added, job.Name())return nil}@@ -91,6 +94,98 @@ func TestGitOpsSyncService_GetSyncByID_ReturnsNotFoundError(t *testing.T) {require.ErrorAs(t, err, ¬Found)}+func TestGitOpsSyncService_CleanupOrphanedSyncsOnStartup_DeletesOnlyOrphans(t *testing.T) {+ ctx := context.Background()+ svc, db, _ := setupGitOpsSyncDirectoryTestService(t)+ require.NoError(t, db.AutoMigrate(&models.Environment{}))++ require.NoError(t, db.Create(&models.Environment{+ BaseModel: models.BaseModel{ID: "env-live"},+ Name: "Live",+ }).Error)+ orphanSyncID := "sync-orphan"+ liveSyncID := "sync-live"+ require.NoError(t, db.Create(&models.GitOpsSync{+ BaseModel: models.BaseModel{ID: orphanSyncID},+ Name: "orphan",+ EnvironmentID: "env-missing",+ RepositoryID: "repo-1",+ ComposePath: "compose.yml",+ ProjectName: "orphan",+ SyncInterval: 15,+ }).Error)+ require.NoError(t, db.Create(&models.GitOpsSync{+ BaseModel: models.BaseModel{ID: liveSyncID},+ Name: "live",+ EnvironmentID: "env-live",+ RepositoryID: "repo-1",+ ComposePath: "compose.yml",+ ProjectName: "live",+ SyncInterval: 15,+ }).Error)+ require.NoError(t, db.Create(&models.Project{+ BaseModel: models.BaseModel{ID: "project-orphan"},+ Name: "orphan",+ Path: "/tmp/orphan",+ Status: models.ProjectStatusStopped,+ GitOpsManagedBy: &orphanSyncID,+ }).Error)++ require.NoError(t, svc.CleanupOrphanedSyncsOnStartup(ctx))++ var orphanCount int64+ require.NoError(t, db.Model(&models.GitOpsSync{}).Where("id = ?", orphanSyncID).Count(&orphanCount).Error)+ require.Zero(t, orphanCount)++ var liveCount int64+ require.NoError(t, db.Model(&models.GitOpsSync{}).Where("id = ?", liveSyncID).Count(&liveCount).Error)+ require.EqualValues(t, 1, liveCount)++ var project models.Project+ require.NoError(t, db.First(&project, "id = ?", "project-orphan").Error)+ require.Nil(t, project.GitOpsManagedBy)+}++func TestGitOpsSyncService_RegisterAutoSyncJobsOnStartup_SkipsOrphans(t *testing.T) {+ ctx := context.Background()+ svc, db, _ := setupGitOpsSyncDirectoryTestService(t)+ require.NoError(t, db.AutoMigrate(&models.Environment{}))++ require.NoError(t, db.Create(&models.Environment{+ BaseModel: models.BaseModel{ID: "env-live"},+ Name: "Live",+ }).Error)+ require.NoError(t, db.Create(&models.GitOpsSync{+ BaseModel: models.BaseModel{ID: "sync-orphan"},+ Name: "orphan",+ EnvironmentID: "env-missing",+ RepositoryID: "repo-1",+ ComposePath: "compose.yml",+ ProjectName: "orphan",+ AutoSync: true,+ SyncInterval: 15,+ }).Error)+ now := time.Now()+ require.NoError(t, db.Create(&models.GitOpsSync{+ BaseModel: models.BaseModel{ID: "sync-live"},+ Name: "live",+ EnvironmentID: "env-live",+ RepositoryID: "repo-1",+ ComposePath: "compose.yml",+ ProjectName: "live",+ AutoSync: true,+ SyncInterval: 15,+ LastSyncAt: &now,+ }).Error)++ scheduler := &gitOpsSyncTestSchedulerInternal{}+ svc.SetScheduler(ctx, scheduler)+ svc.RegisterAutoSyncJobsOnStartup(ctx)++ require.Equal(t, []string{gitOpsSyncJobNameInternal("sync-live")}, scheduler.added)+ require.Empty(t, scheduler.removed)+}+func TestGitOpsSyncService_DeleteSync_DeletesStaleProjectReference(t *testing.T) {ctx := context.Background()svc, db, _ := setupGitOpsSyncDirectoryTestService(t)diff --git a/backend/internal/services/project_service.go b/backend/internal/services/project_service.goindex cb7087e2b..8ab113456 100644--- a/backend/internal/services/project_service.go+++ b/backend/internal/services/project_service.go@@ -2350,6 +2350,19 @@ func (s *ProjectService) DestroyProject(ctx context.Context, projectID string, rif err := s.db.WithContext(ctx).Delete(proj).Error; err != nil {return fmt.Errorf("failed to delete project from database: %w", err)}++ if !removeFiles {+ if projectsDir, dirErr := s.getProjectsDirectoryInternal(ctx); dirErr != nil {+ slog.WarnContext(ctx, "Failed to resolve projects directory for quarantine", "error", dirErr)+ } else if projects.IsSafeSubdirectory(projectsDir, proj.Path) && filepath.Clean(projectsDir) != filepath.Clean(proj.Path) {+ trashPath := filepath.Join(filepath.Dir(proj.Path), fmt.Sprintf(".arcane-trash-%s-%d", filepath.Base(proj.Path), time.Now().Unix()))+ if err := os.Rename(proj.Path, trashPath); err != nil {+ slog.WarnContext(ctx, "Failed to quarantine project files", "path", proj.Path, "trashPath", trashPath, "error", err)+ } else {+ slog.InfoContext(ctx, "Project files quarantined successfully", "path", proj.Path, "trashPath", trashPath)+ }+ }+ }s.invalidateComposeCacheInternal(projectID)writeProjectProgressInternal(ctx, "Project destroyed", 100, "complete")diff --git a/backend/internal/services/project_service_test.go b/backend/internal/services/project_service_test.goindex 92a19230f..b99c64d23 100644--- a/backend/internal/services/project_service_test.go+++ b/backend/internal/services/project_service_test.go@@ -141,8 +141,15 @@ func TestProjectService_DestroyProject_PreservesFilesWhenRequested(t *testing.T)require.NoError(t, svc.DestroyProject(ctx, project.ID, false, false, models.User{}))- assert.DirExists(t, projectPath)- assert.FileExists(t, projectDataPath)+ assert.NoDirExists(t, projectPath)+ assert.NoFileExists(t, projectDataPath)++ entries, err := os.ReadDir(projectsDir)+ require.NoError(t, err)+ require.Len(t, entries, 1)+ trashName := entries[0].Name()+ require.True(t, strings.HasPrefix(trashName, ".arcane-trash-demo-preserve-"), "trash dir name: %s", trashName)+ assert.FileExists(t, filepath.Join(projectsDir, trashName, "project-data.txt"))}func newProjectImagePullServerWithObserverInternal(t *testing.T, inspectByRef map[string]dockertypesimage.InspectResponse, onPull func(fullRef string, authHeader string)) *httptest.Server {diff --git a/backend/pkg/projects/discovery.go b/backend/pkg/projects/discovery.goindex 5817d6180..804c04ac4 100644--- a/backend/pkg/projects/discovery.go+++ b/backend/pkg/projects/discovery.go@@ -87,8 +87,11 @@ func DiscoverProjectDirectories(root string, followSymlinks bool, maxDepth int)}func walkProjectDirectoriesInternal(path string, isRoot bool, currentDepth int, maxDepth int, followSymlinks bool, ancestors map[string]struct{}, discovered *[]DiscoveredProjectDir) error {- if !isRoot && IsInternalScratchDirName(filepath.Base(path)) {- return nil+ if !isRoot {+ base := filepath.Base(path)+ if strings.HasPrefix(base, ".arcane-trash-") || IsInternalScratchDirName(base) {+ return nil+ }}identity, err := ResolveDirectoryIdentityInternal(path)diff --git a/backend/pkg/projects/discovery_test.go b/backend/pkg/projects/discovery_test.goindex 53522e0fa..6c59db051 100644--- a/backend/pkg/projects/discovery_test.go+++ b/backend/pkg/projects/discovery_test.go@@ -195,3 +195,14 @@ func TestDiscoverProjectDirectories_SkipsGitOpsScratchDirs(t *testing.T) {names := discoveredNamesInternal(discoverProjectDirectoriesInternal(t, root))require.ElementsMatch(t, []string{"app", "notes.gitops-backup-final"}, names)}++func TestDiscoverProjectDirectories_SkipsArcaneTrashDirs(t *testing.T) {+ root := t.TempDir()++ writeComposeFileInternal(t, filepath.Join(root, "app"))+ writeComposeFileInternal(t, filepath.Join(root, ".arcane-trash-app-1234567890"))+ writeComposeFileInternal(t, filepath.Join(root, ".hidden"))++ names := discoveredNamesInternal(discoverProjectDirectoriesInternal(t, root))+ require.ElementsMatch(t, []string{"app", ".hidden"}, names)+}diff --git a/types/project/project.go b/types/project/project.goindex 5e056fb97..19f4203a5 100644--- a/types/project/project.go+++ b/types/project/project.go@@ -611,6 +611,8 @@ type Details struct {// Destroy is used to destroy a project.type Destroy struct {// RemoveFiles indicates if project files should be removed. Defaults to true when omitted.+ // When false and the project is stored under the projects directory, files are renamed+ // to a hidden .arcane-trash-* directory so filesystem discovery does not re-import them.//// Required: falseRemoveFiles *bool `json:"removeFiles,omitempty"`