Revert Path to string and convert path list to watch config list

Signed-off-by: Joana Hrotkó <[email protected]>

Author: jhrotko

loader/loader_test.go

@@ -3096,7 +3096,7 @@ services:
 		assert.DeepEqual(t, *frontend.Develop, types.DevelopConfig{
 			Watch: []types.Trigger{
 				{
-					Path:   []string{"./webapp/html"},
+					Path:   "./webapp/html",
 					Action: types.WatchActionSync,
 					Target: "/var/www",
 					Ignore: []string{"node_modules/"},
@@ -3111,7 +3111,11 @@ services:
 		assert.DeepEqual(t, *backend.Develop, types.DevelopConfig{
 			Watch: []types.Trigger{
 				{
-					Path:   []string{"./backend/src", "./backend"},
+					Path:   "./backend/src",
+					Action: types.WatchActionRebuild,
+				},
+				{
+					Path:   "./backend",
 					Action: types.WatchActionRebuild,
 				},
 			},
@@ -3121,7 +3125,7 @@ services:
 		assert.DeepEqual(t, *proxy.Develop, types.DevelopConfig{
 			Watch: []types.Trigger{
 				{
-					Path:   []string{"./proxy/proxy.conf"},
+					Path:   "./proxy/proxy.conf",
 					Action: types.WatchActionSyncRestart,
 					Target: "/etc/nginx/proxy.conf",
 				},
@@ -3148,42 +3152,6 @@ services:
 		})
 		assert.ErrorContains(t, err, "validating filename0.yml: services.frontend.develop.watch.0 action is required")
 	})
-
-	t.Run("should return an error when cannot resolve path", func(t *testing.T) {
-		b, err := os.ReadFile("testdata/watch/compose-test-watch-star.yaml")
-		assert.NilError(t, err)
-
-		configDetails := types.ConfigDetails{
-			WorkingDir: "testdata",
-			ConfigFiles: []types.ConfigFile{
-				{Filename: "watch/compose-test-watch-star.yaml", Content: b},
-			},
-			Environment: map[string]string{},
-		}
-		expServices := types.Services{
-			"app": {
-				Name:        "app",
-				Image:       "example/app",
-				Environment: types.MappingWithEquals{},
-				Networks:    map[string]*types.ServiceNetworkConfig{"default": nil},
-				Develop: &types.DevelopConfig{
-					Watch: []types.Trigger{
-						{
-							Path: []string{
-								filepath.FromSlash("testdata/watch/other.txt"),
-								filepath.FromSlash("testdata/watch/some-text.txt"),
-							},
-							Action: types.WatchActionRebuild,
-						},
-					},
-				},
-			},
-		}
-
-		actual, err := LoadWithContext(context.Background(), configDetails)
-		assert.NilError(t, err)
-		assert.DeepEqual(t, actual.Services, expServices)
-	})
 }
 
 func TestBadServiceConfig(t *testing.T) {

loader/validate.go

@@ -170,10 +170,6 @@ func checkConsistency(project *types.Project) error { //nolint:gocyclo
 				if watch.Action != types.WatchActionRebuild && watch.Action != types.WatchActionRestart {
 					if watch.Target == "" {
 						return fmt.Errorf("services.%s.develop.watch: target is required for %s, %s and %s actions: %w", s.Name, types.WatchActionSync, types.WatchActionSyncExec, types.WatchActionSyncRestart, errdefs.ErrInvalid)
-
-					}
-					if len(watch.Path) > 1 {
-						return fmt.Errorf("services.%s.develop.watch: detected multiple paths %s for action %s. Multiple files are only valid for %s and %s actions: %w", s.Name, watch.Path, watch.Action, types.WatchActionRebuild, types.WatchActionRestart, errdefs.ErrInvalid)
 					}
 				}
 			}

loader/validate_test.go

@@ -292,7 +292,7 @@ func TestValidateWatch(t *testing.T) {
 						Watch: []types.Trigger{
 							{
 								Action: types.WatchActionSync,
-								Path:   []string{"/app"},
+								Path:   "/app",
 								Target: "/container/app",
 							},
 						},
@@ -364,7 +364,7 @@ func TestValidateWatch(t *testing.T) {
 							Watch: []types.Trigger{
 								{
 									Action: tt.action,
-									Path:   []string{"/app"},
+									Path:   "/app",
 									// Missing Target
 								},
 							},
@@ -375,28 +375,6 @@ func TestValidateWatch(t *testing.T) {
 			err := checkConsistency(&project)
 			assert.Error(t, err, "services.myservice.develop.watch: target is required for sync, sync+exec and sync+restart actions: invalid compose project")
 		})
-
-		t.Run(fmt.Sprintf("watch config is INVALID with one or more paths for %s action", tt.action), func(t *testing.T) {
-			project := types.Project{
-				Services: types.Services{
-					"myservice": {
-						Name:  "myservice",
-						Image: "scratch",
-						Develop: &types.DevelopConfig{
-							Watch: []types.Trigger{
-								{
-									Action: tt.action,
-									Path:   []string{"/app", "/app2"}, // should only be one path
-									Target: "/container/app",
-								},
-							},
-						},
-					},
-				},
-			}
-			err := checkConsistency(&project)
-			assert.ErrorContains(t, err, "services.myservice.develop.watch: detected multiple paths")
-		})
 	}
 	tests = []WatchActionTest{
 		{action: types.WatchActionRebuild},
@@ -413,7 +391,7 @@ func TestValidateWatch(t *testing.T) {
 							Watch: []types.Trigger{
 								{
 									Action: tt.action,
-									Path:   []string{"/app"},
+									Path:   "/app",
 								},
 							},
 						},
@@ -434,11 +412,11 @@ func TestValidateWatch(t *testing.T) {
 							Watch: []types.Trigger{
 								{
 									Action: tt.action,
-									Path:   []string{"/app"},
+									Path:   "/app",
 								},
 								{
 									Action: tt.action,
-									Path:   []string{"/app", "/app2"},
+									Path:   "/app2",
 								},
 							},
 						},

paths/unix.go

@@ -17,7 +17,6 @@
 package paths
 
 import (
-	"fmt"
 	"path"
 	"path/filepath"
 
@@ -50,41 +49,9 @@ func (r *relativePathsResolver) absSymbolicLink(value any) (any, error) {
 	if err != nil {
 		return nil, err
 	}
-	switch t := abs.(type) {
-	case string:
-		// this can return []string if * matches more than one file
-		return resolveAbsStarPath(t)
-	case []any:
-		var res []any
-		for _, tt := range t {
-			s, _ := tt.(string)
-			r, err := resolveAbsStarPath(s)
-			if err != nil {
-				return nil, err
-			}
-			res = append(res, r...)
-		}
-		return res, nil
-	}
-
-	return abs, nil
-}
-
-func resolveAbsStarPath(t string) ([]any, error) {
-	matches, err := filepath.Glob(t)
-	if err != nil {
-		return nil, err
-	}
-	if len(matches) == 0 {
-		return nil, fmt.Errorf("could not resolve %s. Please make sure it exists?", t)
-	}
-	res := make([]any, len(matches))
-	for i, m := range matches {
-		symb, err := utils.ResolveSymbolicLink(m)
-		if err != nil {
-			return nil, err
-		}
-		res[i] = symb
+	str, ok := abs.(string)
+	if !ok {
+		return abs, nil
 	}
-	return res, nil
+	return utils.ResolveSymbolicLink(str)
 }

transform/canonical.go

@@ -36,7 +36,7 @@ func init() {
 	transformers["services.*.networks"] = transformServiceNetworks
 	transformers["services.*.volumes.*"] = transformVolumeMount
 	transformers["services.*.dns"] = transformStringOrList
-	transformers["services.*.develop.watch.*.path"] = transformStringOrList
+	transformers["services.*.develop.watch"] = transformWatch
 	transformers["services.*.devices.*"] = transformDeviceMapping
 	transformers["services.*.secrets.*"] = transformFileMount
 	transformers["services.*.configs.*"] = transformFileMount
@@ -52,6 +52,51 @@ func init() {
 	transformers["include.*"] = transformInclude
 }
 
+func transformWatch(data any, _ tree.Path, _ bool) (any, error) {
+	t, ok := data.([]interface{})
+	if !ok {
+		return data, nil
+	}
+
+	for i, w := range t {
+		watchConf, ok := w.(map[string]interface{})
+		if !ok {
+			continue
+		}
+		path, ok := watchConf["path"]
+		if !ok {
+			// This should not happen
+			continue
+		}
+		paths, ok := path.([]interface{})
+		if !ok {
+			// if path is a string there is nothing to do
+			continue
+		}
+
+		// remove the current path that is a list
+		if i == len(t)-1 {
+			t = t[:i]
+		} else {
+			t = append(t[:i], t[i+1:])
+		}
+
+		// transform each element into a watch item
+		for _, p := range paths {
+			extend := make(map[string]interface{})
+			for k, v := range watchConf {
+				if k == "path" {
+					extend[k] = p
+					continue
+				}
+				extend[k] = v
+			}
+			t = append(t, extend)
+		}
+	}
+	return t, nil
+}
+
 func transformStringOrList(data any, _ tree.Path, _ bool) (any, error) {
 	switch t := data.(type) {
 	case string:

types/develop.go

@@ -16,6 +16,11 @@
 
 package types
 
+import (
+	"path/filepath"
+	"strings"
+)
+
 type DevelopConfig struct {
 	Watch []Trigger `yaml:"watch,omitempty" json:"watch,omitempty"`
 
@@ -33,10 +38,34 @@ const (
 )
 
 type Trigger struct {
-	Path       StringList  `yaml:"path" json:"path"`
+	Path       string      `yaml:"path" json:"path"`
 	Action     WatchAction `yaml:"action" json:"action"`
 	Target     string      `yaml:"target,omitempty" json:"target,omitempty"`
 	Exec       ServiceHook `yaml:"exec,omitempty" json:"exec,omitempty"`
 	Ignore     []string    `yaml:"ignore,omitempty" json:"ignore,omitempty"`
 	Extensions Extensions  `yaml:"#extensions,inline,omitempty" json:"-"`
 }
+
+func (t Trigger) AnchorPath() string {
+	if t.IsGlobPath() {
+		pathList := strings.Split(filepath.FromSlash(t.Path), "/")
+		path := []string{}
+
+		for _, a := range pathList {
+			if strings.Contains(a, "*") {
+				break
+			}
+			path = append(path, a)
+		}
+		return strings.Join(path, string(filepath.Separator))
+	}
+	return t.Path
+}
+
+func (t Trigger) IsGlobPath() bool {
+	return strings.Contains(t.Path, "*")
+}
+
+func (t Trigger) IsSyncAction() bool {
+	return t.Action == WatchActionSync || t.Action == WatchActionSyncRestart
+}

validation/validation.go

@@ -89,19 +89,11 @@ func checkFileObject(keys ...string) checkerFunc {
 }
 
 func checkPath(value any, p tree.Path) error {
-	switch v := value.(type) {
-	case string:
-		if v == "" {
-			return fmt.Errorf("%s: value can't be blank", p)
-		}
-	case []interface{}:
-		for _, el := range v {
-			e := el.(string)
-			if e == "" {
-				return fmt.Errorf("%s: value in paths can't be blank", e)
-			}
-		}
+	v := value.(string)
+	if v == "" {
+		return fmt.Errorf("%s: value can't be blank", p)
 	}
+
 	return nil
 }