fix(hash): recreate container on project config content change

pkg/api/labels.go

@@ -31,6 +31,10 @@ const (
 	ServiceLabel = "com.docker.compose.service"
 	// ConfigHashLabel stores configuration hash for a compose service
 	ConfigHashLabel = "com.docker.compose.config-hash"
+	// ServiceConfigsHash stores configuration hash for a compose service configs
+	ServiceConfigsHash = "com.docker.compose.service.%s.configs.hash"
+	// ServiceSecretsHash stores configuration hash for a compose service secrets
+	ServiceSecretsHash = "com.docker.compose.service.%s.secrets.hash"
 	// ContainerNumberLabel stores the container index of a replicated service
 	ContainerNumberLabel = "com.docker.compose.container-number"
 	// VolumeLabel allow to track resource related to a compose volume

pkg/compose/convergence.go

@@ -127,11 +127,11 @@ func (c *convergence) ensureService(ctx context.Context, project *types.Project,
 
 	sort.Slice(containers, func(i, j int) bool {
 		// select obsolete containers first, so they get removed as we scale down
-		if obsolete, _ := c.mustRecreate(service, containers[i], recreate); obsolete {
+		if obsolete, _ := c.mustRecreate(project, service, containers[i], recreate); obsolete {
 			// i is obsolete, so must be first in the list
 			return true
 		}
-		if obsolete, _ := c.mustRecreate(service, containers[j], recreate); obsolete {
+		if obsolete, _ := c.mustRecreate(project, service, containers[j], recreate); obsolete {
 			// j is obsolete, so must be first in the list
 			return false
 		}
@@ -160,7 +160,7 @@ func (c *convergence) ensureService(ctx context.Context, project *types.Project,
 			continue
 		}
 
-		mustRecreate, err := c.mustRecreate(service, container, recreate)
+		mustRecreate, err := c.mustRecreate(project, service, container, recreate)
 		if err != nil {
 			return err
 		}
@@ -323,23 +323,49 @@ func (c *convergence) resolveSharedNamespaces(service *types.ServiceConfig) erro
 	return nil
 }
 
-func (c *convergence) mustRecreate(expected types.ServiceConfig, actual containerType.Summary, policy string) (bool, error) {
+//nolint:gocyclo
+func (c *convergence) mustRecreate(project *types.Project, expected types.ServiceConfig, actual containerType.Summary, policy string) (bool, error) {
 	if policy == api.RecreateNever {
 		return false, nil
 	}
 	if policy == api.RecreateForce {
 		return true, nil
 	}
-	configHash, err := ServiceHash(expected)
+	serviceHash, err := ServiceHash(expected)
 	if err != nil {
 		return false, err
 	}
-	configChanged := actual.Labels[api.ConfigHashLabel] != configHash
-	imageUpdated := actual.Labels[api.ImageDigestLabel] != expected.CustomLabels[api.ImageDigestLabel]
-	if configChanged || imageUpdated {
+
+	if actual.Labels[api.ConfigHashLabel] != serviceHash {
+		return true, nil
+	}
+
+	if actual.Labels[api.ImageDigestLabel] != expected.CustomLabels[api.ImageDigestLabel] {
 		return true, nil
 	}
 
+	serviceNameToConfigHash, err := ServiceConfigsHash(project, expected)
+	if err != nil {
+		return false, err
+	}
+
+	for serviceName, hash := range serviceNameToConfigHash {
+		if actual.Labels[fmt.Sprintf(api.ServiceConfigsHash, serviceName)] != hash {
+			return true, nil
+		}
+	}
+
+	serviceSecretsHash, err := ServiceSecretsHash(project, expected)
+	if err != nil {
+		return false, err
+	}
+
+	for serviceName, hash := range serviceSecretsHash {
+		if actual.Labels[fmt.Sprintf(api.ServiceSecretsHash, serviceName)] != hash {
+			return true, nil
+		}
+	}
+
 	if c.networks != nil && actual.State == "running" {
 		if checkExpectedNetworks(expected, actual, c.networks) {
 			return true, nil

pkg/compose/create.go

@@ -218,7 +218,7 @@ func (s *composeService) getCreateConfigs(ctx context.Context,
 	inherit *container.Summary,
 	opts createOptions,
 ) (createConfigs, error) {
-	labels, err := s.prepareLabels(opts.Labels, service, number)
+	labels, err := s.prepareLabels(opts.Labels, p, service, number)
 	if err != nil {
 		return createConfigs{}, err
 	}
@@ -507,17 +507,36 @@ func parseSecurityOpts(p *types.Project, securityOpts []string) ([]string, bool,
 	return parsed, unconfined, nil
 }
 
-func (s *composeService) prepareLabels(labels types.Labels, service types.ServiceConfig, number int) (map[string]string, error) {
-	hash, err := ServiceHash(service)
+func (s *composeService) prepareLabels(labels types.Labels, project *types.Project, service types.ServiceConfig, number int) (map[string]string, error) {
+	serviceHash, err := ServiceHash(service)
 	if err != nil {
 		return nil, err
 	}
-	labels[api.ConfigHashLabel] = hash
+
+	serviceNameToConfigHash, err := ServiceConfigsHash(project, service)
+	if err != nil {
+		return nil, err
+	}
+
+	for serviceName, hash := range serviceNameToConfigHash {
+		labels[fmt.Sprintf(api.ServiceConfigsHash, serviceName)] = hash
+	}
+
+	serviceNameToSecretHash, err := ServiceSecretsHash(project, service)
+	if err != nil {
+		return nil, err
+	}
+
+	for serviceName, hash := range serviceNameToSecretHash {
+		labels[fmt.Sprintf(api.ServiceSecretsHash, serviceName)] = hash
+	}
 
 	if number > 0 {
 		// One-off containers are not indexed
 		labels[api.ContainerNumberLabel] = strconv.Itoa(number)
 	}
+	labels[api.ConfigHashLabel] = serviceHash
+	labels[api.ContainerNumberLabel] = strconv.Itoa(number)
 
 	var dependencies []string
 	for s, d := range service.DependsOn {

pkg/compose/hash.go

@@ -17,9 +17,13 @@
 package compose
 
 import (
+	"bytes"
 	"encoding/json"
+	"fmt"
+	"time"
 
 	"github.com/compose-spec/compose-go/v2/types"
+	"github.com/docker/compose/v2/pkg/utils"
 	"github.com/opencontainers/go-digest"
 )
 
@@ -35,30 +39,94 @@ func ServiceHash(o types.ServiceConfig) (string, error) {
 	o.DependsOn = nil
 	o.Profiles = nil
 
-	bytes, err := json.Marshal(o)
+	data, err := json.Marshal(o)
 	if err != nil {
 		return "", err
 	}
-	return digest.SHA256.FromBytes(bytes).Encoded(), nil
+	return digest.SHA256.FromBytes(data).Encoded(), nil
+}
+
+// ServiceConfigsHash computes the configuration hash for service configs.
+func ServiceConfigsHash(project *types.Project, serviceConfig types.ServiceConfig) (map[string]string, error) {
+	serviceNameToHash := make(map[string]string)
+	for _, config := range serviceConfig.Configs {
+		file := project.Configs[config.Source]
+		b, err := createTarForConfig(project, types.FileReferenceConfig(config), types.FileObjectConfig(file))
+		if err != nil {
+			return nil, err
+		}
+
+		serviceNameToHash[config.Target] = digest.SHA256.FromBytes(b.Bytes()).Encoded()
+	}
+
+	return serviceNameToHash, nil
+}
+
+// ServiceSecretsHash computes the configuration hash for service secrets.
+func ServiceSecretsHash(project *types.Project, serviceConfig types.ServiceConfig) (map[string]string, error) {
+	serviceNameToHash := make(map[string]string)
+	for _, secret := range serviceConfig.Secrets {
+		file := project.Secrets[secret.Source]
+		b, err := createTarForConfig(project, types.FileReferenceConfig(secret), types.FileObjectConfig(file))
+		if err != nil {
+			return nil, err
+		}
+
+		serviceNameToHash[secret.Target] = digest.SHA256.FromBytes(b.Bytes()).Encoded()
+	}
+
+	return serviceNameToHash, nil
+}
+
+func createTarForConfig(
+	project *types.Project,
+	serviceConfig types.FileReferenceConfig,
+	file types.FileObjectConfig,
+) (*bytes.Buffer, error) {
+	// fixed time to ensure the tarball is deterministic
+	modTime := time.Unix(0, 0)
+
+	if serviceConfig.Target == "" {
+		serviceConfig.Target = "/" + serviceConfig.Source
+	}
+
+	switch {
+	case file.Content != "":
+		return bytes.NewBuffer([]byte(file.Content)), nil
+	case file.Environment != "":
+		env, ok := project.Environment[file.Environment]
+		if !ok {
+			return nil, fmt.Errorf(
+				"environment variable %q required by file %q is not set",
+				file.Environment,
+				file.Name,
+			)
+		}
+		return bytes.NewBuffer([]byte(env)), nil
+	case file.File != "":
+		return utils.CreateTarByPath(file.File, modTime)
+	}
+
+	return nil, fmt.Errorf("config %q is empty", file.Name)
 }
 
 // NetworkHash computes the configuration hash for a network.
 func NetworkHash(o *types.NetworkConfig) (string, error) {
-	bytes, err := json.Marshal(o)
+	data, err := json.Marshal(o)
 	if err != nil {
 		return "", err
 	}
-	return digest.SHA256.FromBytes(bytes).Encoded(), nil
+	return digest.SHA256.FromBytes(data).Encoded(), nil
 }
 
 // VolumeHash computes the configuration hash for a volume.
 func VolumeHash(o types.VolumeConfig) (string, error) {
 	if o.Driver == "" { // (TODO: jhrotko) This probably should be fixed in compose-go
 		o.Driver = "local"
 	}
-	bytes, err := json.Marshal(o)
+	data, err := json.Marshal(o)
 	if err != nil {
 		return "", err
 	}
-	return digest.SHA256.FromBytes(bytes).Encoded(), nil
+	return digest.SHA256.FromBytes(data).Encoded(), nil
 }