feat(orchestrator): add app status sse handler

Co-authored-by: Davide <davideneri18@gmail.com>

Author: lucarin91

internal/api/api.go

@@ -58,6 +58,7 @@ func NewHTTPRouter(
 
 	mux.Handle("GET /v1/apps", handlers.HandleAppList(dockerClient, idProvider, cfg))
 	mux.Handle("POST /v1/apps", handlers.HandleAppCreate(idProvider, cfg))
+	mux.Handle("GET /v1/apps/events", handlers.HandlerAppStatus(dockerClient, idProvider, cfg))
 
 	mux.Handle("GET /v1/apps/{appID}", handlers.HandleAppDetails(dockerClient, bricksIndex, idProvider, cfg))
 	mux.Handle("PATCH /v1/apps/{appID}", handlers.HandleAppDetailsEdits(dockerClient, bricksIndex, idProvider, cfg))

internal/api/handlers/app_start.go

@@ -4,6 +4,8 @@ import (
 	"log/slog"
 	"net/http"
 
+	"github.com/docker/cli/cli/command"
+
 	"github.com/arduino/arduino-app-cli/internal/api/models"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator"
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/app"
@@ -12,8 +14,6 @@ import (
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/modelsindex"
 	"github.com/arduino/arduino-app-cli/internal/store"
 	"github.com/arduino/arduino-app-cli/pkg/render"
-
-	"github.com/docker/cli/cli/command"
 )
 
 func HandleAppStart(

internal/api/handlers/app_status.go

@@ -0,0 +1,57 @@
+package handlers
+
+import (
+	"log/slog"
+	"net/http"
+	"time"
+
+	"github.com/docker/cli/cli/command"
+
+	"github.com/arduino/arduino-app-cli/internal/api/models"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/app"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
+	"github.com/arduino/arduino-app-cli/pkg/render"
+)
+
+func HandlerAppStatus(
+	dockerCli command.Cli,
+	idProvider *app.IDProvider,
+	cfg config.Configuration,
+) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		sseStream, err := render.NewSSEStream(r.Context(), w)
+		if err != nil {
+			slog.Error("Unable to create SSE stream", slog.String("error", err.Error()))
+			render.EncodeResponse(w, http.StatusInternalServerError, models.ErrorResponse{Details: "unable to create SSE stream"})
+			return
+		}
+		defer sseStream.Close()
+
+		// TODO: maybe we should limit the size of this cache?
+		stateCache := make(map[string]orchestrator.Status)
+
+		for {
+			apps, err := orchestrator.AppStatus(r.Context(), cfg, dockerCli.Client(), idProvider)
+			if err != nil {
+				slog.Error("Unable to get apps status", slog.String("error", err.Error()))
+				render.EncodeResponse(w, http.StatusInternalServerError, models.ErrorResponse{Details: "unable to get apps status"})
+				return
+			}
+			for _, a := range apps {
+				status, exist := stateCache[a.ID.String()]
+				if !exist || status != a.Status {
+					sseStream.Send(render.SSEEvent{Type: "app", Data: a})
+				}
+
+				stateCache[a.ID.String()] = a.Status
+			}
+
+			select {
+			case <-r.Context().Done():
+				return
+			case <-time.After(1 * time.Second):
+			}
+		}
+	}
+}

internal/orchestrator/app_status.go

@@ -0,0 +1,53 @@
+package orchestrator
+
+import (
+	"context"
+	"log/slog"
+
+	dockerClient "github.com/docker/docker/client"
+
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/app"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
+)
+
+func AppStatus(ctx context.Context, cfg config.Configuration, docker dockerClient.APIClient, idProvider *app.IDProvider) ([]AppInfo, error) {
+	appsStatus, err := getAppsStatus(ctx, docker)
+	if err != nil {
+		return nil, err
+	}
+
+	defaultApp, err := GetDefaultApp(cfg)
+	if err != nil {
+		slog.Warn("unable to get default app", slog.String("error", err.Error()))
+	}
+
+	apps := make([]AppInfo, 0, len(appsStatus))
+	for _, a := range appsStatus {
+		// FIXME: create an helper function to transform an app.ArduinoApp into an ortchestrator.AppInfo
+
+		app, err := app.Load(a.AppPath.String())
+		if err != nil {
+			slog.Warn("error loading app", "appPath", a.AppPath.String(), "error", err)
+			return nil, err
+		}
+
+		id, err := idProvider.IDFromPath(a.AppPath)
+		if err != nil {
+			return nil, err
+		}
+
+		isDefault := defaultApp != nil && defaultApp.FullPath.EqualsTo(app.FullPath)
+
+		apps = append(apps, AppInfo{
+			ID:          id,
+			Name:        app.Descriptor.Name,
+			Description: app.Descriptor.Description,
+			Icon:        app.Descriptor.Icon,
+			Status:      a.Status,
+			Example:     id.IsExample(),
+			Default:     isDefault,
+		})
+	}
+
+	return apps, nil
+}

internal/orchestrator/helpers.go

@@ -19,7 +19,7 @@ import (
 	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
 )
 
-type AppStatus struct {
+type AppStatusInfo struct {
 	AppPath *paths.Path
 	Status  Status
 }
@@ -34,8 +34,8 @@ type AppStatus struct {
 //	failed: at least one failed
 //	stopping: at least one stopping
 //	starting: at least one starting
-func parseAppStatus(containers []container.Summary) []AppStatus {
-	apps := make([]AppStatus, 0, len(containers))
+func parseAppStatus(containers []container.Summary) []AppStatusInfo {
+	apps := make([]AppStatusInfo, 0, len(containers))
 	appsStatusMap := make(map[string][]Status)
 	for _, c := range containers {
 		appPath, ok := c.Labels[DockerAppPathLabel]
@@ -46,7 +46,7 @@ func parseAppStatus(containers []container.Summary) []AppStatus {
 	}
 
 	appendResult := func(appPath *paths.Path, status Status) {
-		apps = append(apps, AppStatus{
+		apps = append(apps, AppStatusInfo{
 			AppPath: appPath,
 			Status:  status,
 		})
@@ -90,8 +90,8 @@ func parseAppStatus(containers []container.Summary) []AppStatus {
 func getAppsStatus(
 	ctx context.Context,
 	docker dockerClient.APIClient,
-) ([]AppStatus, error) {
-	getPythonApp := func() ([]AppStatus, error) {
+) ([]AppStatusInfo, error) {
+	getPythonApp := func() ([]AppStatusInfo, error) {
 		containers, err := docker.ContainerList(ctx, container.ListOptions{
 			All:     true,
 			Filters: filters.NewArgs(filters.Arg("label", DockerAppLabel+"=true")),
@@ -105,12 +105,12 @@ func getAppsStatus(
 		return parseAppStatus(containers), nil
 	}
 
-	getSketchApp := func() ([]AppStatus, error) {
+	getSketchApp := func() ([]AppStatusInfo, error) {
 		// TODO: implement this function
 		return nil, nil
 	}
 
-	for _, get := range [](func() ([]AppStatus, error)){getPythonApp, getSketchApp} {
+	for _, get := range [](func() ([]AppStatusInfo, error)){getPythonApp, getSketchApp} {
 		apps, err := get()
 		if err != nil {
 			return nil, err
@@ -126,16 +126,16 @@ func getAppStatus(
 	ctx context.Context,
 	docker command.Cli,
 	app app.ArduinoApp,
-) (AppStatus, error) {
+) (AppStatusInfo, error) {
 	apps, err := getAppsStatus(ctx, docker.Client())
 	if err != nil {
-		return AppStatus{}, fmt.Errorf("failed to get app status: %w", err)
+		return AppStatusInfo{}, fmt.Errorf("failed to get app status: %w", err)
 	}
-	idx := slices.IndexFunc(apps, func(a AppStatus) bool {
+	idx := slices.IndexFunc(apps, func(a AppStatusInfo) bool {
 		return a.AppPath.String() == app.FullPath.String()
 	})
 	if idx == -1 {
-		return AppStatus{}, fmt.Errorf("app %s not found", app.FullPath)
+		return AppStatusInfo{}, fmt.Errorf("app %s not found", app.FullPath)
 	}
 	return apps[idx], nil
 }
@@ -148,7 +148,7 @@ func getRunningApp(
 	if err != nil {
 		return nil, fmt.Errorf("failed to get running apps: %w", err)
 	}
-	idx := slices.IndexFunc(apps, func(a AppStatus) bool {
+	idx := slices.IndexFunc(apps, func(a AppStatusInfo) bool {
 		return a.Status == StatusRunning || a.Status == StatusStarting
 	})
 	if idx == -1 {

internal/orchestrator/orchestrator.go

@@ -557,7 +557,7 @@ func ListApps(
 		}
 
 		var status Status
-		if idx := slices.IndexFunc(apps, func(a AppStatus) bool {
+		if idx := slices.IndexFunc(apps, func(a AppStatusInfo) bool {
 			return a.AppPath.EqualsTo(app.FullPath)
 		}); idx != -1 {
 			status = apps[idx].Status