Skip to content

Modern Docker Management, Designed for Everyone

fix: only log project update on git sync when content changed (#4206)

Kyle Mendell439aee51db0e
diff --git a/backend/internal/gitops/gitops_sync.go b/backend/internal/gitops/gitops_sync.go
index e72adf752..26ed0c257 100644
--- a/backend/internal/gitops/gitops_sync.go
+++ b/backend/internal/gitops/gitops_sync.go
@@ -7,7 +7,6 @@ import (
"io"
"io/fs"
"log/slog"
- "maps"
"os"
"path"
"path/filepath"
@@ -1767,7 +1766,7 @@ func (s *GitOpsSyncService) createProjectForSyncInternal(ctx context.Context, sy
return nil, s.failSync(ctx, id, result, sync, actor, "Failed to mark project as GitOps-managed", err.Error())
}
- if _, err := s.projectService.ApplyGitSyncProjectFiles(ctx, project.ID, composeContent, envContent, overrideContent, overrideFileName, actor); err != nil {
+ if _, _, err := s.projectService.ApplyGitSyncProjectFiles(ctx, project.ID, composeContent, envContent, overrideContent, overrideFileName, actor); err != nil {
return nil, s.failSync(ctx, id, result, sync, actor, "Failed to sync project env files", err.Error())
}
@@ -1819,56 +1818,15 @@ func (s *GitOpsSyncService) getOrCreateProjectInternal(ctx context.Context, sync
}
func (s *GitOpsSyncService) updateProjectForSyncInternal(ctx context.Context, sync *projectpkg.GitOpsSync, id string, project *projectpkg.Project, composeContent string, envContent *string, overrideContent *string, overrideFileName string, result *gitops.SyncResult, actor common.User) error {
- // Get current content to see if it changed
- oldCompose, oldEnv, oldOverride, _ := s.projectService.GetProjectContent(ctx, project.ID)
-
- // Update existing project's compose and env files
- _, err := s.projectService.ApplyGitSyncProjectFiles(ctx, project.ID, composeContent, envContent, overrideContent, overrideFileName, actor)
+ _, changed, err := s.projectService.ApplyGitSyncProjectFiles(ctx, project.ID, composeContent, envContent, overrideContent, overrideFileName, actor)
if err != nil {
return s.failSync(ctx, id, result, sync, actor, "Failed to update project files", err.Error())
}
- slog.InfoContext(ctx, "Updated project files", "projectName", project.Name, "projectId", project.ID)
-
- newCompose, newEnv, newOverride, _ := s.projectService.GetProjectContent(ctx, project.ID)
- contentChanged := oldCompose != newCompose || envContentChangedInternal(oldEnv, newEnv) || oldOverride != newOverride
-
- // If content changed and project is running, redeploy. A redeploy failure
- // is classified as common.ErrRedeployAfterSyncFailed so the parent flow
- // can reflect it on the sync row's LastSyncError.
- if contentChanged {
- details, err := s.projectService.GetProjectDetails(ctx, project.ID, projecttypes.DetailsOptions{})
- running := err == nil && (details.Status == string(projectpkg.ProjectStatusRunning) || details.Status == string(projectpkg.ProjectStatusPartiallyRunning))
- if running || sync.RedeployAfterSync {
- slog.InfoContext(ctx, "Redeploying project due to content change from Git sync", "projectName", project.Name, "projectId", project.ID, "wasRunning", running)
- if err := s.projectService.RedeployProject(ctx, project.ID, actor, nil); err != nil {
- slog.ErrorContext(ctx, "Failed to redeploy project after Git sync", "error", err, "projectId", project.ID)
- return common.Classify(common.ErrRedeployAfterSyncFailed, errors.WrapIf(err, "redeploy failed"))
- }
- } else {
- // Project isn't running and RedeployAfterSync is off, so
- // RedeployProject (and its pull side effect) never runs. Pull
- // explicitly if this sync opted into PullImageAfterSync, so a
- // stopped container isn't left referencing an image tag that's
- // since been re-pointed or pruned upstream. A pull failure is
- // returned rather than swallowed, so it surfaces on the sync
- // row's LastSyncError instead of the sync silently reporting
- // success with a stale image.
- if err := s.pullImageAfterSyncIfConfiguredInternal(ctx, sync, project, actor); err != nil {
- return err
- }
- }
- }
- return nil
-}
-
-func envContentChangedInternal(oldEnv, newEnv string) bool {
- oldEnvMap, oldErr := projects.ParseProjectEnvContent(oldEnv, nil)
- newEnvMap, newErr := projects.ParseProjectEnvContent(newEnv, nil)
- if oldErr != nil || newErr != nil {
- return oldEnv != newEnv
+ slog.InfoContext(ctx, "Updated project files", "projectName", project.Name, "projectId", project.ID, "changed", changed)
+ if !changed {
+ return nil
}
-
- return !maps.Equal(oldEnvMap, newEnvMap)
+ return s.redeployIfRunningAfterSync(ctx, sync, project, actor, "single-file")
}
// parseSyncedFiles parses the JSON array of synced file paths from the database
@@ -2066,7 +2024,7 @@ func (s *GitOpsSyncService) stageDirectorySyncInternal(ctx context.Context, sync
_ = acfs.RemoveAll(ctx, projectsDir, stageLogical)
return nil, err
}
- if project != nil && envContentChangedInternal(preEnvContent, postEnvContent) {
+ if project != nil && projects.EnvContentChanged(preEnvContent, postEnvContent) {
contentsChanged = true
}
diff --git a/backend/internal/gitops/service_test.go b/backend/internal/gitops/service_test.go
index a0f80e9d5..61c690a8a 100644
--- a/backend/internal/gitops/service_test.go
+++ b/backend/internal/gitops/service_test.go
@@ -1462,22 +1462,6 @@ func TestBuildSwarmStackDeployRequestInternal(t *testing.T) {
}
}
-func TestEnvContentChangedInternal(t *testing.T) {
- t.Run("ignores formatting-only changes", func(t *testing.T) {
- oldEnv := "B=2\nA=1\n# comment\n"
- newEnv := "A=1\nB=2\n"
-
- assert.False(t, envContentChangedInternal(oldEnv, newEnv))
- })
-
- t.Run("detects semantic changes", func(t *testing.T) {
- oldEnv := "A=1\nB=2\n"
- newEnv := "A=1\nB=3\n"
-
- assert.True(t, envContentChangedInternal(oldEnv, newEnv))
- })
-}
-
func TestGitOpsSyncService_GetEnvironmentSyncLimits(t *testing.T) {
ctx := context.Background()
db := setupGitOpsProjectTestDBInternal(t)
diff --git a/backend/internal/project/project_update.go b/backend/internal/project/project_update.go
index 89f3c80fb..d58a946dd 100644
--- a/backend/internal/project/project_update.go
+++ b/backend/internal/project/project_update.go
@@ -266,27 +266,28 @@ func (s *ProjectService) refreshProjectAfterContentUpdateInternal(ctx context.Co
}
}
-func (s *ProjectService) ApplyGitSyncProjectFiles(ctx context.Context, projectID string, composeContent string, gitEnvContent *string, gitOverrideContent *string, gitOverrideFileName string, user common.User) (*Project, error) {
+func (s *ProjectService) ApplyGitSyncProjectFiles(ctx context.Context, projectID string, composeContent string, gitEnvContent *string, gitOverrideContent *string, gitOverrideFileName string, user common.User) (*Project, bool, error) {
proj, projectsDirectory, err := s.getProjectForUpdate(ctx, projectID)
if err != nil {
- return nil, err
+ return nil, false, err
}
if err := ensureProjectMutableInternal(&proj); err != nil {
- return nil, err
+ return nil, false, err
}
+ before := s.readGitSyncProjectContentInternal(ctx, proj.ID)
envUpdate, err := s.prepareGitSyncEnvUpdateInternal(proj.Path, gitEnvContent)
if err != nil {
- return nil, errors.WrapIf(err, "failed to resolve git env state")
+ return nil, false, errors.WrapIf(err, "failed to resolve git env state")
}
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")
+ return nil, false, errors.WrapIf(err, "invalid compose file")
}
backup, cleanupBackup, err := s.prepareProjectUpdateBackupInternal(ctx, projectsDirectory, proj.Path, &composeContent, gitEnvContent, gitOverrideContent)
if err != nil {
- return nil, err
+ return nil, false, err
}
defer cleanupBackup()
@@ -296,7 +297,7 @@ func (s *ProjectService) ApplyGitSyncProjectFiles(ctx context.Context, projectID
// A failure after the env persist would otherwise leave the project with
// new env values and an old or partially updated compose file set.
err = s.handleProjectUpdateFailureInternal(ctx, projectID, projectsDirectory, &proj, backup, &journalActive, projectStateCommitted, err)
- return nil, err
+ return nil, false, err
}
s.refreshComposeProjectNameInternal(ctx, &proj)
@@ -310,20 +311,54 @@ func (s *ProjectService) ApplyGitSyncProjectFiles(ctx context.Context, projectID
slog.WarnContext(ctx, "failed to update service counts after git sync", "projectID", proj.ID, "error", err)
}
+ after := s.readGitSyncProjectContentInternal(ctx, proj.ID)
+ envSourceRemoved := gitEnvContent == nil && envUpdate.state.HasGitSource
+ changed := s.logGitSyncProjectUpdateInternal(ctx, &proj, before, after, envSourceRemoved, user)
+
+ return &proj, changed, nil
+}
+
+// gitSyncProjectContentInternal is the effective content compared before and
+// after a git sync apply. Unreadable snapshots always compare as changed.
+type gitSyncProjectContentInternal struct {
+ compose, env, override string
+ unreadable bool
+}
+
+func (s *ProjectService) readGitSyncProjectContentInternal(ctx context.Context, projectID string) gitSyncProjectContentInternal {
+ compose, env, override, err := s.GetProjectContent(ctx, projectID)
+ if err != nil {
+ slog.WarnContext(ctx, "failed to read project content for git sync change detection; treating as changed", "projectID", projectID, "error", err)
+ return gitSyncProjectContentInternal{unreadable: true}
+ }
+ return gitSyncProjectContentInternal{compose: compose, env: env, override: override}
+}
+
+// logGitSyncProjectUpdateInternal logs project.update when the effective content
+// changed or the Git env source was removed, and reports whether content changed.
+func (s *ProjectService) logGitSyncProjectUpdateInternal(ctx context.Context, proj *Project, before, after gitSyncProjectContentInternal, envSourceRemoved bool, user common.User) bool {
+ unreadable := before.unreadable || after.unreadable
+ composeChanged := unreadable || before.compose != after.compose
+ envChanged := unreadable || projects.EnvContentChanged(before.env, after.env)
+ overrideChanged := unreadable || before.override != after.override
+ contentChanged := composeChanged || envChanged || overrideChanged
+ if !contentChanged && !envSourceRemoved {
+ return false
+ }
+
metadata := database.JSON{
"action": "git_sync_update",
"projectID": proj.ID,
"projectName": proj.Name,
- "composeUpdated": true,
- "envUpdated": gitEnvContent != nil,
- "overrideUpdated": gitOverrideContent != nil,
+ "composeUpdated": composeChanged,
+ "envUpdated": envChanged,
+ "overrideUpdated": overrideChanged,
}
- if gitEnvContent == nil {
+ if envSourceRemoved {
metadata["envSourceRemoved"] = true
}
s.logProjectEventInternal(ctx, event.EventTypeProjectUpdate, proj.ID, proj.Name, user, metadata, "could not log git sync project update action")
-
- return &proj, nil
+ return contentChanged
}
// applyGitSyncProjectFilesInternal persists the synced env, compose, and
diff --git a/backend/internal/project/service_test.go b/backend/internal/project/service_test.go
index 067d01f01..99793e653 100644
--- a/backend/internal/project/service_test.go
+++ b/backend/internal/project/service_test.go
@@ -3003,7 +3003,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_MigratesDirectEnvIntoProjectOve
require.NoError(t, db.Create(project).Error)
gitEnv := "TOKEN=git\nREMOTE_ONLY=1\n"
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", &gitEnv, nil, "", common.User{
+ updated, _, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", &gitEnv, nil, "", common.User{
ID: "u1",
Username: "tester",
})
@@ -3060,13 +3060,14 @@ func TestProjectService_ApplyGitSyncProjectFiles_PreservesGitEnvSyntax(t *testin
`
gitEnv := "# keep git formatting\nZ_LAST=last\nCLOUDFLARE_CLIENT_SECRET=$$pbkdf2-sha512$$310000$$XXX\nQUOTED_SECRET='$pbkdf2-sha512$310000$XXX'\nA_FIRST=first"
- for range 2 {
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, compose, &gitEnv, nil, "", common.User{
+ for i := range 2 {
+ updated, changed, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, compose, &gitEnv, nil, "", common.User{
ID: "u1",
Username: "tester",
})
require.NoError(t, err)
require.NotNil(t, updated)
+ assert.Equal(t, i == 0, changed)
effectiveBytes, readErr := os.ReadFile(filepath.Join(projectPath, ".env"))
require.NoError(t, readErr)
@@ -3116,7 +3117,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_NormalizesStaleCopiedGitOverrid
}
require.NoError(t, db.Create(project).Error)
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", new("BASE=git-updated\nSHARED=1\nREMOTE_ONLY=1\n"), nil, "", common.User{
+ updated, _, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", new("BASE=git-updated\nSHARED=1\nREMOTE_ONLY=1\n"), nil, "", common.User{
ID: "u1",
Username: "tester",
})
@@ -3164,7 +3165,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_RemovesLegacyDeletedGitMasks(t
}
require.NoError(t, db.Create(project).Error)
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", new("TOKEN=git-updated\nSHARED=1\nREMOTE_ONLY=1\n"), nil, "", common.User{
+ updated, _, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", new("TOKEN=git-updated\nSHARED=1\nREMOTE_ONLY=1\n"), nil, "", common.User{
ID: "u1",
Username: "tester",
})
@@ -3212,7 +3213,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_RemovesGitEnvSource(t *testing.
}
require.NoError(t, db.Create(project).Error)
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", nil, nil, "", common.User{
+ updated, _, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", nil, nil, "", common.User{
ID: "u1",
Username: "tester",
})
@@ -3255,7 +3256,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_WritesAndRemovesComposeOverride
require.NoError(t, db.Create(project).Error)
overrideContent := "services:\n app:\n image: busybox:latest\n"
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", nil, new(overrideContent), "compose.override.yaml", common.User{
+ updated, _, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", nil, new(overrideContent), "compose.override.yaml", common.User{
ID: "u1",
Username: "tester",
})
@@ -3267,7 +3268,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_WritesAndRemovesComposeOverride
assert.Equal(t, overrideContent, string(overrideBytes))
// A subsequent sync without an override removes the previously synced file.
- updated, err = svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", nil, nil, "", common.User{
+ updated, _, err = svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:alpine\n", nil, nil, "", common.User{
ID: "u1",
Username: "tester",
})
@@ -3313,7 +3314,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_UsesGlobalEnvDuringComposeValid
- ${MYPATH}cats/templates:/app/templates
`
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, compose, nil, nil, "", common.User{
+ updated, _, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, compose, nil, nil, "", common.User{
ID: "u1",
Username: "tester",
})
@@ -3365,7 +3366,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_TolerantOfUndefinedComposeVar(t
}
require.NoError(t, db.Create(project).Error)
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, compose, nil, nil, "", common.User{
+ updated, _, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, compose, nil, nil, "", common.User{
ID: "u1",
Username: "tester",
})
diff --git a/backend/internal/project/service_unix_test.go b/backend/internal/project/service_unix_test.go
index 2d044fa08..fee955d68 100644
--- a/backend/internal/project/service_unix_test.go
+++ b/backend/internal/project/service_unix_test.go
@@ -57,7 +57,7 @@ func TestProjectService_ApplyGitSyncProjectFiles_TolerantOfPermissionLockedEnv(t
}
require.NoError(t, db.Create(project).Error)
- updated, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:1.27-alpine\n", new("FOO=fromgit\n"), nil, "", common.User{
+ updated, _, err := svc.ApplyGitSyncProjectFiles(ctx, project.ID, "services:\n app:\n image: nginx:1.27-alpine\n", new("FOO=fromgit\n"), nil, "", common.User{
ID: "u1",
Username: "tester",
})
diff --git a/backend/pkg/projects/env.go b/backend/pkg/projects/env.go
index 2642fd7fb..5d8ebd2e2 100644
--- a/backend/pkg/projects/env.go
+++ b/backend/pkg/projects/env.go
@@ -431,6 +431,17 @@ func BuildEffectiveEnvContent(gitContent, overrideContent string) (string, error
return concatenated, nil
}
+// EnvContentChanged reports whether two env contents differ semantically,
+// ignoring ordering and comments. Unparseable content is compared verbatim.
+func EnvContentChanged(oldContent, newContent string) bool {
+ oldEnv, oldErr := ParseProjectEnvContent(oldContent, nil)
+ newEnv, newErr := ParseProjectEnvContent(newContent, nil)
+ if oldErr != nil || newErr != nil {
+ return oldContent != newContent
+ }
+ return !maps.Equal(oldEnv, newEnv)
+}
+
var envKeyLineRegexInternal = regexp.MustCompile(`^(\s*(?:export\s+)?)([A-Za-z_][A-Za-z0-9_.-]*)(\s*=)(.*)$`)
// mergeEnvOverridesInPlaceInternal rewrites the value of every gitContent line
diff --git a/backend/pkg/projects/env_test.go b/backend/pkg/projects/env_test.go
index 4ae592464..25621a492 100644
--- a/backend/pkg/projects/env_test.go
+++ b/backend/pkg/projects/env_test.go
@@ -503,3 +503,19 @@ func TestComposeFileEnvSelection(t *testing.T) {
assert.Equal(t, []string{filepath.Join(dir, "base.yml")}, files)
})
}
+
+func TestEnvContentChanged(t *testing.T) {
+ t.Run("ignores formatting-only changes", func(t *testing.T) {
+ oldEnv := "B=2\nA=1\n# comment\n"
+ newEnv := "A=1\nB=2\n"
+
+ assert.False(t, EnvContentChanged(oldEnv, newEnv))
+ })
+
+ t.Run("detects semantic changes", func(t *testing.T) {
+ oldEnv := "A=1\nB=2\n"
+ newEnv := "A=1\nB=3\n"
+
+ assert.True(t, EnvContentChanged(oldEnv, newEnv))
+ })
+}