Unify BrickInstance types and add getSelectedModelOrDefault helper

Author: dido18

internal/orchestrator/bricks/bricks.go

@@ -71,7 +71,7 @@ func (s *Service) List() (BrickListResult, error) {
 }
 
 func (s *Service) AppBrickInstancesList(a *app.ArduinoApp) (AppBrickInstancesResult, error) {
-	res := AppBrickInstancesResult{BrickInstances: make([]BrickInstanceListItem, len(a.Descriptor.Bricks))}
+	res := AppBrickInstancesResult{BrickInstances: make([]BrickInstance, len(a.Descriptor.Bricks))}
 	for i, brickInstance := range a.Descriptor.Bricks {
 		brick, found := s.bricksIndex.FindBrickByID(brickInstance.ID)
 		if !found {
@@ -80,16 +80,23 @@ func (s *Service) AppBrickInstancesList(a *app.ArduinoApp) (AppBrickInstancesRes
 
 		variablesMap, configVariables := getInstanceBrickConfigVariableDetails(brick, brickInstance.Variables)
 
-		res.BrickInstances[i] = BrickInstanceListItem{
+		res.BrickInstances[i] = BrickInstance{
 			ID:              brick.ID,
 			Name:            brick.Name,
 			Author:          "Arduino", // TODO: for now we only support our bricks
 			Category:        brick.Category,
 			Status:          "installed",
 			RequireModel:    brick.RequireModel,
-			ModelID:         brickInstance.Model, // TODO: in case is not set by the user, should we return the default model?
-			Variables:       variablesMap,        // TODO: do we want to show also the default value of not explicitly set variables?
+			ModelID:         getSelectedModelOrDefault(brickInstance, brick),
+			Variables:       variablesMap, // TODO: do we want to show also the default value of not explicitly set variables?
 			ConfigVariables: configVariables,
+			CompatibleModels: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) AIModel {
+				return AIModel{
+					ID:          m.ID,
+					Name:        m.Name,
+					Description: m.ModuleDescription,
+				}
+			}),
 		}
 
 	}
@@ -109,11 +116,6 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br
 
 	variables, configVariables := getInstanceBrickConfigVariableDetails(brick, a.Descriptor.Bricks[brickIndex].Variables)
 
-	modelID := a.Descriptor.Bricks[brickIndex].Model
-	if modelID == "" {
-		modelID = brick.ModelName
-	}
-
 	return BrickInstance{
 		ID:              brickID,
 		Name:            brick.Name,
@@ -123,7 +125,7 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br
 		RequireModel:    brick.RequireModel,
 		Variables:       variables,
 		ConfigVariables: configVariables,
-		ModelID:         modelID,
+		ModelID:         getSelectedModelOrDefault(a.Descriptor.Bricks[brickIndex], brick),
 		CompatibleModels: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) AIModel {
 			return AIModel{
 				ID:          m.ID,
@@ -134,6 +136,16 @@ func (s *Service) AppBrickInstanceDetails(a *app.ArduinoApp, brickID string) (Br
 	}, nil
 }
 
+func getSelectedModelOrDefault(appBrick app.Brick, brickIndex *bricksindex.Brick) string {
+	if appBrick.Model != "" {
+		return appBrick.Model
+	}
+	if brickIndex == nil {
+		return ""
+	}
+	return brickIndex.ModelName
+}
+
 func getInstanceBrickConfigVariableDetails(
 	brick *bricksindex.Brick, userVariables map[string]string,
 ) (map[string]string, []BrickConfigVariable) {

internal/orchestrator/bricks/types.go

@@ -30,19 +30,9 @@ type BrickListItem struct {
 }
 
 type AppBrickInstancesResult struct {
-	BrickInstances []BrickInstanceListItem `json:"bricks"`
-}
-type BrickInstanceListItem struct {
-	ID              string                `json:"id"`
-	Name            string                `json:"name"`
-	Author          string                `json:"author"`
-	Category        string                `json:"category"`
-	Status          string                `json:"status"`
-	Variables       map[string]string     `json:"variables,omitempty" description:"Deprecated: use config_variables instead. This field is kept for backward compatibility."`
-	ConfigVariables []BrickConfigVariable `json:"config_variables,omitempty"`
-	RequireModel    bool                  `json:"require_model"`
-	ModelID         string                `json:"model,omitempty"`
+	BrickInstances []BrickInstance `json:"bricks"`
 }
+
 type BrickInstance struct {
 	ID               string                `json:"id"`
 	Name             string                `json:"name"`