Skip to content

Modern Docker Management, Designed for Everyone

refactor: streamline project service with better reusable functions (#3157)

Kyle Mendell0feb10072237
diff --git a/backend/internal/services/gitops_sync_service.go b/backend/internal/services/gitops_sync_service.go
index a48e22959..2ba74b79e 100644
--- a/backend/internal/services/gitops_sync_service.go
+++ b/backend/internal/services/gitops_sync_service.go
@@ -2010,7 +2010,7 @@ func (s *GitOpsSyncService) ensureDirectorySyncProjectLinkedInternal(ctx context
}
if sync.ProjectID != nil && *sync.ProjectID == project.ID && project.GitOpsManagedBy != nil && *project.GitOpsManagedBy == sync.ID {
- s.projectService.cacheComposeProjectIDInternal(normalizeComposeProjectName(project.Name), project.ID)
+ s.projectService.cacheComposeProjectIDInternal(projects.NormalizeProjectName(project.Name), project.ID)
return nil
}
@@ -2024,7 +2024,7 @@ func (s *GitOpsSyncService) ensureDirectorySyncProjectLinkedInternal(ctx context
}
if len(updatesSync) == 0 && len(updatesProject) == 0 {
- s.projectService.cacheComposeProjectIDInternal(normalizeComposeProjectName(project.Name), project.ID)
+ s.projectService.cacheComposeProjectIDInternal(projects.NormalizeProjectName(project.Name), project.ID)
return nil
}
@@ -2046,7 +2046,7 @@ func (s *GitOpsSyncService) ensureDirectorySyncProjectLinkedInternal(ctx context
sync.ProjectID = &project.ID
project.GitOpsManagedBy = &sync.ID
- s.projectService.cacheComposeProjectIDInternal(normalizeComposeProjectName(project.Name), project.ID)
+ s.projectService.cacheComposeProjectIDInternal(projects.NormalizeProjectName(project.Name), project.ID)
return nil
}
@@ -2168,7 +2168,7 @@ func (s *GitOpsSyncService) createRecoveredProjectFromDirectoryInternal(ctx cont
}
sync.ProjectID = &project.ID
- s.projectService.cacheComposeProjectIDInternal(normalizeComposeProjectName(project.Name), project.ID)
+ s.projectService.cacheComposeProjectIDInternal(projects.NormalizeProjectName(project.Name), project.ID)
return project, nil
}
@@ -2275,7 +2275,7 @@ func (s *GitOpsSyncService) validateDirectorySyncStageInternal(ctx context.Conte
project, err := projects.LoadComposeProjectLenient(
ctx,
filepath.Join(stagePath, composeFileName),
- normalizeComposeProjectName(projectName),
+ projects.NormalizeProjectName(projectName),
projectsDir,
autoInjectEnv,
pathMapper,
@@ -2348,7 +2348,7 @@ func (s *GitOpsSyncService) createDirectorySyncProjectInternal(ctx context.Conte
}
sync.ProjectID = &project.ID
- s.projectService.cacheComposeProjectIDInternal(normalizeComposeProjectName(project.Name), project.ID)
+ s.projectService.cacheComposeProjectIDInternal(projects.NormalizeProjectName(project.Name), project.ID)
if s.projectService.eventService != nil {
metadata := models.JSON{"action": "create", "projectID": project.ID, "projectName": project.Name, "path": projectPath}
diff --git a/backend/internal/services/project_service.go b/backend/internal/services/project_service.go
index caff0a521..17b047db1 100644
--- a/backend/internal/services/project_service.go
+++ b/backend/internal/services/project_service.go
@@ -38,7 +38,6 @@ import (
"github.com/getarcaneapp/arcane/types/v2/project"
"github.com/moby/moby/api/types/container"
"github.com/moby/moby/client"
- contextsource "go.getarcane.app/builds/pkg/utils/contextsource"
buildtypes "go.getarcane.app/builds/types"
libupdater "go.getarcane.app/updater/pkg/labels"
"gorm.io/gorm"
@@ -176,6 +175,46 @@ func (s *ProjectService) getProjectsDirectoryInternal(ctx context.Context) (stri
return filepath.Clean(projectsDir), nil
}
+func (s *ProjectService) getProjectsDirectoryOrDefaultInternal(ctx context.Context, cfg *models.Settings) string {
+ projectsDirectory, err := projects.GetProjectsDirectory(ctx, strings.TrimSpace(cfg.ProjectsDirectory.Value))
+ if err != nil {
+ slog.WarnContext(ctx, "unable to determine projects directory; using default", "error", err)
+ return "/app/data/projects"
+ }
+ return projectsDirectory
+}
+
+func (s *ProjectService) getMutableProjectInternal(ctx context.Context, projectID string) (*models.Project, error) {
+ proj, err := s.GetProjectFromDatabaseByID(ctx, projectID)
+ if err != nil {
+ return nil, err
+ }
+ if err := ensureProjectMutableInternal(proj); err != nil {
+ return nil, err
+ }
+ return proj, nil
+}
+
+func (s *ProjectService) logProjectEventInternal(ctx context.Context, eventType models.EventType, projectID, projectName string, user models.User, metadata models.JSON, action string) {
+ if s.eventService == nil {
+ return
+ }
+ if logErr := s.eventService.LogProjectEvent(ctx, eventType, projectID, projectName, user.ID, user.Username, "0", metadata); logErr != nil {
+ slog.ErrorContext(ctx, action, "error", logErr)
+ }
+}
+
+func groupComposeContainersByProjectInternal(containers []container.Summary) map[string][]container.Summary {
+ containersByProject := make(map[string][]container.Summary)
+ for _, c := range containers {
+ projectName := dockerutil.ComposeProjectLabel(c.Labels)
+ if projectName != "" {
+ containersByProject[projectName] = append(containersByProject[projectName], c)
+ }
+ }
+ return containersByProject
+}
+
func (s *ProjectService) GetProjectRelativePath(ctx context.Context, projectPath string) string {
projectsDir, err := s.getProjectsDirectoryInternal(ctx)
if err != nil {
@@ -228,87 +267,16 @@ type ProjectBuildOptions struct {
Load *bool
}
-type deployImageDecision struct {
- Build bool
- PullAlways bool
- PullIfMissing bool
- FallbackBuildOnPullFail bool
- RequireLocalOnly bool
-}
-
-type imagePullMode int
-
-const (
- imagePullModeNever imagePullMode = iota
- imagePullModeIfMissing
- imagePullModeAlways
-)
-
var (
composeStopProjectServicesInternal = projects.ComposeStop
composeUpProjectServicesInternal = projects.ComposeUp
)
-func resolveServiceImagePullMode(svc composetypes.ServiceConfig) imagePullMode {
- rawPolicy := strings.ToLower(strings.TrimSpace(svc.PullPolicy))
- switch {
- case rawPolicy == composetypes.PullPolicyNever:
- return imagePullModeNever
- case rawPolicy == composetypes.PullPolicyAlways:
- return imagePullModeAlways
- case rawPolicy == composetypes.PullPolicyRefresh,
- rawPolicy == "daily",
- rawPolicy == "weekly",
- strings.HasPrefix(rawPolicy, "every_"):
- return imagePullModeAlways
- case rawPolicy == composetypes.PullPolicyMissing,
- rawPolicy == composetypes.PullPolicyIfNotPresent,
- rawPolicy == composetypes.PullPolicyBuild,
- rawPolicy == "":
- return imagePullModeIfMissing
- }
-
- policy, _, err := svc.GetPullPolicy()
- if err != nil {
- slog.Warn("failed to parse service pull_policy, defaulting to missing", "service", svc.Name, "pull_policy", svc.PullPolicy, "error", err)
- return imagePullModeIfMissing
- }
-
- switch policy {
- case composetypes.PullPolicyNever:
- return imagePullModeNever
- case composetypes.PullPolicyAlways, composetypes.PullPolicyRefresh:
- return imagePullModeAlways
- case composetypes.PullPolicyMissing, composetypes.PullPolicyIfNotPresent, composetypes.PullPolicyBuild:
- return imagePullModeIfMissing
- default:
- return imagePullModeIfMissing
- }
-}
-
-func buildProjectImagePullPlan(services composetypes.Services) map[string]imagePullMode {
- plan := map[string]imagePullMode{}
- for _, svc := range services {
- if svc.Build != nil {
- continue
- }
- img := strings.TrimSpace(svc.Image)
- if img == "" {
- continue
- }
- mode := resolveServiceImagePullMode(svc)
- if existing, exists := plan[img]; !exists || mode > existing {
- plan[img] = mode
- }
- }
- return plan
-}
-
// lookupProjectContainers returns containers matched to a project, trying the
// normalized directory name first and falling back to the effective compose
// project name (from COMPOSE_PROJECT_NAME) when it differs.
func lookupProjectContainers(p models.Project, containersByProject map[string][]container.Summary) []container.Summary {
- normName := normalizeComposeProjectName(p.Name)
+ normName := projects.NormalizeProjectName(p.Name)
if c := containersByProject[normName]; len(c) > 0 {
return c
}
@@ -318,17 +286,6 @@ func lookupProjectContainers(p models.Project, containersByProject map[string][]
return nil
}
-func normalizeComposeProjectName(name string) string {
- if name == "" {
- return ""
- }
- normalized := loader.NormalizeProjectName(name)
- if normalized == "" {
- return name
- }
- return normalized
-}
-
func (s *ProjectService) getCachedComposeProjectIDInternal(normalizedName string) (string, bool) {
if normalizedName == "" {
return "", false
@@ -387,7 +344,7 @@ func (s *ProjectService) lookupProjectByCachedComposeNameInternal(ctx context.Co
}
return nil, false, fmt.Errorf("failed to get project by cached compose name: %w", err)
}
- if normalizeComposeProjectName(project.Name) != normalizedName {
+ if projects.NormalizeProjectName(project.Name) != normalizedName {
s.invalidateCachedComposeProjectIDInternal(normalizedName)
return nil, false, nil
}
@@ -396,19 +353,19 @@ func (s *ProjectService) lookupProjectByCachedComposeNameInternal(ctx context.Co
}
func (s *ProjectService) rebuildComposeNameCacheInternal(ctx context.Context) error {
- var projects []models.Project
- if err := s.db.WithContext(ctx).Select("id", "name").Find(&projects).Error; err != nil {
+ var projectModels []models.Project
+ if err := s.db.WithContext(ctx).Select("id", "name").Find(&projectModels).Error; err != nil {
return err
}
- cache := make(map[string]string, len(projects))
- for i := range projects {
- normalizedName := normalizeComposeProjectName(projects[i].Name)
+ cache := make(map[string]string, len(projectModels))
+ for i := range projectModels {
+ normalizedName := projects.NormalizeProjectName(projectModels[i].Name)
if normalizedName == "" {
continue
}
if _, exists := cache[normalizedName]; !exists {
- cache[normalizedName] = projects[i].ID
+ cache[normalizedName] = projectModels[i].ID
}
}
@@ -437,7 +394,7 @@ func (s *ProjectService) GetProjectByComposeName(ctx context.Context, name strin
if name == "" {
return nil, errors.New("project name is empty")
}
- normalized := normalizeComposeProjectName(name)
+ normalized := projects.NormalizeProjectName(name)
var proj models.Project
err := s.db.WithContext(ctx).Where("name = ? OR name = ?", name, normalized).First(&proj).Error
@@ -512,15 +469,11 @@ func (s *ProjectService) loadComposeProjectForProjectInternal(ctx context.Contex
if cfg == nil {
cfg = s.settingsService.GetSettingsOrDefaults(ctx)
}
- projectsDirectory, pdErr := projects.GetProjectsDirectory(ctx, strings.TrimSpace(cfg.ProjectsDirectory.Value))
- if pdErr != nil {
- slog.WarnContext(ctx, "unable to determine projects directory; using default", "error", pdErr)
- projectsDirectory = "/app/data/projects"
- }
+ projectsDirectory := s.getProjectsDirectoryOrDefaultInternal(ctx, cfg)
pathMapper := s.getPathMapperInternal(ctx)
- composeProject, loadErr := projects.LoadComposeProject(ctx, composeFileFullPath, normalizeComposeProjectName(proj.Name), projectsDirectory, utils.BoolOrDefault(cfg.AutoInjectEnv.Value, false), pathMapper)
+ composeProject, loadErr := projects.LoadComposeProject(ctx, composeFileFullPath, projects.NormalizeProjectName(proj.Name), projectsDirectory, utils.BoolOrDefault(cfg.AutoInjectEnv.Value, false), pathMapper)
if loadErr != nil {
return nil, "", loadErr
}
@@ -617,7 +570,7 @@ func (s *ProjectService) refreshProjectImageRefsInternal(ctx context.Context, pr
slog.WarnContext(ctx, "failed to refresh project image refs", "projectID", proj.ID, "projectName", proj.Name, "error", err)
return
}
- imageRefsJSON := marshalProjectImageRefsJSONInternal(refs)
+ imageRefsJSON := projects.MarshalImageRefsJSON(refs)
if err := s.db.WithContext(ctx).
Model(&models.Project{}).
Where("id = ?", proj.ID).
@@ -861,9 +814,7 @@ func (s *ProjectService) UpdateProjectServices(ctx context.Context, projectID st
"projectName": projectFromDb.Name,
"services": append([]string(nil), servicesToUpdate...),
}
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectUpdate, projectID, projectFromDb.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project service update action", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectUpdate, projectID, projectFromDb.Name, user, metadata, "could not log project service update action")
return nil
}
@@ -1306,29 +1257,6 @@ func (s *ProjectService) enrichProjectUpdateInfoInternal(ctx context.Context, re
resp.UpdateInfo = buildProjectUpdateInfoSummaryInternal(imageRefs, updateInfoByRef)
}
-func parseProjectImageRefsJSONInternal(raw string) []string {
- raw = strings.TrimSpace(raw)
- if raw == "" {
- return nil
- }
- var refs []string
- if err := json.Unmarshal([]byte(raw), &refs); err != nil {
- return nil
- }
- return refs
-}
-
-func marshalProjectImageRefsJSONInternal(refs []string) string {
- if len(refs) == 0 {
- return ""
- }
- data, err := json.Marshal(refs)
- if err != nil {
- return ""
- }
- return string(data)
-}
-
func (s *ProjectService) enrichProjectsWithUpdateInfoInternal(
ctx context.Context,
projectsList []models.Project,
@@ -1353,7 +1281,7 @@ func (s *ProjectService) enrichProjectsWithUpdateInfoInternal(
var wg sync.WaitGroup
for _, proj := range projectsList {
- if refs := parseProjectImageRefsJSONInternal(proj.ImageRefsJSON); len(refs) > 0 {
+ if refs := projects.ParseImageRefsJSON(proj.ImageRefsJSON); len(refs) > 0 {
imageRefsByProjectID[proj.ID] = refs
allImageRefs = append(allImageRefs, refs...)
continue
@@ -1642,7 +1570,7 @@ func (s *ProjectService) upsertProjectForDir(ctx context.Context, dirName, dirPa
if existing.Name != composeMetadata.resolvedProjectName {
updates["name"] = composeMetadata.resolvedProjectName
}
- } else if normalizedExistingName := normalizeComposeProjectName(existing.Name); normalizedExistingName != existing.Name {
+ } else if normalizedExistingName := projects.NormalizeProjectName(existing.Name); normalizedExistingName != existing.Name {
updates["name"] = normalizedExistingName
}
}
@@ -2011,13 +1939,7 @@ func (s *ProjectService) GetProjectStatusCounts(ctx context.Context) (folderCoun
}
// 2. Group by project
- containersByProject := make(map[string][]container.Summary)
- for _, c := range containers {
- projName := dockerutil.ComposeProjectLabel(c.Labels)
- if projName != "" {
- containersByProject[projName] = append(containersByProject[projName], c)
- }
- }
+ containersByProject := groupComposeContainersByProjectInternal(containers)
// 3. Calculate status for each project
for _, p := range activeProjects {
@@ -2093,11 +2015,7 @@ func (s *ProjectService) ArchiveProject(ctx context.Context, projectID string, u
}
metadata := models.JSON{"action": "archived", "projectID": projectID, "projectName": proj.Name}
- if s.eventService != nil {
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectUpdate, projectID, proj.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project archive action", "error", logErr)
- }
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectUpdate, projectID, proj.Name, user, metadata, "could not log project archive action")
return nil
}
@@ -2119,11 +2037,7 @@ func (s *ProjectService) UnarchiveProject(ctx context.Context, projectID string,
}
metadata := models.JSON{"action": "unarchived", "projectID": projectID, "projectName": proj.Name}
- if s.eventService != nil {
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectUpdate, projectID, proj.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project unarchive action", "error", logErr)
- }
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectUpdate, projectID, proj.Name, user, metadata, "could not log project unarchive action")
return nil
}
@@ -2147,11 +2061,11 @@ func (s *ProjectService) DeployProject(ctx context.Context, projectID string, us
resolvedPullPolicy := ""
forceRecreate := false
if options != nil {
- resolvedPullPolicy = normalizeDeployPullPolicyInternal(options.PullPolicy)
+ resolvedPullPolicy = projects.NormalizeDeployPullPolicy(options.PullPolicy)
forceRecreate = options.ForceRecreate
}
if resolvedPullPolicy == "" {
- resolvedPullPolicy = normalizeDeployPullPolicyInternal(s.settingsService.GetStringSetting(ctx, "defaultDeployPullPolicy", "missing"))
+ resolvedPullPolicy = projects.NormalizeDeployPullPolicy(s.settingsService.GetStringSetting(ctx, "defaultDeployPullPolicy", "missing"))
}
if resolvedPullPolicy == "" {
resolvedPullPolicy = "missing"
@@ -2206,9 +2120,7 @@ func (s *ProjectService) DeployProject(ctx context.Context, projectID string, us
slog.Info("compose up completed successfully", "projectID", projectID, "projectName", project.Name)
metadata := models.JSON{"action": "deploy", "projectID": projectID, "projectName": project.Name}
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectDeploy, projectID, project.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project deployment action", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectDeploy, projectID, project.Name, user, metadata, "could not log project deployment action")
err = s.updateProjectStatusandCountsInternal(ctx, projectID, models.ProjectStatusRunning)
if err != nil {
@@ -2218,13 +2130,10 @@ func (s *ProjectService) DeployProject(ctx context.Context, projectID string, us
}
func (s *ProjectService) DownProject(ctx context.Context, projectID string, user models.User) error {
- projectFromDb, err := s.GetProjectFromDatabaseByID(ctx, projectID)
+ projectFromDb, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
}
- if err := ensureProjectMutableInternal(projectFromDb); err != nil {
- return err
- }
proj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb, nil)
if lerr != nil {
@@ -2247,9 +2156,7 @@ func (s *ProjectService) DownProject(ctx context.Context, projectID string, user
"projectID": projectID,
"projectName": projectFromDb.Name,
}
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectStop, projectID, projectFromDb.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project down action", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectStop, projectID, projectFromDb.Name, user, metadata, "could not log project down action")
writeProjectProgressInternal(ctx, "Refreshing project status", 90, "status")
if err := s.updateProjectStatusandCountsInternal(ctx, projectID, models.ProjectStatusStopped); err != nil {
@@ -2332,9 +2239,7 @@ func (s *ProjectService) createProjectInternal(ctx context.Context, name, compos
s.refreshProjectImageRefsInternal(ctx, proj)
metadata := models.JSON{"action": "create", "projectID": proj.ID, "projectName": proj.Name, "path": projectPath}
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectCreate, proj.ID, proj.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project creation", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectCreate, proj.ID, proj.Name, user, metadata, "could not log project creation")
return proj, nil
}
@@ -2402,21 +2307,16 @@ func (s *ProjectService) DestroyProject(ctx context.Context, projectID string, r
writeProjectProgressInternal(ctx, "Project destroyed", 100, "complete")
metadata := models.JSON{"action": "destroy", "projectID": projectID, "projectName": proj.Name, "removeFiles": removeFiles, "removeVolumes": removeVolumes}
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectDelete, projectID, proj.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project destroy action", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectDelete, projectID, proj.Name, user, metadata, "could not log project destroy action")
return nil
}
func (s *ProjectService) RedeployProject(ctx context.Context, projectID string, user models.User, options *project.DeployOptions) error {
- proj, err := s.GetProjectFromDatabaseByID(ctx, projectID)
+ proj, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
}
- if err := ensureProjectMutableInternal(proj); err != nil {
- return err
- }
disabled := s.projectRedeployDisabledInternal(ctx, *proj)
if disabled {
@@ -2436,9 +2336,7 @@ func (s *ProjectService) RedeployProject(ctx context.Context, projectID string,
}
metadata := models.JSON{"action": "redeploy", "projectID": projectID, "projectName": proj.Name}
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectDeploy, projectID, proj.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project redeploy action", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectDeploy, projectID, proj.Name, user, metadata, "could not log project redeploy action")
if _, writeErr := progressWriter.Write([]byte(`{"type":"deploy","phase":"up","status":"starting project deployment"}` + "\n")); writeErr != nil {
slog.DebugContext(ctx, "failed to write redeploy deploy progress", "error", writeErr)
@@ -2454,13 +2352,7 @@ func (s *ProjectService) projectRedeployDisabledInternal(ctx context.Context, pr
return false
}
- containersByProject := make(map[string][]container.Summary)
- for _, c := range containers {
- projectName := dockerutil.ComposeProjectLabel(c.Labels)
- if projectName != "" {
- containersByProject[projectName] = append(containersByProject[projectName], c)
- }
- }
+ containersByProject := groupComposeContainersByProjectInternal(containers)
currentContainerID, currentContainerErr := dockerutil.GetCurrentContainerID()
for _, container := range lookupProjectContainers(proj, containersByProject) {
@@ -2473,13 +2365,10 @@ func (s *ProjectService) projectRedeployDisabledInternal(ctx context.Context, pr
}
func (s *ProjectService) PullProjectImages(ctx context.Context, projectID string, progressWriter io.Writer, user models.User, credentials []containerregistry.Credential) error {
- proj, err := s.GetProjectFromDatabaseByID(ctx, projectID)
+ proj, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
}
- if err := ensureProjectMutableInternal(proj); err != nil {
- return err
- }
compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj, nil)
if lerr != nil {
@@ -2507,13 +2396,10 @@ func (s *ProjectService) PullProjectImages(ctx context.Context, projectID string
}
func (s *ProjectService) BuildProjectServices(ctx context.Context, projectID string, options ProjectBuildOptions, progressWriter io.Writer, user *models.User) error {
- projectFromDb, err := s.GetProjectFromDatabaseByID(ctx, projectID)
+ projectFromDb, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
}
- if err := ensureProjectMutableInternal(projectFromDb); err != nil {
- return err
- }
project, _, derr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb, nil)
if derr != nil {
@@ -2529,33 +2415,30 @@ func (s *ProjectService) BuildProjectServices(ctx context.Context, projectID str
// - missing/if_not_present/default: pull only if local image is missing
// - never: never pull (fails early if image is missing locally)
func (s *ProjectService) EnsureProjectImagesPresent(ctx context.Context, projectID string, progressWriter io.Writer, user models.User, credentials []containerregistry.Credential) error {
- proj, err := s.GetProjectFromDatabaseByID(ctx, projectID)
+ proj, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
}
- if err := ensureProjectMutableInternal(proj); err != nil {
- return err
- }
compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj, nil)
if lerr != nil {
return fmt.Errorf("failed to load compose project: %w", lerr)
}
- pullPlan := buildProjectImagePullPlan(compProj.Services)
+ pullPlan := projects.BuildImagePullPlan(compProj.Services)
return s.ensureImagesPresent(ctx, pullPlan, progressWriter, credentials, user)
}
-func (s *ProjectService) ensureImagesPresent(ctx context.Context, pullPlan map[string]imagePullMode, progressWriter io.Writer, credentials []containerregistry.Credential, user models.User) error {
+func (s *ProjectService) ensureImagesPresent(ctx context.Context, pullPlan map[string]projects.ImagePullMode, progressWriter io.Writer, credentials []containerregistry.Credential, user models.User) error {
for img, mode := range pullPlan {
exists, ierr := s.imageService.ImageExistsLocally(ctx, img)
- if ierr != nil && mode != imagePullModeAlways {
+ if ierr != nil && mode != projects.ImagePullModeAlways {
slog.WarnContext(ctx, "failed to check local image existence", "image", img, "error", ierr)
// Non-fatal: attempt to pull to be safe
}
- if mode == imagePullModeNever {
+ if mode == projects.ImagePullModeNever {
if ierr != nil {
slog.WarnContext(ctx, "pull_policy is 'never' but image presence check failed; continuing without pull", "image", img, "error", ierr)
continue
@@ -2567,7 +2450,7 @@ func (s *ProjectService) ensureImagesPresent(ctx context.Context, pullPlan map[s
continue
}
- if mode == imagePullModeIfMissing && exists {
+ if mode == projects.ImagePullModeIfMissing && exists {
slog.DebugContext(ctx, "image already present locally; skipping pull", "image", img)
continue
}
@@ -2602,9 +2485,9 @@ func (s *ProjectService) prepareProjectImagesForDeploy(
continue
}
- decision := decideDeployImageAction(svc, pullPolicyOverride)
+ decision := projects.DecideDeployImageAction(svc, pullPolicyOverride)
if updated {
- decision = deployImageDecision{Build: true}
+ decision = projects.DeployImageDecision{Build: true}
}
if err := s.ensureDeployServiceImageReady(ctx, projectID, project, name, svc, imageName, decision, progressWriter, credentials, user); err != nil {
return err
@@ -2623,7 +2506,7 @@ func prepareDeployServiceConfig(projectID, projectName, serviceName string, svc
return updatedSvc, resolvedImage, updated
}
-func shouldPullDeployImage(decision deployImageDecision, exists bool) bool {
+func shouldPullDeployImage(decision projects.DeployImageDecision, exists bool) bool {
return decision.PullAlways || (decision.PullIfMissing && !exists)
}
@@ -2634,7 +2517,7 @@ func (s *ProjectService) ensureDeployServiceImageReady(
serviceName string,
svc composetypes.ServiceConfig,
imageName string,
- decision deployImageDecision,
+ decision projects.DeployImageDecision,
progressWriter io.Writer,
credentials []containerregistry.Credential,
user *models.User,
@@ -2728,93 +2611,6 @@ func ensureServiceImage(projectID, projectName, serviceName string, svc composet
return imageName, svc, false
}
-func normalizePullPolicy(policy string) string {
- policy = strings.ToLower(strings.TrimSpace(policy))
- if policy == "if_not_present" {
- return "missing"
- }
- return policy
-}
-
-func normalizeDeployPullPolicyInternal(policy string) string {
- normalized := normalizePullPolicy(policy)
- switch normalized {
- case "always", "missing", "never":
- return normalized
- default:
- return ""
- }
-}
-
-func isAlwaysPullPolicy(policy string) bool {
- if policy == "always" || policy == "daily" || policy == "weekly" {
- return true
- }
- return strings.HasPrefix(policy, "every_")
-}
-
-func decideDeployImageAction(svc composetypes.ServiceConfig, pullPolicyOverride string) deployImageDecision {
- policy := normalizePullPolicy(svc.PullPolicy)
- if policy == "" {
- if override := normalizeDeployPullPolicyInternal(pullPolicyOverride); override != "" {
- policy = override
- }
- }
- buildEnabled := svc.Build != nil
-
- if buildEnabled {
- switch {
- case policy == "build":
- return deployImageDecision{Build: true}
- case policy == "never":
- return deployImageDecision{RequireLocalOnly: true}
- case isAlwaysPullPolicy(policy):
- return deployImageDecision{PullAlways: true}
- case policy == "missing":
- return deployImageDecision{PullIfMissing: true}
- case policy == "":
- return deployImageDecision{PullIfMissing: true, FallbackBuildOnPullFail: true}
- default:
- return deployImageDecision{PullIfMissing: true}
- }
- }
-
- switch {
- case policy == "never":
- return deployImageDecision{RequireLocalOnly: true}
- case isAlwaysPullPolicy(policy):
- return deployImageDecision{PullAlways: true}
- default:
- return deployImageDecision{PullIfMissing: true}
- }
-}
-
-func resolveBuildContextInternal(workingDir string, svc composetypes.ServiceConfig, serviceName string) (string, error) {
- contextDir := strings.TrimSpace(svc.Build.Context)
- if contextDir == "" {
- contextDir = workingDir
- } else if _, isGitContext, err := contextsource.ParseGitBuildContextSource(contextDir); err != nil {
- return "", fmt.Errorf("invalid build context for service %s: %w", serviceName, err)
- } else if !isGitContext && !filepath.IsAbs(contextDir) {
- contextDir = filepath.Join(workingDir, contextDir)
- }
-
- if contextDir == "" {
- return "", fmt.Errorf("build context not set for service %s", serviceName)
- }
-
- return contextDir, nil
-}
-
-func resolveDockerfilePathInternal(svc composetypes.ServiceConfig) string {
- dockerfilePath := strings.TrimSpace(svc.Build.Dockerfile)
- if dockerfilePath == "" {
- dockerfilePath = "Dockerfile"
- }
-
- return dockerfilePath
-}
-
func (s *ProjectService) resolveEffectiveBuildProvider(override string) string {
provider := strings.ToLower(strings.TrimSpace(override))
if provider != "" {
@@ -2859,7 +2655,7 @@ func (s *ProjectService) prepareServiceBuildRequest(
// (which is what bind mount sources need) makes `os.Stat` fail because
// the host path doesn't exist inside the Arcane container. See #2314.
// For that reason the build context dir is deliberately left untranslated.
- contextDir, err := resolveBuildContextInternal(project.WorkingDir, updatedSvc, serviceName)
+ contextDir, err := projects.ResolveBuildContext(project.WorkingDir, updatedSvc, serviceName)
if err != nil {
return buildtypes.BuildRequest{}, updatedSvc, updated, err
}
@@ -2871,7 +2667,7 @@ func (s *ProjectService) prepareServiceBuildRequest(
dockerfilePath := ""
if strings.TrimSpace(dockerfileInline) == "" {
- dockerfilePath = resolveDockerfilePathInternal(updatedSvc)
+ dockerfilePath = projects.ResolveDockerfilePath(updatedSvc)
}
buildReq := buildtypes.BuildRequest{
@@ -2974,13 +2770,10 @@ func (s *ProjectService) buildProjectServicesInternal(ctx context.Context, proje
}
func (s *ProjectService) RestartProject(ctx context.Context, projectID string, user models.User) error {
- proj, err := s.GetProjectFromDatabaseByID(ctx, projectID)
+ proj, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
}
- if err := ensureProjectMutableInternal(proj); err != nil {
- return err
- }
if err := s.updateProjectStatusInternal(ctx, projectID, models.ProjectStatusRestarting); err != nil {
return fmt.Errorf("failed to update project status to restarting: %w", err)
@@ -2988,15 +2781,11 @@ func (s *ProjectService) RestartProject(ctx context.Context, projectID string, u
// Get configured projects directory from settings
cfg := s.settingsService.GetSettingsOrDefaults(ctx)
- projectsDirectory, pdErr := projects.GetProjectsDirectory(ctx, strings.TrimSpace(cfg.ProjectsDirectory.Value))
- if pdErr != nil {
- slog.WarnContext(ctx, "unable to determine projects directory; using default", "error", pdErr)
- projectsDirectory = "/app/data/projects"
- }
+ projectsDirectory := s.getProjectsDirectoryOrDefaultInternal(ctx, cfg)
pathMapper := s.getPathMapperInternal(ctx)
- compProj, _, lerr := projects.LoadComposeProjectFromDir(ctx, proj.Path, normalizeComposeProjectName(proj.Name), projectsDirectory, utils.BoolOrDefault(cfg.AutoInjectEnv.Value, false), pathMapper)
+ compProj, _, lerr := projects.LoadComposeProjectFromDir(ctx, proj.Path, projects.NormalizeProjectName(proj.Name), projectsDirectory, utils.BoolOrDefault(cfg.AutoInjectEnv.Value, false), pathMapper)
if lerr != nil {
_ = s.updateProjectStatusInternal(ctx, projectID, models.ProjectStatusRunning)
return fmt.Errorf("failed to load compose project: %w", lerr)
@@ -3013,9 +2802,7 @@ func (s *ProjectService) RestartProject(ctx context.Context, projectID string, u
"projectID": projectID,
"projectName": proj.Name,
}
- if logErr := s.eventService.LogProjectEvent(ctx, models.EventTypeProjectStart, projectID, proj.Name, user.ID, user.Username, "0", metadata); logErr != nil {
- slog.ErrorContext(ctx, "could not log project restart action", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectStart, projectID, proj.Name, user, metadata, "could not log project restart action")
writeProjectProgressInternal(ctx, "Refreshing project status", 90, "status")
if err := s.updateProjectStatusandCountsInternal(ctx, projectID, models.ProjectStatusRunning); err != nil {
@@ -3273,9 +3060,7 @@ func (s *ProjectService) logProjectUpdateEventInternal(ctx context.Context, proj
metadata["projectFilesUpdated"] = true
metadata["projectFileChangeCount"] = len(fileChanges)
}
- 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)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectUpdate, proj.ID, proj.Name, user, metadata, "could not log project update action")
}
func (s *ProjectService) refreshProjectAfterContentUpdateInternal(ctx context.Context, proj *models.Project, composeContent *string, fileChanges []project.ProjectFileChange) {
@@ -3335,9 +3120,7 @@ func (s *ProjectService) ApplyGitSyncProjectFiles(ctx context.Context, projectID
if gitEnvContent == nil {
metadata["envSourceRemoved"] = 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 git sync project update action", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectUpdate, proj.ID, proj.Name, user, metadata, "could not log git sync project update action")
return &proj, nil
}
@@ -3434,8 +3217,8 @@ func projectRenameVolumeMigrationComposeNamesInternal(s *ProjectService, proj *m
return "", "", false
}
- oldComposeName := normalizeComposeProjectName(proj.Name)
- newComposeName := normalizeComposeProjectName(newProjectName)
+ oldComposeName := projects.NormalizeProjectName(proj.Name)
+ newComposeName := projects.NormalizeProjectName(newProjectName)
if oldComposeName == "" || newComposeName == "" || oldComposeName == newComposeName {
return "", "", false
}
@@ -3646,7 +3429,7 @@ func (s *ProjectService) validateComposeContentForUpdate(ctx context.Context, pr
return err
}
- validationProjectName := normalizeComposeProjectName(projectName)
+ validationProjectName := projects.NormalizeProjectName(projectName)
cfg := composetypes.ConfigDetails{
Version: api.ComposeVersion,
WorkingDir: projectPath,
@@ -3656,10 +3439,10 @@ func (s *ProjectService) validateComposeContentForUpdate(ctx context.Context, pr
Environment: composetypes.Mapping(fullEnvMap),
}
- missingIncludeLoader := &missingIncludeStubResourceLoaderInternal{projectPath: projectPath}
- defer missingIncludeLoader.cleanupInternal()
+ missingIncludeLoader := projects.NewMissingIncludeStubLoader(projectPath)
+ defer missingIncludeLoader.Cleanup()
- err = withTransientValidationEnvFile(projectPath, effectiveEnvContent, func() error {
+ err = projects.WithTransientValidationEnvFile(projectPath, effectiveEnvContent, func() error {
_, loadErr := loader.LoadWithContext(ctx, cfg, func(opts *loader.Options) {
opts.ResourceLoaders = append([]loader.ResourceLoader{missingIncludeLoader}, opts.ResourceLoaders...)
if validationProjectName != "" {
@@ -3688,79 +3471,6 @@ func validateComposeIncludePathsForProjectInternal(projectPath, composeContent s
return nil
}
-type missingIncludeStubResourceLoaderInternal struct {
- projectPath string
- tempDir string
- stubs map[string]string
-}
-
-func (l *missingIncludeStubResourceLoaderInternal) Accept(path string) bool {
- _, ok := l.resolveMissingIncludeInternal(path)
- return ok
-}
-
-func (l *missingIncludeStubResourceLoaderInternal) Load(_ context.Context, path string) (string, error) {
- validatedPath, ok := l.resolveMissingIncludeInternal(path)
- if !ok {
- return "", fmt.Errorf("include file is not eligible for validation stub: %s", path)
- }
-
- if l.stubs == nil {
- l.stubs = make(map[string]string)
- }
- if stubPath, ok := l.stubs[validatedPath]; ok {
- return stubPath, nil
- }
-
- if l.tempDir == "" {
- tempDir, err := os.MkdirTemp("", "arcane-compose-include-*")
- if err != nil {
- return "", fmt.Errorf("create validation include temp dir: %w", err)
- }
- l.tempDir = tempDir
- }
-
- relPath, err := filepath.Rel(l.projectPath, validatedPath)
- if err != nil || strings.HasPrefix(relPath, "..") || filepath.IsAbs(relPath) {
- relPath = filepath.Base(validatedPath)
- }
- stubPath := filepath.Join(l.tempDir, relPath)
- if err := os.MkdirAll(filepath.Dir(stubPath), 0o755); err != nil {
- return "", fmt.Errorf("create validation include directory: %w", err)
- }
- if err := os.WriteFile(stubPath, []byte("services: {}\n"), 0o600); err != nil {
- return "", fmt.Errorf("write validation include stub: %w", err)
- }
-
- l.stubs[validatedPath] = stubPath
- return stubPath, nil
-}
-
-func (l *missingIncludeStubResourceLoaderInternal) Dir(path string) string {
- return filepath.Dir(path)
-}
-
-func (l *missingIncludeStubResourceLoaderInternal) resolveMissingIncludeInternal(path string) (string, bool) {
- validatedPath, err := projects.ValidateIncludePathForWrite(l.projectPath, path)
- if err != nil {
- return "", false
- }
-
- if _, err := os.Stat(validatedPath); err == nil {
- return "", false
- } else if !errors.Is(err, os.ErrNotExist) {
- return "", false
- }
-
- return validatedPath, true
-}
-
-func (l *missingIncludeStubResourceLoaderInternal) cleanupInternal() {
- if l.tempDir != "" {
- _ = os.RemoveAll(l.tempDir)
- }
-}
-
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.
@@ -3827,61 +3537,6 @@ func parseComposeValidationEnvContent(content string, contextEnv projects.EnvMap
return envMap, nil
}
-func withTransientValidationEnvFile(projectPath string, effectiveEnvContent *string, run func() error) (err error) {
- envPath := filepath.Join(projectPath, ".env")
- originalContent, readErr := os.ReadFile(envPath)
- originalExists := readErr == nil
- if readErr != nil && !os.IsNotExist(readErr) {
- if !errors.Is(readErr, os.ErrPermission) {
- return fmt.Errorf("prepare env file for compose validation: %w", readErr)
- }
- // The file exists but is permission-locked (e.g. chmod 000, foreign-owned).
- // Its contents can't be verified or safely overwritten, so leave it
- // untouched and validate against whatever's already on disk instead of
- // aborting the whole update.
- slog.Warn("skipping permission-locked .env file during compose validation; leaving it untouched", "projectPath", projectPath)
- if run == nil {
- return nil
- }
- return run()
- }
-
- shouldWrite := effectiveEnvContent != nil || !originalExists
- if shouldWrite {
- content := ""
- if effectiveEnvContent != nil {
- content = *effectiveEnvContent
- }
- if writeErr := projects.WriteEnvFile(projectPath, projectPath, content); writeErr != nil {
- return fmt.Errorf("prepare env file for compose validation: %w", writeErr)
- }
-
- defer func() {
- var restoreErr error
- switch {
- case originalExists:
- restoreErr = projects.WriteEnvFile(projectPath, projectPath, string(originalContent))
- case effectiveEnvContent != nil:
- restoreErr = os.Remove(envPath)
- default:
- restoreErr = os.Remove(envPath)
- }
-
- if restoreErr != nil && !os.IsNotExist(restoreErr) {
- if err == nil {
- err = fmt.Errorf("restore env file after compose validation: %w", restoreErr)
- }
- }
- }()
- }
-
- if run == nil {
- return nil
- }
-
- return run()
-}
-
func (s *ProjectService) resolveEffectiveEnvContentForUpdateInternal(projectPath string, envContent *string) (*string, error) {
if envContent != nil {
return envContent, nil
@@ -4158,13 +3813,10 @@ func (s *ProjectService) applyProjectRenameIfNeeded(proj *models.Project, name *
}
func (s *ProjectService) UpdateProjectIncludeFile(ctx context.Context, projectID, relativePath, content string, user models.User) error {
- proj, err := s.GetProjectFromDatabaseByID(ctx, projectID)
+ proj, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
}
- if err := ensureProjectMutableInternal(proj); err != nil {
- return err
- }
// Normalize and persist project path to ensure include writes occur under projects root
if err := s.ensureProjectPathUnderRoot(ctx, proj, true); err != nil {
@@ -4187,9 +3839,7 @@ func (s *ProjectService) UpdateProjectIncludeFile(ctx context.Context, projectID
"projectName": proj.Name,
"relativePath": relativePath,
}
- 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 include update action", "error", logErr)
- }
+ s.logProjectEventInternal(ctx, models.EventTypeProjectUpdate, proj.ID, proj.Name, user, metadata, "could not log project include update action")
slog.InfoContext(ctx, "project include file updated", "projectID", proj.ID, "file", relativePath)
return nil
@@ -4263,7 +3913,7 @@ func (s *ProjectService) StreamProjectLogs(ctx context.Context, projectID string
// Writer goroutine: compose logs -> pipe
go func() {
// since/timestamps not currently supported by ComposeLogs helper; follow/tail are used.
- err := projects.ComposeLogs(ctx, normalizeComposeProjectName(proj.Name), pw, follow, tail)
+ err := projects.ComposeLogs(ctx, projects.NormalizeProjectName(proj.Name), pw, follow, tail)
_ = pw.Close()
done <- err
}()
@@ -4461,7 +4111,7 @@ func addKnownComposeProjectNameInternal(known map[string]struct{}, name string)
}
known[name] = struct{}{}
- if normalized := normalizeComposeProjectName(name); normalized != "" {
+ if normalized := projects.NormalizeProjectName(name); normalized != "" {
known[normalized] = struct{}{}
}
}
@@ -4482,7 +4132,7 @@ func buildDiscoveredComposeProjectUpdateRowsInternal(
if _, exists := knownProjectNames[projectName]; exists {
continue
}
- if normalized := normalizeComposeProjectName(projectName); normalized != "" {
+ if normalized := projects.NormalizeProjectName(projectName); normalized != "" {
if _, exists := knownProjectNames[normalized]; exists {
continue
}
@@ -4812,13 +4462,7 @@ func (s *ProjectService) fetchProjectStatusConcurrently(ctx context.Context, pro
}
// 2. Group containers by project name
- containersByProject := make(map[string][]container.Summary)
- for _, c := range containers {
- projName := dockerutil.ComposeProjectLabel(c.Labels)
- if projName != "" {
- containersByProject[projName] = append(containersByProject[projName], c)
- }
- }
+ containersByProject := groupComposeContainersByProjectInternal(containers)
// 3. Map to DTOs
results := make([]project.Details, len(projectsList))
@@ -4848,7 +4492,6 @@ func (s *ProjectService) mapProjectToDto(ctx context.Context, projectsDir string
projectContainers := lookupProjectContainers(p, containersByProject)
services := make([]ProjectServiceInfo, 0, len(projectContainers))
- runningCount := 0
for _, c := range projectContainers {
svcName := dockerutil.ComposeServiceLabel(c.Labels)
@@ -4891,11 +4534,8 @@ func (s *ProjectService) mapProjectToDto(ctx context.Context, projectsDir string
Labels: c.Labels,
RedeployDisabled: redeployDisabled,
})
-
- if state == "running" {
- runningCount++
- }
}
+ _, runningCount := s.getServiceCounts(services)
// Convert to RuntimeServices
runtimeServices := make([]project.RuntimeService, len(services))
@@ -5014,7 +4654,7 @@ type composeSyncMetadataInternal struct {
// loadComposeMetadataForSyncInternal loads the compose file once and returns
// the service count plus compose-go's effective project name.
func (s *ProjectService) loadComposeMetadataForSyncInternal(ctx context.Context, dirPath, dirName string) (composeSyncMetadataInternal, error) {
- normName := normalizeComposeProjectName(dirName)
+ normName := projects.NormalizeProjectName(dirName)
meta := composeSyncMetadataInternal{
resolvedProjectName: normName,
}
@@ -5074,7 +4714,7 @@ func (s *ProjectService) refreshComposeProjectNameInternal(ctx context.Context,
}
updates := map[string]any{}
- shouldUpdateName := meta.explicitProjectName || normalizeComposeProjectName(proj.Name) != proj.Name
+ shouldUpdateName := meta.explicitProjectName || projects.NormalizeProjectName(proj.Name) != proj.Name
if shouldUpdateName && meta.resolvedProjectName != "" && proj.Name != meta.resolvedProjectName {
updates["name"] = meta.resolvedProjectName
}
@@ -5392,7 +5032,7 @@ func (s *ProjectService) cleanupProjectRenameJournalSourcesInternal(ctx context.
}
func (s *ProjectService) rollbackProjectRenameJournalInternal(ctx context.Context, journal *projectRenameJournalInternal) error {
- directoryRollback, directoryErr := rollbackProjectRenameDirectoryInternal(journal)
+ pathsMissing, directoryErr := projects.RollbackRenamedProjectDirectory(journal.OldPath, journal.NewPath)
volumeErr := s.rollbackProjectRenameJournalVolumesInternal(ctx, journal)
@@ -5407,17 +5047,17 @@ func (s *ProjectService) rollbackProjectRenameJournalInternal(ctx context.Contex
}
if directoryErr != nil {
- slog.WarnContext(ctx, "keeping project rename journal after restoring database state because directory rollback failed", "projectID", journal.ProjectID, "pathsMissing", directoryRollback.PathsMissing, "error", directoryErr)
+ slog.WarnContext(ctx, "keeping project rename journal after restoring database state because directory rollback failed", "projectID", journal.ProjectID, "pathsMissing", pathsMissing, "error", directoryErr)
}
if volumeErr != nil {
if volumes.OnlyPreservedTargetErrors(volumeErr) {
- slog.WarnContext(ctx, "clearing project rename journal after preserving target volume data", "projectID", journal.ProjectID, "pathsMissing", directoryRollback.PathsMissing, "error", volumeErr)
+ slog.WarnContext(ctx, "clearing project rename journal after preserving target volume data", "projectID", journal.ProjectID, "pathsMissing", pathsMissing, "error", volumeErr)
} else {
if cleanupErr := s.writeProjectRenameRollbackCleanupInternal(ctx, journal); cleanupErr != nil {
return errors.Join(directoryErr, volumeErr, cleanupErr)
}
- slog.WarnContext(ctx, "queued project rename target volume cleanup after restoring database state despite volume rollback failure", "projectID", journal.ProjectID, "pathsMissing", directoryRollback.PathsMissing, "error", volumeErr)
+ slog.WarnContext(ctx, "queued project rename target volume cleanup after restoring database state despite volume rollback failure", "projectID", journal.ProjectID, "pathsMissing", pathsMissing, "error", volumeErr)
}
}
@@ -5519,63 +5159,6 @@ func (s *ProjectService) projectRenameRecoveryDockerInternal(ctx context.Context
return dockerClient, nil
}
-type projectRenameDirectoryRollbackInternal struct {
- PathsMissing bool
-}
-
-func rollbackProjectRenameDirectoryInternal(journal *projectRenameJournalInternal) (projectRenameDirectoryRollbackInternal, error) {
- var result projectRenameDirectoryRollbackInternal
- oldPath := filepath.Clean(journal.OldPath)
- newPath := filepath.Clean(journal.NewPath)
- if oldPath == "" || newPath == "" || oldPath == newPath {
- return result, nil
- }
-
- oldExists := pathExistsInternal(oldPath)
- newExists := pathExistsInternal(newPath)
- switch {
- case oldExists && newExists:
- conflictPath, err := relocateProjectRenameConflictDirectoryInternal(newPath)
- if err != nil {
- slog.Warn("project rename directory rollback found both paths and failed to relocate target path; keeping old path and clearing journal", "oldPath", oldPath, "newPath", newPath, "error", err)
- } else {
- slog.Warn("project rename directory rollback found both paths; moved target path aside and kept old path", "oldPath", oldPath, "newPath", newPath, "conflictPath", conflictPath)
- }
- case !oldExists && newExists:
- if err := os.Rename(newPath, oldPath); err != nil {
- return result, fmt.Errorf("rollback project directory rename: %w", err)
- }
- case !oldExists && !newExists:
- result.PathsMissing = true
- slog.Warn("project rename directory paths are missing during rollback", "oldPath", oldPath, "newPath", newPath)
- }
- return result, nil
-}
-
-func relocateProjectRenameConflictDirectoryInternal(path string) (string, error) {
- parent := filepath.Dir(path)
- base := filepath.Base(path)
- now := time.Now().UTC().UnixNano()
- for attempt := range 10 {
- conflictPath := filepath.Join(parent, fmt.Sprintf(".%s.rename-conflict-%d-%d", base, now, attempt))
- if _, err := os.Stat(conflictPath); err == nil {
- continue
- } else if !os.IsNotExist(err) {
- return "", fmt.Errorf("check conflict path: %w", err)
- }
- if err := os.Rename(path, conflictPath); err != nil {
- return "", fmt.Errorf("relocate project rename target path: %w", err)
- }
- return conflictPath, nil
- }
- return "", fmt.Errorf("relocate project rename target path: no available conflict path for %s", path)
-}
-
-func pathExistsInternal(path string) bool {
- _, err := os.Stat(path)
- return err == nil
-}
-
func cloneStringPtrInternal(value *string) *string {
if value == nil {
return nil
diff --git a/backend/internal/services/project_service_test.go b/backend/internal/services/project_service_test.go
index b3112b157..73eff0b1a 100644
--- a/backend/internal/services/project_service_test.go
+++ b/backend/internal/services/project_service_test.go
@@ -400,37 +400,6 @@ func TestProjectService_FormatDockerPorts(t *testing.T) {
}
}
-func TestProjectService_NormalizeComposeProjectName(t *testing.T) {
- tests := []struct {
- name string
- input string
- expected string
- }{
- {
- name: "simple",
- input: "myproject",
- expected: "myproject",
- },
- {
- name: "with special chars",
- input: "My Project!",
- expected: "myproject",
- },
- {
- name: "empty",
- input: "",
- expected: "",
- },
- }
-
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := normalizeComposeProjectName(tt.input)
- assert.Equal(t, tt.expected, got)
- })
- }
-}
-
func TestProjectService_GetProjectByComposeName(t *testing.T) {
ctx := context.Background()
@@ -552,87 +521,6 @@ func TestProjectService_GetProjectByComposeName(t *testing.T) {
})
}
-func TestResolveServiceImagePullMode(t *testing.T) {
- tests := []struct {
- name string
- service composetypes.ServiceConfig
- expected imagePullMode
- }{
- {
- name: "default policy is missing",
- service: composetypes.ServiceConfig{},
- expected: imagePullModeIfMissing,
- },
- {
- name: "always policy",
- service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyAlways},
- expected: imagePullModeAlways,
- },
- {
- name: "refresh policy",
- service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyRefresh},
- expected: imagePullModeAlways,
- },
- {
- name: "missing policy",
- service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyMissing},
- expected: imagePullModeIfMissing,
- },
- {
- name: "if not present policy",
- service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyIfNotPresent},
- expected: imagePullModeIfMissing,
- },
- {
- name: "never policy",
- service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyNever},
- expected: imagePullModeNever,
- },
- {
- name: "invalid policy defaults to missing behavior",
- service: composetypes.ServiceConfig{PullPolicy: "definitely_invalid"},
- expected: imagePullModeIfMissing,
- },
- }
-
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- assert.Equal(t, tt.expected, resolveServiceImagePullMode(tt.service))
- })
- }
-}
-
-func TestBuildProjectImagePullPlan(t *testing.T) {
- services := composetypes.Services{
- "web": {
- Name: "web",
- Image: "redis:latest",
- PullPolicy: composetypes.PullPolicyIfNotPresent,
- },
- "worker": {
- Name: "worker",
- Image: "redis:latest",
- PullPolicy: composetypes.PullPolicyAlways,
- },
- "api": {
- Name: "api",
- Image: "nginx:latest",
- PullPolicy: composetypes.PullPolicyNever,
- },
- "empty-image": {
- Name: "empty-image",
- Image: "",
- PullPolicy: composetypes.PullPolicyAlways,
- },
- }
-
- plan := buildProjectImagePullPlan(services)
-
- assert.Len(t, plan, 2)
- assert.Equal(t, imagePullModeAlways, plan["redis:latest"])
- assert.Equal(t, imagePullModeNever, plan["nginx:latest"])
-}
-
func TestProjectService_PullProjectImages_UpdatesCurrentImageRecordAfterPull(t *testing.T) {
ctx := context.Background()
db := setupProjectTestDB(t)
@@ -770,8 +658,8 @@ func TestProjectService_EnsureImagesPresent_UpdatesCurrentImageRecordAfterPull(t
CheckTime: time.Now().UTC().Add(-time.Hour),
}).Error)
- require.NoError(t, svc.ensureImagesPresent(ctx, map[string]imagePullMode{
- imageRef: imagePullModeAlways,
+ require.NoError(t, svc.ensureImagesPresent(ctx, map[string]projects.ImagePullMode{
+ imageRef: projects.ImagePullModeAlways,
}, io.Discard, nil, systemUser))
// sha256:old-api may still be in use by another container — pulling for one container
@@ -4197,47 +4085,6 @@ func TestProjectService_PrepareServiceBuildRequest_UsesInlineDockerfile(t *testi
assert.Equal(t, "FROM alpine:3.20\nRUN echo inline\n", req.DockerfileInline)
}
-func TestNormalizePullPolicy(t *testing.T) {
- assert.Equal(t, "missing", normalizePullPolicy("if_not_present"))
- assert.Equal(t, "build", normalizePullPolicy(" BUILD "))
- assert.Equal(t, "", normalizePullPolicy(""))
-}
-
-func TestDecideDeployImageAction(t *testing.T) {
- t.Run("build service with explicit build policy", func(t *testing.T) {
- svc := composetypes.ServiceConfig{
- PullPolicy: "build",
- Build: &composetypes.BuildConfig{Context: "."},
- }
-
- decision := decideDeployImageAction(svc, "")
- assert.True(t, decision.Build)
- assert.False(t, decision.PullAlways)
- })
-
- t.Run("build service default policy uses pull then fallback build", func(t *testing.T) {
- svc := composetypes.ServiceConfig{Build: &composetypes.BuildConfig{Context: "."}}
- decision := decideDeployImageAction(svc, "")
- assert.True(t, decision.PullIfMissing)
- assert.True(t, decision.FallbackBuildOnPullFail)
- assert.False(t, decision.Build)
- })
-
- t.Run("non-build service never policy requires local only", func(t *testing.T) {
- svc := composetypes.ServiceConfig{PullPolicy: "never"}
- decision := decideDeployImageAction(svc, "")
- assert.True(t, decision.RequireLocalOnly)
- assert.False(t, decision.PullIfMissing)
- })
-
- t.Run("compose pull policy wins over deploy override", func(t *testing.T) {
- svc := composetypes.ServiceConfig{PullPolicy: "never"}
- decision := decideDeployImageAction(svc, "always")
- assert.True(t, decision.RequireLocalOnly)
- assert.False(t, decision.PullAlways)
- })
-}
-
func TestProjectService_PrepareServiceBuildRequest_GeneratedImageProviderGuardrails(t *testing.T) {
svc := &ProjectService{}
proj := &composetypes.Project{WorkingDir: "/tmp/project", Name: "demo"}
@@ -4350,30 +4197,6 @@ func TestProjectService_DeployProject_BuildsGeneratedImageWithoutPull(t *testing
assert.NotContains(t, err.Error(), "failed to resolve reference \"arcane.local/")
}
-func TestResolveBuildContextInternal_AllowsRemoteGitContext(t *testing.T) {
- svc := composetypes.ServiceConfig{
- Build: &composetypes.BuildConfig{
- Context: "https://github.com/getarcaneapp/arcane.git#main:docker/app",
- },
- }
-
- contextDir, err := resolveBuildContextInternal("/projects/demo", svc, "web")
- require.NoError(t, err)
- assert.Equal(t, "https://github.com/getarcaneapp/arcane.git#main:docker/app", contextDir)
-}
-
-func TestResolveBuildContextInternal_AllowsRemoteGitContextWithoutGitSuffix(t *testing.T) {
- svc := composetypes.ServiceConfig{
- Build: &composetypes.BuildConfig{
- Context: "https://git.sr.ht/~jordanreger/nws-alerts#main:docker/app",
- },
- }
-
- contextDir, err := resolveBuildContextInternal("/projects/demo", svc, "web")
- require.NoError(t, err)
- assert.Equal(t, "https://git.sr.ht/~jordanreger/nws-alerts#main:docker/app", contextDir)
-}
-
func TestProjectService_SyncProjectsFromFileSystem_IgnoresSymlinkedProjectDirsWhenDisabled(t *testing.T) {
db := setupProjectTestDB(t)
ctx := context.Background()
diff --git a/backend/pkg/projects/build.go b/backend/pkg/projects/build.go
new file mode 100644
index 000000000..014cf21ad
--- /dev/null
+++ b/backend/pkg/projects/build.go
@@ -0,0 +1,40 @@
+package projects
+
+import (
+ "fmt"
+ "path/filepath"
+ "strings"
+
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ contextsource "go.getarcane.app/builds/pkg/utils/contextsource"
+)
+
+// ResolveBuildContext resolves a service build context against workingDir.
+// The service config must have a non-nil Build field.
+func ResolveBuildContext(workingDir string, svc composetypes.ServiceConfig, serviceName string) (string, error) {
+ contextDir := strings.TrimSpace(svc.Build.Context)
+ if contextDir == "" {
+ contextDir = workingDir
+ } else if _, isGitContext, err := contextsource.ParseGitBuildContextSource(contextDir); err != nil {
+ return "", fmt.Errorf("invalid build context for service %s: %w", serviceName, err)
+ } else if !isGitContext && !filepath.IsAbs(contextDir) {
+ contextDir = filepath.Join(workingDir, contextDir)
+ }
+
+ if contextDir == "" {
+ return "", fmt.Errorf("build context not set for service %s", serviceName)
+ }
+
+ return contextDir, nil
+}
+
+// ResolveDockerfilePath returns the configured Dockerfile path or Dockerfile.
+// The service config must have a non-nil Build field.
+func ResolveDockerfilePath(svc composetypes.ServiceConfig) string {
+ dockerfilePath := strings.TrimSpace(svc.Build.Dockerfile)
+ if dockerfilePath == "" {
+ dockerfilePath = "Dockerfile"
+ }
+
+ return dockerfilePath
+}
diff --git a/backend/pkg/projects/build_test.go b/backend/pkg/projects/build_test.go
new file mode 100644
index 000000000..1dbad5a54
--- /dev/null
+++ b/backend/pkg/projects/build_test.go
@@ -0,0 +1,33 @@
+package projects
+
+import (
+ "testing"
+
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+)
+
+func TestResolveBuildContext_AllowsRemoteGitContext(t *testing.T) {
+ svc := composetypes.ServiceConfig{
+ Build: &composetypes.BuildConfig{
+ Context: "https://github.com/getarcaneapp/arcane.git#main:docker/app",
+ },
+ }
+
+ contextDir, err := ResolveBuildContext("/projects/demo", svc, "web")
+ require.NoError(t, err)
+ assert.Equal(t, "https://github.com/getarcaneapp/arcane.git#main:docker/app", contextDir)
+}
+
+func TestResolveBuildContext_AllowsRemoteGitContextWithoutGitSuffix(t *testing.T) {
+ svc := composetypes.ServiceConfig{
+ Build: &composetypes.BuildConfig{
+ Context: "https://git.sr.ht/~jordanreger/nws-alerts#main:docker/app",
+ },
+ }
+
+ contextDir, err := ResolveBuildContext("/projects/demo", svc, "web")
+ require.NoError(t, err)
+ assert.Equal(t, "https://git.sr.ht/~jordanreger/nws-alerts#main:docker/app", contextDir)
+}
diff --git a/backend/pkg/projects/env.go b/backend/pkg/projects/env.go
index 55946142b..a191d56d3 100644
--- a/backend/pkg/projects/env.go
+++ b/backend/pkg/projects/env.go
@@ -253,6 +253,63 @@ func ParseProjectEnvContent(content string, contextEnv EnvMap) (EnvMap, error) {
return parseEnvWithContext(strings.NewReader(content), contextEnv)
}
+// WithTransientValidationEnvFile temporarily writes a project .env file while
+// running compose validation, then restores the original file state.
+func WithTransientValidationEnvFile(projectPath string, effectiveEnvContent *string, run func() error) (err error) {
+ envPath := filepath.Join(projectPath, ".env")
+ originalContent, readErr := os.ReadFile(envPath)
+ originalExists := readErr == nil
+ if readErr != nil && !os.IsNotExist(readErr) {
+ if !errors.Is(readErr, os.ErrPermission) {
+ return fmt.Errorf("prepare env file for compose validation: %w", readErr)
+ }
+ // The file exists but is permission-locked (e.g. chmod 000, foreign-owned).
+ // Its contents can't be verified or safely overwritten, so leave it
+ // untouched and validate against whatever's already on disk instead of
+ // aborting the whole update.
+ slog.Warn("skipping permission-locked .env file during compose validation; leaving it untouched", "projectPath", projectPath)
+ if run == nil {
+ return nil
+ }
+ return run()
+ }
+
+ shouldWrite := effectiveEnvContent != nil || !originalExists
+ if shouldWrite {
+ content := ""
+ if effectiveEnvContent != nil {
+ content = *effectiveEnvContent
+ }
+ if writeErr := WriteEnvFile(projectPath, projectPath, content); writeErr != nil {
+ return fmt.Errorf("prepare env file for compose validation: %w", writeErr)
+ }
+
+ defer func() {
+ var restoreErr error
+ switch {
+ case originalExists:
+ restoreErr = WriteEnvFile(projectPath, projectPath, string(originalContent))
+ case effectiveEnvContent != nil:
+ restoreErr = os.Remove(envPath)
+ default:
+ restoreErr = os.Remove(envPath)
+ }
+
+ if restoreErr != nil && !os.IsNotExist(restoreErr) {
+ if err == nil {
+ err = fmt.Errorf("restore env file after compose validation: %w", restoreErr)
+ }
+ }
+ }()
+ }
+
+ if run == nil {
+ return nil
+ }
+
+ return run()
+}
+
// BuildEffectiveEnvContent merges git and override env sources into the effective
// .env content written to disk. The output is normalized: comments are dropped,
// keys are sorted, and values are rewritten with Arcane's formatter.
diff --git a/backend/pkg/projects/fs_writer.go b/backend/pkg/projects/fs_writer.go
index 7e21b4b24..69c4e8676 100644
--- a/backend/pkg/projects/fs_writer.go
+++ b/backend/pkg/projects/fs_writer.go
@@ -7,6 +7,7 @@ import (
"os"
"path/filepath"
"strings"
+ "time"
pkgutils "github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"go.getarcane.app/sys/atomic"
@@ -215,6 +216,54 @@ func WriteFileWithPerm(filePath, content string, perm os.FileMode) error {
return nil
}
+// RollbackRenamedProjectDirectory restores a project directory rename when possible.
+func RollbackRenamedProjectDirectory(oldPath, newPath string) (pathsMissing bool, err error) {
+ oldPath = filepath.Clean(oldPath)
+ newPath = filepath.Clean(newPath)
+ if oldPath == "" || newPath == "" || oldPath == newPath {
+ return false, nil
+ }
+
+ oldExists, _ := pathExistsInternal(oldPath)
+ newExists, _ := pathExistsInternal(newPath)
+ switch {
+ case oldExists && newExists:
+ conflictPath, err := relocateRenameConflictDirectoryInternal(newPath)
+ if err != nil {
+ slog.Warn("project rename directory rollback found both paths and failed to relocate target path; keeping old path and clearing journal", "oldPath", oldPath, "newPath", newPath, "error", err)
+ } else {
+ slog.Warn("project rename directory rollback found both paths; moved target path aside and kept old path", "oldPath", oldPath, "newPath", newPath, "conflictPath", conflictPath)
+ }
+ case !oldExists && newExists:
+ if err := os.Rename(newPath, oldPath); err != nil {
+ return false, fmt.Errorf("rollback project directory rename: %w", err)
+ }
+ case !oldExists && !newExists:
+ pathsMissing = true
+ slog.Warn("project rename directory paths are missing during rollback", "oldPath", oldPath, "newPath", newPath)
+ }
+ return pathsMissing, nil
+}
+
+func relocateRenameConflictDirectoryInternal(path string) (string, error) {
+ parent := filepath.Dir(path)
+ base := filepath.Base(path)
+ now := time.Now().UTC().UnixNano()
+ for attempt := range 10 {
+ conflictPath := filepath.Join(parent, fmt.Sprintf(".%s.rename-conflict-%d-%d", base, now, attempt))
+ if _, err := os.Stat(conflictPath); err == nil {
+ continue
+ } else if !os.IsNotExist(err) {
+ return "", fmt.Errorf("check conflict path: %w", err)
+ }
+ if err := os.Rename(path, conflictPath); err != nil {
+ return "", fmt.Errorf("relocate project rename target path: %w", err)
+ }
+ return conflictPath, nil
+ }
+ return "", fmt.Errorf("relocate project rename target path: no available conflict path for %s", path)
+}
+
// SyncFile represents a file to be written during directory sync
type SyncFile struct {
RelativePath string // Path relative to the project directory
diff --git a/backend/pkg/projects/image_refs.go b/backend/pkg/projects/image_refs.go
index fdffff2de..a958154ad 100644
--- a/backend/pkg/projects/image_refs.go
+++ b/backend/pkg/projects/image_refs.go
@@ -1,6 +1,7 @@
package projects
import (
+ "encoding/json"
"sort"
"strings"
@@ -8,6 +9,33 @@ import (
projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
)
+// ParseImageRefsJSON parses a JSON array of image references, returning nil
+// for empty or invalid input.
+func ParseImageRefsJSON(raw string) []string {
+ raw = strings.TrimSpace(raw)
+ if raw == "" {
+ return nil
+ }
+ var refs []string
+ if err := json.Unmarshal([]byte(raw), &refs); err != nil {
+ return nil
+ }
+ return refs
+}
+
+// MarshalImageRefsJSON serializes image references to JSON, returning an empty
+// string when there are no refs or encoding fails.
+func MarshalImageRefsJSON(refs []string) string {
+ if len(refs) == 0 {
+ return ""
+ }
+ data, err := json.Marshal(refs)
+ if err != nil {
+ return ""
+ }
+ return string(data)
+}
+
// ImageRefsFromComposeServices returns unique, non-empty image references from
// a compose service map in stable service-name order.
func ImageRefsFromComposeServices(services composetypes.Services) []string {
diff --git a/backend/pkg/projects/includes.go b/backend/pkg/projects/includes.go
index 05ff3e4ba..a0afc1a42 100644
--- a/backend/pkg/projects/includes.go
+++ b/backend/pkg/projects/includes.go
@@ -1,6 +1,7 @@
package projects
import (
+ "context"
"errors"
"fmt"
"os"
@@ -35,6 +36,87 @@ type IncludeFile struct {
Content string `json:"content"`
}
+// MissingIncludeStubLoader creates temporary stub compose files for missing
+// include paths during validation.
+type MissingIncludeStubLoader struct {
+ projectPath string
+ tempDir string
+ stubs map[string]string
+}
+
+// NewMissingIncludeStubLoader creates a loader for validation stubs under projectPath.
+func NewMissingIncludeStubLoader(projectPath string) *MissingIncludeStubLoader {
+ return &MissingIncludeStubLoader{projectPath: projectPath}
+}
+
+func (l *MissingIncludeStubLoader) Accept(path string) bool {
+ _, ok := l.resolveMissingIncludeInternal(path)
+ return ok
+}
+
+func (l *MissingIncludeStubLoader) Load(_ context.Context, path string) (string, error) {
+ validatedPath, ok := l.resolveMissingIncludeInternal(path)
+ if !ok {
+ return "", fmt.Errorf("include file is not eligible for validation stub: %s", path)
+ }
+
+ if l.stubs == nil {
+ l.stubs = make(map[string]string)
+ }
+ if stubPath, ok := l.stubs[validatedPath]; ok {
+ return stubPath, nil
+ }
+
+ if l.tempDir == "" {
+ tempDir, err := os.MkdirTemp("", "arcane-compose-include-*")
+ if err != nil {
+ return "", fmt.Errorf("create validation include temp dir: %w", err)
+ }
+ l.tempDir = tempDir
+ }
+
+ relPath, err := filepath.Rel(l.projectPath, validatedPath)
+ if err != nil || strings.HasPrefix(relPath, "..") || filepath.IsAbs(relPath) {
+ relPath = filepath.Base(validatedPath)
+ }
+ stubPath := filepath.Join(l.tempDir, relPath)
+ if err := os.MkdirAll(filepath.Dir(stubPath), 0o755); err != nil {
+ return "", fmt.Errorf("create validation include directory: %w", err)
+ }
+ if err := os.WriteFile(stubPath, []byte("services: {}\n"), 0o600); err != nil {
+ return "", fmt.Errorf("write validation include stub: %w", err)
+ }
+
+ l.stubs[validatedPath] = stubPath
+ return stubPath, nil
+}
+
+func (l *MissingIncludeStubLoader) Dir(path string) string {
+ return filepath.Dir(path)
+}
+
+func (l *MissingIncludeStubLoader) resolveMissingIncludeInternal(path string) (string, bool) {
+ validatedPath, err := ValidateIncludePathForWrite(l.projectPath, path)
+ if err != nil {
+ return "", false
+ }
+
+ if _, err := os.Stat(validatedPath); err == nil {
+ return "", false
+ } else if !errors.Is(err, os.ErrNotExist) {
+ return "", false
+ }
+
+ return validatedPath, true
+}
+
+// Cleanup removes any temporary validation stub files created by the loader.
+func (l *MissingIncludeStubLoader) Cleanup() {
+ if l.tempDir != "" {
+ _ = os.RemoveAll(l.tempDir)
+ }
+}
+
// ParseIncludes reads a compose file and extracts all include directives.
// envMap is used to expand variables (e.g., ${VAR}) in include paths.
func ParseIncludes(composeFilePath string, envMap EnvMap, includeContent bool) ([]IncludeFile, error) {
diff --git a/backend/pkg/projects/name.go b/backend/pkg/projects/name.go
index d59e815e4..6cbd765ff 100644
--- a/backend/pkg/projects/name.go
+++ b/backend/pkg/projects/name.go
@@ -25,3 +25,16 @@ func ComposeContentProjectName(composeContent string) string {
}
return loader.NormalizeProjectName(raw)
}
+
+// NormalizeProjectName returns compose-go's normalized project name. If
+// compose-go returns empty, the input is returned unchanged.
+func NormalizeProjectName(name string) string {
+ if name == "" {
+ return ""
+ }
+ normalized := loader.NormalizeProjectName(name)
+ if normalized == "" {
+ return name
+ }
+ return normalized
+}
diff --git a/backend/pkg/projects/name_test.go b/backend/pkg/projects/name_test.go
index 3158d6da9..d791f48f7 100644
--- a/backend/pkg/projects/name_test.go
+++ b/backend/pkg/projects/name_test.go
@@ -22,3 +22,36 @@ func TestComposeContentProjectName(t *testing.T) {
})
}
}
+
+func TestNormalizeProjectName(t *testing.T) {
+ tests := []struct {
+ name string
+ input string
+ expected string
+ }{
+ {
+ name: "simple",
+ input: "myproject",
+ expected: "myproject",
+ },
+ {
+ name: "with special chars",
+ input: "My Project!",
+ expected: "myproject",
+ },
+ {
+ name: "empty",
+ input: "",
+ expected: "",
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ got := NormalizeProjectName(tt.input)
+ if got != tt.expected {
+ t.Fatalf("NormalizeProjectName() = %q, want %q", got, tt.expected)
+ }
+ })
+ }
+}
diff --git a/backend/pkg/projects/pull_policy.go b/backend/pkg/projects/pull_policy.go
new file mode 100644
index 000000000..444fc5c17
--- /dev/null
+++ b/backend/pkg/projects/pull_policy.go
@@ -0,0 +1,151 @@
+package projects
+
+import (
+ "log/slog"
+ "strings"
+
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+)
+
+// ImagePullMode describes when Arcane should pull an image for a project.
+type ImagePullMode int
+
+const (
+ // ImagePullModeNever skips pulling the image.
+ ImagePullModeNever ImagePullMode = iota
+ // ImagePullModeIfMissing pulls only when the image is missing locally.
+ ImagePullModeIfMissing
+ // ImagePullModeAlways pulls even when the image is present locally.
+ ImagePullModeAlways
+)
+
+// DeployImageDecision describes how deploy should handle a service image.
+type DeployImageDecision struct {
+ Build bool
+ PullAlways bool
+ PullIfMissing bool
+ FallbackBuildOnPullFail bool
+ RequireLocalOnly bool
+}
+
+// ResolveServiceImagePullMode resolves compose pull_policy into Arcane's pull mode.
+func ResolveServiceImagePullMode(svc composetypes.ServiceConfig) ImagePullMode {
+ rawPolicy := strings.ToLower(strings.TrimSpace(svc.PullPolicy))
+ switch {
+ case rawPolicy == composetypes.PullPolicyNever:
+ return ImagePullModeNever
+ case rawPolicy == composetypes.PullPolicyAlways:
+ return ImagePullModeAlways
+ case rawPolicy == composetypes.PullPolicyRefresh,
+ rawPolicy == "daily",
+ rawPolicy == "weekly",
+ strings.HasPrefix(rawPolicy, "every_"):
+ return ImagePullModeAlways
+ case rawPolicy == composetypes.PullPolicyMissing,
+ rawPolicy == composetypes.PullPolicyIfNotPresent,
+ rawPolicy == composetypes.PullPolicyBuild,
+ rawPolicy == "":
+ return ImagePullModeIfMissing
+ }
+
+ policy, _, err := svc.GetPullPolicy()
+ if err != nil {
+ slog.Warn("failed to parse service pull_policy, defaulting to missing", "service", svc.Name, "pull_policy", svc.PullPolicy, "error", err)
+ return ImagePullModeIfMissing
+ }
+
+ switch policy {
+ case composetypes.PullPolicyNever:
+ return ImagePullModeNever
+ case composetypes.PullPolicyAlways, composetypes.PullPolicyRefresh:
+ return ImagePullModeAlways
+ case composetypes.PullPolicyMissing, composetypes.PullPolicyIfNotPresent, composetypes.PullPolicyBuild:
+ return ImagePullModeIfMissing
+ default:
+ return ImagePullModeIfMissing
+ }
+}
+
+// BuildImagePullPlan builds a deduplicated image pull plan for non-build services.
+func BuildImagePullPlan(services composetypes.Services) map[string]ImagePullMode {
+ plan := map[string]ImagePullMode{}
+ for _, svc := range services {
+ if svc.Build != nil {
+ continue
+ }
+ img := strings.TrimSpace(svc.Image)
+ if img == "" {
+ continue
+ }
+ mode := ResolveServiceImagePullMode(svc)
+ if existing, exists := plan[img]; !exists || mode > existing {
+ plan[img] = mode
+ }
+ }
+ return plan
+}
+
+// NormalizePullPolicy normalizes compose pull policy aliases.
+func NormalizePullPolicy(policy string) string {
+ policy = strings.ToLower(strings.TrimSpace(policy))
+ if policy == "if_not_present" {
+ return "missing"
+ }
+ return policy
+}
+
+// NormalizeDeployPullPolicy returns a supported deploy pull policy or empty string.
+func NormalizeDeployPullPolicy(policy string) string {
+ normalized := NormalizePullPolicy(policy)
+ switch normalized {
+ case "always", "missing", "never":
+ return normalized
+ default:
+ return ""
+ }
+}
+
+// IsAlwaysPullPolicy reports whether policy means always pull.
+func IsAlwaysPullPolicy(policy string) bool {
+ if policy == "always" || policy == "daily" || policy == "weekly" {
+ return true
+ }
+ return strings.HasPrefix(policy, "every_")
+}
+
+// DecideDeployImageAction decides whether deploy should build, pull, or require local images.
+func DecideDeployImageAction(svc composetypes.ServiceConfig, pullPolicyOverride string) DeployImageDecision {
+ policy := NormalizePullPolicy(svc.PullPolicy)
+ if policy == "" {
+ if override := NormalizeDeployPullPolicy(pullPolicyOverride); override != "" {
+ policy = override
+ }
+ }
+ buildEnabled := svc.Build != nil
+
+ if buildEnabled {
+ switch {
+ case policy == "build":
+ return DeployImageDecision{Build: true}
+ case policy == "never":
+ return DeployImageDecision{RequireLocalOnly: true}
+ case IsAlwaysPullPolicy(policy):
+ return DeployImageDecision{PullAlways: true}
+ case policy == "missing":
+ return DeployImageDecision{PullIfMissing: true}
+ case policy == "":
+ return DeployImageDecision{PullIfMissing: true, FallbackBuildOnPullFail: true}
+ default:
+ return DeployImageDecision{PullIfMissing: true}
+ }
+ }
+
+ switch {
+ case policy == "never":
+ return DeployImageDecision{RequireLocalOnly: true}
+ case IsAlwaysPullPolicy(policy):
+ return DeployImageDecision{PullAlways: true}
+ default:
+ return DeployImageDecision{PullIfMissing: true}
+ }
+}
diff --git a/backend/pkg/projects/pull_policy_test.go b/backend/pkg/projects/pull_policy_test.go
new file mode 100644
index 000000000..5b3fc53cf
--- /dev/null
+++ b/backend/pkg/projects/pull_policy_test.go
@@ -0,0 +1,130 @@
+package projects
+
+import (
+ "testing"
+
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/stretchr/testify/assert"
+)
+
+func TestResolveServiceImagePullMode(t *testing.T) {
+ tests := []struct {
+ name string
+ service composetypes.ServiceConfig
+ expected ImagePullMode
+ }{
+ {
+ name: "default policy is missing",
+ service: composetypes.ServiceConfig{},
+ expected: ImagePullModeIfMissing,
+ },
+ {
+ name: "always policy",
+ service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyAlways},
+ expected: ImagePullModeAlways,
+ },
+ {
+ name: "refresh policy",
+ service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyRefresh},
+ expected: ImagePullModeAlways,
+ },
+ {
+ name: "missing policy",
+ service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyMissing},
+ expected: ImagePullModeIfMissing,
+ },
+ {
+ name: "if not present policy",
+ service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyIfNotPresent},
+ expected: ImagePullModeIfMissing,
+ },
+ {
+ name: "never policy",
+ service: composetypes.ServiceConfig{PullPolicy: composetypes.PullPolicyNever},
+ expected: ImagePullModeNever,
+ },
+ {
+ name: "invalid policy defaults to missing behavior",
+ service: composetypes.ServiceConfig{PullPolicy: "definitely_invalid"},
+ expected: ImagePullModeIfMissing,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ assert.Equal(t, tt.expected, ResolveServiceImagePullMode(tt.service))
+ })
+ }
+}
+
+func TestBuildProjectImagePullPlan(t *testing.T) {
+ services := composetypes.Services{
+ "web": {
+ Name: "web",
+ Image: "redis:latest",
+ PullPolicy: composetypes.PullPolicyIfNotPresent,
+ },
+ "worker": {
+ Name: "worker",
+ Image: "redis:latest",
+ PullPolicy: composetypes.PullPolicyAlways,
+ },
+ "api": {
+ Name: "api",
+ Image: "nginx:latest",
+ PullPolicy: composetypes.PullPolicyNever,
+ },
+ "empty-image": {
+ Name: "empty-image",
+ Image: "",
+ PullPolicy: composetypes.PullPolicyAlways,
+ },
+ }
+
+ plan := BuildImagePullPlan(services)
+
+ assert.Len(t, plan, 2)
+ assert.Equal(t, ImagePullModeAlways, plan["redis:latest"])
+ assert.Equal(t, ImagePullModeNever, plan["nginx:latest"])
+}
+
+func TestNormalizePullPolicy(t *testing.T) {
+ assert.Equal(t, "missing", NormalizePullPolicy("if_not_present"))
+ assert.Equal(t, "build", NormalizePullPolicy(" BUILD "))
+ assert.Equal(t, "", NormalizePullPolicy(""))
+}
+
+func TestDecideDeployImageAction(t *testing.T) {
+ t.Run("build service with explicit build policy", func(t *testing.T) {
+ svc := composetypes.ServiceConfig{
+ PullPolicy: "build",
+ Build: &composetypes.BuildConfig{Context: "."},
+ }
+
+ decision := DecideDeployImageAction(svc, "")
+ assert.True(t, decision.Build)
+ assert.False(t, decision.PullAlways)
+ })
+
+ t.Run("build service default policy uses pull then fallback build", func(t *testing.T) {
+ svc := composetypes.ServiceConfig{Build: &composetypes.BuildConfig{Context: "."}}
+ decision := DecideDeployImageAction(svc, "")
+ assert.True(t, decision.PullIfMissing)
+ assert.True(t, decision.FallbackBuildOnPullFail)
+ assert.False(t, decision.Build)
+ })
+
+ t.Run("non-build service never policy requires local only", func(t *testing.T) {
+ svc := composetypes.ServiceConfig{PullPolicy: "never"}
+ decision := DecideDeployImageAction(svc, "")
+ assert.True(t, decision.RequireLocalOnly)
+ assert.False(t, decision.PullIfMissing)
+ })
+
+ t.Run("compose pull policy wins over deploy override", func(t *testing.T) {
+ svc := composetypes.ServiceConfig{PullPolicy: "never"}
+ decision := DecideDeployImageAction(svc, "always")
+ assert.True(t, decision.RequireLocalOnly)
+ assert.False(t, decision.PullAlways)
+ })
+}