add model list info lite on brick list

Author: mirkoCrobu

internal/api/docs/openapi.yaml

@@ -1171,6 +1171,8 @@ components:
         runner:
           type: string
       type: object
+    AIModelLite:
+      type: object
     AIModelsListResult:
       properties:
         models:
@@ -1367,7 +1369,7 @@ components:
           type: string
         models:
           items:
-            type: string
+            $ref: '#/components/schemas/AIModelLite'
           nullable: true
           type: array
         name:

internal/e2e/client/client.gen.go

@@ -19,6 +19,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"io"
 	"net/http"
 	"testing"
 
@@ -28,8 +29,10 @@ import (
 
 	"github.com/arduino/arduino-app-cli/internal/api/models"
 	"github.com/arduino/arduino-app-cli/internal/e2e/client"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/bricks"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/bricksindex"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/modelsindex"
 	"github.com/arduino/arduino-app-cli/internal/store"
 )
 
@@ -83,6 +86,47 @@ func TestBricksList(t *testing.T) {
 		require.Equal(t, bIdx.Description, *brick.Description)
 		require.Equal(t, "Arduino", *brick.Author)
 		require.Equal(t, "installed", *brick.Status)
+		require.Nil(t, brick.Models)
+	}
+}
+
+func TestBricksListModelListInfoLite(t *testing.T) {
+	httpClient := GetHttpclient(t)
+
+	response, err := httpClient.GetBricks(t.Context(), func(ctx context.Context, req *http.Request) error { return nil })
+	require.NoError(t, err)
+	defer response.Body.Close()
+
+	require.Equal(t, http.StatusOK, response.StatusCode, "Expected HTTP 200 OK")
+
+	body, err := io.ReadAll(response.Body)
+	require.NoError(t, err, "Failed to read response body")
+
+	var result bricks.BrickListResult
+	err = json.Unmarshal(body, &result)
+	require.NoError(t, err, "Failed to unmarshal JSON response into BrickListResult")
+	require.NotEmpty(t, result.Bricks, "Bricks list should not be empty")
+
+	expectedModelLiteInfo := []modelsindex.AIModelLite{
+		{
+			ID:                "face-detection",
+			Name:              "Lightweight-Face-Detection",
+			ModuleDescription: "Face bounding box detection. This model is trained on the WIDER FACE dataset and can detect faces in images.",
+		},
+		{
+			ID:                "yolox-object-detection",
+			Name:              "General purpose object detection - YoloX",
+			ModuleDescription: "General purpose object detection model based on YoloX Nano. This model is trained on the COCO dataset and can detect 80 different object classes.",
+		}}
+
+	for _, brick := range result.Bricks {
+		switch brick.ID {
+		case "arduino:object_detection":
+			require.NotNil(t, brick.Models)
+			require.Equal(t, expectedModelLiteInfo, brick.Models)
+		case "arduino:dbstorage_sqlstore":
+			require.Empty(t, brick.Models)
+		}
 	}
 }
 

internal/e2e/daemon/brick_test.go

@@ -64,9 +64,7 @@ func (s *Service) List() (BrickListResult, error) {
 			Description: brick.Description,
 			Category:    brick.Category,
 			Status:      "installed",
-			Models: f.Map(s.modelsIndex.GetModelsByBrick(brick.ID), func(m modelsindex.AIModel) string {
-				return m.ID
-			}),
+			Models:      s.modelsIndex.GetModelsLiteInfoByBrick(brick.ID),
 		}
 	}
 	return res, nil

internal/orchestrator/bricks/bricks.go

@@ -15,18 +15,20 @@
 
 package bricks
 
+import "github.com/arduino/arduino-app-cli/internal/orchestrator/modelsindex"
+
 type BrickListResult struct {
 	Bricks []BrickListItem `json:"bricks"`
 }
 
 type BrickListItem struct {
-	ID          string   `json:"id"`
-	Name        string   `json:"name"`
-	Author      string   `json:"author"`
-	Description string   `json:"description"`
-	Category    string   `json:"category"`
-	Status      string   `json:"status"`
-	Models      []string `json:"models"`
+	ID          string                    `json:"id"`
+	Name        string                    `json:"name"`
+	Author      string                    `json:"author"`
+	Description string                    `json:"description"`
+	Category    string                    `json:"category"`
+	Status      string                    `json:"status"`
+	Models      []modelsindex.AIModelLite `json:"models"`
 }
 
 type AppBrickInstancesResult struct {

internal/orchestrator/bricks/types.go

@@ -53,6 +53,12 @@ type AIModel struct {
 	ModelConfiguration map[string]string `yaml:"model_configuration,omitempty"`
 }
 
+type AIModelLite struct {
+	ID                string `yaml:"-"`
+	Name              string `yaml:"name"`
+	ModuleDescription string `yaml:"description"`
+}
+
 type ModelsIndex struct {
 	models []AIModel
 }
@@ -82,6 +88,25 @@ func (m *ModelsIndex) GetModelsByBrick(brick string) []AIModel {
 	return matches
 }
 
+func (m *ModelsIndex) GetModelsLiteInfoByBrick(brick string) []AIModelLite {
+	var matches []AIModelLite
+	for i := range m.models {
+		if len(m.models[i].Bricks) > 0 && slices.Contains(m.models[i].Bricks, brick) {
+			matches = append(matches,
+				AIModelLite{
+					ID:                m.models[i].ID,
+					Name:              m.models[i].Name,
+					ModuleDescription: m.models[i].ModuleDescription,
+				},
+			)
+		}
+	}
+	if len(matches) == 0 {
+		return nil
+	}
+	return matches
+}
+
 func (m *ModelsIndex) GetModelsByBricks(bricks []string) []AIModel {
 	var matchingModels []AIModel
 	for _, model := range m.models {

internal/orchestrator/modelsindex/models_index.go

@@ -69,4 +69,15 @@ func TestModelsIndex(t *testing.T) {
 		assert.Equal(t, "face-detection", models[0].ID)
 		assert.Equal(t, "yolox-object-detection", models[1].ID)
 	})
+
+	t.Run("it gets models lite by a brick", func(t *testing.T) {
+		model := modelsIndex.GetModelsLiteInfoByBrick("not-existing-brick")
+		assert.Nil(t, model)
+
+		model = modelsIndex.GetModelsLiteInfoByBrick("arduino:object_detection")
+		assert.Len(t, model, 1)
+		assert.Equal(t, "face-detection", model[0].ID)
+		assert.Equal(t, "Face bounding box detection. This model is trained on the WIDER FACE dataset and can detect faces in images.", model[0].ModuleDescription)
+		assert.Equal(t, "Lightweight-Face-Detection", model[0].Name)
+	})
 }