SLVUU-129: Incorporate app layout and settings into single ObjectNode

ScottLogic · Jan 9, 2024 · 2d79d80 · 2d79d80
1 parent c9f37c4
commit 2d79d80
Show file tree

Hide file tree

Showing 10 changed files with 51 additions and 77 deletions.
diff --git a/...rver/src/main/java/org/finos/vuu/layoutserver/controller/ApplicationLayoutController.java b/...rver/src/main/java/org/finos/vuu/layoutserver/controller/ApplicationLayoutController.java
@@ -1,9 +1,8 @@
 package org.finos.vuu.layoutserver.controller;
 
+import com.fasterxml.jackson.databind.node.ObjectNode;
 import lombok.RequiredArgsConstructor;
-import org.finos.vuu.layoutserver.dto.response.ApplicationLayoutDto;
 import org.finos.vuu.layoutserver.service.ApplicationLayoutService;
-import org.modelmapper.ModelMapper;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -20,7 +19,6 @@
 public class ApplicationLayoutController {
 
     private final ApplicationLayoutService service;
-    private final ModelMapper mapper;
 
     /**
      * Gets the persisted application layout for the requesting user. If the requesting user does not have an
@@ -31,24 +29,22 @@ public class ApplicationLayoutController {
      */
     @ResponseStatus(HttpStatus.OK)
     @GetMapping
-    public ApplicationLayoutDto getApplicationLayout(@RequestHeader("username") String username) {
-        return mapper.map(service.getApplicationLayout(username), ApplicationLayoutDto.class);
+    public ObjectNode getApplicationLayout(@RequestHeader("username") String username) {
+        return service.getApplicationLayout(username).getApplicationLayout();
     }
 
     /**
      * Creates or updates the unique application layout for the requesting user.
      *
-     * @param applicationLayoutDto JSON representation of all relevant data about the application layout to be created,
-     *                            containing top-level nodes for the layout itself, and for associated settings
+     * @param applicationLayout JSON representation of all relevant data about the application layout to be created,
+     *                            containing top-level nodes for the layout itself, and (optionally) for associated settings
      * @param username the user making the request
      */
     @ResponseStatus(HttpStatus.CREATED)
     @PutMapping
     public void persistApplicationLayout(@RequestHeader("username") String username,
-        @RequestBody ApplicationLayoutDto applicationLayoutDto) {
-        service.persistApplicationLayout(username,
-                applicationLayoutDto.getApplicationLayout(),
-                applicationLayoutDto.getSettings());
+        @RequestBody ObjectNode applicationLayout) {
+        service.persistApplicationLayout(username, applicationLayout);
     }
 
     /**

diff --git a/...ut-server/src/main/java/org/finos/vuu/layoutserver/dto/response/ApplicationLayoutDto.java b/...ut-server/src/main/java/org/finos/vuu/layoutserver/dto/response/ApplicationLayoutDto.java
diff --git a/layout-server/src/main/java/org/finos/vuu/layoutserver/model/ApplicationLayout.java b/layout-server/src/main/java/org/finos/vuu/layoutserver/model/ApplicationLayout.java
@@ -22,8 +22,4 @@ public class ApplicationLayout {
     @Convert(converter = ObjectNodeConverter.class)
     @Column(columnDefinition = "JSON")
     private ObjectNode applicationLayout;
-
-    @Convert(converter = ObjectNodeConverter.class)
-    @Column(columnDefinition = "JSON")
-    private ObjectNode settings;
 }
diff --git a/layout-server/src/main/java/org/finos/vuu/layoutserver/service/ApplicationLayoutService.java b/layout-server/src/main/java/org/finos/vuu/layoutserver/service/ApplicationLayoutService.java
@@ -20,8 +20,8 @@ public class ApplicationLayoutService {
     private final ApplicationLayoutRepository repository;
     private final DefaultApplicationLayoutLoader defaultLoader;
 
-    public void persistApplicationLayout(String username, ObjectNode applicationLayout, ObjectNode settings) {
-        repository.save(new ApplicationLayout(username, applicationLayout, settings));
+    public void persistApplicationLayout(String username, ObjectNode applicationLayout) {
+        repository.save(new ApplicationLayout(username, applicationLayout));
     }
 
     public ApplicationLayout getApplicationLayout(String username) {

diff --git a/...server/src/main/java/org/finos/vuu/layoutserver/utils/DefaultApplicationLayoutLoader.java b/...server/src/main/java/org/finos/vuu/layoutserver/utils/DefaultApplicationLayoutLoader.java
@@ -25,7 +25,7 @@ public ApplicationLayout getDefaultLayout() {
 
     private void loadDefaultLayout() {
         ObjectNode definition = loadDefaultLayoutJsonFile();
-        defaultLayout = new ApplicationLayout(null, definition, null);
+        defaultLayout = new ApplicationLayout(null, definition);
     }
 
     private ObjectNode loadDefaultLayoutJsonFile() {

diff --git a/layout-server/src/main/resources/defaultApplicationLayout.json b/layout-server/src/main/resources/defaultApplicationLayout.json
@@ -1,27 +1,29 @@
 {
-  "type": "Stack",
-  "id": "main-tabs",
-  "props": {
-    "className": "vuuShell-mainTabs",
-    "TabstripProps": {
-      "allowAddTab": true,
-      "allowCloseTab": true,
-      "allowRenameTab": true,
-      "animateSelectionThumb": false,
-      "location": "main-tab",
-      "tabClassName": "MainTab"
-    },
-    "preserve": true,
-    "active": 0
-  },
-  "children": [
-    {
-      "props": {
-        "id": "tab1",
-        "title": "Tab 1",
-        "className": "vuuShell-Placeholder"
+  "applicationLayout": {
+    "type": "Stack",
+    "id": "main-tabs",
+    "props": {
+      "className": "vuuShell-mainTabs",
+      "TabstripProps": {
+        "allowAddTab": true,
+        "allowCloseTab": true,
+        "allowRenameTab": true,
+        "animateSelectionThumb": false,
+        "location": "main-tab",
+        "tabClassName": "MainTab"
       },
-      "type": "Placeholder"
-    }
-  ]
-}
+      "preserve": true,
+      "active": 0
+    },
+    "children": [
+      {
+        "props": {
+          "id": "tab1",
+          "title": "Tab 1",
+          "className": "vuuShell-Placeholder"
+        },
+        "type": "Placeholder"
+      }
+    ]
+  }
+}
diff --git a/.../src/test/java/org/finos/vuu/layoutserver/controller/ApplicationLayoutControllerTest.java b/.../src/test/java/org/finos/vuu/layoutserver/controller/ApplicationLayoutControllerTest.java
@@ -1,14 +1,12 @@
 package org.finos.vuu.layoutserver.controller;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import org.finos.vuu.layoutserver.dto.response.ApplicationLayoutDto;
 import org.finos.vuu.layoutserver.model.ApplicationLayout;
 import org.finos.vuu.layoutserver.service.ApplicationLayoutService;
 import org.finos.vuu.layoutserver.utils.ObjectNodeConverter;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
-import org.modelmapper.ModelMapper;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.times;
@@ -18,13 +16,12 @@
 class ApplicationLayoutControllerTest {
     private static ApplicationLayoutService mockService;
     private static ApplicationLayoutController controller;
-    private static final ModelMapper modelMapper = new ModelMapper();
     private static final ObjectNodeConverter objectNodeConverter = new ObjectNodeConverter();
 
     @BeforeEach
     public void setup() {
         mockService = Mockito.mock(ApplicationLayoutService.class);
-        controller = new ApplicationLayoutController(mockService, modelMapper);
+        controller = new ApplicationLayoutController(mockService);
     }
 
     @Test
@@ -33,12 +30,11 @@ public void getApplicationLayout_anyUsername_returnsLayoutFromService() {
         ObjectNode definition = objectNodeConverter.convertToEntityAttribute("{\"id\":\"main-tabs\"}");
 
         when(mockService.getApplicationLayout(user))
-                .thenReturn(new ApplicationLayout(user, definition, null));
+                .thenReturn(new ApplicationLayout(user, definition));
 
-        ApplicationLayoutDto response = controller.getApplicationLayout(user);
+        ObjectNode response = controller.getApplicationLayout(user);
 
-        assertThat(response.getApplicationLayout()).isEqualTo(definition);
-        assertThat(response.getSettings()).isNull();
+        assertThat(response).isEqualTo(definition);
 
         verify(mockService, times(1)).getApplicationLayout(user);
     }
@@ -47,12 +43,10 @@ public void getApplicationLayout_anyUsername_returnsLayoutFromService() {
     public void persistApplicationLayout_anyInput_callsService() {
         String user = "user";
         ObjectNode definition = objectNodeConverter.convertToEntityAttribute("{\"id\":\"main-tabs\"}");
-        ApplicationLayoutDto dto = new ApplicationLayoutDto();
-        dto.setApplicationLayout(definition);
 
-        controller.persistApplicationLayout(user, dto);
+        controller.persistApplicationLayout(user, definition);
 
-        verify(mockService, times(1)).persistApplicationLayout(user, definition, null);
+        verify(mockService, times(1)).persistApplicationLayout(user, definition);
     }
 
     @Test

diff --git a/...rc/test/java/org/finos/vuu/layoutserver/integration/ApplicationLayoutIntegrationTest.java b/...rc/test/java/org/finos/vuu/layoutserver/integration/ApplicationLayoutIntegrationTest.java
@@ -54,7 +54,7 @@ public void getApplicationLayout_noLayoutExists_returns200WithDefaultLayout() th
         mockMvc.perform(get(BASE_URL).header("username", "new user"))
                 .andExpect(status().isOk())
                 // Expecting application layout as defined in /test/resources/defaultApplicationLayout.json
-                .andExpect(jsonPath("$.applicationLayout.defaultLayoutKey", is("default-layout-value")));
+                .andExpect(jsonPath("$.defaultLayoutKey", is("default-layout-value")));
     }
 
     @Test
@@ -88,7 +88,7 @@ public void getApplicationLayout_layoutExists_returns200WithPersistedLayout() th
 
         mockMvc.perform(get(BASE_URL).header("username", user))
                 .andExpect(status().isOk())
-                .andExpect(jsonPath("$.applicationLayout", is(definition)));
+                .andExpect(jsonPath("$", is(definition)));
     }
 
     @Test
@@ -111,8 +111,7 @@ public void persistApplicationLayout_noLayoutExists_returns201AndPersistsLayout(
         ApplicationLayout persistedLayout = repository.findById(user).orElseThrow();
 
         assertThat(persistedLayout.getUsername()).isEqualTo(user);
-        assertThat(persistedLayout.getApplicationLayout()).isEqualTo(objectMapper.readTree(definition));
-        assertThat(persistedLayout.getSettings()).isEqualTo(objectMapper.readTree(settings));
+        assertThat(persistedLayout.getApplicationLayout()).isEqualTo(objectMapper.readTree(requestBody));
     }
 
     @Test
@@ -143,8 +142,7 @@ public void persistApplicationLayout_layoutExists_returns201AndOverwritesLayout(
         ApplicationLayout retrievedLayout = repository.findById(user).orElseThrow();
 
         assertThat(retrievedLayout.getUsername()).isEqualTo(user);
-        assertThat(retrievedLayout.getApplicationLayout()).isEqualTo(objectMapper.readTree(newDefinition));
-        assertThat(retrievedLayout.getSettings()).isEqualTo(objectMapper.readTree(settings));
+        assertThat(retrievedLayout.getApplicationLayout()).isEqualTo(objectMapper.readTree(requestBody));
     }
 
     @Test
@@ -192,6 +190,6 @@ public void deleteApplicationLayout_noUserInHeader_returns400() throws Exception
     }
 
     private void persistApplicationLayout(String user, Map<String, String> definition) {
-        repository.save(new ApplicationLayout(user, objectMapper.convertValue(definition, ObjectNode.class), null));
+        repository.save(new ApplicationLayout(user, objectMapper.convertValue(definition, ObjectNode.class)));
     }
 }
diff --git a/...server/src/test/java/org/finos/vuu/layoutserver/service/ApplicationLayoutServiceTest.java b/...server/src/test/java/org/finos/vuu/layoutserver/service/ApplicationLayoutServiceTest.java
@@ -45,15 +45,14 @@ public void getApplicationLayout_noLayout_returnsDefault() {
 
         assertThat(actualLayout.getUsername()).isNull();
         assertThat(actualLayout.getApplicationLayout()).isEqualTo(expectedDefinition);
-        assertThat(actualLayout.getSettings()).isNull();
     }
 
     @Test
     public void getApplicationLayout_layoutExists_returnsLayout() {
         String user = "user";
 
         ObjectNode expectedDefinition = objectNodeConverter.convertToEntityAttribute("{\"id\":\"main-tabs\"}");
-        ApplicationLayout expectedLayout = new ApplicationLayout(user, expectedDefinition, null);
+        ApplicationLayout expectedLayout = new ApplicationLayout(user, expectedDefinition);
 
         when(mockRepo.findById(user)).thenReturn(Optional.of(expectedLayout));
 
@@ -67,10 +66,10 @@ public void createApplicationLayout_validDefinition_callsRepoSave() {
         String user = "user";
         ObjectNode definition = objectNodeConverter.convertToEntityAttribute("{\"id\":\"main-tabs\"}");
 
-        service.persistApplicationLayout(user, definition, null);
+        service.persistApplicationLayout(user, definition);
 
         verify(mockRepo, times(1))
-                .save(new ApplicationLayout(user, definition, null));
+                .save(new ApplicationLayout(user, definition));
     }
 
     @Test

diff --git a/vuu-ui/cypress/e2e/layout-management/api/application-layouts.cy.ts b/vuu-ui/cypress/e2e/layout-management/api/application-layouts.cy.ts
@@ -32,7 +32,6 @@ describe("Application Layouts", () => {
         expect(response.status).to.eq(200);
 
         expect(response.body).to.have.property("applicationLayout");
-        expect(response.body).to.have.property("settings");
 
         expect(JSON.stringify(response.body.applicationLayout)).to.equal(
           JSON.stringify(Cypress.env(DEFAULT_APPLICATION_LAYOUT_ALIAS))