feat(provision): add condition to dependsOn services list [WIRE-1091] (#584)

Author: stefanotorneo

internal/orchestrator/logs.go

@@ -65,11 +65,11 @@ func AppLogs(
 			continue
 		}
 
-		services, err := extracServicesFromComposeFile(composeFilePath)
+		services, err := extractServicesFromComposeFile(composeFilePath)
 		if err != nil {
 			return x.EmptyIter[LogMessage](), err
 		}
-		for _, s := range services {
+		for s := range services {
 			serviceToBrickMapping[s] = brick.ID
 		}
 	}

internal/orchestrator/provision.go

@@ -30,18 +30,22 @@ type volume struct {
 	Target string `yaml:"target"`
 }
 
+type dependsOnCondition struct {
+	Condition string `yaml:"condition"`
+}
+
 type service struct {
-	Image       string            `yaml:"image"`
-	DependsOn   []string          `yaml:"depends_on,omitempty"`
-	Volumes     []volume          `yaml:"volumes"`
-	Devices     []string          `yaml:"devices"`
-	Ports       []string          `yaml:"ports"`
-	User        string            `yaml:"user"`
-	GroupAdd    []string          `yaml:"group_add"`
-	Entrypoint  string            `yaml:"entrypoint"`
-	ExtraHosts  []string          `yaml:"extra_hosts,omitempty"`
-	Labels      map[string]string `yaml:"labels,omitempty"`
-	Environment map[string]string `yaml:"environment,omitempty"`
+	Image       string                        `yaml:"image"`
+	DependsOn   map[string]dependsOnCondition `yaml:"depends_on,omitempty"`
+	Volumes     []volume                      `yaml:"volumes"`
+	Devices     []string                      `yaml:"devices"`
+	Ports       []string                      `yaml:"ports"`
+	User        string                        `yaml:"user"`
+	GroupAdd    []string                      `yaml:"group_add"`
+	Entrypoint  string                        `yaml:"entrypoint"`
+	ExtraHosts  []string                      `yaml:"extra_hosts,omitempty"`
+	Labels      map[string]string             `yaml:"labels,omitempty"`
+	Environment map[string]string             `yaml:"environment,omitempty"`
 }
 
 type Provision struct {
@@ -196,8 +200,8 @@ func generateMainComposeFile(
 	}
 
 	var composeFiles paths.PathList
-	services := []string{}
-	servicesThatRequireDevices := []string{}
+	services := make(map[string]serviceInfo)
+	var servicesThatRequireDevices []string
 	for _, brick := range app.Descriptor.Bricks {
 		idxBrick, found := bricksIndex.FindBrickByID(brick.ID)
 		slog.Debug("Processing brick", slog.String("brick_id", brick.ID), slog.Bool("found", found))
@@ -224,7 +228,7 @@ func generateMainComposeFile(
 		}
 
 		// 3. Retrieve the compose services names.
-		svcs, err := extracServicesFromComposeFile(composeFilePath)
+		svcs, err := extractServicesFromComposeFile(composeFilePath)
 		if err != nil {
 			slog.Error("loading brick_compose", slog.String("brick_id", brick.ID), slog.String("path", composeFilePath.String()), slog.Any("error", err))
 			continue
@@ -233,11 +237,11 @@ func generateMainComposeFile(
 		// 4. Retrieve the required devices that we have to mount
 		slog.Debug("Brick require Devices", slog.Bool("Devices", idxBrick.RequiresDevices), slog.Any("ports", ports))
 		if idxBrick.RequiresDevices {
-			servicesThatRequireDevices = append(servicesThatRequireDevices, svcs...)
+			servicesThatRequireDevices = slices.AppendSeq(servicesThatRequireDevices, maps.Keys(svcs))
 		}
 
 		composeFiles.Add(composeFilePath)
-		services = append(services, svcs...)
+		maps.Insert(services, maps.All(svcs))
 	}
 
 	// Create a single docker-mainCompose that includes all the required services
@@ -291,14 +295,30 @@ func generateMainComposeFile(
 
 	groups := []string{"dialout", "video", "audio", "render"}
 
+	// Define depends_on conditions
+	// Services with healthcheck will be started only when healthy
+	// Services without healthcheck will be started as soon as the container is started
+	dependsOn := make(map[string]dependsOnCondition, len(services))
+	for name := range services {
+		if services[name].hasHealthcheck {
+			dependsOn[name] = dependsOnCondition{
+				Condition: "service_healthy",
+			}
+		} else {
+			dependsOn[name] = dependsOnCondition{
+				Condition: "service_started",
+			}
+		}
+	}
+
 	mainAppCompose.Services = &mainService{
 		Main: service{
 			Image:      pythonImage,
 			Volumes:    volumes,
 			Ports:      slices.Collect(maps.Keys(ports)),
 			Devices:    devices.devicePaths,
 			Entrypoint: "/run.sh",
-			DependsOn:  services,
+			DependsOn:  dependsOn,
 			User:       getCurrentUser(),
 			GroupAdd:   groups,
 			ExtraHosts: []string{"msgpack-rpc-router:host-gateway"},
@@ -333,7 +353,7 @@ func generateMainComposeFile(
 
 	// If there are services that require devices, we need to generate an override compose file
 	// Write additional file to override devices section in included compose files
-	if e := generateServicesOverrideFile(app, services, servicesThatRequireDevices, devices.devicePaths, getCurrentUser(), groups, overrideComposeFile); e != nil {
+	if e := generateServicesOverrideFile(app, slices.Collect(maps.Keys(services)), servicesThatRequireDevices, devices.devicePaths, getCurrentUser(), groups, overrideComposeFile); e != nil {
 		return e
 	}
 
@@ -356,14 +376,21 @@ func generateMainComposeFile(
 	return nil
 }
 
-func extracServicesFromComposeFile(composeFile *paths.Path) ([]string, error) {
+type serviceInfo struct {
+	hasHealthcheck bool
+}
+
+func extractServicesFromComposeFile(composeFile *paths.Path) (map[string]serviceInfo, error) {
 	content, err := os.ReadFile(composeFile.String())
 	if err != nil {
 		return nil, err
 	}
 
 	type serviceMin struct {
-		Image string `yaml:"image"`
+		Image       string `yaml:"image"`
+		Healthcheck struct {
+			Test []string `yaml:"test"`
+		} `yaml:"healthcheck,omitempty"`
 	}
 	type composeServices struct {
 		Services map[string]serviceMin `yaml:"services"`
@@ -372,11 +399,10 @@ func extracServicesFromComposeFile(composeFile *paths.Path) ([]string, error) {
 	if err := yaml.Unmarshal(content, &index); err != nil {
 		return nil, err
 	}
-	services := make([]string, len(index.Services))
-	i := 0
-	for svc := range maps.Keys(index.Services) {
-		services[i] = svc
-		i++
+	services := make(map[string]serviceInfo, len(index.Services))
+	for svc, svcDef := range index.Services {
+		hasHealthcheck := len(svcDef.Healthcheck.Test) > 0
+		services[svc] = serviceInfo{hasHealthcheck: hasHealthcheck}
 	}
 	return services, nil
 }

internal/orchestrator/provision_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator/bricksindex"
 	"github.com/bcmi-labs/orchestrator/internal/store"
 
-	yaml "github.com/goccy/go-yaml"
+	"github.com/goccy/go-yaml"
 
 	"github.com/stretchr/testify/require"
 )
@@ -251,3 +251,156 @@ services:
 	})
 
 }
+
+func TestProvisionAppWithDependsOn(t *testing.T) {
+	cfg := setTestOrchestratorConfig(t)
+	staticStore := store.NewStaticStore(cfg.AssetsDir().String())
+	tempDirectory := t.TempDir()
+	var env = map[string]string{}
+	type services struct {
+		Services map[string]struct {
+			Image     string `yaml:"image"`
+			DependsOn map[string]struct {
+				Condition string `yaml:"condition"`
+			} `yaml:"depends_on"`
+		} `yaml:"services"`
+	}
+
+	bricksIndexContent := []byte(`
+bricks:
+- id: arduino:dbstorage_tsstore
+  name: Database Storage - Time Series Store
+  description: Simplified time series database storage layer for Arduino sensor samples
+    built on top of InfluxDB.
+  require_container: true
+  require_model: false
+  ports: []
+  category: storage
+  variables:
+  - name: APP_HOME
+    default_value: .`)
+	err := cfg.AssetsDir().Join("bricks-list.yaml").WriteFile(bricksIndexContent)
+	require.NoError(t, err)
+
+	bricksIndex, err := bricksindex.GenerateBricksIndexFromFile(cfg.AssetsDir())
+	require.Nil(t, err, "Failed to load bricks index with custom content")
+	br, ok := bricksIndex.FindBrickByID("arduino:dbstorage_tsstore")
+	require.True(t, ok, "Brick arduino:dbstorage_tsstore should exist in the index")
+	require.NotNil(t, br, "Brick arduino:dbstorage_tsstore should not be nil")
+	require.Equal(t, "Database Storage - Time Series Store", br.Name, "Brick name should match")
+
+	app := app.ArduinoApp{
+		Name: "TestApp",
+		Descriptor: app.AppDescriptor{
+			Bricks: []app.Brick{
+				{
+					ID: "arduino:dbstorage_tsstore",
+				},
+			},
+		},
+		FullPath: paths.New(tempDirectory),
+	}
+	require.NoError(t, app.ProvisioningStateDir().MkdirAll())
+
+	t.Run("services with healthcheck", func(t *testing.T) {
+		fileComposePath := cfg.AssetsDir().Join("compose", "arduino", "dbstorage_tsstore")
+		require.NoError(t, fileComposePath.MkdirAll())
+		dependsOnFromStrings := `
+services:
+  dbstorage-influx:
+    image: influxdb:2.7
+    ports:
+      - "${BIND_ADDRESS:-127.0.0.1}:${BIND_PORT:-8086}:8086"
+    volumes:
+      - "${APP_HOME:-.}/data/influx-data:/var/lib/influxdb2"
+    environment:
+      DOCKER_INFLUXDB_INIT_MODE: setup
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8086/health"]`
+		err := fileComposePath.Join("brick_compose.yaml").WriteFile([]byte(dependsOnFromStrings))
+		require.NoError(t, err)
+
+		// Run the provision function to generate the main compose file
+		err = generateMainComposeFile(&app, bricksIndex, "app-bricks:python-apps-base:dev-latest", cfg, env, staticStore)
+		require.NoError(t, err, "Failed to generate main compose file")
+		composeFilePath := paths.New(tempDirectory).Join(".cache").Join("app-compose.yaml")
+		require.True(t, composeFilePath.Exist(), "Main compose file should exist")
+
+		// Open main compose file and check for the expected depends_on with service_healthy
+		mainComposeFileContent, err := composeFilePath.ReadFile()
+		require.Nil(t, err, "Failed to read compose file")
+		var content services
+		err = yaml.Unmarshal(mainComposeFileContent, &content)
+		require.Nil(t, err, "Failed to unmarshal overrides content")
+		exp := services{
+			Services: map[string]struct {
+				Image     string `yaml:"image"`
+				DependsOn map[string]struct {
+					Condition string `yaml:"condition"`
+				} `yaml:"depends_on"`
+			}{
+				"main": {
+					Image: "app-bricks:python-apps-base:dev-latest",
+					DependsOn: map[string]struct {
+						Condition string `yaml:"condition"`
+					}{
+						"dbstorage-influx": {
+							Condition: "service_healthy",
+						},
+					},
+				},
+			},
+		}
+		require.Equal(t, exp, content, "Main compose content should match the expected structure")
+	})
+
+	t.Run("services without healthcheck", func(t *testing.T) {
+		fileComposePath := cfg.AssetsDir().Join("compose", "arduino", "dbstorage_tsstore")
+		require.NoError(t, fileComposePath.MkdirAll())
+		dependsOnFromStrings := `
+services:
+  dbstorage-influx:
+    image: influxdb:2.7
+    ports:
+      - "${BIND_ADDRESS:-127.0.0.1}:${BIND_PORT:-8086}:8086"
+    volumes:
+      - "${APP_HOME:-.}/data/influx-data:/var/lib/influxdb2"
+    environment:
+      DOCKER_INFLUXDB_INIT_MODE: setup`
+		err = fileComposePath.Join("brick_compose.yaml").WriteFile([]byte(dependsOnFromStrings))
+		require.NoError(t, err)
+
+		// Run the provision function to generate the main compose file
+		err = generateMainComposeFile(&app, bricksIndex, "app-bricks:python-apps-base:dev-latest", cfg, env, staticStore)
+		require.NoError(t, err, "Failed to generate main compose file")
+		composeFilePath := paths.New(tempDirectory).Join(".cache").Join("app-compose.yaml")
+		require.True(t, composeFilePath.Exist(), "Main compose file should exist")
+
+		// Open main compose file and check for the expected depends_on with service_started
+		mainComposeFileContent, err := composeFilePath.ReadFile()
+		require.Nil(t, err, "Failed to read compose file")
+		var content services
+		err = yaml.Unmarshal(mainComposeFileContent, &content)
+		require.Nil(t, err, "Failed to unmarshal overrides content")
+		exp := services{
+			Services: map[string]struct {
+				Image     string `yaml:"image"`
+				DependsOn map[string]struct {
+					Condition string `yaml:"condition"`
+				} `yaml:"depends_on"`
+			}{
+				"main": {
+					Image: "app-bricks:python-apps-base:dev-latest",
+					DependsOn: map[string]struct {
+						Condition string `yaml:"condition"`
+					}{
+						"dbstorage-influx": {
+							Condition: "service_started",
+						},
+					},
+				},
+			},
+		}
+		require.Equal(t, exp, content, "Main compose content should match the expected structure")
+	})
+}