feat: set site execution order

Author: demeyerthom

.changes/unreleased/Added-20250708-114044.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: Added option to set site execution order
+time: 2025-07-08T11:40:44.556019581+02:00

internal/batcher/batcher.go

@@ -1,5 +1,57 @@
 package batcher
 
-import "github.com/mach-composer/mach-composer-cli/internal/graph"
+import (
+	"fmt"
+	"github.com/mach-composer/mach-composer-cli/internal/config"
+	"github.com/mach-composer/mach-composer-cli/internal/graph"
+	"slices"
+)
 
-type BatchFunc func(g *graph.Graph) map[int][]graph.Node
+type BatchFunc func(g *graph.Graph) (map[int][]graph.Node, error)
+
+type Batcher string
+
+func Factory(cfg *config.MachConfig) (BatchFunc, error) {
+	switch cfg.MachComposer.Batcher.Type {
+	case "":
+		fallthrough
+	case "simple":
+		return simpleBatchFunc(), nil
+	case "site":
+		var siteOrder, err = DetermineSiteOrder(cfg)
+		if err != nil {
+			return nil, fmt.Errorf("failed determining site order: %w", err)
+		}
+
+		return siteBatchFunc(siteOrder), nil
+	default:
+		return nil, fmt.Errorf("unknown batch type %s", cfg.MachComposer.Batcher.Type)
+	}
+}
+
+func DetermineSiteOrder(cfg *config.MachConfig) ([]string, error) {
+	var identifiers = cfg.Sites.Identifiers()
+	var siteOrder = make([]string, len(identifiers))
+
+	if len(cfg.MachComposer.Batcher.SiteOrder) > 0 {
+		// Use the site order from the configuration if provided
+		siteOrder = cfg.MachComposer.Batcher.SiteOrder
+
+		// Make sure the site order contains the same fields as the identifiers
+		if len(siteOrder) != len(identifiers) {
+			return nil, fmt.Errorf("site order length %d does not match identifiers length %d", len(siteOrder), len(identifiers))
+		}
+		for _, siteIdentifier := range siteOrder {
+			if !slices.Contains(identifiers, siteIdentifier) {
+				return nil, fmt.Errorf("site order contains siteIdentifier %s that is not in the identifiers list", siteIdentifier)
+			}
+		}
+
+	} else {
+		for i, identifier := range identifiers {
+			siteOrder[i] = identifier
+		}
+	}
+
+	return siteOrder, nil
+}

internal/batcher/batcher_test.go

@@ -0,0 +1,150 @@
+package batcher
+
+import (
+	"github.com/mach-composer/mach-composer-cli/internal/config"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestReturnsErrorWhenUnknownBatchType(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{
+				Type: "unknown",
+			},
+		},
+	}
+
+	_, err := Factory(cfg)
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "unknown batch type unknown")
+}
+
+func TestReturnsSimpleBatchFuncWhenTypeIsEmpty(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{
+				Type: "",
+			},
+		},
+	}
+
+	batchFunc, err := Factory(cfg)
+	assert.NoError(t, err)
+	assert.NotNil(t, batchFunc)
+}
+
+func TestReturnsSimpleBatchFuncWhenTypeIsSimple(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{
+				Type: "simple",
+			},
+		},
+	}
+
+	batchFunc, err := Factory(cfg)
+	assert.NoError(t, err)
+	assert.NotNil(t, batchFunc)
+}
+
+func TestReturnsSiteBatchFunc(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{
+				Type: "site",
+			},
+		},
+		Sites: config.SiteConfigs{
+			{
+				Identifier: "site-1",
+			},
+			{
+				Identifier: "site-2",
+			},
+		},
+	}
+
+	batchFunc, err := Factory(cfg)
+	assert.NoError(t, err)
+	assert.NotNil(t, batchFunc)
+}
+
+func TestDetermineSiteOrderReturnsIdentifiersWhenNoSiteOrderProvided(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{},
+		},
+		Sites: config.SiteConfigs{
+			{Identifier: "site-1"},
+			{Identifier: "site-2"},
+		},
+	}
+	order, err := DetermineSiteOrder(cfg)
+	assert.NoError(t, err)
+	assert.Equal(t, []string{"site-1", "site-2"}, order)
+}
+
+func TestDetermineSiteOrderReturnsSiteOrderWhenProvided(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{
+				SiteOrder: []string{"site-2", "site-1"},
+			},
+		},
+		Sites: config.SiteConfigs{
+			{Identifier: "site-1"},
+			{Identifier: "site-2"},
+		},
+	}
+	order, err := DetermineSiteOrder(cfg)
+	assert.NoError(t, err)
+	assert.Equal(t, []string{"site-2", "site-1"}, order)
+}
+
+func TestDetermineSiteOrderReturnsErrorWhenSiteOrderLengthMismatch(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{
+				SiteOrder: []string{"site-1", "site-2"},
+			},
+		},
+		Sites: config.SiteConfigs{
+			{Identifier: "site-1"},
+		},
+	}
+	order, err := DetermineSiteOrder(cfg)
+	assert.Error(t, err)
+	assert.Nil(t, order)
+	assert.Contains(t, err.Error(), "site order length 2 does not match identifiers length 1")
+}
+
+func TestDetermineSiteOrderReturnsErrorWhenSiteOrderContainsUnknownIdentifier(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{
+				SiteOrder: []string{"site-1", "unknown-site"},
+			},
+		},
+		Sites: config.SiteConfigs{
+			{Identifier: "site-1"},
+			{Identifier: "site-2"},
+		},
+	}
+	order, err := DetermineSiteOrder(cfg)
+	assert.Error(t, err)
+	assert.Nil(t, order)
+	assert.Contains(t, err.Error(), "site order contains siteIdentifier unknown-site that is not in the identifiers list")
+}
+
+func TestDetermineSiteOrderReturnsEmptyWhenNoSites(t *testing.T) {
+	cfg := &config.MachConfig{
+		MachComposer: config.MachComposer{
+			Batcher: config.Batcher{},
+		},
+		Sites: config.SiteConfigs{},
+	}
+	order, err := DetermineSiteOrder(cfg)
+	assert.NoError(t, err)
+	assert.Empty(t, order)
+}

internal/batcher/naive_batcher.go renamed to internal/batcher/simple_batcher.go

@@ -2,8 +2,9 @@ package batcher
 
 import "github.com/mach-composer/mach-composer-cli/internal/graph"
 
-func NaiveBatchFunc() BatchFunc {
-	return func(g *graph.Graph) map[int][]graph.Node {
+// simpleBatchFunc returns a BatchFunc that batches nodes based on their depth in the graph.
+func simpleBatchFunc() BatchFunc {
+	return func(g *graph.Graph) (map[int][]graph.Node, error) {
 		batches := map[int][]graph.Node{}
 
 		var sets = map[string][]graph.Path{}
@@ -24,6 +25,6 @@ func NaiveBatchFunc() BatchFunc {
 			batches[mx] = append(batches[mx], n)
 		}
 
-		return batches
+		return batches, nil
 	}
 }

internal/batcher/naive_batcher_test.go renamed to internal/batcher/simple_batcher_test.go

@@ -7,7 +7,7 @@ import (
 	"testing"
 )
 
-func TestBatchNodesDepth1(t *testing.T) {
+func TestSimpleBatchNodesDepth1(t *testing.T) {
 	ig := graph.New(func(n internalgraph.Node) string { return n.Path() }, graph.Directed(), graph.Tree(), graph.PreventCycles())
 
 	start := new(internalgraph.NodeMock)
@@ -17,12 +17,13 @@ func TestBatchNodesDepth1(t *testing.T) {
 
 	g := &internalgraph.Graph{Graph: ig, StartNode: start}
 
-	batches := NaiveBatchFunc()(g)
+	batches, err := simpleBatchFunc()(g)
 
+	assert.NoError(t, err)
 	assert.Equal(t, 1, len(batches))
 }
 
-func TestBatchNodesDepth2(t *testing.T) {
+func TestSimpleBatchNodesDepth2(t *testing.T) {
 	ig := graph.New(func(n internalgraph.Node) string { return n.Path() }, graph.Directed(), graph.Tree(), graph.PreventCycles())
 
 	site := new(internalgraph.NodeMock)
@@ -43,8 +44,9 @@ func TestBatchNodesDepth2(t *testing.T) {
 
 	g := &internalgraph.Graph{Graph: ig, StartNode: site}
 
-	batches := NaiveBatchFunc()(g)
+	batches, err := simpleBatchFunc()(g)
 
+	assert.NoError(t, err)
 	assert.Equal(t, 2, len(batches))
 	assert.Equal(t, 1, len(batches[0]))
 	assert.Equal(t, "main/site-1", batches[0][0].Path())
@@ -53,7 +55,7 @@ func TestBatchNodesDepth2(t *testing.T) {
 	assert.Contains(t, batches[1][1].Path(), "component")
 }
 
-func TestBatchNodesDepth3(t *testing.T) {
+func TestSimpleBatchNodesDepth3(t *testing.T) {
 	ig := graph.New(func(n internalgraph.Node) string { return n.Path() }, graph.Directed(), graph.Tree(), graph.PreventCycles())
 
 	site := new(internalgraph.NodeMock)
@@ -74,8 +76,9 @@ func TestBatchNodesDepth3(t *testing.T) {
 
 	g := &internalgraph.Graph{Graph: ig, StartNode: site}
 
-	batches := NaiveBatchFunc()(g)
+	batches, err := simpleBatchFunc()(g)
 
+	assert.NoError(t, err)
 	assert.Equal(t, 3, len(batches))
 	assert.Equal(t, 1, len(batches[0]))
 	assert.Equal(t, "main/site-1", batches[0][0].Path())

internal/batcher/site_batcher.go

@@ -0,0 +1,71 @@
+package batcher
+
+import (
+	"fmt"
+	"github.com/mach-composer/mach-composer-cli/internal/graph"
+	"golang.org/x/exp/maps"
+)
+
+// siteBatchFunc returns a BatchFunc that batches nodes based on their site order before considering their depth in
+// the graph.
+func siteBatchFunc(siteOrder []string) BatchFunc {
+	return func(g *graph.Graph) (map[int][]graph.Node, error) {
+		batches := map[int][]graph.Node{}
+
+		var projects = g.Vertices().Filter(graph.ProjectType)
+		if len(projects) != 1 {
+			return nil, fmt.Errorf("expected 1 project, got %d", len(projects))
+		}
+		var project = projects[0]
+
+		var sites = g.Vertices().Filter(graph.SiteType)
+
+		batches[0] = []graph.Node{project}
+
+		for _, siteIdentifier := range siteOrder {
+			var sets = map[string][]graph.Path{}
+			var site = sites.FilterByIdentifier(siteIdentifier)
+			if site == nil {
+				return nil, fmt.Errorf("site with identifier %s not found", siteIdentifier)
+			}
+
+			pg, err := g.ExtractSubGraph(site)
+			if err != nil {
+				return nil, err
+			}
+
+			for _, n := range pg.Vertices() {
+				var route, _ = pg.Routes(n.Path(), site.Path())
+				sets[n.Path()] = route
+			}
+
+			var siteBatches = map[int][]graph.Node{}
+
+			for k, routes := range sets {
+				var mx int
+				for _, route := range routes {
+					if len(route) > mx {
+						mx = len(route)
+					}
+				}
+				n, _ := pg.Vertex(k)
+				siteBatches[mx] = append(siteBatches[mx], n)
+			}
+
+			// Get the highest int in the batches map
+			var keys = maps.Keys(batches)
+			var maxKey int
+			for _, key := range keys {
+				if key > maxKey {
+					maxKey = key
+				}
+			}
+
+			for k, v := range siteBatches {
+				batches[maxKey+k+1] = append(batches[maxKey+k+1], v...)
+			}
+		}
+
+		return batches, nil
+	}
+}