Skip to content

Modern Docker Management, Designed for Everyone

refactor(projects): centralize Compose workflows and consolidate files (#3860)

Kyle Mendell9b45fd5572e5
diff --git a/backend/cli/upgrade/upgrade.go b/backend/cli/upgrade/upgrade.go
index b401902dc..1698f0f01 100644
--- a/backend/cli/upgrade/upgrade.go
+++ b/backend/cli/upgrade/upgrade.go
@@ -11,15 +11,14 @@ import (
"emperror.dev/errors"
- "github.com/containerd/platforms"
"github.com/moby/moby/api/types/container"
- "github.com/moby/moby/api/types/image"
"github.com/moby/moby/api/types/network"
"github.com/moby/moby/client"
"github.com/spf13/cobra"
docker "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
"go.getarcane.app/sys/cgroup"
"go.getarcane.app/updater/labels"
)
@@ -245,42 +244,11 @@ func refreshRecreatedImageLabelsInternal(containerLabels, previousImageLabels, i
refreshed[key] = value
}
- if refreshed != nil && imageDigest != "" {
- for key := range refreshed {
- if strings.EqualFold(key, "com.docker.compose.image") {
- refreshed[key] = imageDigest
- }
- }
- }
+ projects.RefreshComposeImageLabel(refreshed, imageDigest)
return refreshed
}
-// composeImageDigestInternal selects the digest compose v5.5.0 records in the
-// com.docker.compose.image label: the host platform's image-manifest digest,
-// which stays stable across attested rebuilds, falling back to the top-level
-// image ID when the engine reports no manifest data (mirrors compose's
-// localContentDigest). Writing any other value would make compose flag the
-// container as diverged and recreate it on the next up.
-func composeImageDigestInternal(inspect client.ImageInspectResult) string {
- matcher := platforms.Default()
- var available []image.ManifestSummary
- for _, m := range inspect.Manifests {
- if m.Kind == image.ManifestKindImage && m.Available {
- available = append(available, m)
- }
- }
- for _, m := range available {
- if m.ImageData != nil && matcher.Match(m.ImageData.Platform) {
- return m.ID
- }
- }
- if len(available) == 1 {
- return available[0].ID
- }
- return inspect.ID
-}
-
func refreshRecreatedContainerLabelsInternal(ctx context.Context, dockerClient *client.Client, containerLabels map[string]string, previousImage, targetImage string) map[string]string {
// Manifest data is needed to record the platform manifest digest compose
// v5.5.0 expects in com.docker.compose.image; older daemons may reject the
@@ -313,7 +281,7 @@ func refreshRecreatedContainerLabelsInternal(ctx context.Context, dockerClient *
}
}
}
- return refreshRecreatedImageLabelsInternal(containerLabels, previousImageLabels, imageLabels, composeImageDigestInternal(imageInspect))
+ return refreshRecreatedImageLabelsInternal(containerLabels, previousImageLabels, imageLabels, projects.ComposeImageDigest(imageInspect))
}
func hasOCIImageLabelInternal(containerLabels map[string]string) bool {
diff --git a/backend/internal/container/handler.go b/backend/internal/container/handler.go
index 62b130882..1da544862 100644
--- a/backend/internal/container/handler.go
+++ b/backend/internal/container/handler.go
@@ -25,6 +25,7 @@ import (
dockerutils "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane"
activitylib "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/activity"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/handlerutil"
"github.com/getarcaneapp/arcane/types/v2/base"
@@ -645,7 +646,7 @@ func (h *ContainerHandler) GetContainer(ctx context.Context, input *GetContainer
}
func (h *ContainerHandler) GenerateCompose(ctx context.Context, input *GenerateComposeInput) (*handlerutil.Out[containertypes.GenerateComposeResponse], error) {
- composeContent, err := h.containerService.GenerateCompose(ctx, input.Body.ContainerIDs)
+ composeContent, err := projects.ComposeGenerate(ctx, h.dockerService.DockerHost(), "", input.Body.ContainerIDs)
if err != nil {
return nil, huma.Error500InternalServerError(errors.WithMessage(err, "Failed to generate compose file").Error())
}
diff --git a/backend/internal/container/service.go b/backend/internal/container/service.go
index 0bb0f6fca..6a37daf56 100644
--- a/backend/internal/container/service.go
+++ b/backend/internal/container/service.go
@@ -19,7 +19,6 @@ import (
"emperror.dev/errors"
- composetypes "github.com/compose-spec/compose-go/v2/types"
"github.com/moby/moby/api/types/container"
"github.com/moby/moby/api/types/mount"
"github.com/moby/moby/api/types/network"
@@ -556,7 +555,10 @@ func (s *ContainerService) tryRedeployViaComposeProjectInternal(ctx context.Cont
return "", true, errors.WrapIff(err, "compose redeploy failed for %s/%s", projectName, serviceName)
}
- newID := s.findComposeServiceContainerIDInternal(ctx, projectName, serviceName)
+ newID, lookupErr := projects.FindComposeServiceContainerID(ctx, s.dockerService.DockerHost(), projectName, serviceName)
+ if lookupErr != nil {
+ slog.WarnContext(ctx, "failed to resolve container via compose ps after redeploy", "project", projectName, "service", serviceName, "err", lookupErr)
+ }
if newID == "" {
// Recreated successfully but couldn't locate the new container; return the
// original ID so the handler can degrade gracefully.
@@ -578,50 +580,6 @@ func (s *ContainerService) tryRedeployViaComposeProjectInternal(ctx context.Cont
return newID, true, nil
}
-// findComposeServiceContainerIDInternal locates the (presumably newly recreated)
-// container for a given compose project+service pair using the compose SDK's Ps
-// command. When multiple containers match (a stopped predecessor can briefly
-// linger during recreation), the first running one is preferred; otherwise the
-// first match is returned. Returns "" when none found.
-func (s *ContainerService) findComposeServiceContainerIDInternal(ctx context.Context, projectName, serviceName string) string {
- containers, err := projects.ComposePs(ctx, s.dockerService.DockerHost(), &composetypes.Project{Name: projectName}, []string{serviceName}, true)
- if err != nil {
- slog.WarnContext(ctx, "failed to resolve container via compose ps after redeploy",
- "project", projectName,
- "service", serviceName,
- "err", err,
- )
- return ""
- }
-
- var firstMatch string
- for _, c := range containers {
- if c.Service != serviceName {
- continue
- }
- if firstMatch == "" {
- firstMatch = c.ID
- }
- if c.State == "running" {
- return c.ID
- }
- }
- return firstMatch
-}
-
-func (s *ContainerService) GenerateCompose(ctx context.Context, containerIDs []string) (string, error) {
- proj, err := projects.ComposeGenerate(ctx, s.dockerService.DockerHost(), "", containerIDs)
- if err != nil {
- return "", err
- }
-
- content, err := proj.MarshalYAML()
- if err != nil {
- return "", errors.WithMessage(err, "failed to marshal generated compose project")
- }
- return string(content), nil
-}
-
func (s *ContainerService) RedeployContainer(ctx context.Context, containerID string, user common.User) (string, error) {
dockerClient, err := s.dockerService.GetClient(ctx)
if err != nil {
diff --git a/backend/internal/gitops/gitops_sync.go b/backend/internal/gitops/gitops_sync.go
index 4507bf62d..b6efc0796 100644
--- a/backend/internal/gitops/gitops_sync.go
+++ b/backend/internal/gitops/gitops_sync.go
@@ -1073,7 +1073,7 @@ func (s *GitOpsSyncService) performSingleFileSyncInternal(ctx context.Context, s
// or COMPOSE_ENV_FILES, those files never reach the project, so direct the
// user to directory sync instead of silently deploying an incomplete
// selection.
- if composeFileEnvNeedsDirectorySyncInternal(sync, source) {
+ if projects.ComposeEnvRequiresDirectorySync(sync.ComposePath, source.overrideFileName, source.envContent) {
return result, s.failSync(ctx, id, result, sync, actor,
"COMPOSE_FILE or COMPOSE_ENV_FILES references additional files",
"the synced .env references additional files via COMPOSE_FILE or COMPOSE_ENV_FILES; enable \"Sync entire directory\" for this sync")
@@ -1098,47 +1098,6 @@ func (s *GitOpsSyncService) performSingleFileSyncInternal(ctx context.Context, s
return result, nil
}
-// composeFileEnvNeedsDirectorySyncInternal reports whether the synced .env
-// declares a COMPOSE_FILE or COMPOSE_ENV_FILES selection that single-file sync
-// cannot satisfy — i.e. it references any file other than the ones single-file
-// sync actually ships (the synced compose file, its sibling override, and .env
-// itself), or any file in a subdirectory.
-func composeFileEnvNeedsDirectorySyncInternal(sync *projectpkg.GitOpsSync, source *preparedSyncSource) bool {
- if source == nil || source.envContent == nil {
- return false
- }
- envMap, err := projects.ParseProjectEnvContent(*source.envContent, nil)
- if err != nil || len(envMap) == 0 {
- return false
- }
-
- allowedComposeFiles := map[string]struct{}{filepath.Base(sync.ComposePath): {}}
- if source.overrideFileName != "" {
- allowedComposeFiles[source.overrideFileName] = struct{}{}
- }
- if entriesNeedDirectorySyncInternal(projects.ComposeFileEntriesFromEnv(envMap), allowedComposeFiles) {
- return true
- }
-
- // Single-file sync writes the synced env content to .env, so a
- // self-reference is satisfiable; anything else never reaches the project.
- return entriesNeedDirectorySyncInternal(projects.ComposeEnvFileEntriesFromEnv(envMap), map[string]struct{}{projects.EffectiveEnvFileName: {}})
-}
-
-func entriesNeedDirectorySyncInternal(entries []string, allowed map[string]struct{}) bool {
- for _, entry := range entries {
- // Normalize so relative prefixes like "./compose.yaml" match allowed.
- cleaned := filepath.Clean(entry)
- if cleaned != filepath.Base(cleaned) {
- return true // nested path can't be single-file synced
- }
- if _, ok := allowed[cleaned]; !ok {
- return true
- }
- }
- return false
-}
-
// buildSwarmStackDeployRequestInternal assembles the deploy request for a Git Sync that targets
// a Swarm stack. WithRegistryAuth is always set so the Git Sync path resolves stored registry
// credentials the same way a direct stack deploy does. Resolution happens per image at deploy
diff --git a/backend/internal/project/handler.go b/backend/internal/project/handler.go
index 8f2a56ec0..0bc0ef3b2 100644
--- a/backend/internal/project/handler.go
+++ b/backend/internal/project/handler.go
@@ -1,8 +1,6 @@
package project
import (
- "github.com/getarcaneapp/arcane/backend/v2/internal/database"
-
"context"
stderrors "errors"
"fmt"
@@ -13,24 +11,26 @@ import (
"strings"
"time"
- activitytypes "github.com/getarcaneapp/arcane/types/v2/activity"
-
"emperror.dev/errors"
"github.com/danielgtaylor/huma/v2"
"github.com/getarcaneapp/arcane/backend/v2/internal/activity"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/database"
"github.com/getarcaneapp/arcane/backend/v2/internal/middleware"
"github.com/getarcaneapp/arcane/backend/v2/pkg/authz"
dockerutils "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
activitylib "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/activity"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumes"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/handlerutil"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/httpx"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/mapper"
workspacepkg "github.com/getarcaneapp/arcane/backend/v2/pkg/workspace"
+ activitytypes "github.com/getarcaneapp/arcane/types/v2/activity"
"github.com/getarcaneapp/arcane/types/v2/base"
- "github.com/getarcaneapp/arcane/types/v2/project"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
+ workspacetypes "github.com/getarcaneapp/arcane/types/v2/workspace"
"github.com/samber/mo"
"gorm.io/gorm"
)
@@ -70,13 +70,13 @@ type ListProjectTagsInput struct {
type UpdateProjectTagInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
ProjectID string `path:"projectId" doc:"Project ID"`
- Body project.UpdateTag
+ Body projecttypes.UpdateTag
}
type DeployProjectInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
ProjectID string `path:"projectId" doc:"Project ID"`
- Body *project.DeployOptions
+ Body *projecttypes.DeployOptions
}
type DownProjectInput struct {
@@ -97,19 +97,19 @@ type GetProjectInput struct {
type RedeployProjectInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
ProjectID string `path:"projectId" doc:"Project ID"`
- Body *project.DeployOptions
+ Body *projecttypes.DeployOptions
}
type DestroyProjectInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
ProjectID string `path:"projectId" doc:"Project ID"`
- Body *project.Destroy
+ Body *projecttypes.Destroy
}
type UpdateProjectInput struct {
EnvironmentID string `path:"id" doc:"Environment ID"`
ProjectID string `path:"projectId" doc:"Project ID"`
- Body project.UpdateProject
+ Body projecttypes.UpdateProject
}
type RestartProjectInput struct {
@@ -379,7 +379,7 @@ func RegisterProjects(api huma.API, projectService *ProjectService, activityServ
}
// ListProjects returns a paginated list of projects.
-func (h *ProjectHandler) ListProjects(ctx context.Context, input *ListProjectsInput) (*handlerutil.Page[project.Details], error) {
+func (h *ProjectHandler) ListProjects(ctx context.Context, input *ListProjectsInput) (*handlerutil.Page[projecttypes.Details], error) {
params := handlerutil.PaginationParams(input.Start, input.Limit, input.Sort, input.Order, input.Search)
if input.Status != "" {
params.Filters["status"] = input.Status
@@ -403,11 +403,11 @@ func (h *ProjectHandler) ListProjects(ctx context.Context, input *ListProjectsIn
}
if projects == nil {
- projects = []project.Details{}
+ projects = []projecttypes.Details{}
}
- return &handlerutil.Page[project.Details]{
- Body: base.Paginated[project.Details]{
+ return &handlerutil.Page[projecttypes.Details]{
+ Body: base.Paginated[projecttypes.Details]{
Success: true,
Data: projects,
Pagination: handlerutil.PaginationResponse(paginationResp),
@@ -416,16 +416,16 @@ func (h *ProjectHandler) ListProjects(ctx context.Context, input *ListProjectsIn
}
// GetProjectStatusCounts returns counts of projects by status.
-func (h *ProjectHandler) GetProjectStatusCounts(ctx context.Context, input *GetProjectStatusCountsInput) (*handlerutil.Out[project.StatusCounts], error) {
+func (h *ProjectHandler) GetProjectStatusCounts(ctx context.Context, input *GetProjectStatusCountsInput) (*handlerutil.Out[projecttypes.StatusCounts], error) {
_, running, stopped, total, archived, err := h.projectService.GetProjectStatusCounts(ctx)
if err != nil {
return nil, huma.Error500InternalServerError(errors.WithMessage(err, "Failed to get project status counts").Error())
}
- return &handlerutil.Out[project.StatusCounts]{
- Body: base.ApiResponse[project.StatusCounts]{
+ return &handlerutil.Out[projecttypes.StatusCounts]{
+ Body: base.ApiResponse[projecttypes.StatusCounts]{
Success: true,
- Data: project.StatusCounts{
+ Data: projecttypes.StatusCounts{
RunningProjects: running,
StoppedProjects: stopped,
TotalProjects: total,
@@ -436,25 +436,25 @@ func (h *ProjectHandler) GetProjectStatusCounts(ctx context.Context, input *GetP
}
// ListProjectTags returns the reusable project tag catalog for an environment.
-func (h *ProjectHandler) ListProjectTags(ctx context.Context, _ *ListProjectTagsInput) (*handlerutil.Out[[]project.TagOption], error) {
+func (h *ProjectHandler) ListProjectTags(ctx context.Context, _ *ListProjectTagsInput) (*handlerutil.Out[[]projecttypes.TagOption], error) {
options, err := h.projectService.ListProjectTagOptions(ctx)
if err != nil {
return nil, huma.Error500InternalServerError(errors.WithMessage(err, "Failed to list project tags").Error())
}
if options == nil {
- options = []project.TagOption{}
+ options = []projecttypes.TagOption{}
}
- return &handlerutil.Out[[]project.TagOption]{Body: base.ApiResponse[[]project.TagOption]{Success: true, Data: options}}, nil
+ return &handlerutil.Out[[]projecttypes.TagOption]{Body: base.ApiResponse[[]projecttypes.TagOption]{Success: true, Data: options}}, nil
}
// UpdateProjectTag applies one UI-managed project tag association change.
-func (h *ProjectHandler) UpdateProjectTag(ctx context.Context, input *UpdateProjectTagInput) (*handlerutil.Out[project.UpdateTagResponse], error) {
+func (h *ProjectHandler) UpdateProjectTag(ctx context.Context, input *UpdateProjectTagInput) (*handlerutil.Out[projecttypes.UpdateTagResponse], error) {
user, err := handlerutil.RequireUser(ctx)
if err != nil {
return nil, err
}
- var tags []project.Tag
+ var tags []projecttypes.Tag
runtimeCtx := utils.ActivityRuntimeContext(ctx, h.appCtx)
activityID, err := activitylib.RunHandlerActivity(runtimeCtx, h.activityService, activitylib.HandlerOptions{
EnvironmentID: input.EnvironmentID,
@@ -483,9 +483,9 @@ func (h *ProjectHandler) UpdateProjectTag(ctx context.Context, input *UpdateProj
}
}
- return &handlerutil.Out[project.UpdateTagResponse]{Body: base.ApiResponse[project.UpdateTagResponse]{
+ return &handlerutil.Out[projecttypes.UpdateTagResponse]{Body: base.ApiResponse[projecttypes.UpdateTagResponse]{
Success: true,
- Data: project.UpdateTagResponse{
+ Data: projecttypes.UpdateTagResponse{
Tags: tags,
ActivityID: mo.EmptyableToOption(strings.TrimSpace(activityID)).ToPointer(),
},
@@ -622,13 +622,13 @@ func (h *ProjectHandler) DownProject(ctx context.Context, input *DownProjectInpu
}
func projectUpdateHTTPErrorInternal(err error) error {
- if conflictErr, ok := stderrors.AsType[*volumes.ProjectVolumeRenameConflictError](err); ok {
+ if conflictErr, ok := stderrors.AsType[*volumetypes.ProjectVolumeRenameConflictError](err); ok {
return huma.Error409Conflict(conflictErr.Error())
}
- if inUseErr, ok := stderrors.AsType[*volumes.ProjectVolumeRenameInUseError](err); ok {
+ if inUseErr, ok := stderrors.AsType[*volumetypes.ProjectVolumeRenameInUseError](err); ok {
return huma.Error409Conflict(inUseErr.Error())
}
- if spaceErr, ok := stderrors.AsType[*volumes.ProjectVolumeRenameInsufficientSpaceError](err); ok {
+ if spaceErr, ok := stderrors.AsType[*volumetypes.ProjectVolumeRenameInsufficientSpaceError](err); ok {
return huma.NewError(http.StatusInsufficientStorage, spaceErr.Error())
}
return projectWorkspaceRequestHTTPErrorInternal(err)
@@ -650,12 +650,12 @@ func projectWorkspaceRequestHTTPErrorInternal(err error) error {
}
// CreateProject creates a new Docker Compose project.
-func (h *ProjectHandler) CreateProject(ctx context.Context, input *CreateProjectInput) (*handlerutil.Out[project.CreateReponse], error) {
- projectInput, err := handlerutil.ParseMultipartJSONPart[project.CreateProject](input.RawBody, "project")
+func (h *ProjectHandler) CreateProject(ctx context.Context, input *CreateProjectInput) (*handlerutil.Out[projecttypes.CreateReponse], error) {
+ projectInput, err := handlerutil.ParseMultipartJSONPart[projecttypes.CreateProject](input.RawBody, "project")
if err != nil {
return nil, err
}
- manifest, err := handlerutil.ParseMultipartJSONPart[project.CreateProjectWorkspaceManifest](input.RawBody, "manifest")
+ manifest, err := handlerutil.ParseMultipartJSONPart[projecttypes.CreateProjectWorkspaceManifest](input.RawBody, "manifest")
if err != nil {
return nil, err
}
@@ -697,7 +697,7 @@ func (h *ProjectHandler) CreateProject(ctx context.Context, input *CreateProject
return nil, huma.Error500InternalServerError(errors.WithMessage(err, "Failed to create project").Error())
}
- var response project.CreateReponse
+ var response projecttypes.CreateReponse
if err := mapper.MapStruct(proj, &response); err != nil {
return nil, huma.Error500InternalServerError("failed to map response")
}
@@ -716,8 +716,8 @@ func (h *ProjectHandler) CreateProject(ctx context.Context, input *CreateProject
return nil, huma.Error500InternalServerError(errors.WithMessage(err, "Failed to load project tags").Error())
}
- return &handlerutil.Out[project.CreateReponse]{
- Body: base.ApiResponse[project.CreateReponse]{
+ return &handlerutil.Out[projecttypes.CreateReponse]{
+ Body: base.ApiResponse[projecttypes.CreateReponse]{
Success: true,
Data: response,
},
@@ -725,25 +725,25 @@ func (h *ProjectHandler) CreateProject(ctx context.Context, input *CreateProject
}
// GetProject returns a project by ID.
-func (h *ProjectHandler) GetProject(ctx context.Context, input *GetProjectInput) (*handlerutil.Out[project.Details], error) {
+func (h *ProjectHandler) GetProject(ctx context.Context, input *GetProjectInput) (*handlerutil.Out[projecttypes.Details], error) {
if input.ProjectID == "" {
return nil, huma.Error400BadRequest("Project ID is required")
}
- details, err := h.projectService.GetProjectDetails(ctx, input.ProjectID, project.DetailsOptions{})
+ details, err := h.projectService.GetProjectDetails(ctx, input.ProjectID, projecttypes.DetailsOptions{})
if err != nil {
return nil, huma.Error404NotFound(errors.WithMessage(err, "Failed to get project details").Error())
}
- return &handlerutil.Out[project.Details]{
- Body: base.ApiResponse[project.Details]{
+ return &handlerutil.Out[projecttypes.Details]{
+ Body: base.ApiResponse[projecttypes.Details]{
Success: true,
Data: details,
},
}, nil
}
-func (h *ProjectHandler) getProjectDetailsWithOptionsInternal(ctx context.Context, input *GetProjectInput, opts project.DetailsOptions) (*handlerutil.Out[project.Details], error) {
+func (h *ProjectHandler) getProjectDetailsWithOptionsInternal(ctx context.Context, input *GetProjectInput, opts projecttypes.DetailsOptions) (*handlerutil.Out[projecttypes.Details], error) {
if input.ProjectID == "" {
return nil, huma.Error400BadRequest("Project ID is required")
}
@@ -753,16 +753,16 @@ func (h *ProjectHandler) getProjectDetailsWithOptionsInternal(ctx context.Contex
return nil, huma.Error404NotFound(errors.WithMessage(err, "Failed to get project details").Error())
}
- return &handlerutil.Out[project.Details]{
- Body: base.ApiResponse[project.Details]{
+ return &handlerutil.Out[projecttypes.Details]{
+ Body: base.ApiResponse[projecttypes.Details]{
Success: true,
Data: details,
},
}, nil
}
-func (h *ProjectHandler) GetProjectCompose(ctx context.Context, input *GetProjectInput) (*handlerutil.Out[project.Details], error) {
- return h.getProjectDetailsWithOptionsInternal(ctx, input, project.DetailsOptions{
+func (h *ProjectHandler) GetProjectCompose(ctx context.Context, input *GetProjectInput) (*handlerutil.Out[projecttypes.Details], error) {
+ return h.getProjectDetailsWithOptionsInternal(ctx, input, projecttypes.DetailsOptions{
IncludeComposeContent: true,
IncludeEnvState: true,
IncludeIncludeFiles: true,
@@ -770,14 +770,14 @@ func (h *ProjectHandler) GetProjectCompose(ctx context.Context, input *GetProjec
})
}
-func (h *ProjectHandler) GetProjectRuntime(ctx context.Context, input *GetProjectInput) (*handlerutil.Out[project.Details], error) {
- return h.getProjectDetailsWithOptionsInternal(ctx, input, project.DetailsOptions{
+func (h *ProjectHandler) GetProjectRuntime(ctx context.Context, input *GetProjectInput) (*handlerutil.Out[projecttypes.Details], error) {
+ return h.getProjectDetailsWithOptionsInternal(ctx, input, projecttypes.DetailsOptions{
IncludeRuntimeServices: true,
})
}
-func (h *ProjectHandler) GetProjectUpdates(ctx context.Context, input *GetProjectInput) (*handlerutil.Out[project.Details], error) {
- return h.getProjectDetailsWithOptionsInternal(ctx, input, project.DetailsOptions{
+func (h *ProjectHandler) GetProjectUpdates(ctx context.Context, input *GetProjectInput) (*handlerutil.Out[projecttypes.Details], error) {
+ return h.getProjectDetailsWithOptionsInternal(ctx, input, projecttypes.DetailsOptions{
IncludeServiceConfigs: true,
IncludeUpdateInfo: true,
})
@@ -856,7 +856,7 @@ func (h *ProjectHandler) DestroyProject(ctx context.Context, input *DestroyProje
}
// UpdateProject updates a Docker Compose project.
-func (h *ProjectHandler) UpdateProject(ctx context.Context, input *UpdateProjectInput) (*handlerutil.Out[project.Details], error) {
+func (h *ProjectHandler) UpdateProject(ctx context.Context, input *UpdateProjectInput) (*handlerutil.Out[projecttypes.Details], error) {
if input.ProjectID == "" {
return nil, huma.Error400BadRequest("Project ID is required")
}
@@ -889,7 +889,7 @@ func (h *ProjectHandler) UpdateProject(ctx context.Context, input *UpdateProject
return nil, huma.Error400BadRequest(errors.WithMessage(err, "Failed to update project").Error())
}
- details, err := h.projectService.GetProjectDetails(runtimeCtx, input.ProjectID, project.DetailsOptions{
+ details, err := h.projectService.GetProjectDetails(runtimeCtx, input.ProjectID, projecttypes.DetailsOptions{
IncludeComposeContent: true,
IncludeEnvState: true,
IncludeIncludeFiles: true,
@@ -902,8 +902,8 @@ func (h *ProjectHandler) UpdateProject(ctx context.Context, input *UpdateProject
}
details.ActivityID = mo.EmptyableToOption(strings.TrimSpace(activityID)).ToPointer()
- return &handlerutil.Out[project.Details]{
- Body: base.ApiResponse[project.Details]{
+ return &handlerutil.Out[projecttypes.Details]{
+ Body: base.ApiResponse[projecttypes.Details]{
Success: true,
Data: details,
},
@@ -1134,7 +1134,7 @@ func (h *ProjectHandler) BuildProjectImages(ctx context.Context, input *BuildPro
return nil, err
}
- options := ProjectBuildOptions{}
+ options := projecttypes.BuildOptions{}
if input.Body != nil {
options.Services = input.Body.Services
options.Provider = input.Body.Provider
@@ -1155,3 +1155,107 @@ func (h *ProjectHandler) BuildProjectImages(ctx context.Context, input *BuildPro
},
}), nil
}
+
+type GetProjectWorkspaceInput struct {
+ EnvironmentID string `path:"id" doc:"Environment ID"`
+ ProjectID string `path:"projectId" doc:"Project ID"`
+}
+
+type GetProjectWorkspaceFileInput struct {
+ EnvironmentID string `path:"id" doc:"Environment ID"`
+ ProjectID string `path:"projectId" doc:"Project ID"`
+ RelativePath string `query:"relativePath" doc:"Path relative to the project workspace root"`
+}
+
+type UpdateProjectWorkspaceInput struct {
+ EnvironmentID string `path:"id" doc:"Environment ID"`
+ ProjectID string `path:"projectId" doc:"Project ID"`
+ RawBody multipart.Form `contentType:"multipart/form-data"`
+}
+
+func registerProjectWorkspaceRoutesInternal(api huma.API, h *ProjectHandler) {
+ basePath := "/environments/{id}/projects/{projectId}/workspace"
+ tag := "Project Workspace"
+ handlerutil.RegisterSecured(api, handlerutil.Operation("get-project-workspace", http.MethodGet, basePath, "Get project workspace", "", tag), authz.PermProjectsRead, h.GetProjectWorkspace)
+ handlerutil.RegisterSecured(api, handlerutil.Operation("get-project-workspace-file", http.MethodGet, basePath+"/file", "Get project workspace file", "", tag), authz.PermProjectsRead, h.GetProjectWorkspaceFile)
+ handlerutil.RegisterSecured(api, handlerutil.Operation("download-project-workspace-file", http.MethodGet, basePath+"/file/download", "Download project workspace file", "", tag), authz.PermProjectsRead, h.DownloadProjectWorkspaceFile)
+ updateOperation := handlerutil.Operation("update-project-workspace", http.MethodPut, basePath, "Update project workspace", "", tag)
+ updateOperation.RequestBody = handlerutil.WorkspaceMultipartRequestBody("JSON encoded project workspace manifest")
+ handlerutil.RegisterSecured(api, updateOperation, authz.PermProjectsUpdate, h.UpdateProjectWorkspace)
+}
+
+func projectWorkspaceHTTPErrorInternal(err error) error {
+ switch {
+ case errors.Is(err, common.ErrProjectWorkspaceConflict):
+ return huma.Error409Conflict(err.Error())
+ case errors.Is(err, common.ErrProjectArchived):
+ return huma.Error409Conflict(err.Error())
+ case errors.Is(err, common.ErrProjectWorkspaceForbidden):
+ return huma.Error403Forbidden(err.Error())
+ case errors.Is(err, common.ErrProjectWorkspaceNotFound), errors.Is(err, common.ErrProjectNotFound):
+ return huma.Error404NotFound(err.Error())
+ case errors.Is(err, common.ErrProjectWorkspaceBadRequest):
+ return huma.Error400BadRequest(err.Error())
+ default:
+ return huma.Error500InternalServerError("internal error")
+ }
+}
+
+func (h *ProjectHandler) GetProjectWorkspace(ctx context.Context, input *GetProjectWorkspaceInput) (*handlerutil.Out[workspacetypes.Workspace], error) {
+ result, err := h.projectService.GetProjectWorkspace(ctx, input.ProjectID)
+ if err != nil {
+ return nil, projectWorkspaceHTTPErrorInternal(err)
+ }
+ return &handlerutil.Out[workspacetypes.Workspace]{Body: base.ApiResponse[workspacetypes.Workspace]{Success: true, Data: *result}}, nil
+}
+
+func (h *ProjectHandler) GetProjectWorkspaceFile(ctx context.Context, input *GetProjectWorkspaceFileInput) (*handlerutil.Out[workspacetypes.FileContent], error) {
+ result, err := h.projectService.GetProjectWorkspaceFile(ctx, input.ProjectID, input.RelativePath)
+ if err != nil {
+ return nil, projectWorkspaceHTTPErrorInternal(err)
+ }
+ return &handlerutil.Out[workspacetypes.FileContent]{Body: base.ApiResponse[workspacetypes.FileContent]{Success: true, Data: *result}}, nil
+}
+
+func (h *ProjectHandler) DownloadProjectWorkspaceFile(ctx context.Context, input *GetProjectWorkspaceFileInput) (*huma.StreamResponse, error) {
+ reader, size, name, err := h.projectService.DownloadProjectWorkspaceFile(ctx, input.ProjectID, input.RelativePath)
+ if err != nil {
+ return nil, projectWorkspaceHTTPErrorInternal(err)
+ }
+ return handlerutil.DownloadResponse(reader, size, name), nil
+}
+
+func (h *ProjectHandler) UpdateProjectWorkspace(ctx context.Context, input *UpdateProjectWorkspaceInput) (*handlerutil.Out[workspacetypes.Workspace], error) {
+ manifest, err := handlerutil.ParseMultipartJSONPart[projecttypes.WorkspaceUpdateManifest](input.RawBody, "manifest")
+ if err != nil {
+ return nil, err
+ }
+ maxFileSizeMB := workspacepkg.DefaultMaxFileSizeMB
+ if h.projectService != nil && h.projectService.config != nil {
+ maxFileSizeMB = h.projectService.config.ProjectWorkspaceMaxFileSizeMB
+ }
+ uploads, err := handlerutil.ReadWorkspaceUploads(input.RawBody, workspacepkg.MaxFileSizeBytes(maxFileSizeMB))
+ if err != nil {
+ return nil, err
+ }
+ user, err := handlerutil.RequireUser(ctx)
+ if err != nil {
+ return nil, err
+ }
+ var result *workspacetypes.Workspace
+ runtimeCtx := utils.ActivityRuntimeContext(ctx, h.appCtx)
+ activityID, err := activitylib.RunHandlerActivity(runtimeCtx, h.activityService, activitylib.HandlerOptions{
+ EnvironmentID: input.EnvironmentID, Type: activitytypes.TypeResourceAction, ResourceType: "project", ResourceID: input.ProjectID, ResourceName: input.ProjectID, User: user,
+ Step: "Updating project workspace", Message: "Updating project workspace", SuccessMessage: "Project workspace updated successfully",
+ Metadata: database.JSON{"action": "update_project_workspace", "fileChangeCount": len(manifest.FileChanges)},
+ }, func(runtimeCtx context.Context) error {
+ var updateErr error
+ result, updateErr = h.projectService.UpdateProjectWorkspace(runtimeCtx, input.ProjectID, manifest, uploads, *user)
+ return updateErr
+ })
+ if err != nil {
+ return nil, projectWorkspaceHTTPErrorInternal(err)
+ }
+ result.ActivityID = mo.EmptyableToOption(strings.TrimSpace(activityID)).ToPointer()
+ return &handlerutil.Out[workspacetypes.Workspace]{Body: base.ApiResponse[workspacetypes.Workspace]{Success: true, Data: *result}}, nil
+}
diff --git a/backend/internal/project/project.go b/backend/internal/project/project.go
index cd0a2efa8..afdaec7fb 100644
--- a/backend/internal/project/project.go
+++ b/backend/internal/project/project.go
@@ -1,8 +1,6 @@
package project
import (
- "github.com/getarcaneapp/arcane/backend/v2/internal/common"
-
"context"
"io"
"log/slog"
@@ -10,23 +8,25 @@ import (
"path/filepath"
"strings"
"sync"
-
- "github.com/getarcaneapp/arcane/backend/v2/internal/registry"
+ "time"
"emperror.dev/errors"
-
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/getarcaneapp/arcane/backend/v2/internal/config"
"github.com/getarcaneapp/arcane/backend/v2/internal/database"
"github.com/getarcaneapp/arcane/backend/v2/internal/docker"
"github.com/getarcaneapp/arcane/backend/v2/internal/event"
"github.com/getarcaneapp/arcane/backend/v2/internal/image"
"github.com/getarcaneapp/arcane/backend/v2/internal/kv"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/registry"
"github.com/getarcaneapp/arcane/backend/v2/internal/settings"
"github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/getarcaneapp/arcane/types/v2/containerregistry"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
dockerregistry "github.com/moby/moby/api/types/registry"
"github.com/moby/moby/client"
- "github.com/samber/hot"
"github.com/samber/mo"
buildtypes "go.getarcane.app/builds/types"
"gorm.io/gorm"
@@ -38,6 +38,7 @@ type buildServiceInternal interface {
}
type ProjectService struct {
+ composeCoordinator projecttypes.ComposeCoordinator
db *database.DB
settingsService *settings.SettingsService
eventService *event.EventService
@@ -55,12 +56,12 @@ type ProjectService struct {
syncMu sync.Mutex
composeNames composeNameCacheInternal
- parsedCompose *parsedComposeCacheInternal
+ parsedCompose projecttypes.ComposeCache[*composetypes.Project]
// metaCache holds per-project icon/URL metadata, keyed by project ID. Deriving
// it costs a full compose load (interpolation plus .env reads) and, for GitOps
// projects, a gitops_syncs lookup — per project, on every list request.
// Entries are validated by compose/include/env file mtimes rather than a TTL.
- metaCache *hot.HotCache[string, projectMetadataEntryInternal]
+ metaCache projecttypes.ComposeCache[projects.ArcaneComposeMetadata]
}
// EnsureGitOpsProjectLinked persists the bidirectional GitOps/project binding
@@ -74,7 +75,7 @@ func (s *ProjectService) EnsureGitOpsProjectLinked(ctx context.Context, sync *Gi
}
cacheBinding := func() {
- s.composeNames.put(projects.NormalizeProjectName(project.Name), project.ID)
+ s.composeNames.putInternal(projects.NormalizeProjectName(project.Name), project.ID)
}
if sync.ProjectID != nil && *sync.ProjectID == project.ID && project.GitOpsManagedBy != nil && *project.GitOpsManagedBy == sync.ID {
cacheBinding()
@@ -133,7 +134,7 @@ func (s *ProjectService) ValidateComposeDirectory(ctx context.Context, projectNa
pathMapper,
nil,
nil,
- true,
+ true, nil, nil,
)
if err != nil {
return 0, err
@@ -164,7 +165,7 @@ func (s *ProjectService) CreateGitOpsManagedProject(ctx context.Context, sync *G
sync.ProjectID = &project.ID
project.GitOpsManagedBy = &sync.ID
- s.composeNames.put(projects.NormalizeProjectName(project.Name), project.ID)
+ s.composeNames.putInternal(projects.NormalizeProjectName(project.Name), project.ID)
if err := s.reconcileComposeTagsForProjectInternal(ctx, project); err != nil {
slog.WarnContext(ctx, "failed to reconcile Compose project tags during GitOps project creation", "projectID", project.ID, "error", err)
}
@@ -195,6 +196,7 @@ type registryCredentialsProviderInternal func(context.Context) ([]containerregis
func NewProjectService(db *database.DB, settingsService *settings.SettingsService, eventService *event.EventService, imageService *image.ImageService, dockerService *docker.DockerClientService, buildService buildServiceInternal, lifecycleService *LifecycleService, containerRegistryService *registry.ContainerRegistryService, cfg *config.Config) *ProjectService {
return &ProjectService{
+ composeCoordinator: projects.NewCoordinator(projecttypes.ComposeCommands{Stop: composeStopProjectServicesInternal, Up: composeUpProjectServicesInternal}),
db: db,
settingsService: settingsService,
eventService: eventService,
@@ -204,8 +206,8 @@ func NewProjectService(db *database.DB, settingsService *settings.SettingsServic
lifecycleService: lifecycleService,
containerRegistryService: containerRegistryService,
config: cfg,
- parsedCompose: newParsedComposeCacheInternal(),
- metaCache: hot.NewHotCache[string, projectMetadataEntryInternal](hot.LRU, 1024).Build(),
+ parsedCompose: projects.NewParsedComposeCache(),
+ metaCache: projects.NewComposeCache[projects.ArcaneComposeMetadata](1024, nil),
}
}
@@ -342,7 +344,7 @@ func (s *ProjectService) GetProjectByComposeName(ctx context.Context, name strin
var proj Project
err := s.db.WithContext(ctx).Where("name = ? OR name = ?", name, normalized).First(&proj).Error
if err == nil {
- s.composeNames.put(normalized, proj.ID)
+ s.composeNames.putInternal(normalized, proj.ID)
return &proj, nil
}
if !errors.Is(err, gorm.ErrRecordNotFound) {
@@ -419,3 +421,249 @@ func (s *ProjectService) projectPathMapperInternal(ctx context.Context) *project
dockerClient,
)
}
+
+// composeNameCacheInternal maps normalized compose project names to project
+// IDs so a name lookup skips the projects table scan.
+type composeNameCacheInternal struct {
+ mu sync.RWMutex
+ byName map[string]string
+}
+
+func (c *composeNameCacheInternal) projectIDInternal(normalizedName string) mo.Option[string] {
+ if normalizedName == "" {
+ return mo.None[string]()
+ }
+
+ c.mu.RLock()
+ defer c.mu.RUnlock()
+
+ if c.byName == nil {
+ return mo.None[string]()
+ }
+
+ projectID, ok := c.byName[normalizedName]
+ return mo.TupleToOption(projectID, ok)
+}
+
+func (c *composeNameCacheInternal) putInternal(normalizedName, projectID string) {
+ if normalizedName == "" || projectID == "" {
+ return
+ }
+
+ c.mu.Lock()
+ defer c.mu.Unlock()
+
+ if c.byName == nil {
+ c.byName = make(map[string]string)
+ }
+ c.byName[normalizedName] = projectID
+}
+
+func (c *composeNameCacheInternal) invalidateInternal(normalizedName string) {
+ if normalizedName == "" {
+ return
+ }
+
+ c.mu.Lock()
+ defer c.mu.Unlock()
+
+ delete(c.byName, normalizedName)
+}
+
+func (c *composeNameCacheInternal) replaceInternal(byName map[string]string) {
+ c.mu.Lock()
+ c.byName = byName
+ c.mu.Unlock()
+}
+
+func (s *ProjectService) invalidateProjectCachesInternal(projectID string) {
+ if s.parsedCompose != nil {
+ s.parsedCompose.Invalidate(projectID)
+ }
+ if s.metaCache != nil {
+ s.metaCache.Invalidate(projectID)
+ }
+}
+
+func (s *ProjectService) lookupProjectByCachedComposeNameInternal(ctx context.Context, normalizedName string) (*Project, bool, error) {
+ projectID, ok := s.composeNames.projectIDInternal(normalizedName).Get()
+ if !ok {
+ return nil, false, nil
+ }
+
+ var projectModel Project
+ if err := s.db.WithContext(ctx).Where("id = ?", projectID).First(&projectModel).Error; err != nil {
+ if errors.Is(err, gorm.ErrRecordNotFound) {
+ s.composeNames.invalidateInternal(normalizedName)
+ return nil, false, nil
+ }
+ if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
+ return nil, false, errors.WrapIf(err, "request canceled or timed out")
+ }
+ return nil, false, errors.WrapIf(err, "failed to get project by cached compose name")
+ }
+ if projects.NormalizeProjectName(projectModel.Name) != normalizedName {
+ s.composeNames.invalidateInternal(normalizedName)
+ return nil, false, nil
+ }
+
+ return &projectModel, true, nil
+}
+
+func (s *ProjectService) rebuildComposeNameCacheInternal(ctx context.Context) error {
+ var projectModels []Project
+ if err := s.db.WithContext(ctx).Select("id", "name").Find(&projectModels).Error; err != nil {
+ return err
+ }
+
+ byName := make(map[string]string, len(projectModels))
+ for i := range projectModels {
+ normalizedName := projects.NormalizeProjectName(projectModels[i].Name)
+ if normalizedName == "" {
+ continue
+ }
+ if _, exists := byName[normalizedName]; !exists {
+ byName[normalizedName] = projectModels[i].ID
+ }
+ }
+
+ s.composeNames.replaceInternal(byName)
+
+ return nil
+}
+
+// ResolveProjectComposeFile returns the base compose file for a project. The
+// precedence mirrors `docker compose`: COMPOSE_FILE in the merged environment
+// (.env.global first, the project's .env on top) wins, then a GitOps sync's
+// configured compose path, then standard detection.
+func (s *ProjectService) ResolveProjectComposeFile(ctx context.Context, proj *Project) (string, error) {
+ if proj == nil {
+ return "", errors.New("project is nil")
+ }
+
+ projectsDirectory := ""
+ if s.settingsService != nil {
+ var dirErr error
+ projectsDirectory, dirErr = s.GetProjectsDirectory(ctx)
+ if dirErr != nil {
+ // The .env.global layer is skipped for an empty projects directory;
+ // keep resolution working but surface the misconfiguration.
+ slog.WarnContext(ctx, "failed to resolve projects directory for compose selection", "projectID", proj.ID, "error", dirErr)
+ }
+ }
+ if files, selErr := projects.ComposeFileEnvSelection(ctx, projectsDirectory, proj.Path); selErr != nil {
+ return "", selErr
+ } else if len(files) > 0 {
+ return files[0], nil
+ }
+
+ if proj.GitOpsManagedBy != nil && strings.TrimSpace(*proj.GitOpsManagedBy) != "" {
+ var syncRecord GitOpsSync
+ if err := s.db.WithContext(ctx).
+ Select("compose_path").
+ Where("id = ?", *proj.GitOpsManagedBy).
+ First(&syncRecord).Error; err == nil {
+ composeFileName := strings.TrimSpace(filepath.Base(syncRecord.ComposePath))
+ if composeFileName != "" && composeFileName != "." {
+ candidate := filepath.Join(proj.Path, composeFileName)
+ // os.Stat rather than acfs: proj.Path may be an imported project
+ // outside the projects directory, and the compose file may be a
+ // symlink resolving outside it.
+ if info, statErr := os.Stat(candidate); statErr == nil {
+ if !info.IsDir() {
+ return candidate, nil
+ }
+ } else if !os.IsNotExist(statErr) {
+ return "", errors.WrapIff(statErr, "failed to inspect GitOps compose file %s", candidate)
+ }
+ }
+ } else if !errors.Is(err, gorm.ErrRecordNotFound) {
+ return "", errors.WrapIff(err, "failed to resolve GitOps compose path for project %s", proj.ID)
+ }
+ }
+
+ composeFile, err := projects.DetectComposeFile(ctx, projectsDirectory, proj.Path)
+ if err != nil {
+ return "", common.Classify(common.ErrProjectComposeFileNotFound, errors.WrapIf(err, "Project compose file not found"))
+ }
+
+ return composeFile, nil
+}
+
+func (s *ProjectService) loadComposeProjectForProjectInternal(ctx context.Context, proj *Project, services ...string) (*composetypes.Project, string, error) {
+ composeFileFullPath, err := s.ResolveProjectComposeFile(ctx, proj)
+ if err != nil {
+ return nil, "", err
+ }
+
+ cfg := s.settingsService.GetSettingsOrDefaults(ctx)
+ projectsDirectory := getProjectsDirectoryOrDefaultInternal(ctx, cfg)
+
+ pathMapper := s.projectPathMapperInternal(ctx)
+
+ composeProject, loadErr := projects.LoadComposeProject(ctx, composeFileFullPath, projects.NormalizeProjectName(proj.Name), projectsDirectory, utils.BoolOrDefault(cfg.AutoInjectEnv.Value, false), pathMapper, nil, nil, false, nil, services)
+ if loadErr != nil {
+ return nil, "", loadErr
+ }
+
+ return composeProject, composeFileFullPath, nil
+}
+
+func (s *ProjectService) getCachedComposeProjectInternal(ctx context.Context, proj *Project, cfg *settings.Settings) (*composetypes.Project, error) {
+ if proj == nil {
+ return nil, errors.New("project is nil")
+ }
+ if cfg == nil {
+ cfg = s.settingsService.GetSettingsOrDefaults(ctx)
+ }
+ composePath, err := s.ResolveProjectComposeFile(ctx, proj)
+ if err != nil {
+ return nil, err
+ }
+ return projects.LoadCachedComposeProject(ctx, s.parsedCompose, proj.ID, proj.Path, composePath, projects.NormalizeProjectName(proj.Name), getProjectsDirectoryOrDefaultInternal(ctx, cfg), utils.BoolOrDefault(cfg.AutoInjectEnv.Value, false), s.projectPathMapperInternal(ctx))
+}
+
+func (s *ProjectService) refreshComposeProjectNameInternal(ctx context.Context, proj *Project) {
+ if proj == nil {
+ return
+ }
+
+ dirName := proj.Name
+ if proj.DirName != nil && *proj.DirName != "" {
+ dirName = *proj.DirName
+ }
+
+ meta, err := s.loadComposeMetadataForSyncInternal(ctx, proj.Path, dirName)
+ if err != nil {
+ slog.WarnContext(ctx, "failed to refresh compose project name", "projectID", proj.ID, "path", proj.Path, "error", err)
+ return
+ }
+
+ updates := map[string]any{}
+ shouldUpdateName := meta.explicitProjectName || projects.NormalizeProjectName(proj.Name) != proj.Name
+ if shouldUpdateName && meta.resolvedProjectName != "" && proj.Name != meta.resolvedProjectName {
+ updates["name"] = meta.resolvedProjectName
+ }
+ if mo.PointerToOption(proj.ComposeProjectName) != mo.PointerToOption(meta.composeProjectName) {
+ updates["compose_project_name"] = meta.composeProjectName
+ }
+ if len(updates) == 0 {
+ return
+ }
+
+ updates["updated_at"] = time.Now()
+ if err := s.db.WithContext(ctx).
+ Model(&Project{}).
+ Where("id = ?", proj.ID).
+ Updates(updates).Error; err != nil {
+ slog.WarnContext(ctx, "failed to persist refreshed compose project name", "projectID", proj.ID, "error", err)
+ return
+ }
+
+ if name, ok := updates["name"].(string); ok {
+ proj.Name = name
+ }
+ if _, ok := updates["compose_project_name"]; ok {
+ proj.ComposeProjectName = meta.composeProjectName
+ }
+}
diff --git a/backend/internal/project/project_compose_cache.go b/backend/internal/project/project_compose_cache.go
deleted file mode 100644
index f8cdd73d8..000000000
--- a/backend/internal/project/project_compose_cache.go
+++ /dev/null
@@ -1,428 +0,0 @@
-package project
-
-import (
- "github.com/getarcaneapp/arcane/backend/v2/internal/settings"
-
- "context"
- "log/slog"
- "os"
- "path/filepath"
- "strings"
- "sync"
- "time"
-
- "emperror.dev/errors"
-
- composetypes "github.com/compose-spec/compose-go/v2/types"
- "github.com/getarcaneapp/arcane/backend/v2/internal/common"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
- "github.com/samber/hot"
- "github.com/samber/mo"
- "gorm.io/gorm"
-)
-
-// composeNameCacheInternal maps normalized compose project names to project
-// IDs so a name lookup skips the projects table scan.
-type composeNameCacheInternal struct {
- mu sync.RWMutex
- byName map[string]string
-}
-
-// parsedComposeCacheInternal caches parsed compose projects by project ID. An
-// entry is dropped once its compose file or any of its includes changes on disk.
-type parsedComposeCacheInternal struct {
- entries *hot.HotCache[string, composeCacheEntry]
-}
-
-type composeCacheEntry struct {
- composePath string
- composeMtime time.Time
- includeMtimes map[string]time.Time
- // envMtimes tracks the env files that influence file selection and
- // interpolation (.env, .env.global, COMPOSE_ENV_FILES entries). A zero time
- // records a file that did not exist when the entry was cached, so its later
- // appearance also invalidates. Needed because .env now selects the file set
- // via COMPOSE_FILE.
- envMtimes map[string]time.Time
- project *composetypes.Project
-}
-
-type projectMetadataEntryInternal struct {
- composeCacheEntry
-
- meta projects.ArcaneComposeMetadata
-}
-
-func newParsedComposeCacheInternal() *parsedComposeCacheInternal {
- return &parsedComposeCacheInternal{entries: hot.NewHotCache[string, composeCacheEntry](hot.LRU, 2048).Build()}
-}
-
-func (c *composeNameCacheInternal) projectID(normalizedName string) mo.Option[string] {
- if normalizedName == "" {
- return mo.None[string]()
- }
-
- c.mu.RLock()
- defer c.mu.RUnlock()
-
- if c.byName == nil {
- return mo.None[string]()
- }
-
- projectID, ok := c.byName[normalizedName]
- return mo.TupleToOption(projectID, ok)
-}
-
-func (c *composeNameCacheInternal) put(normalizedName, projectID string) {
- if normalizedName == "" || projectID == "" {
- return
- }
-
- c.mu.Lock()
- defer c.mu.Unlock()
-
- if c.byName == nil {
- c.byName = make(map[string]string)
- }
- c.byName[normalizedName] = projectID
-}
-
-func (c *composeNameCacheInternal) invalidate(normalizedName string) {
- if normalizedName == "" {
- return
- }
-
- c.mu.Lock()
- defer c.mu.Unlock()
-
- delete(c.byName, normalizedName)
-}
-
-func (c *composeNameCacheInternal) replace(byName map[string]string) {
- c.mu.Lock()
- c.byName = byName
- c.mu.Unlock()
-}
-
-func (s *ProjectService) invalidateProjectCachesInternal(projectID string) {
- if s.parsedCompose != nil {
- s.parsedCompose.invalidate(projectID)
- }
- if s.metaCache != nil {
- s.metaCache.Delete(projectID)
- }
-}
-
-func (c *parsedComposeCacheInternal) invalidate(projectID string) {
- if c == nil || c.entries == nil || strings.TrimSpace(projectID) == "" {
- return
- }
- c.entries.Delete(projectID)
-}
-
-func (s *ProjectService) lookupProjectByCachedComposeNameInternal(ctx context.Context, normalizedName string) (*Project, bool, error) {
- projectID, ok := s.composeNames.projectID(normalizedName).Get()
- if !ok {
- return nil, false, nil
- }
-
- var projectModel Project
- if err := s.db.WithContext(ctx).Where("id = ?", projectID).First(&projectModel).Error; err != nil {
- if errors.Is(err, gorm.ErrRecordNotFound) {
- s.composeNames.invalidate(normalizedName)
- return nil, false, nil
- }
- if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
- return nil, false, errors.WrapIf(err, "request canceled or timed out")
- }
- return nil, false, errors.WrapIf(err, "failed to get project by cached compose name")
- }
- if projects.NormalizeProjectName(projectModel.Name) != normalizedName {
- s.composeNames.invalidate(normalizedName)
- return nil, false, nil
- }
-
- return &projectModel, true, nil
-}
-
-func (s *ProjectService) rebuildComposeNameCacheInternal(ctx context.Context) error {
- var projectModels []Project
- if err := s.db.WithContext(ctx).Select("id", "name").Find(&projectModels).Error; err != nil {
- return err
- }
-
- byName := make(map[string]string, len(projectModels))
- for i := range projectModels {
- normalizedName := projects.NormalizeProjectName(projectModels[i].Name)
- if normalizedName == "" {
- continue
- }
- if _, exists := byName[normalizedName]; !exists {
- byName[normalizedName] = projectModels[i].ID
- }
- }
-
- s.composeNames.replace(byName)
-
- return nil
-}
-
-// ResolveProjectComposeFile returns the base compose file for a project. The
-// precedence mirrors `docker compose`: COMPOSE_FILE in the merged environment
-// (.env.global first, the project's .env on top) wins, then a GitOps sync's
-// configured compose path, then standard detection.
-func (s *ProjectService) ResolveProjectComposeFile(ctx context.Context, proj *Project) (string, error) {
- if proj == nil {
- return "", errors.New("project is nil")
- }
-
- projectsDirectory := ""
- if s.settingsService != nil {
- var dirErr error
- projectsDirectory, dirErr = s.GetProjectsDirectory(ctx)
- if dirErr != nil {
- // The .env.global layer is skipped for an empty projects directory;
- // keep resolution working but surface the misconfiguration.
- slog.WarnContext(ctx, "failed to resolve projects directory for compose selection", "projectID", proj.ID, "error", dirErr)
- }
- }
- if files, selErr := projects.ComposeFileEnvSelection(ctx, projectsDirectory, proj.Path); selErr != nil {
- return "", selErr
- } else if len(files) > 0 {
- return files[0], nil
- }
-
- if proj.GitOpsManagedBy != nil && strings.TrimSpace(*proj.GitOpsManagedBy) != "" {
- var syncRecord GitOpsSync
- if err := s.db.WithContext(ctx).
- Select("compose_path").
- Where("id = ?", *proj.GitOpsManagedBy).
- First(&syncRecord).Error; err == nil {
- composeFileName := strings.TrimSpace(filepath.Base(syncRecord.ComposePath))
- if composeFileName != "" && composeFileName != "." {
- candidate := filepath.Join(proj.Path, composeFileName)
- // os.Stat rather than acfs: proj.Path may be an imported project
- // outside the projects directory, and the compose file may be a
- // symlink resolving outside it.
- if info, statErr := os.Stat(candidate); statErr == nil {
- if !info.IsDir() {
- return candidate, nil
- }
- } else if !os.IsNotExist(statErr) {
- return "", errors.WrapIff(statErr, "failed to inspect GitOps compose file %s", candidate)
- }
- }
- } else if !errors.Is(err, gorm.ErrRecordNotFound) {
- return "", errors.WrapIff(err, "failed to resolve GitOps compose path for project %s", proj.ID)
- }
- }
-
- composeFile, err := projects.DetectComposeFile(ctx, projectsDirectory, proj.Path)
- if err != nil {
- return "", common.Classify(common.ErrProjectComposeFileNotFound, errors.WrapIf(err, "Project compose file not found"))
- }
-
- return composeFile, nil
-}
-
-func (s *ProjectService) loadComposeProjectForProjectInternal(ctx context.Context, proj *Project, cfg *settings.Settings) (*composetypes.Project, string, error) {
- composeFileFullPath, err := s.ResolveProjectComposeFile(ctx, proj)
- if err != nil {
- return nil, "", err
- }
-
- if cfg == nil {
- cfg = s.settingsService.GetSettingsOrDefaults(ctx)
- }
- projectsDirectory := getProjectsDirectoryOrDefaultInternal(ctx, cfg)
-
- pathMapper := s.projectPathMapperInternal(ctx)
-
- composeProject, loadErr := projects.LoadComposeProject(ctx, composeFileFullPath, projects.NormalizeProjectName(proj.Name), projectsDirectory, utils.BoolOrDefault(cfg.AutoInjectEnv.Value, false), pathMapper, nil, nil, false)
- if loadErr != nil {
- return nil, "", loadErr
- }
-
- return composeProject, composeFileFullPath, nil
-}
-
-func (s *ProjectService) getCachedComposeProjectInternal(ctx context.Context, proj *Project, cfg *settings.Settings) (*composetypes.Project, error) {
- if proj == nil {
- return nil, errors.New("project is nil")
- }
- if s.parsedCompose == nil {
- s.parsedCompose = newParsedComposeCacheInternal()
- }
-
- if cached, ok := s.parsedCompose.entries.Peek(proj.ID); ok {
- if cached.project != nil && validComposeCacheEntryInternal(cached) {
- return cached.project, nil
- }
- s.parsedCompose.entries.Delete(proj.ID)
- }
-
- if cfg == nil {
- cfg = s.settingsService.GetSettingsOrDefaults(ctx)
- }
-
- entry, found, err := s.parsedCompose.entries.GetWithLoaders(proj.ID, func(_ []string) (map[string]composeCacheEntry, error) {
- composeProject, composePath, err := s.loadComposeProjectForProjectInternal(ctx, proj, cfg)
- if err != nil {
- return nil, err
- }
-
- var composeFiles, composeEnvFiles []string
- if composeProject != nil {
- composeFiles = composeProject.ComposeFiles
- if envOpts, err := projects.ParseComposeEnvOptions(composeProject.WorkingDir, projects.EnvMap(composeProject.Environment)); err == nil {
- composeEnvFiles = envOpts.EnvFiles
- }
- }
- entry, err := newComposeCacheEntryInternal(proj, getProjectsDirectoryOrDefaultInternal(ctx, cfg), composePath, composeFiles, composeEnvFiles)
- if err != nil {
- return nil, err
- }
- entry.project = composeProject
-
- return map[string]composeCacheEntry{proj.ID: entry}, nil
- })
- if err != nil {
- return nil, err
- }
- if !found {
- return nil, errors.New("compose cache loader returned no project")
- }
-
- return entry.project, nil
-}
-
-// newComposeCacheEntryInternal snapshots the mtimes of every file a compose
-// load consumed: the root, every other merged config file (COMPOSE_FILE
-// entries, an auto-loaded override, includes), and the env files that select
-// and interpolate them (.env, .env.global, COMPOSE_ENV_FILES entries). An env
-// file that does not exist is recorded as a zero time so its later appearance
-// invalidates too. os.Stat rather than acfs throughout: see
-// validComposeCacheEntryInternal.
-func newComposeCacheEntryInternal(proj *Project, projectsDirectory, composePath string, composeFiles, composeEnvFiles []string) (composeCacheEntry, error) {
- entry := composeCacheEntry{
- composePath: composePath,
- includeMtimes: make(map[string]time.Time, len(composeFiles)),
- envMtimes: make(map[string]time.Time, 2+len(composeEnvFiles)),
- }
- info, err := os.Stat(composePath)
- if err != nil {
- return composeCacheEntry{}, errors.WrapIf(err, "stat compose file")
- }
- entry.composeMtime = info.ModTime()
-
- rootPath, err := filepath.Abs(composePath)
- if err != nil {
- rootPath = composePath
- }
- for _, composeFile := range composeFiles {
- if composeFile == "" || composeFile == composePath || composeFile == rootPath {
- continue
- }
- info, err := os.Stat(composeFile)
- if err != nil {
- return composeCacheEntry{}, errors.WrapIff(err, "stat compose file %s", composeFile)
- }
- entry.includeMtimes[composeFile] = info.ModTime()
- }
-
- envPaths := append([]string{
- filepath.Join(proj.Path, projects.EffectiveEnvFileName),
- filepath.Join(projectsDirectory, projects.GlobalEnvFileName),
- }, composeEnvFiles...)
- for _, envPath := range envPaths {
- if info, err := os.Stat(envPath); err == nil {
- entry.envMtimes[envPath] = info.ModTime()
- } else {
- entry.envMtimes[envPath] = time.Time{}
- }
- }
- return entry, nil
-}
-
-// The compose file and its includes are absolute paths compose-go resolved, and
-// either may legitimately be a symlink to, or a file under, a directory outside
-// the project (#3556). These invalidation probes therefore stay on os.Stat
-// rather than a root-confined stat, which would reject those layouts.
-func validComposeCacheEntryInternal(entry composeCacheEntry) bool {
- if entry.composePath == "" {
- return false
- }
-
- info, err := os.Stat(entry.composePath)
- if err != nil || !info.ModTime().Equal(entry.composeMtime) {
- return false
- }
- for includePath, cachedMtime := range entry.includeMtimes {
- info, err := os.Stat(includePath)
- if err != nil || !info.ModTime().Equal(cachedMtime) {
- return false
- }
- }
- for envPath, cachedMtime := range entry.envMtimes {
- info, err := os.Stat(envPath)
- switch {
- case err != nil:
- // Present when cached, now gone/unreadable: invalidate.
- if !cachedMtime.IsZero() {
- return false
- }
- case cachedMtime.IsZero():
- // Absent when cached, now present: invalidate.
- return false
- case !info.ModTime().Equal(cachedMtime):
- return false
- }
- }
- return true
-}
-
-func (s *ProjectService) refreshComposeProjectNameInternal(ctx context.Context, proj *Project) {
- if proj == nil {
- return
- }
-
- dirName := proj.Name
- if proj.DirName != nil && *proj.DirName != "" {
- dirName = *proj.DirName
- }
-
- meta, err := s.loadComposeMetadataForSyncInternal(ctx, proj.Path, dirName)
- if err != nil {
- slog.WarnContext(ctx, "failed to refresh compose project name", "projectID", proj.ID, "path", proj.Path, "error", err)
- return
- }
-
- updates := map[string]any{}
- shouldUpdateName := meta.explicitProjectName || projects.NormalizeProjectName(proj.Name) != proj.Name
- if shouldUpdateName && meta.resolvedProjectName != "" && proj.Name != meta.resolvedProjectName {
- updates["name"] = meta.resolvedProjectName
- }
- if mo.PointerToOption(proj.ComposeProjectName) != mo.PointerToOption(meta.composeProjectName) {
- updates["compose_project_name"] = meta.composeProjectName
- }
- if len(updates) == 0 {
- return
- }
-
- updates["updated_at"] = time.Now()
- if err := s.db.WithContext(ctx).
- Model(&Project{}).
- Where("id = ?", proj.ID).
- Updates(updates).Error; err != nil {
- slog.WarnContext(ctx, "failed to persist refreshed compose project name", "projectID", proj.ID, "error", err)
- return
- }
-
- if name, ok := updates["name"].(string); ok {
- proj.Name = name
- }
- if _, ok := updates["compose_project_name"]; ok {
- proj.ComposeProjectName = meta.composeProjectName
- }
-}
diff --git a/backend/internal/project/project_details.go b/backend/internal/project/project_details.go
index 9bf00d599..83ed3083f 100644
--- a/backend/internal/project/project_details.go
+++ b/backend/internal/project/project_details.go
@@ -97,7 +97,7 @@ func (s *ProjectService) GetProjectServices(ctx context.Context, projectID strin
return nil, err
}
- composeProject, composeFileFullPath, derr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb, nil)
+ composeProject, composeFileFullPath, derr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb)
if derr != nil {
return []ProjectServiceInfo{}, errors.WrapIff(derr, "failed to load compose project in %s", projectFromDb.Path)
}
@@ -682,7 +682,7 @@ func (s *ProjectService) StreamProjectLogs(ctx context.Context, projectID string
}
func (s *ProjectService) CountServicesFromCompose(ctx context.Context, p Project) (int, error) {
- proj, _, err := s.loadComposeProjectForProjectInternal(ctx, &p, nil)
+ proj, _, err := s.loadComposeProjectForProjectInternal(ctx, &p)
if err != nil {
return 0, err
}
diff --git a/backend/internal/project/project_env.go b/backend/internal/project/project_env.go
deleted file mode 100644
index 8659abc5f..000000000
--- a/backend/internal/project/project_env.go
+++ /dev/null
@@ -1,244 +0,0 @@
-package project
-
-import (
- "context"
- "log/slog"
- "strings"
-
- "emperror.dev/errors"
-
- "github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
-)
-
-type gitSyncEnvUpdateInternal struct {
- state projects.ProjectEnvState
- gitEnvContent *string
- overrideContent string
- effectiveContent *string
-}
-
-func (s *ProjectService) resolveEffectiveEnvContentForUpdateInternal(projectPath string, envContent *string) (*string, error) {
- if envContent != nil {
- return envContent, nil
- }
-
- state, err := projects.ReadProjectEnvState(projectPath)
- if err != nil {
- return nil, errors.WrapIf(err, "read project env state")
- }
-
- effectiveContent, err := resolveStoredEffectiveEnvContentInternal(state)
- if err != nil {
- return nil, err
- }
- if effectiveContent == "" && !state.HasEffective && !state.HasGitSource && !state.HasOverride {
- return nil, nil
- }
-
- return &effectiveContent, nil
-}
-
-func resolveStoredEffectiveEnvContentInternal(state projects.ProjectEnvState) (string, error) {
- if state.HasEffective {
- return state.EffectiveContent, nil
- }
- if state.HasGitSource || state.HasOverride {
- effectiveContent, err := projects.BuildEffectiveEnvContent(state.GitContent, state.OverrideContent)
- if err != nil {
- return "", errors.WrapIf(err, "build effective env content")
- }
- return effectiveContent, nil
- }
- return state.DirectContent, nil
-}
-
-func persistEffectiveEnvContentInternal(ctx context.Context, projectPath, projectsDirectory, envContent string) error {
- state, err := projects.ReadProjectEnvState(projectPath)
- if err != nil {
- return errors.WrapIf(err, "read project env state")
- }
-
- if state.HasGitSource && state.HasEffective && envContent == state.EffectiveContent {
- storedEffectiveContent, buildErr := projects.BuildEffectiveEnvContent(state.GitContent, state.OverrideContent)
- if buildErr == nil && envContent == storedEffectiveContent {
- return nil
- }
- }
-
- if !state.HasGitSource {
- if state.HasOverride {
- if err := projects.RemoveProjectFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName); err != nil {
- return err
- }
- }
- return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, state.EffectiveUnreadable, envContent)
- }
-
- overrideContent, err := projects.BuildOverrideEnvContent(state.GitContent, envContent)
- if err != nil {
- return errors.WrapIf(err, "build override env content")
- }
-
- effectiveContent, err := projects.BuildEffectiveEnvContent(state.GitContent, overrideContent)
- if err != nil {
- return errors.WrapIf(err, "build effective env content")
- }
-
- if err := projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, state.EffectiveUnreadable, effectiveContent); err != nil {
- return err
- }
-
- return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName, state.OverrideUnreadable, overrideContent)
-}
-
-func (s *ProjectService) ensureEffectiveEnvFileInternal(ctx context.Context, projectPath, projectsDirectory string) error {
- state, err := projects.ReadProjectEnvState(projectPath)
- if err != nil {
- return errors.WrapIf(err, "read project env state")
- }
-
- if !state.HasGitSource {
- if state.HasOverride {
- if err := projects.RemoveProjectFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName); err != nil {
- return err
- }
- effectiveContent, err := resolveStoredEffectiveEnvContentInternal(state)
- if err != nil {
- return err
- }
- return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, state.EffectiveUnreadable, effectiveContent)
- }
- return projects.EnsureEnvFile(ctx, projectsDirectory, projectPath)
- }
-
- effectiveContent, err := projects.BuildEffectiveEnvContent(state.GitContent, state.OverrideContent)
- if err != nil {
- return errors.WrapIf(err, "build effective env content")
- }
-
- return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, state.EffectiveUnreadable, effectiveContent)
-}
-
-func (s *ProjectService) prepareGitSyncEnvUpdateInternal(projectPath string, gitEnvContent *string) (gitSyncEnvUpdateInternal, error) {
- state, err := projects.ReadProjectEnvState(projectPath)
- if err != nil {
- return gitSyncEnvUpdateInternal{}, errors.WrapIf(err, "read project env state")
- }
-
- update := gitSyncEnvUpdateInternal{
- state: state,
- gitEnvContent: gitEnvContent,
- }
-
- if gitEnvContent == nil {
- effectiveContent, err := resolveStoredEffectiveEnvContentInternal(state)
- if err != nil {
- return gitSyncEnvUpdateInternal{}, err
- }
- if effectiveContent == "" && !state.HasEffective && !state.HasGitSource && !state.HasOverride {
- return update, nil
- }
- update.effectiveContent = &effectiveContent
- return update, nil
- }
-
- overrideContent, err := s.resolveOverrideContentForGitSyncInternal(state, *gitEnvContent)
- if err != nil {
- return gitSyncEnvUpdateInternal{}, err
- }
- update.overrideContent = overrideContent
-
- effectiveContent, err := projects.BuildEffectiveEnvContent(*gitEnvContent, overrideContent)
- if err != nil {
- return gitSyncEnvUpdateInternal{}, errors.WrapIf(err, "build effective env content")
- }
- update.effectiveContent = &effectiveContent
-
- return update, nil
-}
-
-func (s *ProjectService) resolveOverrideContentForGitSyncInternal(state projects.ProjectEnvState, gitEnvContent string) (string, error) {
- switch {
- case state.HasGitSource:
- overrideContent, err := projects.BuildOverrideEnvContent(state.GitContent, state.OverrideContent)
- if err != nil {
- return "", errors.WrapIf(err, "build override env content")
- }
- return overrideContent, nil
- case state.HasOverride:
- effectiveContent, err := resolveStoredEffectiveEnvContentInternal(state)
- if err != nil {
- return "", err
- }
- overrideContent, err := projects.BuildOverrideEnvContent(gitEnvContent, effectiveContent)
- if err != nil {
- return "", errors.WrapIf(err, "build override env content")
- }
- return overrideContent, nil
- case strings.TrimSpace(state.DirectContent) != "":
- overrideContent, err := projects.BuildAdditiveOverrideEnvContent(gitEnvContent, state.DirectContent)
- if err != nil {
- return "", errors.WrapIf(err, "build override env content")
- }
- return overrideContent, nil
- default:
- return "", nil
- }
-}
-
-func persistGitSyncEnvFilesInternal(ctx context.Context, projectPath, projectsDirectory string, update gitSyncEnvUpdateInternal) error {
- if update.gitEnvContent == nil {
- if update.state.HasGitSource {
- if err := projects.RemoveProjectFile(ctx, projectsDirectory, projectPath, projects.GitSourceEnvFileName); err != nil {
- return err
- }
- }
- if update.state.HasOverride {
- if err := projects.RemoveProjectFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName); err != nil {
- return err
- }
- }
- if update.effectiveContent != nil || update.state.HasEffective || update.state.HasGitSource || update.state.HasOverride {
- effectiveContent := ""
- if update.effectiveContent != nil {
- effectiveContent = *update.effectiveContent
- }
- return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, update.state.EffectiveUnreadable, effectiveContent)
- }
- if update.state.EffectiveUnreadable {
- slog.Warn("skipping permission-locked .env file; leaving it untouched", "projectPath", projectPath)
- return nil
- }
- return projects.EnsureEnvFile(ctx, projectsDirectory, projectPath)
- }
-
- if update.effectiveContent == nil {
- return errors.New("missing effective env content for git sync update")
- }
-
- if err := projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, update.state.EffectiveUnreadable, *update.effectiveContent); err != nil {
- return err
- }
- if err := projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.GitSourceEnvFileName, update.state.GitSourceUnreadable, *update.gitEnvContent); err != nil {
- return err
- }
- return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName, update.state.OverrideUnreadable, update.overrideContent)
-}
-
-// ApplyGitSyncEnvToDirectory applies the same managed three-file environment
-// merge used by single-file project syncs and returns the effective content
-// before and after the update.
-func (s *ProjectService) ApplyGitSyncEnvToDirectory(ctx context.Context, projectPath, projectsDirectory string, gitEnvContent *string) (before, after string, err error) {
- update, err := s.prepareGitSyncEnvUpdateInternal(projectPath, gitEnvContent)
- if err != nil {
- return "", "", errors.WrapIf(err, "failed to resolve git env state")
- }
- before = update.state.DirectContent
- if update.effectiveContent != nil {
- after = *update.effectiveContent
- }
- if err := persistGitSyncEnvFilesInternal(ctx, projectPath, projectsDirectory, update); err != nil {
- return "", "", errors.WrapIf(err, "failed to sync git env files")
- }
- return before, after, nil
-}
diff --git a/backend/internal/project/project_lifecycle.go b/backend/internal/project/project_lifecycle.go
index b221f8359..a1558238a 100644
--- a/backend/internal/project/project_lifecycle.go
+++ b/backend/internal/project/project_lifecycle.go
@@ -1,24 +1,19 @@
package project
import (
- "github.com/getarcaneapp/arcane/backend/v2/internal/event"
-
- "github.com/getarcaneapp/arcane/backend/v2/internal/database"
-
"context"
stderrors "errors"
"fmt"
"io"
"log/slog"
"path/filepath"
- "strings"
"time"
"emperror.dev/errors"
-
composetypes "github.com/compose-spec/compose-go/v2/types"
- "github.com/docker/compose/v5/pkg/api"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/database"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/event"
dockerutil "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/timeouts"
"github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
@@ -26,7 +21,8 @@ import (
"github.com/getarcaneapp/arcane/backend/v2/pkg/workspace"
"github.com/getarcaneapp/arcane/types/v2"
"github.com/getarcaneapp/arcane/types/v2/containerregistry"
- "github.com/getarcaneapp/arcane/types/v2/project"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+
"go.getarcane.app/acfs"
buildtypes "go.getarcane.app/builds/types"
"go.getarcane.app/sys/cgroup"
@@ -34,13 +30,6 @@ import (
"gorm.io/gorm"
)
-type ProjectBuildOptions struct {
- Services []string
- Provider string
- Push *bool
- Load *bool
-}
-
var (
composeStopProjectServicesInternal = projects.ComposeStop
composeUpProjectServicesInternal = projects.ComposeUp
@@ -58,32 +47,6 @@ func (s *ProjectService) reconcilePulledImageRefsInternal(ctx context.Context, i
}
}
-func (s *ProjectService) composePullSelectedServicesInternal(
- ctx context.Context,
- compProj *composetypes.Project,
- servicesToUpdate []string,
- user common.User,
- credentials []containerregistry.Credential,
-) error {
- if compProj == nil {
- return nil
- }
-
- imageRefsToPull := projects.SelectedImageRefs(compProj, servicesToUpdate)
- if len(imageRefsToPull) == 0 {
- return nil
- }
-
- progressWriter, _ := ctx.Value(dockerutil.ProgressWriterKey{}).(io.Writer)
- for _, imageRef := range imageRefsToPull {
- if err := s.pullAndReconcileImageInternal(ctx, imageRef, progressWriter, user, credentials); err != nil {
- return err
- }
- }
-
- return nil
-}
-
func (s *ProjectService) pullAndReconcileImageInternal(
ctx context.Context,
imageRef string,
@@ -119,7 +82,7 @@ func (s *ProjectService) UpdateProjectServices(ctx context.Context, projectID st
previousStatus := projectFromDb.Status
// 1. Load project
- compProj, _, err := s.loadComposeProjectForProjectInternal(ctx, projectFromDb, nil)
+ compProj, _, err := s.loadComposeProjectForProjectInternal(ctx, projectFromDb, servicesToUpdate...)
if err != nil {
return errors.WrapIf(err, "failed to load compose project")
}
@@ -137,23 +100,19 @@ func (s *ProjectService) UpdateProjectServices(ctx context.Context, projectID st
return errors.WrapIf(err, "resolve registry credentials")
}
- // 3. Pull images for specific services
- if err := s.composePullSelectedServicesInternal(ctx, compProj, servicesToUpdate, user, credentials); err != nil {
- if statusErr := s.updateProjectStatusInternal(ctx, projectID, previousStatus); statusErr != nil {
- slog.ErrorContext(ctx, "UpdateProjectServices: failed to restore project status after compose pull failure", "projectID", projectID, "error", statusErr)
- }
- return errors.WrapIf(err, "pull updated service images")
- }
-
- // 4. Stop specific services
- if err := composeStopProjectServicesInternal(ctx, compProj, servicesToUpdate); err != nil {
- slog.WarnContext(ctx, "compose stop failed, continuing", "error", err)
- }
-
- // 5. Up specific services
- if err := composeUpProjectServicesInternal(ctx, compProj, servicesToUpdate, false, true, false, s.composeRegistryAuthConfigsInternal(ctx), s.deployWaitTimeoutInternal()); err != nil {
- s.restoreProjectStatusAfterFailedDeployInternal(ctx, projectID)
- return errors.WrapIf(err, "failed to up services")
+ progressWriter, _ := ctx.Value(dockerutil.ProgressWriterKey{}).(io.Writer)
+ if err := s.composeCoordinator.UpdateServices(ctx, projecttypes.ComposeServiceUpdate{
+ Project: compProj, Services: servicesToUpdate,
+ Images: s.composeImageOperationsInternal(&user, credentials), Progress: progressWriter,
+ AuthConfigs: s.composeRegistryAuthConfigsInternal(ctx), WaitTimeout: s.deployWaitTimeoutInternal(),
+ RestoreBeforeMutation: func(ctx context.Context) {
+ if statusErr := s.updateProjectStatusInternal(ctx, projectID, previousStatus); statusErr != nil {
+ slog.ErrorContext(ctx, "failed to restore project status before service update", "projectID", projectID, "error", statusErr)
+ }
+ },
+ Recover: func(ctx context.Context) { s.restoreProjectStatusAfterFailedDeployInternal(ctx, projectID) },
+ }); err != nil {
+ return err
}
// 6. Finalize status
@@ -238,20 +197,13 @@ func (s *ProjectService) UnarchiveProject(ctx context.Context, projectID string,
return nil
}
-// resolveRemoveOrphansInternal decides whether compose up should remove orphan containers.
-// GitOps-managed projects always remove orphans so the running stack matches the
-// tracked compose file. Non-GitOps callers may opt in per request via DeployOptions.
// deployWaitTimeoutInternal resolves how long compose up waits for depends_on
// health/completion conditions, from the deployWaitTimeout setting.
func (s *ProjectService) deployWaitTimeoutInternal() time.Duration {
return timeouts.GetDuration(s.settingsService.GetSettingsConfig().DeployWaitTimeout.AsInt(), timeouts.DefaultDeployWait)
}
-func resolveRemoveOrphansInternal(gitOpsManaged bool, options *project.DeployOptions) bool {
- return gitOpsManaged || (options != nil && options.RemoveOrphans)
-}
-
-func (s *ProjectService) DeployProject(ctx context.Context, projectID string, user common.User, options *project.DeployOptions) error {
+func (s *ProjectService) DeployProject(ctx context.Context, projectID string, user common.User, options *projecttypes.DeployOptions) error {
projectFromDb, err := s.GetProjectFromDatabaseByID(ctx, projectID)
if err != nil {
return errors.WrapIf(err, "failed to get project")
@@ -260,74 +212,37 @@ func (s *ProjectService) DeployProject(ctx context.Context, projectID string, us
return err
}
- resolvedPullPolicy := ""
- forceRecreate := false
- recreateVolumes := false
- if options != nil {
- resolvedPullPolicy = projects.NormalizeDeployPullPolicy(options.PullPolicy)
- forceRecreate = options.ForceRecreate
- recreateVolumes = options.RecreateVolumes
- }
- if resolvedPullPolicy == "" {
- resolvedPullPolicy = projects.NormalizeDeployPullPolicy(s.settingsService.GetStringSetting(ctx, "defaultDeployPullPolicy", "missing"))
- }
- if resolvedPullPolicy == "" {
- resolvedPullPolicy = "missing"
- }
-
if err := s.updateProjectStatusInternal(ctx, projectID, ProjectStatusDeploying); err != nil {
return errors.WrapIf(err, "failed to update project status to deploying")
}
-
- // Run any configured pre-deploy lifecycle hook before loading the compose
- // project so hooks can produce files that compose then consumes (e.g.
- // `sops -d secrets.enc.env > .env.runtime` for an `env_file: .env.runtime`
- // service). A failed hook aborts the deploy.
- if s.lifecycleService != nil {
- if lerr := s.lifecycleService.RunPreDeploy(ctx, projectFromDb, user); lerr != nil {
- s.restoreProjectStatusAfterFailedDeployInternal(ctx, projectID)
- return errors.WrapIf(lerr, "pre-deploy lifecycle hook failed")
- }
- }
-
- projectModel, _, derr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb, nil)
- if derr != nil {
- s.restoreProjectStatusAfterFailedDeployInternal(ctx, projectID)
- return errors.WrapIff(derr, "failed to load compose project in %s", projectFromDb.Path)
- }
-
- credentials, cerr := s.ResolveRegistryCredentials(ctx)
- if cerr != nil {
- s.restoreProjectStatusAfterFailedDeployInternal(ctx, projectID)
- return errors.WrapIf(cerr, "resolve registry credentials")
- }
-
progressWriter, _ := ctx.Value(dockerutil.ProgressWriterKey{}).(io.Writer)
- if perr := s.prepareProjectImagesForDeploy(ctx, projectID, projectModel, progressWriter, credentials, &user, resolvedPullPolicy); perr != nil {
- s.restoreProjectStatusAfterFailedDeployInternal(ctx, projectID)
- return errors.WrapIf(perr, "failed to prepare project images for deploy")
- }
-
- gitOpsManaged := projectFromDb.GitOpsManagedBy != nil && *projectFromDb.GitOpsManagedBy != ""
- removeOrphans := resolveRemoveOrphansInternal(gitOpsManaged, options)
-
- slog.Info("starting compose up with health check support", "projectID", projectID, "projectName", projectModel.Name, "services", len(projectModel.Services), "removeOrphans", removeOrphans)
- // Health/progress streaming (if any) is handled inside projects.ComposeUp via ctx.
- if err := projects.ComposeUp(ctx, projectModel, nil, removeOrphans, forceRecreate, recreateVolumes, s.composeRegistryAuthConfigsInternal(ctx), s.deployWaitTimeoutInternal()); err != nil {
- slog.Error("compose up failed", "projectName", projectModel.Name, "projectID", projectID, "error", err)
- if containers, psErr := s.GetProjectServices(ctx, projectID); psErr == nil {
- slog.Info("containers after failed deploy", "projectID", projectID, "containers", containers)
- }
- s.restoreProjectStatusAfterFailedDeployInternal(ctx, projectID)
-
- // Provide more helpful error messages
- errMsg := err.Error()
- if strings.Contains(errMsg, "timeout") || strings.Contains(errMsg, "context deadline exceeded") {
- return errors.WrapIf(err, "deployment timed out waiting for services - long-running 'service_healthy'/'service_completed_successfully' dependencies may need a higher Deploy Wait Timeout setting, and 'service_healthy' requires a healthcheck")
- }
- return errors.WrapIf(err, "failed to deploy project")
+ projectModel, err := s.composeCoordinator.Deploy(ctx, projecttypes.ComposeDeployment{
+ ProjectID: projectID, ProjectPath: projectFromDb.Path, Options: options,
+ DefaultPullPolicy: s.settingsService.GetStringSetting(ctx, "defaultDeployPullPolicy", "missing"),
+ GitOpsManaged: projectFromDb.GitOpsManagedBy != nil && *projectFromDb.GitOpsManagedBy != "",
+ WaitTimeout: s.deployWaitTimeoutInternal(), AuthConfigs: s.composeRegistryAuthConfigsInternal(ctx), Progress: progressWriter,
+ PreDeploy: func(ctx context.Context) error {
+ if s.lifecycleService == nil {
+ return nil
+ }
+ return s.lifecycleService.RunPreDeploy(ctx, projectFromDb, user)
+ },
+ Load: func(ctx context.Context) (*composetypes.Project, error) {
+ model, _, err := s.loadComposeProjectForProjectInternal(ctx, projectFromDb)
+ return model, err
+ },
+ ResolveImages: func(ctx context.Context) (projecttypes.ComposeImageOperations, error) {
+ credentials, err := s.ResolveRegistryCredentials(ctx)
+ operations := s.composeImageOperationsInternal(&user, credentials)
+ // Deployment pulls are recorded as system actions; builds retain the requesting actor.
+ operations.Pull = s.composeImageOperationsInternal(nil, credentials).Pull
+ return operations, err
+ },
+ Recover: func(ctx context.Context) { s.restoreProjectStatusAfterFailedDeployInternal(ctx, projectID) },
+ })
+ if err != nil {
+ return err
}
- slog.Info("compose up completed successfully", "projectID", projectID, "projectName", projectModel.Name)
metadata := database.JSON{"action": "deploy", "projectID": projectID, "projectName": projectModel.Name}
s.logProjectEventInternal(ctx, event.EventTypeProjectDeploy, projectID, projectModel.Name, user, metadata, "could not log project deployment action")
@@ -345,7 +260,7 @@ func (s *ProjectService) DownProject(ctx context.Context, projectID string, user
return err
}
- proj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb, nil)
+ proj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb)
if lerr != nil {
_ = s.updateProjectStatusInternal(ctx, projectID, ProjectStatusRunning)
return errors.WrapIf(lerr, "failed to load compose project")
@@ -375,7 +290,7 @@ func (s *ProjectService) DownProject(ctx context.Context, projectID string, user
// "-N" (the interactive default). When false a collision returns
// projects.ErrProjectDirExists (wrapped) so GitOps creates fail loudly instead of
// minting runaway "-N" duplicate projects on a broken binding.
-func (s *ProjectService) CreateProject(ctx context.Context, name, composeContent string, envContent *string, manifest project.CreateProjectWorkspaceManifest, uploads map[int][]byte, uiTags []string, uiTagColors map[string]project.TagColor, user common.User, allowNameSuffixOptions ...bool) (*Project, error) {
+func (s *ProjectService) CreateProject(ctx context.Context, name, composeContent string, envContent *string, manifest projecttypes.CreateProjectWorkspaceManifest, uploads map[int][]byte, uiTags []string, uiTagColors map[string]projecttypes.TagColor, user common.User, allowNameSuffixOptions ...bool) (*Project, error) {
normalizedUITags, err := projects.NormalizeProjectTags(uiTags)
if err != nil {
return nil, errors.WrapIf(err, "invalid project tags")
@@ -438,7 +353,7 @@ func (s *ProjectService) CreateProject(ctx context.Context, name, composeContent
// GitOps-originated creates (allowNameSuffix=false) tolerate not-yet-supplied
// ${VAR} references the same way single-file git sync updates do; interactive
// creates (allowNameSuffix=true) stay strict.
- if err := validateComposeContentForUpdate(ctx, projectsDirectory, projectPath, name, composeContent, envContent, nil, "", !allowNameSuffix); err != nil {
+ if err := projects.ValidateComposeContentForUpdate(ctx, projectsDirectory, projectPath, name, composeContent, envContent, nil, "", !allowNameSuffix); err != nil {
_ = acfs.RemoveAll(context.WithoutCancel(ctx), projectsDirectory, projectLogical)
return nil, errors.WrapIf(err, "invalid compose file")
}
@@ -512,7 +427,7 @@ func (s *ProjectService) DestroyProject(ctx context.Context, projectID string, r
}
if removeVolumes {
- if compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj, nil); lerr == nil {
+ if compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj); lerr == nil {
if derr := projects.ComposeDown(ctx, compProj, true); derr != nil {
slog.WarnContext(ctx, "failed to remove volumes", "error", derr)
}
@@ -559,7 +474,7 @@ func (s *ProjectService) DestroyProject(ctx context.Context, projectID string, r
return nil
}
-func (s *ProjectService) RedeployProject(ctx context.Context, projectID string, user common.User, options *project.DeployOptions) error {
+func (s *ProjectService) RedeployProject(ctx context.Context, projectID string, user common.User, options *projecttypes.DeployOptions) error {
proj, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
@@ -614,50 +529,32 @@ func (s *ProjectService) PullProjectImages(ctx context.Context, projectID string
return err
}
- compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj, nil)
+ compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj)
if lerr != nil {
return errors.WrapIf(lerr, "failed to load compose project")
}
- images := map[string]struct{}{}
- for _, svc := range compProj.Services {
- if svc.Build == nil {
- if img := strings.TrimSpace(svc.Image); img != "" {
- images[img] = struct{}{}
- }
- }
- // pre_start hook images and type:image volume sources are pulled from a
- // registry even for build services — they cannot be built.
- for _, img := range api.GetDependentImages(svc, compProj.Name) {
- images[img] = struct{}{}
- }
- for _, vol := range svc.Volumes {
- if vol.Type == composetypes.VolumeTypeImage && strings.TrimSpace(vol.Source) != "" {
- images[strings.TrimSpace(vol.Source)] = struct{}{}
- }
- }
- }
-
- for img := range images {
+ for _, img := range projects.PullableImageRefs(compProj) {
if err := s.pullAndReconcileImageInternal(ctx, img, progressWriter, user, credentials); err != nil {
return err
}
}
+
return nil
}
-func (s *ProjectService) BuildProjectServices(ctx context.Context, projectID string, options ProjectBuildOptions, progressWriter io.Writer, user *common.User) error {
+func (s *ProjectService) BuildProjectServices(ctx context.Context, projectID string, options projecttypes.BuildOptions, progressWriter io.Writer, user *common.User) error {
projectFromDb, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
return err
}
- projectModel, _, derr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb, nil)
+ projectModel, _, derr := s.loadComposeProjectForProjectInternal(ctx, projectFromDb)
if derr != nil {
return errors.WrapIff(derr, "failed to load compose project in %s", projectFromDb.Path)
}
- return s.buildProjectServicesInternal(ctx, projectID, projectModel, options, progressWriter, user)
+ return s.composeCoordinator.BuildServices(ctx, projectID, projectModel, options, progressWriter, s.composeImageOperationsInternal(user, nil))
}
// EnsureProjectImagesPresent checks all compose service images for the project and
@@ -671,296 +568,12 @@ func (s *ProjectService) EnsureProjectImagesPresent(ctx context.Context, project
return err
}
- compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj, nil)
+ compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj)
if lerr != nil {
return errors.WrapIf(lerr, "failed to load compose project")
}
- pullPlan := projects.BuildImagePullPlan(compProj)
-
- return s.ensureImagesPresent(ctx, pullPlan, progressWriter, credentials, user)
-}
-
-// imageRefreshDueInternal reports whether a pull_policy refresh window has
-// elapsed for a locally present image, using the engine's last-tag time as
-// compose v5.5.0 does; an unknown time counts as due.
-func (s *ProjectService) imageRefreshDueInternal(ctx context.Context, imageRef string, window time.Duration) bool {
- lastTagged, err := s.imageService.ImageLastTagTime(ctx, imageRef)
- if err != nil {
- slog.WarnContext(ctx, "failed to resolve image last-tag time; treating refresh as due", "image", imageRef, "error", err)
- return true
- }
- return lastTagged.IsZero() || time.Now().After(lastTagged.Add(window))
-}
-
-func (s *ProjectService) ensureImagesPresent(ctx context.Context, pullPlan map[string]projects.ImagePullStep, progressWriter io.Writer, credentials []containerregistry.Credential, user common.User) error {
- for img, step := range pullPlan {
- exists, ierr := s.imageService.ImageExistsLocally(ctx, img)
- if ierr != nil && step.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 step.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
- }
- if !exists {
- return errors.Errorf("image %s is not available locally and pull_policy is 'never'", img)
- }
- slog.DebugContext(ctx, "pull_policy is 'never'; using local image without pull", "image", img)
- continue
- }
-
- if step.Mode == projects.ImagePullModeIfMissing && exists {
- slog.DebugContext(ctx, "image already present locally; skipping pull", "image", img)
- continue
- }
-
- if step.Mode == projects.ImagePullModeRefresh && exists && !s.imageRefreshDueInternal(ctx, img, step.RefreshAfter) {
- slog.DebugContext(ctx, "pull_policy refresh window has not elapsed; skipping pull", "image", img, "window", step.RefreshAfter)
- continue
- }
-
- if err := s.pullAndReconcileImageInternal(ctx, img, progressWriter, user, credentials); err != nil {
- return err
- }
- }
- return nil
-}
-
-func (s *ProjectService) prepareProjectImagesForDeploy(
- ctx context.Context,
- projectID string,
- project *composetypes.Project,
- progressWriter io.Writer,
- credentials []containerregistry.Credential,
- user *common.User,
- pullPolicyOverride string,
-) error {
- if project == nil {
- return nil
- }
-
- for name, svc := range project.Services {
- svc, imageName, updated := projects.PrepareDeployServiceConfig(projectID, project.Name, name, svc)
- if updated {
- project.Services[name] = svc
- }
-
- if imageName == "" {
- continue
- }
-
- decision := projects.DecideDeployImageAction(svc, pullPolicyOverride)
- if updated {
- decision = projects.DeployImageDecision{Build: true}
- }
- if err := s.ensureDeployServiceImageReady(ctx, projectID, project, name, svc, imageName, decision, progressWriter, credentials, user); err != nil {
- return err
- }
-
- // pre_start hook images and type:image volume sources cannot be built:
- // they follow the service's pull decision minus the build/fallback paths.
- dependentDecision := projects.DeployImageDecision{PullIfMissing: true}
- switch {
- case decision.RequireLocalOnly:
- dependentDecision = projects.DeployImageDecision{RequireLocalOnly: true}
- case decision.PullAlways:
- dependentDecision = projects.DeployImageDecision{PullAlways: true}
- case decision.PullIfStale:
- dependentDecision = projects.DeployImageDecision{PullIfStale: true, StaleAfter: decision.StaleAfter}
- }
- dependentImages := api.GetDependentImages(svc, project.Name)
- for _, vol := range svc.Volumes {
- if vol.Type == composetypes.VolumeTypeImage && strings.TrimSpace(vol.Source) != "" {
- dependentImages = append(dependentImages, strings.TrimSpace(vol.Source))
- }
- }
- for _, img := range dependentImages {
- if err := s.ensureDeployServiceImageReady(ctx, projectID, project, name, svc, img, dependentDecision, progressWriter, credentials, user); err != nil {
- return err
- }
- }
- }
-
- return nil
-}
-
-func (s *ProjectService) ensureDeployServiceImageReady(
- ctx context.Context,
- projectID string,
- project *composetypes.Project,
- serviceName string,
- svc composetypes.ServiceConfig,
- imageName string,
- decision projects.DeployImageDecision,
- progressWriter io.Writer,
- credentials []containerregistry.Credential,
- user *common.User,
-) error {
- if decision.Build {
- return s.buildServiceImageForDeploy(ctx, projectID, project, serviceName, svc, progressWriter, user)
- }
-
- exists, err := s.imageService.ImageExistsLocally(ctx, imageName)
- if err != nil {
- slog.WarnContext(ctx, "failed to check local image existence", "image", imageName, "error", err)
- }
-
- if decision.RequireLocalOnly {
- if !exists {
- return errors.Errorf("image %s is not available locally and pull_policy is set to never", imageName)
- }
- return nil
- }
-
- var lastTagged time.Time
- if decision.PullIfStale && exists {
- var tagErr error
- lastTagged, tagErr = s.imageService.ImageLastTagTime(ctx, imageName)
- if tagErr != nil {
- // Unknown last-tag time counts as stale, matching the missing-record
- // behavior of compose's refresh handling.
- slog.WarnContext(ctx, "failed to resolve image last-tag time; treating refresh as due", "image", imageName, "error", tagErr)
- }
- }
- if !projects.ShouldPullDeployImage(decision, exists, lastTagged) {
- return nil
- }
-
- err = s.pullAndReconcileImageInternal(ctx, imageName, progressWriter, common.SystemUser, credentials)
- if err == nil {
- return nil
- }
- if svc.Build != nil && decision.FallbackBuildOnPullFail {
- slog.WarnContext(ctx, "image pull failed, falling back to build", "service", serviceName, "image", imageName, "error", err)
- return s.buildServiceImageForDeploy(ctx, projectID, project, serviceName, svc, progressWriter, user)
- }
- return errors.WrapIff(err, "failed to pull image %s", imageName)
-}
-
-func (s *ProjectService) buildServiceImageForDeploy(
- ctx context.Context,
- projectID string,
- project *composetypes.Project,
- serviceName string,
- svc composetypes.ServiceConfig,
- progressWriter io.Writer,
- user *common.User,
-) error {
- if s.buildService == nil {
- return errors.Errorf("build service not available for service %s", serviceName)
- }
-
- buildReq, updatedSvc, updated, err := s.prepareServiceBuildRequest(ctx, projectID, project, serviceName, svc, ProjectBuildOptions{})
- if err != nil {
- return err
- }
- if updated {
- project.Services[serviceName] = updatedSvc
- }
-
- if _, err := s.buildService.BuildImage(ctx, types.LocalDockerEnvironmentID, buildReq, progressWriter, serviceName, user); err != nil {
- return err
- }
-
- return nil
-}
-
-func (s *ProjectService) resolveEffectiveBuildProvider(override string) string {
- provider := strings.ToLower(strings.TrimSpace(override))
- if provider != "" {
- return provider
- }
-
- if s.buildService != nil {
- provider = strings.ToLower(strings.TrimSpace(s.buildService.BuildSettings().BuildProvider))
- }
-
- if provider == "" {
- provider = "local"
- }
-
- return provider
-}
-
-func (s *ProjectService) prepareServiceBuildRequest(
- ctx context.Context,
- projectID string,
- project *composetypes.Project,
- serviceName string,
- svc composetypes.ServiceConfig,
- options ProjectBuildOptions,
-) (buildtypes.BuildRequest, composetypes.ServiceConfig, bool, error) {
- _ = ctx
- imageName, updatedSvc, updated := projects.EnsureServiceImage(projectID, project.Name, serviceName, svc)
- effectiveProvider := s.resolveEffectiveBuildProvider(options.Provider)
-
- if updated && effectiveProvider == "depot" {
- return buildtypes.BuildRequest{}, updatedSvc, updated, errors.Errorf("service %s must define an image when using depot build provider", serviceName)
- }
- if updated && options.Push != nil && *options.Push {
- return buildtypes.BuildRequest{}, updatedSvc, updated, errors.Errorf("service %s must define an image when push is enabled", serviceName)
- }
-
- // The build context (and any absolute Dockerfile path) is read locally by
- // Arcane — both the docker provider (`archive.TarWithOptions`) and the
- // buildkit provider (`SolveOpt.LocalDirs`) stream the directory contents
- // to the daemon from the Arcane process's own filesystem. It must
- // therefore stay as a container path; translating it to the host path
- // (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 := projects.ResolveBuildContext(project.WorkingDir, updatedSvc, serviceName)
- if err != nil {
- return buildtypes.BuildRequest{}, updatedSvc, updated, err
- }
-
- dockerfileInline := updatedSvc.Build.DockerfileInline
- if strings.TrimSpace(updatedSvc.Build.Dockerfile) != "" && strings.TrimSpace(dockerfileInline) != "" {
- return buildtypes.BuildRequest{}, updatedSvc, updated, errors.Errorf("service %s cannot define both dockerfile and dockerfile_inline", serviceName)
- }
-
- dockerfilePath := ""
- if strings.TrimSpace(dockerfileInline) == "" {
- dockerfilePath = projects.ResolveDockerfilePath(updatedSvc)
- }
-
- buildReq := buildtypes.BuildRequest{
- ContextDir: contextDir,
- Dockerfile: dockerfilePath,
- DockerfileInline: dockerfileInline,
- Tags: projects.MergeBuildTags(imageName, updatedSvc.Build.Tags),
- Target: strings.TrimSpace(updatedSvc.Build.Target),
- BuildArgs: projects.BuildArgsFromCompose(updatedSvc.Build.Args),
- Labels: projects.LabelsFromCompose(updatedSvc.Build.Labels),
- CacheFrom: append([]string(nil), updatedSvc.Build.CacheFrom...),
- CacheTo: append([]string(nil), updatedSvc.Build.CacheTo...),
- NoCache: updatedSvc.Build.NoCache,
- Pull: updatedSvc.Build.Pull,
- Network: strings.TrimSpace(updatedSvc.Build.Network),
- Isolation: strings.TrimSpace(updatedSvc.Build.Isolation),
- ShmSize: int64(updatedSvc.Build.ShmSize),
- Ulimits: projects.UlimitsFromCompose(updatedSvc.Build.Ulimits),
- Entitlements: append(
- []string(nil),
- updatedSvc.Build.Entitlements...,
- ),
- Privileged: updatedSvc.Build.Privileged,
- ExtraHosts: updatedSvc.Build.ExtraHosts.AsList(":"),
- Platforms: projects.BuildPlatformsFromCompose(updatedSvc),
- Provider: effectiveProvider,
- }
- if options.Push != nil {
- buildReq.Push = *options.Push
- }
- if options.Load != nil {
- buildReq.Load = *options.Load
- }
-
- return buildReq, updatedSvc, updated, nil
+ return s.composeCoordinator.EnsureImagesPresent(ctx, compProj, progressWriter, s.composeImageOperationsInternal(&user, credentials))
}
func (s *ProjectService) restoreProjectStatusAfterFailedDeployInternal(ctx context.Context, projectID string) {
@@ -987,46 +600,6 @@ func (s *ProjectService) restoreProjectStatusAfterFailedDeployInternal(ctx conte
}
}
-func (s *ProjectService) buildProjectServicesInternal(ctx context.Context, projectID string, project *composetypes.Project, options ProjectBuildOptions, progressWriter io.Writer, user *common.User) error {
- if s.buildService == nil {
- return nil
- }
- if project == nil {
- return nil
- }
-
- selected := projects.NormalizeBuildSelections(options.Services)
-
- buildCount := 0
- for name, svc := range project.Services {
- if svc.Build == nil {
- continue
- }
- if !projects.ServiceSelected(selected, name) {
- continue
- }
-
- buildReq, updatedSvc, updated, err := s.prepareServiceBuildRequest(ctx, projectID, project, name, svc, options)
- if err != nil {
- return err
- }
- if updated {
- project.Services[name] = updatedSvc
- }
-
- buildCount++
- if _, err := s.buildService.BuildImage(ctx, types.LocalDockerEnvironmentID, buildReq, progressWriter, name, user); err != nil {
- return err
- }
- }
-
- if buildCount == 0 && len(selected) > 0 {
- return errors.Errorf("no build-enabled services matched: %s", strings.Join(options.Services, ", "))
- }
-
- return nil
-}
-
func (s *ProjectService) RestartProject(ctx context.Context, projectID string, services []string, user common.User) error {
proj, err := s.getMutableProjectInternal(ctx, projectID)
if err != nil {
@@ -1037,13 +610,7 @@ func (s *ProjectService) RestartProject(ctx context.Context, projectID string, s
return errors.WrapIf(err, "failed to update project status to restarting")
}
- // Get configured projects directory from settings
- cfg := s.settingsService.GetSettingsOrDefaults(ctx)
- projectsDirectory := getProjectsDirectoryOrDefaultInternal(ctx, cfg)
-
- pathMapper := s.projectPathMapperInternal(ctx)
-
- compProj, _, lerr := projects.LoadComposeProjectFromDir(ctx, proj.Path, projects.NormalizeProjectName(proj.Name), projectsDirectory, utils.BoolOrDefault(cfg.AutoInjectEnv.Value, false), pathMapper)
+ compProj, _, lerr := s.loadComposeProjectForProjectInternal(ctx, proj)
if lerr != nil {
_ = s.updateProjectStatusInternal(ctx, projectID, ProjectStatusRunning)
return errors.WrapIf(lerr, "failed to load compose project")
@@ -1066,3 +633,27 @@ func (s *ProjectService) RestartProject(ctx context.Context, projectID string, s
return s.updateProjectStatusandCountsInternal(ctx, projectID, ProjectStatusRunning)
}
+
+func (s *ProjectService) composeImageOperationsInternal(user *common.User, credentials []containerregistry.Credential) projecttypes.ComposeImageOperations {
+ operations := projecttypes.ComposeImageOperations{
+ Pull: func(ctx context.Context, image string, progress io.Writer) error {
+ actor := common.SystemUser
+ if user != nil {
+ actor = *user
+ }
+ return s.pullAndReconcileImageInternal(ctx, image, progress, actor, credentials)
+ },
+ }
+ if s.imageService != nil {
+ operations.Exists = s.imageService.ImageExistsLocally
+ operations.LastTagged = s.imageService.ImageLastTagTime
+ }
+ if s.buildService != nil {
+ operations.BuildProvider = s.buildService.BuildSettings().BuildProvider
+ operations.Build = func(ctx context.Context, request buildtypes.BuildRequest, progress io.Writer, service string) error {
+ _, err := s.buildService.BuildImage(ctx, types.LocalDockerEnvironmentID, request, progress, service, user)
+ return err
+ }
+ }
+ return operations
+}
diff --git a/backend/internal/project/project_listing.go b/backend/internal/project/project_listing.go
index a61734522..851e3fe61 100644
--- a/backend/internal/project/project_listing.go
+++ b/backend/internal/project/project_listing.go
@@ -4,6 +4,7 @@ import (
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
"context"
+ "fmt"
"log/slog"
"maps"
"os"
@@ -983,15 +984,6 @@ func (s *ProjectService) mapProjectToDto(ctx context.Context, projectsDir string
// are resolved here; callers iterating over many projects should resolve them
// once and pass them in.
func (s *ProjectService) ProjectMetadata(ctx context.Context, p Project, env *projectMetadataEnvInternal) projects.ArcaneComposeMetadata {
- if s.metaCache != nil && p.ID != "" {
- if entry, ok, _ := s.metaCache.Get(p.ID); ok {
- if validComposeCacheEntryInternal(entry.composeCacheEntry) {
- return entry.meta
- }
- s.metaCache.Delete(p.ID)
- }
- }
-
empty := projects.ArcaneComposeMetadata{ServiceIconSets: map[string]projects.IconSet{}}
composeFile, err := s.ResolveProjectComposeFile(ctx, &p)
@@ -1010,6 +1002,13 @@ func (s *ProjectService) ProjectMetadata(ctx context.Context, p Project, env *pr
}
}
+ fingerprint := fmt.Sprintf("%q|%q|%t", composeFile, env.projectsDirectory, env.autoInjectEnv)
+ if s.metaCache != nil && p.ID != "" {
+ if cached, ok := s.metaCache.Get(p.ID, fingerprint); ok {
+ return cached
+ }
+ }
+
meta, err := projects.ParseArcaneComposeMetadata(ctx, composeFile, env.projectsDirectory, env.autoInjectEnv)
if err != nil {
slog.WarnContext(ctx, "failed to parse Arcane compose metadata", "path", composeFile, "error", err)
@@ -1019,11 +1018,9 @@ func (s *ProjectService) ProjectMetadata(ctx context.Context, p Project, env *pr
if s.metaCache == nil || p.ID == "" {
return meta
}
- entry, err := newComposeCacheEntryInternal(&p, env.projectsDirectory, composeFile, meta.ComposeFiles, meta.EnvFiles)
- if err != nil {
- return meta
+ if err := s.metaCache.Set(p.ID, fingerprint, p.Path, env.projectsDirectory, composeFile, meta.ComposeFiles, meta.EnvFiles, meta); err != nil {
+ slog.DebugContext(ctx, "failed to cache Compose metadata", "projectID", p.ID, "error", err)
}
- s.metaCache.Set(p.ID, projectMetadataEntryInternal{composeCacheEntry: entry, meta: meta})
return meta
}
diff --git a/backend/internal/project/project_rename_journal.go b/backend/internal/project/project_rename_journal.go
deleted file mode 100644
index 3d5b7713b..000000000
--- a/backend/internal/project/project_rename_journal.go
+++ /dev/null
@@ -1,551 +0,0 @@
-package project
-
-import (
- "context"
- "encoding/json/v2"
- stderrors "errors"
- "log/slog"
- "os"
- "path/filepath"
- "strings"
- "time"
-
- "emperror.dev/errors"
-
- dockerutil "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumes"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
- "github.com/moby/moby/client"
- "go.getarcane.app/acfs"
- "gorm.io/gorm"
-)
-
-type activeProjectRenameSyncStateInternal struct {
- skipDiscoveredPaths map[string]struct{}
- protectSeenPaths map[string]struct{}
-}
-
-const (
- projectRenameJournalKeyPrefixInternal = "project_rename_journal:"
- projectRenameRollbackCleanupKeyPrefixInternal = "project_rename_rollback_cleanup:"
-
- projectRenameJournalPhaseStartedInternal = "started"
- projectRenameJournalPhaseTargetsCopiedInternal = "targets_copied"
- projectRenameJournalPhaseOldVolumesRemovedInternal = "old_volumes_removed"
- projectRenameJournalPhaseProjectStateCommittedInternal = "project_state_committed"
- projectRenameJournalPhaseSourceCleanupPendingInternal = "source_cleanup_pending"
- projectRenameJournalPhaseProjectStateRolledBackInternal = "project_state_rolled_back"
-)
-
-type projectRenameJournalInternal struct {
- ProjectID string `json:"projectId"`
- OldName string `json:"oldName"`
- NewName string `json:"newName"`
- OldPath string `json:"oldPath"`
- NewPath string `json:"newPath"`
- OldDirName *string `json:"oldDirName,omitempty"`
- NewDirName string `json:"newDirName"`
- Phase string `json:"phase"`
- Volumes []volumes.JournalVolume `json:"volumes,omitempty"`
- UpdatedAt time.Time `json:"updatedAt"`
-}
-
-type projectRenameRollbackCleanupInternal struct {
- ProjectID string `json:"projectId"`
- OldName string `json:"oldName"`
- OldPath string `json:"oldPath"`
- NewName string `json:"newName"`
- NewPath string `json:"newPath"`
- Volumes []volumes.JournalVolume `json:"volumes,omitempty"`
- UpdatedAt time.Time `json:"updatedAt"`
-}
-
-func (s *ProjectService) activeProjectRenameSyncStateInternal(ctx context.Context) activeProjectRenameSyncStateInternal {
- state := activeProjectRenameSyncStateInternal{
- skipDiscoveredPaths: make(map[string]struct{}),
- protectSeenPaths: make(map[string]struct{}),
- }
- if s == nil || s.kvService == nil {
- return state
- }
-
- entries, err := s.kvService.ListByPrefix(ctx, projectRenameJournalKeyPrefixInternal)
- if err != nil {
- slog.WarnContext(ctx, "failed to list project rename journals during filesystem sync", "error", err)
- return state
- }
-
- for _, entry := range entries {
- var journal projectRenameJournalInternal
- if err := json.Unmarshal([]byte(entry.Value), &journal); err != nil {
- slog.WarnContext(ctx, "failed to decode project rename journal during filesystem sync", "key", entry.Key, "error", err)
- continue
- }
- if !projectRenameJournalFilesystemSyncPendingInternal(journal.Phase) {
- continue
- }
- if oldPath := strings.TrimSpace(journal.OldPath); oldPath != "" {
- state.protectSeenPaths[filepath.Clean(oldPath)] = struct{}{}
- }
- if newPath := strings.TrimSpace(journal.NewPath); newPath != "" {
- state.skipDiscoveredPaths[filepath.Clean(newPath)] = struct{}{}
- }
- }
-
- return state
-}
-
-func (s activeProjectRenameSyncStateInternal) skipDiscoveredPathInternal(path string) bool {
- _, ok := s.skipDiscoveredPaths[filepath.Clean(path)]
- return ok
-}
-
-func (s activeProjectRenameSyncStateInternal) markProtectedPathsSeenInternal(seen map[string]struct{}) {
- for seenPath := range s.protectSeenPaths {
- seen[seenPath] = struct{}{}
- }
-}
-
-func (s *ProjectService) startProjectRenameJournalInternal(ctx context.Context, journal *projectRenameJournalInternal) (bool, error) {
- if journal == nil {
- return false, nil
- }
- if err := s.writeProjectRenameJournalInternal(ctx, journal, projectRenameJournalPhaseStartedInternal); err != nil {
- return false, err
- }
- return true, nil
-}
-
-func (s *ProjectService) applyProjectVolumeMigrationForUpdateInternal(ctx context.Context, volumeMigration volumes.Migration, renameJournal *projectRenameJournalInternal, applied *bool) error {
- if volumeMigration == nil {
- return nil
- }
- if err := volumeMigration.Apply(ctx); err != nil {
- return errors.WrapIf(err, "failed to rename project volumes")
- }
- *applied = true
- return s.writeProjectRenameJournalInternal(ctx, renameJournal, projectRenameJournalPhaseTargetsCopiedInternal)
-}
-
-func (s *ProjectService) finalizeProjectRenameAfterCommitInternal(ctx context.Context, projectID string, volumeMigration volumes.Migration, renameJournal *projectRenameJournalInternal, journalActive *bool) {
- if renameJournal != nil {
- if err := s.writeProjectRenameJournalInternal(ctx, renameJournal, projectRenameJournalPhaseProjectStateCommittedInternal); err != nil {
- slog.WarnContext(ctx, "failed to mark project rename journal committed", "projectID", projectID, "error", err)
- }
- }
-
- if committer, ok := volumeMigration.(volumes.Committer); ok {
- if err := committer.Commit(ctx); err != nil {
- slog.WarnContext(ctx, "failed to clean up project source volumes after committed rename", "projectID", projectID, "error", err)
- var cleanupErr *volumes.SourceCleanupError
- if errors.As(err, &cleanupErr) {
- if writeErr := s.writeProjectRenameJournalInternal(ctx, renameJournal, projectRenameJournalPhaseSourceCleanupPendingInternal); writeErr != nil {
- slog.WarnContext(ctx, "failed to mark project rename source cleanup pending", "projectID", projectID, "error", writeErr)
- }
- }
- return
- } else if err := s.writeProjectRenameJournalInternal(ctx, renameJournal, projectRenameJournalPhaseOldVolumesRemovedInternal); err != nil {
- slog.WarnContext(ctx, "failed to mark old project rename volumes removed", "projectID", projectID, "error", err)
- }
- }
-
- s.completeProjectRenameJournalForUpdateInternal(ctx, renameJournal, projectID, journalActive)
-}
-
-func (s *ProjectService) completeProjectRenameJournalForUpdateInternal(ctx context.Context, renameJournal *projectRenameJournalInternal, projectID string, journalActive *bool) {
- if renameJournal == nil {
- return
- }
- if clearErr := s.clearProjectRenameJournalInternal(ctx, projectID); clearErr != nil {
- slog.WarnContext(ctx, "failed to clear project rename journal", "projectID", projectID, "error", clearErr)
- return
- }
- *journalActive = false
-}
-
-func withProjectRenameRollback(ctx context.Context, proj *Project, projectStateCommitted *bool, run func() error) error {
- originalPath := proj.Path
- originalDirName := proj.DirName
-
- if err := run(); err != nil {
- if projectStateCommitted != nil && *projectStateCommitted {
- return err
- }
- if proj.Path != originalPath {
- // The rollback has to run even when the caller's context is already
- // cancelled, or a cancelled update leaves the directory renamed
- // with the database still pointing at the original path.
- rollbackCtx := context.WithoutCancel(ctx)
-
- // Both paths share a parent whenever the rename stayed inside the
- // projects directory; an imported project can sit elsewhere, in
- // which case the move crosses roots and cannot be confined.
- var renameErr error
- if parent := filepath.Dir(originalPath); parent == filepath.Dir(proj.Path) {
- renameErr = acfs.Rename(rollbackCtx, parent, "/"+filepath.Base(proj.Path), "/"+filepath.Base(originalPath))
- } else {
- renameErr = os.Rename(proj.Path, originalPath)
- }
- if renameErr != nil {
- slog.WarnContext(ctx, "failed to rollback project directory rename", "from", proj.Path, "to", originalPath, "error", renameErr)
- return err
- }
- proj.Path = originalPath
- proj.DirName = originalDirName
- }
- return err
- }
-
- return nil
-}
-
-func (s *ProjectService) prepareProjectRenameJournalInternal(proj *Project, name *string, projectsDirectory string, migration volumes.Migration) *projectRenameJournalInternal {
- if s == nil || s.kvService == nil || proj == nil || name == nil {
- return nil
- }
-
- newName := strings.TrimSpace(*name)
- if newName == "" || proj.Name == newName {
- return nil
- }
-
- newDirName := strings.TrimSpace(projects.SanitizeProjectName(newName))
- if newDirName == "" || strings.Trim(newDirName, "_") == "" {
- return nil
- }
-
- journal := &projectRenameJournalInternal{
- ProjectID: proj.ID,
- OldName: proj.Name,
- NewName: newName,
- OldPath: filepath.Clean(proj.Path),
- NewPath: filepath.Clean(filepath.Join(projectsDirectory, newDirName)),
- OldDirName: cloneStringPtrInternal(proj.DirName),
- NewDirName: newDirName,
- Phase: projectRenameJournalPhaseStartedInternal,
- }
-
- if source, ok := migration.(volumes.JournalSource); ok {
- journal.Volumes = source.JournalVolumes()
- }
-
- return journal
-}
-
-func (s *ProjectService) writeProjectRenameJournalInternal(ctx context.Context, journal *projectRenameJournalInternal, phase string) error {
- if s == nil || s.kvService == nil || journal == nil {
- return nil
- }
- journal.Phase = phase
- journal.UpdatedAt = time.Now().UTC()
-
- payload, err := json.Marshal(journal)
- if err != nil {
- return errors.WrapIf(err, "marshal project rename journal")
- }
-
- if err := s.kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+journal.ProjectID, string(payload)); err != nil {
- return errors.WrapIf(err, "write project rename journal")
- }
- return nil
-}
-
-func (s *ProjectService) clearProjectRenameJournalInternal(ctx context.Context, projectID string) error {
- if s == nil || s.kvService == nil || strings.TrimSpace(projectID) == "" {
- return nil
- }
- return s.kvService.Delete(ctx, projectRenameJournalKeyPrefixInternal+projectID)
-}
-
-func (s *ProjectService) writeProjectRenameRollbackCleanupInternal(ctx context.Context, journal *projectRenameJournalInternal) error {
- if s == nil || s.kvService == nil || journal == nil || strings.TrimSpace(journal.ProjectID) == "" || len(journal.Volumes) == 0 {
- return nil
- }
-
- cleanup := projectRenameRollbackCleanupInternal{
- ProjectID: journal.ProjectID,
- OldName: journal.OldName,
- OldPath: filepath.Clean(journal.OldPath),
- NewName: journal.NewName,
- NewPath: filepath.Clean(journal.NewPath),
- Volumes: journal.Volumes,
- UpdatedAt: time.Now().UTC(),
- }
- payload, err := json.Marshal(cleanup)
- if err != nil {
- return errors.WrapIf(err, "marshal project rename rollback cleanup")
- }
- if err := s.kvService.Set(ctx, projectRenameRollbackCleanupKeyPrefixInternal+journal.ProjectID, string(payload)); err != nil {
- return errors.WrapIf(err, "write project rename rollback cleanup")
- }
- return nil
-}
-
-func (s *ProjectService) clearProjectRenameRollbackCleanupInternal(ctx context.Context, projectID string) error {
- if s == nil || s.kvService == nil || strings.TrimSpace(projectID) == "" {
- return nil
- }
- return s.kvService.Delete(ctx, projectRenameRollbackCleanupKeyPrefixInternal+projectID)
-}
-
-func projectRenameJournalTargetsCopiedInternal(phase string) bool {
- switch phase {
- case projectRenameJournalPhaseTargetsCopiedInternal,
- projectRenameJournalPhaseOldVolumesRemovedInternal,
- projectRenameJournalPhaseProjectStateCommittedInternal,
- projectRenameJournalPhaseSourceCleanupPendingInternal:
- return true
- default:
- return false
- }
-}
-
-func projectRenameJournalFilesystemSyncPendingInternal(phase string) bool {
- switch phase {
- case projectRenameJournalPhaseStartedInternal,
- projectRenameJournalPhaseTargetsCopiedInternal:
- return true
- default:
- return false
- }
-}
-
-func (s *ProjectService) RecoverProjectRenameJournals(ctx context.Context) error {
- if s == nil || s.kvService == nil {
- return nil
- }
-
- entries, err := s.kvService.ListByPrefix(ctx, projectRenameJournalKeyPrefixInternal)
- if err != nil {
- return err
- }
-
- var recoverErr error
- for _, entry := range entries {
- var journal projectRenameJournalInternal
- if err := json.Unmarshal([]byte(entry.Value), &journal); err != nil {
- recoverErr = stderrors.Join(recoverErr, errors.WrapIff(err, "decode project rename journal %s", entry.Key))
- continue
- }
- if err := s.recoverProjectRenameJournalInternal(ctx, &journal); err != nil {
- recoverErr = stderrors.Join(recoverErr, errors.WrapIff(err, "recover project rename journal %s", entry.Key))
- continue
- }
- }
- return stderrors.Join(recoverErr, s.recoverProjectRenameRollbackCleanupsInternal(ctx))
-}
-
-func (s *ProjectService) recoverProjectRenameJournalForProjectInternal(ctx context.Context, projectID string) error {
- if s == nil || s.kvService == nil || strings.TrimSpace(projectID) == "" {
- return nil
- }
-
- raw, ok, err := s.kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+projectID)
- if err != nil || !ok {
- return err
- }
-
- var journal projectRenameJournalInternal
- if err := json.Unmarshal([]byte(raw), &journal); err != nil {
- return errors.WrapIf(err, "decode project rename journal")
- }
- return s.recoverProjectRenameJournalInternal(ctx, &journal)
-}
-
-func (s *ProjectService) recoverProjectRenameJournalInternal(ctx context.Context, journal *projectRenameJournalInternal) error {
- if s == nil || journal == nil || strings.TrimSpace(journal.ProjectID) == "" {
- return nil
- }
-
- var proj Project
- dbErr := s.db.WithContext(ctx).First(&proj, "id = ?", journal.ProjectID).Error
- if dbErr != nil && !errors.Is(dbErr, gorm.ErrRecordNotFound) {
- return errors.WrapIf(dbErr, "load project for rename recovery")
- }
-
- projectCommitted := dbErr == nil && (proj.Name == journal.NewName || filepath.Clean(proj.Path) == filepath.Clean(journal.NewPath))
- if projectCommitted {
- if journal.Phase == projectRenameJournalPhaseSourceCleanupPendingInternal {
- if err := s.cleanupProjectRenameJournalSourcesInternal(ctx, journal); err != nil {
- return err
- }
- return s.clearProjectRenameJournalInternal(ctx, journal.ProjectID)
- }
- if err := s.cleanupProjectRenameJournalSourcesInternal(ctx, journal); err != nil {
- var cleanupErr *volumes.SourceCleanupError
- if errors.As(err, &cleanupErr) {
- if writeErr := s.writeProjectRenameJournalInternal(ctx, journal, projectRenameJournalPhaseSourceCleanupPendingInternal); writeErr != nil {
- return stderrors.Join(err, writeErr)
- }
- }
- return err
- }
- return s.clearProjectRenameJournalInternal(ctx, journal.ProjectID)
- }
-
- if err := s.rollbackProjectRenameJournalInternal(ctx, journal); err != nil {
- return err
- }
- if err := s.writeProjectRenameJournalInternal(ctx, journal, projectRenameJournalPhaseProjectStateRolledBackInternal); err != nil {
- return err
- }
- return s.clearProjectRenameJournalInternal(ctx, journal.ProjectID)
-}
-
-func (s *ProjectService) cleanupProjectRenameJournalSourcesInternal(ctx context.Context, journal *projectRenameJournalInternal) error {
- dockerClient, err := s.projectRenameRecoveryDockerInternal(ctx, len(journal.Volumes) > 0)
- if err != nil {
- return err
- }
-
- if err := volumes.EnsureTargetsReadyForCleanup(ctx, dockerClient, journal.Volumes); err != nil {
- var missingWithSource *volumes.TargetMissingWithSourceError
- if errors.As(err, &missingWithSource) {
- slog.WarnContext(ctx, "rolling back project rename because target volume is missing and source volume remains", "projectID", journal.ProjectID, "sourceVolume", missingWithSource.SourceVolume, "targetVolume", missingWithSource.TargetVolume)
- return s.rollbackProjectRenameJournalInternal(ctx, journal)
- }
- var externallyRemoved *volumes.VolumesExternallyRemovedError
- if errors.As(err, &externallyRemoved) {
- slog.WarnContext(ctx, "project rename cleanup found source and target volumes externally removed", "projectID", journal.ProjectID, "volumeCount", len(externallyRemoved.Volumes), "error", externallyRemoved)
- } else {
- return err
- }
- }
-
- return volumes.RemoveSourceVolumes(ctx, dockerClient, journal.Volumes)
-}
-
-func (s *ProjectService) rollbackProjectRenameJournalInternal(ctx context.Context, journal *projectRenameJournalInternal) error {
- pathsMissing, directoryErr := projects.RollbackRenamedProjectDirectory(ctx, journal.OldPath, journal.NewPath)
-
- volumeErr := s.rollbackProjectRenameJournalVolumesInternal(ctx, journal)
-
- if err := s.db.WithContext(ctx).Model(&Project{}).
- Where("id = ?", journal.ProjectID).
- Updates(map[string]any{
- "name": journal.OldName,
- "path": journal.OldPath,
- "dir_name": journal.OldDirName,
- }).Error; err != nil {
- return stderrors.Join(directoryErr, volumeErr, errors.WrapIf(err, "restore project database state"))
- }
-
- if directoryErr != nil {
- 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", pathsMissing, "error", volumeErr)
- } else {
- if cleanupErr := s.writeProjectRenameRollbackCleanupInternal(ctx, journal); cleanupErr != nil {
- return stderrors.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", pathsMissing, "error", volumeErr)
- }
- }
-
- return directoryErr
-}
-
-func (s *ProjectService) recoverProjectRenameRollbackCleanupsInternal(ctx context.Context) error {
- if s == nil || s.kvService == nil {
- return nil
- }
-
- entries, err := s.kvService.ListByPrefix(ctx, projectRenameRollbackCleanupKeyPrefixInternal)
- if err != nil {
- return err
- }
-
- var recoverErr error
- for _, entry := range entries {
- var cleanup projectRenameRollbackCleanupInternal
- if err := json.Unmarshal([]byte(entry.Value), &cleanup); err != nil {
- recoverErr = stderrors.Join(recoverErr, errors.WrapIff(err, "decode project rename rollback cleanup %s", entry.Key))
- continue
- }
- if err := s.recoverProjectRenameRollbackCleanupInternal(ctx, &cleanup); err != nil {
- recoverErr = stderrors.Join(recoverErr, errors.WrapIff(err, "recover project rename rollback cleanup %s", entry.Key))
- continue
- }
- }
- return recoverErr
-}
-
-func (s *ProjectService) recoverProjectRenameRollbackCleanupInternal(ctx context.Context, cleanup *projectRenameRollbackCleanupInternal) error {
- if s == nil || cleanup == nil || strings.TrimSpace(cleanup.ProjectID) == "" {
- return nil
- }
- if len(cleanup.Volumes) == 0 {
- return s.clearProjectRenameRollbackCleanupInternal(ctx, cleanup.ProjectID)
- }
-
- var proj Project
- dbErr := s.db.WithContext(ctx).First(&proj, "id = ?", cleanup.ProjectID).Error
- if dbErr != nil {
- if errors.Is(dbErr, gorm.ErrRecordNotFound) {
- slog.WarnContext(ctx, "clearing project rename rollback cleanup because project no longer exists", "projectID", cleanup.ProjectID)
- return s.clearProjectRenameRollbackCleanupInternal(ctx, cleanup.ProjectID)
- }
- return errors.WrapIf(dbErr, "load project for rename rollback cleanup")
- }
-
- if proj.Name != cleanup.OldName || filepath.Clean(proj.Path) != filepath.Clean(cleanup.OldPath) {
- slog.WarnContext(ctx, "clearing project rename rollback cleanup because project state changed", "projectID", cleanup.ProjectID, "projectName", proj.Name, "projectPath", proj.Path)
- return s.clearProjectRenameRollbackCleanupInternal(ctx, cleanup.ProjectID)
- }
-
- dockerClient, err := s.projectRenameRecoveryDockerInternal(ctx, len(cleanup.Volumes) > 0)
- if err != nil {
- return err
- }
-
- if err := volumes.CleanupRollbackTargetVolumes(ctx, dockerClient, cleanup.Volumes); err != nil {
- if volumes.OnlyPreservedTargetErrors(err) {
- slog.WarnContext(ctx, "clearing project rename rollback cleanup after preserving target volume data", "projectID", cleanup.ProjectID, "error", err)
- return s.clearProjectRenameRollbackCleanupInternal(ctx, cleanup.ProjectID)
- }
- return err
- }
-
- dockerutil.InvalidateVolumeUsageCache(dockerClient)
- return s.clearProjectRenameRollbackCleanupInternal(ctx, cleanup.ProjectID)
-}
-
-func (s *ProjectService) rollbackProjectRenameJournalVolumesInternal(ctx context.Context, journal *projectRenameJournalInternal) error {
- if !projectRenameJournalTargetsCopiedInternal(journal.Phase) {
- return nil
- }
-
- dockerClient, err := s.projectRenameRecoveryDockerInternal(ctx, len(journal.Volumes) > 0)
- if err != nil {
- return err
- }
-
- return volumes.RollbackVolumes(ctx, dockerClient, journal.Volumes)
-}
-
-func (s *ProjectService) projectRenameRecoveryDockerInternal(ctx context.Context, dockerRequired bool) (*client.Client, error) {
- if !dockerRequired {
- return nil, nil
- }
- if s.dockerService == nil {
- return nil, errors.New("docker service unavailable")
- }
-
- dockerClient, err := s.dockerService.GetClient(ctx)
- if err != nil {
- return nil, errors.WrapIf(err, "failed to connect to Docker")
- }
-
- return dockerClient, nil
-}
-
-func cloneStringPtrInternal(value *string) *string {
- if value == nil {
- return nil
- }
- cloned := *value
- return &cloned
-}
diff --git a/backend/internal/project/project_sync.go b/backend/internal/project/project_sync.go
index 9da1cd386..dd6d4104a 100644
--- a/backend/internal/project/project_sync.go
+++ b/backend/internal/project/project_sync.go
@@ -9,7 +9,6 @@ import (
"time"
"emperror.dev/errors"
-
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
@@ -502,3 +501,236 @@ func (s *ProjectService) loadComposeMetadataForSyncInternal(ctx context.Context,
return meta, nil
}
+
+type gitSyncEnvUpdateInternal struct {
+ state projects.ProjectEnvState
+ gitEnvContent *string
+ overrideContent string
+ effectiveContent *string
+}
+
+func (s *ProjectService) resolveEffectiveEnvContentForUpdateInternal(projectPath string, envContent *string) (*string, error) {
+ if envContent != nil {
+ return envContent, nil
+ }
+
+ state, err := projects.ReadProjectEnvState(projectPath)
+ if err != nil {
+ return nil, errors.WrapIf(err, "read project env state")
+ }
+
+ effectiveContent, err := resolveStoredEffectiveEnvContentInternal(state)
+ if err != nil {
+ return nil, err
+ }
+ if effectiveContent == "" && !state.HasEffective && !state.HasGitSource && !state.HasOverride {
+ return nil, nil
+ }
+
+ return &effectiveContent, nil
+}
+
+func resolveStoredEffectiveEnvContentInternal(state projects.ProjectEnvState) (string, error) {
+ if state.HasEffective {
+ return state.EffectiveContent, nil
+ }
+ if state.HasGitSource || state.HasOverride {
+ effectiveContent, err := projects.BuildEffectiveEnvContent(state.GitContent, state.OverrideContent)
+ if err != nil {
+ return "", errors.WrapIf(err, "build effective env content")
+ }
+ return effectiveContent, nil
+ }
+ return state.DirectContent, nil
+}
+
+func persistEffectiveEnvContentInternal(ctx context.Context, projectPath, projectsDirectory, envContent string) error {
+ state, err := projects.ReadProjectEnvState(projectPath)
+ if err != nil {
+ return errors.WrapIf(err, "read project env state")
+ }
+
+ if state.HasGitSource && state.HasEffective && envContent == state.EffectiveContent {
+ storedEffectiveContent, buildErr := projects.BuildEffectiveEnvContent(state.GitContent, state.OverrideContent)
+ if buildErr == nil && envContent == storedEffectiveContent {
+ return nil
+ }
+ }
+
+ if !state.HasGitSource {
+ if state.HasOverride {
+ if err := projects.RemoveProjectFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName); err != nil {
+ return err
+ }
+ }
+ return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, state.EffectiveUnreadable, envContent)
+ }
+
+ overrideContent, err := projects.BuildOverrideEnvContent(state.GitContent, envContent)
+ if err != nil {
+ return errors.WrapIf(err, "build override env content")
+ }
+
+ effectiveContent, err := projects.BuildEffectiveEnvContent(state.GitContent, overrideContent)
+ if err != nil {
+ return errors.WrapIf(err, "build effective env content")
+ }
+
+ if err := projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, state.EffectiveUnreadable, effectiveContent); err != nil {
+ return err
+ }
+
+ return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName, state.OverrideUnreadable, overrideContent)
+}
+
+func (s *ProjectService) ensureEffectiveEnvFileInternal(ctx context.Context, projectPath, projectsDirectory string) error {
+ state, err := projects.ReadProjectEnvState(projectPath)
+ if err != nil {
+ return errors.WrapIf(err, "read project env state")
+ }
+
+ if !state.HasGitSource {
+ if state.HasOverride {
+ if err := projects.RemoveProjectFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName); err != nil {
+ return err
+ }
+ effectiveContent, err := resolveStoredEffectiveEnvContentInternal(state)
+ if err != nil {
+ return err
+ }
+ return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, state.EffectiveUnreadable, effectiveContent)
+ }
+ return projects.EnsureEnvFile(ctx, projectsDirectory, projectPath)
+ }
+
+ effectiveContent, err := projects.BuildEffectiveEnvContent(state.GitContent, state.OverrideContent)
+ if err != nil {
+ return errors.WrapIf(err, "build effective env content")
+ }
+
+ return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, state.EffectiveUnreadable, effectiveContent)
+}
+
+func (s *ProjectService) prepareGitSyncEnvUpdateInternal(projectPath string, gitEnvContent *string) (gitSyncEnvUpdateInternal, error) {
+ state, err := projects.ReadProjectEnvState(projectPath)
+ if err != nil {
+ return gitSyncEnvUpdateInternal{}, errors.WrapIf(err, "read project env state")
+ }
+
+ update := gitSyncEnvUpdateInternal{
+ state: state,
+ gitEnvContent: gitEnvContent,
+ }
+
+ if gitEnvContent == nil {
+ effectiveContent, err := resolveStoredEffectiveEnvContentInternal(state)
+ if err != nil {
+ return gitSyncEnvUpdateInternal{}, err
+ }
+ if effectiveContent == "" && !state.HasEffective && !state.HasGitSource && !state.HasOverride {
+ return update, nil
+ }
+ update.effectiveContent = &effectiveContent
+ return update, nil
+ }
+
+ overrideContent, err := s.resolveOverrideContentForGitSyncInternal(state, *gitEnvContent)
+ if err != nil {
+ return gitSyncEnvUpdateInternal{}, err
+ }
+ update.overrideContent = overrideContent
+
+ effectiveContent, err := projects.BuildEffectiveEnvContent(*gitEnvContent, overrideContent)
+ if err != nil {
+ return gitSyncEnvUpdateInternal{}, errors.WrapIf(err, "build effective env content")
+ }
+ update.effectiveContent = &effectiveContent
+
+ return update, nil
+}
+
+func (s *ProjectService) resolveOverrideContentForGitSyncInternal(state projects.ProjectEnvState, gitEnvContent string) (string, error) {
+ switch {
+ case state.HasGitSource:
+ overrideContent, err := projects.BuildOverrideEnvContent(state.GitContent, state.OverrideContent)
+ if err != nil {
+ return "", errors.WrapIf(err, "build override env content")
+ }
+ return overrideContent, nil
+ case state.HasOverride:
+ effectiveContent, err := resolveStoredEffectiveEnvContentInternal(state)
+ if err != nil {
+ return "", err
+ }
+ overrideContent, err := projects.BuildOverrideEnvContent(gitEnvContent, effectiveContent)
+ if err != nil {
+ return "", errors.WrapIf(err, "build override env content")
+ }
+ return overrideContent, nil
+ case strings.TrimSpace(state.DirectContent) != "":
+ overrideContent, err := projects.BuildAdditiveOverrideEnvContent(gitEnvContent, state.DirectContent)
+ if err != nil {
+ return "", errors.WrapIf(err, "build override env content")
+ }
+ return overrideContent, nil
+ default:
+ return "", nil
+ }
+}
+
+func persistGitSyncEnvFilesInternal(ctx context.Context, projectPath, projectsDirectory string, update gitSyncEnvUpdateInternal) error {
+ if update.gitEnvContent == nil {
+ if update.state.HasGitSource {
+ if err := projects.RemoveProjectFile(ctx, projectsDirectory, projectPath, projects.GitSourceEnvFileName); err != nil {
+ return err
+ }
+ }
+ if update.state.HasOverride {
+ if err := projects.RemoveProjectFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName); err != nil {
+ return err
+ }
+ }
+ if update.effectiveContent != nil || update.state.HasEffective || update.state.HasGitSource || update.state.HasOverride {
+ effectiveContent := ""
+ if update.effectiveContent != nil {
+ effectiveContent = *update.effectiveContent
+ }
+ return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, update.state.EffectiveUnreadable, effectiveContent)
+ }
+ if update.state.EffectiveUnreadable {
+ slog.Warn("skipping permission-locked .env file; leaving it untouched", "projectPath", projectPath)
+ return nil
+ }
+ return projects.EnsureEnvFile(ctx, projectsDirectory, projectPath)
+ }
+
+ if update.effectiveContent == nil {
+ return errors.New("missing effective env content for git sync update")
+ }
+
+ if err := projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.EffectiveEnvFileName, update.state.EffectiveUnreadable, *update.effectiveContent); err != nil {
+ return err
+ }
+ if err := projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.GitSourceEnvFileName, update.state.GitSourceUnreadable, *update.gitEnvContent); err != nil {
+ return err
+ }
+ return projects.WriteManagedEnvFile(ctx, projectsDirectory, projectPath, projects.OverrideEnvFileName, update.state.OverrideUnreadable, update.overrideContent)
+}
+
+// ApplyGitSyncEnvToDirectory applies the same managed three-file environment
+// merge used by single-file project syncs and returns the effective content
+// before and after the update.
+func (s *ProjectService) ApplyGitSyncEnvToDirectory(ctx context.Context, projectPath, projectsDirectory string, gitEnvContent *string) (before, after string, err error) {
+ update, err := s.prepareGitSyncEnvUpdateInternal(projectPath, gitEnvContent)
+ if err != nil {
+ return "", "", errors.WrapIf(err, "failed to resolve git env state")
+ }
+ before = update.state.DirectContent
+ if update.effectiveContent != nil {
+ after = *update.effectiveContent
+ }
+ if err := persistGitSyncEnvFilesInternal(ctx, projectPath, projectsDirectory, update); err != nil {
+ return "", "", errors.WrapIf(err, "failed to sync git env files")
+ }
+ return before, after, nil
+}
diff --git a/backend/internal/project/project_update.go b/backend/internal/project/project_update.go
index 4f01afe22..57d979761 100644
--- a/backend/internal/project/project_update.go
+++ b/backend/internal/project/project_update.go
@@ -1,28 +1,25 @@
package project
import (
- "github.com/getarcaneapp/arcane/backend/v2/internal/event"
-
- "github.com/getarcaneapp/arcane/backend/v2/internal/database"
-
"context"
+ "encoding/json/v2"
stderrors "errors"
"log/slog"
"os"
"path/filepath"
"strings"
+ "time"
- "emperror.dev/emperror"
"emperror.dev/errors"
-
- "github.com/compose-spec/compose-go/v2/loader"
- composetypes "github.com/compose-spec/compose-go/v2/types"
- "github.com/docker/compose/v5/pkg/api"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/database"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/event"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumehelper"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumes"
"github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
+ "github.com/moby/moby/client"
"go.getarcane.app/acfs"
acfstypes "go.getarcane.app/acfs/types"
"gorm.io/gorm"
@@ -75,7 +72,7 @@ func (s *ProjectService) UpdateProject(ctx context.Context, projectID string, na
}
projectStateCommitted := false
- if err := withProjectRenameRollback(ctx, &proj, &projectStateCommitted, func() error {
+ if err := withProjectRenameRollbackInternal(ctx, &proj, &projectStateCommitted, func() error {
return s.applyProjectUpdateWithRenameJournalInternal(ctx, &proj, name, projectsDirectory, composeContent, envContent, overrideContent, volumeMigration, renameJournal, &journalActive, &projectStateCommitted)
}); err != nil {
err = s.handleProjectUpdateFailureInternal(ctx, projectID, projectsDirectory, &proj, backup, &journalActive, projectStateCommitted, err)
@@ -135,7 +132,7 @@ func (s *ProjectService) prepareProjectUpdateBackupInternal(ctx context.Context,
return backup, func() { _ = acfs.RemoveAll(cleanupCtx, projectsDirectory, backupLogical) }, nil
}
-func (s *ProjectService) applyProjectUpdateWithRenameJournalInternal(ctx context.Context, proj *Project, name *string, projectsDirectory string, composeContent, envContent, overrideContent *string, volumeMigration volumes.Migration, renameJournal *projectRenameJournalInternal, journalActive *bool, projectStateCommitted *bool) (err error) {
+func (s *ProjectService) applyProjectUpdateWithRenameJournalInternal(ctx context.Context, proj *Project, name *string, projectsDirectory string, composeContent, envContent, overrideContent *string, volumeMigration volumetypes.Migration, renameJournal *projecttypes.RenameJournal, journalActive *bool, projectStateCommitted *bool) (err error) {
volumeMigrationApplied := false
defer func() {
stateCommitted := projectStateCommitted != nil && *projectStateCommitted
@@ -152,7 +149,7 @@ func (s *ProjectService) applyProjectUpdateWithRenameJournalInternal(ctx context
if err = s.persistUpdatedProjectFiles(ctx, proj, projectsDirectory, composeContent, envContent, overrideContent); err != nil {
return err
}
- if err = s.applyProjectVolumeMigrationForUpdateInternal(ctx, volumeMigration, renameJournal, &volumeMigrationApplied); err != nil {
+ if err = projects.ApplyRenameVolumeMigration(ctx, s.renameRecoveryOperationsInternal(), volumeMigration, renameJournal, &volumeMigrationApplied); err != nil {
return err
}
if err = s.saveProjectUpdateInternal(ctx, proj); err != nil {
@@ -161,7 +158,7 @@ func (s *ProjectService) applyProjectUpdateWithRenameJournalInternal(ctx context
if projectStateCommitted != nil {
*projectStateCommitted = true
}
- s.finalizeProjectRenameAfterCommitInternal(ctx, proj.ID, volumeMigration, renameJournal, journalActive)
+ projects.FinalizeRenameAfterCommit(ctx, s.renameRecoveryOperationsInternal(), proj.ID, volumeMigration, renameJournal, journalActive)
return nil
}
@@ -255,7 +252,7 @@ func (s *ProjectService) ApplyGitSyncProjectFiles(ctx context.Context, projectID
return nil, errors.WrapIf(err, "failed to resolve git env state")
}
- if err := validateComposeContentForUpdate(ctx, projectsDirectory, proj.Path, proj.Name, composeContent, envUpdate.effectiveContent, gitOverrideContent, gitOverrideFileName, true); err != nil {
+ if err := projects.ValidateComposeContentForUpdate(ctx, projectsDirectory, proj.Path, proj.Name, composeContent, envUpdate.effectiveContent, gitOverrideContent, gitOverrideFileName, true); err != nil {
return nil, errors.WrapIf(err, "invalid compose file")
}
@@ -346,7 +343,7 @@ func (s *ProjectService) getProjectForUpdate(ctx context.Context, projectID stri
return proj, projectsDirectory, nil
}
-func (s *ProjectService) prepareProjectRenameVolumeMigrationForUpdateInternal(ctx context.Context, proj *Project, name *string, projectsDirectory string, composeContent, envContent, overrideContent *string) (volumes.Migration, error) {
+func (s *ProjectService) prepareProjectRenameVolumeMigrationForUpdateInternal(ctx context.Context, proj *Project, name *string, projectsDirectory string, composeContent, envContent, overrideContent *string) (volumetypes.Migration, error) {
if !isProjectRenameRequestedInternal(proj, name) {
return nil, nil
}
@@ -383,13 +380,13 @@ func (s *ProjectService) prepareProjectRenameVolumeMigrationForUpdateInternal(ct
return s.prepareProjectRenameVolumeMigrationInternal(ctx, &previewProject, name)
}
-func (s *ProjectService) prepareProjectRenameVolumeMigrationInternal(ctx context.Context, proj *Project, name *string) (volumes.Migration, error) {
+func (s *ProjectService) prepareProjectRenameVolumeMigrationInternal(ctx context.Context, proj *Project, name *string) (volumetypes.Migration, error) {
oldComposeName, newComposeName, ok := projectRenameVolumeMigrationComposeNamesInternal(s, proj, name)
if !ok {
return nil, nil
}
- composeProject, _, err := s.loadComposeProjectForProjectInternal(ctx, proj, nil)
+ composeProject, _, err := s.loadComposeProjectForProjectInternal(ctx, proj)
if err != nil {
if errors.Is(err, common.ErrProjectComposeFileNotFound) {
return nil, nil
@@ -407,7 +404,7 @@ func (s *ProjectService) prepareProjectRenameVolumeMigrationInternal(ctx context
registry = s.settingsService.GetSettingsConfig().ToolsImageRegistry.Value
}
- return volumes.PlanMigration(ctx, dockerClient, composeProject, oldComposeName, newComposeName, volumehelper.ToolsImage(registry))
+ return projects.PlanVolumeMigration(ctx, dockerClient, composeProject, oldComposeName, newComposeName, volumehelper.ToolsImage(registry))
}
func projectRenameVolumeMigrationComposeNamesInternal(s *ProjectService, proj *Project, name *string) (string, string, bool) {
@@ -516,7 +513,7 @@ func (s *ProjectService) persistUpdatedProjectFiles(ctx context.Context, proj *P
return errors.WrapIf(err, "invalid compose file")
}
valOverride, valOverrideName := projects.ResolveEffectiveOverrideForValidation(proj.Path, overrideContent)
- if err := validateComposeContentForUpdate(ctx, projectsDirectory, proj.Path, proj.Name, *composeContent, effectiveEnvContent, valOverride, valOverrideName, false); err != nil {
+ if err := projects.ValidateComposeContentForUpdate(ctx, projectsDirectory, proj.Path, proj.Name, *composeContent, effectiveEnvContent, valOverride, valOverrideName, false); err != nil {
return errors.WrapIf(err, "invalid compose file")
}
// The env is persisted first so WriteComposeFile targets the COMPOSE_FILE
@@ -564,7 +561,7 @@ func (s *ProjectService) persistOverrideOnlyUpdateInternal(ctx context.Context,
return errors.WrapIf(err, "invalid compose file")
}
valOverride, valOverrideName := projects.ResolveEffectiveOverrideForValidation(proj.Path, overrideContent)
- if err := validateComposeContentForUpdate(ctx, projectsDirectory, proj.Path, proj.Name, baseContent, effectiveEnvContent, valOverride, valOverrideName, false); err != nil {
+ if err := projects.ValidateComposeContentForUpdate(ctx, projectsDirectory, proj.Path, proj.Name, baseContent, effectiveEnvContent, valOverride, valOverrideName, false); err != nil {
return errors.WrapIf(err, "invalid compose file")
}
if envContent != nil {
@@ -578,98 +575,6 @@ func (s *ProjectService) persistOverrideOnlyUpdateInternal(ctx context.Context,
return nil
}
-func validateComposeContentForUpdate(ctx context.Context, projectsDirectory, projectPath, projectName, composeContent string, effectiveEnvContent *string, overrideContent *string, overrideFileName string, lenient bool) (err error) {
- defer func() {
- if panicErr := emperror.Recover(recover()); panicErr != nil {
- err = errors.WrapIf(panicErr, "compose file contains invalid syntax")
- }
- }()
-
- fullEnvMap, envErr := projects.BuildValidationEnvironment(ctx, projectsDirectory, projectPath, effectiveEnvContent)
- if envErr != nil {
- return envErr
- }
-
- // COMPOSE_FILE in the (edited) env selects the exact file set, so validate
- // against it — a save that introduces a broken selection fails fast.
- envOpts, envOptsErr := projects.ParseComposeEnvOptions(projectPath, fullEnvMap)
- if envOptsErr != nil {
- return envOptsErr
- }
-
- validationProjectName := projects.NormalizeProjectName(projectName)
- var configFiles []composetypes.ConfigFile
- switch {
- case len(envOpts.ConfigFiles) > 0:
- // The compose tab edits the base (first) file. Later entries are read
- // from disk; existence was already checked while parsing COMPOSE_FILE. An
- // Arcane-managed override lives in the project root and only applies when
- // that exact path is listed in the selection (docker skips auto-overrides
- // for an explicit file set); a same-named file in a subdirectory is not
- // the managed override.
- overrideName := strings.TrimSpace(overrideFileName)
- if overrideName == "" {
- overrideName = projects.DefaultComposeOverrideFileName
- }
- overridePath := ""
- if absProjectPath, absErr := filepath.Abs(filepath.Clean(projectPath)); absErr == nil {
- overridePath = filepath.Join(absProjectPath, overrideName)
- }
- for i, f := range envOpts.ConfigFiles {
- switch {
- case i == 0:
- configFiles = append(configFiles, composetypes.ConfigFile{Filename: f, Content: []byte(composeContent)})
- case overrideContent != nil && overridePath != "" && f == overridePath:
- configFiles = append(configFiles, composetypes.ConfigFile{Filename: f, Content: []byte(*overrideContent)})
- default:
- configFiles = append(configFiles, composetypes.ConfigFile{Filename: f})
- }
- }
- default:
- configFiles = []composetypes.ConfigFile{
- {Filename: filepath.Join(projectPath, "compose.yaml"), Content: []byte(composeContent)},
- }
- // When an override is supplied, validate the *merged* config as `docker
- // compose` would deploy it. Overrides can add services and are layered on
- // top (listed after the base so the override wins).
- if overrideContent != nil {
- overrideName := strings.TrimSpace(overrideFileName)
- if overrideName == "" {
- overrideName = projects.DefaultComposeOverrideFileName
- }
- configFiles = append(configFiles, composetypes.ConfigFile{
- Filename: filepath.Join(projectPath, overrideName),
- Content: []byte(*overrideContent),
- })
- }
- }
-
- cfg := composetypes.ConfigDetails{
- Version: api.ComposeVersion,
- WorkingDir: projectPath,
- ConfigFiles: configFiles,
- Environment: composetypes.Mapping(fullEnvMap),
- }
-
- missingIncludeLoader := projects.NewMissingIncludeStubLoader(projectPath)
- defer missingIncludeLoader.Cleanup()
-
- err = projects.WithTransientValidationEnvFile(ctx, projectPath, effectiveEnvContent, func() error {
- _, loadErr := loader.LoadWithContext(ctx, cfg, func(opts *loader.Options) {
- opts.ResourceLoaders = append([]loader.ResourceLoader{missingIncludeLoader}, opts.ResourceLoaders...)
- if validationProjectName != "" {
- opts.SetProjectName(validationProjectName, false)
- }
- if lenient {
- projects.ApplyLenientLoaderOptions(ctx, opts, cfg.ConfigFiles[0].Filename)
- }
- })
- return loadErr
- })
-
- return err
-}
-
func (s *ProjectService) ensureProjectStoppedForRenameInternal(ctx context.Context, proj *Project, name *string) error {
if !isProjectRenameRequestedInternal(proj, name) {
return nil
@@ -755,3 +660,336 @@ func (s *ProjectService) applyProjectRenameIfNeeded(ctx context.Context, proj *P
proj.Name = newName
return nil
}
+
+type activeProjectRenameSyncStateInternal struct {
+ skipDiscoveredPaths map[string]struct{}
+ protectSeenPaths map[string]struct{}
+}
+
+func (s *ProjectService) activeProjectRenameSyncStateInternal(ctx context.Context) activeProjectRenameSyncStateInternal {
+ state := activeProjectRenameSyncStateInternal{
+ skipDiscoveredPaths: make(map[string]struct{}),
+ protectSeenPaths: make(map[string]struct{}),
+ }
+ if s == nil || s.kvService == nil {
+ return state
+ }
+
+ entries, err := s.kvService.ListByPrefix(ctx, projecttypes.RenameJournalKeyPrefix)
+ if err != nil {
+ slog.WarnContext(ctx, "failed to list project rename journals during filesystem sync", "error", err)
+ return state
+ }
+
+ for _, entry := range entries {
+ var journal projecttypes.RenameJournal
+ if err := json.Unmarshal([]byte(entry.Value), &journal); err != nil {
+ slog.WarnContext(ctx, "failed to decode project rename journal during filesystem sync", "key", entry.Key, "error", err)
+ continue
+ }
+ if !projects.RenameJournalFilesystemSyncPending(journal.Phase) {
+ continue
+ }
+ if oldPath := strings.TrimSpace(journal.OldPath); oldPath != "" {
+ state.protectSeenPaths[filepath.Clean(oldPath)] = struct{}{}
+ }
+ if newPath := strings.TrimSpace(journal.NewPath); newPath != "" {
+ state.skipDiscoveredPaths[filepath.Clean(newPath)] = struct{}{}
+ }
+ }
+
+ return state
+}
+
+func (s activeProjectRenameSyncStateInternal) skipDiscoveredPathInternal(path string) bool {
+ _, ok := s.skipDiscoveredPaths[filepath.Clean(path)]
+ return ok
+}
+
+func (s activeProjectRenameSyncStateInternal) markProtectedPathsSeenInternal(seen map[string]struct{}) {
+ for seenPath := range s.protectSeenPaths {
+ seen[seenPath] = struct{}{}
+ }
+}
+
+func (s *ProjectService) startProjectRenameJournalInternal(ctx context.Context, journal *projecttypes.RenameJournal) (bool, error) {
+ if journal == nil {
+ return false, nil
+ }
+ if err := s.writeProjectRenameJournalInternal(ctx, journal, projecttypes.RenameJournalPhaseStarted); err != nil {
+ return false, err
+ }
+ return true, nil
+}
+
+func withProjectRenameRollbackInternal(ctx context.Context, proj *Project, projectStateCommitted *bool, run func() error) error {
+ originalPath := proj.Path
+ originalDirName := proj.DirName
+
+ if err := run(); err != nil {
+ if projectStateCommitted != nil && *projectStateCommitted {
+ return err
+ }
+ if proj.Path != originalPath {
+ // The rollback has to run even when the caller's context is already
+ // cancelled, or a cancelled update leaves the directory renamed
+ // with the database still pointing at the original path.
+ rollbackCtx := context.WithoutCancel(ctx)
+
+ // Both paths share a parent whenever the rename stayed inside the
+ // projects directory; an imported project can sit elsewhere, in
+ // which case the move crosses roots and cannot be confined.
+ var renameErr error
+ if parent := filepath.Dir(originalPath); parent == filepath.Dir(proj.Path) {
+ renameErr = acfs.Rename(rollbackCtx, parent, "/"+filepath.Base(proj.Path), "/"+filepath.Base(originalPath))
+ } else {
+ renameErr = os.Rename(proj.Path, originalPath)
+ }
+ if renameErr != nil {
+ slog.WarnContext(ctx, "failed to rollback project directory rename", "from", proj.Path, "to", originalPath, "error", renameErr)
+ return err
+ }
+ proj.Path = originalPath
+ proj.DirName = originalDirName
+ }
+ return err
+ }
+
+ return nil
+}
+
+func (s *ProjectService) prepareProjectRenameJournalInternal(proj *Project, name *string, projectsDirectory string, migration volumetypes.Migration) *projecttypes.RenameJournal {
+ if s == nil || s.kvService == nil || proj == nil || name == nil {
+ return nil
+ }
+
+ newName := strings.TrimSpace(*name)
+ if newName == "" || proj.Name == newName {
+ return nil
+ }
+
+ newDirName := strings.TrimSpace(projects.SanitizeProjectName(newName))
+ if newDirName == "" || strings.Trim(newDirName, "_") == "" {
+ return nil
+ }
+
+ journal := &projecttypes.RenameJournal{
+ ProjectID: proj.ID,
+ OldName: proj.Name,
+ NewName: newName,
+ OldPath: filepath.Clean(proj.Path),
+ NewPath: filepath.Clean(filepath.Join(projectsDirectory, newDirName)),
+ OldDirName: cloneStringPtrInternal(proj.DirName),
+ NewDirName: newDirName,
+ Phase: projecttypes.RenameJournalPhaseStarted,
+ }
+
+ if source, ok := migration.(volumetypes.JournalSource); ok {
+ journal.Volumes = source.JournalVolumes()
+ }
+
+ return journal
+}
+
+func (s *ProjectService) writeProjectRenameJournalInternal(ctx context.Context, journal *projecttypes.RenameJournal, phase string) error {
+ if s == nil || s.kvService == nil || journal == nil {
+ return nil
+ }
+ journal.Phase = phase
+ journal.UpdatedAt = time.Now().UTC()
+
+ payload, err := json.Marshal(journal)
+ if err != nil {
+ return errors.WrapIf(err, "marshal project rename journal")
+ }
+
+ if err := s.kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+journal.ProjectID, string(payload)); err != nil {
+ return errors.WrapIf(err, "write project rename journal")
+ }
+ return nil
+}
+
+func (s *ProjectService) clearProjectRenameJournalInternal(ctx context.Context, projectID string) error {
+ if s == nil || s.kvService == nil || strings.TrimSpace(projectID) == "" {
+ return nil
+ }
+ return s.kvService.Delete(ctx, projecttypes.RenameJournalKeyPrefix+projectID)
+}
+
+func (s *ProjectService) writeProjectRenameRollbackCleanupInternal(ctx context.Context, journal *projecttypes.RenameJournal) error {
+ if s == nil || s.kvService == nil || journal == nil || strings.TrimSpace(journal.ProjectID) == "" || len(journal.Volumes) == 0 {
+ return nil
+ }
+
+ cleanup := projecttypes.RenameRollbackCleanup{
+ ProjectID: journal.ProjectID,
+ OldName: journal.OldName,
+ OldPath: filepath.Clean(journal.OldPath),
+ NewName: journal.NewName,
+ NewPath: filepath.Clean(journal.NewPath),
+ Volumes: journal.Volumes,
+ UpdatedAt: time.Now().UTC(),
+ }
+ payload, err := json.Marshal(cleanup)
+ if err != nil {
+ return errors.WrapIf(err, "marshal project rename rollback cleanup")
+ }
+ if err := s.kvService.Set(ctx, projecttypes.RenameRollbackCleanupKeyPrefix+journal.ProjectID, string(payload)); err != nil {
+ return errors.WrapIf(err, "write project rename rollback cleanup")
+ }
+ return nil
+}
+
+func (s *ProjectService) clearProjectRenameRollbackCleanupInternal(ctx context.Context, projectID string) error {
+ if s == nil || s.kvService == nil || strings.TrimSpace(projectID) == "" {
+ return nil
+ }
+ return s.kvService.Delete(ctx, projecttypes.RenameRollbackCleanupKeyPrefix+projectID)
+}
+
+func (s *ProjectService) RecoverProjectRenameJournals(ctx context.Context) error {
+ if s == nil || s.kvService == nil {
+ return nil
+ }
+
+ entries, err := s.kvService.ListByPrefix(ctx, projecttypes.RenameJournalKeyPrefix)
+ if err != nil {
+ return err
+ }
+
+ var recoverErr error
+ for _, entry := range entries {
+ var journal projecttypes.RenameJournal
+ if err := json.Unmarshal([]byte(entry.Value), &journal); err != nil {
+ recoverErr = stderrors.Join(recoverErr, errors.WrapIff(err, "decode project rename journal %s", entry.Key))
+ continue
+ }
+ if err := s.recoverProjectRenameJournalInternal(ctx, &journal); err != nil {
+ recoverErr = stderrors.Join(recoverErr, errors.WrapIff(err, "recover project rename journal %s", entry.Key))
+ continue
+ }
+ }
+ return stderrors.Join(recoverErr, s.recoverProjectRenameRollbackCleanupsInternal(ctx))
+}
+
+func (s *ProjectService) recoverProjectRenameJournalForProjectInternal(ctx context.Context, projectID string) error {
+ if s == nil || s.kvService == nil || strings.TrimSpace(projectID) == "" {
+ return nil
+ }
+
+ raw, ok, err := s.kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+projectID)
+ if err != nil || !ok {
+ return err
+ }
+
+ var journal projecttypes.RenameJournal
+ if err := json.Unmarshal([]byte(raw), &journal); err != nil {
+ return errors.WrapIf(err, "decode project rename journal")
+ }
+ return s.recoverProjectRenameJournalInternal(ctx, &journal)
+}
+
+func (s *ProjectService) recoverProjectRenameJournalInternal(ctx context.Context, journal *projecttypes.RenameJournal) error {
+ if s == nil || journal == nil || strings.TrimSpace(journal.ProjectID) == "" {
+ return nil
+ }
+
+ var proj Project
+ dbErr := s.db.WithContext(ctx).First(&proj, "id = ?", journal.ProjectID).Error
+ if dbErr != nil && !errors.Is(dbErr, gorm.ErrRecordNotFound) {
+ return errors.WrapIf(dbErr, "load project for rename recovery")
+ }
+
+ projectCommitted := dbErr == nil && (proj.Name == journal.NewName || filepath.Clean(proj.Path) == filepath.Clean(journal.NewPath))
+ return projects.RecoverRenameJournal(ctx, journal, projectCommitted, s.renameRecoveryOperationsInternal())
+}
+
+func (s *ProjectService) recoverProjectRenameRollbackCleanupsInternal(ctx context.Context) error {
+ if s == nil || s.kvService == nil {
+ return nil
+ }
+
+ entries, err := s.kvService.ListByPrefix(ctx, projecttypes.RenameRollbackCleanupKeyPrefix)
+ if err != nil {
+ return err
+ }
+
+ var recoverErr error
+ for _, entry := range entries {
+ var cleanup projecttypes.RenameRollbackCleanup
+ if err := json.Unmarshal([]byte(entry.Value), &cleanup); err != nil {
+ recoverErr = stderrors.Join(recoverErr, errors.WrapIff(err, "decode project rename rollback cleanup %s", entry.Key))
+ continue
+ }
+ if err := s.recoverProjectRenameRollbackCleanupInternal(ctx, &cleanup); err != nil {
+ recoverErr = stderrors.Join(recoverErr, errors.WrapIff(err, "recover project rename rollback cleanup %s", entry.Key))
+ continue
+ }
+ }
+ return recoverErr
+}
+
+func (s *ProjectService) recoverProjectRenameRollbackCleanupInternal(ctx context.Context, cleanup *projecttypes.RenameRollbackCleanup) error {
+ if s == nil || cleanup == nil || strings.TrimSpace(cleanup.ProjectID) == "" {
+ return nil
+ }
+ if len(cleanup.Volumes) == 0 {
+ return s.clearProjectRenameRollbackCleanupInternal(ctx, cleanup.ProjectID)
+ }
+
+ var proj Project
+ dbErr := s.db.WithContext(ctx).First(&proj, "id = ?", cleanup.ProjectID).Error
+ if dbErr != nil {
+ if errors.Is(dbErr, gorm.ErrRecordNotFound) {
+ slog.WarnContext(ctx, "clearing project rename rollback cleanup because project no longer exists", "projectID", cleanup.ProjectID)
+ return s.clearProjectRenameRollbackCleanupInternal(ctx, cleanup.ProjectID)
+ }
+ return errors.WrapIf(dbErr, "load project for rename rollback cleanup")
+ }
+
+ if proj.Name != cleanup.OldName || filepath.Clean(proj.Path) != filepath.Clean(cleanup.OldPath) {
+ slog.WarnContext(ctx, "clearing project rename rollback cleanup because project state changed", "projectID", cleanup.ProjectID, "projectName", proj.Name, "projectPath", proj.Path)
+ return s.clearProjectRenameRollbackCleanupInternal(ctx, cleanup.ProjectID)
+ }
+
+ return projects.CleanupRenameRollbackTargets(ctx, cleanup, s.renameRecoveryOperationsInternal())
+}
+
+func (s *ProjectService) projectRenameRecoveryDockerInternal(ctx context.Context, dockerRequired bool) (*client.Client, error) {
+ if !dockerRequired {
+ return nil, nil
+ }
+ if s.dockerService == nil {
+ return nil, errors.New("docker service unavailable")
+ }
+
+ dockerClient, err := s.dockerService.GetClient(ctx)
+ if err != nil {
+ return nil, errors.WrapIf(err, "failed to connect to Docker")
+ }
+
+ return dockerClient, nil
+}
+
+func cloneStringPtrInternal(value *string) *string {
+ if value == nil {
+ return nil
+ }
+ cloned := *value
+ return &cloned
+}
+
+func (s *ProjectService) renameRecoveryOperationsInternal() projecttypes.RenameRecoveryOperations {
+ return projecttypes.RenameRecoveryOperations{
+ Docker: s.projectRenameRecoveryDockerInternal,
+ WriteJournal: s.writeProjectRenameJournalInternal,
+ ClearJournal: s.clearProjectRenameJournalInternal,
+ ClearRollbackCleanup: s.clearProjectRenameRollbackCleanupInternal,
+ WriteRollbackCleanup: s.writeProjectRenameRollbackCleanupInternal,
+ RestoreState: func(ctx context.Context, journal *projecttypes.RenameJournal) error {
+ return s.db.WithContext(ctx).Model(&Project{}).Where("id = ?", journal.ProjectID).Updates(map[string]any{
+ "name": journal.OldName, "path": journal.OldPath, "dir_name": journal.OldDirName,
+ }).Error
+ },
+ }
+}
diff --git a/backend/internal/project/service_test.go b/backend/internal/project/service_test.go
index 3c57f0a3a..05d56b921 100644
--- a/backend/internal/project/service_test.go
+++ b/backend/internal/project/service_test.go
@@ -18,6 +18,8 @@ import (
"testing"
"time"
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
+
composetypes "github.com/compose-spec/compose-go/v2/types"
composeapi "github.com/docker/compose/v5/pkg/api"
"github.com/getarcaneapp/arcane/backend/v2/internal/actors"
@@ -584,7 +586,7 @@ func TestProjectService_GetProjectByComposeName(t *testing.T) {
require.NoError(t, err)
assert.Equal(t, original.ID, found.ID)
- cachedProjectID, cached := svc.composeNames.projectID("myproject").Get()
+ cachedProjectID, cached := svc.composeNames.projectIDInternal("myproject").Get()
require.True(t, cached)
assert.Equal(t, original.ID, cachedProjectID)
@@ -601,7 +603,7 @@ func TestProjectService_GetProjectByComposeName(t *testing.T) {
require.NoError(t, err)
assert.Equal(t, replacement.ID, found.ID)
- cachedProjectID, cached = svc.composeNames.projectID("myproject").Get()
+ cachedProjectID, cached = svc.composeNames.projectIDInternal("myproject").Get()
require.True(t, cached)
assert.Equal(t, replacement.ID, cachedProjectID)
})
@@ -621,7 +623,7 @@ func TestProjectService_GetProjectByComposeName(t *testing.T) {
require.NoError(t, err)
assert.Equal(t, original.ID, found.ID)
- cachedProjectID, cached := svc.composeNames.projectID("myapp").Get()
+ cachedProjectID, cached := svc.composeNames.projectIDInternal("myapp").Get()
require.True(t, cached)
assert.Equal(t, original.ID, cachedProjectID)
@@ -634,7 +636,7 @@ func TestProjectService_GetProjectByComposeName(t *testing.T) {
require.Error(t, err)
assert.Contains(t, err.Error(), "project not found")
- _, cached = svc.composeNames.projectID("myapp").Get()
+ _, cached = svc.composeNames.projectIDInternal("myapp").Get()
assert.False(t, cached)
})
}
@@ -776,9 +778,7 @@ func TestProjectService_EnsureImagesPresent_UpdatesCurrentImageRecordAfterPull(t
CheckTime: time.Now().UTC().Add(-time.Hour),
}).Error)
- require.NoError(t, svc.ensureImagesPresent(ctx, map[string]projects.ImagePullStep{
- imageRef: {Mode: projects.ImagePullModeAlways},
- }, io.Discard, nil, common.SystemUser))
+ require.NoError(t, svc.composeCoordinator.EnsureImagesPresent(ctx, &composetypes.Project{Services: composetypes.Services{"api": {Image: imageRef, PullPolicy: composetypes.PullPolicyAlways}}}, io.Discard, svc.composeImageOperationsInternal(nil, nil)))
// sha256:old-api may still be in use by another container — pulling for one container
// must not clear it (fixes #2453).
@@ -930,7 +930,7 @@ func TestProjectService_ComposePullSelectedServicesInternal_ReconcilesOnlyOnSucc
Enabled: true,
}}
- require.NoError(t, svc.composePullSelectedServicesInternal(ctx, projectDef, []string{"app", "app-copy", "sidecar", "builder"}, common.SystemUser, credentials))
+ require.NoError(t, svc.composeCoordinator.PullServices(ctx, projectDef, []string{"app", "app-copy", "sidecar", "builder"}, svc.composeImageOperationsInternal(nil, credentials), nil))
assert.Equal(t, 1, pullsByRef[privateImageRef], "duplicate service refs should only be pulled once")
assert.Equal(t, 1, pullsByRef[publicImageRef], "selected public image should still be pulled")
assert.Len(t, pullsByRef, 2, "build-backed services should not trigger image pulls")
@@ -1005,7 +1005,7 @@ func TestProjectService_ComposePullSelectedServicesInternal_LeavesRecordsWhenPul
CheckTime: time.Now().UTC().Add(-time.Hour),
}).Error)
- err = svc.composePullSelectedServicesInternal(ctx, projectDef, []string{"app"}, common.SystemUser, nil)
+ err = svc.composeCoordinator.PullServices(ctx, projectDef, []string{"app"}, svc.composeImageOperationsInternal(nil, nil), nil)
require.Error(t, err)
require.ErrorContains(t, err, "failed to pull image")
@@ -1116,7 +1116,7 @@ func TestProjectService_UpdateProjectServicesForcesRecreateInternal(t *testing.T
imageService := image.NewImageService(db, dockerService, nil, imageUpdateService, nil, event.NewEventService(db, nil, nil))
projectPath := createComposeProjectDir(t, projectsDir, "compose-update-force")
- require.NoError(t, os.WriteFile(filepath.Join(projectPath, "compose.yaml"), []byte("services:\n app:\n image: "+imageRef+"\n"), 0o644))
+ require.NoError(t, os.WriteFile(filepath.Join(projectPath, "compose.yaml"), []byte("services:\n app:\n image: "+imageRef+"\n unrelated:\n image: busybox:latest\n"), 0o644))
projectRecord := &Project{
ID: "project-update-force",
@@ -1138,8 +1138,9 @@ func TestProjectService_UpdateProjectServicesForcesRecreateInternal(t *testing.T
}
upCalled := false
forceRecreate := false
- composeUpProjectServicesInternal = func(_ context.Context, _ *composetypes.Project, services []string, removeOrphans bool, force bool, _ bool, _ map[string]dockerregistry.AuthConfig, _ time.Duration) error {
+ composeUpProjectServicesInternal = func(_ context.Context, selected *composetypes.Project, services []string, removeOrphans bool, force bool, _ bool, _ map[string]dockerregistry.AuthConfig, _ time.Duration) error {
upCalled = true
+ assert.Equal(t, []string{"app"}, selected.ServiceNames())
forceRecreate = force
assert.Equal(t, []string{"app"}, services)
assert.False(t, removeOrphans)
@@ -1374,7 +1375,7 @@ func TestProjectService_PrepareProjectRenameVolumeMigrationForUpdate_UsesCompose
require.NoError(t, err)
require.NotNil(t, migration)
- journalSource, ok := migration.(volumes.JournalSource)
+ journalSource, ok := migration.(volumetypes.JournalSource)
require.True(t, ok)
journalVolumes := journalSource.JournalVolumes()
require.Len(t, journalVolumes, 1)
@@ -1391,7 +1392,7 @@ func TestProjectService_PrepareProjectRenameVolumeMigrationForUpdate_UsesCompose
require.NoError(t, err)
require.NotNil(t, migration)
- journalSource, ok := migration.(volumes.JournalSource)
+ journalSource, ok := migration.(volumetypes.JournalSource)
require.True(t, ok)
journalVolumes := journalSource.JournalVolumes()
require.Len(t, journalVolumes, 1)
@@ -1408,7 +1409,7 @@ func TestProjectService_PrepareProjectRenameVolumeMigrationForUpdate_UsesCompose
require.NoError(t, err)
require.NotNil(t, migration)
- journalSource, ok := migration.(volumes.JournalSource)
+ journalSource, ok := migration.(volumetypes.JournalSource)
require.True(t, ok)
journalVolumes := journalSource.JournalVolumes()
require.Len(t, journalVolumes, 1)
@@ -1455,7 +1456,7 @@ func TestProjectService_ApplyProjectUpdateWithRenameJournal_RollsBackVolumeMigra
projectForUpdate := *project
journalActive := false
projectStateCommitted := false
- err = withProjectRenameRollback(ctx, &projectForUpdate, &projectStateCommitted, func() error {
+ err = withProjectRenameRollbackInternal(ctx, &projectForUpdate, &projectStateCommitted, func() error {
return svc.applyProjectUpdateWithRenameJournalInternal(ctx, &projectForUpdate, new("bar"), projectsDir, nil, nil, nil, migration, nil, &journalActive, &projectStateCommitted)
})
require.Error(t, err)
@@ -1500,7 +1501,7 @@ func TestProjectService_ApplyProjectUpdateWithRenameJournal_SucceedsCommittedRen
projectForUpdate := *project
journalActive := false
projectStateCommitted := false
- err = withProjectRenameRollback(ctx, &projectForUpdate, &projectStateCommitted, func() error {
+ err = withProjectRenameRollbackInternal(ctx, &projectForUpdate, &projectStateCommitted, func() error {
return svc.applyProjectUpdateWithRenameJournalInternal(ctx, &projectForUpdate, new("bar"), projectsDir, nil, nil, nil, migration, nil, &journalActive, &projectStateCommitted)
})
require.NoError(t, err)
@@ -1544,7 +1545,7 @@ func TestProjectService_UpdateProject_ClearsJournalForNonRenameWhenRecoveryDocke
}
require.NoError(t, db.Create(project).Error)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -1552,8 +1553,8 @@ func TestProjectService_UpdateProject_ClearsJournalForNonRenameWhenRecoveryDocke
NewPath: filepath.Join(projectsDir, "web"),
OldDirName: &oldDir,
NewDirName: "web",
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -1563,7 +1564,7 @@ func TestProjectService_UpdateProject_ClearsJournalForNonRenameWhenRecoveryDocke
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
envContent := "FOO=bar\n"
updated, err := svc.UpdateProject(ctx, project.ID, nil, nil, &envContent, nil, common.User{
@@ -1578,7 +1579,7 @@ func TestProjectService_UpdateProject_ClearsJournalForNonRenameWhenRecoveryDocke
require.NoError(t, err)
require.Equal(t, envContent, string(envBytes))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
}
@@ -1610,7 +1611,7 @@ func TestProjectService_UpdateProject_AllowsRenameAfterJournalRecoveryDockerUnav
}
require.NoError(t, db.Create(project).Error)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -1618,8 +1619,8 @@ func TestProjectService_UpdateProject_AllowsRenameAfterJournalRecoveryDockerUnav
NewPath: filepath.Join(projectsDir, "web"),
OldDirName: &oldDir,
NewDirName: "web",
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -1629,7 +1630,7 @@ func TestProjectService_UpdateProject_AllowsRenameAfterJournalRecoveryDockerUnav
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
updated, err := svc.UpdateProject(ctx, project.ID, new("web"), nil, nil, nil, common.User{
ID: "u1",
@@ -1642,7 +1643,7 @@ func TestProjectService_UpdateProject_AllowsRenameAfterJournalRecoveryDockerUnav
require.NoDirExists(t, projectPath)
require.DirExists(t, filepath.Join(projectsDir, "web"))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
}
@@ -4240,202 +4241,6 @@ func TestProjectService_ListProjects_WithDerivedStatusFilter_AllowsAllPageSizeSe
assert.Equal(t, "stopped-24", items[len(items)-1].Name)
}
-func TestProjectService_PrepareServiceBuildRequest_MapsComposeFields(t *testing.T) {
- svc := &ProjectService{}
- proj := &composetypes.Project{WorkingDir: "/tmp/project", Name: "demo"}
-
- serviceCfg := composetypes.ServiceConfig{
- Name: "web",
- Image: "example/web:latest",
- Platform: "linux/amd64",
- Build: &composetypes.BuildConfig{
- Context: ".",
- Dockerfile: "Dockerfile.custom",
- Target: "prod",
- Args: composetypes.MappingWithEquals{
- "FOO": new("bar"),
- },
- Tags: []string{"example/web:sha", "example/web:latest"},
- CacheFrom: []string{"example/cache:latest"},
- CacheTo: []string{"type=local,dest=/tmp/cache"},
- NoCache: true,
- Pull: true,
- Network: "host",
- Isolation: "default",
- ShmSize: composetypes.UnitBytes(64 * 1024 * 1024),
- Ulimits: map[string]*composetypes.UlimitsConfig{
- "nofile": {Soft: 1024, Hard: 2048},
- },
- Entitlements: []string{"network.host"},
- Privileged: true,
- ExtraHosts: composetypes.HostsList{
- "registry.local": {"10.0.0.5"},
- },
- Labels: composetypes.Labels{
- "com.example.team": "platform",
- },
- },
- }
-
- req, _, _, err := svc.prepareServiceBuildRequest(
- context.Background(),
- "project-id",
- proj,
- "web",
- serviceCfg,
- ProjectBuildOptions{},
- )
- require.NoError(t, err)
-
- assert.Equal(t, "/tmp/project", req.ContextDir)
- assert.Equal(t, "Dockerfile.custom", req.Dockerfile)
- assert.Equal(t, "prod", req.Target)
- assert.Equal(t, map[string]string{"FOO": "bar"}, req.BuildArgs)
- assert.Equal(t, []string{"example/web:latest", "example/web:sha"}, req.Tags)
- assert.Equal(t, []string{"linux/amd64"}, req.Platforms)
- assert.Equal(t, []string{"example/cache:latest"}, req.CacheFrom)
- assert.Equal(t, []string{"type=local,dest=/tmp/cache"}, req.CacheTo)
- assert.True(t, req.NoCache)
- assert.True(t, req.Pull)
- assert.Equal(t, "host", req.Network)
- assert.Equal(t, "default", req.Isolation)
- assert.Equal(t, int64(64*1024*1024), req.ShmSize)
- assert.Equal(t, map[string]string{"nofile": "1024:2048"}, req.Ulimits)
- assert.Equal(t, []string{"network.host"}, req.Entitlements)
- assert.True(t, req.Privileged)
- assert.Equal(t, map[string]string{"com.example.team": "platform"}, req.Labels)
- require.Len(t, req.ExtraHosts, 1)
- assert.Contains(t, req.ExtraHosts[0], "registry.local")
- assert.Contains(t, req.ExtraHosts[0], "10.0.0.5")
-}
-
-// TestProjectService_PrepareServiceBuildRequest_KeepsContainerPaths is a
-// regression test for #2314: Arcane's local build pipeline (the docker and
-// buildkit providers both read the build context via the Arcane process's own
-// filesystem) cannot use host paths, so prepareServiceBuildRequest must leave
-// the build context and any absolute Dockerfile path as container paths even
-// when the projects mount has a non-matching host prefix.
-func TestProjectService_PrepareServiceBuildRequest_KeepsContainerPaths(t *testing.T) {
- svc := &ProjectService{}
- proj := &composetypes.Project{WorkingDir: "/app/data/projects/demo", Name: "demo"}
-
- serviceCfg := composetypes.ServiceConfig{
- Name: "web",
- Image: "example/web:latest",
- Build: &composetypes.BuildConfig{
- Context: ".",
- Dockerfile: "/app/data/projects/demo/Dockerfile.custom",
- },
- }
-
- req, _, _, err := svc.prepareServiceBuildRequest(
- context.Background(),
- "project-id",
- proj,
- "web",
- serviceCfg,
- ProjectBuildOptions{},
- )
- require.NoError(t, err)
-
- assert.Equal(t, "/app/data/projects/demo", req.ContextDir)
- assert.Equal(t, "/app/data/projects/demo/Dockerfile.custom", req.Dockerfile)
-}
-
-// TestProjectService_PrepareServiceBuildRequest_BuildDotKeepsContainerPath
-// reproduces the exact configuration from #2314: a compose file with
-// `build: .` next to its Dockerfile, on an installation where the projects
-// directory is bind-mounted from a different host path than the container
-// path. The resulting BuildRequest must point at the container path so the
-// local builder can stat / tar the directory.
-func TestProjectService_PrepareServiceBuildRequest_BuildDotKeepsContainerPath(t *testing.T) {
- svc := &ProjectService{}
- proj := &composetypes.Project{WorkingDir: "/app/data/projects/caddy", Name: "caddy"}
-
- serviceCfg := composetypes.ServiceConfig{
- Name: "caddy",
- Image: "caddy",
- Build: &composetypes.BuildConfig{
- Context: ".",
- },
- }
-
- req, _, _, err := svc.prepareServiceBuildRequest(
- context.Background(),
- "project-id",
- proj,
- "caddy",
- serviceCfg,
- ProjectBuildOptions{},
- )
- require.NoError(t, err)
-
- assert.Equal(t, "/app/data/projects/caddy", req.ContextDir)
- assert.Equal(t, "Dockerfile", req.Dockerfile)
-}
-
-func TestProjectService_PrepareServiceBuildRequest_UsesInlineDockerfile(t *testing.T) {
- svc := &ProjectService{}
- proj := &composetypes.Project{WorkingDir: "/tmp/project", Name: "demo"}
-
- serviceCfg := composetypes.ServiceConfig{
- Name: "web",
- Image: "example/web:latest",
- Build: &composetypes.BuildConfig{
- Context: ".",
- DockerfileInline: "FROM alpine:3.20\nRUN echo inline\n",
- },
- }
-
- req, _, _, err := svc.prepareServiceBuildRequest(
- context.Background(),
- "project-id",
- proj,
- "web",
- serviceCfg,
- ProjectBuildOptions{},
- )
- require.NoError(t, err)
-
- assert.Equal(t, "/tmp/project", req.ContextDir)
- assert.Empty(t, req.Dockerfile)
- assert.Equal(t, "FROM alpine:3.20\nRUN echo inline\n", req.DockerfileInline)
-}
-
-func TestProjectService_PrepareServiceBuildRequest_GeneratedImageProviderGuardrails(t *testing.T) {
- svc := &ProjectService{}
- proj := &composetypes.Project{WorkingDir: "/tmp/project", Name: "demo"}
-
- serviceCfg := composetypes.ServiceConfig{
- Name: "web",
- Build: &composetypes.BuildConfig{
- Context: ".",
- },
- }
-
- _, _, _, err := svc.prepareServiceBuildRequest(
- context.Background(),
- "project-id",
- proj,
- "web",
- serviceCfg,
- ProjectBuildOptions{Provider: "depot"},
- )
- require.Error(t, err)
- assert.Contains(t, err.Error(), "must define an image when using depot")
-
- _, _, _, err = svc.prepareServiceBuildRequest(
- context.Background(),
- "project-id",
- proj,
- "web",
- serviceCfg,
- ProjectBuildOptions{Provider: "local", Push: new(true)},
- )
- require.Error(t, err)
- assert.Contains(t, err.Error(), "must define an image when push is enabled")
-}
-
func TestProjectService_DeployProject_StopsOnBuildPreparationError(t *testing.T) {
db := setupProjectTestDB(t)
ctx := context.Background()
@@ -5571,7 +5376,7 @@ func TestResolveRemoveOrphans(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
- require.Equal(t, tt.want, resolveRemoveOrphansInternal(tt.gitOpsManaged, tt.options))
+ require.Equal(t, tt.want, projects.ResolveRemoveOrphans(tt.gitOpsManaged, tt.options))
})
}
}
@@ -5600,7 +5405,7 @@ func TestProjectService_RecoverProjectRenameJournals_RollsBackUncommittedDirecto
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -5608,17 +5413,17 @@ func TestProjectService_RecoverProjectRenameJournals_RollsBackUncommittedDirecto
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
require.FileExists(t, filepath.Join(oldPath, "compose.yaml"))
require.NoDirExists(t, newPath)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
@@ -5654,7 +5459,7 @@ func TestProjectService_RecoverProjectRenameJournals_StartedPhaseSkipsVolumeRoll
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -5662,8 +5467,8 @@ func TestProjectService_RecoverProjectRenameJournals_StartedPhaseSkipsVolumeRoll
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseStartedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseStarted,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -5673,13 +5478,13 @@ func TestProjectService_RecoverProjectRenameJournals_StartedPhaseSkipsVolumeRoll
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
require.FileExists(t, filepath.Join(oldPath, "compose.yaml"))
require.NoDirExists(t, newPath)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
@@ -5717,7 +5522,7 @@ func TestProjectService_RecoverProjectRenameJournals_RelocatesTargetWhenBothPath
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -5725,15 +5530,15 @@ func TestProjectService_RecoverProjectRenameJournals_RelocatesTargetWhenBothPath
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseStartedInternal,
+ Phase: projecttypes.RenameJournalPhaseStarted,
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.FileExists(t, filepath.Join(oldPath, "compose.yaml"))
@@ -5780,7 +5585,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsStartedJournalWhenDir
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -5788,15 +5593,15 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsStartedJournalWhenDir
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseStartedInternal,
+ Phase: projecttypes.RenameJournalPhaseStarted,
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.NoDirExists(t, oldPath)
@@ -5845,7 +5650,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsPreservedTargetJourna
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -5853,8 +5658,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsPreservedTargetJourna
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -5864,26 +5669,17 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsPreservedTargetJourna
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.False(t, targetRemoved, "preserved target volume should remain for manual inspection")
require.DirExists(t, oldPath)
}
-func TestProjectRenameJournalTargetsCopiedInternal(t *testing.T) {
- require.False(t, projectRenameJournalTargetsCopiedInternal(projectRenameJournalPhaseStartedInternal))
- require.False(t, projectRenameJournalTargetsCopiedInternal(projectRenameJournalPhaseProjectStateRolledBackInternal))
- require.True(t, projectRenameJournalTargetsCopiedInternal(projectRenameJournalPhaseSourceCleanupPendingInternal))
- require.True(t, projectRenameJournalTargetsCopiedInternal(projectRenameJournalPhaseTargetsCopiedInternal))
- require.True(t, projectRenameJournalTargetsCopiedInternal(projectRenameJournalPhaseOldVolumesRemovedInternal))
- require.True(t, projectRenameJournalTargetsCopiedInternal(projectRenameJournalPhaseProjectStateCommittedInternal))
-}
-
func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournal(t *testing.T) {
db := setupProjectTestDB(t)
require.NoError(t, db.AutoMigrate(&kv.KVEntry{}))
@@ -5907,7 +5703,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournal(t *t
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -5915,15 +5711,15 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournal(t *t
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseOldVolumesRemovedInternal,
+ Phase: projecttypes.RenameJournalPhaseOldVolumesRemoved,
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.DirExists(t, newPath)
@@ -5947,7 +5743,7 @@ func TestProjectService_FinalizeProjectRenameAfterCommit_ClearsJournalAfterSourc
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := &projectRenameJournalInternal{
+ journal := &projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -5955,17 +5751,17 @@ func TestProjectService_FinalizeProjectRenameAfterCommit_ClearsJournalAfterSourc
NewPath: project.Path,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
}
- require.NoError(t, svc.writeProjectRenameJournalInternal(ctx, journal, projectRenameJournalPhaseTargetsCopiedInternal))
+ require.NoError(t, svc.writeProjectRenameJournalInternal(ctx, journal, projecttypes.RenameJournalPhaseTargetsCopied))
migration := &fakeProjectVolumeRenameMigrationInternal{}
journalActive := true
- svc.finalizeProjectRenameAfterCommitInternal(ctx, project.ID, migration, journal, &journalActive)
+ projects.FinalizeRenameAfterCommit(ctx, svc.renameRecoveryOperationsInternal(), project.ID, migration, journal, &journalActive)
require.True(t, migration.commitCalled)
require.False(t, journalActive)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
}
@@ -5988,7 +5784,7 @@ func TestProjectService_FinalizeProjectRenameAfterCommit_KeepsJournalWhenSourceC
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := &projectRenameJournalInternal{
+ journal := &projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -5996,25 +5792,25 @@ func TestProjectService_FinalizeProjectRenameAfterCommit_KeepsJournalWhenSourceC
NewPath: project.Path,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
}
- require.NoError(t, svc.writeProjectRenameJournalInternal(ctx, journal, projectRenameJournalPhaseTargetsCopiedInternal))
+ require.NoError(t, svc.writeProjectRenameJournalInternal(ctx, journal, projecttypes.RenameJournalPhaseTargetsCopied))
migration := &fakeProjectVolumeRenameMigrationInternal{
commitErr: volumes.NewSourceCleanupError("nginx_data", errors.New("source cleanup failed")),
}
journalActive := true
- svc.finalizeProjectRenameAfterCommitInternal(ctx, project.ID, migration, journal, &journalActive)
+ projects.FinalizeRenameAfterCommit(ctx, svc.renameRecoveryOperationsInternal(), project.ID, migration, journal, &journalActive)
require.True(t, migration.commitCalled)
require.True(t, journalActive)
- raw, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ raw, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.True(t, ok)
- var updatedJournal projectRenameJournalInternal
+ var updatedJournal projecttypes.RenameJournal
require.NoError(t, json.Unmarshal([]byte(raw), &updatedJournal))
- require.Equal(t, projectRenameJournalPhaseSourceCleanupPendingInternal, updatedJournal.Phase)
+ require.Equal(t, projecttypes.RenameJournalPhaseSourceCleanupPending, updatedJournal.Phase)
}
func TestProjectService_RecoverProjectRenameJournals_KeepsJournalWhenDirectoryRollbackFails(t *testing.T) {
@@ -6073,7 +5869,7 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsJournalWhenDirectoryRo
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6081,8 +5877,8 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsJournalWhenDirectoryRo
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6092,13 +5888,13 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsJournalWhenDirectoryRo
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.Error(t, err)
require.Contains(t, err.Error(), "rollback project directory rename")
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.True(t, ok)
require.True(t, targetRemoved.Load(), "target volume rollback should still run after directory rollback fails")
@@ -6115,7 +5911,7 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsJournalWhenDirectoryRo
require.NoError(t, os.MkdirAll(filepath.Dir(oldPath), 0o755))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err = kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err = kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.FileExists(t, filepath.Join(oldPath, "compose.yaml"))
@@ -6167,7 +5963,7 @@ func TestProjectService_RecoverProjectRenameJournals_CompletesCommittedVolumeJou
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6175,8 +5971,8 @@ func TestProjectService_RecoverProjectRenameJournals_CompletesCommittedVolumeJou
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseOldVolumesRemovedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseOldVolumesRemoved,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6186,11 +5982,11 @@ func TestProjectService_RecoverProjectRenameJournals_CompletesCommittedVolumeJou
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.True(t, oldVolumeRemoved.Load(), "expected committed recovery to remove source volume")
@@ -6240,7 +6036,7 @@ func TestProjectService_RecoverProjectRenameJournals_RollsBackCommittedJournalWh
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6248,8 +6044,8 @@ func TestProjectService_RecoverProjectRenameJournals_RollsBackCommittedJournalWh
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseOldVolumesRemovedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseOldVolumesRemoved,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6259,13 +6055,13 @@ func TestProjectService_RecoverProjectRenameJournals_RollsBackCommittedJournalWh
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.NoError(t, err)
require.False(t, oldVolumeRemoved.Load(), "source volume is the only remaining copy and must not be deleted")
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.DirExists(t, oldPath)
@@ -6350,7 +6146,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalAfterDBRestore
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6358,8 +6154,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalAfterDBRestore
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseProjectStateCommittedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseProjectStateCommitted,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6374,17 +6170,17 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalAfterDBRestore
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.Error(t, err)
require.ErrorContains(t, err, "remove rollback target volume web_cache")
require.Positive(t, targetRemoveAttempts.Load())
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok, "project-state journal should clear after database rollback succeeds")
- _, ok, err = kvService.Get(ctx, projectRenameRollbackCleanupKeyPrefixInternal+project.ID)
+ _, ok, err = kvService.Get(ctx, projecttypes.RenameRollbackCleanupKeyPrefix+project.ID)
require.NoError(t, err)
require.True(t, ok, "target cleanup should keep retry state when removal fails")
require.FileExists(t, filepath.Join(oldPath, "compose.yaml"))
@@ -6400,7 +6196,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalAfterDBRestore
allowTargetRemove.Store(true)
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err = kvService.Get(ctx, projectRenameRollbackCleanupKeyPrefixInternal+project.ID)
+ _, ok, err = kvService.Get(ctx, projecttypes.RenameRollbackCleanupKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.False(t, targetExists.Load())
@@ -6427,13 +6223,13 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsRollbackCleanupWhenDoc
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- cleanup := projectRenameRollbackCleanupInternal{
+ cleanup := projecttypes.RenameRollbackCleanup{
ProjectID: project.ID,
OldName: "nginx",
OldPath: oldPath,
NewName: "web",
NewPath: filepath.Join(projectsDir, "web"),
- Volumes: []volumes.JournalVolume{
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6443,13 +6239,13 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsRollbackCleanupWhenDoc
}
payload, err := json.Marshal(cleanup)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameRollbackCleanupKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameRollbackCleanupKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.Error(t, err)
require.ErrorContains(t, err, "docker service unavailable")
- _, ok, err := kvService.Get(ctx, projectRenameRollbackCleanupKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameRollbackCleanupKeyPrefix+project.ID)
require.NoError(t, err)
require.True(t, ok)
}
@@ -6490,7 +6286,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournalWhenS
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6498,8 +6294,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournalWhenS
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseProjectStateCommittedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseProjectStateCommitted,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6509,12 +6305,12 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournalWhenS
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.NoError(t, err)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.DirExists(t, newPath)
@@ -6576,7 +6372,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournalAndCl
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6584,8 +6380,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournalAndCl
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseProjectStateCommittedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseProjectStateCommitted,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6600,12 +6396,12 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsCommittedJournalAndCl
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.NoError(t, err)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.True(t, cacheSourceRemoved.Load(), "source volume should still be cleaned up when the target exists")
@@ -6659,7 +6455,7 @@ func TestProjectService_RecoverProjectRenameJournals_MarksSourceCleanupPendingWh
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6667,8 +6463,8 @@ func TestProjectService_RecoverProjectRenameJournals_MarksSourceCleanupPendingWh
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseProjectStateCommittedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseProjectStateCommitted,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6678,22 +6474,22 @@ func TestProjectService_RecoverProjectRenameJournals_MarksSourceCleanupPendingWh
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.Error(t, err)
- var cleanupErr *volumes.SourceCleanupError
+ var cleanupErr *volumetypes.SourceCleanupError
require.ErrorAs(t, err, &cleanupErr)
require.Equal(t, "nginx_data", cleanupErr.SourceVolume)
require.Positive(t, sourceRemoveAttempts.Load())
- raw, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ raw, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.True(t, ok)
- var updatedJournal projectRenameJournalInternal
+ var updatedJournal projecttypes.RenameJournal
require.NoError(t, json.Unmarshal([]byte(raw), &updatedJournal))
- require.Equal(t, projectRenameJournalPhaseSourceCleanupPendingInternal, updatedJournal.Phase)
+ require.Equal(t, projecttypes.RenameJournalPhaseSourceCleanupPending, updatedJournal.Phase)
require.DirExists(t, newPath)
require.NoDirExists(t, oldPath)
@@ -6744,7 +6540,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsSourceCleanupPendingJ
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6752,8 +6548,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsSourceCleanupPendingJ
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseSourceCleanupPendingInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseSourceCleanupPending,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6763,12 +6559,12 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsSourceCleanupPendingJ
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.NoError(t, err)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.True(t, sourceRemoved.Load())
@@ -6843,7 +6639,7 @@ func TestProjectService_RecoverProjectRenameJournals_RollsBackSourceCleanupPendi
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6851,8 +6647,8 @@ func TestProjectService_RecoverProjectRenameJournals_RollsBackSourceCleanupPendi
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseSourceCleanupPendingInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseSourceCleanupPending,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6867,15 +6663,15 @@ func TestProjectService_RecoverProjectRenameJournals_RollsBackSourceCleanupPendi
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.NoError(t, err)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
- _, ok, err = kvService.Get(ctx, projectRenameRollbackCleanupKeyPrefixInternal+project.ID)
+ _, ok, err = kvService.Get(ctx, projecttypes.RenameRollbackCleanupKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.False(t, dataSourceRemoved.Load(), "source volume is the remaining data copy and must not be removed")
@@ -6933,7 +6729,7 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsSourceCleanupPendingJo
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -6941,8 +6737,8 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsSourceCleanupPendingJo
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseSourceCleanupPendingInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseSourceCleanupPending,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -6952,22 +6748,22 @@ func TestProjectService_RecoverProjectRenameJournals_KeepsSourceCleanupPendingJo
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.Error(t, err)
- var cleanupErr *volumes.SourceCleanupError
+ var cleanupErr *volumetypes.SourceCleanupError
require.ErrorAs(t, err, &cleanupErr)
require.Equal(t, "nginx_data", cleanupErr.SourceVolume)
require.Positive(t, sourceRemoveAttempts.Load())
- raw, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ raw, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.True(t, ok)
- var updatedJournal projectRenameJournalInternal
+ var updatedJournal projecttypes.RenameJournal
require.NoError(t, json.Unmarshal([]byte(raw), &updatedJournal))
- require.Equal(t, projectRenameJournalPhaseSourceCleanupPendingInternal, updatedJournal.Phase)
+ require.Equal(t, projecttypes.RenameJournalPhaseSourceCleanupPending, updatedJournal.Phase)
require.DirExists(t, newPath)
require.NoDirExists(t, oldPath)
@@ -6999,7 +6795,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsStartedJournalWhenDir
kvService := kv.NewKVService(db)
svc := NewProjectService(db, nil, nil, nil, nil, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -7007,17 +6803,17 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsStartedJournalWhenDir
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseStartedInternal,
+ Phase: projecttypes.RenameJournalPhaseStarted,
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
require.NoDirExists(t, oldPath)
require.NoDirExists(t, newPath)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
}
@@ -7069,7 +6865,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsMissingPathJournalWhe
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -7077,8 +6873,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsMissingPathJournalWhe
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -7088,11 +6884,11 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsMissingPathJournalWhe
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok)
require.False(t, targetRemoved.Load(), "target volume may be the only complete copy and must stay when source restore fails")
@@ -7143,7 +6939,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenRollbackSo
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -7151,8 +6947,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenRollbackSo
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -7162,11 +6958,11 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenRollbackSo
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok, "inspect uncertainty should not permanently block future renames")
require.False(t, targetRemoved.Load(), "target volume must not be deleted when source inspection is uncertain")
@@ -7222,7 +7018,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenRollbackTa
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -7230,8 +7026,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenRollbackTa
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -7241,11 +7037,11 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenRollbackTa
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
require.NoError(t, svc.RecoverProjectRenameJournals(ctx))
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok, "inspect uncertainty should not permanently block future renames")
require.False(t, targetRemoved.Load(), "target volume must not be deleted when target inspection is uncertain")
@@ -7307,7 +7103,7 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenTargetPres
kvService := kv.NewKVService(db)
dockerService := &docker.DockerClientService{Client: newTestDockerClientInternal(t, server)}
svc := NewProjectService(db, nil, nil, nil, dockerService, nil, nil, nil, config.Load()).WithKVService(kvService)
- journal := projectRenameJournalInternal{
+ journal := projecttypes.RenameJournal{
ProjectID: project.ID,
OldName: "nginx",
NewName: "web",
@@ -7315,8 +7111,8 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenTargetPres
NewPath: newPath,
OldDirName: &oldDir,
NewDirName: newDir,
- Phase: projectRenameJournalPhaseTargetsCopiedInternal,
- Volumes: []volumes.JournalVolume{
+ Phase: projecttypes.RenameJournalPhaseTargetsCopied,
+ Volumes: []volumetypes.JournalVolume{
{
Key: "data",
OldName: "nginx_data",
@@ -7326,12 +7122,12 @@ func TestProjectService_RecoverProjectRenameJournals_ClearsJournalWhenTargetPres
}
payload, err := json.Marshal(journal)
require.NoError(t, err)
- require.NoError(t, kvService.Set(ctx, projectRenameJournalKeyPrefixInternal+project.ID, string(payload)))
+ require.NoError(t, kvService.Set(ctx, projecttypes.RenameJournalKeyPrefix+project.ID, string(payload)))
err = svc.RecoverProjectRenameJournals(ctx)
require.NoError(t, err)
- _, ok, err := kvService.Get(ctx, projectRenameJournalKeyPrefixInternal+project.ID)
+ _, ok, err := kvService.Get(ctx, projecttypes.RenameJournalKeyPrefix+project.ID)
require.NoError(t, err)
require.False(t, ok, "preserved target data should not leave the project permanently blocked")
require.False(t, targetRemoved.Load(), "target volume may be the only complete copy and must stay when source restore fails")
diff --git a/backend/internal/project/workspace_handler.go b/backend/internal/project/workspace_handler.go
deleted file mode 100644
index dd003b50f..000000000
--- a/backend/internal/project/workspace_handler.go
+++ /dev/null
@@ -1,129 +0,0 @@
-package project
-
-import (
- "github.com/getarcaneapp/arcane/backend/v2/internal/database"
-
- "context"
- "mime/multipart"
- "net/http"
- "strings"
-
- activitytypes "github.com/getarcaneapp/arcane/types/v2/activity"
-
- "emperror.dev/errors"
- "github.com/danielgtaylor/huma/v2"
- "github.com/getarcaneapp/arcane/backend/v2/internal/common"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/authz"
- activitylib "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/activity"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/utils/handlerutil"
- workspacepkg "github.com/getarcaneapp/arcane/backend/v2/pkg/workspace"
- "github.com/getarcaneapp/arcane/types/v2/base"
- projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
- workspacetypes "github.com/getarcaneapp/arcane/types/v2/workspace"
- "github.com/samber/mo"
-)
-
-type GetProjectWorkspaceInput struct {
- EnvironmentID string `path:"id" doc:"Environment ID"`
- ProjectID string `path:"projectId" doc:"Project ID"`
-}
-
-type GetProjectWorkspaceFileInput struct {
- EnvironmentID string `path:"id" doc:"Environment ID"`
- ProjectID string `path:"projectId" doc:"Project ID"`
- RelativePath string `query:"relativePath" doc:"Path relative to the project workspace root"`
-}
-
-type UpdateProjectWorkspaceInput struct {
- EnvironmentID string `path:"id" doc:"Environment ID"`
- ProjectID string `path:"projectId" doc:"Project ID"`
- RawBody multipart.Form `contentType:"multipart/form-data"`
-}
-
-func registerProjectWorkspaceRoutesInternal(api huma.API, h *ProjectHandler) {
- basePath := "/environments/{id}/projects/{projectId}/workspace"
- tag := "Project Workspace"
- handlerutil.RegisterSecured(api, handlerutil.Operation("get-project-workspace", http.MethodGet, basePath, "Get project workspace", "", tag), authz.PermProjectsRead, h.GetProjectWorkspace)
- handlerutil.RegisterSecured(api, handlerutil.Operation("get-project-workspace-file", http.MethodGet, basePath+"/file", "Get project workspace file", "", tag), authz.PermProjectsRead, h.GetProjectWorkspaceFile)
- handlerutil.RegisterSecured(api, handlerutil.Operation("download-project-workspace-file", http.MethodGet, basePath+"/file/download", "Download project workspace file", "", tag), authz.PermProjectsRead, h.DownloadProjectWorkspaceFile)
- updateOperation := handlerutil.Operation("update-project-workspace", http.MethodPut, basePath, "Update project workspace", "", tag)
- updateOperation.RequestBody = handlerutil.WorkspaceMultipartRequestBody("JSON encoded project workspace manifest")
- handlerutil.RegisterSecured(api, updateOperation, authz.PermProjectsUpdate, h.UpdateProjectWorkspace)
-}
-
-func projectWorkspaceHTTPErrorInternal(err error) error {
- switch {
- case errors.Is(err, common.ErrProjectWorkspaceConflict):
- return huma.Error409Conflict(err.Error())
- case errors.Is(err, common.ErrProjectArchived):
- return huma.Error409Conflict(err.Error())
- case errors.Is(err, common.ErrProjectWorkspaceForbidden):
- return huma.Error403Forbidden(err.Error())
- case errors.Is(err, common.ErrProjectWorkspaceNotFound), errors.Is(err, common.ErrProjectNotFound):
- return huma.Error404NotFound(err.Error())
- case errors.Is(err, common.ErrProjectWorkspaceBadRequest):
- return huma.Error400BadRequest(err.Error())
- default:
- return huma.Error500InternalServerError("internal error")
- }
-}
-
-func (h *ProjectHandler) GetProjectWorkspace(ctx context.Context, input *GetProjectWorkspaceInput) (*handlerutil.Out[workspacetypes.Workspace], error) {
- result, err := h.projectService.GetProjectWorkspace(ctx, input.ProjectID)
- if err != nil {
- return nil, projectWorkspaceHTTPErrorInternal(err)
- }
- return &handlerutil.Out[workspacetypes.Workspace]{Body: base.ApiResponse[workspacetypes.Workspace]{Success: true, Data: *result}}, nil
-}
-
-func (h *ProjectHandler) GetProjectWorkspaceFile(ctx context.Context, input *GetProjectWorkspaceFileInput) (*handlerutil.Out[workspacetypes.FileContent], error) {
- result, err := h.projectService.GetProjectWorkspaceFile(ctx, input.ProjectID, input.RelativePath)
- if err != nil {
- return nil, projectWorkspaceHTTPErrorInternal(err)
- }
- return &handlerutil.Out[workspacetypes.FileContent]{Body: base.ApiResponse[workspacetypes.FileContent]{Success: true, Data: *result}}, nil
-}
-
-func (h *ProjectHandler) DownloadProjectWorkspaceFile(ctx context.Context, input *GetProjectWorkspaceFileInput) (*huma.StreamResponse, error) {
- reader, size, name, err := h.projectService.DownloadProjectWorkspaceFile(ctx, input.ProjectID, input.RelativePath)
- if err != nil {
- return nil, projectWorkspaceHTTPErrorInternal(err)
- }
- return handlerutil.DownloadResponse(reader, size, name), nil
-}
-
-func (h *ProjectHandler) UpdateProjectWorkspace(ctx context.Context, input *UpdateProjectWorkspaceInput) (*handlerutil.Out[workspacetypes.Workspace], error) {
- manifest, err := handlerutil.ParseMultipartJSONPart[projecttypes.WorkspaceUpdateManifest](input.RawBody, "manifest")
- if err != nil {
- return nil, err
- }
- maxFileSizeMB := workspacepkg.DefaultMaxFileSizeMB
- if h.projectService != nil && h.projectService.config != nil {
- maxFileSizeMB = h.projectService.config.ProjectWorkspaceMaxFileSizeMB
- }
- uploads, err := handlerutil.ReadWorkspaceUploads(input.RawBody, workspacepkg.MaxFileSizeBytes(maxFileSizeMB))
- if err != nil {
- return nil, err
- }
- user, err := handlerutil.RequireUser(ctx)
- if err != nil {
- return nil, err
- }
- var result *workspacetypes.Workspace
- runtimeCtx := utils.ActivityRuntimeContext(ctx, h.appCtx)
- activityID, err := activitylib.RunHandlerActivity(runtimeCtx, h.activityService, activitylib.HandlerOptions{
- EnvironmentID: input.EnvironmentID, Type: activitytypes.TypeResourceAction, ResourceType: "project", ResourceID: input.ProjectID, ResourceName: input.ProjectID, User: user,
- Step: "Updating project workspace", Message: "Updating project workspace", SuccessMessage: "Project workspace updated successfully",
- Metadata: database.JSON{"action": "update_project_workspace", "fileChangeCount": len(manifest.FileChanges)},
- }, func(runtimeCtx context.Context) error {
- var updateErr error
- result, updateErr = h.projectService.UpdateProjectWorkspace(runtimeCtx, input.ProjectID, manifest, uploads, *user)
- return updateErr
- })
- if err != nil {
- return nil, projectWorkspaceHTTPErrorInternal(err)
- }
- result.ActivityID = mo.EmptyableToOption(strings.TrimSpace(activityID)).ToPointer()
- return &handlerutil.Out[workspacetypes.Workspace]{Body: base.ApiResponse[workspacetypes.Workspace]{Success: true, Data: *result}}, nil
-}
diff --git a/backend/internal/template/service.go b/backend/internal/template/service.go
index 330933141..810acab08 100644
--- a/backend/internal/template/service.go
+++ b/backend/internal/template/service.go
@@ -17,8 +17,6 @@ import (
"emperror.dev/errors"
- composeloader "github.com/compose-spec/compose-go/v2/loader"
- composetypes "github.com/compose-spec/compose-go/v2/types"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/getarcaneapp/arcane/backend/v2/internal/database"
"github.com/getarcaneapp/arcane/backend/v2/internal/settings"
@@ -59,12 +57,9 @@ type TemplateService struct {
}
const (
- remoteCacheDuration = 5 * time.Minute
- fsSyncInterval = 1 * time.Minute
- remoteIconResolveLimit = 4
- templateArcaneBlockKey = "x-arcane"
- templateArcaneIconKey = "icon"
- templateArcaneIconsAliasKey = "icons"
+ remoteCacheDuration = 5 * time.Minute
+ fsSyncInterval = 1 * time.Minute
+ remoteIconResolveLimit = 4
)
const remoteIDPrefix = "remote"
@@ -306,7 +301,7 @@ func (s *TemplateService) CreateTemplate(ctx context.Context, template *ComposeT
}
template.IsCustom = true
template.IsRemote = false
- setTemplateIconURL(template, s.resolveTemplateIconURL(ctx, template.Content, mo.PointerToOption(template.EnvContent).OrEmpty()))
+ setTemplateIconURL(template, projects.ResolveTemplateIconURL(ctx, template.Content, mo.PointerToOption(template.EnvContent).OrEmpty()))
return s.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
if err := tx.Create(template).Error; err != nil {
return errors.WrapIf(err, "failed to create template")
@@ -333,7 +328,7 @@ func (s *TemplateService) UpdateTemplate(ctx context.Context, id string, updates
existing.Description = updates.Description
existing.Content = updates.Content
existing.EnvContent = updates.EnvContent
- setTemplateIconURL(&existing, s.resolveTemplateIconURL(ctx, existing.Content, mo.PointerToOption(existing.EnvContent).OrEmpty()))
+ setTemplateIconURL(&existing, projects.ResolveTemplateIconURL(ctx, existing.Content, mo.PointerToOption(existing.EnvContent).OrEmpty()))
if err := tx.Save(&existing).Error; err != nil {
return errors.WrapIf(err, "failed to update template")
@@ -806,7 +801,7 @@ func (s *TemplateService) enrichRemoteTemplateIcons(ctx context.Context, templat
return nil
}
- setTemplateIconURL(&templates[idx], s.resolveTemplateIconURL(groupCtx, composeContent, envContent))
+ setTemplateIconURL(&templates[idx], projects.ResolveTemplateIconURL(groupCtx, composeContent, envContent))
return nil
})
}
@@ -1017,7 +1012,7 @@ func (s *TemplateService) SyncLocalTemplatesFromFilesystem(ctx context.Context)
}
func (s *TemplateService) upsertFilesystemTemplate(ctx context.Context, name, desc, compose string, envPtr *string) error {
- iconURL := s.resolveTemplateIconURL(ctx, compose, mo.PointerToOption(envPtr).OrEmpty())
+ iconURL := projects.ResolveTemplateIconURL(ctx, compose, mo.PointerToOption(envPtr).OrEmpty())
return s.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
var existing ComposeTemplate
@@ -1109,118 +1104,6 @@ func (s *TemplateService) syncFilesystemTemplatesInternal(ctx context.Context) e
return nil
}
-// ParseComposeServices extracts service names from a compose file content using compose-go
-func (s *TemplateService) ParseComposeServices(ctx context.Context, composeContent string) []string {
- if composeContent == "" {
- return []string{}
- }
-
- // Create a temp directory with dummy .env file to satisfy env_file references
- // System temp scratch: no acfs root exists for it.
- tmpDir, err := os.MkdirTemp("", "arcane-compose-parse-*")
- if err != nil {
- slog.WarnContext(ctx, "Failed to create temp dir for compose parsing", "error", err)
- return []string{}
- }
- defer func() { _ = os.RemoveAll(tmpDir) }()
-
- // Create a dummy .env file to prevent env file errors
- envPath := filepath.Join(tmpDir, ".env")
- if err := projects.WriteFileWithPerm(envPath, "", utils.FilePerm); err != nil {
- slog.WarnContext(ctx, "Failed to create dummy env file", "error", err)
- }
-
- // Parse using compose-go
- configDetails := composetypes.ConfigDetails{
- ConfigFiles: []composetypes.ConfigFile{
- {
- Content: []byte(composeContent),
- },
- },
- WorkingDir: tmpDir,
- Environment: composetypes.Mapping{},
- }
-
- project, err := composeloader.LoadWithContext(ctx, configDetails, composeloader.WithSkipValidation)
- if err != nil {
- slog.WarnContext(ctx, "Failed to parse compose services", "error", err)
- return []string{}
- }
-
- serviceNames := make([]string, 0, len(project.Services))
- for _, service := range project.Services {
- serviceNames = append(serviceNames, service.Name)
- }
-
- return serviceNames
-}
-
-func (s *TemplateService) resolveTemplateIconURL(ctx context.Context, composeContent, envContent string) *string {
- if strings.TrimSpace(composeContent) == "" {
- return nil
- }
-
- // System temp scratch: no acfs root exists for it.
- tmpDir, err := os.MkdirTemp("", "arcane-template-icon-*")
- if err != nil {
- slog.WarnContext(ctx, "failed to create temp dir for template icon parsing", "error", err)
- return nil
- }
- defer func() { _ = os.RemoveAll(tmpDir) }()
-
- envPath := filepath.Join(tmpDir, ".env")
- if err := projects.WriteFileWithPerm(envPath, envContent, utils.FilePerm); err != nil {
- slog.WarnContext(ctx, "failed to create temp env file for template icon parsing", "error", err)
- }
-
- envMap := make(composetypes.Mapping)
- for _, variable := range projects.ParseEnvContent(envContent) {
- if key := strings.TrimSpace(variable.Key); key != "" {
- envMap[key] = variable.Value
- }
- }
- envMap["PWD"] = tmpDir
-
- configDetails := composetypes.ConfigDetails{
- ConfigFiles: []composetypes.ConfigFile{
- {
- Content: []byte(composeContent),
- },
- },
- WorkingDir: tmpDir,
- Environment: envMap,
- }
-
- project, err := composeloader.LoadWithContext(ctx, configDetails, composeloader.WithSkipValidation, func(opts *composeloader.Options) {
- opts.SkipConsistencyCheck = true
- })
- if err != nil {
- slog.WarnContext(ctx, "failed to parse compose for template icon metadata", "error", err)
- return nil
- }
-
- if project == nil {
- return nil
- }
-
- arcaneBlock, ok := project.Extensions[templateArcaneBlockKey]
- if !ok {
- return nil
- }
-
- arcaneBlockMap, ok := utils.AsStringMap(arcaneBlock).Get()
- if !ok {
- return nil
- }
-
- icon := utils.FirstNonEmpty(
- utils.FirstNonEmpty(utils.Collect(arcaneBlockMap[templateArcaneIconKey], utils.ToString)...),
- utils.FirstNonEmpty(utils.Collect(arcaneBlockMap[templateArcaneIconsAliasKey], utils.ToString)...),
- )
-
- return mo.EmptyableToOption(strings.TrimSpace(icon)).ToPointer()
-}
-
func setTemplateIconURL(template *ComposeTemplate, iconURL *string) {
if template == nil {
return
@@ -1265,7 +1148,7 @@ func (s *TemplateService) GetTemplateContentWithParsedData(ctx context.Context,
}
}
- setTemplateIconURL(composeTemplate, s.resolveTemplateIconURL(ctx, composeContent, envContent))
+ setTemplateIconURL(composeTemplate, projects.ResolveTemplateIconURL(ctx, composeContent, envContent))
var outTemplate tmpl.Template
if mapErr := mapper.MapStruct(composeTemplate, &outTemplate); mapErr != nil {
@@ -1273,7 +1156,7 @@ func (s *TemplateService) GetTemplateContentWithParsedData(ctx context.Context,
}
// Parse services from compose content using compose-go library
- services := s.ParseComposeServices(ctx, composeContent)
+ services := projects.ParseComposeServices(ctx, composeContent)
// Parse environment variables
parsedEnvVars := projects.ParseEnvContent(envContent)
diff --git a/backend/internal/template/service_test.go b/backend/internal/template/service_test.go
index 0676ab248..fb3a5d2af 100644
--- a/backend/internal/template/service_test.go
+++ b/backend/internal/template/service_test.go
@@ -77,71 +77,6 @@ func makePublicTestClient(t *testing.T, server *httptest.Server) (*http.Client,
return client, lookupIP, baseURL
}
-func TestResolveTemplateIconURL(t *testing.T) {
- service := &TemplateService{}
-
- tests := []struct {
- name string
- compose string
- envContent string
- want string
- }{
- {
- name: "top level icon",
- compose: `x-arcane:
- icon: https://cdn.example/icon.png
-services:
- app:
- image: nginx:alpine
-`,
- want: "https://cdn.example/icon.png",
- },
- {
- name: "icons alias",
- compose: `x-arcane:
- icons: https://cdn.example/alias.png
-services:
- app:
- image: nginx:alpine
-`,
- want: "https://cdn.example/alias.png",
- },
- {
- name: "env interpolation",
- compose: `x-arcane:
- icon: ${TEMPLATE_ICON}
-services:
- app:
- image: nginx:alpine
-`,
- envContent: "TEMPLATE_ICON=https://cdn.example/from-env.png\n",
- want: "https://cdn.example/from-env.png",
- },
- {
- name: "invalid x arcane block",
- compose: `x-arcane: plain-text
-services:
- app:
- image: nginx:alpine
-`,
- want: "",
- },
- }
-
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- iconURL := service.resolveTemplateIconURL(context.Background(), tt.compose, tt.envContent)
- if tt.want == "" {
- require.Nil(t, iconURL)
- return
- }
-
- require.NotNil(t, iconURL)
- require.Equal(t, tt.want, *iconURL)
- })
- }
-}
-
func TestFetchRegistryTemplates_ReusesCachedIconsOnNotModified(t *testing.T) {
var composeHits atomic.Int32
var okComposeURL string
diff --git a/backend/internal/updater/service.go b/backend/internal/updater/service.go
index c6c0a46ed..448b4ffb7 100644
--- a/backend/internal/updater/service.go
+++ b/backend/internal/updater/service.go
@@ -16,7 +16,6 @@ import (
"emperror.dev/errors"
- "github.com/compose-spec/compose-go/v2/loader"
"github.com/getarcaneapp/arcane/backend/v2/internal/activity"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/getarcaneapp/arcane/backend/v2/internal/database"
@@ -1323,7 +1322,7 @@ func activeComposeProjectNameSetInternal(projects []projectpkg.Project) map[stri
continue
}
active[name] = struct{}{}
- if normalized := loader.NormalizeProjectName(name); normalized != "" {
+ if normalized := projectspkg.NormalizeProjectName(name); normalized != "" {
active[normalized] = struct{}{}
}
}
diff --git a/backend/internal/volume/backup.go b/backend/internal/volume/backup.go
index 6a15b9497..f413ac767 100644
--- a/backend/internal/volume/backup.go
+++ b/backend/internal/volume/backup.go
@@ -28,6 +28,7 @@ import (
activitylib "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/activity"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumehelper"
"github.com/getarcaneapp/arcane/backend/v2/pkg/pagination"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/backupbrowser"
activitytypes "github.com/getarcaneapp/arcane/types/v2/activity"
@@ -257,22 +258,7 @@ func (s *VolumeService) startContainersAfterBackupInternal(ctx context.Context,
current, found = currentByName[name]
}
if !found {
- projectName := docker.ComposeProjectLabel(stopped.Labels)
- serviceName := docker.ComposeServiceLabel(stopped.Labels)
- containerNumber := strings.TrimSpace(stopped.Labels["com.docker.compose.container-number"])
- if projectName != "" && serviceName != "" {
- for _, candidate := range currentContainers.Items {
- if docker.ComposeProjectLabel(candidate.Labels) != projectName || docker.ComposeServiceLabel(candidate.Labels) != serviceName {
- continue
- }
- if containerNumber != "" && strings.TrimSpace(candidate.Labels["com.docker.compose.container-number"]) != containerNumber {
- continue
- }
- current = candidate
- found = true
- break
- }
- }
+ current, found = projects.FindComposeReplica(currentContainers.Items, stopped.Labels)
}
if !found {
nextRemaining = append(nextRemaining, stopped)
diff --git a/backend/internal/volume/handler.go b/backend/internal/volume/handler.go
index 327c611df..3f3472829 100644
--- a/backend/internal/volume/handler.go
+++ b/backend/internal/volume/handler.go
@@ -22,7 +22,6 @@ import (
"github.com/getarcaneapp/arcane/backend/v2/internal/upload"
"github.com/getarcaneapp/arcane/backend/v2/pkg/authz"
activitylib "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/activity"
- volumeops "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumes"
"github.com/getarcaneapp/arcane/backend/v2/pkg/pagination"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils/handlerutil"
@@ -709,9 +708,9 @@ func (h *VolumeHandler) RenameVolume(ctx context.Context, input *RenameVolumeInp
return renameErr
})
if err != nil {
- var conflictErr *volumeops.ProjectVolumeRenameConflictError
- var inUseErr *volumeops.ProjectVolumeRenameInUseError
- var spaceErr *volumeops.ProjectVolumeRenameInsufficientSpaceError
+ var conflictErr *volumetypes.ProjectVolumeRenameConflictError
+ var inUseErr *volumetypes.ProjectVolumeRenameInUseError
+ var spaceErr *volumetypes.ProjectVolumeRenameInsufficientSpaceError
switch {
case errors.Is(err, common.ErrBadRequest):
return nil, huma.Error400BadRequest(err.Error())
diff --git a/backend/internal/volume/rename.go b/backend/internal/volume/rename.go
index c077199a6..d44aad415 100644
--- a/backend/internal/volume/rename.go
+++ b/backend/internal/volume/rename.go
@@ -75,9 +75,9 @@ func (s *VolumeService) RenameVolume(ctx context.Context, oldName, newName strin
return nil, combinedErr
}
- if committer, ok := migration.(volumeops.Committer); ok {
+ if committer, ok := migration.(volumetypes.Committer); ok {
if err := committer.Commit(ctx); err != nil {
- var cleanupErr *volumeops.SourceCleanupError
+ var cleanupErr *volumetypes.SourceCleanupError
if errors.As(err, &cleanupErr) {
// The copy and metadata are committed; only removing the source
// failed, so the rename itself succeeded.
diff --git a/backend/pkg/libarcane/swarm/convert_test.go b/backend/pkg/libarcane/swarm/convert_test.go
index 2eb4187b9..95ddd5b5e 100644
--- a/backend/pkg/libarcane/swarm/convert_test.go
+++ b/backend/pkg/libarcane/swarm/convert_test.go
@@ -8,7 +8,7 @@ import (
composegotypes "github.com/compose-spec/compose-go/v2/types"
"github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
- projecttypes "github.com/getarcaneapp/arcane/backend/v2/pkg/projects/types"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
swarmtypes "github.com/getarcaneapp/arcane/types/v2/swarm"
"github.com/moby/moby/api/types/mount"
"github.com/moby/moby/api/types/swarm"
diff --git a/backend/pkg/libarcane/swarm/deploy.go b/backend/pkg/libarcane/swarm/deploy.go
index 3ec6ad3e3..17fd7ebcb 100644
--- a/backend/pkg/libarcane/swarm/deploy.go
+++ b/backend/pkg/libarcane/swarm/deploy.go
@@ -11,7 +11,7 @@ import (
composegotypes "github.com/compose-spec/compose-go/v2/types"
"github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
- projecttypes "github.com/getarcaneapp/arcane/backend/v2/pkg/projects/types"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
swarmtypes "github.com/getarcaneapp/arcane/types/v2/swarm"
"github.com/moby/moby/api/types/swarm"
dockerclient "github.com/moby/moby/client"
diff --git a/backend/pkg/libarcane/swarm/load_test.go b/backend/pkg/libarcane/swarm/load_test.go
index 15edf827e..05c646bb5 100644
--- a/backend/pkg/libarcane/swarm/load_test.go
+++ b/backend/pkg/libarcane/swarm/load_test.go
@@ -5,7 +5,7 @@ import (
"testing"
"github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
- projecttypes "github.com/getarcaneapp/arcane/backend/v2/pkg/projects/types"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
"github.com/stretchr/testify/require"
)
diff --git a/backend/pkg/libarcane/swarm/render.go b/backend/pkg/libarcane/swarm/render.go
index 775e8bce3..190584bf5 100644
--- a/backend/pkg/libarcane/swarm/render.go
+++ b/backend/pkg/libarcane/swarm/render.go
@@ -9,7 +9,7 @@ import (
"emperror.dev/errors"
"github.com/getarcaneapp/arcane/backend/v2/pkg/projects"
- projecttypes "github.com/getarcaneapp/arcane/backend/v2/pkg/projects/types"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
)
type StackRenderOptions struct {
diff --git a/backend/pkg/libarcane/volumes/compose.go b/backend/pkg/libarcane/volumes/compose.go
deleted file mode 100644
index a40dc02d6..000000000
--- a/backend/pkg/libarcane/volumes/compose.go
+++ /dev/null
@@ -1,75 +0,0 @@
-package volumes
-
-import (
- "os"
- "strings"
-
- "emperror.dev/errors"
-
- composetemplate "github.com/compose-spec/compose-go/v2/template"
- "go.yaml.in/yaml/v4"
-)
-
-func composeVolumeKeysWithExplicitNameInternal(composeFiles []string) (map[string]struct{}, error) {
- explicit := make(map[string]struct{})
- for _, composeFile := range composeFiles {
- composeFile = strings.TrimSpace(composeFile)
- if composeFile == "" {
- continue
- }
- keys, err := composeVolumeKeysWithExplicitNameInFileInternal(composeFile)
- if err != nil {
- return nil, err
- }
- for key := range keys {
- explicit[key] = struct{}{}
- }
- }
- return explicit, nil
-}
-
-func composeVolumeKeysWithExplicitNameInFileInternal(path string) (map[string]struct{}, error) {
- // os.* rather than acfs: compose config files may live outside the project
- // directory (e.g. via include), so no single confinement root covers them.
- content, err := os.ReadFile(path)
- if err != nil {
- return nil, errors.WrapIf(err, "read compose file")
- }
-
- composeData := map[string]any{}
- if err := yaml.Unmarshal(content, &composeData); err != nil {
- return nil, errors.WrapIf(err, "parse compose file")
- }
-
- rawVolumes, ok := composeData["volumes"]
- if !ok || rawVolumes == nil {
- return map[string]struct{}{}, nil
- }
-
- volumes, ok := rawVolumes.(map[string]any)
- if !ok {
- return nil, errors.New("parse compose file: volumes must be a mapping")
- }
-
- explicit := make(map[string]struct{})
- for key, rawVolume := range volumes {
- key = strings.TrimSpace(key)
- if key == "" {
- continue
- }
- volumeConfig, ok := rawVolume.(map[string]any)
- if !ok {
- continue
- }
- rawName, hasName := volumeConfig["name"]
- if !hasName {
- continue
- }
- name, ok := rawName.(string)
- if ok && len(composetemplate.ExtractVariables(map[string]any{"name": name}, nil)) == 0 {
- explicit[key] = struct{}{}
- }
- }
-
- return explicit, nil
-}
diff --git a/backend/pkg/libarcane/volumes/compose_test.go b/backend/pkg/libarcane/volumes/compose_test.go
deleted file mode 100644
index d5f2049d1..000000000
--- a/backend/pkg/libarcane/volumes/compose_test.go
+++ /dev/null
@@ -1,74 +0,0 @@
-package volumes
-
-import (
- "os"
- "path/filepath"
- "testing"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestComposeVolumeKeysWithExplicitNameInternal(t *testing.T) {
- projectPath := t.TempDir()
- rootCompose := filepath.Join(projectPath, "compose.yaml")
- includeCompose := filepath.Join(projectPath, "included.yaml")
-
- require.NoError(t, os.WriteFile(rootCompose, []byte(`
-services:
- app:
- image: nginx:alpine
- volumes:
- - data:/data
- - fixed:/fixed
- - env_named:/env
- - env_default:/env-default
- - env_unbraced:/env-unbraced
- - escaped:/escaped
- - scalar:/scalar
- - null_named:/null
- - numeric_named:/numeric
-volumes:
- data:
- driver: local
- fixed:
- name: app-data
- env_named:
- name: ${APP_VOLUME}
- env_default:
- name: ${APP_VOLUME:-app-data}
- env_unbraced:
- name: $APP_VOLUME
- escaped:
- name: $${APP_VOLUME}
- scalar:
- null_named:
- name: null
- numeric_named:
- name: 123
- inline: {}
-`), 0o644))
- require.NoError(t, os.WriteFile(includeCompose, []byte(`
-volumes:
- included:
- name: included-fixed
- included_implicit:
- driver: local
-`), 0o644))
-
- explicit, err := composeVolumeKeysWithExplicitNameInternal([]string{rootCompose, includeCompose})
- require.NoError(t, err)
-
- assert.Contains(t, explicit, "fixed")
- assert.Contains(t, explicit, "escaped")
- assert.Contains(t, explicit, "included")
- assert.NotContains(t, explicit, "data")
- assert.NotContains(t, explicit, "env_named")
- assert.NotContains(t, explicit, "env_default")
- assert.NotContains(t, explicit, "env_unbraced")
- assert.NotContains(t, explicit, "scalar")
- assert.NotContains(t, explicit, "null_named")
- assert.NotContains(t, explicit, "numeric_named")
- assert.NotContains(t, explicit, "inline")
- assert.NotContains(t, explicit, "included_implicit")
-}
diff --git a/backend/pkg/libarcane/volumes/volume_rename.go b/backend/pkg/libarcane/volumes/volume_rename.go
index 93f655e18..106906d13 100644
--- a/backend/pkg/libarcane/volumes/volume_rename.go
+++ b/backend/pkg/libarcane/volumes/volume_rename.go
@@ -3,7 +3,6 @@ package volumes
import (
"context"
stderrors "errors"
- "fmt"
"log/slog"
"maps"
"slices"
@@ -12,59 +11,25 @@ import (
"time"
"emperror.dev/errors"
- composetypes "github.com/compose-spec/compose-go/v2/types"
cerrdefs "github.com/containerd/errdefs"
- "github.com/docker/compose/v5/pkg/api"
- composepkg "github.com/docker/compose/v5/pkg/compose"
dockerutil "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumehelper"
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
"github.com/moby/moby/api/types/container"
- "github.com/moby/moby/api/types/volume"
"github.com/moby/moby/client"
)
-type Migration interface {
- Apply(ctx context.Context) error
- Rollback(ctx context.Context) error
-}
-
-type Committer interface {
- Commit(ctx context.Context) error
-}
-
-type JournalSource interface {
- JournalVolumes() []JournalVolume
-}
-
-type projectVolumeRenameEntryInternal struct {
- Key string
- OldName string
- NewName string
- OldVolume volume.Volume
- NewConfig composetypes.VolumeConfig
- CreateOptions client.VolumeCreateOptions
-}
-
type dockerProjectVolumeRenameMigrationInternal struct {
dockerClient *client.Client
- entries []projectVolumeRenameEntryInternal
- createdNew []projectVolumeRenameEntryInternal
- removedOld []projectVolumeRenameEntryInternal
+ entries []volumetypes.RenameEntry
+ createdNew []volumetypes.RenameEntry
+ removedOld []volumetypes.RenameEntry
oldComposeName string
newComposeName string
toolsImage string
}
-type JournalVolume struct {
- Key string `json:"key"`
- OldName string `json:"oldName"`
- NewName string `json:"newName"`
- Driver string `json:"driver,omitempty"`
- Options map[string]string `json:"options,omitempty"`
- Labels map[string]string `json:"labels,omitempty"`
-}
-
type projectVolumeCopyRuntimeInternal struct {
Image string
}
@@ -73,42 +38,16 @@ const (
projectVolumeCopyMountPathInternal = "/volume"
)
-func PlanMigration(ctx context.Context, dockerClient *client.Client, composeProject *composetypes.Project, oldComposeName, newComposeName string, toolsImage string) (Migration, error) {
- if dockerClient == nil {
- return nil, errors.New("docker service unavailable")
- }
- if composeProject == nil || len(composeProject.Volumes) == 0 {
- return nil, nil
- }
- if strings.TrimSpace(oldComposeName) == "" || strings.TrimSpace(newComposeName) == "" || oldComposeName == newComposeName {
- return nil, nil
- }
-
- explicitVolumeNames, err := composeVolumeKeysWithExplicitNameInternal(composeProject.ComposeFiles)
- if err != nil {
- return nil, errors.WrapIf(err, "failed to parse compose volume names")
- }
-
- entries, err := collectProjectRenameVolumeEntriesInternal(ctx, dockerClient, composeProject.Volumes, explicitVolumeNames, oldComposeName, newComposeName)
- if err != nil {
- return nil, err
- }
-
+// NewMigration prepares generic volume copies with caller-supplied target configuration.
+func NewMigration(dockerClient *client.Client, entries []volumetypes.RenameEntry, oldProject, newProject, toolsImage string) volumetypes.Migration {
if len(entries) == 0 {
- return nil, nil
+ return nil
}
-
- return &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: dockerClient,
- entries: entries,
- oldComposeName: oldComposeName,
- newComposeName: newComposeName,
- toolsImage: toolsImage,
- }, nil
+ return &dockerProjectVolumeRenameMigrationInternal{dockerClient: dockerClient, entries: entries, oldComposeName: oldProject, newComposeName: newProject, toolsImage: toolsImage}
}
// PlanRename validates and prepares an unused Docker volume for a copy-based rename.
-func PlanRename(ctx context.Context, dockerClient *client.Client, oldName, newName string, toolsImage string) (Migration, error) {
+func PlanRename(ctx context.Context, dockerClient *client.Client, oldName, newName string, toolsImage string) (volumetypes.Migration, error) {
if dockerClient == nil {
return nil, errors.New("docker service unavailable")
}
@@ -126,14 +65,14 @@ func PlanRename(ctx context.Context, dockerClient *client.Client, oldName, newNa
if err != nil {
return nil, errors.WrapIff(err, "inspect source volume %s", oldName)
}
- if err := ensureProjectRenameSourceVolumeDetachedInternal(ctx, dockerClient, oldName); err != nil {
+ if err := EnsureRenameSourceDetached(ctx, dockerClient, oldName); err != nil {
return nil, err
}
- if err := ensureProjectRenameTargetVolumeAbsentInternal(ctx, dockerClient, newName); err != nil {
+ if err := EnsureRenameTargetAbsent(ctx, dockerClient, newName); err != nil {
return nil, err
}
- entry := projectVolumeRenameEntryInternal{
+ entry := volumetypes.RenameEntry{
OldName: oldName,
NewName: newName,
OldVolume: oldVolume.Volume,
@@ -145,60 +84,7 @@ func PlanRename(ctx context.Context, dockerClient *client.Client, oldName, newNa
},
}
- return &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: dockerClient,
- entries: []projectVolumeRenameEntryInternal{entry},
- toolsImage: toolsImage,
- }, nil
-}
-
-func collectProjectRenameVolumeEntriesInternal(ctx context.Context, dockerClient *client.Client, volumes map[string]composetypes.VolumeConfig, explicitVolumeNames map[string]struct{}, oldComposeName, newComposeName string) ([]projectVolumeRenameEntryInternal, error) {
- entries := make([]projectVolumeRenameEntryInternal, 0, len(volumes))
- for key, volumeConfig := range volumes {
- entry, ok, err := inspectProjectRenameVolumeEntryInternal(ctx, dockerClient, key, volumeConfig, explicitVolumeNames, oldComposeName, newComposeName)
- if err != nil {
- return nil, err
- }
- if ok {
- entries = append(entries, entry)
- }
- }
- return entries, nil
-}
-
-func inspectProjectRenameVolumeEntryInternal(ctx context.Context, dockerClient *client.Client, key string, volumeConfig composetypes.VolumeConfig, explicitVolumeNames map[string]struct{}, oldComposeName, newComposeName string) (projectVolumeRenameEntryInternal, bool, error) {
- if _, explicit := explicitVolumeNames[key]; explicit || bool(volumeConfig.External) {
- return projectVolumeRenameEntryInternal{}, false, nil
- }
-
- oldName := oldComposeName + "_" + key
- newName := newComposeName + "_" + key
- if oldName == newName || (volumeConfig.Name != oldName && volumeConfig.Name != newName) {
- return projectVolumeRenameEntryInternal{}, false, nil
- }
-
- if err := ensureProjectRenameTargetVolumeAbsentInternal(ctx, dockerClient, newName); err != nil {
- return projectVolumeRenameEntryInternal{}, false, err
- }
-
- oldVolume, err := dockerClient.VolumeInspect(ctx, oldName, client.VolumeInspectOptions{})
- if err != nil {
- if cerrdefs.IsNotFound(err) {
- return projectVolumeRenameEntryInternal{}, false, nil
- }
- return projectVolumeRenameEntryInternal{}, false, errors.WrapIff(err, "inspect source volume %s", oldName)
- }
- if err := ensureProjectRenameSourceVolumeDetachedInternal(ctx, dockerClient, oldName); err != nil {
- return projectVolumeRenameEntryInternal{}, false, err
- }
-
- return projectVolumeRenameEntryInternal{
- Key: key,
- OldName: oldName,
- NewName: newName,
- OldVolume: oldVolume.Volume,
- NewConfig: buildProjectRenamedVolumeConfigInternal(volumeConfig, key, newName, newComposeName),
- }, true, nil
+ return NewMigration(dockerClient, []volumetypes.RenameEntry{entry}, "", "", toolsImage), nil
}
func (m *dockerProjectVolumeRenameMigrationInternal) Apply(ctx context.Context) error {
@@ -218,13 +104,13 @@ func (m *dockerProjectVolumeRenameMigrationInternal) Apply(ctx context.Context)
for _, entry := range m.entries {
if err := createProjectRenamedVolumeInternal(ctx, dockerClient, entry); err != nil {
- return stderrors.Join(err, m.rollbackCreatedTargets(ctx, dockerClient))
+ return stderrors.Join(err, m.rollbackCreatedTargetsInternal(ctx, dockerClient))
}
m.createdNew = append(m.createdNew, entry)
if err := copyProjectVolumeDataInternal(ctx, dockerClient, copyRuntime, entry.OldName, entry.NewName); err != nil {
return stderrors.Join(errors.
- WrapIff(err, "copy volume data from %s to %s", entry.OldName, entry.NewName), m.rollbackCreatedTargets(ctx, dockerClient),
+ WrapIff(err, "copy volume data from %s to %s", entry.OldName, entry.NewName), m.rollbackCreatedTargetsInternal(ctx, dockerClient),
)
}
}
@@ -260,14 +146,14 @@ func (m *dockerProjectVolumeRenameMigrationInternal) Commit(ctx context.Context)
return nil
}
-func (m *dockerProjectVolumeRenameMigrationInternal) JournalVolumes() []JournalVolume {
+func (m *dockerProjectVolumeRenameMigrationInternal) JournalVolumes() []volumetypes.JournalVolume {
if m == nil || len(m.entries) == 0 {
return nil
}
- volumes := make([]JournalVolume, 0, len(m.entries))
+ volumes := make([]volumetypes.JournalVolume, 0, len(m.entries))
for _, entry := range m.entries {
- volumes = append(volumes, JournalVolume{
+ volumes = append(volumes, volumetypes.JournalVolume{
Key: entry.Key,
OldName: entry.OldName,
NewName: entry.NewName,
@@ -293,7 +179,7 @@ func (m *dockerProjectVolumeRenameMigrationInternal) Rollback(ctx context.Contex
continue
}
preservedTargets[entry.NewName] = struct{}{}
- rollbackErr = stderrors.Join(rollbackErr, NewTargetPreservedDuringRollbackError(JournalVolume{
+ rollbackErr = stderrors.Join(rollbackErr, NewTargetPreservedDuringRollbackError(volumetypes.JournalVolume{
OldName: entry.OldName,
NewName: entry.NewName,
}, errors.New("source volume was already removed")))
@@ -306,7 +192,7 @@ func (m *dockerProjectVolumeRenameMigrationInternal) Rollback(ctx context.Contex
sourceExists, err := VolumeExists(ctx, dockerClient, entry.OldName)
if err != nil {
preservedTargets[entry.NewName] = struct{}{}
- rollbackErr = stderrors.Join(rollbackErr, NewTargetPreservedDuringRollbackError(JournalVolume{
+ rollbackErr = stderrors.Join(rollbackErr, NewTargetPreservedDuringRollbackError(volumetypes.JournalVolume{
OldName: entry.OldName,
NewName: entry.NewName,
}, errors.WrapIff(err, "inspect source rollback volume %s", entry.OldName)))
@@ -319,7 +205,7 @@ func (m *dockerProjectVolumeRenameMigrationInternal) Rollback(ctx context.Contex
targetExists, err := VolumeExists(ctx, dockerClient, entry.NewName)
if err != nil {
preservedTargets[entry.NewName] = struct{}{}
- rollbackErr = stderrors.Join(rollbackErr, NewTargetPreservedDuringRollbackError(JournalVolume{
+ rollbackErr = stderrors.Join(rollbackErr, NewTargetPreservedDuringRollbackError(volumetypes.JournalVolume{
OldName: entry.OldName,
NewName: entry.NewName,
}, errors.WrapIff(err, "inspect target rollback volume %s", entry.NewName)))
@@ -327,7 +213,7 @@ func (m *dockerProjectVolumeRenameMigrationInternal) Rollback(ctx context.Contex
}
if targetExists {
preservedTargets[entry.NewName] = struct{}{}
- rollbackErr = stderrors.Join(rollbackErr, NewTargetPreservedDuringRollbackError(JournalVolume{
+ rollbackErr = stderrors.Join(rollbackErr, NewTargetPreservedDuringRollbackError(volumetypes.JournalVolume{
OldName: entry.OldName,
NewName: entry.NewName,
}, errProjectRenameRollbackSourceMissingInternal))
@@ -336,20 +222,20 @@ func (m *dockerProjectVolumeRenameMigrationInternal) Rollback(ctx context.Contex
}
}
- rollbackErr = stderrors.Join(rollbackErr, m.rollbackCreatedTargetsPreserving(ctx, dockerClient, preservedTargets))
+ rollbackErr = stderrors.Join(rollbackErr, m.rollbackCreatedTargetsPreservingInternal(ctx, dockerClient, preservedTargets))
if rollbackErr == nil {
dockerutil.InvalidateVolumeUsageCache(dockerClient)
}
return rollbackErr
}
-func (m *dockerProjectVolumeRenameMigrationInternal) rollbackCreatedTargets(ctx context.Context, dockerClient *client.Client) error {
- return m.rollbackCreatedTargetsPreserving(ctx, dockerClient, nil)
+func (m *dockerProjectVolumeRenameMigrationInternal) rollbackCreatedTargetsInternal(ctx context.Context, dockerClient *client.Client) error {
+ return m.rollbackCreatedTargetsPreservingInternal(ctx, dockerClient, nil)
}
-func (m *dockerProjectVolumeRenameMigrationInternal) rollbackCreatedTargetsPreserving(ctx context.Context, dockerClient *client.Client, preservedTargets map[string]struct{}) error {
+func (m *dockerProjectVolumeRenameMigrationInternal) rollbackCreatedTargetsPreservingInternal(ctx context.Context, dockerClient *client.Client, preservedTargets map[string]struct{}) error {
var rollbackErr error
- remainingCreated := make([]projectVolumeRenameEntryInternal, 0, len(preservedTargets))
+ remainingCreated := make([]volumetypes.RenameEntry, 0, len(preservedTargets))
for _, entry := range slices.Backward(m.createdNew) {
if _, preserve := preservedTargets[entry.NewName]; preserve {
remainingCreated = append(remainingCreated, entry)
@@ -370,18 +256,7 @@ func (m *dockerProjectVolumeRenameMigrationInternal) rollbackCreatedTargetsPrese
return rollbackErr
}
-func buildProjectRenamedVolumeConfigInternal(volumeConfig composetypes.VolumeConfig, key, newName, newComposeName string) composetypes.VolumeConfig {
- newConfig := volumeConfig
- newConfig.Name = newName
- newConfig.CustomLabels = composetypes.Labels{
- api.VolumeLabel: key,
- api.ProjectLabel: newComposeName,
- api.VersionLabel: api.ComposeVersion,
- }
- return newConfig
-}
-
-func ensureProjectRenameTargetVolumeAbsentInternal(ctx context.Context, dockerClient *client.Client, newName string) error {
+func EnsureRenameTargetAbsent(ctx context.Context, dockerClient *client.Client, newName string) error {
_, err := dockerClient.VolumeInspect(ctx, newName, client.VolumeInspectOptions{})
if err != nil {
if cerrdefs.IsNotFound(err) {
@@ -389,46 +264,22 @@ func ensureProjectRenameTargetVolumeAbsentInternal(ctx context.Context, dockerCl
}
return errors.WrapIff(err, "inspect target volume %s", newName)
}
- return &ProjectVolumeRenameConflictError{VolumeName: newName}
+ return &volumetypes.ProjectVolumeRenameConflictError{VolumeName: newName}
}
-func ensureProjectRenameSourceVolumeDetachedInternal(ctx context.Context, dockerClient *client.Client, oldName string) error {
+func EnsureRenameSourceDetached(ctx context.Context, dockerClient *client.Client, oldName string) error {
containerIDs, err := dockerutil.GetContainersUsingVolume(ctx, dockerClient, oldName)
if err != nil {
return errors.WrapIff(err, "inspect containers using source volume %s", oldName)
}
if len(containerIDs) > 0 {
- return &ProjectVolumeRenameInUseError{VolumeName: oldName, ContainerIDs: containerIDs}
+ return &volumetypes.ProjectVolumeRenameInUseError{VolumeName: oldName, ContainerIDs: containerIDs}
}
return nil
}
-func createProjectRenamedVolumeInternal(ctx context.Context, dockerClient *client.Client, entry projectVolumeRenameEntryInternal) error {
- if strings.TrimSpace(entry.CreateOptions.Name) != "" {
- if _, err := dockerClient.VolumeCreate(ctx, entry.CreateOptions); err != nil {
- return errors.WrapIff(err, "create target volume %s", entry.NewName)
- }
- return nil
- }
-
- labels := map[string]string{}
- maps.Copy(labels, entry.OldVolume.Labels)
- maps.Copy(labels, entry.NewConfig.Labels)
- maps.Copy(labels, entry.NewConfig.CustomLabels)
-
- hash, err := composepkg.VolumeHash(entry.NewConfig)
- if err != nil {
- return errors.WrapIff(err, "hash target volume %s", entry.NewName)
- }
- labels[api.ConfigHashLabel] = hash
-
- _, err = dockerClient.VolumeCreate(ctx, client.VolumeCreateOptions{
- Name: entry.NewName,
- Driver: entry.NewConfig.Driver,
- DriverOpts: entry.NewConfig.DriverOpts,
- Labels: labels,
- })
- if err != nil {
+func createProjectRenamedVolumeInternal(ctx context.Context, dockerClient *client.Client, entry volumetypes.RenameEntry) error {
+ if _, err := dockerClient.VolumeCreate(ctx, entry.CreateOptions); err != nil {
return errors.WrapIff(err, "create target volume %s", entry.NewName)
}
return nil
@@ -518,7 +369,7 @@ func copyProjectVolumeDataInternal(ctx context.Context, dockerClient *client.Cli
})
if err != nil {
if isProjectVolumeCopyNoSpaceErrorInternal(err) {
- return &ProjectVolumeRenameInsufficientSpaceError{
+ return &volumetypes.ProjectVolumeRenameInsufficientSpaceError{
SourceVolume: sourceVolume,
TargetVolume: targetVolume,
Detail: err.Error(),
@@ -590,7 +441,7 @@ func isProjectVolumeCopyNoSpaceErrorInternal(err error) bool {
return strings.Contains(strings.ToLower(err.Error()), "no space left on device")
}
-func EnsureTargetsReadyForCleanup(ctx context.Context, dockerClient *client.Client, volumes []JournalVolume) error {
+func EnsureTargetsReadyForCleanup(ctx context.Context, dockerClient *client.Client, volumes []volumetypes.JournalVolume) error {
if len(volumes) == 0 {
return nil
}
@@ -598,8 +449,8 @@ func EnsureTargetsReadyForCleanup(ctx context.Context, dockerClient *client.Clie
return errors.New("docker service unavailable")
}
- var missingWithSource *TargetMissingWithSourceError
- var externallyRemoved []JournalVolume
+ var missingWithSource *volumetypes.TargetMissingWithSourceError
+ var externallyRemoved []volumetypes.JournalVolume
for _, vol := range volumes {
targetExists, err := VolumeExists(ctx, dockerClient, vol.NewName)
if err != nil {
@@ -615,7 +466,7 @@ func EnsureTargetsReadyForCleanup(ctx context.Context, dockerClient *client.Clie
}
if sourceExists {
if missingWithSource == nil {
- missingWithSource = &TargetMissingWithSourceError{
+ missingWithSource = &volumetypes.TargetMissingWithSourceError{
SourceVolume: vol.OldName,
TargetVolume: vol.NewName,
}
@@ -628,12 +479,12 @@ func EnsureTargetsReadyForCleanup(ctx context.Context, dockerClient *client.Clie
return missingWithSource
}
if len(externallyRemoved) > 0 {
- return &VolumesExternallyRemovedError{Volumes: externallyRemoved}
+ return &volumetypes.VolumesExternallyRemovedError{Volumes: externallyRemoved}
}
return nil
}
-func RemoveSourceVolumes(ctx context.Context, dockerClient *client.Client, volumes []JournalVolume) error {
+func RemoveSourceVolumes(ctx context.Context, dockerClient *client.Client, volumes []volumetypes.JournalVolume) error {
for _, vol := range volumes {
if err := removeProjectVolumeWithRetryInternal(ctx, dockerClient, vol.OldName, client.VolumeRemoveOptions{Force: false}); err != nil {
return NewSourceCleanupError(vol.OldName, err)
@@ -643,7 +494,7 @@ func RemoveSourceVolumes(ctx context.Context, dockerClient *client.Client, volum
return nil
}
-func RollbackVolumes(ctx context.Context, dockerClient *client.Client, volumes []JournalVolume) error {
+func RollbackVolumes(ctx context.Context, dockerClient *client.Client, volumes []volumetypes.JournalVolume) error {
var rollbackErr error
for _, vol := range slices.Backward(volumes) {
if err := RollbackVolume(ctx, dockerClient, vol); err != nil {
@@ -656,7 +507,7 @@ func RollbackVolumes(ctx context.Context, dockerClient *client.Client, volumes [
return rollbackErr
}
-func RollbackVolume(ctx context.Context, dockerClient *client.Client, vol JournalVolume) error {
+func RollbackVolume(ctx context.Context, dockerClient *client.Client, vol volumetypes.JournalVolume) error {
oldExists, err := VolumeExists(ctx, dockerClient, vol.OldName)
if err != nil {
return NewTargetPreservedDuringRollbackError(vol, errors.WrapIff(err, "inspect source rollback volume %s", vol.OldName))
@@ -677,7 +528,7 @@ func RollbackVolume(ctx context.Context, dockerClient *client.Client, vol Journa
return nil
}
-func CleanupRollbackTargetVolumes(ctx context.Context, dockerClient *client.Client, volumes []JournalVolume) error {
+func CleanupRollbackTargetVolumes(ctx context.Context, dockerClient *client.Client, volumes []volumetypes.JournalVolume) error {
var cleanupErr error
for _, vol := range slices.Backward(volumes) {
if err := cleanupProjectRenameRollbackTargetVolumeInternal(ctx, dockerClient, vol); err != nil {
@@ -687,7 +538,7 @@ func CleanupRollbackTargetVolumes(ctx context.Context, dockerClient *client.Clie
return cleanupErr
}
-func cleanupProjectRenameRollbackTargetVolumeInternal(ctx context.Context, dockerClient *client.Client, vol JournalVolume) error {
+func cleanupProjectRenameRollbackTargetVolumeInternal(ctx context.Context, dockerClient *client.Client, vol volumetypes.JournalVolume) error {
oldExists, err := VolumeExists(ctx, dockerClient, vol.OldName)
if err != nil {
return errors.WrapIff(err, "inspect source cleanup volume %s", vol.OldName)
@@ -733,111 +584,23 @@ func VolumeExists(ctx context.Context, dockerClient *client.Client, name string)
return false, errors.WrapIff(err, "inspect volume %s", name)
}
-type ProjectVolumeRenameConflictError struct {
- VolumeName string
-}
-
-func (e *ProjectVolumeRenameConflictError) Error() string {
- if strings.TrimSpace(e.VolumeName) == "" {
- return "target volume already exists"
- }
- return "target volume already exists: " + e.VolumeName
-}
-
-type ProjectVolumeRenameInUseError struct {
- VolumeName string
- ContainerIDs []string
-}
-
-func (e *ProjectVolumeRenameInUseError) Error() string {
- if strings.TrimSpace(e.VolumeName) == "" {
- return "source volume is still attached to containers"
- }
- if len(e.ContainerIDs) == 0 {
- return "source volume is still attached to containers: " + e.VolumeName
- }
- return fmt.Sprintf("source volume is still attached to %d container(s): %s", len(e.ContainerIDs), e.VolumeName)
-}
-
-type ProjectVolumeRenameInsufficientSpaceError struct {
- SourceVolume string
- TargetVolume string
- Detail string
-}
-
-func (e *ProjectVolumeRenameInsufficientSpaceError) Error() string {
- msg := "insufficient disk space to rename project volume"
- if e.SourceVolume != "" && e.TargetVolume != "" {
- msg = fmt.Sprintf("insufficient disk space to copy volume %s to %s", e.SourceVolume, e.TargetVolume)
- }
- if strings.TrimSpace(e.Detail) != "" {
- msg += ": " + strings.TrimSpace(e.Detail)
- }
- return msg
-}
-
-type TargetMissingWithSourceError struct {
- SourceVolume string
- TargetVolume string
-}
-
-func (e *TargetMissingWithSourceError) Error() string {
- return fmt.Sprintf("committed project rename target volume %s is missing while source volume %s still exists", e.TargetVolume, e.SourceVolume)
-}
-
-type SourceCleanupError struct {
- SourceVolume string
- Err error
-}
-
func NewSourceCleanupError(sourceVolume string, err error) error {
- return &SourceCleanupError{
+ return &volumetypes.SourceCleanupError{
SourceVolume: sourceVolume,
Err: err,
}
}
-func (e *SourceCleanupError) Error() string {
- if e == nil {
- return "clean up committed project rename source volume"
- }
- if strings.TrimSpace(e.SourceVolume) == "" {
- return fmt.Sprintf("clean up committed project rename source volume: %v", e.Err)
- }
- return fmt.Sprintf("clean up committed project rename source volume %s: %v", e.SourceVolume, e.Err)
-}
-
-func (e *SourceCleanupError) Unwrap() error {
- if e == nil {
- return nil
- }
- return e.Err
-}
-
-type TargetPreservedDuringRollbackError struct {
- SourceVolume string
- TargetVolume string
- Err error
-}
-
var errProjectRenameRollbackSourceMissingInternal = errors.New("source volume is missing and target volume may contain the only remaining data copy")
-func NewTargetPreservedDuringRollbackError(vol JournalVolume, err error) error {
- return &TargetPreservedDuringRollbackError{
+func NewTargetPreservedDuringRollbackError(vol volumetypes.JournalVolume, err error) error {
+ return &volumetypes.TargetPreservedDuringRollbackError{
SourceVolume: vol.OldName,
TargetVolume: vol.NewName,
Err: err,
}
}
-func (e *TargetPreservedDuringRollbackError) Error() string {
- return fmt.Sprintf("preserved project rename target volume %s during rollback to avoid data loss; source volume %s was not safe to rely on: %v", e.TargetVolume, e.SourceVolume, e.Err)
-}
-
-func (e *TargetPreservedDuringRollbackError) Unwrap() error {
- return e.Err
-}
-
func OnlyPreservedTargetErrors(err error) bool {
if err == nil {
return false
@@ -855,25 +618,10 @@ func OnlyPreservedTargetErrors(err error) bool {
return true
}
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
return errors.As(err, &preserved)
}
-type VolumesExternallyRemovedError struct {
- Volumes []JournalVolume
-}
-
-func (e *VolumesExternallyRemovedError) Error() string {
- if e == nil || len(e.Volumes) == 0 {
- return "committed project rename source and target volumes are both missing"
- }
- if len(e.Volumes) == 1 {
- vol := e.Volumes[0]
- return fmt.Sprintf("committed project rename target volume %s is missing and source volume %s is also missing", vol.NewName, vol.OldName)
- }
- return fmt.Sprintf("committed project rename source and target volumes are both missing for %d volume pairs", len(e.Volumes))
-}
-
func cloneStringMapInternal(values map[string]string) map[string]string {
if len(values) == 0 {
return nil
diff --git a/backend/pkg/libarcane/volumes/volume_rename_followup_test.go b/backend/pkg/libarcane/volumes/volume_rename_followup_test.go
index 7e2601c16..ffb9e1ccf 100644
--- a/backend/pkg/libarcane/volumes/volume_rename_followup_test.go
+++ b/backend/pkg/libarcane/volumes/volume_rename_followup_test.go
@@ -9,6 +9,8 @@ import (
"sync/atomic"
"testing"
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
+
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -35,8 +37,8 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackExplainsPreservedTar
t.Cleanup(server.Close)
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
- createdNew: []projectVolumeRenameEntryInternal{
+ dockerClient: newTestDockerClientInternal(t, server),
+ createdNew: []volumetypes.RenameEntry{
{OldName: "nginx_data", NewName: "web_data"},
},
}
@@ -44,7 +46,7 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackExplainsPreservedTar
err := migration.Rollback(context.Background())
require.Error(t, err)
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
require.ErrorAs(t, err, &preserved)
require.Contains(t, err.Error(), "avoid data loss")
require.Contains(t, err.Error(), "only remaining data copy")
@@ -67,13 +69,13 @@ func TestRollbackVolume_ExplainsPreservedTargetWhenSourceMissing(t *testing.T) {
}))
t.Cleanup(server.Close)
- err := RollbackVolume(context.Background(), newTestDockerClient(t, server), JournalVolume{
+ err := RollbackVolume(context.Background(), newTestDockerClientInternal(t, server), volumetypes.JournalVolume{
OldName: "nginx_data",
NewName: "web_data",
})
require.Error(t, err)
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
require.ErrorAs(t, err, &preserved)
require.Contains(t, err.Error(), "avoid data loss")
require.Contains(t, err.Error(), "only remaining data copy")
diff --git a/backend/pkg/libarcane/volumes/volume_rename_runtime_test.go b/backend/pkg/libarcane/volumes/volume_rename_runtime_test.go
index 2eff6052c..d0b5eef3c 100644
--- a/backend/pkg/libarcane/volumes/volume_rename_runtime_test.go
+++ b/backend/pkg/libarcane/volumes/volume_rename_runtime_test.go
@@ -27,7 +27,7 @@ func TestGetProjectVolumeCopyRuntimeInternal_UsesToolsImageWhenAvailable(t *test
}))
t.Cleanup(server.Close)
- copyRuntime, err := getProjectVolumeCopyRuntimeInternal(context.Background(), newTestDockerClient(t, server), volumehelper.ToolsImage(""))
+ copyRuntime, err := getProjectVolumeCopyRuntimeInternal(context.Background(), newTestDockerClientInternal(t, server), volumehelper.ToolsImage(""))
require.NoError(t, err)
require.Equal(t, volumehelper.ToolsImage(""), copyRuntime.Image)
@@ -58,7 +58,7 @@ func TestCreateProjectVolumeCopyHolderContainerInternal_UsesPassiveHolderCommand
_, cleanup, err := createProjectVolumeCopyHolderContainerInternal(
context.Background(),
- newTestDockerClient(t, server),
+ newTestDockerClientInternal(t, server),
projectVolumeCopyRuntimeInternal{Image: "arcane:local"},
"nginx_data",
true,
diff --git a/backend/pkg/libarcane/volumes/volume_rename_safety_test.go b/backend/pkg/libarcane/volumes/volume_rename_safety_test.go
index 68a4df063..f5cc61350 100644
--- a/backend/pkg/libarcane/volumes/volume_rename_safety_test.go
+++ b/backend/pkg/libarcane/volumes/volume_rename_safety_test.go
@@ -11,6 +11,8 @@ import (
"syscall"
"testing"
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
+
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumehelper"
"github.com/moby/moby/api/types/container"
"github.com/moby/moby/api/types/mount"
@@ -39,11 +41,11 @@ func TestEnsureProjectRenameTargetVolumeAbsentInternal_ReturnsConflictWhenTarget
}))
t.Cleanup(server.Close)
- dockerClient := newTestDockerClient(t, server)
+ dockerClient := newTestDockerClientInternal(t, server)
- err := ensureProjectRenameTargetVolumeAbsentInternal(context.Background(), dockerClient, "web_data")
+ err := EnsureRenameTargetAbsent(context.Background(), dockerClient, "web_data")
- var conflictErr *ProjectVolumeRenameConflictError
+ var conflictErr *volumetypes.ProjectVolumeRenameConflictError
require.ErrorAs(t, err, &conflictErr)
require.Equal(t, "web_data", conflictErr.VolumeName)
}
@@ -68,11 +70,11 @@ func TestEnsureProjectRenameSourceVolumeDetachedInternal_ReturnsConflictWhenCont
}))
t.Cleanup(server.Close)
- dockerClient := newTestDockerClient(t, server)
+ dockerClient := newTestDockerClientInternal(t, server)
- err := ensureProjectRenameSourceVolumeDetachedInternal(context.Background(), dockerClient, "nginx_data")
+ err := EnsureRenameSourceDetached(context.Background(), dockerClient, "nginx_data")
- var inUseErr *ProjectVolumeRenameInUseError
+ var inUseErr *volumetypes.ProjectVolumeRenameInUseError
require.ErrorAs(t, err, &inUseErr)
require.Equal(t, "nginx_data", inUseErr.VolumeName)
require.Equal(t, []string{"stopped-container"}, inUseErr.ContainerIDs)
@@ -117,7 +119,7 @@ func TestGetProjectVolumeCopyRuntimeInternal_UsesArcaneAgentLabel(t *testing.T)
}))
t.Cleanup(server.Close)
- copyRuntime, err := getProjectVolumeCopyRuntimeInternal(context.Background(), newTestDockerClient(t, server), volumehelper.ToolsImage(""))
+ copyRuntime, err := getProjectVolumeCopyRuntimeInternal(context.Background(), newTestDockerClientInternal(t, server), volumehelper.ToolsImage(""))
require.NoError(t, err)
require.Equal(t, "arcane-agent:local", copyRuntime.Image)
@@ -145,11 +147,11 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesTargetWhenS
t.Cleanup(server.Close)
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
- createdNew: []projectVolumeRenameEntryInternal{
+ dockerClient: newTestDockerClientInternal(t, server),
+ createdNew: []volumetypes.RenameEntry{
{OldName: "nginx_data", NewName: "web_data"},
},
- removedOld: []projectVolumeRenameEntryInternal{
+ removedOld: []volumetypes.RenameEntry{
{
OldName: "nginx_data",
NewName: "web_data",
@@ -160,7 +162,7 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesTargetWhenS
err := migration.Rollback(context.Background())
require.Error(t, err)
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
require.ErrorAs(t, err, &preserved)
require.False(t, targetRemoved.Load(), "target volume may be the only complete copy and must stay when source restore fails")
require.Len(t, migration.createdNew, 1)
@@ -202,12 +204,12 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackCleansSafeTargetsWhe
t.Cleanup(server.Close)
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
- createdNew: []projectVolumeRenameEntryInternal{
+ dockerClient: newTestDockerClientInternal(t, server),
+ createdNew: []volumetypes.RenameEntry{
{OldName: "nginx_data", NewName: "web_data"},
{OldName: "nginx_cache", NewName: "web_cache"},
},
- removedOld: []projectVolumeRenameEntryInternal{
+ removedOld: []volumetypes.RenameEntry{
{
OldName: "nginx_data",
NewName: "web_data",
@@ -218,11 +220,11 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackCleansSafeTargetsWhe
err := migration.Rollback(context.Background())
require.Error(t, err)
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
require.ErrorAs(t, err, &preserved)
require.False(t, preservedTargetRemoved.Load(), "target volume may be the only complete copy and must stay when source restore fails")
require.True(t, safeTargetRemoved.Load(), "targets without removed sources should still be cleaned up")
- require.Equal(t, []projectVolumeRenameEntryInternal{{OldName: "nginx_data", NewName: "web_data"}}, migration.createdNew)
+ require.Equal(t, []volumetypes.RenameEntry{{OldName: "nginx_data", NewName: "web_data"}}, migration.createdNew)
}
func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesTargetWhenSourceInspectFails(t *testing.T) {
@@ -256,8 +258,8 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesTargetWhenS
t.Cleanup(server.Close)
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
- createdNew: []projectVolumeRenameEntryInternal{
+ dockerClient: newTestDockerClientInternal(t, server),
+ createdNew: []volumetypes.RenameEntry{
{OldName: "nginx_data", NewName: "web_data"},
{OldName: "nginx_cache", NewName: "web_cache"},
},
@@ -266,11 +268,11 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesTargetWhenS
err := migration.Rollback(context.Background())
require.Error(t, err)
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
require.ErrorAs(t, err, &preserved)
require.False(t, preservedTargetRemoved.Load(), "target volume must not be deleted when source inspection is uncertain")
require.True(t, safeTargetRemoved.Load(), "targets without rollback uncertainty should still be cleaned up")
- require.Equal(t, []projectVolumeRenameEntryInternal{{OldName: "nginx_data", NewName: "web_data"}}, migration.createdNew)
+ require.Equal(t, []volumetypes.RenameEntry{{OldName: "nginx_data", NewName: "web_data"}}, migration.createdNew)
}
func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesTargetWhenTargetInspectFails(t *testing.T) {
@@ -306,8 +308,8 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesTargetWhenT
t.Cleanup(server.Close)
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
- createdNew: []projectVolumeRenameEntryInternal{
+ dockerClient: newTestDockerClientInternal(t, server),
+ createdNew: []volumetypes.RenameEntry{
{OldName: "nginx_data", NewName: "web_data"},
{OldName: "nginx_cache", NewName: "web_cache"},
},
@@ -316,11 +318,11 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesTargetWhenT
err := migration.Rollback(context.Background())
require.Error(t, err)
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
require.ErrorAs(t, err, &preserved)
require.False(t, preservedTargetRemoved.Load(), "target volume must not be deleted when target inspection is uncertain")
require.True(t, safeTargetRemoved.Load(), "targets without rollback uncertainty should still be cleaned up")
- require.Equal(t, []projectVolumeRenameEntryInternal{{OldName: "nginx_data", NewName: "web_data"}}, migration.createdNew)
+ require.Equal(t, []volumetypes.RenameEntry{{OldName: "nginx_data", NewName: "web_data"}}, migration.createdNew)
}
func TestDockerProjectVolumeRenameMigrationInternal_RollbackRemovesTargetsWhenSourcesRemain(t *testing.T) {
@@ -350,8 +352,8 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackRemovesTargetsWhenSo
t.Cleanup(server.Close)
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
- createdNew: []projectVolumeRenameEntryInternal{
+ dockerClient: newTestDockerClientInternal(t, server),
+ createdNew: []volumetypes.RenameEntry{
{
OldName: "nginx_data",
NewName: "web_data",
@@ -381,11 +383,11 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesRemovedOldT
t.Cleanup(server.Close)
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
- createdNew: []projectVolumeRenameEntryInternal{
+ dockerClient: newTestDockerClientInternal(t, server),
+ createdNew: []volumetypes.RenameEntry{
{NewName: "web_data"},
},
- removedOld: []projectVolumeRenameEntryInternal{
+ removedOld: []volumetypes.RenameEntry{
{
OldName: "nginx_data",
NewName: "web_data",
@@ -396,11 +398,11 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackPreservesRemovedOldT
err := migration.Rollback(context.Background())
require.Error(t, err)
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
require.ErrorAs(t, err, &preserved)
require.False(t, targetRemoved.Load(), "rollback must not delete target volumes after source cleanup has started")
- require.Equal(t, []projectVolumeRenameEntryInternal{{OldName: "nginx_data", NewName: "web_data"}}, migration.removedOld)
- require.Equal(t, []projectVolumeRenameEntryInternal{{NewName: "web_data"}}, migration.createdNew)
+ require.Equal(t, []volumetypes.RenameEntry{{OldName: "nginx_data", NewName: "web_data"}}, migration.removedOld)
+ require.Equal(t, []volumetypes.RenameEntry{{NewName: "web_data"}}, migration.createdNew)
}
func TestDockerProjectVolumeRenameMigrationInternal_RollbackAfterPartialCommitCleansSafeTargets(t *testing.T) {
@@ -449,33 +451,33 @@ func TestDockerProjectVolumeRenameMigrationInternal_RollbackAfterPartialCommitCl
}))
t.Cleanup(server.Close)
- entries := []projectVolumeRenameEntryInternal{
+ entries := []volumetypes.RenameEntry{
{OldName: "nginx_data", NewName: "web_data"},
{OldName: "nginx_cache", NewName: "web_cache"},
}
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
+ dockerClient: newTestDockerClientInternal(t, server),
entries: entries,
- createdNew: append([]projectVolumeRenameEntryInternal(nil), entries...),
+ createdNew: append([]volumetypes.RenameEntry(nil), entries...),
}
err := migration.Commit(context.Background())
- var cleanupErr *SourceCleanupError
+ var cleanupErr *volumetypes.SourceCleanupError
require.ErrorAs(t, err, &cleanupErr)
require.Equal(t, "nginx_cache", cleanupErr.SourceVolume)
require.True(t, firstSourceRemoved.Load())
require.Positive(t, secondSourceRemoveAttempts.Load())
- require.Equal(t, []projectVolumeRenameEntryInternal{entries[0]}, migration.removedOld)
+ require.Equal(t, []volumetypes.RenameEntry{entries[0]}, migration.removedOld)
err = migration.Rollback(context.Background())
require.Error(t, err)
- var preserved *TargetPreservedDuringRollbackError
+ var preserved *volumetypes.TargetPreservedDuringRollbackError
require.ErrorAs(t, err, &preserved)
require.False(t, preservedTargetRemoved.Load(), "target volume may be the only complete copy and must stay when source cleanup has started")
require.True(t, safeTargetRemoved.Load(), "targets whose source volumes remain should still be cleaned up")
- require.Equal(t, []projectVolumeRenameEntryInternal{entries[0]}, migration.createdNew)
+ require.Equal(t, []volumetypes.RenameEntry{entries[0]}, migration.createdNew)
}
func TestDockerProjectVolumeRenameMigrationInternal_CommitPreflightsAllTargetsBeforeRemovingSources(t *testing.T) {
@@ -509,8 +511,8 @@ func TestDockerProjectVolumeRenameMigrationInternal_CommitPreflightsAllTargetsBe
t.Cleanup(server.Close)
migration := &dockerProjectVolumeRenameMigrationInternal{
- dockerClient: newTestDockerClient(t, server),
- entries: []projectVolumeRenameEntryInternal{
+ dockerClient: newTestDockerClientInternal(t, server),
+ entries: []volumetypes.RenameEntry{
{
Key: "data",
OldName: "nginx_data",
@@ -526,7 +528,7 @@ func TestDockerProjectVolumeRenameMigrationInternal_CommitPreflightsAllTargetsBe
err := migration.Commit(context.Background())
- var missingTarget *TargetMissingWithSourceError
+ var missingTarget *volumetypes.TargetMissingWithSourceError
require.ErrorAs(t, err, &missingTarget)
require.Equal(t, "nginx_cache", missingTarget.SourceVolume)
require.Equal(t, "web_cache", missingTarget.TargetVolume)
diff --git a/backend/pkg/libarcane/volumes/volume_rename_test.go b/backend/pkg/libarcane/volumes/volume_rename_test.go
index c3edbed72..bfbe86caf 100644
--- a/backend/pkg/libarcane/volumes/volume_rename_test.go
+++ b/backend/pkg/libarcane/volumes/volume_rename_test.go
@@ -1,25 +1,21 @@
package volumes
import (
- "context"
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
- composetypes "github.com/compose-spec/compose-go/v2/types"
- "github.com/docker/compose/v5/pkg/api"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane"
"github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumehelper"
"github.com/moby/moby/api/types/container"
"github.com/moby/moby/api/types/volume"
"github.com/moby/moby/client"
- "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
-func newTestDockerClient(t *testing.T, server *httptest.Server) *client.Client {
+func newTestDockerClientInternal(t *testing.T, server *httptest.Server) *client.Client {
t.Helper()
httpClient := server.Client()
@@ -37,29 +33,6 @@ func newTestDockerClient(t *testing.T, server *httptest.Server) *client.Client {
return cli
}
-func TestBuildProjectRenamedVolumeConfigInternal(t *testing.T) {
- source := composetypes.VolumeConfig{
- Name: "nginx_data",
- Driver: "local",
- Labels: composetypes.Labels{
- "existing": "kept",
- },
- CustomLabels: composetypes.Labels{
- api.ProjectLabel: "nginx",
- api.VolumeLabel: "data",
- },
- }
-
- got := buildProjectRenamedVolumeConfigInternal(source, "data", "web_data", "web")
-
- require.Equal(t, "web_data", got.Name)
- require.Equal(t, "local", got.Driver)
- require.Equal(t, "kept", got.Labels["existing"])
- require.Equal(t, "web", got.CustomLabels[api.ProjectLabel])
- require.Equal(t, "data", got.CustomLabels[api.VolumeLabel])
- require.Equal(t, api.ComposeVersion, got.CustomLabels[api.VersionLabel])
-}
-
func TestPlanRenamePreservesStandaloneVolumeConfiguration(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch {
@@ -82,7 +55,7 @@ func TestPlanRenamePreservesStandaloneVolumeConfiguration(t *testing.T) {
}))
t.Cleanup(server.Close)
- migration, err := PlanRename(t.Context(), newTestDockerClient(t, server), "source-data", "renamed-data", volumehelper.ToolsImage(""))
+ migration, err := PlanRename(t.Context(), newTestDockerClientInternal(t, server), "source-data", "renamed-data", volumehelper.ToolsImage(""))
require.NoError(t, err)
planned, ok := migration.(*dockerProjectVolumeRenameMigrationInternal)
@@ -112,54 +85,3 @@ func TestContainerSummaryMountsVolumeInternal(t *testing.T) {
require.True(t, containerSummaryMountsVolumeInternal(summary, "web_data"))
require.False(t, containerSummaryMountsVolumeInternal(summary, "nginx_data"))
}
-
-func TestCreateProjectRenamedVolumeInternal_UsesPendingComposeDriverOptions(t *testing.T) {
- var payload map[string]any
- server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- if r.Method == http.MethodPost && strings.HasSuffix(r.URL.Path, "/volumes/create") {
- if !assert.NoError(t, json.NewDecoder(r.Body).Decode(&payload)) {
- return
- }
- w.Header().Set("Content-Type", "application/json")
- if !assert.NoError(t, json.NewEncoder(w).Encode(volume.Volume{Name: "web_data"})) {
- return
- }
- return
- }
- http.NotFound(w, r)
- }))
- t.Cleanup(server.Close)
-
- entry := projectVolumeRenameEntryInternal{
- Key: "data",
- OldName: "nginx_data",
- NewName: "web_data",
- OldVolume: volume.Volume{
- Driver: "old-driver",
- Options: map[string]string{"old": "true"},
- Labels: map[string]string{"existing": "kept"},
- },
- NewConfig: composetypes.VolumeConfig{
- Name: "web_data",
- Driver: "new-driver",
- DriverOpts: map[string]string{"new": "true"},
- CustomLabels: composetypes.Labels{
- api.ProjectLabel: "web",
- api.VolumeLabel: "data",
- },
- },
- }
-
- err := createProjectRenamedVolumeInternal(context.Background(), newTestDockerClient(t, server), entry)
-
- require.NoError(t, err)
- require.Equal(t, "web_data", payload["Name"])
- require.Equal(t, "new-driver", payload["Driver"])
- require.Equal(t, map[string]any{"new": "true"}, payload["DriverOpts"])
- labels, ok := payload["Labels"].(map[string]any)
- require.True(t, ok)
- require.Equal(t, "kept", labels["existing"])
- require.Equal(t, "web", labels[api.ProjectLabel])
- require.Equal(t, "data", labels[api.VolumeLabel])
- require.NotEmpty(t, labels[api.ConfigHashLabel])
-}
diff --git a/backend/pkg/projects/build.go b/backend/pkg/projects/build.go
index ce6bbed58..5670d5309 100644
--- a/backend/pkg/projects/build.go
+++ b/backend/pkg/projects/build.go
@@ -1,12 +1,18 @@
package projects
import (
+ "fmt"
+ "maps"
"path/filepath"
+ "strconv"
"strings"
"emperror.dev/errors"
composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/utils/imageref"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
"go.getarcane.app/builds/pkg/contextsource"
+ buildtypes "go.getarcane.app/builds/types"
)
// ResolveBuildContext resolves a service build context against workingDir.
@@ -38,3 +44,229 @@ func ResolveDockerfilePath(svc composetypes.ServiceConfig) string {
return dockerfilePath
}
+
+// BuildArgsFromCompose flattens compose build args into a string map, dropping nil values.
+func BuildArgsFromCompose(args map[string]*string) map[string]string {
+ buildArgs := map[string]string{}
+ for key, value := range args {
+ if value == nil {
+ continue
+ }
+ buildArgs[key] = *value
+ }
+ return buildArgs
+}
+
+// LabelsFromCompose copies compose labels into a plain map, returning nil when empty.
+func LabelsFromCompose(labels composetypes.Labels) map[string]string {
+ if len(labels) == 0 {
+ return nil
+ }
+
+ out := make(map[string]string, len(labels))
+ maps.Copy(out, labels)
+
+ return out
+}
+
+// UlimitsFromCompose renders compose ulimits as Docker-style "soft:hard" (or single) strings.
+func UlimitsFromCompose(ulimits map[string]*composetypes.UlimitsConfig) map[string]string {
+ if len(ulimits) == 0 {
+ return nil
+ }
+
+ out := make(map[string]string, len(ulimits))
+ for name, cfg := range ulimits {
+ if cfg == nil {
+ continue
+ }
+
+ switch {
+ case cfg.Single > 0:
+ out[name] = strconv.Itoa(cfg.Single)
+ case cfg.Soft > 0 || cfg.Hard > 0:
+ out[name] = fmt.Sprintf("%d:%d", cfg.Soft, cfg.Hard)
+ }
+ }
+
+ if len(out) == 0 {
+ return nil
+ }
+
+ return out
+}
+
+// MergeBuildTags combines a primary image tag with compose tags, trimming blanks
+// and de-duplicating while preserving order (primary first).
+func MergeBuildTags(primaryImage string, composeTags []string) []string {
+ seen := map[string]struct{}{}
+ merged := make([]string, 0, len(composeTags)+1)
+
+ appendTag := func(tag string) {
+ tag = strings.TrimSpace(tag)
+ if tag == "" {
+ return
+ }
+ if _, ok := seen[tag]; ok {
+ return
+ }
+ seen[tag] = struct{}{}
+ merged = append(merged, tag)
+ }
+
+ appendTag(primaryImage)
+ for _, tag := range composeTags {
+ appendTag(tag)
+ }
+
+ return merged
+}
+
+// BuildPlatformsFromCompose returns the build platforms for a service, falling
+// back to the service platform when no build platforms are declared.
+func BuildPlatformsFromCompose(svc composetypes.ServiceConfig) []string {
+ platforms := make([]string, 0, len(svc.Build.Platforms)+1)
+ for _, platform := range svc.Build.Platforms {
+ platform = strings.TrimSpace(platform)
+ if platform == "" {
+ continue
+ }
+ platforms = append(platforms, platform)
+ }
+
+ if len(platforms) == 0 {
+ if servicePlatform := strings.TrimSpace(svc.Platform); servicePlatform != "" {
+ platforms = append(platforms, servicePlatform)
+ }
+ }
+
+ return platforms
+}
+
+// BuildLocalImageTag derives a deterministic local image tag for a built service.
+func BuildLocalImageTag(projectID, projectName, serviceName string) string {
+ shortID := strings.TrimSpace(projectID)
+ if len(shortID) > 8 {
+ shortID = shortID[:8]
+ }
+ projectPart := SanitizeImageComponent(projectName)
+ if projectPart == "" {
+ projectPart = "project"
+ }
+ servicePart := SanitizeImageComponent(serviceName)
+ if servicePart == "" {
+ servicePart = "service"
+ }
+
+ return fmt.Sprintf("%s/%s-%s/%s:latest", imageref.LocalBuildRegistry, projectPart, shortID, servicePart)
+}
+
+// SanitizeImageComponent lowercases a value and replaces characters that are
+// invalid in an image reference component with '-'.
+func SanitizeImageComponent(value string) string {
+ value = strings.ToLower(strings.TrimSpace(value))
+ if value == "" {
+ return ""
+ }
+ return strings.Map(func(r rune) rune {
+ switch {
+ case r >= 'a' && r <= 'z':
+ return r
+ case r >= '0' && r <= '9':
+ return r
+ case r == '-' || r == '_' || r == '.':
+ return r
+ default:
+ return '-'
+ }
+ }, value)
+}
+
+func resolveEffectiveBuildProviderInternal(override, defaultProvider string) string {
+ provider := strings.ToLower(strings.TrimSpace(override))
+ if provider != "" {
+ return provider
+ }
+
+ provider = strings.ToLower(strings.TrimSpace(defaultProvider))
+
+ if provider == "" {
+ provider = "local"
+ }
+
+ return provider
+}
+
+// PrepareServiceBuildRequest translates a Compose build into the configured provider request.
+func PrepareServiceBuildRequest(
+ projectID string,
+ project *composetypes.Project,
+ serviceName string,
+ svc composetypes.ServiceConfig,
+ options projecttypes.BuildOptions,
+ defaultProvider string,
+) (buildtypes.BuildRequest, composetypes.ServiceConfig, bool, error) {
+ if project == nil || svc.Build == nil {
+ return buildtypes.BuildRequest{}, svc, false, errors.New("compose project and service build configuration are required")
+ }
+ imageName, updatedSvc, updated := EnsureServiceImage(projectID, project.Name, serviceName, svc)
+ effectiveProvider := resolveEffectiveBuildProviderInternal(options.Provider, defaultProvider)
+
+ if updated && effectiveProvider == "depot" {
+ return buildtypes.BuildRequest{}, updatedSvc, updated, errors.Errorf("service %s must define an image when using depot build provider", serviceName)
+ }
+ if updated && options.Push != nil && *options.Push {
+ return buildtypes.BuildRequest{}, updatedSvc, updated, errors.Errorf("service %s must define an image when push is enabled", serviceName)
+ }
+
+ // Build providers read the context from Arcane's filesystem, so keep
+ // container paths here; only Docker bind sources use host paths.
+ contextDir, err := ResolveBuildContext(project.WorkingDir, updatedSvc, serviceName)
+ if err != nil {
+ return buildtypes.BuildRequest{}, updatedSvc, updated, err
+ }
+
+ dockerfileInline := updatedSvc.Build.DockerfileInline
+ if strings.TrimSpace(updatedSvc.Build.Dockerfile) != "" && strings.TrimSpace(dockerfileInline) != "" {
+ return buildtypes.BuildRequest{}, updatedSvc, updated, errors.Errorf("service %s cannot define both dockerfile and dockerfile_inline", serviceName)
+ }
+
+ dockerfilePath := ""
+ if strings.TrimSpace(dockerfileInline) == "" {
+ dockerfilePath = ResolveDockerfilePath(updatedSvc)
+ }
+
+ buildReq := buildtypes.BuildRequest{
+ ContextDir: contextDir,
+ Dockerfile: dockerfilePath,
+ DockerfileInline: dockerfileInline,
+ Tags: MergeBuildTags(imageName, updatedSvc.Build.Tags),
+ Target: strings.TrimSpace(updatedSvc.Build.Target),
+ BuildArgs: BuildArgsFromCompose(updatedSvc.Build.Args),
+ Labels: LabelsFromCompose(updatedSvc.Build.Labels),
+ CacheFrom: append([]string(nil), updatedSvc.Build.CacheFrom...),
+ CacheTo: append([]string(nil), updatedSvc.Build.CacheTo...),
+ NoCache: updatedSvc.Build.NoCache,
+ Pull: updatedSvc.Build.Pull,
+ Network: strings.TrimSpace(updatedSvc.Build.Network),
+ Isolation: strings.TrimSpace(updatedSvc.Build.Isolation),
+ ShmSize: int64(updatedSvc.Build.ShmSize),
+ Ulimits: UlimitsFromCompose(updatedSvc.Build.Ulimits),
+ Entitlements: append(
+ []string(nil),
+ updatedSvc.Build.Entitlements...,
+ ),
+ Privileged: updatedSvc.Build.Privileged,
+ ExtraHosts: updatedSvc.Build.ExtraHosts.AsList(":"),
+ Platforms: BuildPlatformsFromCompose(updatedSvc),
+ Provider: effectiveProvider,
+ }
+ if options.Push != nil {
+ buildReq.Push = *options.Push
+ }
+ if options.Load != nil {
+ buildReq.Load = *options.Load
+ }
+
+ return buildReq, updatedSvc, updated, nil
+}
diff --git a/backend/pkg/projects/build_test.go b/backend/pkg/projects/build_test.go
index 1dbad5a54..15738e7f2 100644
--- a/backend/pkg/projects/build_test.go
+++ b/backend/pkg/projects/build_test.go
@@ -4,6 +4,7 @@ import (
"testing"
composetypes "github.com/compose-spec/compose-go/v2/types"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -31,3 +32,220 @@ func TestResolveBuildContext_AllowsRemoteGitContextWithoutGitSuffix(t *testing.T
require.NoError(t, err)
assert.Equal(t, "https://git.sr.ht/~jordanreger/nws-alerts#main:docker/app", contextDir)
}
+
+func TestMergeBuildTags(t *testing.T) {
+ tags := MergeBuildTags("example/app:latest", []string{"example/app:sha", "example/app:latest", " "})
+ assert.Equal(t, []string{"example/app:latest", "example/app:sha"}, tags)
+}
+
+func TestBuildPlatformsFromCompose(t *testing.T) {
+ t.Run("uses service platform when build platforms missing", func(t *testing.T) {
+ svc := composetypes.ServiceConfig{
+ Platform: "linux/amd64",
+ Build: &composetypes.BuildConfig{
+ Context: ".",
+ },
+ }
+
+ platforms := BuildPlatformsFromCompose(svc)
+ assert.Equal(t, []string{"linux/amd64"}, platforms)
+ })
+
+ t.Run("keeps explicit build platforms", func(t *testing.T) {
+ svc := composetypes.ServiceConfig{
+ Platform: "linux/amd64",
+ Build: &composetypes.BuildConfig{
+ Context: ".",
+ Platforms: []string{"linux/arm64"},
+ },
+ }
+
+ platforms := BuildPlatformsFromCompose(svc)
+ assert.Equal(t, []string{"linux/arm64"}, platforms)
+ })
+}
+
+func TestPrepareServiceBuildRequest_MapsComposeFields(t *testing.T) {
+ proj := &composetypes.Project{WorkingDir: "/tmp/project", Name: "demo"}
+
+ serviceCfg := composetypes.ServiceConfig{
+ Name: "web",
+ Image: "example/web:latest",
+ Platform: "linux/amd64",
+ Build: &composetypes.BuildConfig{
+ Context: ".",
+ Dockerfile: "Dockerfile.custom",
+ Target: "prod",
+ Args: composetypes.MappingWithEquals{
+ "FOO": new("bar"),
+ },
+ Tags: []string{"example/web:sha", "example/web:latest"},
+ CacheFrom: []string{"example/cache:latest"},
+ CacheTo: []string{"type=local,dest=/tmp/cache"},
+ NoCache: true,
+ Pull: true,
+ Network: "host",
+ Isolation: "default",
+ ShmSize: composetypes.UnitBytes(64 * 1024 * 1024),
+ Ulimits: map[string]*composetypes.UlimitsConfig{
+ "nofile": {Soft: 1024, Hard: 2048},
+ },
+ Entitlements: []string{"network.host"},
+ Privileged: true,
+ ExtraHosts: composetypes.HostsList{
+ "registry.local": {"10.0.0.5"},
+ },
+ Labels: composetypes.Labels{
+ "com.example.team": "platform",
+ },
+ },
+ }
+
+ req, _, _, err := PrepareServiceBuildRequest(
+ "project-id",
+ proj,
+ "web",
+ serviceCfg,
+ projecttypes.BuildOptions{}, "",
+ )
+ require.NoError(t, err)
+
+ assert.Equal(t, "/tmp/project", req.ContextDir)
+ assert.Equal(t, "Dockerfile.custom", req.Dockerfile)
+ assert.Equal(t, "prod", req.Target)
+ assert.Equal(t, map[string]string{"FOO": "bar"}, req.BuildArgs)
+ assert.Equal(t, []string{"example/web:latest", "example/web:sha"}, req.Tags)
+ assert.Equal(t, []string{"linux/amd64"}, req.Platforms)
+ assert.Equal(t, []string{"example/cache:latest"}, req.CacheFrom)
+ assert.Equal(t, []string{"type=local,dest=/tmp/cache"}, req.CacheTo)
+ assert.True(t, req.NoCache)
+ assert.True(t, req.Pull)
+ assert.Equal(t, "host", req.Network)
+ assert.Equal(t, "default", req.Isolation)
+ assert.Equal(t, int64(64*1024*1024), req.ShmSize)
+ assert.Equal(t, map[string]string{"nofile": "1024:2048"}, req.Ulimits)
+ assert.Equal(t, []string{"network.host"}, req.Entitlements)
+ assert.True(t, req.Privileged)
+ assert.Equal(t, map[string]string{"com.example.team": "platform"}, req.Labels)
+ require.Len(t, req.ExtraHosts, 1)
+ assert.Contains(t, req.ExtraHosts[0], "registry.local")
+ assert.Contains(t, req.ExtraHosts[0], "10.0.0.5")
+}
+
+// TestPrepareServiceBuildRequest_KeepsContainerPaths is a
+// regression test for #2314: Arcane's local build pipeline (the docker and
+// buildkit providers both read the build context via the Arcane process's own
+// filesystem) cannot use host paths, so prepareServiceBuildRequest must leave
+// the build context and any absolute Dockerfile path as container paths even
+// when the projects mount has a non-matching host prefix.
+func TestPrepareServiceBuildRequest_KeepsContainerPaths(t *testing.T) {
+ proj := &composetypes.Project{WorkingDir: "/app/data/projects/demo", Name: "demo"}
+
+ serviceCfg := composetypes.ServiceConfig{
+ Name: "web",
+ Image: "example/web:latest",
+ Build: &composetypes.BuildConfig{
+ Context: ".",
+ Dockerfile: "/app/data/projects/demo/Dockerfile.custom",
+ },
+ }
+
+ req, _, _, err := PrepareServiceBuildRequest(
+ "project-id",
+ proj,
+ "web",
+ serviceCfg,
+ projecttypes.BuildOptions{}, "",
+ )
+ require.NoError(t, err)
+
+ assert.Equal(t, "/app/data/projects/demo", req.ContextDir)
+ assert.Equal(t, "/app/data/projects/demo/Dockerfile.custom", req.Dockerfile)
+}
+
+// TestPrepareServiceBuildRequest_BuildDotKeepsContainerPath
+// reproduces the exact configuration from #2314: a compose file with
+// `build: .` next to its Dockerfile, on an installation where the projects
+// directory is bind-mounted from a different host path than the container
+// path. The resulting BuildRequest must point at the container path so the
+// local builder can stat / tar the directory.
+func TestPrepareServiceBuildRequest_BuildDotKeepsContainerPath(t *testing.T) {
+ proj := &composetypes.Project{WorkingDir: "/app/data/projects/caddy", Name: "caddy"}
+
+ serviceCfg := composetypes.ServiceConfig{
+ Name: "caddy",
+ Image: "caddy",
+ Build: &composetypes.BuildConfig{
+ Context: ".",
+ },
+ }
+
+ req, _, _, err := PrepareServiceBuildRequest(
+ "project-id",
+ proj,
+ "caddy",
+ serviceCfg,
+ projecttypes.BuildOptions{}, "",
+ )
+ require.NoError(t, err)
+
+ assert.Equal(t, "/app/data/projects/caddy", req.ContextDir)
+ assert.Equal(t, "Dockerfile", req.Dockerfile)
+}
+
+func TestPrepareServiceBuildRequest_UsesInlineDockerfile(t *testing.T) {
+ proj := &composetypes.Project{WorkingDir: "/tmp/project", Name: "demo"}
+
+ serviceCfg := composetypes.ServiceConfig{
+ Name: "web",
+ Image: "example/web:latest",
+ Build: &composetypes.BuildConfig{
+ Context: ".",
+ DockerfileInline: "FROM alpine:3.20\nRUN echo inline\n",
+ },
+ }
+
+ req, _, _, err := PrepareServiceBuildRequest(
+ "project-id",
+ proj,
+ "web",
+ serviceCfg,
+ projecttypes.BuildOptions{}, "",
+ )
+ require.NoError(t, err)
+
+ assert.Equal(t, "/tmp/project", req.ContextDir)
+ assert.Empty(t, req.Dockerfile)
+ assert.Equal(t, "FROM alpine:3.20\nRUN echo inline\n", req.DockerfileInline)
+}
+
+func TestPrepareServiceBuildRequest_GeneratedImageProviderGuardrails(t *testing.T) {
+ proj := &composetypes.Project{WorkingDir: "/tmp/project", Name: "demo"}
+
+ serviceCfg := composetypes.ServiceConfig{
+ Name: "web",
+ Build: &composetypes.BuildConfig{
+ Context: ".",
+ },
+ }
+
+ _, _, _, err := PrepareServiceBuildRequest(
+ "project-id",
+ proj,
+ "web",
+ serviceCfg,
+ projecttypes.BuildOptions{Provider: "depot"}, "",
+ )
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), "must define an image when using depot")
+
+ _, _, _, err = PrepareServiceBuildRequest(
+ "project-id",
+ proj,
+ "web",
+ serviceCfg,
+ projecttypes.BuildOptions{Provider: "local", Push: new(true)}, "",
+ )
+ require.Error(t, err)
+ assert.Contains(t, err.Error(), "must define an image when push is enabled")
+}
diff --git a/backend/pkg/projects/build_translation.go b/backend/pkg/projects/build_translation.go
deleted file mode 100644
index 06563a972..000000000
--- a/backend/pkg/projects/build_translation.go
+++ /dev/null
@@ -1,148 +0,0 @@
-package projects
-
-import (
- "fmt"
- "maps"
- "strconv"
- "strings"
-
- composetypes "github.com/compose-spec/compose-go/v2/types"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/utils/imageref"
-)
-
-// BuildArgsFromCompose flattens compose build args into a string map, dropping nil values.
-func BuildArgsFromCompose(args map[string]*string) map[string]string {
- buildArgs := map[string]string{}
- for key, value := range args {
- if value == nil {
- continue
- }
- buildArgs[key] = *value
- }
- return buildArgs
-}
-
-// LabelsFromCompose copies compose labels into a plain map, returning nil when empty.
-func LabelsFromCompose(labels composetypes.Labels) map[string]string {
- if len(labels) == 0 {
- return nil
- }
-
- out := make(map[string]string, len(labels))
- maps.Copy(out, labels)
-
- return out
-}
-
-// UlimitsFromCompose renders compose ulimits as Docker-style "soft:hard" (or single) strings.
-func UlimitsFromCompose(ulimits map[string]*composetypes.UlimitsConfig) map[string]string {
- if len(ulimits) == 0 {
- return nil
- }
-
- out := make(map[string]string, len(ulimits))
- for name, cfg := range ulimits {
- if cfg == nil {
- continue
- }
-
- switch {
- case cfg.Single > 0:
- out[name] = strconv.Itoa(cfg.Single)
- case cfg.Soft > 0 || cfg.Hard > 0:
- out[name] = fmt.Sprintf("%d:%d", cfg.Soft, cfg.Hard)
- }
- }
-
- if len(out) == 0 {
- return nil
- }
-
- return out
-}
-
-// MergeBuildTags combines a primary image tag with compose tags, trimming blanks
-// and de-duplicating while preserving order (primary first).
-func MergeBuildTags(primaryImage string, composeTags []string) []string {
- seen := map[string]struct{}{}
- merged := make([]string, 0, len(composeTags)+1)
-
- appendTag := func(tag string) {
- tag = strings.TrimSpace(tag)
- if tag == "" {
- return
- }
- if _, ok := seen[tag]; ok {
- return
- }
- seen[tag] = struct{}{}
- merged = append(merged, tag)
- }
-
- appendTag(primaryImage)
- for _, tag := range composeTags {
- appendTag(tag)
- }
-
- return merged
-}
-
-// BuildPlatformsFromCompose returns the build platforms for a service, falling
-// back to the service platform when no build platforms are declared.
-func BuildPlatformsFromCompose(svc composetypes.ServiceConfig) []string {
- platforms := make([]string, 0, len(svc.Build.Platforms)+1)
- for _, platform := range svc.Build.Platforms {
- platform = strings.TrimSpace(platform)
- if platform == "" {
- continue
- }
- platforms = append(platforms, platform)
- }
-
- if len(platforms) == 0 {
- if servicePlatform := strings.TrimSpace(svc.Platform); servicePlatform != "" {
- platforms = append(platforms, servicePlatform)
- }
- }
-
- return platforms
-}
-
-// BuildLocalImageTag derives a deterministic local image tag for a built service.
-func BuildLocalImageTag(projectID, projectName, serviceName string) string {
- shortID := strings.TrimSpace(projectID)
- if len(shortID) > 8 {
- shortID = shortID[:8]
- }
- projectPart := SanitizeImageComponent(projectName)
- if projectPart == "" {
- projectPart = "project"
- }
- servicePart := SanitizeImageComponent(serviceName)
- if servicePart == "" {
- servicePart = "service"
- }
-
- return fmt.Sprintf("%s/%s-%s/%s:latest", imageref.LocalBuildRegistry, projectPart, shortID, servicePart)
-}
-
-// SanitizeImageComponent lowercases a value and replaces characters that are
-// invalid in an image reference component with '-'.
-func SanitizeImageComponent(value string) string {
- value = strings.ToLower(strings.TrimSpace(value))
- if value == "" {
- return ""
- }
- return strings.Map(func(r rune) rune {
- switch {
- case r >= 'a' && r <= 'z':
- return r
- case r >= '0' && r <= '9':
- return r
- case r == '-' || r == '_' || r == '.':
- return r
- default:
- return '-'
- }
- }, value)
-}
diff --git a/backend/pkg/projects/build_translation_test.go b/backend/pkg/projects/build_translation_test.go
deleted file mode 100644
index 1c26c5df2..000000000
--- a/backend/pkg/projects/build_translation_test.go
+++ /dev/null
@@ -1,40 +0,0 @@
-package projects
-
-import (
- "testing"
-
- composetypes "github.com/compose-spec/compose-go/v2/types"
- "github.com/stretchr/testify/assert"
-)
-
-func TestMergeBuildTags(t *testing.T) {
- tags := MergeBuildTags("example/app:latest", []string{"example/app:sha", "example/app:latest", " "})
- assert.Equal(t, []string{"example/app:latest", "example/app:sha"}, tags)
-}
-
-func TestBuildPlatformsFromCompose(t *testing.T) {
- t.Run("uses service platform when build platforms missing", func(t *testing.T) {
- svc := composetypes.ServiceConfig{
- Platform: "linux/amd64",
- Build: &composetypes.BuildConfig{
- Context: ".",
- },
- }
-
- platforms := BuildPlatformsFromCompose(svc)
- assert.Equal(t, []string{"linux/amd64"}, platforms)
- })
-
- t.Run("keeps explicit build platforms", func(t *testing.T) {
- svc := composetypes.ServiceConfig{
- Platform: "linux/amd64",
- Build: &composetypes.BuildConfig{
- Context: ".",
- Platforms: []string{"linux/arm64"},
- },
- }
-
- platforms := BuildPlatformsFromCompose(svc)
- assert.Equal(t, []string{"linux/arm64"}, platforms)
- })
-}
diff --git a/backend/pkg/projects/cache.go b/backend/pkg/projects/cache.go
new file mode 100644
index 000000000..172572e04
--- /dev/null
+++ b/backend/pkg/projects/cache.go
@@ -0,0 +1,150 @@
+package projects
+
+import (
+ "context"
+ "fmt"
+ "os"
+ "path/filepath"
+ "strings"
+ "time"
+
+ "emperror.dev/errors"
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+ "github.com/samber/hot"
+)
+
+type composeCacheInternal[T any] struct {
+ entries *hot.HotCache[string, composeCacheEntryInternal[T]]
+ clone func(T) T
+}
+
+type composeCacheEntryInternal[T any] struct {
+ fingerprint string
+ mtimes map[string]time.Time
+ value T
+}
+
+// NewComposeCache caches Compose-derived values and their file dependencies.
+// clone, when supplied, isolates stored values from mutations by callers.
+func NewComposeCache[T any](capacity int, clone func(T) T) projecttypes.ComposeCache[T] {
+ return &composeCacheInternal[T]{entries: hot.NewHotCache[string, composeCacheEntryInternal[T]](hot.LRU, capacity).Build(), clone: clone}
+}
+
+// NewParsedComposeCache keeps operation-local models separate from cached state.
+func NewParsedComposeCache() projecttypes.ComposeCache[*composetypes.Project] {
+ return NewComposeCache(2048, cloneComposeProjectInternal)
+}
+
+func cloneComposeProjectInternal(project *composetypes.Project) *composetypes.Project {
+ if project == nil {
+ return nil
+ }
+ // With no names this compose-go operation deep-copies without disabling services.
+ return project.WithServicesDisabled()
+}
+
+func (c *composeCacheInternal[T]) Get(projectID, fingerprint string) (T, bool) {
+ entry, found := c.entries.Peek(projectID)
+ if found && entry.fingerprint == fingerprint && validComposeCacheEntryInternal(entry.mtimes) {
+ if c.clone != nil {
+ return c.clone(entry.value), true
+ }
+ return entry.value, true
+ }
+ var zero T
+ return zero, false
+}
+
+func (c *composeCacheInternal[T]) Set(projectID, fingerprint, projectPath, projectsDirectory, composePath string, composeFiles, envFiles []string, value T) error {
+ if strings.TrimSpace(projectID) == "" {
+ return nil
+ }
+ mtimes := make(map[string]time.Time)
+ for _, path := range append([]string{composePath}, composeFiles...) {
+ if path == "" {
+ continue
+ }
+ info, err := os.Stat(path)
+ if err != nil {
+ return errors.WrapIff(err, "stat compose file %s", path)
+ }
+ mtimes[path] = info.ModTime()
+ }
+ dependencies := append([]string{filepath.Join(projectPath, EffectiveEnvFileName)}, envFiles...)
+ if projectsDirectory != "" {
+ dependencies = append(dependencies, filepath.Join(projectsDirectory, GlobalEnvFileName))
+ }
+ // A later standard override must invalidate a model loaded before it existed.
+ for _, name := range composeOverrideFileCandidates {
+ dependencies = append(dependencies, filepath.Join(filepath.Dir(composePath), name))
+ }
+ for _, path := range dependencies {
+ info, err := os.Stat(path)
+ if err == nil {
+ mtimes[path] = info.ModTime()
+ continue
+ }
+ if !os.IsNotExist(err) {
+ return errors.WrapIff(err, "stat compose dependency %s", path)
+ }
+ mtimes[path] = time.Time{}
+ }
+ if c.clone != nil {
+ value = c.clone(value)
+ }
+ c.entries.Set(projectID, composeCacheEntryInternal[T]{fingerprint: fingerprint, mtimes: mtimes, value: value})
+ return nil
+}
+
+func (c *composeCacheInternal[T]) Invalidate(projectID string) {
+ c.entries.Delete(projectID)
+}
+
+func validComposeCacheEntryInternal(mtimes map[string]time.Time) bool {
+ for path, mtime := range mtimes {
+ info, err := os.Stat(path)
+ if err != nil {
+ if !os.IsNotExist(err) || !mtime.IsZero() {
+ return false
+ }
+ continue
+ }
+ if mtime.IsZero() || !info.ModTime().Equal(mtime) {
+ return false
+ }
+ }
+ return true
+}
+
+// LoadCachedComposeProject resolves an executable model with isolated cached state.
+func LoadCachedComposeProject(ctx context.Context, cache projecttypes.ComposeCache[*composetypes.Project], projectID, projectPath, composePath, projectName, projectsDirectory string, autoInject bool, pathMapper *PathMapper) (*composetypes.Project, error) {
+ fingerprint := fmt.Sprintf("%q|%q|%q|%t|%#v", composePath, projectName, projectsDirectory, autoInject, pathMapper)
+ if cache != nil {
+ if cached, ok := cache.Get(projectID, fingerprint); ok {
+ return cached, nil
+ }
+ }
+ dependencies := projecttypes.ComposeDependencies{}
+ model, err := LoadComposeProject(ctx, composePath, projectName, projectsDirectory, autoInject, pathMapper, nil, nil, false, &dependencies, nil)
+ if err != nil {
+ return nil, err
+ }
+ if cache == nil {
+ return model, nil
+ }
+ if envOpts, parseErr := ParseComposeEnvOptions(model.WorkingDir, EnvMap(model.Environment)); parseErr == nil {
+ dependencies.EnvFiles = append(dependencies.EnvFiles, envOpts.EnvFiles...)
+ }
+ // Metadata discovery already follows recursive includes and their interpolation env files.
+ meta, err := ParseArcaneComposeMetadata(ctx, composePath, projectsDirectory, autoInject)
+ if err != nil {
+ return model, nil //nolint:nilerr // Metadata discovery failure disables caching; the executable model is valid.
+ }
+ composeFiles := append(append([]string{}, model.ComposeFiles...), meta.ComposeFiles...)
+ dependencies.EnvFiles = append(dependencies.EnvFiles, meta.EnvFiles...)
+ if err := cache.Set(projectID, fingerprint, projectPath, projectsDirectory, composePath, composeFiles, dependencies.EnvFiles, model); err != nil {
+ return nil, err
+ }
+ return model, nil
+}
diff --git a/backend/pkg/projects/cmds.go b/backend/pkg/projects/cmds.go
index e1bbe628a..100982d1d 100644
--- a/backend/pkg/projects/cmds.go
+++ b/backend/pkg/projects/cmds.go
@@ -2,18 +2,21 @@ package projects
import (
"context"
+ "fmt"
"io"
+ "strings"
"time"
- "github.com/compose-spec/compose-go/v2/types"
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+
"github.com/docker/compose/v5/pkg/api"
"github.com/docker/compose/v5/pkg/compose"
+ docker "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/timeouts"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/moby/moby/api/types/container"
"github.com/moby/moby/api/types/registry"
"github.com/moby/moby/client"
-
- "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/timeouts"
- "github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
)
// defaultComposeTimeout is applied to compose operations that have been
@@ -35,7 +38,7 @@ func detachFromHTTPContextInternal(parent context.Context, timeout time.Duration
return context.WithTimeout(ctx, timeout)
}
-func ComposeRestart(ctx context.Context, proj *types.Project, services []string) error {
+func ComposeRestart(ctx context.Context, proj *composetypes.Project, services []string) error {
restartCtx, cancel := detachFromHTTPContextInternal(ctx, defaultComposeTimeout)
defer cancel()
@@ -48,7 +51,7 @@ func ComposeRestart(ctx context.Context, proj *types.Project, services []string)
return c.svc.Restart(restartCtx, proj.Name, api.RestartOptions{Project: proj, Services: services})
}
-func ComposeStop(ctx context.Context, proj *types.Project, services []string) error {
+func ComposeStop(ctx context.Context, proj *composetypes.Project, services []string) error {
if len(services) == 0 {
return nil
}
@@ -64,7 +67,12 @@ func ComposeStop(ctx context.Context, proj *types.Project, services []string) er
return c.svc.Stop(stopCtx, proj.Name, api.StopOptions{Services: services})
}
-func ComposeUp(ctx context.Context, proj *types.Project, services []string, removeOrphans bool, forceRecreate bool, recreateVolumes bool, authConfigs map[string]registry.AuthConfig, waitTimeout time.Duration) error {
+func ComposeUp(ctx context.Context, proj *composetypes.Project, services []string, removeOrphans bool, forceRecreate bool, recreateVolumes bool, authConfigs map[string]registry.AuthConfig, waitTimeout time.Duration) error {
+ selected, err := SelectServices(proj, services)
+ if err != nil {
+ return err
+ }
+ proj = selected
if waitTimeout <= 0 {
waitTimeout = timeouts.DefaultDeployWait
}
@@ -101,12 +109,12 @@ func ComposeUp(ctx context.Context, proj *types.Project, services []string, remo
}
defer func() { _ = c.Close() }()
- upOptions, startOptions := composeUpOptions(proj, services, removeOrphans, forceRecreate, waitTimeout, envOpts)
+ upOptions, startOptions := composeUpOptionsInternal(proj, services, removeOrphans, forceRecreate, waitTimeout, envOpts)
return c.svc.Up(composeCtx, proj, api.UpOptions{Create: upOptions, Start: startOptions})
}
-func composeUpOptions(proj *types.Project, services []string, removeOrphans bool, forceRecreate bool, waitTimeout time.Duration, envOpts ComposeEnvOptions) (api.CreateOptions, api.StartOptions) {
+func composeUpOptionsInternal(proj *composetypes.Project, services []string, removeOrphans bool, forceRecreate bool, waitTimeout time.Duration, envOpts ComposeEnvOptions) (api.CreateOptions, api.StartOptions) {
recreatePolicy := api.RecreateDiverged
if forceRecreate {
recreatePolicy = api.RecreateForce
@@ -137,7 +145,7 @@ func composeUpOptions(proj *types.Project, services []string, removeOrphans bool
// ComposePs lists a project's compose containers. dockerHost is the
// config-resolved docker host used to reuse the shared read-only compose
// client; empty falls back to a one-shot environment-resolved client.
-func ComposePs(ctx context.Context, dockerHost string, proj *types.Project, services []string, all bool) ([]api.ContainerSummary, error) {
+func ComposePs(ctx context.Context, dockerHost string, proj *composetypes.Project, services []string, all bool) ([]api.ContainerSummary, error) {
c, shared, err := plainComposeClientInternal(ctx, dockerHost)
if err != nil {
return nil, err
@@ -149,19 +157,24 @@ func ComposePs(ctx context.Context, dockerHost string, proj *types.Project, serv
return c.svc.Ps(ctx, proj.Name, api.PsOptions{All: all, Services: services})
}
-func ComposeGenerate(ctx context.Context, dockerHost, projectName string, containerIDs []string) (*types.Project, error) {
+func ComposeGenerate(ctx context.Context, dockerHost, projectName string, containerIDs []string) (string, error) {
c, shared, err := plainComposeClientInternal(ctx, dockerHost)
if err != nil {
- return nil, err
+ return "", err
}
if !shared {
defer func() { _ = c.Close() }()
}
- return c.svc.Generate(ctx, api.GenerateOptions{ProjectName: projectName, Containers: containerIDs})
+ model, err := c.svc.Generate(ctx, api.GenerateOptions{ProjectName: projectName, Containers: containerIDs})
+ if err != nil {
+ return "", err
+ }
+ content, err := model.MarshalYAML()
+ return string(content), err
}
-func ComposeDown(ctx context.Context, proj *types.Project, removeVolumes bool) error {
+func ComposeDown(ctx context.Context, proj *composetypes.Project, removeVolumes bool) error {
downCtx, cancel := detachFromHTTPContextInternal(ctx, defaultComposeTimeout)
defer cancel()
@@ -219,3 +232,72 @@ func ListGlobalComposeContainers(ctx context.Context, dockerClient client.APICli
return listResult.Items, nil
}
+
+// FindComposeServiceContainerID prefers a running service container over a stopped predecessor.
+func FindComposeServiceContainerID(ctx context.Context, dockerHost, projectName, serviceName string) (string, error) {
+ containers, err := ComposePs(ctx, dockerHost, &composetypes.Project{Name: projectName}, []string{serviceName}, true)
+ if err != nil {
+ return "", err
+ }
+ var firstMatch string
+ for _, c := range containers {
+ if c.Service != serviceName {
+ continue
+ }
+ if firstMatch == "" {
+ firstMatch = c.ID
+ }
+ if c.State == "running" {
+ return c.ID, nil
+ }
+ }
+ return firstMatch, nil
+}
+
+// FindComposeReplica matches a replacement by project, service, and its recorded replica number.
+func FindComposeReplica(containers []container.Summary, labels map[string]string) (container.Summary, bool) {
+ projectName := docker.ComposeProjectLabel(labels)
+ serviceName := docker.ComposeServiceLabel(labels)
+ if projectName == "" || serviceName == "" {
+ return container.Summary{}, false
+ }
+ number := strings.TrimSpace(labels[api.ContainerNumberLabel])
+ for _, candidate := range containers {
+ if docker.ComposeProjectLabel(candidate.Labels) != projectName || docker.ComposeServiceLabel(candidate.Labels) != serviceName {
+ continue
+ }
+ if number != "" && strings.TrimSpace(candidate.Labels[api.ContainerNumberLabel]) != number {
+ continue
+ }
+ return candidate, true
+ }
+ return container.Summary{}, false
+}
+
+// FormatPorts renders compose port publishers as "published:target/proto"
+// (or "target/proto" when the port is not published).
+func FormatPorts(publishers []api.PortPublisher) []string {
+ var ports []string
+ for _, pub := range publishers {
+ if pub.PublishedPort > 0 {
+ ports = append(ports, fmt.Sprintf("%d:%d/%s", pub.PublishedPort, pub.TargetPort, pub.Protocol))
+ } else {
+ ports = append(ports, fmt.Sprintf("%d/%s", pub.TargetPort, pub.Protocol))
+ }
+ }
+ return ports
+}
+
+// FormatDockerPorts renders container port summaries in the same shape as
+// FormatPorts, for containers Arcane sees outside a compose project.
+func FormatDockerPorts(ports []container.PortSummary) []string {
+ var res []string
+ for _, p := range ports {
+ if p.PublicPort == 0 {
+ res = append(res, fmt.Sprintf("%d/%s", p.PrivatePort, p.Type))
+ } else {
+ res = append(res, fmt.Sprintf("%d:%d/%s", p.PublicPort, p.PrivatePort, p.Type))
+ }
+ }
+ return res
+}
diff --git a/backend/pkg/projects/cmds_test.go b/backend/pkg/projects/cmds_test.go
index 29549af24..88235c3eb 100644
--- a/backend/pkg/projects/cmds_test.go
+++ b/backend/pkg/projects/cmds_test.go
@@ -12,7 +12,9 @@ import (
composetypes "github.com/compose-spec/compose-go/v2/types"
"github.com/docker/compose/v5/pkg/api"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
+ "github.com/moby/moby/api/types/container"
"github.com/moby/moby/client"
+ "github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -101,28 +103,28 @@ func TestComposeUpOptions_RemoveOrphans(t *testing.T) {
proj := &composetypes.Project{Name: "test"}
t.Run("removeOrphans true propagates to CreateOptions", func(t *testing.T) {
- upOptions, _ := composeUpOptions(proj, nil, true, false, 0, ComposeEnvOptions{})
+ upOptions, _ := composeUpOptionsInternal(proj, nil, true, false, 0, ComposeEnvOptions{})
require.True(t, upOptions.RemoveOrphans)
})
t.Run("removeOrphans false leaves CreateOptions disabled", func(t *testing.T) {
- upOptions, _ := composeUpOptions(proj, nil, false, false, 0, ComposeEnvOptions{})
+ upOptions, _ := composeUpOptionsInternal(proj, nil, false, false, 0, ComposeEnvOptions{})
require.False(t, upOptions.RemoveOrphans)
})
t.Run("removeOrphans is independent of forceRecreate", func(t *testing.T) {
// forceRecreate drives the Recreate policy, not RemoveOrphans.
- upOptions, _ := composeUpOptions(proj, nil, true, true, 0, ComposeEnvOptions{})
+ upOptions, _ := composeUpOptionsInternal(proj, nil, true, true, 0, ComposeEnvOptions{})
require.True(t, upOptions.RemoveOrphans)
require.Equal(t, api.RecreateForce, upOptions.Recreate)
- upOptions, _ = composeUpOptions(proj, nil, false, true, 0, ComposeEnvOptions{})
+ upOptions, _ = composeUpOptionsInternal(proj, nil, false, true, 0, ComposeEnvOptions{})
require.False(t, upOptions.RemoveOrphans)
require.Equal(t, api.RecreateForce, upOptions.Recreate)
})
t.Run("COMPOSE_REMOVE_ORPHANS / COMPOSE_IGNORE_ORPHANS propagate", func(t *testing.T) {
- upOptions, _ := composeUpOptions(proj, nil, false, false, 0, ComposeEnvOptions{RemoveOrphans: true, IgnoreOrphans: true})
+ upOptions, _ := composeUpOptionsInternal(proj, nil, false, false, 0, ComposeEnvOptions{RemoveOrphans: true, IgnoreOrphans: true})
require.True(t, upOptions.RemoveOrphans)
require.True(t, upOptions.IgnoreOrphans)
})
@@ -154,3 +156,38 @@ func TestListGlobalComposeContainersUsesProvidedClient(t *testing.T) {
require.Len(t, containers, 1)
require.Equal(t, "abc123", containers[0].ID)
}
+
+func TestFormatDockerPorts(t *testing.T) {
+ tests := []struct {
+ name string
+ input []container.PortSummary
+ expected []string
+ }{
+ {
+ name: "public port",
+ input: []container.PortSummary{
+ {PublicPort: 8080, PrivatePort: 80, Type: "tcp"},
+ },
+ expected: []string{"8080:80/tcp"},
+ },
+ {
+ name: "private only",
+ input: []container.PortSummary{
+ {PrivatePort: 80, Type: "tcp"},
+ },
+ expected: []string{"80/tcp"},
+ },
+ {
+ name: "empty",
+ input: []container.PortSummary{},
+ expected: nil,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ got := FormatDockerPorts(tt.input)
+ assert.Equal(t, tt.expected, got)
+ })
+ }
+}
diff --git a/backend/pkg/projects/compose_env.go b/backend/pkg/projects/compose_env.go
deleted file mode 100644
index 188f87d6d..000000000
--- a/backend/pkg/projects/compose_env.go
+++ /dev/null
@@ -1,253 +0,0 @@
-package projects
-
-import (
- "context"
- "log/slog"
- "maps"
- "os"
- "path/filepath"
- "strconv"
- "strings"
-
- "emperror.dev/errors"
-
- "github.com/compose-spec/compose-go/v2/consts"
- "github.com/getarcaneapp/arcane/backend/v2/internal/common"
-)
-
-// Docker Compose pre-defined variable names that compose-go's consts package
-// does not export. See https://docs.docker.com/compose/how-tos/environment-variables/envvars.
-const (
- composeEnvFilesKey = "COMPOSE_ENV_FILES"
- composeRemoveOrphansKey = "COMPOSE_REMOVE_ORPHANS"
- composeIgnoreOrphansKey = "COMPOSE_IGNORE_ORPHANS"
- composeParallelLimitKey = "COMPOSE_PARALLEL_LIMIT"
-
- defaultComposePathSeparator = ":"
-)
-
-// ComposeEnvOptions holds the deployment-relevant Docker Compose pre-defined
-// environment variables parsed from a project's merged environment.
-type ComposeEnvOptions struct {
- // ConfigFiles is the resolved, absolute COMPOSE_FILE selection in order (the
- // first entry is the base file). Nil when COMPOSE_FILE is unset.
- ConfigFiles []string
- // Profiles is the COMPOSE_PROFILES selection.
- Profiles []string
- // ProjectName is COMPOSE_PROJECT_NAME (not normalized).
- ProjectName string
- // EnvFiles is the resolved, absolute COMPOSE_ENV_FILES selection in order.
- EnvFiles []string
- // RemoveOrphans is COMPOSE_REMOVE_ORPHANS.
- RemoveOrphans bool
- // IgnoreOrphans is COMPOSE_IGNORE_ORPHANS.
- IgnoreOrphans bool
- // ParallelLimit is COMPOSE_PARALLEL_LIMIT; 0 means unset.
- ParallelLimit int
-}
-
-// ParseComposeEnvOptions extracts the deployment-relevant COMPOSE_* variables
-// from an already-merged environment map. Malformed path selections return a
-// classified common.ErrComposeFileEnvInvalid; malformed scalars are ignored
-// with a debug log, matching `docker compose`'s tolerance.
-func ParseComposeEnvOptions(workdir string, env EnvMap) (ComposeEnvOptions, error) {
- opts := ComposeEnvOptions{
- ProjectName: strings.TrimSpace(env[consts.ComposeProjectName]),
- }
-
- files, err := resolveComposeFileSelectionInternal(workdir, env)
- if err != nil {
- return ComposeEnvOptions{}, err
- }
- opts.ConfigFiles = files
-
- if raw := strings.TrimSpace(env[consts.ComposeProfiles]); raw != "" {
- opts.Profiles = splitAndTrimInternal(raw, ",")
- }
-
- for _, entry := range ComposeEnvFileEntriesFromEnv(env) {
- resolved, resErr := ResolvePathWithinDir(workdir, entry)
- if resErr != nil {
- return ComposeEnvOptions{}, common.Classify(common.ErrComposeFileEnvInvalid, errors.WrapIff(resErr, "COMPOSE_ENV_FILES entry %q", entry))
- }
- opts.EnvFiles = append(opts.EnvFiles, resolved)
- }
-
- opts.RemoveOrphans = parseComposeBoolInternal(env, composeRemoveOrphansKey)
- opts.IgnoreOrphans = parseComposeBoolInternal(env, composeIgnoreOrphansKey)
-
- if raw := strings.TrimSpace(env[composeParallelLimitKey]); raw != "" {
- if n, convErr := strconv.Atoi(raw); convErr == nil && n > 0 {
- opts.ParallelLimit = n
- } else {
- slog.Debug("ignoring invalid COMPOSE_PARALLEL_LIMIT", "value", raw)
- }
- }
-
- return opts, nil
-}
-
-// ComposeFileEnvSelection resolves the COMPOSE_FILE selection for dir with the
-// same layering EnvLoader.LoadEnvironment uses at deployment: .env.global from
-// projectsDir first, the project .env on top, then any COMPOSE_ENV_FILES
-// entries. Returns nil when the merged environment does not set COMPOSE_FILE.
-// COMPOSE_DISABLE_ENV_FILE (declared in .env.global) skips the project .env, as
-// `docker compose` does; a global COMPOSE_FILE still applies. An empty
-// projectsDir skips the global layer.
-func ComposeFileEnvSelection(ctx context.Context, projectsDir, dir string) ([]string, error) {
- envMap := make(EnvMap)
- if strings.TrimSpace(projectsDir) != "" {
- globalEnv, err := ParseProjectEnvFile(filepath.Join(projectsDir, GlobalEnvFileName), envMap)
- if err != nil {
- return nil, err
- }
- maps.Copy(envMap, globalEnv)
- }
-
- // COMPOSE_DISABLE_ENV_FILE skips the project .env; it is read only from the
- // sources merged so far (.env.global), matching LoadEnvironment.
- if !parseComposeBoolInternal(envMap, consts.ComposeDisableDefaultEnvFile) {
- projectEnv, err := ParseProjectEnvFile(filepath.Join(dir, EffectiveEnvFileName), envMap)
- if err != nil {
- return nil, err
- }
- maps.Copy(envMap, projectEnv)
- }
- if len(envMap) == 0 {
- return nil, nil
- }
- mergeComposeEnvFilesInternal(ctx, dir, envMap, ParseProjectEnvFile, nil)
- return resolveComposeFileSelectionInternal(dir, envMap)
-}
-
-// ComposeFileEntriesFromEnv returns the raw COMPOSE_FILE entries declared in env
-// (split on COMPOSE_PATH_SEPARATOR, ":" by default), or nil when unset. Entries
-// are not resolved, validated, or stat'd.
-func ComposeFileEntriesFromEnv(env EnvMap) []string {
- raw, ok := env[consts.ComposeFilePath]
- if !ok || strings.TrimSpace(raw) == "" {
- return nil
- }
-
- separator := defaultComposePathSeparator
- if custom := strings.TrimSpace(env[consts.ComposePathSeparator]); custom != "" {
- separator = custom
- }
-
- return splitAndTrimInternal(raw, separator)
-}
-
-// ComposeEnvFileEntriesFromEnv returns the raw COMPOSE_ENV_FILES entries
-// declared in env (comma-separated), or nil when unset. Entries are not
-// resolved, validated, or stat'd.
-func ComposeEnvFileEntriesFromEnv(env EnvMap) []string {
- raw := strings.TrimSpace(env[composeEnvFilesKey])
- if raw == "" {
- return nil
- }
- return splitAndTrimInternal(raw, ",")
-}
-
-// resolveComposeFileSelectionInternal parses COMPOSE_FILE from env into an
-// ordered list of absolute compose-file paths, or nil when COMPOSE_FILE is
-// unset. Every entry must be a relative path to an existing file within
-// workdir; the first entry (the base file) must sit directly in workdir.
-func resolveComposeFileSelectionInternal(workdir string, env EnvMap) ([]string, error) {
- entries := ComposeFileEntriesFromEnv(env)
- if len(entries) == 0 {
- return nil, nil
- }
-
- absWorkdir, err := filepath.Abs(filepath.Clean(workdir))
- if err != nil {
- return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.WrapIf(err, "resolve project directory"))
- }
-
- files := make([]string, 0, len(entries))
- for i, entry := range entries {
- if filepath.IsAbs(entry) {
- return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.Errorf("COMPOSE_FILE entry %q must be relative to the project directory", entry))
- }
-
- resolved, resErr := ResolvePathWithinDir(absWorkdir, entry)
- if resErr != nil {
- return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.WrapIff(resErr, "COMPOSE_FILE entry %q", entry))
- }
-
- if i == 0 && filepath.Dir(resolved) != absWorkdir {
- return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.Errorf("the first COMPOSE_FILE entry %q must be in the project directory", entry))
- }
-
- // os.Stat rather than acfs: compose files may be symlinks resolving
- // outside any confinement root, and workdir can be an imported project
- // living outside the projects directory.
- info, statErr := os.Stat(resolved)
- if statErr != nil {
- return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.WrapIff(statErr, "COMPOSE_FILE entry %q", entry))
- }
- if info.IsDir() {
- return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.Errorf("COMPOSE_FILE entry %q is a directory", entry))
- }
-
- files = append(files, resolved)
- }
-
- return files, nil
-}
-
-// mergeComposeEnvFilesInternal merges each COMPOSE_ENV_FILES entry (in order,
-// later wins) on top of envMap; bad entries are warned and skipped. Unlike
-// `docker compose`, the entries are additive on top of the project .env rather
-// than a replacement: .env is Arcane's managed effective env file and the place
-// COMPOSE_ENV_FILES itself is declared, so replacing it would be self-defeating.
-func mergeComposeEnvFilesInternal(ctx context.Context, workdir string, envMap EnvMap, parse func(path string, contextEnv EnvMap) (EnvMap, error), onMerged func(values EnvMap)) {
- for _, entry := range ComposeEnvFileEntriesFromEnv(envMap) {
- resolved, err := ResolvePathWithinDir(workdir, entry)
- if err != nil {
- slog.WarnContext(ctx, "skipping COMPOSE_ENV_FILES entry outside project directory", "entry", entry, "error", err)
- continue
- }
- // os.Stat rather than acfs: env files may be symlinks resolving outside
- // any confinement root (a supported setup).
- if _, statErr := os.Stat(resolved); statErr != nil {
- slog.WarnContext(ctx, "COMPOSE_ENV_FILES entry not found", "path", resolved, "error", statErr)
- continue
- }
- values, err := parse(resolved, envMap)
- if err != nil {
- slog.WarnContext(ctx, "failed to load COMPOSE_ENV_FILES entry", "path", resolved, "error", err)
- continue
- }
- if len(values) == 0 {
- continue
- }
- maps.Copy(envMap, values)
- if onMerged != nil {
- onMerged(values)
- }
- }
-}
-
-func splitAndTrimInternal(raw, sep string) []string {
- parts := strings.Split(raw, sep)
- out := make([]string, 0, len(parts))
- for _, p := range parts {
- if trimmed := strings.TrimSpace(p); trimmed != "" {
- out = append(out, trimmed)
- }
- }
- return out
-}
-
-func parseComposeBoolInternal(env EnvMap, key string) bool {
- raw := strings.TrimSpace(env[key])
- if raw == "" {
- return false
- }
- v, err := strconv.ParseBool(raw)
- if err != nil {
- slog.Debug("ignoring invalid compose boolean env var", "key", key, "value", raw)
- return false
- }
- return v
-}
diff --git a/backend/pkg/projects/compose_env_test.go b/backend/pkg/projects/compose_env_test.go
deleted file mode 100644
index c78170f85..000000000
--- a/backend/pkg/projects/compose_env_test.go
+++ /dev/null
@@ -1,185 +0,0 @@
-package projects
-
-import (
- "os"
- "path/filepath"
- "testing"
-
- "emperror.dev/errors"
-
- "github.com/getarcaneapp/arcane/backend/v2/internal/common"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestParseComposeEnvOptions(t *testing.T) {
- t.Parallel()
-
- dir := t.TempDir()
- require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
- require.NoError(t, os.MkdirAll(filepath.Join(dir, "sub"), 0o755))
- require.NoError(t, os.WriteFile(filepath.Join(dir, "sub", "extra.yml"), []byte("services: {}\n"), 0o600))
-
- t.Run("scalars, profiles split, and custom separator", func(t *testing.T) {
- t.Parallel()
- env := EnvMap{
- "COMPOSE_FILE": "base.yml;sub/extra.yml",
- "COMPOSE_PATH_SEPARATOR": ";",
- "COMPOSE_PROFILES": "frontend, debug",
- "COMPOSE_PROJECT_NAME": "myproj",
- "COMPOSE_REMOVE_ORPHANS": "true",
- "COMPOSE_IGNORE_ORPHANS": "1",
- "COMPOSE_PARALLEL_LIMIT": "4",
- }
-
- opts, err := ParseComposeEnvOptions(dir, env)
- require.NoError(t, err)
- assert.Equal(t, []string{filepath.Join(dir, "base.yml"), filepath.Join(dir, "sub", "extra.yml")}, opts.ConfigFiles)
- assert.Equal(t, []string{"frontend", "debug"}, opts.Profiles)
- assert.Equal(t, "myproj", opts.ProjectName)
- assert.True(t, opts.RemoveOrphans)
- assert.True(t, opts.IgnoreOrphans)
- assert.Equal(t, 4, opts.ParallelLimit)
- })
-
- t.Run("invalid scalars are ignored", func(t *testing.T) {
- t.Parallel()
- opts, err := ParseComposeEnvOptions(dir, EnvMap{
- "COMPOSE_REMOVE_ORPHANS": "nope",
- "COMPOSE_PARALLEL_LIMIT": "-3",
- })
- require.NoError(t, err)
- assert.False(t, opts.RemoveOrphans)
- assert.Zero(t, opts.ParallelLimit)
- })
-
- t.Run("COMPOSE_ENV_FILES resolved in order, traversal rejected", func(t *testing.T) {
- t.Parallel()
- opts, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_ENV_FILES": "sub/extra.env, .env.local"})
- require.NoError(t, err)
- assert.Equal(t, []string{filepath.Join(dir, "sub", "extra.env"), filepath.Join(dir, ".env.local")}, opts.EnvFiles)
-
- _, err = ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_ENV_FILES": "../outside.env"})
- require.Error(t, err)
- assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
- })
-
- t.Run("absolute entry rejected", func(t *testing.T) {
- t.Parallel()
- _, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_FILE": filepath.Join(dir, "base.yml")})
- require.Error(t, err)
- assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
- })
-
- t.Run("escaping entry rejected", func(t *testing.T) {
- t.Parallel()
- _, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_FILE": "../base.yml"})
- require.Error(t, err)
- assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
- })
-
- t.Run("non-root first entry rejected", func(t *testing.T) {
- t.Parallel()
- _, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_FILE": "sub/extra.yml:base.yml"})
- require.Error(t, err)
- assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
- })
-
- t.Run("missing entry rejected", func(t *testing.T) {
- t.Parallel()
- _, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_FILE": "base.yml:sub/missing.yml"})
- require.Error(t, err)
- assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
- })
-}
-
-func TestComposeFileEnvSelection(t *testing.T) {
- t.Parallel()
-
- t.Run("nil when no .env", func(t *testing.T) {
- t.Parallel()
- files, err := ComposeFileEnvSelection(t.Context(), "", t.TempDir())
- require.NoError(t, err)
- assert.Nil(t, files)
- })
-
- t.Run("resolves COMPOSE_FILE from .env", func(t *testing.T) {
- t.Parallel()
- dir := t.TempDir()
- require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, "extra.yml"), []byte("services: {}\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=base.yml:extra.yml\n"), 0o600))
-
- files, err := ComposeFileEnvSelection(t.Context(), "", dir)
- require.NoError(t, err)
- assert.Equal(t, []string{filepath.Join(dir, "base.yml"), filepath.Join(dir, "extra.yml")}, files)
- })
-
- t.Run("resolves COMPOSE_FILE from COMPOSE_ENV_FILES entry", func(t *testing.T) {
- t.Parallel()
- dir := t.TempDir()
- require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, "aux.env"), []byte("COMPOSE_FILE=base.yml\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_ENV_FILES=aux.env\n"), 0o600))
-
- files, err := ComposeFileEnvSelection(t.Context(), "", dir)
- require.NoError(t, err)
- assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
- })
-
- t.Run("global COMPOSE_DISABLE_ENV_FILE skips project .env", func(t *testing.T) {
- t.Parallel()
- projectsDir := t.TempDir()
- dir := filepath.Join(projectsDir, "proj")
- require.NoError(t, os.MkdirAll(dir, 0o755))
- require.NoError(t, os.WriteFile(filepath.Join(projectsDir, GlobalEnvFileName), []byte("COMPOSE_DISABLE_ENV_FILE=true\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=base.yml\n"), 0o600))
-
- files, err := ComposeFileEnvSelection(t.Context(), projectsDir, dir)
- require.NoError(t, err)
- assert.Nil(t, files)
- })
-
- t.Run("global COMPOSE_FILE selects the base when the project .env is silent", func(t *testing.T) {
- t.Parallel()
- projectsDir := t.TempDir()
- dir := filepath.Join(projectsDir, "proj")
- require.NoError(t, os.MkdirAll(dir, 0o755))
- require.NoError(t, os.WriteFile(filepath.Join(projectsDir, GlobalEnvFileName), []byte("COMPOSE_FILE=base.yml\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
-
- files, err := ComposeFileEnvSelection(t.Context(), projectsDir, dir)
- require.NoError(t, err)
- assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
- })
-
- t.Run("project .env COMPOSE_FILE overrides the global value", func(t *testing.T) {
- t.Parallel()
- projectsDir := t.TempDir()
- dir := filepath.Join(projectsDir, "proj")
- require.NoError(t, os.MkdirAll(dir, 0o755))
- require.NoError(t, os.WriteFile(filepath.Join(projectsDir, GlobalEnvFileName), []byte("COMPOSE_FILE=global.yml\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, "global.yml"), []byte("services: {}\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=base.yml\n"), 0o600))
-
- files, err := ComposeFileEnvSelection(t.Context(), projectsDir, dir)
- require.NoError(t, err)
- assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
- })
-
- t.Run("COMPOSE_DISABLE_ENV_FILE still honors a global COMPOSE_FILE", func(t *testing.T) {
- t.Parallel()
- projectsDir := t.TempDir()
- dir := filepath.Join(projectsDir, "proj")
- require.NoError(t, os.MkdirAll(dir, 0o755))
- require.NoError(t, os.WriteFile(filepath.Join(projectsDir, GlobalEnvFileName), []byte("COMPOSE_DISABLE_ENV_FILE=true\nCOMPOSE_FILE=base.yml\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
- require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=other.yml\n"), 0o600))
-
- files, err := ComposeFileEnvSelection(t.Context(), projectsDir, dir)
- require.NoError(t, err)
- assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
- })
-}
diff --git a/backend/pkg/projects/compose_override.go b/backend/pkg/projects/compose_override.go
deleted file mode 100644
index 247608ea4..000000000
--- a/backend/pkg/projects/compose_override.go
+++ /dev/null
@@ -1,183 +0,0 @@
-package projects
-
-import (
- "context"
- "log/slog"
- "os"
- "path/filepath"
- "slices"
- "strings"
-
- "emperror.dev/errors"
-
- "github.com/compose-spec/compose-go/v2/cli"
-)
-
-// composeOverrideFileCandidates lists supported compose override filenames in
-// detection order, sourced from compose-go.
-var composeOverrideFileCandidates = slices.Clone(cli.DefaultOverrideFileNames)
-
-// DefaultComposeOverrideFileName is the override filename Arcane writes when a
-// project gains an override but has none on disk. It is deliberately
-// composeOverrideFileCandidates[1] ("compose.override.yaml"), NOT [0]
-// ("compose.override.yml"), so the default override extension matches Arcane's
-// ".yaml" base default (DefaultComposeFileName = "compose.yaml"). Do not "fix"
-// this to [0]: `docker compose` has no preference between the two, and keeping
-// ".yaml" avoids a mismatched base/override extension pair.
-const DefaultComposeOverrideFileName = "compose.override.yaml"
-
-// ComposeOverrideFileCandidates returns the supported compose override filenames
-// in detection order. A copy is returned so callers can't mutate package state.
-func ComposeOverrideFileCandidates() []string {
- return slices.Clone(composeOverrideFileCandidates)
-}
-
-// findComposeOverrideCandidatesInternal returns every supported override
-// candidate name for which exists reports true, in compose-go preference order.
-// It is the single primitive behind both filesystem discovery
-// (DetectComposeOverrideFile) and non-filesystem discovery
-// (ResolveComposeOverride), so the two can never drift in preference order.
-func findComposeOverrideCandidatesInternal(exists func(name string) bool) []string {
- found := make([]string, 0, 1)
- for _, name := range composeOverrideFileCandidates {
- if exists(name) {
- found = append(found, name)
- }
- }
- return found
-}
-
-// warnOnMultipleComposeOverridesInternal mirrors compose-go: when more than one
-// override candidate is present it logs which candidates were found and which
-// highest-preference match will be used.
-func warnOnMultipleComposeOverridesInternal(found []string) {
- if len(found) > 1 {
- slog.Warn("multiple compose override files found; using highest-preference match",
- "using", found[0], "found", found)
- }
-}
-
-// DetectComposeOverrideFile returns the path to the highest-preference compose
-// override file present in dir, following compose-go's preference order, or ""
-// when none exists. When multiple override files are present it returns the
-// highest-preference match and logs a warning, mirroring compose-go behavior.
-func DetectComposeOverrideFile(dir string) string {
- // Stays on os.*: override files may be symlinks resolving outside any
- // confinement root (same class as #3556 includes), which acfs cannot follow.
- found := findComposeOverrideCandidatesInternal(func(name string) bool {
- info, err := os.Stat(filepath.Join(dir, name))
- return err == nil && !info.IsDir()
- })
- if len(found) == 0 {
- return ""
- }
- warnOnMultipleComposeOverridesInternal(found)
- return filepath.Join(dir, found[0])
-}
-
-// ReadComposeOverrideContent returns the content of the highest-preference
-// compose override file present in dir, or "" when none exists or it cannot be
-// read. It is a best-effort read intended for change detection.
-func ReadComposeOverrideContent(dir string) string {
- overridePath := DetectComposeOverrideFile(dir)
- if overridePath == "" {
- return ""
- }
- content, err := os.ReadFile(overridePath)
- if err != nil {
- return ""
- }
- return string(content)
-}
-
-// ResolveComposeOverride finds the highest-preference compose override file among
-// the supported candidates using the exists probe, then loads it via read. It
-// centralizes override discovery so non-filesystem sources (e.g. a Git working
-// tree accessed through a validated client) reuse the same preference order.
-// When multiple candidates exist it warns and uses the highest-preference match,
-// mirroring DetectComposeOverrideFile. found is false (with empty name/content)
-// when no candidate exists.
-func ResolveComposeOverride(exists func(name string) bool, read func(name string) (string, error)) (fileName string, content string, found bool, err error) {
- matches := findComposeOverrideCandidatesInternal(exists)
- if len(matches) == 0 {
- return "", "", false, nil
- }
- warnOnMultipleComposeOverridesInternal(matches)
- name := matches[0]
- c, readErr := read(name)
- if readErr != nil {
- return "", "", false, readErr
- }
- return name, c, true, nil
-}
-
-// WriteComposeOverrideFile writes content as the override file named fileName in
-// dir when content is non-nil, and removes every other override candidate so a
-// renamed or deleted override never leaves a stale copy behind. When content is
-// nil, all supported override files are removed. projectsRoot bounds writes to
-// prevent path traversal.
-func WriteComposeOverrideFile(ctx context.Context, projectsRoot, dir string, content *string, fileName string) error {
- keep := ""
- if content != nil {
- keep = strings.TrimSpace(fileName)
- if keep == "" {
- return errors.New("missing override file name")
- }
- if err := WriteProjectFile(ctx, projectsRoot, dir, keep, *content); err != nil {
- return err
- }
- }
-
- // Remove stale override files: deleted from the source, or renamed to a
- // different candidate name than the one currently written.
- for _, candidate := range composeOverrideFileCandidates {
- if candidate == keep {
- continue
- }
- if err := RemoveProjectFile(ctx, projectsRoot, dir, candidate); err != nil {
- return err
- }
- }
-
- return nil
-}
-
-// ExistingOrDefaultOverrideName returns the override file name already present
-// in dir, falling back to DefaultComposeOverrideFileName.
-func ExistingOrDefaultOverrideName(dir string) string {
- if overridePath := DetectComposeOverrideFile(dir); overridePath != "" {
- return filepath.Base(overridePath)
- }
- return DefaultComposeOverrideFileName
-}
-
-// ResolveEffectiveOverrideForValidation resolves the override content compose
-// validation should see: the on-disk override when the caller supplied none,
-// nothing when the caller explicitly blanked it, otherwise the caller's content.
-func ResolveEffectiveOverrideForValidation(dir string, overrideContent *string) (*string, string) {
- switch {
- case overrideContent == nil:
- overridePath := DetectComposeOverrideFile(dir)
- if overridePath == "" {
- return nil, ""
- }
- onDisk := ReadComposeOverrideContent(dir)
- return &onDisk, filepath.Base(overridePath)
- case strings.TrimSpace(*overrideContent) == "":
- return nil, ""
- default:
- return overrideContent, ExistingOrDefaultOverrideName(dir)
- }
-}
-
-// ApplyOverrideFileChange writes, clears, or leaves the override file alone
-// depending on whether overrideContent is nil, blank, or set.
-func ApplyOverrideFileChange(ctx context.Context, projectsRoot, dir string, overrideContent *string) error {
- if overrideContent == nil {
- return nil
- }
- if strings.TrimSpace(*overrideContent) == "" {
- return WriteComposeOverrideFile(ctx, projectsRoot, dir, nil, "")
- }
- return WriteComposeOverrideFile(ctx, projectsRoot, dir, overrideContent, ExistingOrDefaultOverrideName(dir))
-}
diff --git a/backend/pkg/projects/compose_override_test.go b/backend/pkg/projects/compose_override_test.go
deleted file mode 100644
index 04724a294..000000000
--- a/backend/pkg/projects/compose_override_test.go
+++ /dev/null
@@ -1,91 +0,0 @@
-package projects
-
-import (
- "errors"
- "os"
- "path/filepath"
- "testing"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestReadComposeOverrideContent(t *testing.T) {
- t.Parallel()
-
- dir := t.TempDir()
- assert.Empty(t, ReadComposeOverrideContent(dir))
-
- content := "services:\n app:\n image: busybox:latest\n"
- require.NoError(t, os.WriteFile(filepath.Join(dir, "compose.override.yaml"), []byte(content), 0o600))
- assert.Equal(t, content, ReadComposeOverrideContent(dir))
-}
-
-func TestResolveComposeOverride(t *testing.T) {
- t.Parallel()
-
- t.Run("returns highest-preference match", func(t *testing.T) {
- t.Parallel()
- available := map[string]string{
- "compose.override.yml": "first\n",
- "docker-compose.override.yaml": "second\n",
- }
- name, content, found, err := ResolveComposeOverride(
- func(n string) bool { _, ok := available[n]; return ok },
- func(n string) (string, error) { return available[n], nil },
- )
- require.NoError(t, err)
- require.True(t, found)
- // compose.override.yml precedes docker-compose.override.yaml in compose-go order.
- assert.Equal(t, "compose.override.yml", name)
- assert.Equal(t, "first\n", content)
- })
-
- t.Run("returns not found when nothing exists", func(t *testing.T) {
- t.Parallel()
- name, content, found, err := ResolveComposeOverride(
- func(string) bool { return false },
- func(string) (string, error) { return "", nil },
- )
- require.NoError(t, err)
- assert.False(t, found)
- assert.Empty(t, name)
- assert.Empty(t, content)
- })
-
- t.Run("propagates read error", func(t *testing.T) {
- t.Parallel()
- _, _, found, err := ResolveComposeOverride(
- func(string) bool { return true },
- func(string) (string, error) { return "", errors.New("boom") },
- )
- require.Error(t, err)
- assert.False(t, found)
- })
-}
-
-func TestWriteComposeOverrideFile(t *testing.T) {
- t.Parallel()
-
- root := t.TempDir()
- dir := filepath.Join(root, "proj")
- require.NoError(t, os.MkdirAll(dir, 0o755))
-
- // A stale override under a different candidate name should be cleaned up.
- require.NoError(t, os.WriteFile(filepath.Join(dir, "docker-compose.override.yml"), []byte("stale\n"), 0o600))
-
- content := "services:\n app:\n image: busybox:latest\n"
- require.NoError(t, WriteComposeOverrideFile(t.Context(), root, dir, &content, "compose.override.yaml"))
-
- written, err := os.ReadFile(filepath.Join(dir, "compose.override.yaml"))
- require.NoError(t, err)
- assert.Equal(t, content, string(written))
-
- _, statErr := os.Stat(filepath.Join(dir, "docker-compose.override.yml"))
- assert.True(t, os.IsNotExist(statErr))
-
- // Nil content removes all override files.
- require.NoError(t, WriteComposeOverrideFile(t.Context(), root, dir, nil, ""))
- _, statErr = os.Stat(filepath.Join(dir, "compose.override.yaml"))
- assert.True(t, os.IsNotExist(statErr))
-}
diff --git a/backend/pkg/projects/container_mounts.go b/backend/pkg/projects/container_mounts.go
deleted file mode 100644
index 08da6b57a..000000000
--- a/backend/pkg/projects/container_mounts.go
+++ /dev/null
@@ -1,60 +0,0 @@
-package projects
-
-import (
- "context"
- "strings"
-
- mounttypes "github.com/moby/moby/api/types/mount"
- "github.com/moby/moby/client"
-
- "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane"
-)
-
-// GetCurrentContainerMounts inspects Arcane's own container and returns its bind and
-// named-volume mounts as HostMount entries. It returns no mounts when Arcane is
-// not running in a container (or the daemon is unreachable). This is the basis for
-// Docker-in-Docker host-path resolution.
-func GetCurrentContainerMounts(ctx context.Context, dockerCli *client.Client) ([]HostMount, error) {
- if dockerCli == nil {
- return nil, nil // No docker client, can't discover
- }
-
- // Label-fallback detection matters here: with network_mode: service:<sidecar>
- // the hostname identifies the sidecar, whose mounts do not include
- // docker.sock — breaking host-path resolution for the self-upgrader (#3544).
- inspect, err := libarcane.InspectCurrentArcaneContainer(ctx, dockerCli)
- if err != nil {
- // Not running in a container or can't reach docker daemon
- return nil, err
- }
-
- mounts := make([]HostMount, 0, len(inspect.Mounts))
- for i := range inspect.Mounts {
- m := &inspect.Mounts[i]
- if m.Type != mounttypes.TypeBind && m.Type != mounttypes.TypeVolume {
- continue
- }
- if strings.TrimSpace(m.Source) == "" || strings.TrimSpace(m.Destination) == "" {
- continue
- }
- mounts = append(mounts, HostMount{Destination: m.Destination, Source: m.Source})
- }
- return mounts, nil
-}
-
-// GetHostPathForContainerPath attempts to discover the host-side path for a given container path
-// by inspecting the container itself. This is useful for Docker-in-Docker scenarios
-// where the application needs to know host paths for volume mapping. It returns an empty
-// string when the path is not covered by any of Arcane's mounts.
-func GetHostPathForContainerPath(ctx context.Context, dockerCli *client.Client, containerPath string) (string, error) {
- mounts, err := GetCurrentContainerMounts(ctx, dockerCli)
- if err != nil {
- return "", err
- }
-
- if host, ok := ResolveHostPath(mounts, containerPath).Get(); ok {
- return host, nil
- }
-
- return "", nil
-}
diff --git a/backend/pkg/projects/coordinator.go b/backend/pkg/projects/coordinator.go
new file mode 100644
index 000000000..1ac9d9fde
--- /dev/null
+++ b/backend/pkg/projects/coordinator.go
@@ -0,0 +1,456 @@
+package projects
+
+import (
+ "context"
+ "io"
+ "log/slog"
+ "strings"
+ "time"
+
+ "emperror.dev/errors"
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/docker/compose/v5/pkg/api"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+)
+
+type composeCoordinatorInternal struct {
+ commands projecttypes.ComposeCommands
+}
+
+// NewCoordinator owns Compose workflow sequencing using the configured SDK commands.
+func NewCoordinator(commands projecttypes.ComposeCommands) projecttypes.ComposeCoordinator {
+ if commands.Stop == nil {
+ commands.Stop = ComposeStop
+ }
+ if commands.Up == nil {
+ commands.Up = ComposeUp
+ }
+ return &composeCoordinatorInternal{commands: commands}
+}
+
+// Deploy runs hooks before loading, prepares images, then reconciles the project.
+func (c *composeCoordinatorInternal) Deploy(ctx context.Context, request projecttypes.ComposeDeployment) (_ *composetypes.Project, err error) {
+ defer func() {
+ if err != nil && request.Recover != nil {
+ request.Recover(ctx)
+ }
+ }()
+ if request.PreDeploy != nil {
+ if err := request.PreDeploy(ctx); err != nil {
+ return nil, errors.WrapIf(err, "pre-deploy lifecycle hook failed")
+ }
+ }
+ model, err := request.Load(ctx)
+ if err != nil {
+ return nil, errors.WrapIff(err, "failed to load compose project in %s", request.ProjectPath)
+ }
+ operations, err := request.ResolveImages(ctx)
+ if err != nil {
+ return nil, errors.WrapIf(err, "resolve registry credentials")
+ }
+ pullPolicy := ""
+ forceRecreate, recreateVolumes := false, false
+ if request.Options != nil {
+ pullPolicy = NormalizeDeployPullPolicy(request.Options.PullPolicy)
+ forceRecreate, recreateVolumes = request.Options.ForceRecreate, request.Options.RecreateVolumes
+ }
+ if pullPolicy == "" {
+ pullPolicy = NormalizeDeployPullPolicy(request.DefaultPullPolicy)
+ }
+ if pullPolicy == "" {
+ pullPolicy = "missing"
+ }
+ if err := c.PrepareImagesForDeploy(ctx, request.ProjectID, model, request.Progress, operations, pullPolicy); err != nil {
+ return nil, errors.WrapIf(err, "failed to prepare project images for deploy")
+ }
+ removeOrphans := ResolveRemoveOrphans(request.GitOpsManaged, request.Options)
+ slog.InfoContext(ctx, "starting compose up with health check support", "projectID", request.ProjectID, "projectName", model.Name, "services", len(model.Services), "removeOrphans", removeOrphans)
+ if err := c.commands.Up(ctx, model, nil, removeOrphans, forceRecreate, recreateVolumes, request.AuthConfigs, request.WaitTimeout); err != nil {
+ slog.ErrorContext(ctx, "compose up failed", "projectName", model.Name, "projectID", request.ProjectID, "error", err)
+ if strings.Contains(err.Error(), "timeout") || strings.Contains(err.Error(), "context deadline exceeded") {
+ return nil, errors.WrapIf(err, "deployment timed out waiting for services - long-running 'service_healthy'/'service_completed_successfully' dependencies may need a higher Deploy Wait Timeout setting, and 'service_healthy' requires a healthcheck")
+ }
+ return nil, errors.WrapIf(err, "failed to deploy project")
+ }
+ slog.InfoContext(ctx, "compose up completed successfully", "projectID", request.ProjectID, "projectName", model.Name)
+ return model, nil
+}
+
+// ResolveRemoveOrphans preserves GitOps reconciliation and explicit caller opt-in.
+func ResolveRemoveOrphans(gitOpsManaged bool, options *projecttypes.DeployOptions) bool {
+ return gitOpsManaged || (options != nil && options.RemoveOrphans)
+}
+
+// UpdateServices validates scope before pulling or stopping any service.
+func (c *composeCoordinatorInternal) UpdateServices(ctx context.Context, request projecttypes.ComposeServiceUpdate) error {
+ selected, err := SelectServices(request.Project, request.Services)
+ if err != nil {
+ if request.RestoreBeforeMutation != nil {
+ request.RestoreBeforeMutation(ctx)
+ }
+ return err
+ }
+ if err := c.PullServices(ctx, selected, request.Services, request.Images, request.Progress); err != nil {
+ if request.RestoreBeforeMutation != nil {
+ request.RestoreBeforeMutation(ctx)
+ }
+ return errors.WrapIf(err, "pull updated service images")
+ }
+ if err := c.commands.Stop(ctx, selected, request.Services); err != nil {
+ slog.WarnContext(ctx, "compose stop failed, continuing", "error", err)
+ }
+ if err := c.commands.Up(ctx, selected, request.Services, false, true, false, request.AuthConfigs, request.WaitTimeout); err != nil {
+ if request.Recover != nil {
+ request.Recover(ctx)
+ }
+ return errors.WrapIf(err, "failed to up services")
+ }
+ return nil
+}
+
+// SelectServices enables requested profiles and returns a separate, scoped model.
+func SelectServices(model *composetypes.Project, services []string) (*composetypes.Project, error) {
+ if model == nil {
+ return nil, errors.New("compose project is nil")
+ }
+ enabled, err := model.WithServicesEnabled(services...)
+ if err != nil {
+ return nil, err
+ }
+ selected, err := enabled.WithSelectedServices(services)
+ if err != nil {
+ return nil, err
+ }
+ return selected.WithoutUnnecessaryResources(), nil
+}
+
+// PullServices pulls each selected registry image once through the application image service.
+func (c *composeCoordinatorInternal) PullServices(ctx context.Context, model *composetypes.Project, services []string, operations projecttypes.ComposeImageOperations, progress io.Writer) error {
+ for _, imageRef := range SelectedImageRefs(model, services) {
+ if err := operations.Pull(ctx, imageRef, progress); err != nil {
+ return err
+ }
+ }
+ return nil
+}
+
+func (c *composeCoordinatorInternal) imageRefreshDueInternal(ctx context.Context, imageRef string, window time.Duration, operations projecttypes.ComposeImageOperations) bool {
+ lastTagged, err := operations.LastTagged(ctx, imageRef)
+ if err != nil {
+ slog.WarnContext(ctx, "failed to resolve image last-tag time; treating refresh as due", "image", imageRef, "error", err)
+ return true
+ }
+ return lastTagged.IsZero() || time.Now().After(lastTagged.Add(window))
+}
+
+func (c *composeCoordinatorInternal) EnsureImagesPresent(ctx context.Context, model *composetypes.Project, progressWriter io.Writer, operations projecttypes.ComposeImageOperations) error {
+ for img, step := range BuildImagePullPlan(model) {
+ exists, ierr := operations.Exists(ctx, img)
+ if ierr != nil && step.Mode != ImagePullModeAlways {
+ slog.WarnContext(ctx, "failed to check local image existence", "image", img, "error", ierr)
+ // Non-fatal: attempt to pull to be safe
+ }
+
+ if step.Mode == ImagePullModeNever {
+ if ierr != nil {
+ slog.WarnContext(ctx, "pull_policy is 'never' but image presence check failed; continuing without pull", "image", img, "error", ierr)
+ continue
+ }
+ if !exists {
+ return errors.Errorf("image %s is not available locally and pull_policy is 'never'", img)
+ }
+ slog.DebugContext(ctx, "pull_policy is 'never'; using local image without pull", "image", img)
+ continue
+ }
+
+ if step.Mode == ImagePullModeIfMissing && exists {
+ slog.DebugContext(ctx, "image already present locally; skipping pull", "image", img)
+ continue
+ }
+
+ if step.Mode == ImagePullModeRefresh && exists && !c.imageRefreshDueInternal(ctx, img, step.RefreshAfter, operations) {
+ slog.DebugContext(ctx, "pull_policy refresh window has not elapsed; skipping pull", "image", img, "window", step.RefreshAfter)
+ continue
+ }
+
+ if err := operations.Pull(ctx, img, progressWriter); err != nil {
+ return err
+ }
+ }
+ return nil
+}
+
+func (c *composeCoordinatorInternal) PrepareImagesForDeploy(
+ ctx context.Context,
+ projectID string,
+ project *composetypes.Project,
+ progressWriter io.Writer,
+ operations projecttypes.ComposeImageOperations,
+ pullPolicyOverride string,
+) error {
+ if project == nil {
+ return nil
+ }
+
+ for name, svc := range project.Services {
+ svc, imageName, updated := PrepareDeployServiceConfig(projectID, project.Name, name, svc)
+ if updated {
+ project.Services[name] = svc
+ }
+
+ if imageName == "" {
+ continue
+ }
+
+ decision := DecideDeployImageAction(svc, pullPolicyOverride)
+ if updated {
+ decision = DeployImageDecision{Build: true}
+ }
+ if err := c.ensureDeployServiceImageReadyInternal(ctx, projectID, project, name, svc, imageName, decision, progressWriter, operations); err != nil {
+ return err
+ }
+
+ // pre_start hook images and type:image volume sources cannot be built:
+ // they follow the service's pull decision minus the build/fallback paths.
+ dependentDecision := DeployImageDecision{PullIfMissing: true}
+ switch {
+ case decision.RequireLocalOnly:
+ dependentDecision = DeployImageDecision{RequireLocalOnly: true}
+ case decision.PullAlways:
+ dependentDecision = DeployImageDecision{PullAlways: true}
+ case decision.PullIfStale:
+ dependentDecision = DeployImageDecision{PullIfStale: true, StaleAfter: decision.StaleAfter}
+ }
+ dependentImages := api.GetDependentImages(svc, project.Name)
+ for _, vol := range svc.Volumes {
+ if vol.Type == composetypes.VolumeTypeImage && strings.TrimSpace(vol.Source) != "" {
+ dependentImages = append(dependentImages, strings.TrimSpace(vol.Source))
+ }
+ }
+ for _, img := range dependentImages {
+ if err := c.ensureDeployServiceImageReadyInternal(ctx, projectID, project, name, svc, img, dependentDecision, progressWriter, operations); err != nil {
+ return err
+ }
+ }
+ }
+
+ return nil
+}
+
+func (c *composeCoordinatorInternal) ensureDeployServiceImageReadyInternal(
+ ctx context.Context,
+ projectID string,
+ project *composetypes.Project,
+ serviceName string,
+ svc composetypes.ServiceConfig,
+ imageName string,
+ decision DeployImageDecision,
+ progressWriter io.Writer,
+ operations projecttypes.ComposeImageOperations,
+) error {
+ if decision.Build {
+ return c.buildServiceImageForDeployInternal(ctx, projectID, project, serviceName, svc, progressWriter, operations)
+ }
+
+ exists, err := operations.Exists(ctx, imageName)
+ if err != nil {
+ slog.WarnContext(ctx, "failed to check local image existence", "image", imageName, "error", err)
+ }
+
+ if decision.RequireLocalOnly {
+ if !exists {
+ return errors.Errorf("image %s is not available locally and pull_policy is set to never", imageName)
+ }
+ return nil
+ }
+
+ var lastTagged time.Time
+ if decision.PullIfStale && exists {
+ var tagErr error
+ lastTagged, tagErr = operations.LastTagged(ctx, imageName)
+ if tagErr != nil {
+ // Unknown last-tag time counts as stale, matching the missing-record
+ // behavior of compose's refresh handling.
+ slog.WarnContext(ctx, "failed to resolve image last-tag time; treating refresh as due", "image", imageName, "error", tagErr)
+ }
+ }
+ if !ShouldPullDeployImage(decision, exists, lastTagged) {
+ return nil
+ }
+
+ err = operations.Pull(ctx, imageName, progressWriter)
+ if err == nil {
+ return nil
+ }
+ if svc.Build != nil && decision.FallbackBuildOnPullFail {
+ slog.WarnContext(ctx, "image pull failed, falling back to build", "service", serviceName, "image", imageName, "error", err)
+ return c.buildServiceImageForDeployInternal(ctx, projectID, project, serviceName, svc, progressWriter, operations)
+ }
+ return errors.WrapIff(err, "failed to pull image %s", imageName)
+}
+
+func (c *composeCoordinatorInternal) buildServiceImageForDeployInternal(
+ ctx context.Context,
+ projectID string,
+ project *composetypes.Project,
+ serviceName string,
+ svc composetypes.ServiceConfig,
+ progressWriter io.Writer,
+ operations projecttypes.ComposeImageOperations,
+) error {
+ if operations.Build == nil {
+ return errors.Errorf("build service not available for service %s", serviceName)
+ }
+
+ buildReq, updatedSvc, updated, err := PrepareServiceBuildRequest(projectID, project, serviceName, svc, projecttypes.BuildOptions{}, operations.BuildProvider)
+ if err != nil {
+ return err
+ }
+ if updated {
+ project.Services[serviceName] = updatedSvc
+ }
+
+ if err := operations.Build(ctx, buildReq, progressWriter, serviceName); err != nil {
+ return err
+ }
+
+ return nil
+}
+
+func (c *composeCoordinatorInternal) BuildServices(ctx context.Context, projectID string, project *composetypes.Project, options projecttypes.BuildOptions, progressWriter io.Writer, operations projecttypes.ComposeImageOperations) error {
+ if operations.Build == nil {
+ return nil
+ }
+ if project == nil {
+ return nil
+ }
+
+ selected := NormalizeBuildSelections(options.Services)
+
+ buildCount := 0
+ for name, svc := range project.Services {
+ if svc.Build == nil {
+ continue
+ }
+ if !ServiceSelected(selected, name) {
+ continue
+ }
+
+ buildReq, updatedSvc, updated, err := PrepareServiceBuildRequest(projectID, project, name, svc, options, operations.BuildProvider)
+ if err != nil {
+ return err
+ }
+ if updated {
+ project.Services[name] = updatedSvc
+ }
+
+ buildCount++
+ if err := operations.Build(ctx, buildReq, progressWriter, name); err != nil {
+ return err
+ }
+ }
+
+ if buildCount == 0 && len(selected) > 0 {
+ return errors.Errorf("no build-enabled services matched: %s", strings.Join(options.Services, ", "))
+ }
+
+ return nil
+}
+
+// NormalizeBuildSelections turns a user-supplied service list into a lookup set,
+// dropping blanks. An empty set means "every service".
+func NormalizeBuildSelections(services []string) map[string]struct{} {
+ selected := map[string]struct{}{}
+ for _, name := range services {
+ name = strings.TrimSpace(name)
+ if name == "" {
+ continue
+ }
+ selected[name] = struct{}{}
+ }
+ return selected
+}
+
+// ServiceSelected reports whether name is in the selection built by
+// NormalizeBuildSelections. An empty selection selects everything.
+func ServiceSelected(selected map[string]struct{}, name string) bool {
+ if len(selected) == 0 {
+ return true
+ }
+ _, ok := selected[name]
+ return ok
+}
+
+// EnsureServiceImage gives a build-only service a deterministic local image tag
+// so the built image has a stable name to deploy from. It reports whether the
+// service config was changed.
+func EnsureServiceImage(projectID, projectName, serviceName string, svc composetypes.ServiceConfig) (string, composetypes.ServiceConfig, bool) {
+ imageName := strings.TrimSpace(svc.Image)
+ if imageName == "" {
+ imageName = BuildLocalImageTag(projectID, projectName, serviceName)
+ svc.Image = imageName
+ return imageName, svc, true
+ }
+ return imageName, svc, false
+}
+
+// PrepareDeployServiceConfig resolves the image a service deploys as, naming
+// build-only services via EnsureServiceImage. It reports whether the service
+// config was changed.
+func PrepareDeployServiceConfig(projectID, projectName, serviceName string, svc composetypes.ServiceConfig) (composetypes.ServiceConfig, string, bool) {
+ if svc.Build == nil {
+ return svc, strings.TrimSpace(svc.Image), false
+ }
+
+ resolvedImage, updatedSvc, updated := EnsureServiceImage(projectID, projectName, serviceName, svc)
+ return updatedSvc, resolvedImage, updated
+}
+
+// ShouldPullDeployImage reports whether a deploy must pull, given the resolved
+// pull decision, whether the image is already present locally, and when the
+// local image was last tagged (zero when unknown). Refresh policies mirror
+// compose v5.5.0's `up`: a present image is re-pulled only once its window
+// has elapsed since the engine's last-tag time.
+func ShouldPullDeployImage(decision DeployImageDecision, exists bool, lastTagged time.Time) bool {
+ if decision.PullAlways {
+ return true
+ }
+ if !exists {
+ return decision.PullIfMissing || decision.PullIfStale
+ }
+ if decision.PullIfStale {
+ return lastTagged.IsZero() || time.Now().After(lastTagged.Add(decision.StaleAfter))
+ }
+ return false
+}
+
+// SelectedImageRefs returns the distinct pullable image refs of the selected
+// services — build services are excluded, since their images come from a build.
+func SelectedImageRefs(compProj *composetypes.Project, servicesToUpdate []string) []string {
+ if compProj == nil {
+ return nil
+ }
+
+ selected := NormalizeBuildSelections(servicesToUpdate)
+ refs := make([]string, 0, len(compProj.Services))
+ seen := make(map[string]struct{}, len(compProj.Services))
+
+ for name, svc := range compProj.Services {
+ if !ServiceSelected(selected, name) || svc.Build != nil {
+ continue
+ }
+
+ imageRef := strings.TrimSpace(svc.Image)
+ if imageRef == "" {
+ continue
+ }
+ if _, exists := seen[imageRef]; exists {
+ continue
+ }
+
+ seen[imageRef] = struct{}{}
+ refs = append(refs, imageRef)
+ }
+
+ return refs
+}
diff --git a/backend/pkg/projects/custom_labels.go b/backend/pkg/projects/custom_labels.go
index c1808308b..f6edbf0f8 100644
--- a/backend/pkg/projects/custom_labels.go
+++ b/backend/pkg/projects/custom_labels.go
@@ -1,14 +1,16 @@
-// Package projects provides utilities for managing Docker Compose projects and their metadata.
package projects
import (
"context"
+ stderrors "errors"
+ "fmt"
"log/slog"
"maps"
"os"
"path/filepath"
"slices"
"strings"
+ "unicode"
"emperror.dev/errors"
"github.com/compose-spec/compose-go/v2/loader"
@@ -318,7 +320,7 @@ func loadComposeProjectForMetadataFromFileInternal(ctx context.Context, composeF
opts.SkipValidation = true
opts.SkipConsistencyCheck = true
opts.SkipResolveEnvironment = false
- }, false)
+ }, false, nil, nil)
}
func loadComposeEnvironment(workdir string) map[string]string {
@@ -507,3 +509,74 @@ func parseLabelPair(raw string) (string, string, bool) {
}
return strings.TrimSpace(parts[0]), strings.TrimSpace(parts[1]), true
}
+
+const (
+ // ProjectTagMaxLength is the maximum number of Unicode characters in a tag name.
+ ProjectTagMaxLength = 64
+ // ProjectTagsPerSourceLimit is the maximum number of UI or Compose tags on one project.
+ ProjectTagsPerSourceLimit = 50
+)
+
+var projectTagColorsInternal = map[projecttypes.TagColor]struct{}{
+ projecttypes.TagColorGray: {},
+ projecttypes.TagColorPurple: {},
+ projecttypes.TagColorBlue: {},
+ projecttypes.TagColorGreen: {},
+ projecttypes.TagColorYellow: {},
+ projecttypes.TagColorOrange: {},
+ projecttypes.TagColorRed: {},
+ projecttypes.TagColorPink: {},
+}
+
+// NormalizeProjectTag validates and normalizes a project tag name.
+func NormalizeProjectTag(name string) (string, error) {
+ normalized := strings.ToLower(strings.TrimSpace(name))
+ if normalized == "" {
+ return "", stderrors.New("tag name cannot be empty")
+ }
+ if len([]rune(normalized)) > ProjectTagMaxLength {
+ return "", fmt.Errorf("tag name cannot exceed %d characters", ProjectTagMaxLength)
+ }
+ if strings.ContainsRune(normalized, ',') {
+ return "", stderrors.New("tag name cannot contain commas")
+ }
+ for _, char := range normalized {
+ if unicode.IsControl(char) {
+ return "", stderrors.New("tag name cannot contain control characters")
+ }
+ }
+ return normalized, nil
+}
+
+// NormalizeProjectTags validates, normalizes, and de-duplicates project tags.
+func NormalizeProjectTags(names []string) ([]string, error) {
+ result := make([]string, 0, min(len(names), ProjectTagsPerSourceLimit))
+ seen := make(map[string]struct{}, len(names))
+ for _, name := range names {
+ normalized, err := NormalizeProjectTag(name)
+ if err != nil {
+ return nil, err
+ }
+ if _, exists := seen[normalized]; exists {
+ continue
+ }
+ if len(result) >= ProjectTagsPerSourceLimit {
+ return nil, fmt.Errorf("a project cannot have more than %d tags per source", ProjectTagsPerSourceLimit)
+ }
+ seen[normalized] = struct{}{}
+ result = append(result, normalized)
+ }
+ return result, nil
+}
+
+// NormalizeProjectTagColor validates and normalizes a project tag color.
+func NormalizeProjectTagColor(color projecttypes.TagColor) (projecttypes.TagColor, error) {
+ normalized := projecttypes.TagColor(strings.ToLower(strings.TrimSpace(string(color))))
+ if normalized == "" {
+ return projecttypes.TagColorGray, nil
+ }
+ if _, valid := projectTagColorsInternal[normalized]; !valid {
+ return "", fmt.Errorf("unsupported tag color %q", color)
+ }
+ return normalized, nil
+}
diff --git a/backend/pkg/projects/custom_labels_test.go b/backend/pkg/projects/custom_labels_test.go
index a004a862d..fc95b72ba 100644
--- a/backend/pkg/projects/custom_labels_test.go
+++ b/backend/pkg/projects/custom_labels_test.go
@@ -4,6 +4,7 @@ import (
"context"
"os"
"path/filepath"
+ "strings"
"testing"
projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
@@ -180,3 +181,21 @@ x-arcane:
require.Equal(t, "https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/watchtower.svg", meta.ProjectIcon.Light)
require.Equal(t, "https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/watchtower.svg", meta.ProjectIcon.Dark)
}
+
+func TestNormalizeProjectTags(t *testing.T) {
+ tags, err := NormalizeProjectTags([]string{" Database ", "DATABASE", "maintenance-window"})
+ require.NoError(t, err)
+ require.Equal(t, []string{"database", "maintenance-window"}, tags)
+
+ for _, invalid := range []string{"", "bad,tag", "bad\ntag", strings.Repeat("a", ProjectTagMaxLength+1)} {
+ _, err := NormalizeProjectTag(invalid)
+ require.Error(t, err, invalid)
+ }
+
+ tooMany := make([]string, ProjectTagsPerSourceLimit+1)
+ for index := range tooMany {
+ tooMany[index] = "tag-" + strings.Repeat("x", index/10) + string(rune('a'+index%10))
+ }
+ _, err = NormalizeProjectTags(tooMany)
+ require.Error(t, err)
+}
diff --git a/backend/pkg/projects/directory_identity.go b/backend/pkg/projects/directory_identity.go
deleted file mode 100644
index a1ca742d5..000000000
--- a/backend/pkg/projects/directory_identity.go
+++ /dev/null
@@ -1,26 +0,0 @@
-package projects
-
-import (
- "os"
- "path/filepath"
-)
-
-// ResolveDirectoryIdentityInternal stays on os.*: it resolves symlinks that
-// may point anywhere on the host to establish directory identity, which the
-// root-confined acfs API cannot do.
-func ResolveDirectoryIdentityInternal(path string) (string, error) {
- resolvedPath, err := filepath.EvalSymlinks(path)
- if err != nil {
- if os.IsNotExist(err) {
- return "", err
- }
- resolvedPath = path
- }
-
- absPath, err := filepath.Abs(resolvedPath)
- if err != nil {
- return "", err
- }
-
- return filepath.Clean(absPath), nil
-}
diff --git a/backend/pkg/projects/discovery.go b/backend/pkg/projects/discovery.go
index 6ba672955..a2c7a0900 100644
--- a/backend/pkg/projects/discovery.go
+++ b/backend/pkg/projects/discovery.go
@@ -10,6 +10,8 @@ import (
"strings"
"emperror.dev/errors"
+ "github.com/compose-spec/compose-go/v2/loader"
+ "go.yaml.in/yaml/v4"
)
type DiscoveredProjectDir struct {
@@ -246,3 +248,93 @@ func IsInternalScratchDirName(name string) bool {
}
return IsGitOpsScratchDirName(name)
}
+
+// ComposeContentProjectName returns the normalized top-level `name:` from
+// compose YAML content, or "" when the key is absent or unusable. Interpolated
+// names (containing `${`) are treated as absent so the backend and the
+// frontend name lock behave identically; parse errors are ignored here because
+// the full compose validation reports them with proper context.
+func ComposeContentProjectName(composeContent string) string {
+ var doc struct {
+ Name string `yaml:"name"`
+ }
+ if err := yaml.Unmarshal([]byte(composeContent), &doc); err != nil {
+ return ""
+ }
+ raw := strings.TrimSpace(doc.Name)
+ if raw == "" || strings.Contains(raw, "${") {
+ return ""
+ }
+ 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
+}
+
+// ResolveDirectoryIdentityInternal stays on os.*: it resolves symlinks that
+// may point anywhere on the host to establish directory identity, which the
+// root-confined acfs API cannot do.
+func ResolveDirectoryIdentityInternal(path string) (string, error) {
+ resolvedPath, err := filepath.EvalSymlinks(path)
+ if err != nil {
+ if os.IsNotExist(err) {
+ return "", err
+ }
+ resolvedPath = path
+ }
+
+ absPath, err := filepath.Abs(resolvedPath)
+ if err != nil {
+ return "", err
+ }
+
+ return filepath.Clean(absPath), nil
+}
+
+// ComposeEnvRequiresDirectorySync reports whether environment file selections require
+// files beyond the Compose file, its sibling override, and the effective .env file.
+func ComposeEnvRequiresDirectorySync(composePath, overrideFileName string, envContent *string) bool {
+ if envContent == nil {
+ return false
+ }
+ envMap, err := ParseProjectEnvContent(*envContent, nil)
+ if err != nil || len(envMap) == 0 {
+ return false
+ }
+
+ allowedComposeFiles := map[string]struct{}{filepath.Base(composePath): {}}
+ if overrideFileName != "" {
+ allowedComposeFiles[overrideFileName] = struct{}{}
+ }
+ if entriesNeedDirectorySyncInternal(ComposeFileEntriesFromEnv(envMap), allowedComposeFiles) {
+ return true
+ }
+
+ // Single-file sync writes the synced env content to .env, so a
+ // self-reference is satisfiable; anything else never reaches the project.
+ return entriesNeedDirectorySyncInternal(ComposeEnvFileEntriesFromEnv(envMap), map[string]struct{}{EffectiveEnvFileName: {}})
+}
+
+func entriesNeedDirectorySyncInternal(entries []string, allowed map[string]struct{}) bool {
+ for _, entry := range entries {
+ // Normalize so relative prefixes like "./compose.yaml" match allowed.
+ cleaned := filepath.Clean(entry)
+ if cleaned != filepath.Base(cleaned) {
+ return true // nested path can't be single-file synced
+ }
+ if _, ok := allowed[cleaned]; !ok {
+ return true
+ }
+ }
+ return false
+}
diff --git a/backend/pkg/projects/discovery_test.go b/backend/pkg/projects/discovery_test.go
index a6080a64a..b18c50acd 100644
--- a/backend/pkg/projects/discovery_test.go
+++ b/backend/pkg/projects/discovery_test.go
@@ -258,3 +258,61 @@ func TestDiscoverProjectDirectories_SkipsFilesystemSnapshotDirs(t *testing.T) {
require.NoError(t, err)
assert.Equal(t, []string{"arcane"}, discoveredNamesInternal(discovered))
}
+
+func TestComposeContentProjectName(t *testing.T) {
+ tests := []struct {
+ name string
+ content string
+ want string
+ }{
+ {"literal name", "name: sabnzbd\nservices:\n sabnzbd:\n image: nginx\n", "sabnzbd"},
+ {"normalized", "name: My_App 2\nservices: {}\n", "my_app2"},
+ {"absent", "services: {}\n", ""},
+ {"interpolated", "name: ${PROJECT}\nservices: {}\n", ""},
+ {"invalid yaml", "name: [unclosed\n", ""},
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ {
+ got := ComposeContentProjectName(tt.content)
+ assert.Equal(t, tt.want, got,
+ "ComposeContentProjectName() = %q, want %q", got, tt.want)
+ }
+
+ })
+ }
+}
+
+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)
+
+ require.Equal(t, tt.expected, got,
+ "NormalizeProjectName() = %q, want %q", got, tt.expected)
+
+ })
+ }
+}
diff --git a/backend/pkg/projects/env.go b/backend/pkg/projects/env.go
index 86a9aba1b..411a043af 100644
--- a/backend/pkg/projects/env.go
+++ b/backend/pkg/projects/env.go
@@ -15,9 +15,9 @@ import (
"time"
"emperror.dev/errors"
-
"github.com/compose-spec/compose-go/v2/consts"
"github.com/compose-spec/compose-go/v2/dotenv"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/samber/hot"
"go.getarcane.app/acfs"
)
@@ -727,3 +727,240 @@ func formatEnvValueInternal(value string) string {
return `"` + escaped + `"`
}
+
+// Docker Compose pre-defined variable names that compose-go's consts package
+// does not export. See https://docs.docker.com/compose/how-tos/environment-variables/envvars.
+const (
+ composeEnvFilesKey = "COMPOSE_ENV_FILES"
+ composeRemoveOrphansKey = "COMPOSE_REMOVE_ORPHANS"
+ composeIgnoreOrphansKey = "COMPOSE_IGNORE_ORPHANS"
+ composeParallelLimitKey = "COMPOSE_PARALLEL_LIMIT"
+
+ defaultComposePathSeparator = ":"
+)
+
+// ComposeEnvOptions holds the deployment-relevant Docker Compose pre-defined
+// environment variables parsed from a project's merged environment.
+type ComposeEnvOptions struct {
+ // ConfigFiles is the resolved, absolute COMPOSE_FILE selection in order (the
+ // first entry is the base file). Nil when COMPOSE_FILE is unset.
+ ConfigFiles []string
+ // Profiles is the COMPOSE_PROFILES selection.
+ Profiles []string
+ // ProjectName is COMPOSE_PROJECT_NAME (not normalized).
+ ProjectName string
+ // EnvFiles is the resolved, absolute COMPOSE_ENV_FILES selection in order.
+ EnvFiles []string
+ // RemoveOrphans is COMPOSE_REMOVE_ORPHANS.
+ RemoveOrphans bool
+ // IgnoreOrphans is COMPOSE_IGNORE_ORPHANS.
+ IgnoreOrphans bool
+ // ParallelLimit is COMPOSE_PARALLEL_LIMIT; 0 means unset.
+ ParallelLimit int
+}
+
+// ParseComposeEnvOptions extracts the deployment-relevant COMPOSE_* variables
+// from an already-merged environment map. Malformed path selections return a
+// classified common.ErrComposeFileEnvInvalid; malformed scalars are ignored
+// with a debug log, matching `docker compose`'s tolerance.
+func ParseComposeEnvOptions(workdir string, env EnvMap) (ComposeEnvOptions, error) {
+ opts := ComposeEnvOptions{
+ ProjectName: strings.TrimSpace(env[consts.ComposeProjectName]),
+ }
+
+ files, err := resolveComposeFileSelectionInternal(workdir, env)
+ if err != nil {
+ return ComposeEnvOptions{}, err
+ }
+ opts.ConfigFiles = files
+
+ if raw := strings.TrimSpace(env[consts.ComposeProfiles]); raw != "" {
+ opts.Profiles = splitAndTrimInternal(raw, ",")
+ }
+
+ for _, entry := range ComposeEnvFileEntriesFromEnv(env) {
+ resolved, resErr := ResolvePathWithinDir(workdir, entry)
+ if resErr != nil {
+ return ComposeEnvOptions{}, common.Classify(common.ErrComposeFileEnvInvalid, errors.WrapIff(resErr, "COMPOSE_ENV_FILES entry %q", entry))
+ }
+ opts.EnvFiles = append(opts.EnvFiles, resolved)
+ }
+
+ opts.RemoveOrphans = parseComposeBoolInternal(env, composeRemoveOrphansKey)
+ opts.IgnoreOrphans = parseComposeBoolInternal(env, composeIgnoreOrphansKey)
+
+ if raw := strings.TrimSpace(env[composeParallelLimitKey]); raw != "" {
+ if n, convErr := strconv.Atoi(raw); convErr == nil && n > 0 {
+ opts.ParallelLimit = n
+ } else {
+ slog.Debug("ignoring invalid COMPOSE_PARALLEL_LIMIT", "value", raw)
+ }
+ }
+
+ return opts, nil
+}
+
+// ComposeFileEnvSelection resolves the COMPOSE_FILE selection for dir with the
+// same layering EnvLoader.LoadEnvironment uses at deployment: .env.global from
+// projectsDir first, the project .env on top, then any COMPOSE_ENV_FILES
+// entries. Returns nil when the merged environment does not set COMPOSE_FILE.
+// COMPOSE_DISABLE_ENV_FILE (declared in .env.global) skips the project .env, as
+// `docker compose` does; a global COMPOSE_FILE still applies. An empty
+// projectsDir skips the global layer.
+func ComposeFileEnvSelection(ctx context.Context, projectsDir, dir string) ([]string, error) {
+ envMap := make(EnvMap)
+ if strings.TrimSpace(projectsDir) != "" {
+ globalEnv, err := ParseProjectEnvFile(filepath.Join(projectsDir, GlobalEnvFileName), envMap)
+ if err != nil {
+ return nil, err
+ }
+ maps.Copy(envMap, globalEnv)
+ }
+
+ // COMPOSE_DISABLE_ENV_FILE skips the project .env; it is read only from the
+ // sources merged so far (.env.global), matching LoadEnvironment.
+ if !parseComposeBoolInternal(envMap, consts.ComposeDisableDefaultEnvFile) {
+ projectEnv, err := ParseProjectEnvFile(filepath.Join(dir, EffectiveEnvFileName), envMap)
+ if err != nil {
+ return nil, err
+ }
+ maps.Copy(envMap, projectEnv)
+ }
+ if len(envMap) == 0 {
+ return nil, nil
+ }
+ mergeComposeEnvFilesInternal(ctx, dir, envMap, ParseProjectEnvFile, nil)
+ return resolveComposeFileSelectionInternal(dir, envMap)
+}
+
+// ComposeFileEntriesFromEnv returns the raw COMPOSE_FILE entries declared in env
+// (split on COMPOSE_PATH_SEPARATOR, ":" by default), or nil when unset. Entries
+// are not resolved, validated, or stat'd.
+func ComposeFileEntriesFromEnv(env EnvMap) []string {
+ raw, ok := env[consts.ComposeFilePath]
+ if !ok || strings.TrimSpace(raw) == "" {
+ return nil
+ }
+
+ separator := defaultComposePathSeparator
+ if custom := strings.TrimSpace(env[consts.ComposePathSeparator]); custom != "" {
+ separator = custom
+ }
+
+ return splitAndTrimInternal(raw, separator)
+}
+
+// ComposeEnvFileEntriesFromEnv returns the raw COMPOSE_ENV_FILES entries
+// declared in env (comma-separated), or nil when unset. Entries are not
+// resolved, validated, or stat'd.
+func ComposeEnvFileEntriesFromEnv(env EnvMap) []string {
+ raw := strings.TrimSpace(env[composeEnvFilesKey])
+ if raw == "" {
+ return nil
+ }
+ return splitAndTrimInternal(raw, ",")
+}
+
+// resolveComposeFileSelectionInternal parses COMPOSE_FILE from env into an
+// ordered list of absolute compose-file paths, or nil when COMPOSE_FILE is
+// unset. Every entry must be a relative path to an existing file within
+// workdir; the first entry (the base file) must sit directly in workdir.
+func resolveComposeFileSelectionInternal(workdir string, env EnvMap) ([]string, error) {
+ entries := ComposeFileEntriesFromEnv(env)
+ if len(entries) == 0 {
+ return nil, nil
+ }
+
+ absWorkdir, err := filepath.Abs(filepath.Clean(workdir))
+ if err != nil {
+ return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.WrapIf(err, "resolve project directory"))
+ }
+
+ files := make([]string, 0, len(entries))
+ for i, entry := range entries {
+ if filepath.IsAbs(entry) {
+ return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.Errorf("COMPOSE_FILE entry %q must be relative to the project directory", entry))
+ }
+
+ resolved, resErr := ResolvePathWithinDir(absWorkdir, entry)
+ if resErr != nil {
+ return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.WrapIff(resErr, "COMPOSE_FILE entry %q", entry))
+ }
+
+ if i == 0 && filepath.Dir(resolved) != absWorkdir {
+ return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.Errorf("the first COMPOSE_FILE entry %q must be in the project directory", entry))
+ }
+
+ // os.Stat rather than acfs: compose files may be symlinks resolving
+ // outside any confinement root, and workdir can be an imported project
+ // living outside the projects directory.
+ info, statErr := os.Stat(resolved)
+ if statErr != nil {
+ return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.WrapIff(statErr, "COMPOSE_FILE entry %q", entry))
+ }
+ if info.IsDir() {
+ return nil, common.Classify(common.ErrComposeFileEnvInvalid, errors.Errorf("COMPOSE_FILE entry %q is a directory", entry))
+ }
+
+ files = append(files, resolved)
+ }
+
+ return files, nil
+}
+
+// mergeComposeEnvFilesInternal merges each COMPOSE_ENV_FILES entry (in order,
+// later wins) on top of envMap; bad entries are warned and skipped. Unlike
+// `docker compose`, the entries are additive on top of the project .env rather
+// than a replacement: .env is Arcane's managed effective env file and the place
+// COMPOSE_ENV_FILES itself is declared, so replacing it would be self-defeating.
+func mergeComposeEnvFilesInternal(ctx context.Context, workdir string, envMap EnvMap, parse func(path string, contextEnv EnvMap) (EnvMap, error), onMerged func(values EnvMap)) {
+ for _, entry := range ComposeEnvFileEntriesFromEnv(envMap) {
+ resolved, err := ResolvePathWithinDir(workdir, entry)
+ if err != nil {
+ slog.WarnContext(ctx, "skipping COMPOSE_ENV_FILES entry outside project directory", "entry", entry, "error", err)
+ continue
+ }
+ // os.Stat rather than acfs: env files may be symlinks resolving outside
+ // any confinement root (a supported setup).
+ if _, statErr := os.Stat(resolved); statErr != nil {
+ slog.WarnContext(ctx, "COMPOSE_ENV_FILES entry not found", "path", resolved, "error", statErr)
+ continue
+ }
+ values, err := parse(resolved, envMap)
+ if err != nil {
+ slog.WarnContext(ctx, "failed to load COMPOSE_ENV_FILES entry", "path", resolved, "error", err)
+ continue
+ }
+ if len(values) == 0 {
+ continue
+ }
+ maps.Copy(envMap, values)
+ if onMerged != nil {
+ onMerged(values)
+ }
+ }
+}
+
+func splitAndTrimInternal(raw, sep string) []string {
+ parts := strings.Split(raw, sep)
+ out := make([]string, 0, len(parts))
+ for _, p := range parts {
+ if trimmed := strings.TrimSpace(p); trimmed != "" {
+ out = append(out, trimmed)
+ }
+ }
+ return out
+}
+
+func parseComposeBoolInternal(env EnvMap, key string) bool {
+ raw := strings.TrimSpace(env[key])
+ if raw == "" {
+ return false
+ }
+ v, err := strconv.ParseBool(raw)
+ if err != nil {
+ slog.Debug("ignoring invalid compose boolean env var", "key", key, "value", raw)
+ return false
+ }
+ return v
+}
diff --git a/backend/pkg/projects/env_test.go b/backend/pkg/projects/env_test.go
index ecc48de23..4ae592464 100644
--- a/backend/pkg/projects/env_test.go
+++ b/backend/pkg/projects/env_test.go
@@ -2,12 +2,14 @@ package projects
import (
"context"
- "errors"
+ stderrors "errors"
"os"
"path/filepath"
"runtime"
"testing"
+ "emperror.dev/errors"
+ "github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
@@ -107,7 +109,7 @@ func TestWithTransientValidationEnvFile_PreservesExternalSymlink(t *testing.T) {
originalLinkTarget, err := os.Readlink(envPath)
require.NoError(t, err)
- validationErr := errors.New("validation failed")
+ validationErr := stderrors.New("validation failed")
updatedContent := "VALUE=validation\n"
err = WithTransientValidationEnvFile(t.Context(), projectDir, &updatedContent, func() error {
content, readErr := os.ReadFile(targetPath)
@@ -329,3 +331,175 @@ func TestReadProjectEnvState(t *testing.T) {
assert.Equal(t, "A=1\nB=2\n", state.EffectiveContent)
})
}
+
+func TestParseComposeEnvOptions(t *testing.T) {
+ t.Parallel()
+
+ dir := t.TempDir()
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
+ require.NoError(t, os.MkdirAll(filepath.Join(dir, "sub"), 0o755))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "sub", "extra.yml"), []byte("services: {}\n"), 0o600))
+
+ t.Run("scalars, profiles split, and custom separator", func(t *testing.T) {
+ t.Parallel()
+ env := EnvMap{
+ "COMPOSE_FILE": "base.yml;sub/extra.yml",
+ "COMPOSE_PATH_SEPARATOR": ";",
+ "COMPOSE_PROFILES": "frontend, debug",
+ "COMPOSE_PROJECT_NAME": "myproj",
+ "COMPOSE_REMOVE_ORPHANS": "true",
+ "COMPOSE_IGNORE_ORPHANS": "1",
+ "COMPOSE_PARALLEL_LIMIT": "4",
+ }
+
+ opts, err := ParseComposeEnvOptions(dir, env)
+ require.NoError(t, err)
+ assert.Equal(t, []string{filepath.Join(dir, "base.yml"), filepath.Join(dir, "sub", "extra.yml")}, opts.ConfigFiles)
+ assert.Equal(t, []string{"frontend", "debug"}, opts.Profiles)
+ assert.Equal(t, "myproj", opts.ProjectName)
+ assert.True(t, opts.RemoveOrphans)
+ assert.True(t, opts.IgnoreOrphans)
+ assert.Equal(t, 4, opts.ParallelLimit)
+ })
+
+ t.Run("invalid scalars are ignored", func(t *testing.T) {
+ t.Parallel()
+ opts, err := ParseComposeEnvOptions(dir, EnvMap{
+ "COMPOSE_REMOVE_ORPHANS": "nope",
+ "COMPOSE_PARALLEL_LIMIT": "-3",
+ })
+ require.NoError(t, err)
+ assert.False(t, opts.RemoveOrphans)
+ assert.Zero(t, opts.ParallelLimit)
+ })
+
+ t.Run("COMPOSE_ENV_FILES resolved in order, traversal rejected", func(t *testing.T) {
+ t.Parallel()
+ opts, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_ENV_FILES": "sub/extra.env, .env.local"})
+ require.NoError(t, err)
+ assert.Equal(t, []string{filepath.Join(dir, "sub", "extra.env"), filepath.Join(dir, ".env.local")}, opts.EnvFiles)
+
+ _, err = ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_ENV_FILES": "../outside.env"})
+ require.Error(t, err)
+ assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
+ })
+
+ t.Run("absolute entry rejected", func(t *testing.T) {
+ t.Parallel()
+ _, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_FILE": filepath.Join(dir, "base.yml")})
+ require.Error(t, err)
+ assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
+ })
+
+ t.Run("escaping entry rejected", func(t *testing.T) {
+ t.Parallel()
+ _, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_FILE": "../base.yml"})
+ require.Error(t, err)
+ assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
+ })
+
+ t.Run("non-root first entry rejected", func(t *testing.T) {
+ t.Parallel()
+ _, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_FILE": "sub/extra.yml:base.yml"})
+ require.Error(t, err)
+ assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
+ })
+
+ t.Run("missing entry rejected", func(t *testing.T) {
+ t.Parallel()
+ _, err := ParseComposeEnvOptions(dir, EnvMap{"COMPOSE_FILE": "base.yml:sub/missing.yml"})
+ require.Error(t, err)
+ assert.True(t, errors.Is(err, common.ErrComposeFileEnvInvalid))
+ })
+}
+
+func TestComposeFileEnvSelection(t *testing.T) {
+ t.Parallel()
+
+ t.Run("nil when no .env", func(t *testing.T) {
+ t.Parallel()
+ files, err := ComposeFileEnvSelection(t.Context(), "", t.TempDir())
+ require.NoError(t, err)
+ assert.Nil(t, files)
+ })
+
+ t.Run("resolves COMPOSE_FILE from .env", func(t *testing.T) {
+ t.Parallel()
+ dir := t.TempDir()
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "extra.yml"), []byte("services: {}\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=base.yml:extra.yml\n"), 0o600))
+
+ files, err := ComposeFileEnvSelection(t.Context(), "", dir)
+ require.NoError(t, err)
+ assert.Equal(t, []string{filepath.Join(dir, "base.yml"), filepath.Join(dir, "extra.yml")}, files)
+ })
+
+ t.Run("resolves COMPOSE_FILE from COMPOSE_ENV_FILES entry", func(t *testing.T) {
+ t.Parallel()
+ dir := t.TempDir()
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "aux.env"), []byte("COMPOSE_FILE=base.yml\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_ENV_FILES=aux.env\n"), 0o600))
+
+ files, err := ComposeFileEnvSelection(t.Context(), "", dir)
+ require.NoError(t, err)
+ assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
+ })
+
+ t.Run("global COMPOSE_DISABLE_ENV_FILE skips project .env", func(t *testing.T) {
+ t.Parallel()
+ projectsDir := t.TempDir()
+ dir := filepath.Join(projectsDir, "proj")
+ require.NoError(t, os.MkdirAll(dir, 0o755))
+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, GlobalEnvFileName), []byte("COMPOSE_DISABLE_ENV_FILE=true\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=base.yml\n"), 0o600))
+
+ files, err := ComposeFileEnvSelection(t.Context(), projectsDir, dir)
+ require.NoError(t, err)
+ assert.Nil(t, files)
+ })
+
+ t.Run("global COMPOSE_FILE selects the base when the project .env is silent", func(t *testing.T) {
+ t.Parallel()
+ projectsDir := t.TempDir()
+ dir := filepath.Join(projectsDir, "proj")
+ require.NoError(t, os.MkdirAll(dir, 0o755))
+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, GlobalEnvFileName), []byte("COMPOSE_FILE=base.yml\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
+
+ files, err := ComposeFileEnvSelection(t.Context(), projectsDir, dir)
+ require.NoError(t, err)
+ assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
+ })
+
+ t.Run("project .env COMPOSE_FILE overrides the global value", func(t *testing.T) {
+ t.Parallel()
+ projectsDir := t.TempDir()
+ dir := filepath.Join(projectsDir, "proj")
+ require.NoError(t, os.MkdirAll(dir, 0o755))
+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, GlobalEnvFileName), []byte("COMPOSE_FILE=global.yml\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "global.yml"), []byte("services: {}\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=base.yml\n"), 0o600))
+
+ files, err := ComposeFileEnvSelection(t.Context(), projectsDir, dir)
+ require.NoError(t, err)
+ assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
+ })
+
+ t.Run("COMPOSE_DISABLE_ENV_FILE still honors a global COMPOSE_FILE", func(t *testing.T) {
+ t.Parallel()
+ projectsDir := t.TempDir()
+ dir := filepath.Join(projectsDir, "proj")
+ require.NoError(t, os.MkdirAll(dir, 0o755))
+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, GlobalEnvFileName), []byte("COMPOSE_DISABLE_ENV_FILE=true\nCOMPOSE_FILE=base.yml\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "base.yml"), []byte("services: {}\n"), 0o600))
+ require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=other.yml\n"), 0o600))
+
+ files, err := ComposeFileEnvSelection(t.Context(), projectsDir, dir)
+ require.NoError(t, err)
+ assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
+ })
+}
diff --git a/backend/pkg/projects/env_validation.go b/backend/pkg/projects/env_validation.go
index 904135edc..bfe73e877 100644
--- a/backend/pkg/projects/env_validation.go
+++ b/backend/pkg/projects/env_validation.go
@@ -1,6 +1,7 @@
package projects
import (
+ "bufio"
"context"
"maps"
"os"
@@ -10,6 +11,7 @@ import (
"emperror.dev/errors"
"github.com/compose-spec/compose-go/v2/consts"
"github.com/compose-spec/compose-go/v2/dotenv"
+ "github.com/getarcaneapp/arcane/types/v2/env"
)
// BuildValidationEnvironment resolves the env a compose file is validated
@@ -89,3 +91,54 @@ func ParseValidationEnvContent(content string, contextEnv EnvMap) (EnvMap, error
return envMap, nil
}
+
+// ParseEnvContent parses environment variables from .env file content
+func ParseEnvContent(content string) []env.Variable {
+ if content == "" {
+ return []env.Variable{}
+ }
+
+ var vars []env.Variable
+ scanner := bufio.NewScanner(strings.NewReader(content))
+
+ for scanner.Scan() {
+ line := strings.TrimSpace(scanner.Text())
+
+ // Skip empty lines and comments
+ if line == "" || strings.HasPrefix(line, "#") {
+ continue
+ }
+
+ // Split on first '='
+ parts := strings.SplitN(line, "=", 2)
+ if len(parts) != 2 {
+ continue
+ }
+
+ key := strings.TrimSpace(parts[0])
+ value := ""
+ if len(parts) == 2 {
+ value = strings.TrimSpace(parts[1])
+ }
+
+ // Strip surrounding quotes and handle escapes
+ if len(value) >= 2 {
+ if strings.HasPrefix(value, `"`) && strings.HasSuffix(value, `"`) {
+ value = value[1 : len(value)-1]
+ value = strings.ReplaceAll(value, `\"`, `"`)
+ } else if strings.HasPrefix(value, `'`) && strings.HasSuffix(value, `'`) {
+ value = value[1 : len(value)-1]
+ value = strings.ReplaceAll(value, `\'`, `'`)
+ }
+ }
+
+ if key != "" {
+ vars = append(vars, env.Variable{
+ Key: key,
+ Value: value,
+ })
+ }
+ }
+
+ return vars
+}
diff --git a/backend/pkg/projects/env_variables.go b/backend/pkg/projects/env_variables.go
deleted file mode 100644
index e57873c49..000000000
--- a/backend/pkg/projects/env_variables.go
+++ /dev/null
@@ -1,59 +0,0 @@
-package projects
-
-import (
- "bufio"
- "strings"
-
- "github.com/getarcaneapp/arcane/types/v2/env"
-)
-
-// ParseEnvContent parses environment variables from .env file content
-func ParseEnvContent(content string) []env.Variable {
- if content == "" {
- return []env.Variable{}
- }
-
- var vars []env.Variable
- scanner := bufio.NewScanner(strings.NewReader(content))
-
- for scanner.Scan() {
- line := strings.TrimSpace(scanner.Text())
-
- // Skip empty lines and comments
- if line == "" || strings.HasPrefix(line, "#") {
- continue
- }
-
- // Split on first '='
- parts := strings.SplitN(line, "=", 2)
- if len(parts) != 2 {
- continue
- }
-
- key := strings.TrimSpace(parts[0])
- value := ""
- if len(parts) == 2 {
- value = strings.TrimSpace(parts[1])
- }
-
- // Strip surrounding quotes and handle escapes
- if len(value) >= 2 {
- if strings.HasPrefix(value, `"`) && strings.HasSuffix(value, `"`) {
- value = value[1 : len(value)-1]
- value = strings.ReplaceAll(value, `\"`, `"`)
- } else if strings.HasPrefix(value, `'`) && strings.HasSuffix(value, `'`) {
- value = value[1 : len(value)-1]
- value = strings.ReplaceAll(value, `\'`, `'`)
- }
- }
-
- if key != "" {
- vars = append(vars, env.Variable{
- Key: key,
- Value: value,
- })
- }
- }
-
- return vars
-}
diff --git a/backend/pkg/projects/fs_templates.go b/backend/pkg/projects/fs_templates.go
index 3000ba93e..ea114d5bb 100644
--- a/backend/pkg/projects/fs_templates.go
+++ b/backend/pkg/projects/fs_templates.go
@@ -2,14 +2,18 @@ package projects
import (
"context"
+ "log/slog"
"os"
"path/filepath"
"regexp"
"strings"
"emperror.dev/errors"
+ composeloader "github.com/compose-spec/compose-go/v2/loader"
+ composetypes "github.com/compose-spec/compose-go/v2/types"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
+ "github.com/samber/mo"
"go.getarcane.app/acfs"
)
@@ -245,3 +249,102 @@ POSTGRES_PORT=5432
# DEBUG=false
`
}
+
+// ParseComposeServices extracts service names from a compose file content using compose-go
+func ParseComposeServices(ctx context.Context, composeContent string) []string {
+ if composeContent == "" {
+ return []string{}
+ }
+
+ // Create a temp directory with dummy .env file to satisfy env_file references
+ // System temp scratch: no acfs root exists for it.
+ tmpDir, err := os.MkdirTemp("", "arcane-compose-parse-*")
+ if err != nil {
+ slog.WarnContext(ctx, "Failed to create temp dir for compose parsing", "error", err)
+ return []string{}
+ }
+ defer func() { _ = os.RemoveAll(tmpDir) }()
+
+ // Create a dummy .env file to prevent env file errors
+ envPath := filepath.Join(tmpDir, ".env")
+ if err := WriteFileWithPerm(envPath, "", utils.FilePerm); err != nil {
+ slog.WarnContext(ctx, "Failed to create dummy env file", "error", err)
+ }
+
+ // Parse using compose-go
+ configDetails := composetypes.ConfigDetails{
+ ConfigFiles: []composetypes.ConfigFile{
+ {
+ Content: []byte(composeContent),
+ },
+ },
+ WorkingDir: tmpDir,
+ Environment: composetypes.Mapping{},
+ }
+
+ project, err := composeloader.LoadWithContext(ctx, configDetails, composeloader.WithSkipValidation)
+ if err != nil {
+ slog.WarnContext(ctx, "Failed to parse compose services", "error", err)
+ return []string{}
+ }
+
+ serviceNames := make([]string, 0, len(project.Services))
+ for _, service := range project.Services {
+ serviceNames = append(serviceNames, service.Name)
+ }
+
+ return serviceNames
+}
+
+// ResolveTemplateIconURL reads Arcane icon metadata from template Compose content.
+func ResolveTemplateIconURL(ctx context.Context, composeContent, envContent string) *string {
+ if strings.TrimSpace(composeContent) == "" {
+ return nil
+ }
+
+ // System temp scratch: no acfs root exists for it.
+ tmpDir, err := os.MkdirTemp("", "arcane-template-icon-*")
+ if err != nil {
+ slog.WarnContext(ctx, "failed to create temp dir for template icon parsing", "error", err)
+ return nil
+ }
+ defer func() { _ = os.RemoveAll(tmpDir) }()
+
+ envPath := filepath.Join(tmpDir, ".env")
+ if err := WriteFileWithPerm(envPath, envContent, utils.FilePerm); err != nil {
+ slog.WarnContext(ctx, "failed to create temp env file for template icon parsing", "error", err)
+ }
+
+ envMap := make(composetypes.Mapping)
+ for _, variable := range ParseEnvContent(envContent) {
+ if key := strings.TrimSpace(variable.Key); key != "" {
+ envMap[key] = variable.Value
+ }
+ }
+ envMap["PWD"] = tmpDir
+
+ configDetails := composetypes.ConfigDetails{
+ ConfigFiles: []composetypes.ConfigFile{
+ {
+ Content: []byte(composeContent),
+ },
+ },
+ WorkingDir: tmpDir,
+ Environment: envMap,
+ }
+
+ project, err := composeloader.LoadWithContext(ctx, configDetails, composeloader.WithSkipValidation, func(opts *composeloader.Options) {
+ opts.SkipConsistencyCheck = true
+ })
+ if err != nil {
+ slog.WarnContext(ctx, "failed to parse compose for template icon metadata", "error", err)
+ return nil
+ }
+
+ if project == nil {
+ return nil
+ }
+
+ icon, _, _, _ := parseArcaneBlockInternal(project.Extensions[arcaneBlockKey])
+ return mo.EmptyableToOption(strings.TrimSpace(icon.Icon)).ToPointer()
+}
diff --git a/backend/pkg/projects/fs_templates_test.go b/backend/pkg/projects/fs_templates_test.go
index 9140979bf..c9daadd1f 100644
--- a/backend/pkg/projects/fs_templates_test.go
+++ b/backend/pkg/projects/fs_templates_test.go
@@ -1,6 +1,7 @@
package projects
import (
+ "context"
"os"
"path/filepath"
"testing"
@@ -59,3 +60,66 @@ func TestReadFolderComposeTemplate_ReadsEnvExample(t *testing.T) {
require.NotNil(t, env)
assert.Equal(t, "KEY=value\n", *env)
}
+
+func TestResolveTemplateIconURL(t *testing.T) {
+ tests := []struct {
+ name string
+ compose string
+ envContent string
+ want string
+ }{
+ {
+ name: "top level icon",
+ compose: `x-arcane:
+ icon: https://cdn.example/icon.png
+services:
+ app:
+ image: nginx:alpine
+`,
+ want: "https://cdn.example/icon.png",
+ },
+ {
+ name: "icons alias",
+ compose: `x-arcane:
+ icons: https://cdn.example/alias.png
+services:
+ app:
+ image: nginx:alpine
+`,
+ want: "https://cdn.example/alias.png",
+ },
+ {
+ name: "env interpolation",
+ compose: `x-arcane:
+ icon: ${TEMPLATE_ICON}
+services:
+ app:
+ image: nginx:alpine
+`,
+ envContent: "TEMPLATE_ICON=https://cdn.example/from-env.png\n",
+ want: "https://cdn.example/from-env.png",
+ },
+ {
+ name: "invalid x arcane block",
+ compose: `x-arcane: plain-text
+services:
+ app:
+ image: nginx:alpine
+`,
+ want: "",
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ iconURL := ResolveTemplateIconURL(context.Background(), tt.compose, tt.envContent)
+ if tt.want == "" {
+ require.Nil(t, iconURL)
+ return
+ }
+
+ require.NotNil(t, iconURL)
+ require.Equal(t, tt.want, *iconURL)
+ })
+ }
+}
diff --git a/backend/pkg/projects/fs_writer.go b/backend/pkg/projects/fs_writer.go
index e6b49b992..a7f6c1071 100644
--- a/backend/pkg/projects/fs_writer.go
+++ b/backend/pkg/projects/fs_writer.go
@@ -13,7 +13,7 @@ import (
"time"
"emperror.dev/errors"
-
+ "github.com/compose-spec/compose-go/v2/cli"
"github.com/getarcaneapp/arcane/backend/v2/pkg/utils"
"go.getarcane.app/acfs"
"go.getarcane.app/acfs/atomic"
@@ -446,3 +446,172 @@ func cleanupEmptyDirs(ctx context.Context, projectPath, startLogical string) {
}
}
}
+
+// composeOverrideFileCandidates lists supported compose override filenames in
+// detection order, sourced from compose-go.
+var composeOverrideFileCandidates = slices.Clone(cli.DefaultOverrideFileNames)
+
+// DefaultComposeOverrideFileName is the override filename Arcane writes when a
+// project gains an override but has none on disk. It is deliberately
+// composeOverrideFileCandidates[1] ("compose.override.yaml"), NOT [0]
+// ("compose.override.yml"), so the default override extension matches Arcane's
+// ".yaml" base default (DefaultComposeFileName = "compose.yaml"). Do not "fix"
+// this to [0]: `docker compose` has no preference between the two, and keeping
+// ".yaml" avoids a mismatched base/override extension pair.
+const DefaultComposeOverrideFileName = "compose.override.yaml"
+
+// ComposeOverrideFileCandidates returns the supported compose override filenames
+// in detection order. A copy is returned so callers can't mutate package state.
+func ComposeOverrideFileCandidates() []string {
+ return slices.Clone(composeOverrideFileCandidates)
+}
+
+// findComposeOverrideCandidatesInternal returns every supported override
+// candidate name for which exists reports true, in compose-go preference order.
+// It is the single primitive behind both filesystem discovery
+// (DetectComposeOverrideFile) and non-filesystem discovery
+// (ResolveComposeOverride), so the two can never drift in preference order.
+func findComposeOverrideCandidatesInternal(exists func(name string) bool) []string {
+ found := make([]string, 0, 1)
+ for _, name := range composeOverrideFileCandidates {
+ if exists(name) {
+ found = append(found, name)
+ }
+ }
+ return found
+}
+
+// warnOnMultipleComposeOverridesInternal mirrors compose-go: when more than one
+// override candidate is present it logs which candidates were found and which
+// highest-preference match will be used.
+func warnOnMultipleComposeOverridesInternal(found []string) {
+ if len(found) > 1 {
+ slog.Warn("multiple compose override files found; using highest-preference match",
+ "using", found[0], "found", found)
+ }
+}
+
+// DetectComposeOverrideFile returns the path to the highest-preference compose
+// override file present in dir, following compose-go's preference order, or ""
+// when none exists. When multiple override files are present it returns the
+// highest-preference match and logs a warning, mirroring compose-go behavior.
+func DetectComposeOverrideFile(dir string) string {
+ // Stays on os.*: override files may be symlinks resolving outside any
+ // confinement root (same class as #3556 includes), which acfs cannot follow.
+ found := findComposeOverrideCandidatesInternal(func(name string) bool {
+ info, err := os.Stat(filepath.Join(dir, name))
+ return err == nil && !info.IsDir()
+ })
+ if len(found) == 0 {
+ return ""
+ }
+ warnOnMultipleComposeOverridesInternal(found)
+ return filepath.Join(dir, found[0])
+}
+
+// ReadComposeOverrideContent returns the content of the highest-preference
+// compose override file present in dir, or "" when none exists or it cannot be
+// read. It is a best-effort read intended for change detection.
+func ReadComposeOverrideContent(dir string) string {
+ overridePath := DetectComposeOverrideFile(dir)
+ if overridePath == "" {
+ return ""
+ }
+ content, err := os.ReadFile(overridePath)
+ if err != nil {
+ return ""
+ }
+ return string(content)
+}
+
+// ResolveComposeOverride finds the highest-preference compose override file among
+// the supported candidates using the exists probe, then loads it via read. It
+// centralizes override discovery so non-filesystem sources (e.g. a Git working
+// tree accessed through a validated client) reuse the same preference order.
+// When multiple candidates exist it warns and uses the highest-preference match,
+// mirroring DetectComposeOverrideFile. found is false (with empty name/content)
+// when no candidate exists.
+func ResolveComposeOverride(exists func(name string) bool, read func(name string) (string, error)) (fileName string, content string, found bool, err error) {
+ matches := findComposeOverrideCandidatesInternal(exists)
+ if len(matches) == 0 {
+ return "", "", false, nil
+ }
+ warnOnMultipleComposeOverridesInternal(matches)
+ name := matches[0]
+ c, readErr := read(name)
+ if readErr != nil {
+ return "", "", false, readErr
+ }
+ return name, c, true, nil
+}
+
+// WriteComposeOverrideFile writes content as the override file named fileName in
+// dir when content is non-nil, and removes every other override candidate so a
+// renamed or deleted override never leaves a stale copy behind. When content is
+// nil, all supported override files are removed. projectsRoot bounds writes to
+// prevent path traversal.
+func WriteComposeOverrideFile(ctx context.Context, projectsRoot, dir string, content *string, fileName string) error {
+ keep := ""
+ if content != nil {
+ keep = strings.TrimSpace(fileName)
+ if keep == "" {
+ return errors.New("missing override file name")
+ }
+ if err := WriteProjectFile(ctx, projectsRoot, dir, keep, *content); err != nil {
+ return err
+ }
+ }
+
+ // Remove stale override files: deleted from the source, or renamed to a
+ // different candidate name than the one currently written.
+ for _, candidate := range composeOverrideFileCandidates {
+ if candidate == keep {
+ continue
+ }
+ if err := RemoveProjectFile(ctx, projectsRoot, dir, candidate); err != nil {
+ return err
+ }
+ }
+
+ return nil
+}
+
+// ExistingOrDefaultOverrideName returns the override file name already present
+// in dir, falling back to DefaultComposeOverrideFileName.
+func ExistingOrDefaultOverrideName(dir string) string {
+ if overridePath := DetectComposeOverrideFile(dir); overridePath != "" {
+ return filepath.Base(overridePath)
+ }
+ return DefaultComposeOverrideFileName
+}
+
+// ResolveEffectiveOverrideForValidation resolves the override content compose
+// validation should see: the on-disk override when the caller supplied none,
+// nothing when the caller explicitly blanked it, otherwise the caller's content.
+func ResolveEffectiveOverrideForValidation(dir string, overrideContent *string) (*string, string) {
+ switch {
+ case overrideContent == nil:
+ overridePath := DetectComposeOverrideFile(dir)
+ if overridePath == "" {
+ return nil, ""
+ }
+ onDisk := ReadComposeOverrideContent(dir)
+ return &onDisk, filepath.Base(overridePath)
+ case strings.TrimSpace(*overrideContent) == "":
+ return nil, ""
+ default:
+ return overrideContent, ExistingOrDefaultOverrideName(dir)
+ }
+}
+
+// ApplyOverrideFileChange writes, clears, or leaves the override file alone
+// depending on whether overrideContent is nil, blank, or set.
+func ApplyOverrideFileChange(ctx context.Context, projectsRoot, dir string, overrideContent *string) error {
+ if overrideContent == nil {
+ return nil
+ }
+ if strings.TrimSpace(*overrideContent) == "" {
+ return WriteComposeOverrideFile(ctx, projectsRoot, dir, nil, "")
+ }
+ return WriteComposeOverrideFile(ctx, projectsRoot, dir, overrideContent, ExistingOrDefaultOverrideName(dir))
+}
diff --git a/backend/pkg/projects/fs_writer_test.go b/backend/pkg/projects/fs_writer_test.go
index 60a6a396e..7c954c8e8 100644
--- a/backend/pkg/projects/fs_writer_test.go
+++ b/backend/pkg/projects/fs_writer_test.go
@@ -1,6 +1,7 @@
package projects
import (
+ "errors"
"os"
"path/filepath"
"runtime"
@@ -409,3 +410,83 @@ func TestWriteComposeFile_PreservesExistingCustomComposeNames(t *testing.T) {
_, err = os.Stat(filepath.Join(projectDir, "compose.yaml"))
assert.True(t, os.IsNotExist(err), "compose.yaml should not be created when an existing custom compose file is present")
}
+
+func TestReadComposeOverrideContent(t *testing.T) {
+ t.Parallel()
+
+ dir := t.TempDir()
+ assert.Empty(t, ReadComposeOverrideContent(dir))
+
+ content := "services:\n app:\n image: busybox:latest\n"
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "compose.override.yaml"), []byte(content), 0o600))
+ assert.Equal(t, content, ReadComposeOverrideContent(dir))
+}
+
+func TestResolveComposeOverride(t *testing.T) {
+ t.Parallel()
+
+ t.Run("returns highest-preference match", func(t *testing.T) {
+ t.Parallel()
+ available := map[string]string{
+ "compose.override.yml": "first\n",
+ "docker-compose.override.yaml": "second\n",
+ }
+ name, content, found, err := ResolveComposeOverride(
+ func(n string) bool { _, ok := available[n]; return ok },
+ func(n string) (string, error) { return available[n], nil },
+ )
+ require.NoError(t, err)
+ require.True(t, found)
+ // compose.override.yml precedes docker-compose.override.yaml in compose-go order.
+ assert.Equal(t, "compose.override.yml", name)
+ assert.Equal(t, "first\n", content)
+ })
+
+ t.Run("returns not found when nothing exists", func(t *testing.T) {
+ t.Parallel()
+ name, content, found, err := ResolveComposeOverride(
+ func(string) bool { return false },
+ func(string) (string, error) { return "", nil },
+ )
+ require.NoError(t, err)
+ assert.False(t, found)
+ assert.Empty(t, name)
+ assert.Empty(t, content)
+ })
+
+ t.Run("propagates read error", func(t *testing.T) {
+ t.Parallel()
+ _, _, found, err := ResolveComposeOverride(
+ func(string) bool { return true },
+ func(string) (string, error) { return "", errors.New("boom") },
+ )
+ require.Error(t, err)
+ assert.False(t, found)
+ })
+}
+
+func TestWriteComposeOverrideFile(t *testing.T) {
+ t.Parallel()
+
+ root := t.TempDir()
+ dir := filepath.Join(root, "proj")
+ require.NoError(t, os.MkdirAll(dir, 0o755))
+
+ // A stale override under a different candidate name should be cleaned up.
+ require.NoError(t, os.WriteFile(filepath.Join(dir, "docker-compose.override.yml"), []byte("stale\n"), 0o600))
+
+ content := "services:\n app:\n image: busybox:latest\n"
+ require.NoError(t, WriteComposeOverrideFile(t.Context(), root, dir, &content, "compose.override.yaml"))
+
+ written, err := os.ReadFile(filepath.Join(dir, "compose.override.yaml"))
+ require.NoError(t, err)
+ assert.Equal(t, content, string(written))
+
+ _, statErr := os.Stat(filepath.Join(dir, "docker-compose.override.yml"))
+ assert.True(t, os.IsNotExist(statErr))
+
+ // Nil content removes all override files.
+ require.NoError(t, WriteComposeOverrideFile(t.Context(), root, dir, nil, ""))
+ _, statErr = os.Stat(filepath.Join(dir, "compose.override.yaml"))
+ assert.True(t, os.IsNotExist(statErr))
+}
diff --git a/backend/pkg/projects/image_refs.go b/backend/pkg/projects/image_refs.go
index 9d1d60aa6..9b303abec 100644
--- a/backend/pkg/projects/image_refs.go
+++ b/backend/pkg/projects/image_refs.go
@@ -6,8 +6,12 @@ import (
"strings"
composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/containerd/platforms"
composeapi "github.com/docker/compose/v5/pkg/api"
+
projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+ "github.com/moby/moby/api/types/image"
+ "github.com/moby/moby/client"
)
// ParseImageRefsJSON parses a JSON array of image references, returning nil
@@ -120,3 +124,62 @@ func uniqueImageRefsInternal(size int, collect func(yield func(string))) []strin
return refs
}
+
+// PullableImageRefs includes service images and registry-only hook and volume images.
+func PullableImageRefs(project *composetypes.Project) []string {
+ if project == nil {
+ return nil
+ }
+ return uniqueImageRefsInternal(len(project.Services), func(yield func(string)) {
+ for _, service := range project.Services {
+ if service.Build == nil {
+ yield(service.Image)
+ }
+ for _, image := range composeapi.GetDependentImages(service, project.Name) {
+ yield(image)
+ }
+ for _, volume := range service.Volumes {
+ if volume.Type == composetypes.VolumeTypeImage {
+ yield(volume.Source)
+ }
+ }
+ }
+ })
+}
+
+// RefreshComposeImageLabel updates an existing Compose digest label in place.
+func RefreshComposeImageLabel(labels map[string]string, imageDigest string) {
+ if imageDigest == "" {
+ return
+ }
+ for key := range labels {
+ if strings.EqualFold(key, composeapi.ImageDigestLabel) {
+ labels[key] = imageDigest
+ }
+ }
+}
+
+// ComposeImageDigest selects the digest compose v5.5.0 records in the
+// com.docker.compose.image label: the host platform's image-manifest digest,
+// which stays stable across attested rebuilds, falling back to the top-level
+// image ID when the engine reports no manifest data (mirrors compose's
+// localContentDigest). Writing any other value would make compose flag the
+// container as diverged and recreate it on the next up.
+func ComposeImageDigest(inspect client.ImageInspectResult) string {
+ matcher := platforms.Default()
+ var available []image.ManifestSummary
+ for _, m := range inspect.Manifests {
+ if m.Kind == image.ManifestKindImage && m.Available {
+ available = append(available, m)
+ }
+ }
+ for _, m := range available {
+ if m.ImageData != nil && matcher.Match(m.ImageData.Platform) {
+ return m.ID
+ }
+ }
+ if len(available) == 1 {
+ return available[0].ID
+ }
+ return inspect.ID
+}
diff --git a/backend/pkg/projects/image_refs_test.go b/backend/pkg/projects/image_refs_test.go
index c2e1cb62c..b4baed844 100644
--- a/backend/pkg/projects/image_refs_test.go
+++ b/backend/pkg/projects/image_refs_test.go
@@ -54,7 +54,7 @@ func TestBuildImageRefsFromComposeProject_UsesMergedComposeOverrides(t *testing.
build: ./app
`), 0o644))
- project, err := LoadComposeProject(context.Background(), composePath, "override-demo", dir, false, nil, nil, nil, false)
+ project, err := LoadComposeProject(context.Background(), composePath, "override-demo", dir, false, nil, nil, nil, false, nil, nil)
require.NoError(t, err)
assert.Equal(t, []string{"overridden-app:latest"}, BuildImageRefsFromComposeProject(project))
diff --git a/backend/pkg/projects/load.go b/backend/pkg/projects/load.go
index bd418765c..b9df8508c 100644
--- a/backend/pkg/projects/load.go
+++ b/backend/pkg/projects/load.go
@@ -14,7 +14,6 @@ import (
"emperror.dev/emperror"
"emperror.dev/errors"
-
interp "github.com/compose-spec/compose-go/v2/interpolation"
"github.com/compose-spec/compose-go/v2/loader"
"github.com/compose-spec/compose-go/v2/template"
@@ -23,7 +22,7 @@ import (
"github.com/docker/compose/v5/pkg/api"
"github.com/docker/go-units"
"github.com/getarcaneapp/arcane/backend/v2/internal/common"
- projecttypes "github.com/getarcaneapp/arcane/backend/v2/pkg/projects/types"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
"github.com/samber/mo"
)
@@ -337,6 +336,8 @@ func LoadComposeProject(
envOverride EnvMap,
configureLoader func(*loader.Options),
lenient bool,
+ dependencies *projecttypes.ComposeDependencies,
+ services []string,
) (project *composetypes.Project, err error) {
defer recoverComposeLoadPanicInternal(ctx, composeFile, &project, &err)
@@ -418,13 +419,17 @@ func LoadComposeProject(
}
// Discard env_file after folding into environment, as the compose CLI
// does, so config-hashes match and both tools stop recreating services.
- loader.WithDiscardEnvFiles(opts)
+ if dependencies == nil {
+ loader.WithDiscardEnvFiles(opts)
+ }
if lenient {
ApplyLenientLoaderOptions(ctx, opts, composeFile)
}
if configureLoader != nil {
configureLoader(opts)
}
+ // Select before environment resolution and Arcane resource/path preparation.
+ loader.WithSelectedServices(services)(opts)
}}
project, err = loader.LoadWithContext(ctx, cfg, loaderOptions...)
@@ -432,6 +437,8 @@ func LoadComposeProject(
return nil, errors.WrapIf(err, "load compose project")
}
+ recordComposeDependenciesInternal(project, dependencies)
+
for _, configFile := range cfg.ConfigFiles {
project.ComposeFiles = append(project.ComposeFiles, configFile.Filename)
}
@@ -446,7 +453,7 @@ func LoadComposeProject(
return nil, err
}
- injectServiceConfiguration(project, injectionVars)
+ injectServiceConfigurationInternal(project, injectionVars)
return project, nil
}
@@ -558,7 +565,7 @@ func applyCustomLabelsInternal(projectName string, serviceName string, workingDi
}
}
-func injectServiceConfiguration(project *composetypes.Project, injectionVars EnvMap) {
+func injectServiceConfigurationInternal(project *composetypes.Project, injectionVars EnvMap) {
for i, s := range project.Services {
s.CustomLabels = applyCustomLabelsInternal(project.Name, s.Name, project.WorkingDir, project.ComposeFiles)
@@ -583,7 +590,7 @@ func LoadComposeProjectFromDir(ctx context.Context, dir, projectName, projectsDi
return nil, "", err
}
- proj, err := LoadComposeProject(ctx, composeFile, projectName, projectsDirectory, autoInjectEnv, pathMapper, nil, nil, false)
+ proj, err := LoadComposeProject(ctx, composeFile, projectName, projectsDirectory, autoInjectEnv, pathMapper, nil, nil, false, nil, nil)
if err != nil {
return nil, "", err
}
@@ -601,7 +608,7 @@ func ResolveRelativeProjectPaths(project *composetypes.Project, workdir string)
for i := range service.Volumes {
v := &service.Volumes[i]
if v.Type == composetypes.VolumeTypeBind {
- if resolved, ok := resolvePathRelative(workdir, v.Source).Get(); ok {
+ if resolved, ok := resolvePathRelativeInternal(workdir, v.Source).Get(); ok {
v.Source = resolved
modified = true
}
@@ -613,23 +620,130 @@ func ResolveRelativeProjectPaths(project *composetypes.Project, workdir string)
}
for name, secret := range project.Secrets {
- if resolved, ok := resolvePathRelative(workdir, secret.File).Get(); ok {
+ if resolved, ok := resolvePathRelativeInternal(workdir, secret.File).Get(); ok {
secret.File = resolved
project.Secrets[name] = secret
}
}
for name, config := range project.Configs {
- if resolved, ok := resolvePathRelative(workdir, config.File).Get(); ok {
+ if resolved, ok := resolvePathRelativeInternal(workdir, config.File).Get(); ok {
config.File = resolved
project.Configs[name] = config
}
}
}
-func resolvePathRelative(workdir, candidate string) mo.Option[string] {
+func resolvePathRelativeInternal(workdir, candidate string) mo.Option[string] {
if candidate == "" || filepath.IsAbs(candidate) || workdir == "" {
return mo.None[string]()
}
return mo.Some(filepath.Clean(filepath.Join(workdir, candidate)))
}
+
+func recordComposeDependenciesInternal(project *composetypes.Project, dependencies *projecttypes.ComposeDependencies) {
+ if dependencies != nil {
+ for name, service := range project.Services {
+ for _, envFile := range service.EnvFiles {
+ dependencies.EnvFiles = append(dependencies.EnvFiles, envFile.Path)
+ }
+ dependencies.EnvFiles = append(dependencies.EnvFiles, service.LabelFiles...)
+ service.EnvFiles = nil
+ project.Services[name] = service
+ }
+ }
+}
+
+// ValidateComposeContentForUpdate validates proposed editor content without persisting it.
+// Missing includes are tolerated here; deployment uses strict executable loading.
+func ValidateComposeContentForUpdate(ctx context.Context, projectsDirectory, projectPath, projectName, composeContent string, effectiveEnvContent *string, overrideContent *string, overrideFileName string, lenient bool) (err error) {
+ defer func() {
+ if panicErr := emperror.Recover(recover()); panicErr != nil {
+ err = errors.WrapIf(panicErr, "compose file contains invalid syntax")
+ }
+ }()
+
+ fullEnvMap, envErr := BuildValidationEnvironment(ctx, projectsDirectory, projectPath, effectiveEnvContent)
+ if envErr != nil {
+ return envErr
+ }
+
+ // COMPOSE_FILE in the (edited) env selects the exact file set, so validate
+ // against it — a save that introduces a broken selection fails fast.
+ envOpts, envOptsErr := ParseComposeEnvOptions(projectPath, fullEnvMap)
+ if envOptsErr != nil {
+ return envOptsErr
+ }
+
+ validationProjectName := NormalizeProjectName(projectName)
+ var configFiles []composetypes.ConfigFile
+ switch {
+ case len(envOpts.ConfigFiles) > 0:
+ // The compose tab edits the base (first) file. Later entries are read
+ // from disk; existence was already checked while parsing COMPOSE_FILE. An
+ // Arcane-managed override lives in the project root and only applies when
+ // that exact path is listed in the selection (docker skips auto-overrides
+ // for an explicit file set); a same-named file in a subdirectory is not
+ // the managed override.
+ overrideName := strings.TrimSpace(overrideFileName)
+ if overrideName == "" {
+ overrideName = DefaultComposeOverrideFileName
+ }
+ overridePath := ""
+ if absProjectPath, absErr := filepath.Abs(filepath.Clean(projectPath)); absErr == nil {
+ overridePath = filepath.Join(absProjectPath, overrideName)
+ }
+ for i, f := range envOpts.ConfigFiles {
+ switch {
+ case i == 0:
+ configFiles = append(configFiles, composetypes.ConfigFile{Filename: f, Content: []byte(composeContent)})
+ case overrideContent != nil && overridePath != "" && f == overridePath:
+ configFiles = append(configFiles, composetypes.ConfigFile{Filename: f, Content: []byte(*overrideContent)})
+ default:
+ configFiles = append(configFiles, composetypes.ConfigFile{Filename: f})
+ }
+ }
+ default:
+ configFiles = []composetypes.ConfigFile{
+ {Filename: filepath.Join(projectPath, "compose.yaml"), Content: []byte(composeContent)},
+ }
+ // When an override is supplied, validate the *merged* config as `docker
+ // compose` would deploy it. Overrides can add services and are layered on
+ // top (listed after the base so the override wins).
+ if overrideContent != nil {
+ overrideName := strings.TrimSpace(overrideFileName)
+ if overrideName == "" {
+ overrideName = DefaultComposeOverrideFileName
+ }
+ configFiles = append(configFiles, composetypes.ConfigFile{
+ Filename: filepath.Join(projectPath, overrideName),
+ Content: []byte(*overrideContent),
+ })
+ }
+ }
+
+ cfg := composetypes.ConfigDetails{
+ Version: api.ComposeVersion,
+ WorkingDir: projectPath,
+ ConfigFiles: configFiles,
+ Environment: composetypes.Mapping(fullEnvMap),
+ }
+
+ missingIncludeLoader := NewMissingIncludeStubLoader(projectPath)
+ defer missingIncludeLoader.Cleanup()
+
+ err = WithTransientValidationEnvFile(ctx, projectPath, effectiveEnvContent, func() error {
+ _, loadErr := loader.LoadWithContext(ctx, cfg, func(opts *loader.Options) {
+ opts.ResourceLoaders = append([]loader.ResourceLoader{missingIncludeLoader}, opts.ResourceLoaders...)
+ if validationProjectName != "" {
+ opts.SetProjectName(validationProjectName, false)
+ }
+ if lenient {
+ ApplyLenientLoaderOptions(ctx, opts, cfg.ConfigFiles[0].Filename)
+ }
+ })
+ return loadErr
+ })
+
+ return err
+}
diff --git a/backend/pkg/projects/load_test.go b/backend/pkg/projects/load_test.go
index 35f970ed1..b918533c3 100644
--- a/backend/pkg/projects/load_test.go
+++ b/backend/pkg/projects/load_test.go
@@ -151,7 +151,8 @@ func TestLoadComposeProject_MergesComposeOverrideFile(t *testing.T) {
require.NoError(t, os.WriteFile(basePath, []byte("services:\n app:\n image: nginx:alpine\n environment:\n FROM_BASE: \"1\"\n"), 0o600))
require.NoError(t, os.WriteFile(overridePath, []byte("services:\n app:\n image: busybox:latest\n environment:\n FROM_OVERRIDE: \"1\"\n"), 0o600))
- project, err := LoadComposeProject(context.Background(), basePath, "demo", dir, false, nil, nil, nil, false)
+ cache := NewParsedComposeCache()
+ project, err := LoadCachedComposeProject(t.Context(), cache, "demo-id", dir, basePath, "demo", dir, false, nil)
require.NoError(t, err)
require.NotNil(t, project)
@@ -160,6 +161,11 @@ func TestLoadComposeProject_MergesComposeOverrideFile(t *testing.T) {
assert.Contains(t, app.Environment, "FROM_BASE")
assert.Contains(t, app.Environment, "FROM_OVERRIDE")
assert.Equal(t, []string{basePath, overridePath}, project.ComposeFiles)
+
+ delete(project.Services, "app")
+ cached, err := LoadCachedComposeProject(t.Context(), cache, "demo-id", dir, basePath, "demo", dir, false, nil)
+ require.NoError(t, err)
+ assert.Equal(t, "busybox:latest", cached.Services["app"].Image)
}
func TestLoadComposeProject_ComposeFileEnvSelectsFilesAndSkipsOverride(t *testing.T) {
@@ -175,7 +181,7 @@ func TestLoadComposeProject_ComposeFileEnvSelectsFilesAndSkipsOverride(t *testin
require.NoError(t, os.WriteFile(filepath.Join(dir, "compose.override.yaml"), []byte("services:\n app:\n image: alpine:3\n"), 0o600))
require.NoError(t, os.WriteFile(filepath.Join(dir, ".env"), []byte("COMPOSE_FILE=base.yml:sub/extra.yml\n"), 0o600))
- project, err := LoadComposeProject(context.Background(), basePath, "demo", dir, false, nil, nil, nil, false)
+ project, err := LoadComposeProject(context.Background(), basePath, "demo", dir, false, nil, nil, nil, false, nil, nil)
require.NoError(t, err)
require.NotNil(t, project)
@@ -223,7 +229,7 @@ func TestLoadComposeProject_ArcaneProcessEnvInterpolation(t *testing.T) {
basePath := filepath.Join(dir, "compose.yaml")
require.NoError(t, os.WriteFile(basePath, []byte(tc.compose), 0o600))
- project, err := LoadComposeProject(context.Background(), basePath, "demo", dir, false, nil, nil, nil, false)
+ project, err := LoadComposeProject(context.Background(), basePath, "demo", dir, false, nil, nil, nil, false, nil, nil)
require.NoError(t, err)
require.NotNil(t, project)
@@ -244,7 +250,7 @@ func TestLoadComposeProject_DoesNotMergeOverrideForCustomBaseName(t *testing.T)
require.NoError(t, os.WriteFile(basePath, []byte("services:\n app:\n image: nginx:alpine\n environment:\n FROM_BASE: \"1\"\n"), 0o600))
require.NoError(t, os.WriteFile(overridePath, []byte("services:\n app:\n image: busybox:latest\n environment:\n FROM_OVERRIDE: \"1\"\n"), 0o600))
- project, err := LoadComposeProject(context.Background(), basePath, "demo", dir, false, nil, nil, nil, false)
+ project, err := LoadComposeProject(context.Background(), basePath, "demo", dir, false, nil, nil, nil, false, nil, nil)
require.NoError(t, err)
require.NotNil(t, project)
@@ -347,7 +353,7 @@ func TestLoadComposeProjectLenient_ToleratesUndefinedVariables(t *testing.T) {
- ${CONFIG_FILE}:/etc/app/app.conf
`), 0o600))
- project, err := LoadComposeProject(context.Background(), composePath, "demo", dir, false, nil, nil, nil, true)
+ project, err := LoadComposeProject(context.Background(), composePath, "demo", dir, false, nil, nil, nil, true, nil, nil)
require.NoError(t, err)
require.NotNil(t, project)
assert.Len(t, project.Services, 1)
@@ -373,7 +379,7 @@ func TestLoadComposeProjectLenient_ToleratesUndefinedTypedFieldVariables(t *test
memory: ${MEMORY}
`), 0o600))
- project, err := LoadComposeProject(context.Background(), composePath, "demo", dir, false, nil, nil, nil, true)
+ project, err := LoadComposeProject(context.Background(), composePath, "demo", dir, false, nil, nil, nil, true, nil, nil)
require.NoError(t, err)
require.NotNil(t, project)
assert.Len(t, project.Services, 1)
@@ -398,7 +404,7 @@ func TestLoadComposeProjectLenient_AppliesVariableDefaults(t *testing.T) {
- MAX_FILE_SIZE=${ARCANE_TEST_UNSET_SIZE:-104857600}
`), 0o600))
- project, err := LoadComposeProject(context.Background(), composePath, "demo", dir, false, nil, nil, nil, true)
+ project, err := LoadComposeProject(context.Background(), composePath, "demo", dir, false, nil, nil, nil, true, nil, nil)
require.NoError(t, err)
require.NotNil(t, project)
require.Len(t, project.Services, 1)
@@ -419,6 +425,11 @@ func TestLoadComposeProject_UsesProjectLevelComposeLabelsForIncludedServices(t *
require.NoError(t, os.WriteFile(includePath, []byte(`services:
included:
image: nginx:alpine
+ profiles: [manual]
+ volumes:
+ - included-data:/data
+volumes:
+ included-data:
`), 0o600))
require.NoError(t, os.WriteFile(composePath, []byte(`include:
- included.compose.yaml
@@ -427,12 +438,15 @@ services:
image: busybox:latest
`), 0o600))
- project, err := LoadComposeProject(context.Background(), composePath, "demo", projectDir, false, nil, nil, nil, false)
+ project, err := LoadComposeProject(context.Background(), composePath, "demo", projectDir, false, nil, nil, nil, false, nil, []string{"root", "included"})
require.NoError(t, err)
require.NotNil(t, project)
rootService := project.Services["root"]
includedService := project.Services["included"]
+ require.Contains(t, project.Services, "included")
+ require.Contains(t, project.Volumes, "included-data")
+ require.Equal(t, "demo_included-data", project.Volumes["included-data"].Name)
expectedConfigFiles := strings.Join(project.ComposeFiles, ",")
require.Equal(t, []string{composePath}, project.ComposeFiles)
@@ -477,7 +491,7 @@ services:
composePath := filepath.Join(projectDir, "compose.yaml")
require.NoError(t, os.WriteFile(composePath, []byte(tt.composeBody), 0o600))
- project, err := LoadComposeProject(context.Background(), composePath, "aitools", projectDir, false, nil, nil, nil, false)
+ project, err := LoadComposeProject(context.Background(), composePath, "aitools", projectDir, false, nil, nil, nil, false, nil, nil)
require.NoError(t, err)
require.NotNil(t, project)
require.Equal(t, tt.wantName, project.Name)
@@ -500,7 +514,7 @@ func TestResolveRelativeProjectPaths(t *testing.T) {
- ./config.conf:/etc/app/config.conf
`), 0o600))
- project, err := LoadComposeProject(context.Background(), composePath, "demo", dir, false, nil, nil, nil, false)
+ project, err := LoadComposeProject(context.Background(), composePath, "demo", dir, false, nil, nil, nil, false, nil, nil)
require.NoError(t, err)
ResolveRelativeProjectPaths(project, dir)
@@ -534,7 +548,7 @@ func TestLoadComposeProject_RemapsRelativeBindEscapingProjectsMount(t *testing.T
pathMapper := NewPathMapper(projectsRoot, "/docker/112/arcane/arcane-data/projects")
require.True(t, pathMapper.IsNonMatchingMount())
- project, err := LoadComposeProject(context.Background(), composePath, "goclaw", projectsRoot, false, pathMapper, nil, nil, false)
+ project, err := LoadComposeProject(context.Background(), composePath, "goclaw", projectsRoot, false, pathMapper, nil, nil, false, nil, nil)
require.NoError(t, err)
sources := make(map[string]string)
diff --git a/backend/pkg/projects/name.go b/backend/pkg/projects/name.go
deleted file mode 100644
index 6cbd765ff..000000000
--- a/backend/pkg/projects/name.go
+++ /dev/null
@@ -1,40 +0,0 @@
-package projects
-
-import (
- "strings"
-
- "github.com/compose-spec/compose-go/v2/loader"
- "go.yaml.in/yaml/v4"
-)
-
-// ComposeContentProjectName returns the normalized top-level `name:` from
-// compose YAML content, or "" when the key is absent or unusable. Interpolated
-// names (containing `${`) are treated as absent so the backend and the
-// frontend name lock behave identically; parse errors are ignored here because
-// the full compose validation reports them with proper context.
-func ComposeContentProjectName(composeContent string) string {
- var doc struct {
- Name string `yaml:"name"`
- }
- if err := yaml.Unmarshal([]byte(composeContent), &doc); err != nil {
- return ""
- }
- raw := strings.TrimSpace(doc.Name)
- if raw == "" || strings.Contains(raw, "${") {
- return ""
- }
- 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
deleted file mode 100644
index 426b5ccb9..000000000
--- a/backend/pkg/projects/name_test.go
+++ /dev/null
@@ -1,66 +0,0 @@
-package projects
-
-import (
- "testing"
-
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
-)
-
-func TestComposeContentProjectName(t *testing.T) {
- tests := []struct {
- name string
- content string
- want string
- }{
- {"literal name", "name: sabnzbd\nservices:\n sabnzbd:\n image: nginx\n", "sabnzbd"},
- {"normalized", "name: My_App 2\nservices: {}\n", "my_app2"},
- {"absent", "services: {}\n", ""},
- {"interpolated", "name: ${PROJECT}\nservices: {}\n", ""},
- {"invalid yaml", "name: [unclosed\n", ""},
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- {
- got := ComposeContentProjectName(tt.content)
- assert.Equal(t, tt.want, got,
- "ComposeContentProjectName() = %q, want %q", got, tt.want)
- }
-
- })
- }
-}
-
-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)
-
- require.Equal(t, tt.expected, got,
- "NormalizeProjectName() = %q, want %q", got, tt.expected)
-
- })
- }
-}
diff --git a/backend/pkg/projects/path_mapper.go b/backend/pkg/projects/path_mapper.go
index 7d983f109..54421d152 100644
--- a/backend/pkg/projects/path_mapper.go
+++ b/backend/pkg/projects/path_mapper.go
@@ -9,7 +9,9 @@ import (
"emperror.dev/errors"
composetypes "github.com/compose-spec/compose-go/v2/types"
- projecttypes "github.com/getarcaneapp/arcane/backend/v2/pkg/projects/types"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+ mounttypes "github.com/moby/moby/api/types/mount"
"github.com/moby/moby/client"
"github.com/samber/mo"
)
@@ -498,3 +500,52 @@ func IsWindowsDrivePath(candidate string) bool {
candidate[1] == ':' &&
(candidate[2] == '/' || candidate[2] == '\\')
}
+
+// GetCurrentContainerMounts inspects Arcane's own container and returns its bind and
+// named-volume mounts as HostMount entries. It returns no mounts when Arcane is
+// not running in a container (or the daemon is unreachable). This is the basis for
+// Docker-in-Docker host-path resolution.
+func GetCurrentContainerMounts(ctx context.Context, dockerCli *client.Client) ([]HostMount, error) {
+ if dockerCli == nil {
+ return nil, nil // No docker client, can't discover
+ }
+
+ // Label-fallback detection matters here: with network_mode: service:<sidecar>
+ // the hostname identifies the sidecar, whose mounts do not include
+ // docker.sock — breaking host-path resolution for the self-upgrader (#3544).
+ inspect, err := libarcane.InspectCurrentArcaneContainer(ctx, dockerCli)
+ if err != nil {
+ // Not running in a container or can't reach docker daemon
+ return nil, err
+ }
+
+ mounts := make([]HostMount, 0, len(inspect.Mounts))
+ for i := range inspect.Mounts {
+ m := &inspect.Mounts[i]
+ if m.Type != mounttypes.TypeBind && m.Type != mounttypes.TypeVolume {
+ continue
+ }
+ if strings.TrimSpace(m.Source) == "" || strings.TrimSpace(m.Destination) == "" {
+ continue
+ }
+ mounts = append(mounts, HostMount{Destination: m.Destination, Source: m.Source})
+ }
+ return mounts, nil
+}
+
+// GetHostPathForContainerPath attempts to discover the host-side path for a given container path
+// by inspecting the container itself. This is useful for Docker-in-Docker scenarios
+// where the application needs to know host paths for volume mapping. It returns an empty
+// string when the path is not covered by any of Arcane's mounts.
+func GetHostPathForContainerPath(ctx context.Context, dockerCli *client.Client, containerPath string) (string, error) {
+ mounts, err := GetCurrentContainerMounts(ctx, dockerCli)
+ if err != nil {
+ return "", err
+ }
+
+ if host, ok := ResolveHostPath(mounts, containerPath).Get(); ok {
+ return host, nil
+ }
+
+ return "", nil
+}
diff --git a/backend/pkg/projects/ports.go b/backend/pkg/projects/ports.go
deleted file mode 100644
index 5833ea4f7..000000000
--- a/backend/pkg/projects/ports.go
+++ /dev/null
@@ -1,36 +0,0 @@
-package projects
-
-import (
- "fmt"
-
- "github.com/docker/compose/v5/pkg/api"
- "github.com/moby/moby/api/types/container"
-)
-
-// FormatPorts renders compose port publishers as "published:target/proto"
-// (or "target/proto" when the port is not published).
-func FormatPorts(publishers []api.PortPublisher) []string {
- var ports []string
- for _, pub := range publishers {
- if pub.PublishedPort > 0 {
- ports = append(ports, fmt.Sprintf("%d:%d/%s", pub.PublishedPort, pub.TargetPort, pub.Protocol))
- } else {
- ports = append(ports, fmt.Sprintf("%d/%s", pub.TargetPort, pub.Protocol))
- }
- }
- return ports
-}
-
-// FormatDockerPorts renders container port summaries in the same shape as
-// FormatPorts, for containers Arcane sees outside a compose project.
-func FormatDockerPorts(ports []container.PortSummary) []string {
- var res []string
- for _, p := range ports {
- if p.PublicPort == 0 {
- res = append(res, fmt.Sprintf("%d/%s", p.PrivatePort, p.Type))
- } else {
- res = append(res, fmt.Sprintf("%d:%d/%s", p.PublicPort, p.PrivatePort, p.Type))
- }
- }
- return res
-}
diff --git a/backend/pkg/projects/ports_test.go b/backend/pkg/projects/ports_test.go
deleted file mode 100644
index 82a1e9074..000000000
--- a/backend/pkg/projects/ports_test.go
+++ /dev/null
@@ -1,43 +0,0 @@
-package projects
-
-import (
- "testing"
-
- "github.com/moby/moby/api/types/container"
- "github.com/stretchr/testify/assert"
-)
-
-func TestFormatDockerPorts(t *testing.T) {
- tests := []struct {
- name string
- input []container.PortSummary
- expected []string
- }{
- {
- name: "public port",
- input: []container.PortSummary{
- {PublicPort: 8080, PrivatePort: 80, Type: "tcp"},
- },
- expected: []string{"8080:80/tcp"},
- },
- {
- name: "private only",
- input: []container.PortSummary{
- {PrivatePort: 80, Type: "tcp"},
- },
- expected: []string{"80/tcp"},
- },
- {
- name: "empty",
- input: []container.PortSummary{},
- expected: nil,
- },
- }
-
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := FormatDockerPorts(tt.input)
- assert.Equal(t, tt.expected, got)
- })
- }
-}
diff --git a/backend/pkg/projects/project_tags.go b/backend/pkg/projects/project_tags.go
deleted file mode 100644
index b4c6f8044..000000000
--- a/backend/pkg/projects/project_tags.go
+++ /dev/null
@@ -1,81 +0,0 @@
-package projects
-
-import (
- "errors"
- "fmt"
- "strings"
- "unicode"
-
- projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
-)
-
-const (
- // ProjectTagMaxLength is the maximum number of Unicode characters in a tag name.
- ProjectTagMaxLength = 64
- // ProjectTagsPerSourceLimit is the maximum number of UI or Compose tags on one project.
- ProjectTagsPerSourceLimit = 50
-)
-
-var projectTagColorsInternal = map[projecttypes.TagColor]struct{}{
- projecttypes.TagColorGray: {},
- projecttypes.TagColorPurple: {},
- projecttypes.TagColorBlue: {},
- projecttypes.TagColorGreen: {},
- projecttypes.TagColorYellow: {},
- projecttypes.TagColorOrange: {},
- projecttypes.TagColorRed: {},
- projecttypes.TagColorPink: {},
-}
-
-// NormalizeProjectTag validates and normalizes a project tag name.
-func NormalizeProjectTag(name string) (string, error) {
- normalized := strings.ToLower(strings.TrimSpace(name))
- if normalized == "" {
- return "", errors.New("tag name cannot be empty")
- }
- if len([]rune(normalized)) > ProjectTagMaxLength {
- return "", fmt.Errorf("tag name cannot exceed %d characters", ProjectTagMaxLength)
- }
- if strings.ContainsRune(normalized, ',') {
- return "", errors.New("tag name cannot contain commas")
- }
- for _, char := range normalized {
- if unicode.IsControl(char) {
- return "", errors.New("tag name cannot contain control characters")
- }
- }
- return normalized, nil
-}
-
-// NormalizeProjectTags validates, normalizes, and de-duplicates project tags.
-func NormalizeProjectTags(names []string) ([]string, error) {
- result := make([]string, 0, min(len(names), ProjectTagsPerSourceLimit))
- seen := make(map[string]struct{}, len(names))
- for _, name := range names {
- normalized, err := NormalizeProjectTag(name)
- if err != nil {
- return nil, err
- }
- if _, exists := seen[normalized]; exists {
- continue
- }
- if len(result) >= ProjectTagsPerSourceLimit {
- return nil, fmt.Errorf("a project cannot have more than %d tags per source", ProjectTagsPerSourceLimit)
- }
- seen[normalized] = struct{}{}
- result = append(result, normalized)
- }
- return result, nil
-}
-
-// NormalizeProjectTagColor validates and normalizes a project tag color.
-func NormalizeProjectTagColor(color projecttypes.TagColor) (projecttypes.TagColor, error) {
- normalized := projecttypes.TagColor(strings.ToLower(strings.TrimSpace(string(color))))
- if normalized == "" {
- return projecttypes.TagColorGray, nil
- }
- if _, valid := projectTagColorsInternal[normalized]; !valid {
- return "", fmt.Errorf("unsupported tag color %q", color)
- }
- return normalized, nil
-}
diff --git a/backend/pkg/projects/project_tags_test.go b/backend/pkg/projects/project_tags_test.go
deleted file mode 100644
index c0e6eb347..000000000
--- a/backend/pkg/projects/project_tags_test.go
+++ /dev/null
@@ -1,26 +0,0 @@
-package projects
-
-import (
- "strings"
- "testing"
-
- "github.com/stretchr/testify/require"
-)
-
-func TestNormalizeProjectTags(t *testing.T) {
- tags, err := NormalizeProjectTags([]string{" Database ", "DATABASE", "maintenance-window"})
- require.NoError(t, err)
- require.Equal(t, []string{"database", "maintenance-window"}, tags)
-
- for _, invalid := range []string{"", "bad,tag", "bad\ntag", strings.Repeat("a", ProjectTagMaxLength+1)} {
- _, err := NormalizeProjectTag(invalid)
- require.Error(t, err, invalid)
- }
-
- tooMany := make([]string, ProjectTagsPerSourceLimit+1)
- for index := range tooMany {
- tooMany[index] = "tag-" + strings.Repeat("x", index/10) + string(rune('a'+index%10))
- }
- _, err = NormalizeProjectTags(tooMany)
- require.Error(t, err)
-}
diff --git a/backend/pkg/projects/service_selection.go b/backend/pkg/projects/service_selection.go
deleted file mode 100644
index 476c152a6..000000000
--- a/backend/pkg/projects/service_selection.go
+++ /dev/null
@@ -1,106 +0,0 @@
-package projects
-
-import (
- "strings"
- "time"
-
- composetypes "github.com/compose-spec/compose-go/v2/types"
-)
-
-// NormalizeBuildSelections turns a user-supplied service list into a lookup set,
-// dropping blanks. An empty set means "every service".
-func NormalizeBuildSelections(services []string) map[string]struct{} {
- selected := map[string]struct{}{}
- for _, name := range services {
- name = strings.TrimSpace(name)
- if name == "" {
- continue
- }
- selected[name] = struct{}{}
- }
- return selected
-}
-
-// ServiceSelected reports whether name is in the selection built by
-// NormalizeBuildSelections. An empty selection selects everything.
-func ServiceSelected(selected map[string]struct{}, name string) bool {
- if len(selected) == 0 {
- return true
- }
- _, ok := selected[name]
- return ok
-}
-
-// EnsureServiceImage gives a build-only service a deterministic local image tag
-// so the built image has a stable name to deploy from. It reports whether the
-// service config was changed.
-func EnsureServiceImage(projectID, projectName, serviceName string, svc composetypes.ServiceConfig) (string, composetypes.ServiceConfig, bool) {
- imageName := strings.TrimSpace(svc.Image)
- if imageName == "" {
- imageName = BuildLocalImageTag(projectID, projectName, serviceName)
- svc.Image = imageName
- return imageName, svc, true
- }
- return imageName, svc, false
-}
-
-// PrepareDeployServiceConfig resolves the image a service deploys as, naming
-// build-only services via EnsureServiceImage. It reports whether the service
-// config was changed.
-func PrepareDeployServiceConfig(projectID, projectName, serviceName string, svc composetypes.ServiceConfig) (composetypes.ServiceConfig, string, bool) {
- if svc.Build == nil {
- return svc, strings.TrimSpace(svc.Image), false
- }
-
- resolvedImage, updatedSvc, updated := EnsureServiceImage(projectID, projectName, serviceName, svc)
- return updatedSvc, resolvedImage, updated
-}
-
-// ShouldPullDeployImage reports whether a deploy must pull, given the resolved
-// pull decision, whether the image is already present locally, and when the
-// local image was last tagged (zero when unknown). Refresh policies mirror
-// compose v5.5.0's `up`: a present image is re-pulled only once its window
-// has elapsed since the engine's last-tag time.
-func ShouldPullDeployImage(decision DeployImageDecision, exists bool, lastTagged time.Time) bool {
- if decision.PullAlways {
- return true
- }
- if !exists {
- return decision.PullIfMissing || decision.PullIfStale
- }
- if decision.PullIfStale {
- return lastTagged.IsZero() || time.Now().After(lastTagged.Add(decision.StaleAfter))
- }
- return false
-}
-
-// SelectedImageRefs returns the distinct pullable image refs of the selected
-// services — build services are excluded, since their images come from a build.
-func SelectedImageRefs(compProj *composetypes.Project, servicesToUpdate []string) []string {
- if compProj == nil {
- return nil
- }
-
- selected := NormalizeBuildSelections(servicesToUpdate)
- refs := make([]string, 0, len(compProj.Services))
- seen := make(map[string]struct{}, len(compProj.Services))
-
- for name, svc := range compProj.Services {
- if !ServiceSelected(selected, name) || svc.Build != nil {
- continue
- }
-
- imageRef := strings.TrimSpace(svc.Image)
- if imageRef == "" {
- continue
- }
- if _, exists := seen[imageRef]; exists {
- continue
- }
-
- seen[imageRef] = struct{}{}
- refs = append(refs, imageRef)
- }
-
- return refs
-}
diff --git a/backend/pkg/projects/volume_migration.go b/backend/pkg/projects/volume_migration.go
new file mode 100644
index 000000000..76acd4894
--- /dev/null
+++ b/backend/pkg/projects/volume_migration.go
@@ -0,0 +1,372 @@
+package projects
+
+import (
+ "context"
+ stderrors "errors"
+ "log/slog"
+ "maps"
+ "os"
+ "strings"
+
+ "emperror.dev/errors"
+ composetemplate "github.com/compose-spec/compose-go/v2/template"
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ cerrdefs "github.com/containerd/errdefs"
+ "github.com/docker/compose/v5/pkg/api"
+ composepkg "github.com/docker/compose/v5/pkg/compose"
+ dockerutil "github.com/getarcaneapp/arcane/backend/v2/pkg/dockerutil"
+ "github.com/getarcaneapp/arcane/backend/v2/pkg/libarcane/volumes"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
+ "github.com/moby/moby/client"
+ "go.yaml.in/yaml/v4"
+)
+
+func PlanVolumeMigration(ctx context.Context, dockerClient *client.Client, composeProject *composetypes.Project, oldComposeName, newComposeName string, toolsImage string) (volumetypes.Migration, error) {
+ if dockerClient == nil {
+ return nil, errors.New("docker service unavailable")
+ }
+ if composeProject == nil || len(composeProject.Volumes) == 0 {
+ return nil, nil
+ }
+ if strings.TrimSpace(oldComposeName) == "" || strings.TrimSpace(newComposeName) == "" || oldComposeName == newComposeName {
+ return nil, nil
+ }
+
+ explicitVolumeNames, err := composeVolumeKeysWithExplicitNameInternal(composeProject.ComposeFiles)
+ if err != nil {
+ return nil, errors.WrapIf(err, "failed to parse compose volume names")
+ }
+
+ entries, err := collectProjectRenameVolumeEntriesInternal(ctx, dockerClient, composeProject.Volumes, explicitVolumeNames, oldComposeName, newComposeName)
+ if err != nil {
+ return nil, err
+ }
+
+ if len(entries) == 0 {
+ return nil, nil
+ }
+
+ return volumes.NewMigration(dockerClient, entries, oldComposeName, newComposeName, toolsImage), nil
+}
+
+func collectProjectRenameVolumeEntriesInternal(ctx context.Context, dockerClient *client.Client, volumes map[string]composetypes.VolumeConfig, explicitVolumeNames map[string]struct{}, oldComposeName, newComposeName string) ([]volumetypes.RenameEntry, error) {
+ entries := make([]volumetypes.RenameEntry, 0, len(volumes))
+ for key, volumeConfig := range volumes {
+ entry, ok, err := inspectProjectRenameVolumeEntryInternal(ctx, dockerClient, key, volumeConfig, explicitVolumeNames, oldComposeName, newComposeName)
+ if err != nil {
+ return nil, err
+ }
+ if ok {
+ entries = append(entries, entry)
+ }
+ }
+ return entries, nil
+}
+
+func inspectProjectRenameVolumeEntryInternal(ctx context.Context, dockerClient *client.Client, key string, volumeConfig composetypes.VolumeConfig, explicitVolumeNames map[string]struct{}, oldComposeName, newComposeName string) (volumetypes.RenameEntry, bool, error) {
+ if _, explicit := explicitVolumeNames[key]; explicit || bool(volumeConfig.External) {
+ return volumetypes.RenameEntry{}, false, nil
+ }
+
+ oldName := oldComposeName + "_" + key
+ newName := newComposeName + "_" + key
+ if oldName == newName || (volumeConfig.Name != oldName && volumeConfig.Name != newName) {
+ return volumetypes.RenameEntry{}, false, nil
+ }
+
+ if err := volumes.EnsureRenameTargetAbsent(ctx, dockerClient, newName); err != nil {
+ return volumetypes.RenameEntry{}, false, err
+ }
+
+ oldVolume, err := dockerClient.VolumeInspect(ctx, oldName, client.VolumeInspectOptions{})
+ if err != nil {
+ if cerrdefs.IsNotFound(err) {
+ return volumetypes.RenameEntry{}, false, nil
+ }
+ return volumetypes.RenameEntry{}, false, errors.WrapIff(err, "inspect source volume %s", oldName)
+ }
+ if err := volumes.EnsureRenameSourceDetached(ctx, dockerClient, oldName); err != nil {
+ return volumetypes.RenameEntry{}, false, err
+ }
+
+ newConfig := buildProjectRenamedVolumeConfigInternal(volumeConfig, key, newName, newComposeName)
+ createOptions, err := renamedVolumeCreateOptionsInternal(newConfig, oldVolume.Volume.Labels)
+ if err != nil {
+ return volumetypes.RenameEntry{}, false, err
+ }
+ return volumetypes.RenameEntry{
+ Key: key,
+ OldName: oldName,
+ NewName: newName,
+ OldVolume: oldVolume.Volume,
+ CreateOptions: createOptions,
+ }, true, nil
+}
+
+func buildProjectRenamedVolumeConfigInternal(volumeConfig composetypes.VolumeConfig, key, newName, newComposeName string) composetypes.VolumeConfig {
+ newConfig := volumeConfig
+ newConfig.Name = newName
+ newConfig.CustomLabels = composetypes.Labels{
+ api.VolumeLabel: key,
+ api.ProjectLabel: newComposeName,
+ api.VersionLabel: api.ComposeVersion,
+ }
+ return newConfig
+}
+
+func renamedVolumeCreateOptionsInternal(config composetypes.VolumeConfig, oldLabels map[string]string) (client.VolumeCreateOptions, error) {
+ labels := map[string]string{}
+ maps.Copy(labels, oldLabels)
+ maps.Copy(labels, config.Labels)
+ maps.Copy(labels, config.CustomLabels)
+ hash, err := composepkg.VolumeHash(config)
+ if err != nil {
+ return client.VolumeCreateOptions{}, errors.WrapIff(err, "hash target volume %s", config.Name)
+ }
+ labels[api.ConfigHashLabel] = hash
+ return client.VolumeCreateOptions{Name: config.Name, Driver: config.Driver, DriverOpts: config.DriverOpts, Labels: labels}, nil
+}
+
+func composeVolumeKeysWithExplicitNameInternal(composeFiles []string) (map[string]struct{}, error) {
+ explicit := make(map[string]struct{})
+ for _, composeFile := range composeFiles {
+ composeFile = strings.TrimSpace(composeFile)
+ if composeFile == "" {
+ continue
+ }
+ keys, err := composeVolumeKeysWithExplicitNameInFileInternal(composeFile)
+ if err != nil {
+ return nil, err
+ }
+ for key := range keys {
+ explicit[key] = struct{}{}
+ }
+ }
+ return explicit, nil
+}
+
+func composeVolumeKeysWithExplicitNameInFileInternal(path string) (map[string]struct{}, error) {
+ // os.* rather than acfs: compose config files may live outside the project
+ // directory (e.g. via include), so no single confinement root covers them.
+ content, err := os.ReadFile(path)
+ if err != nil {
+ return nil, errors.WrapIf(err, "read compose file")
+ }
+
+ composeData := map[string]any{}
+ if err := yaml.Unmarshal(content, &composeData); err != nil {
+ return nil, errors.WrapIf(err, "parse compose file")
+ }
+
+ rawVolumes, ok := composeData["volumes"]
+ if !ok || rawVolumes == nil {
+ return map[string]struct{}{}, nil
+ }
+
+ volumes, ok := rawVolumes.(map[string]any)
+ if !ok {
+ return nil, errors.New("parse compose file: volumes must be a mapping")
+ }
+
+ explicit := make(map[string]struct{})
+ for key, rawVolume := range volumes {
+ key = strings.TrimSpace(key)
+ if key == "" {
+ continue
+ }
+ volumeConfig, ok := rawVolume.(map[string]any)
+ if !ok {
+ continue
+ }
+ rawName, hasName := volumeConfig["name"]
+ if !hasName {
+ continue
+ }
+ name, ok := rawName.(string)
+ if ok && len(composetemplate.ExtractVariables(map[string]any{"name": name}, nil)) == 0 {
+ explicit[key] = struct{}{}
+ }
+ }
+
+ return explicit, nil
+}
+
+func ApplyRenameVolumeMigration(ctx context.Context, operations projecttypes.RenameRecoveryOperations, volumeMigration volumetypes.Migration, renameJournal *projecttypes.RenameJournal, applied *bool) error {
+ if volumeMigration == nil {
+ return nil
+ }
+ if err := volumeMigration.Apply(ctx); err != nil {
+ return errors.WrapIf(err, "failed to rename project volumes")
+ }
+ *applied = true
+ return operations.WriteJournal(ctx, renameJournal, projecttypes.RenameJournalPhaseTargetsCopied)
+}
+
+func FinalizeRenameAfterCommit(ctx context.Context, operations projecttypes.RenameRecoveryOperations, projectID string, volumeMigration volumetypes.Migration, renameJournal *projecttypes.RenameJournal, journalActive *bool) {
+ if renameJournal != nil {
+ if err := operations.WriteJournal(ctx, renameJournal, projecttypes.RenameJournalPhaseProjectStateCommitted); err != nil {
+ slog.WarnContext(ctx, "failed to mark project rename journal committed", "projectID", projectID, "error", err)
+ }
+ }
+
+ if committer, ok := volumeMigration.(volumetypes.Committer); ok {
+ if err := committer.Commit(ctx); err != nil {
+ slog.WarnContext(ctx, "failed to clean up project source volumes after committed rename", "projectID", projectID, "error", err)
+ var cleanupErr *volumetypes.SourceCleanupError
+ if errors.As(err, &cleanupErr) {
+ if writeErr := operations.WriteJournal(ctx, renameJournal, projecttypes.RenameJournalPhaseSourceCleanupPending); writeErr != nil {
+ slog.WarnContext(ctx, "failed to mark project rename source cleanup pending", "projectID", projectID, "error", writeErr)
+ }
+ }
+ return
+ } else if err := operations.WriteJournal(ctx, renameJournal, projecttypes.RenameJournalPhaseOldVolumesRemoved); err != nil {
+ slog.WarnContext(ctx, "failed to mark old project rename volumes removed", "projectID", projectID, "error", err)
+ }
+ }
+
+ completeRenameJournalInternal(ctx, operations, renameJournal, projectID, journalActive)
+}
+
+func completeRenameJournalInternal(ctx context.Context, operations projecttypes.RenameRecoveryOperations, renameJournal *projecttypes.RenameJournal, projectID string, journalActive *bool) {
+ if renameJournal == nil {
+ return
+ }
+ if clearErr := operations.ClearJournal(ctx, projectID); clearErr != nil {
+ slog.WarnContext(ctx, "failed to clear project rename journal", "projectID", projectID, "error", clearErr)
+ return
+ }
+ *journalActive = false
+}
+
+func renameJournalTargetsCopiedInternal(phase string) bool {
+ switch phase {
+ case projecttypes.RenameJournalPhaseTargetsCopied,
+ projecttypes.RenameJournalPhaseOldVolumesRemoved,
+ projecttypes.RenameJournalPhaseProjectStateCommitted,
+ projecttypes.RenameJournalPhaseSourceCleanupPending:
+ return true
+ default:
+ return false
+ }
+}
+
+func RenameJournalFilesystemSyncPending(phase string) bool {
+ switch phase {
+ case projecttypes.RenameJournalPhaseStarted,
+ projecttypes.RenameJournalPhaseTargetsCopied:
+ return true
+ default:
+ return false
+ }
+}
+
+func cleanupRenameJournalSourcesInternal(ctx context.Context, operations projecttypes.RenameRecoveryOperations, journal *projecttypes.RenameJournal) error {
+ dockerClient, err := operations.Docker(ctx, len(journal.Volumes) > 0)
+ if err != nil {
+ return err
+ }
+
+ if err := volumes.EnsureTargetsReadyForCleanup(ctx, dockerClient, journal.Volumes); err != nil {
+ var missingWithSource *volumetypes.TargetMissingWithSourceError
+ if errors.As(err, &missingWithSource) {
+ slog.WarnContext(ctx, "rolling back project rename because target volume is missing and source volume remains", "projectID", journal.ProjectID, "sourceVolume", missingWithSource.SourceVolume, "targetVolume", missingWithSource.TargetVolume)
+ return rollbackRenameJournalInternal(ctx, operations, journal)
+ }
+ var externallyRemoved *volumetypes.VolumesExternallyRemovedError
+ if errors.As(err, &externallyRemoved) {
+ slog.WarnContext(ctx, "project rename cleanup found source and target volumes externally removed", "projectID", journal.ProjectID, "volumeCount", len(externallyRemoved.Volumes), "error", externallyRemoved)
+ } else {
+ return err
+ }
+ }
+
+ return volumes.RemoveSourceVolumes(ctx, dockerClient, journal.Volumes)
+}
+
+func rollbackRenameJournalInternal(ctx context.Context, operations projecttypes.RenameRecoveryOperations, journal *projecttypes.RenameJournal) error {
+ pathsMissing, directoryErr := RollbackRenamedProjectDirectory(ctx, journal.OldPath, journal.NewPath)
+
+ volumeErr := rollbackRenameJournalVolumesInternal(ctx, operations, journal)
+
+ if err := operations.RestoreState(ctx, journal); err != nil {
+ return stderrors.Join(directoryErr, volumeErr, errors.WrapIf(err, "restore project database state"))
+ }
+
+ if directoryErr != nil {
+ 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", pathsMissing, "error", volumeErr)
+ } else {
+ if cleanupErr := operations.WriteRollbackCleanup(ctx, journal); cleanupErr != nil {
+ return stderrors.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", pathsMissing, "error", volumeErr)
+ }
+ }
+
+ return directoryErr
+}
+
+func rollbackRenameJournalVolumesInternal(ctx context.Context, operations projecttypes.RenameRecoveryOperations, journal *projecttypes.RenameJournal) error {
+ if !renameJournalTargetsCopiedInternal(journal.Phase) {
+ return nil
+ }
+
+ dockerClient, err := operations.Docker(ctx, len(journal.Volumes) > 0)
+ if err != nil {
+ return err
+ }
+
+ return volumes.RollbackVolumes(ctx, dockerClient, journal.Volumes)
+}
+
+func RecoverRenameJournal(ctx context.Context, journal *projecttypes.RenameJournal, projectCommitted bool, operations projecttypes.RenameRecoveryOperations) error {
+ if projectCommitted {
+ if journal.Phase == projecttypes.RenameJournalPhaseSourceCleanupPending {
+ if err := cleanupRenameJournalSourcesInternal(ctx, operations, journal); err != nil {
+ return err
+ }
+ return operations.ClearJournal(ctx, journal.ProjectID)
+ }
+ if err := cleanupRenameJournalSourcesInternal(ctx, operations, journal); err != nil {
+ var cleanupErr *volumetypes.SourceCleanupError
+ if errors.As(err, &cleanupErr) {
+ if writeErr := operations.WriteJournal(ctx, journal, projecttypes.RenameJournalPhaseSourceCleanupPending); writeErr != nil {
+ return stderrors.Join(err, writeErr)
+ }
+ }
+ return err
+ }
+ return operations.ClearJournal(ctx, journal.ProjectID)
+ }
+
+ if err := rollbackRenameJournalInternal(ctx, operations, journal); err != nil {
+ return err
+ }
+ if err := operations.WriteJournal(ctx, journal, projecttypes.RenameJournalPhaseProjectStateRolledBack); err != nil {
+ return err
+ }
+ return operations.ClearJournal(ctx, journal.ProjectID)
+}
+
+func CleanupRenameRollbackTargets(ctx context.Context, cleanup *projecttypes.RenameRollbackCleanup, operations projecttypes.RenameRecoveryOperations) error {
+ dockerClient, err := operations.Docker(ctx, len(cleanup.Volumes) > 0)
+ if err != nil {
+ return err
+ }
+
+ if err := volumes.CleanupRollbackTargetVolumes(ctx, dockerClient, cleanup.Volumes); err != nil {
+ if volumes.OnlyPreservedTargetErrors(err) {
+ slog.WarnContext(ctx, "clearing project rename rollback cleanup after preserving target volume data", "projectID", cleanup.ProjectID, "error", err)
+ return operations.ClearRollbackCleanup(ctx, cleanup.ProjectID)
+ }
+ return err
+ }
+
+ dockerutil.InvalidateVolumeUsageCache(dockerClient)
+ return operations.ClearRollbackCleanup(ctx, cleanup.ProjectID)
+}
diff --git a/backend/pkg/projects/volume_migration_test.go b/backend/pkg/projects/volume_migration_test.go
new file mode 100644
index 000000000..bff609f6c
--- /dev/null
+++ b/backend/pkg/projects/volume_migration_test.go
@@ -0,0 +1,142 @@
+package projects
+
+import (
+ "os"
+ "path/filepath"
+ "testing"
+
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/docker/compose/v5/pkg/api"
+ projecttypes "github.com/getarcaneapp/arcane/types/v2/project"
+ "github.com/moby/moby/api/types/volume"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+)
+
+func TestBuildProjectRenamedVolumeConfigInternal(t *testing.T) {
+ source := composetypes.VolumeConfig{
+ Name: "nginx_data",
+ Driver: "local",
+ Labels: composetypes.Labels{
+ "existing": "kept",
+ },
+ CustomLabels: composetypes.Labels{
+ api.ProjectLabel: "nginx",
+ api.VolumeLabel: "data",
+ },
+ }
+
+ got := buildProjectRenamedVolumeConfigInternal(source, "data", "web_data", "web")
+
+ require.Equal(t, "web_data", got.Name)
+ require.Equal(t, "local", got.Driver)
+ require.Equal(t, "kept", got.Labels["existing"])
+ require.Equal(t, "web", got.CustomLabels[api.ProjectLabel])
+ require.Equal(t, "data", got.CustomLabels[api.VolumeLabel])
+ require.Equal(t, api.ComposeVersion, got.CustomLabels[api.VersionLabel])
+}
+
+func TestRenamedVolumeCreateOptionsInternal_UsesPendingComposeDriverOptions(t *testing.T) {
+ entry := struct {
+ NewConfig composetypes.VolumeConfig
+ OldVolume volume.Volume
+ }{
+ OldVolume: volume.Volume{
+ Driver: "old-driver",
+ Options: map[string]string{"old": "true"},
+ Labels: map[string]string{"existing": "kept"},
+ },
+ NewConfig: composetypes.VolumeConfig{
+ Name: "web_data",
+ Driver: "new-driver",
+ DriverOpts: map[string]string{"new": "true"},
+ CustomLabels: composetypes.Labels{
+ api.ProjectLabel: "web",
+ api.VolumeLabel: "data",
+ },
+ },
+ }
+
+ options, err := renamedVolumeCreateOptionsInternal(entry.NewConfig, entry.OldVolume.Labels)
+ require.NoError(t, err)
+ require.Equal(t, "web_data", options.Name)
+ require.Equal(t, "new-driver", options.Driver)
+ require.Equal(t, map[string]string{"new": "true"}, options.DriverOpts)
+ require.Equal(t, "kept", options.Labels["existing"])
+ require.Equal(t, "web", options.Labels[api.ProjectLabel])
+ require.Equal(t, "data", options.Labels[api.VolumeLabel])
+ require.NotEmpty(t, options.Labels[api.ConfigHashLabel])
+}
+
+func TestComposeVolumeKeysWithExplicitNameInternal(t *testing.T) {
+ projectPath := t.TempDir()
+ rootCompose := filepath.Join(projectPath, "compose.yaml")
+ includeCompose := filepath.Join(projectPath, "included.yaml")
+
+ require.NoError(t, os.WriteFile(rootCompose, []byte(`
+services:
+ app:
+ image: nginx:alpine
+ volumes:
+ - data:/data
+ - fixed:/fixed
+ - env_named:/env
+ - env_default:/env-default
+ - env_unbraced:/env-unbraced
+ - escaped:/escaped
+ - scalar:/scalar
+ - null_named:/null
+ - numeric_named:/numeric
+volumes:
+ data:
+ driver: local
+ fixed:
+ name: app-data
+ env_named:
+ name: ${APP_VOLUME}
+ env_default:
+ name: ${APP_VOLUME:-app-data}
+ env_unbraced:
+ name: $APP_VOLUME
+ escaped:
+ name: $${APP_VOLUME}
+ scalar:
+ null_named:
+ name: null
+ numeric_named:
+ name: 123
+ inline: {}
+`), 0o644))
+ require.NoError(t, os.WriteFile(includeCompose, []byte(`
+volumes:
+ included:
+ name: included-fixed
+ included_implicit:
+ driver: local
+`), 0o644))
+
+ explicit, err := composeVolumeKeysWithExplicitNameInternal([]string{rootCompose, includeCompose})
+ require.NoError(t, err)
+
+ assert.Contains(t, explicit, "fixed")
+ assert.Contains(t, explicit, "escaped")
+ assert.Contains(t, explicit, "included")
+ assert.NotContains(t, explicit, "data")
+ assert.NotContains(t, explicit, "env_named")
+ assert.NotContains(t, explicit, "env_default")
+ assert.NotContains(t, explicit, "env_unbraced")
+ assert.NotContains(t, explicit, "scalar")
+ assert.NotContains(t, explicit, "null_named")
+ assert.NotContains(t, explicit, "numeric_named")
+ assert.NotContains(t, explicit, "inline")
+ assert.NotContains(t, explicit, "included_implicit")
+}
+
+func TestProjectRenameJournalTargetsCopiedInternal(t *testing.T) {
+ require.False(t, renameJournalTargetsCopiedInternal(projecttypes.RenameJournalPhaseStarted))
+ require.False(t, renameJournalTargetsCopiedInternal(projecttypes.RenameJournalPhaseProjectStateRolledBack))
+ require.True(t, renameJournalTargetsCopiedInternal(projecttypes.RenameJournalPhaseSourceCleanupPending))
+ require.True(t, renameJournalTargetsCopiedInternal(projecttypes.RenameJournalPhaseTargetsCopied))
+ require.True(t, renameJournalTargetsCopiedInternal(projecttypes.RenameJournalPhaseOldVolumesRemoved))
+ require.True(t, renameJournalTargetsCopiedInternal(projecttypes.RenameJournalPhaseProjectStateCommitted))
+}
diff --git a/types/go.mod b/types/go.mod
index cb0fa216d..5cbd4fa0d 100644
--- a/types/go.mod
+++ b/types/go.mod
@@ -9,6 +9,7 @@ require (
github.com/moby/moby/api v1.56.0
github.com/moby/moby/client v0.6.0
github.com/stretchr/testify v1.12.1
+ go.getarcane.app/builds v0.4.1
)
require (
diff --git a/types/go.sum b/types/go.sum
index 439f41272..b849e63e6 100644
--- a/types/go.sum
+++ b/types/go.sum
@@ -54,6 +54,8 @@ github.com/stretchr/testify v1.12.1 h1:EuwCh5fleGS7H32xRwO3wRGT7DxrDhLAT6FF8MpWD
github.com/stretchr/testify v1.12.1/go.mod h1:MDEgiDPPsNp5cuIrHPPCyornHKgEVbtFUmoNlxoYthg=
github.com/xhit/go-str2duration/v2 v2.1.0 h1:lxklc02Drh6ynqX+DdPyp5pCKLUQpRT8bp8Ydu2Bstc=
github.com/xhit/go-str2duration/v2 v2.1.0/go.mod h1:ohY8p+0f07DiV6Em5LKB0s2YpLtXVyJfNt1+BlmyAsU=
+go.getarcane.app/builds v0.4.1 h1:R8iEgTf9+NDtI1IEzF2R3Mn+v6AGUqwCMs7CEFpVRZk=
+go.getarcane.app/builds v0.4.1/go.mod h1:vSWYulIelS9m91mPpvaN+orZ4/A20eGGcynP892eMkg=
go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=
go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.71.0 h1:3g7B90UzBltIDKq1/5mrTGxTnOFDV0ICOhLoxiZ8jlg=
diff --git a/types/project/compose_cache.go b/types/project/compose_cache.go
new file mode 100644
index 000000000..43d492ccd
--- /dev/null
+++ b/types/project/compose_cache.go
@@ -0,0 +1,14 @@
+package project
+
+// ComposeCache stores values until their Compose configuration inputs change.
+// Fingerprints identify the settings and project identity used when loading.
+type ComposeCache[T any] interface {
+ Get(projectID, fingerprint string) (T, bool)
+ Set(projectID, fingerprint, projectPath, projectsDirectory, composePath string, composeFiles, envFiles []string, value T) error
+ Invalidate(projectID string)
+}
+
+// ComposeDependencies records files consumed before executable models discard env_file.
+type ComposeDependencies struct {
+ EnvFiles []string
+}
diff --git a/backend/pkg/projects/types/compose_content.go b/types/project/compose_content.go
similarity index 98%
rename from backend/pkg/projects/types/compose_content.go
rename to types/project/compose_content.go
index 920f28498..df546a441 100644
--- a/backend/pkg/projects/types/compose_content.go
+++ b/types/project/compose_content.go
@@ -1,4 +1,4 @@
-package types
+package project
import (
composetypes "github.com/compose-spec/compose-go/v2/types"
diff --git a/types/project/compose_operation.go b/types/project/compose_operation.go
new file mode 100644
index 000000000..f9ce580ad
--- /dev/null
+++ b/types/project/compose_operation.go
@@ -0,0 +1,71 @@
+package project
+
+import (
+ "context"
+ "io"
+ "time"
+
+ composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/moby/moby/api/types/registry"
+ buildtypes "go.getarcane.app/builds/types"
+)
+
+// BuildOptions selects Compose services and overrides the configured build provider.
+type BuildOptions struct {
+ Services []string
+ Provider string
+ Push *bool
+ Load *bool
+}
+
+// ComposeImageOperations connects Compose preparation to the application's image and build services.
+type ComposeImageOperations struct {
+ Exists func(context.Context, string) (bool, error)
+ LastTagged func(context.Context, string) (time.Time, error)
+ Pull func(context.Context, string, io.Writer) error
+ Build func(context.Context, buildtypes.BuildRequest, io.Writer, string) error
+ BuildProvider string
+}
+
+// ComposeDeployment supplies application actions in deployment order.
+type ComposeDeployment struct {
+ ProjectID string
+ ProjectPath string
+ Options *DeployOptions
+ DefaultPullPolicy string
+ GitOpsManaged bool
+ WaitTimeout time.Duration
+ AuthConfigs map[string]registry.AuthConfig
+ Progress io.Writer
+ PreDeploy func(context.Context) error
+ Load func(context.Context) (*composetypes.Project, error)
+ ResolveImages func(context.Context) (ComposeImageOperations, error)
+ Recover func(context.Context)
+}
+
+// ComposeServiceUpdate supplies an already authorized service update.
+type ComposeServiceUpdate struct {
+ Project *composetypes.Project
+ Services []string
+ Images ComposeImageOperations
+ Progress io.Writer
+ AuthConfigs map[string]registry.AuthConfig
+ WaitTimeout time.Duration
+ RestoreBeforeMutation func(context.Context)
+ Recover func(context.Context)
+}
+
+// ComposeCommands supplies the SDK operations used by the coordinator.
+type ComposeCommands struct {
+ Stop func(context.Context, *composetypes.Project, []string) error
+ Up func(context.Context, *composetypes.Project, []string, bool, bool, bool, map[string]registry.AuthConfig, time.Duration) error
+}
+
+// ComposeCoordinator executes Compose workflows through application collaborators.
+type ComposeCoordinator interface {
+ Deploy(ctx context.Context, request ComposeDeployment) (*composetypes.Project, error)
+ UpdateServices(ctx context.Context, request ComposeServiceUpdate) error
+ PullServices(ctx context.Context, model *composetypes.Project, services []string, operations ComposeImageOperations, progress io.Writer) error
+ EnsureImagesPresent(ctx context.Context, model *composetypes.Project, progress io.Writer, operations ComposeImageOperations) error
+ BuildServices(ctx context.Context, projectID string, model *composetypes.Project, options BuildOptions, progress io.Writer, operations ComposeImageOperations) error
+}
diff --git a/types/project/rename.go b/types/project/rename.go
new file mode 100644
index 000000000..cb35ad68e
--- /dev/null
+++ b/types/project/rename.go
@@ -0,0 +1,54 @@
+package project
+
+import (
+ "context"
+ "time"
+
+ volumetypes "github.com/getarcaneapp/arcane/types/v2/volume"
+ "github.com/moby/moby/client"
+)
+
+const (
+ RenameJournalKeyPrefix = "project_rename_journal:"
+ RenameRollbackCleanupKeyPrefix = "project_rename_rollback_cleanup:"
+
+ RenameJournalPhaseStarted = "started"
+ RenameJournalPhaseTargetsCopied = "targets_copied"
+ RenameJournalPhaseOldVolumesRemoved = "old_volumes_removed"
+ RenameJournalPhaseProjectStateCommitted = "project_state_committed"
+ RenameJournalPhaseSourceCleanupPending = "source_cleanup_pending"
+ RenameJournalPhaseProjectStateRolledBack = "project_state_rolled_back"
+)
+
+type RenameJournal struct {
+ ProjectID string `json:"projectId"`
+ OldName string `json:"oldName"`
+ NewName string `json:"newName"`
+ OldPath string `json:"oldPath"`
+ NewPath string `json:"newPath"`
+ OldDirName *string `json:"oldDirName,omitempty"`
+ NewDirName string `json:"newDirName"`
+ Phase string `json:"phase"`
+ Volumes []volumetypes.JournalVolume `json:"volumes,omitempty"`
+ UpdatedAt time.Time `json:"updatedAt"`
+}
+
+type RenameRollbackCleanup struct {
+ ProjectID string `json:"projectId"`
+ OldName string `json:"oldName"`
+ OldPath string `json:"oldPath"`
+ NewName string `json:"newName"`
+ NewPath string `json:"newPath"`
+ Volumes []volumetypes.JournalVolume `json:"volumes,omitempty"`
+ UpdatedAt time.Time `json:"updatedAt"`
+}
+
+// RenameRecoveryOperations supplies persistence and Docker access to rename recovery.
+type RenameRecoveryOperations struct {
+ Docker func(context.Context, bool) (*client.Client, error)
+ WriteJournal func(context.Context, *RenameJournal, string) error
+ ClearJournal func(context.Context, string) error
+ ClearRollbackCleanup func(context.Context, string) error
+ RestoreState func(context.Context, *RenameJournal) error
+ WriteRollbackCleanup func(context.Context, *RenameJournal) error
+}
diff --git a/types/volume/rename.go b/types/volume/rename.go
new file mode 100644
index 000000000..f5e36de58
--- /dev/null
+++ b/types/volume/rename.go
@@ -0,0 +1,144 @@
+package volume
+
+import (
+ "context"
+ "fmt"
+ "strings"
+
+ "github.com/moby/moby/api/types/volume"
+ "github.com/moby/moby/client"
+)
+
+// RenameEntry describes a source volume and the target configuration for a copy-based rename.
+type RenameEntry struct {
+ Key string
+ OldName string
+ NewName string
+ OldVolume volume.Volume
+ CreateOptions client.VolumeCreateOptions
+}
+
+type Migration interface {
+ Apply(ctx context.Context) error
+ Rollback(ctx context.Context) error
+}
+
+type Committer interface {
+ Commit(ctx context.Context) error
+}
+
+type JournalSource interface {
+ JournalVolumes() []JournalVolume
+}
+
+type JournalVolume struct {
+ Key string `json:"key"`
+ OldName string `json:"oldName"`
+ NewName string `json:"newName"`
+ Driver string `json:"driver,omitempty"`
+ Options map[string]string `json:"options,omitempty"`
+ Labels map[string]string `json:"labels,omitempty"`
+}
+
+type ProjectVolumeRenameConflictError struct {
+ VolumeName string
+}
+
+type ProjectVolumeRenameInUseError struct {
+ VolumeName string
+ ContainerIDs []string
+}
+
+type ProjectVolumeRenameInsufficientSpaceError struct {
+ SourceVolume string
+ TargetVolume string
+ Detail string
+}
+
+type TargetMissingWithSourceError struct {
+ SourceVolume string
+ TargetVolume string
+}
+
+type SourceCleanupError struct {
+ SourceVolume string
+ Err error
+}
+
+type TargetPreservedDuringRollbackError struct {
+ SourceVolume string
+ TargetVolume string
+ Err error
+}
+
+type VolumesExternallyRemovedError struct {
+ Volumes []JournalVolume
+}
+
+func (e *VolumesExternallyRemovedError) Error() string {
+ if e == nil || len(e.Volumes) == 0 {
+ return "committed project rename source and target volumes are both missing"
+ }
+ if len(e.Volumes) == 1 {
+ vol := e.Volumes[0]
+ return fmt.Sprintf("committed project rename target volume %s is missing and source volume %s is also missing", vol.NewName, vol.OldName)
+ }
+ return fmt.Sprintf("committed project rename source and target volumes are both missing for %d volume pairs", len(e.Volumes))
+}
+
+func (e *TargetPreservedDuringRollbackError) Unwrap() error {
+ return e.Err
+}
+
+func (e *TargetPreservedDuringRollbackError) Error() string {
+ return fmt.Sprintf("preserved project rename target volume %s during rollback to avoid data loss; source volume %s was not safe to rely on: %v", e.TargetVolume, e.SourceVolume, e.Err)
+}
+
+func (e *SourceCleanupError) Unwrap() error {
+ if e == nil {
+ return nil
+ }
+ return e.Err
+}
+
+func (e *SourceCleanupError) Error() string {
+ if e == nil {
+ return "clean up committed project rename source volume"
+ }
+ if strings.TrimSpace(e.SourceVolume) == "" {
+ return fmt.Sprintf("clean up committed project rename source volume: %v", e.Err)
+ }
+ return fmt.Sprintf("clean up committed project rename source volume %s: %v", e.SourceVolume, e.Err)
+}
+
+func (e *TargetMissingWithSourceError) Error() string {
+ return fmt.Sprintf("committed project rename target volume %s is missing while source volume %s still exists", e.TargetVolume, e.SourceVolume)
+}
+
+func (e *ProjectVolumeRenameInsufficientSpaceError) Error() string {
+ msg := "insufficient disk space to rename project volume"
+ if e.SourceVolume != "" && e.TargetVolume != "" {
+ msg = fmt.Sprintf("insufficient disk space to copy volume %s to %s", e.SourceVolume, e.TargetVolume)
+ }
+ if strings.TrimSpace(e.Detail) != "" {
+ msg += ": " + strings.TrimSpace(e.Detail)
+ }
+ return msg
+}
+
+func (e *ProjectVolumeRenameInUseError) Error() string {
+ if strings.TrimSpace(e.VolumeName) == "" {
+ return "source volume is still attached to containers"
+ }
+ if len(e.ContainerIDs) == 0 {
+ return "source volume is still attached to containers: " + e.VolumeName
+ }
+ return fmt.Sprintf("source volume is still attached to %d container(s): %s", len(e.ContainerIDs), e.VolumeName)
+}
+
+func (e *ProjectVolumeRenameConflictError) Error() string {
+ if strings.TrimSpace(e.VolumeName) == "" {
+ return "target volume already exists"
+ }
+ return "target volume already exists: " + e.VolumeName
+}