feat(docker): add recreate ignore label to skip recreate (#1158)

* feat(docker): add recreate ignore label to skip recreate

#1157

* chore: remove unless comment

* feat(utils): set add Difference method

* feat(docker): add `cd.doco.deployment.recreate.ignore.signal` label to send a signal when service recreation is skipped

#1157

* chore: make lint

* fix(test): t.Parallel called multiple times

* chore: make lint

* chore(docker): make `getIgnoreRecrateCfgFromProject` more strict

* test(docker): update test name

* fix(docker): typo on recreate

* refactor(docker): switch ignore config format to yaml

* fix(docker): fix test ignore label

* test: update test function names to use CamelCase

---------

Co-authored-by: Kim Oliver Drechsel <kim@drechsel.xyz>

Author: qianlongzt

.dockerignore

@@ -11,3 +11,4 @@ Dockerfile
 *.compose.yaml
 docker-compose.yaml
 .dockerignore
+Makefile

internal/docker/compose.go

@@ -301,6 +301,7 @@ func LoadCompose(ctx context.Context, repoPath, workingDir, projectName string,
 // deployCompose deploys a project as specified by the Docker Compose specification (LoadCompose).
 func deployCompose(ctx context.Context, dockerCli command.Cli, project *types.Project,
 	deployConfig *config.DeployConfig, recreateMode string, services []string,
+	needSignal []SignalService,
 ) error {
 	var (
 		err          error
@@ -313,6 +314,12 @@ func deployCompose(ctx context.Context, dockerCli command.Cli, project *types.Pr
 		return err
 	}
 
+	if len(needSignal) > 0 {
+		if err := ComposeSignal(ctx, dockerCli, project, needSignal); err != nil {
+			return err
+		}
+	}
+
 	if deployConfig.PruneImages {
 		beforeImages, err = service.Images(ctx, project.Name, api.ImagesOptions{})
 		if err != nil {
@@ -416,7 +423,7 @@ func deployCompose(ctx context.Context, dockerCli command.Cli, project *types.Pr
 func DeployStack(
 	jobLog *slog.Logger, externalRepoPath string, ctx *context.Context,
 	dockerCli *command.Cli, dockerClient *client.Client, payload *webhook.ParsedPayload, deployConfig *config.DeployConfig,
-	changedFiles []gitInternal.ChangedFile, latestCommit, appVersion string, forceDeploy bool,
+	detectedChanges []Change, needSignal []SignalService, latestCommit, appVersion string, forceDeploy bool,
 ) error {
 	startTime := time.Now()
 
@@ -520,12 +527,6 @@ func DeployStack(
 			}
 		}
 	} else {
-		detectedChanges, err := ProjectFilesHaveChanges(externalRepoPath, changedFiles, project)
-		if err != nil {
-			errMsg := "failed to check for changed project files"
-			return fmt.Errorf("%s: %w", errMsg, err)
-		}
-
 		addComposeServiceLabels(project, deployConfig, payload, externalWorkingDir, appVersion, timestamp, ComposeVersion, latestCommit, projectHash)
 		addComposeVolumeLabels(project, deployConfig, payload, appVersion, timestamp, ComposeVersion, latestCommit, projectHash)
 
@@ -545,11 +546,21 @@ func DeployStack(
 			}
 
 			stackLog.Debug("changed project files detected, forcing recreate", slog.Any("changes", detectedChanges))
+		case len(needSignal) > 0:
+			stackLog.Debug("changed project files detected, sending signal to service",
+				slog.Any("need_signal", needSignal))
 		}
 
-		stackLog.Info("deploying stack", slog.Group("recreate", slog.String("mode", recreateMode), slog.Any("forced_services", forcedServices.ToSlice())))
+		stackLog.Info("deploying stack",
+			slog.Group("recreate",
+				slog.String("mode", recreateMode),
+				slog.Any("forced_services", forcedServices.ToSlice()),
+			),
+			slog.Any("need_signal", needSignal),
+		)
 
-		err = deployCompose(*ctx, *dockerCli, project, deployConfig, recreateMode, forcedServices.ToSlice())
+		err = deployCompose(*ctx, *dockerCli, project, deployConfig, recreateMode,
+			forcedServices.ToSlice(), needSignal)
 		if err != nil {
 			prometheus.DeploymentErrorsTotal.WithLabelValues(deployConfig.Name).Inc()
 			return fmt.Errorf("failed to deploy stack: %w", err)
@@ -605,7 +616,7 @@ func DestroyStack(
 	return nil
 }
 
-func getPaths(changedFiles []gitInternal.ChangedFile, basePath string) []string {
+func GetPathsFromGitChangedFiles(changedFiles []gitInternal.ChangedFile, basePath string) []string {
 	var absPaths []string
 
 	basePath = filepath.Clean(basePath)
@@ -632,7 +643,7 @@ func getPaths(changedFiles []gitInternal.ChangedFile, basePath string) []string
 }
 
 // HasChangedConfigs checks if any files used in docker compose `configs:` definitions have changed using the Git status.
-func HasChangedConfigs(paths []string, project *types.Project) ([]string, error) {
+func HasChangedConfigs(paths []string, project *types.Project, ignoreCfg projectIgnoreCfg) ([]string, []string) {
 	configToServicesMap := make(map[string][]string)
 
 	for name, s := range project.Services {
@@ -641,26 +652,35 @@ func HasChangedConfigs(paths []string, project *types.Project) ([]string, error)
 		}
 	}
 
-	var changedServices []string
+	var (
+		changedServices []string
+		ignoredServices []string
+	)
 
-	for name, c := range project.Configs {
+	for cfgName, c := range project.Configs {
 		// Changes in config.Content are handled in project hash comparison
 		if c.File == "" {
 			continue
 		}
 
 		for _, p := range paths {
 			if filesystem.InBasePath(c.File, p) {
-				changedServices = append(changedServices, configToServicesMap[name]...)
+				for _, svcName := range configToServicesMap[cfgName] {
+					if !checkIsIgnoreByCfg(ignoreCfg, svcName, changeScopeConfigs, cfgName) {
+						changedServices = append(changedServices, svcName)
+					} else {
+						ignoredServices = append(ignoredServices, svcName)
+					}
+				}
 			}
 		}
 	}
 
-	return slice.Unique(changedServices), nil
+	return getChangeAndIgnore(changedServices, ignoredServices)
 }
 
 // HasChangedSecrets checks if any files used in docker compose `secrets:` definitions have changed using the Git status.
-func HasChangedSecrets(paths []string, project *types.Project) ([]string, error) {
+func HasChangedSecrets(paths []string, project *types.Project, ignoreCfg projectIgnoreCfg) ([]string, []string) {
 	secretsToServicesMap := make(map[string][]string)
 
 	for name, s := range project.Services {
@@ -669,46 +689,63 @@ func HasChangedSecrets(paths []string, project *types.Project) ([]string, error)
 		}
 	}
 
-	var changedServices []string
+	var (
+		changedServices []string
+		ignoredServices []string
+	)
 
-	for name, s := range project.Secrets {
+	for secretName, s := range project.Secrets {
 		if s.File == "" {
 			continue
 		}
 
 		for _, p := range paths {
 			if filesystem.InBasePath(s.File, p) {
-				changedServices = append(changedServices, secretsToServicesMap[name]...)
+				for _, svcName := range secretsToServicesMap[secretName] {
+					if !checkIsIgnoreByCfg(ignoreCfg, svcName, changeScopeSecrets, secretName) {
+						changedServices = append(changedServices, svcName)
+					} else {
+						ignoredServices = append(ignoredServices, svcName)
+					}
+				}
 			}
 		}
 	}
 
-	return slice.Unique(changedServices), nil
+	return getChangeAndIgnore(changedServices, ignoredServices)
 }
 
 // HasChangedBindMounts checks if any files used in docker compose `volumes:` definitions with type `bind` have changed using the Git status.
-func HasChangedBindMounts(paths []string, project *types.Project) ([]string, error) {
-	var changedServices []string
+func HasChangedBindMounts(paths []string, project *types.Project, ignoreCfg projectIgnoreCfg) ([]string, []string) {
+	var (
+		changedServices []string
+		ignoredServices []string
+	)
 
 	for _, s := range project.Services {
 	out:
 		for _, v := range s.Volumes {
 			if v.Type == "bind" && v.Source != "" {
 				for _, p := range paths {
 					if filesystem.InBasePath(v.Source, p) {
-						changedServices = append(changedServices, s.Name)
+						if !checkIsIgnoreByCfg(ignoreCfg, s.Name, changeScopeBindMounts, v.Target) {
+							changedServices = append(changedServices, s.Name)
+						} else {
+							ignoredServices = append(ignoredServices, s.Name)
+						}
+
 						break out
 					}
 				}
 			}
 		}
 	}
 
-	return slice.Unique(changedServices), nil
+	return getChangeAndIgnore(changedServices, ignoredServices)
 }
 
 // HasChangedEnvFiles checks if any files used in docker compose `env_file:` definitions have changed using the Git status.
-func HasChangedEnvFiles(paths []string, project *types.Project) ([]string, error) {
+func HasChangedEnvFiles(paths []string, project *types.Project, _ projectIgnoreCfg) ([]string, []string) {
 	var changedServices []string
 
 	for _, s := range project.Services {
@@ -728,7 +765,7 @@ func HasChangedEnvFiles(paths []string, project *types.Project) ([]string, error
 
 // HasChangedBuildFiles checks if any files used as build context in docker compose `build:` definitions have changed using the Git status.
 // This includes any file within the build context directory for each service. If a changed file is within a build context, it returns true.
-func HasChangedBuildFiles(paths []string, project *types.Project) ([]string, error) {
+func HasChangedBuildFiles(paths []string, project *types.Project, _ projectIgnoreCfg) ([]string, []string) {
 	var changedServices []string
 
 	for _, s := range project.Services {
@@ -802,42 +839,81 @@ func sortChanges(changes []Change) {
 	}
 }
 
+type IgnoredInfo struct {
+	// Ignored services name
+	Ignored []string `json:"ignored"`
+	// Ignored services need to send signal
+	NeedSendSignal []SignalService `json:"need_signal"`
+}
+
+func (i IgnoredInfo) IsEmpty() bool {
+	return len(i.Ignored) == 0 && len(i.NeedSendSignal) == 0
+}
+
+type SignalService struct {
+	ServiceName string `json:"service_name"`
+	Signal      string `json:"signal"`
+}
+
 // ProjectFilesHaveChanges checks if any files related to the compose project have changed.
-func ProjectFilesHaveChanges(repoRootExternal string, changedFiles []gitInternal.ChangedFile, project *types.Project) ([]Change, error) {
+func ProjectFilesHaveChanges(changePaths []string, project *types.Project) ([]Change, IgnoredInfo, error) {
 	checks := []struct {
-		name string
-		fn   func([]string, *types.Project) ([]string, error)
+		name changeScope
+		fn   func([]string, *types.Project, projectIgnoreCfg) ([]string, []string)
 	}{
-		{"configs", HasChangedConfigs},
-		{"secrets", HasChangedSecrets},
-		{"bindMounts", HasChangedBindMounts},
-		{"envFiles", HasChangedEnvFiles},
-		{"buildFiles", HasChangedBuildFiles},
+		{changeScopeConfigs, HasChangedConfigs},
+		{changeScopeSecrets, HasChangedSecrets},
+		{changeScopeBindMounts, HasChangedBindMounts},
+		{changeScopeEnvFiles, HasChangedEnvFiles},
+		{changeScopeBuildFiles, HasChangedBuildFiles},
 	}
 
-	paths := getPaths(changedFiles, repoRootExternal)
+	ignoreCfg, err := getIgnoreRecreateCfgFromProject(project)
+	if err != nil {
+		return nil, IgnoredInfo{}, err
+	}
 
-	var changes []Change
+	var (
+		changes                                []Change
+		allChangedServices, allIgnoredServices []string
+	)
 
 	for _, check := range checks {
-		changedServices, err := check.fn(paths, project)
-		if err != nil {
-			return nil, fmt.Errorf("failed to check '%s' for changes: %w", check.name, err)
-		}
+		changedServices, ignoredServices := check.fn(changePaths, project, ignoreCfg)
+
+		allChangedServices = append(allChangedServices, changedServices...)
+		allIgnoredServices = append(allIgnoredServices, ignoredServices...)
 
 		if len(changedServices) > 0 {
 			slices.Sort(changedServices)
 
 			changes = append(changes, Change{
-				Type:     check.name,
+				Type:     string(check.name),
 				Services: changedServices,
 			})
 		}
 	}
 
 	sortChanges(changes)
 
-	return changes, nil
+	_, ignores := getChangeAndIgnore(allChangedServices, allIgnoredServices)
+	slices.Sort(ignores)
+
+	retIgnored := IgnoredInfo{}
+
+	for _, svcName := range ignores {
+		sig := ignoreCfg[svcName].signal
+		if sig != "" {
+			retIgnored.NeedSendSignal = append(retIgnored.NeedSendSignal, SignalService{
+				ServiceName: svcName,
+				Signal:      sig,
+			})
+		} else {
+			retIgnored.Ignored = append(retIgnored.Ignored, svcName)
+		}
+	}
+
+	return changes, retIgnored, nil
 }
 
 // RestartProject restarts all services in the specified project.