Feat/455 improve app patch response (#461)

Co-authored-by: mirkoCrobu <mirkocrobu@NB-0531.localdomain>

Author: mirkoCrobu

cmd/gendoc/docs.go

@@ -396,8 +396,10 @@ Contains a JSON object with the details of an error.
 				ID string `path:"id" description:"application identifier."`
 			})(nil),
 			CustomSuccessResponse: &CustomResponseDef{
-				Description: "Successful response",
-				StatusCode:  http.StatusOK,
+				ContentType:   "application/json",
+				DataStructure: orchestrator.AppDetailedInfo{},
+				Description:   "Successful response",
+				StatusCode:    http.StatusOK,
 			},
 			Description: "Edit the given application. Is it possible to modify the default status, to add/remove/update bricks and bricks variables.",
 			Summary:     "Update App Details",

internal/api/api.go

@@ -45,7 +45,7 @@ func NewHTTPRouter(
 	mux.Handle("POST /v1/apps", handlers.HandleAppCreate(dockerClient))
 
 	mux.Handle("GET /v1/apps/{appID}", handlers.HandleAppDetails(dockerClient, bricksIndex))
-	mux.Handle("PATCH /v1/apps/{appID}", handlers.HandleAppDetailsEdits())
+	mux.Handle("PATCH /v1/apps/{appID}", handlers.HandleAppDetailsEdits(dockerClient, bricksIndex))
 	mux.Handle("GET /v1/apps/{appID}/logs", handlers.HandleAppLogs(dockerClient))
 	mux.Handle("POST /v1/apps/{appID}/start", handlers.HandleAppStart(dockerClient, provisioner, modelsIndex, bricksIndex))
 	mux.Handle("POST /v1/apps/{appID}/stop", handlers.HandleAppStop(dockerClient))

internal/api/docs/openapi.yaml

@@ -336,6 +336,10 @@ paths:
               $ref: '#/components/schemas/EditRequest'
       responses:
         "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AppDetailedInfo'
           description: Successful response
         "400":
           $ref: '#/components/responses/BadRequest'

internal/api/handlers/app_details.go

@@ -46,7 +46,7 @@ type EditRequest struct {
 	Default     *bool   `json:"default"`
 }
 
-func HandleAppDetailsEdits() http.HandlerFunc {
+func HandleAppDetailsEdits(dockerClient *dockerClient.Client, bricksIndex *bricksindex.BricksIndex) http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		id, err := orchestrator.NewIDFromBase64(r.PathValue("appID"))
 		if err != nil {
@@ -71,7 +71,6 @@ func HandleAppDetailsEdits() http.HandlerFunc {
 			render.EncodeResponse(w, http.StatusBadRequest, models.ErrorResponse{Details: "invalid request"})
 			return
 		}
-
 		err = orchestrator.EditApp(orchestrator.AppEditRequest{
 			Default:     editRequest.Default,
 			Name:        editRequest.Name,
@@ -83,7 +82,12 @@ func HandleAppDetailsEdits() http.HandlerFunc {
 			render.EncodeResponse(w, http.StatusInternalServerError, models.ErrorResponse{Details: "unable to edit the app"})
 			return
 		}
-
-		w.WriteHeader(http.StatusOK)
+		res, err := orchestrator.AppDetails(r.Context(), dockerClient, app, bricksIndex)
+		if err != nil {
+			slog.Error("Unable to parse the app.yaml", slog.String("error", err.Error()))
+			render.EncodeResponse(w, http.StatusInternalServerError, models.ErrorResponse{Details: "unable to find the app"})
+			return
+		}
+		render.EncodeResponse(w, http.StatusOK, res)
 	}
 }

internal/e2e/client/client.gen.go

@@ -115,7 +115,6 @@ func TestEditApp(t *testing.T) {
 	httpClient := GetHttpclient(t)
 
 	appName := "test-app-to-edit"
-	var updatedAppId string
 	createResp, err := httpClient.CreateAppWithResponse(
 		t.Context(),
 		&client.CreateAppParams{SkipSketch: f.Ptr(true)},
@@ -132,29 +131,25 @@ func TestEditApp(t *testing.T) {
 
 	t.Run("EditAllFields_Success", func(t *testing.T) {
 		renamedApp := appName + "-renamed"
+		modifedIcon := "🌟"
 		editResp, err := httpClient.EditAppWithResponse(
 			t.Context(),
 			validAppId,
 			client.EditRequest{
 				Description: f.Ptr("new-description"),
-				Icon:        f.Ptr("🌟"),
+				Icon:        f.Ptr(modifedIcon),
 				Name:        f.Ptr(renamedApp),
 			},
 		)
 		require.NoError(t, err)
 		require.Equal(t, http.StatusOK, editResp.StatusCode())
-
-		appList, err := httpClient.GetAppsWithResponse(t.Context(), &client.GetAppsParams{})
+		require.NotNil(t, editResp.JSON200)
+		require.NotNil(t, editResp.JSON200.Id)
+		detailsResp, err := httpClient.GetAppDetailsWithResponse(t.Context(), editResp.JSON200.Id)
 		require.NoError(t, err)
-		require.Equal(t, http.StatusOK, appList.StatusCode())
-		require.NotEmpty(t, appList.JSON200.Apps)
-		require.Len(t, *appList.JSON200.Apps, 1)
-
-		app := (*appList.JSON200.Apps)[0]
-		require.Equal(t, renamedApp, *app.Name)
-		require.Equal(t, "new-description", *app.Description)
-		require.Equal(t, "🌟", *app.Icon)
-		updatedAppId = *app.Id
+		require.Equal(t, http.StatusOK, detailsResp.StatusCode())
+		require.Equal(t, renamedApp, detailsResp.JSON200.Name)
+		require.Equal(t, modifedIcon, *detailsResp.JSON200.Icon)
 	})
 
 	t.Run("InvalidAppId_Fail", func(t *testing.T) {
@@ -216,11 +211,25 @@ func TestEditApp(t *testing.T) {
 	})
 
 	t.Run("InvalidRequestBody_Fail", func(t *testing.T) {
+		createResp, err := httpClient.CreateAppWithResponse(
+			t.Context(),
+			&client.CreateAppParams{SkipSketch: f.Ptr(true)},
+			client.CreateAppRequest{
+				Icon: f.Ptr("💻"),
+				Name: "new-valid-app",
+			},
+		)
+		require.NoError(t, err)
+		require.Equal(t, http.StatusCreated, createResp.StatusCode())
+		require.NotNil(t, createResp.JSON201)
+
+		validAppId := *createResp.JSON201.Id
+
 		var actualResponseBody models.ErrorResponse
 		malformedBody := `{"name": "test" "icon": "💻"}`
 		editResp, err := httpClient.EditAppWithBody(
 			t.Context(),
-			updatedAppId,
+			validAppId,
 			"application/json",
 			strings.NewReader(malformedBody),
 		)

internal/e2e/daemon/app_test.go

@@ -748,22 +748,26 @@ func EditApp(req AppEditRequest, app *app.ArduinoApp) (editErr error) {
 		if newPath.Exist() {
 			return ErrAppAlreadyExists
 		}
-
-		defer func() {
-			if err := app.FullPath.Rename(newPath); err != nil {
-				editErr = fmt.Errorf("failed to rename app path: %w", err)
-				return
-			}
-		}()
+		if err := app.FullPath.Rename(newPath); err != nil {
+			editErr = fmt.Errorf("failed to rename app path: %w", err)
+			return editErr
+		}
+		app.FullPath = newPath
+		app.Name = app.Descriptor.Name
 	}
+
 	if req.Icon != nil {
 		app.Descriptor.Icon = *req.Icon
 	}
 	if req.Description != nil {
 		app.Descriptor.Description = *req.Description
 	}
 
-	return app.Save()
+	err := app.Save()
+	if err != nil {
+		return fmt.Errorf("failed to save app: %w", err)
+	}
+	return nil
 }
 
 func editAppDefaults(userApp *app.ArduinoApp, isDefault bool) error {

internal/orchestrator/orchestrator.go

@@ -238,14 +238,15 @@ func TestEditApp(t *testing.T) {
 		_, err := CreateApp(t.Context(), CreateAppRequest{Name: originalAppName})
 		require.NoError(t, err)
 		appDir := orchestratorConfig.AppsDir().Join(originalAppName)
-		originalApp := f.Must(app.Load(appDir.String()))
+		userApp := f.Must(app.Load(appDir.String()))
+		originalPath := userApp.FullPath
 
-		err = EditApp(AppEditRequest{Name: f.Ptr("new-name")}, &originalApp)
+		err = EditApp(AppEditRequest{Name: f.Ptr("new-name")}, &userApp)
 		require.NoError(t, err)
 		editedApp, err := app.Load(orchestratorConfig.AppsDir().Join("new-name").String())
 		require.NoError(t, err)
 		require.Equal(t, "new-name", editedApp.Name)
-		require.True(t, originalApp.FullPath.NotExist()) // The original app directory should be removed after renaming
+		require.True(t, originalPath.NotExist()) // The original app directory should be removed after renaming
 
 		t.Run("already existing name", func(t *testing.T) {
 			existingAppName := "existing-name"