orchestrator/app: add ProvisioningStateDir, AppComposeFilePath methods (#517)

Author: alessio-perugini

internal/orchestrator/app/app.go

@@ -69,6 +69,11 @@ func Load(appPath string) (ArduinoApp, error) {
 		return ArduinoApp{}, errors.New("main python file and sketch file missing from app")
 	}
 
+	// Ensure the .cache folder is created
+	if err := app.ProvisioningStateDir().MkdirAll(); err != nil {
+		return ArduinoApp{}, errors.New("cannot create .cache directory for app provisioning state")
+	}
+
 	return app, nil
 }
 
@@ -104,3 +109,11 @@ func (a *ArduinoApp) Save() error {
 func (a *ArduinoApp) SketchBuildPath() *paths.Path {
 	return a.FullPath.Join(".cache", "sketch")
 }
+
+func (a *ArduinoApp) ProvisioningStateDir() *paths.Path {
+	return a.FullPath.Join(".cache")
+}
+
+func (a *ArduinoApp) AppComposeFilePath() *paths.Path {
+	return a.ProvisioningStateDir().Join("app-compose.yaml")
+}

internal/orchestrator/logs.go

@@ -45,11 +45,7 @@ func AppLogs(
 		return x.EmptyIter[LogMessage](), nil
 	}
 
-	provisioningStateDir, err := getProvisioningStateDir(app)
-	if err != nil {
-		return nil, err
-	}
-	mainCompose := provisioningStateDir.Join("app-compose.yaml")
+	mainCompose := app.AppComposeFilePath()
 	if mainCompose.NotExist() {
 		return x.EmptyIter[LogMessage](), nil
 	}
@@ -63,7 +59,7 @@ func AppLogs(
 			slog.Warn("invalid brick id", slog.String("brick_id", brick.ID))
 			continue
 		}
-		composeFilePath := provisioningStateDir.Join("compose", namespace, brickName, "brick_compose.yaml")
+		composeFilePath := app.ProvisioningStateDir().Join("compose", namespace, brickName, "brick_compose.yaml")
 		if composeFilePath.Exist() {
 			prj, err := loader.LoadWithContext(
 				ctx,

internal/orchestrator/orchestrator.go

@@ -153,12 +153,6 @@ func StartApp(
 				return
 			}
 
-			provisioningStateDir, err := getProvisioningStateDir(app)
-			if err != nil {
-				yield(StreamMessage{error: err})
-				return
-			}
-
 			// Override the compose Variables with the app's variables and model configuration.
 			envs := []string{}
 			addMapToEnv := func(m map[string]string) {
@@ -173,10 +167,9 @@ func StartApp(
 				}
 			}
 
-			mainCompose := provisioningStateDir.Join("app-compose.yaml")
-			overrideComposeFile := provisioningStateDir.Join("app-compose-overrides.yaml")
+			overrideComposeFile := app.ProvisioningStateDir().Join("app-compose-overrides.yaml")
 			commands := []string{}
-			commands = append(commands, "docker", "compose", "-f", mainCompose.String())
+			commands = append(commands, "docker", "compose", "-f", app.AppComposeFilePath().String())
 			if ok, _ := overrideComposeFile.ExistCheck(); ok {
 				commands = append(commands, "-f", overrideComposeFile.String())
 			}
@@ -221,12 +214,7 @@ func StopApp(ctx context.Context, app app.ArduinoApp) iter.Seq[StreamMessage] {
 		}
 
 		if app.MainPythonFile != nil {
-			provisioningStateDir, err := getProvisioningStateDir(app)
-			if err != nil {
-				yield(StreamMessage{error: err})
-				return
-			}
-			mainCompose := provisioningStateDir.Join("app-compose.yaml")
+			mainCompose := app.AppComposeFilePath()
 			// In case the app was never started
 			if mainCompose.Exist() {
 				process, err := paths.NewProcess(nil, "docker", "compose", "-f", mainCompose.String(), "stop", fmt.Sprintf("--timeout=%d", DefaultDockerStopTimeoutSeconds))

internal/orchestrator/provision.go

@@ -93,12 +93,7 @@ func (p *Provision) App(
 		return fmt.Errorf("provisioning failed: arduinoApp is nil")
 	}
 
-	provisioningStateDir, err := getProvisioningStateDir(*arduinoApp)
-	if err != nil {
-		return err
-	}
-
-	dst := provisioningStateDir.Join("compose")
+	dst := arduinoApp.ProvisioningStateDir().Join("compose")
 	if err := dst.RemoveAll(); err != nil {
 		return fmt.Errorf("failed to remove compose directory: %w", err)
 	}
@@ -195,14 +190,6 @@ func pullBasePythonContainer(ctx context.Context, pythonImage string) error {
 	return process.RunWithinContext(ctx)
 }
 
-func getProvisioningStateDir(app app.ArduinoApp) (*paths.Path, error) {
-	cacheDir := app.FullPath.Join(".cache")
-	if err := cacheDir.MkdirAll(); err != nil {
-		return nil, err
-	}
-	return cacheDir, nil
-}
-
 const DockerAppLabel = "cc.arduino.app"
 const DockerAppPathLabel = "cc.arduino.app.path"
 
@@ -211,19 +198,14 @@ func generateMainComposeFile(
 	bricksIndex *bricksindex.BricksIndex,
 	pythonImage string,
 ) error {
-	provisioningStateDir, err := getProvisioningStateDir(*app)
-	if err != nil {
-		return err
-	}
-
 	slog.Debug("Generating main compose file for the App")
 
 	var composeFiles paths.PathList
 	services := []string{}
 	brickServices := map[string][]string{}
 	for _, brick := range app.Descriptor.Bricks {
 		brickPath := filepath.Join(strings.Split(brick.ID, ":")...)
-		composeFilePath := provisioningStateDir.Join("compose", brickPath, "brick_compose.yaml")
+		composeFilePath := app.ProvisioningStateDir().Join("compose", brickPath, "brick_compose.yaml")
 		if composeFilePath.Exist() {
 			composeFiles.Add(composeFilePath)
 			svcs, e := extracServicesFromComposeFile(composeFilePath)
@@ -240,9 +222,9 @@ func generateMainComposeFile(
 	}
 
 	// Create a single docker-mainCompose that includes all the required services
-	mainComposeFile := provisioningStateDir.Join("app-compose.yaml")
+	mainComposeFile := app.AppComposeFilePath()
 	// If required, create an override compose file for devices
-	overrideComposeFile := provisioningStateDir.Join("app-compose-overrides.yaml")
+	overrideComposeFile := app.ProvisioningStateDir().Join("app-compose-overrides.yaml")
 
 	type mainService struct {
 		Main service `yaml:"main"`